| 1 |
# Emojibase Data |
| 2 |
|
| 3 |
[](https://github.com/milesj/emojibase/actions?query=branch%3Amaster) |
| 4 |
[](https://www.npmjs.com/package/emojibase-data) |
| 5 |
[](https://www.npmjs.com/package/emojibase-data) |
| 6 |
[](https://www.jsdelivr.com/package/npm/emojibase-data) |
| 7 |
|
| 8 |
Install the package. |
| 9 |
|
| 10 |
``` |
| 11 |
yarn add emojibase-data |
| 12 |
``` |
| 13 |
|
| 14 |
Import and use the localized JSON dataset. |
| 15 |
|
| 16 |
```ts |
| 17 |
import data from 'emojibase-data/en/data.json'; |
| 18 |
``` |
| 19 |
|
| 20 |
Or fetch the dataset from our CDN. |
| 21 |
|
| 22 |
```ts |
| 23 |
import { fetchFromCDN, fetchEmojis, fetchShortcodes } from 'emojibase'; |
| 24 |
|
| 25 |
const englishEmojis = await fetchFromCDN('en/data.json', { shortcodes: ['github'] }); |
| 26 |
const japaneseCompactEmojis = await fetchEmojis('ja', { compact: true }); |
| 27 |
const germanCldrShortcodes = await fetchShortcodes('de', 'cldr'); |
| 28 |
``` |
| 29 |
|
| 30 |
## Documentation |
| 31 |
|
| 32 |
[https://emojibase.dev/docs/datasets](https://emojibase.dev/docs/datasets) |