@teamwork/emojione

v3.0.1

Emoji One is a complete set of emojis designed for the web. It includes libraries to easily convert unicode characters to shortnames (:smile:) and shortnames to our custom emoji images. PNG and SVG formats provided for the emoji images. For more information about how to use this package see README

Latest version published 6 years ago

License: Unrecognized

NPM

GitHub

Package Health Score

53 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
3.0.1	\|	11/2017	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.3.1	\|	09/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.2.8	\|	02/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Unrecognized

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (7)

GitHub Stars: 4.46K
Forks: 537
Contributors: 60

Direct Usage Popularity

The npm package @teamwork/emojione receives a total of 7 downloads a week. As such, we scored @teamwork/emojione popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @teamwork/emojione, we found that it has been starred 4,460 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 60
Funding: No

With more than 10 contributors for the @teamwork/emojione repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like @teamwork/emojione is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

archived

Commit Frequency

No Recent Commits

Open Issues: 117
Open PR: 15
Last Release: 6 years ago
Last Commit: 5 years ago

Further analysis of the maintenance status of @teamwork/emojione based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @teamwork/emojione is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 7 years
Dependencies: 0 Direct
Versions: 7
Install Size: 0 B
Dist-tags: 2
# of Files: 0
Maintainers: 108
TS Typings: Yes

@teamwork/emojione has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

# EmojiOne > bringing you emojione.com & emoji.codes

The web's first and only complete open source emoji set. It is 100% free and super easy to integrate.

The Idea

To standardize emoji on the web through the use of common :shortnames:.

When storing user inputted text in your database, say from a guestbook or through a CMS admin, it is recommended that you store text containing only :shortnames: and not Unicode emoji characters or emoji images. Then, when you are displaying that content to the user, you can convert it server-side with the PHP toolkit provided, or client-side using the Javascript toolkit which is also provided. Demos of this process using Javascript, jQuery, and PHP are included in the repo, and we have example code snippets below.

What are Shortnames?

Shortnames are semi-standardized human-readable identifiers for each emoji icon. Many online web applications will accept these shortnames as alternatives for the actual unicode character. We've compiled the full list over at emoji.codes with quick copy & search functions.

Installation

We've teamed up with JSDelivr to provide a simple way to install these emoji on any javascript-enabled website. Add the following script and stylesheet links to the head of your webpage:

Alternatively, CDNjs is also available as a CDN Host for EmojiOne.

Quick installs can also be done using NPM and Bower (for the Javascript toolkit) or Composer (for the PHP toolkit).

NPM

&gt; npm install emojione

Bower

&gt; bower install emojione

Composer

$ composer require emojione/emojione

Meteor

meteor add emojione:emojione

Usage Examples

Below there are some examples of how you will actually use the libraries to convert Unicode emoji characters to :shortnames: and :shortnames: to emoji images.

Javascript Conversion

.toShort(str) - native unicode -> shortnames

This demo shows you how to take native unicode emoji input, such as that from your mobile device, and translate it to their corresponding shortnames. (we recommend this for database storage)

.shortnameToImage(str) - shortname -> images

This demo shows you how to take input containing only shortnames and translate it directly to EmojiOne images. (when displaying the unified input to clients)

.unicodeToImage(str) - native unicode -> images

This demo shows you how to take native unicode emoji input, such as that from your mobile device, and translate it directly to EmojiOne images. (would be great for a live editor preview)

.toImage(str) - native unicode + shortnames -> images (mixed input)

This demo shows you how to take input containing both native unicode emoji and shortnames, and translate it into EmojiOne images for display.

PHP Conversion

As of version 1.4.1 this library syntax has changed.

toShort($str) - native unicode -> shortnames

This demo shows you how to take native unicode emoji input, such as that from your mobile device, and translate it to their corresponding shortnames. (we recommend this for database storage)

shortnameToImage($str) - shortname -> images

This demo shows you how to take input containing only shortnames and translate it directly to EmojiOne images. (when displaying the unified input to clients)

unicodeToImage($str) - native unicode -> images

This demo shows you how to take native unicode emoji input, such as that from your mobile device, and translate it directly to EmojiOne images. (would be great for a live editor preview)

toImage($str) - native unicode + shortnames -> images (mixed input)

This demo shows you how to take input containing both native unicode emoji and shortnames, and translate it into EmojiOne images for display.

Note: As of version 1.4.1 the following implementation has been deprecated. It's included in the library for backwards compatibility but will be removed at a later date.

::toShort($str) - native unicode -> shortnames

This demo shows you how to take native unicode emoji input, such as that from your mobile device, and translate it to their corresponding shortnames. (we recommend this for database storage)

::shortnameToImage($str) - shortname -> images

This demo shows you how to take input containing only shortnames and translate it directly to EmojiOne images. (when displaying the unified input to clients)

::unicodeToImage($str) - native unicode -> images

This demo shows you how to take native unicode emoji input, such as that from your mobile device, and translate it directly to EmojiOne images. (would be great for a live editor preview)

::toImage($str) - native unicode + shortnames -> images (mixed input)

This demo shows you how to take input containing both native unicode emoji and shortnames, and translate it into EmojiOne images for display.

Meteor Conversion

Template helpers

My emoji {{&gt; emojione ':beers:'}} text.

{{#emojione}}My emoji :beers: text.{{/emojione}}

Swift Conversion

Emojione.transform(string: "Rocket.Chat: :rocket:")

Extras

shortnameToUnicode(str)

Change from shortnames to native unicode emoji.

Shortname Autocomplete

Easily add shortname autocomplete functionality to any text input on your page.

ASCII Smiley Conversion

With one quick step you can start converting common ASCII smileys to their corresponding images.

Alternate Alt Tags

Change from the native unicode emoji in the resulting alt tags to their shortnames instead.

Live Preview Box

Display converted Emoji in a preview box as the user is typing.

Conversion HTML Class

Stick a class of .emojione-convert on any HTML element and automatically convert native unicode emoji and/or shortnames to images after page load.

Convert on Form Submission

Converts unicode input to shortnames once the user submits the form.

Sprites (PNG)

With an additional CSS file you can use EmojiOne as resizable PNG sprites (up to 64x64).

Sprites (SVG)

This sprite method requires no extra CSS, and is infinitely resizable.

Other Considerations

Character Encoding — UTF-8

If you're getting serious about implementing emoji into your website, you will want to consider your web stack's character encoding. You should make sure that all connection points are using the same encoding. There are a lot of options and configuration possibilities here, so you'll have to figure what works best for your own situation.

A quick Google search will bring up a lot of information on how to get your entire web stack to use UTF-8, which is needed to properly handle Unicode emoji.

To get you started, here's a nice guide: UTF-8: The Secret of Character Encoding.

Information

Bug reports

If you discover any bugs, feel free to create an issue on GitHub. We also welcome the open-source community to contribute to the project by forking it and issuing pull requests.

https://github.com/Ranks/emojione/issues

Contact

If you have any questions, comments, or concerns you are welcome to contact us.

Alternatives

We sincerely hope that you choose to use EmojiOne and support our project, but if you feel like it's not for you, please have a look at these possible alternatives:

Licenses

EmojiOne Artwork

Applies to all PNG and SVG files as well as any adaptations made.
The following applies to artwork included in EmojiOne GitHub libraries versions < 2.0.0.
License: Creative Commons Attribution-ShareAlike 4.0 International
Human Readable License: https://creativecommons.org/licenses/by-sa/4.0/
Complete Legal Terms: https://creativecommons.org/licenses/by-sa/4.0/legalcode
The following applies to artwork included in EmojiOne GitHub libraries versions >= 2.0.0.
License: Creative Commons Attribution 4.0 International
Human Readable License: https://creativecommons.org/licenses/by/4.0/
Complete Legal Terms: https://creativecommons.org/licenses/by/4.0/legalcode

EmojiOne Non-Artwork

Applies to: Javascript, JSON, PHP, CSS, HTML files, and everything else not covered under the artwork license above.
License: MIT
Complete Legal Terms: https://opensource.org/licenses/MIT

@teamwork/emojione development dependencies

grunt grunt-contrib-cssmin grunt-contrib-jshint grunt-contrib-qunit grunt-contrib-sass grunt-contrib-uglify grunt-contrib-watch grunt-imageoptim grunt-jsonlint grunt-spritesmith grunt-svgstore

FAQs

What is @teamwork/emojione?

Emoji One is a complete set of emojis designed for the web. It includes libraries to easily convert unicode characters ... Visit Snyk Advisor to see a full health score report for @teamwork/emojione, including popularity, security, maintenance & community analysis.

Is @teamwork/emojione popular?

The npm package @teamwork/emojione receives a total of 7 weekly downloads. As such, @teamwork/emojione popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @teamwork/emojione well maintained?

We found indications that @teamwork/emojione is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @teamwork/emojione safe to use?

The npm package @teamwork/emojione was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 18 April-2024, at 23:35 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (7)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

The Idea

What are Shortnames?

Installation

NPM

Bower

Composer

Meteor

Usage Examples

Javascript Conversion

PHP Conversion

As of version 1.4.1 this library syntax has changed.

Note: As of version 1.4.1 the following implementation has been deprecated. It's included in the library for backwards compatibility but will be removed at a later date.

Meteor Conversion

Template helpers

Swift Conversion

Extras

Other Considerations

Character Encoding — UTF-8

Information

Bug reports

Contact

Alternatives

Licenses

EmojiOne Artwork

EmojiOne Non-Artwork

@teamwork/emojione development dependencies

FAQs

What is @teamwork/emojione?

Is @teamwork/emojione popular?

Is @teamwork/emojione well maintained?

Is @teamwork/emojione safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues