Home

Awesome

<p align="center"><img src="demo/logo.png" align="center" alt=""></p> <p align="center"> <a href="https://travis-ci.org/ritz078/embed.js"> <img src="https://travis-ci.org/ritz078/embed.js.svg?branch=master" alt="Build Status" style="max-width:100%;"> </a> <a href="https://github.com/ritz078/embed.js"> <img src="https://img.shields.io/npm/v/embed-js.svg" alt="npm" style="max-width:100%;"> </a> <a href="https://twitter.com/intent/tweet?text=embed.js+%7C+A+JS+plugin+to+embed+emojis%2C+media%2C+maps%2C+tweets%2C+code%2C+services+and+parse+markdown+http%3A%2F%2Fbit.ly%2F1NIvT8A&amp;url='http%3A%2F%2Fbit.ly%2F1NIvT8A'&amp;hashtags=JavaScript"> <img src="https://img.shields.io/twitter/url/https/github.com/ritz078/embed.js.svg?style=social" alt="Twitter" style="max-width:100%;"> </a> <a href="https://www.producthunt.com/tech/embed-js"> <img src="https://img.shields.io/badge/vote-producthunt-E45127.svg" alt="Producthunt" style="max-width:100%;"> </a> <a href="https://www.paypal.me/ritz078/20usd" target="_blank"> <img src="https://img.shields.io/badge/Donate-PayPal-green.svg" alt="paypal" style="max-width:100%;"> </a> </p>

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

Live Demo

screen

Important links

Installation

To install the stable version:

npm install --save embed-js

CDN

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({
  input: 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()

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

Development

  1. Fork the repo
  2. clone the repo then cd embed.js
  3. create a new branch
  4. Make sure ruby and sass are installed on your system.
  5. Then npm install && npm i -g rollup && npm i -g grunt-cli
  6. grunt : this will start the grunt server and open a demo page.
  7. Create a PR

Note: This projects adheres to a Code of Conduct.

grunt tasks

  1. grunt : starts development server and watches files for changes. Run this for development purpose.
  2. grunt dist : create dist directory with all the different build files
  3. grunt build-emoji : create spritesheet from all the emojis. Only run if you have made some changes related to emojis

License

MIT © Ritesh Kumar