Skip to content
This repository has been archived by the owner on Jul 23, 2019. It is now read-only.

Latest commit

 

History

History
43 lines (29 loc) · 1.82 KB

INSTALLATION.md

File metadata and controls

43 lines (29 loc) · 1.82 KB

Installation

We've teamed up with JSDelivr to provide a simple way to install these emoji on any javascript-enabled website. Add the following script and stylesheet links to the head of your webpage:

<script src="https://cdn.jsdelivr.net/npm/emojione@4.0.0/lib/js/emojione.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/emojione@4.0.0/extras/css/emojione.min.css"/>

Quick installs can also be done using NPM and Bower (for the Javascript toolkit) or Composer (for the PHP toolkit). If you wish to serve image assets locally you'll need to install emojione-assets and include the pngs and/or sprites into your project. Many of our demos use assets locally simply by pointing the imagePathPNG variable to your local asset location.

NPM

> npm install emojione

Bower

> bower install emojione

Composer

$ composer require emojione/emojione

Meteor

meteor add emojione:emojione

Version 2 Installation

EmojiOne version 2 is no longer supported or distributed.

Character Encoding — UTF-8

If you're getting serious about implementing emoji into your website, you will want to consider your web stack's character encoding. You should make sure that all connection points are using the same encoding. There are a lot of options and configuration possibilities here, so you'll have to figure what works best for your own situation.

A quick Google search will bring up a lot of information on how to get your entire web stack to use UTF-8, which is needed to properly handle Unicode emoji.

To get you started, here's a nice guide: UTF-8: The Secret of Character Encoding.