nberlette / emoji

Straightforward emoji library for your next project, plus a really bad CLI.

🔥 @nberlette/emoji

Straightforward emoji database for your next project. Includes support for CommonJS, ES, and CLI.

yarn add @nberlette/emoji

Yarn saves this dependency in your package.json when installing locally.

📦 Using as a resource

import - ECMAScript/ES

// both named and default imports work just fine 
import emojis, { emoji } from '@nberlette/emoji'

require - CommonJS/Node

const emojis = require('@nberlette/emoji')

Direct access to emoji.json via CDN

• 🔗 unpkg.com/@nberlette/emoji@latest/emoji.json
• 🔗 cdn.jsdelivr.net/npm/@nberlette/emoji/emoji.json

📺 Command Line Interface

Install globally

yarn global add @nberlette/emoji

Usage

emoji [keyword]

Note: if keyword is excluded, it prints the full list of emojis.

• Exact match: returns just the emoji for keyword
• Single result: returns the emoji + keyword (or trigger)
• Many results: returns emoji + keyword for each match