emoji-toolkit

What is emoji-toolkit?

The emoji-toolkit npm package is a comprehensive library for working with emojis. It provides various functionalities such as converting emoji shortcodes to images, handling different emoji styles, and supporting multiple platforms. This toolkit is useful for developers who want to integrate emojis into their applications seamlessly.

What are emoji-toolkit's main functionalities?

Convert Emoji Shortcodes to Images

This feature allows you to convert emoji shortcodes (e.g., :pizza:) into their corresponding emoji images. This is useful for rendering emojis in environments that do not support native emoji rendering.

const emojiToolkit = require('emoji-toolkit');
const textWithEmojis = emojiToolkit.toImage('I love :pizza: and :coffee:!');
console.log(textWithEmojis);

Set Emoji Styles

This feature allows you to customize the style of the emojis, such as using sprite sheets and setting the size of the emojis. This is useful for maintaining a consistent look and feel across different platforms.

const emojiToolkit = require('emoji-toolkit');
emojiToolkit.sprites = true;
emojiToolkit.spriteSize = 32;
const styledEmoji = emojiToolkit.toImage('I love :pizza: and :coffee:!');
console.log(styledEmoji);

Support for Multiple Platforms

This feature allows you to switch between different emoji styles provided by various platforms like Apple, Google, Twitter, etc. This is useful for ensuring that emojis look consistent with the platform's native style.

const emojiToolkit = require('emoji-toolkit');
emojiToolkit.img_set = 'apple';
const appleStyledEmoji = emojiToolkit.toImage('I love :pizza: and :coffee:!');
console.log(appleStyledEmoji);
emojiToolkit.img_set = 'google';
const googleStyledEmoji = emojiToolkit.toImage('I love :pizza: and :coffee:!');
console.log(googleStyledEmoji);

Other packages similar to emoji-toolkit

emoji-mart

emoji-mart is a comprehensive emoji picker component for React. It provides a customizable emoji picker that can be easily integrated into React applications. Unlike emoji-toolkit, which focuses on converting and styling emojis, emoji-mart is more about providing a user-friendly interface for selecting emojis.

emojione

emojione is a library that provides a complete set of emoji images and tools for working with emojis. It offers similar functionalities to emoji-toolkit, such as converting shortcodes to images and supporting multiple styles. However, emojione also includes a rich set of emoji images that can be used directly in applications.

twemoji

twemoji is an open-source project by Twitter that provides a set of emoji images and a JavaScript library for parsing and rendering emojis. It is similar to emoji-toolkit in that it allows for converting shortcodes to images and supports different styles. However, twemoji is specifically designed to match Twitter's emoji style.

README

A set of libraries to help users find and replace native system emojis with JoyPixels (formerly EmojiOne) in their app or website.

Heads up! EmojiOne has rebranded to JoyPixels. Please see our UPGRADE DOC for details on what's new, especially if you're migrating from emojione, as all references to "emojione" in class names and file names have been changed.

What's Included?

• This project includes libraries used to convert emoji into various formats, including conversion to JoyPixels emoji images.

• All libraries included here are available free under the MIT license.

License to Use JoyPixels Images

JoyPixels Version 4+

JoyPixels Version 4+ is available under the same licensing structure as Version 3. Please see below for more details.

JoyPixels Version 3+

JoyPixels launched version 3.0 in 2017, which has several licensing options available. PNG 32px, 64px, and 128px as well as 32px and 64px sprites are available for digital use, with attribution. See https://www.joypixels.com/licenses/free for more information on usage and attribution requirements.

Premium Licenses are available for larger PNG assets and SVG assets, for digital and print use (within budget constraints). See https://www.joypixels.com/licenses/premium for more information or to obtain a Premium License.

For product/retail licensing, see our Enterprise License https://www.joypixels.com/licenses/enterprise.

JoyPixels Version 2

JoyPixels version 2 is no longer supported or distributed. Please see UPGRADE.md for instructions on upgrading from version 2 to version 3. Version 2 was bound by the Creative Commons Attribution 4.0 International License.

Installation

To install the JoyPixels/emoji-toolkit, please refer to the guide at INSTALLATION.md. Version 3 introduces many potentially-breaking changes. Refer to the UPGRADE.md documentation for more details.

Contributing

Please see CONTRIBUTING.md for more info on contributing to the JoyPixels/emoji-toolkit project. For artwork comments and questions please see the emojione-assets repo.

Usage

You'll find basic usage examples here in the /examples/ directory, and links to usage demos in USAGE.md.

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/joypixels/emoji-toolkit/issues

Contact

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

• 
• [e-mail]
• https://www.joypixels.com
• https://twitter.com/joypixels

Alternatives

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

• https://github.com/hassankhan/emojify.js
• https://github.com/emojidex/ (used to be known as Phantom Open Emoji)
• https://github.com/iamcal/emoji-data (with PHP and Javascript interfaces)
• https://github.com/node-modules/emoji
• https://github.com/steveklabnik/emoji
• https://github.com/rockerhieu/emojicon
• https://github.com/HenrikJoreteg/emoji-images
• https://github.com/frissdiegurke/emoji-parser
• https://github.com/muan/emojilib
• https://github.com/kcthota/emoji4j