A repository of over 1000 quality jQuery plugins

jQuery embed.js

embed.js is a jQuery Layout plugin.

Created by Ritz078

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

Not what you're looking for? Click here to view more Layout jQuery plugins

Build Status npm Twitter Producthunt

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. npm install && npm i -g rollup && npm i -g grunt-cli
  5. grunt : this will start the grunt server and open a demo page.
  6. 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



You might also like these other Layout jQuery Plugins

  • jquery.cookiefy

    jquery.cookiefy is a very lightweight, adjustable and easy-to-use plugin for the EU-law cookie warning

  • Tabs

    A jQuery plugin for simple tabs.

  • Equalize

    A jQuery plugin for equal dimensions.