Skip to content

Repository files navigation

Build Status

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

screen

Codepen Example

##Documentation

##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 embeds emojis, media, maps, tweets, gists, code, services and markdown. ✨

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages