emojicons

1.2.0 • Public • Published

cons

Codacy Badge Code Climate Scrutinizer Code Quality Issue Count

Emojicons is a 365 byte (jQuery compressed) script for responsive, scalable, high-definition Apple emoji pseudo-icons. Usage is (very) simple.

Note: despite Github showing whitespace around the emoji, all emoji are transparent.

Add the files

you need jQuery (or maybe not, check emojicons.js)

Npm it

npm install emojicons --save

or simply download from up above.

Near the bottom of your body include emojicons.js:

<body>
  ...
  <script src="./emojicons.js"></script> 
</body>

get yourself a cdn link that's always up-to-date

`THE best storage of ALL TIME`
  https://raw.githubusercontent.com/ayazhafiz/emojicons/master/emojicons.js
 
`or a DOPE cdn of my own`
  http://cdn.ayazhafiz.com/js/emojicons.js
  http://cdn.ayazhafiz.com/js/emojicons.min.js
  http://cdn.ayazhafiz.com/js/jsPure-emojicons.min.js

jquery.emojicons.min.js is only 365 bytes in size.

You must have a head tag. It's both syntactically correct and required.

Usage

From here, it's just plug 'n' chug. You can use one of three tags to create a container for the emoji:

  1. <span class="emoji"> (Syntactically correct)
  2. <i class="emoji">
  3. <emoji>

Basically, either make a span or i with an emoji class or just have a custom emoji tag.

Where the emoji though?

Check out this page. Find the emoji you want, and inside your tag, place the name of the emoji. For example,

<emoji>hashtag</emoji>

will produce

IMPORTANT NOTE:
You can include only one emoji per container, and there must be no whitespace between each angle bracket and the name of the emoji.

Emoji Options

All emoji have a corresponding smaller version, noted by a prefix sm-. For instance,

<emoji>desktop</emoji>

will produce

while

<emoji>sm-desktop</emoji>

will produce

It's highly recommended you take advantage of this smaller option if you can forgive optimal quality.

You can also specify skin tone for some emoji, based on the Fitzpatrick scale. Applicable emoji have a -d suffix for the default tone, -2 for lightest, -4 for light, -6 for neutral, -8 for dark, and -10 for darkest. E.g.:

<emoji>hand-d</emoji>	<emoji>hand-2</emoji>	<emoji>hand-4</emoji>	<emoji>hand-6</emoji>	<emoji>hand-8</emoji>	<emoji>hand-10</emoji>

makes

Finally, you can specify a male / female version for applicable emojis with m- and f- prefixes, respectively.

<emoji>m-haircut-d</emoji>	<emoji>f-haircut-d</emoji>

will produce a male and female version of the same emoji:


Images are hosted on S3.

That's it, baby!

Package Sidebar

Install

npm i emojicons

Weekly Downloads

2

Version

1.2.0

License

MIT

Last publish

Collaborators

  • ahafiz