Build Status npm Bower Twitter Producthunt

> A JavaScript plugin that analyses the string and automatically embeds the supported emojis, media, maps, tweets, code and services. #### [Live Demo](http://codepen.io/ritz078/full/WvvNGe/) [![screen](demo/demo.gif)](http://codepen.io/ritz078/full/WvvNGe/) ## Important links * **[Features](http://riteshkr.com/embed.js)** * **[Full Documentation](https://embedjs.readme.io)** * **[Examples](https://embedjs.readme.io/docs/basic-example)** ## Installation To install the stable version: ``` npm install --save embed-js ``` ## CDN * [jsDelivr](https://www.jsdelivr.com/projects/embed.js) * [cdnjs](https://cdnjs.com/libraries/embed-js) ## Simple Usage Let's assume that the HTML structure is as written below ``` html
``` Creating an instance of embed.js ``` javascript var x = new EmbedJS({ input: document.getElementById('element'), googleAuthKey : 'xxxx' }) ``` Next step is replacing the original text with the processed text. ``` javascript //Render the result x.render(); ``` There may be cases where you just want the processed string to use it according to your need. You can get it by the following method. ``` javascript //Get the resulting string x.text(function(data){ console.log(data); //The resultant string }) ``` If you wan't to destroy the instance. It will also replace the processed string with the original string. ``` javascript //Destroy the instance x.destroy() ``` ## Adding custom emojis 1. Add the image to **assets/images/emojis**. Make sure the name of the file is same as emoji name. 1. Pass the emoji name as the value to `customEmoji`. See the example [here](https://embedjs.readme.io/docs/options#customemoji) 1. Run `grunt build-emoji && grunt build` ## License MIT © [Ritesh Kumar](https://github.com/ritz078)