Skip to content

A JavaScript plugin that analyses the string and automatically embeds emojis, media, maps, tweets, code ,services and markdown.

Notifications You must be signed in to change notification settings

eface2face/embed.js

 
 

Repository files navigation

Build Status npm Bower Twitter

A JavaScript plugin that analyses the string and automatically embeds the supported emojis, media, maps, tweets, code and services.

screen

Important links

Simple Usage

Let's assume that the HTML structure is as written below

<div id="element">
   <!--===== your string here =======-->
</div>

Creating an instance of embed.js

var x = new EmbedJS({
  element: document.getElementById('element'),
  googleAuthKey : 'xxxx'
})

Next step is replacing the original text with the processed text.

//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.

//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.

//Destroy the instance
x.destroy()

Creating custom build

Set the features you don't want to false in build.json and then run

grunt build

This will create a customized build of the plugin.

Adding custom emojis

  1. Add the image to assets/images/emojis. Make sure the name of the file is same as emoji name.
  2. Pass the emoji name as the value to customEmoji. See the example here
  3. Run grunt build-emoji && grunt build

Contributing

  1. Fork and clone the repo.
  2. Run npm install to install all build dependencies(including Grunt).
  3. Create a new branch, please DON'T work in your master branch directly.
  4. Run grunt so that you can see the impact of your changes on the browser while developing.
  5. Fix stuff or add new feature.
  6. This repo follows Angular commit guidelines. For this we are using commitizen. So instead of git commit, prefer using npm run commit and follow the guidelines.
  7. Update the documentation to reflect any changes.
  8. Push to your fork and submit a pull request.

License

MIT © Ritesh Kumar

About

A JavaScript plugin that analyses the string and automatically embeds emojis, media, maps, tweets, code ,services and markdown.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 72.0%
  • CSS 23.9%
  • HTML 4.1%