https://github.com/jukben/emoji-search

🔍️ Retrieve emojis based on the search term
https://github.com/jukben/emoji-search

emoji emoji-search search

Last synced: about 2 months ago
JSON representation

🔍️ Retrieve emojis based on the search term

• Host: GitHub
• URL: https://github.com/jukben/emoji-search
• Owner: jukben
• License: mit
• Created: 2017-09-10T13:43:38.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-08-22T15:25:46.000Z (over 1 year ago)
• Last Synced: 2024-10-12T13:26:55.974Z (2 months ago)
• Topics: emoji, emoji-search, search
• Language: TypeScript
• Homepage:
• Size: 503 KB
• Stars: 8
• Watchers: 3
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @jukben/emoji-search

Exposes search function which returns arrays of related emojis: 

```javascript 

type Emoji = {

    category: string

    char: string,

    fitzpatrick_scale: boolean

    keywords: Array,

    name: string,

}

(string) => Array

```

Based on [emojilib](https://github.com/muan/emojilib) and wonderful [match-sorter](https://github.com/kentcdodds/match-sorter).

## Install

`npm i --save-dev @jukben/emoji-search`

## Usage

```javascript

import search from "@jukben/emoji-search"

search("beer") // [{"keywords":["beer", "relax","beverage","drink","drunk","party","pub","summer","alcohol","booze"],"char":"🍺","fitzpatrick_scale":false,"category":"food_and_drink", name: "beer"},{"keywords":["beers", "relax","beverage","drink","drunk","party","pub","summer","alcohol","booze"],"char":"🍻","fitzpatrick_scale":false,"category":"food_and_drink", name: beers"},{"keywords":["milk_glass", "beverage","drink","cow"],"char":"🥛","fitzpatrick_scale":false,"category":"food_and_drink", name: "milk_glass"},...

search("beer")[0].char // 🍺

```

## License



MIT