Master	Develop

A swiss-army-knife for all emoji, in Javascript. Used by Gitter

The emoji keywords are as described by emoji-cheat-sheet.com.

Go to this project's GitHub pages to see the code in action.

• Fast
• Awesome
• Made from unicorn blood
• Available on a CDN (gasp)
• Converts emoticons like :) :( :'(
• Allows customisation of processed emoji
• Includes a sample .htaccess file for caching Javascript and CSS
• Switchable emoji sets (SOON!)

Add this to the rest of your stylesheet imports: Then add this to your Javascript code:

bower install emojify.js --save

npm install emojify.js --save

This works in the browser and on Node

• object - Optional JSON object with any of the following attributes:

emojify.setConfig({emojify_tag_type : 'div'});

This only works in the browser

• element - Optional HTML element to restrict the emojification to.

emojify.run();
// OR
emojify.run(document.getElementById('my-element'))

This works in the browser and on Node

• string - String to emojify
• callback - Optional callback function to output emoji with

By default, emojify.js uses the internal function defaultReplacer() to replace emoji. You can override this behaviour by supplying your own callback function.

Your callback function will receive two parameters, the emoji pattern found (emoji), and the emoji name (name). In the case of emoticons, for example, emoji = ':)' and name = 'smile'.

The context in which your replacer function is run will have the config available. So you can access properties such as img_dir at this.config.img_dir.

emojify.replace('I am happy :)');
// OR
replacer = function(emoji, name) {
    // Customise output here
    return emojifiedString;
}

emojify.replace('I am happy :)', replacer);

To exclude tags from being emojified, add no-emojify to their class attributes.

Please read CONTRIBUTING.md.