Code Monkey home page Code Monkey logo

emoji-parser's Introduction

Multiplatform Emoji client ๐Ÿ˜Ž

This Module allows you to use Emoji in your Web application interface.

If Emoji are natively supported by user's paltform, it will be rendered as-is. Otherwhise Module will provide fallback images.

User Guide

To use Emoji in your interface, follow this steps.

  • Include specc-emoji.js on your site. Bottom of the <body> tag prefered.
  • Mark all Elements which may content Emoji with js-emoji-included class name.
  • Fire
Emoji.parse();

That's it.

๐Ÿ˜

How it works ๐Ÿค”

First of all it checks for native Emoji supporting. You can access this feature by Emoji.supported property

if ( Emoji.supported ){
	console.log('Emoji natively supported.');
} else {
	console.log('Emoji does not supported.');
}

If user's platform does not supports Emoji, Module will find and relpace all smiles with fallback images that looks like

<em class="emoji" data-emoji="๐Ÿ˜"></em>

Cutted Unicode symbols stores in data-emoji attribute. Next, CSS class emoji.css will stylize this <em> tag with fallback images.

Note that Module requires special CSS file emoji.css, which placed in ../css/ (from original script) directory. If you need to specify your own style location, open specc-emoji.js and change CSS_FILE_PATH property to your path.

/**
* @private
* Path where styles stored
*/
var CSS_FILE_PATH = 'css/emoji.css';

Same thing with CSS file: it uses fallback images by ../emoji/<FILENAME> address.

Example

Open example.html file.

Questions

Fell free to give me a feedback on [email protected] ๐Ÿ˜ผ

emoji-parser's People

Contributors

nespecc avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.