iamludal / twemoji-awesome

🀑 Like font-awesome, but for emojis.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Twemoji Awesome 🀑

License

Like Font Awesome, but for Twitter Emojis. πŸŽ‰

Supports v13.0 emojis (more than 3,300). πŸ’ͺ

You can refer to this cheatsheet for a complete list of emojis you can use. πŸ“

βœ… Usage

Download this stylesheet and include it to your website.

<link ref="stylesheet" href="path/to/twemoji-awesome.css">

That's all ! You can now start using Twemoji Awesome. πŸ₯³

Emoji Emoji Cheatsheet HTML
calendar <i class="twa twa-calendar"></i>
flexed-biceps <i class="twa twa-flexed-biceps"></i>
grimacing-face <i class="twa twa-2x twa-grimacing-face"></i>

πŸ“ Notes

1️⃣ Emoji styles are defined in twemoji-awesome.css. Like Font Awesome which uses fa-*, Twemoji Awesome uses twa-* for class names.

2️⃣ You can find a full cheatsheet here, where all emojis (13.0) are listed with their corresponding name.

3️⃣ You can change the emoji size with twa-lg, twa-2x, twa-3x, twa-4x and twa-5x.

πŸ› οΈ Generating

First of all, download dependencies:

npm i

😴 TL;DR

To generate a new twemoji-awesome.css stylesheet from the last emojis version:

make all

Fetches emojis, builds the stylesheet and builds the cheatsheet.

πŸ” 1. Fetching emojis

The following command will fetch the last emoji.json version and filter Twemojis from it.

make emoji

🎨 2. Building the stylesheet

The following command will generate the stylesheet corresponding to the emoji.json file.

make css

πŸ“ 3. Building the cheatsheet

If you also need to generate a brand new cheatsheet (eg. after an update), the following command will do it for you! πŸ™

make cheatsheet

πŸ™ Acknowledgements

  • Elle Kasai for the CSS basis (twemoji-basis.css) and the original idea of Twemoji Awesome.
  • emoji.json for the complete list of emojis (including their names, codes, categories...).
  • Twemoji for the emojis SVGs (Twemojis).

About

🀑 Like font-awesome, but for emojis.

License:MIT License


Languages

Language:JavaScript 82.8%Language:CSS 14.6%Language:Makefile 2.6%