GitHub - Nolanlawson - Emoji-Picker-Element - A Lightweight Emoji Picker For The Modern Web

21/03/2023, 10:54 GitHub - nolanlawson/emoji-picker-element: A lightweight emoji picker for the modern web
nolanlawson / emoji-picker-element Public
A lightweight emoji picker for the modern web
nolanlawson.github.io/emoji-picker-element/
Apache-2.0 license
940 stars 66 forks
Star Notifications
Code Issues 15 Pull requests 3 Actions Projects Security Ins
master Go to file
nolanlawson … 3 weeks ago
View code
README.md
emoji-picker-element
<emoji-picker></emoji-picker>
https://github.com/nolanlawson/emoji-picker-element 1/25
A lightweight emoji picker, distributed as a web component.
Features:
Supports Emoji v14.0 (depending on OS) and custom emoji

Uses IndexedDB, so it consumes far less memory than other emoji pickers
Small bundle size (<15kB min+gz)
Renders native emoji by default, with support for custom fonts
Accessible by default
Framework and bundler not required, just add a <script> tag and use it
Table of contents:
emoji-picker-element
Usage
Examples
Emoji support
Custom emoji font
Polyfilling flag emoji on Windows
Styling
Size
Dark mode
CSS variables
Focus outline
Small screen sizes
Custom styling
JavaScript API
Picker
Events
emoji-click
skin-tone-change
Internationalization
Built-in translations
Custom category order
Database
Constructors
constructor
Accessors
customEmoji
Methods
close
delete
getEmojiByGroup
getEmojiBySearchQuery
getEmojiByShortcode
getEmojiByUnicodeOrName
getPreferredSkinTone
getTopFavoriteEmoji
incrementFavoriteEmojiCount
ready
setPreferredSkinTone
Custom emoji
Tree-shaking
Within a Svelte project
Data and offline
Data source and JSON format
Shortcodes
Cache performance
emojibase-data compatibility (deprecated)
Trimming the emoji data (deprecated)
Offline-first
Environments without IndexedDB
Design decisions
IndexedDB
Native emoji
JSON loading
Browser support
Contributing
Usage
Via npm:
npm install emoji-picker-element
import 'emoji-picker-element';
Or as a <script> tag:
<script type="module" src="https://cdn.jsdelivr.net/npm/emoji-picker-element@^1/index
Then use the HTML:
<emoji-picker></emoji-picker>
And listen for emoji-click events:
document.querySelector('emoji-picker')
.addEventListener('emoji-click', event => console.log(event.detail));
This will log:
{
"emoji": {
"annotation": "grinning face",
"group": 0,
"order": 1,
"shortcodes": [ "grinning_face", "grinning" ],
"tags": [ "face", "grin" ],
"unicode": "😀",
"version": 1,
"emoticon": ":D"
},
"skinTone": 0,
"unicode": "😀"
}
Examples
Demo (source)
Button with tooltip/popover (source)
Inserting emoji into a text input (source)
In a React app (source)
Custom emoji font (source)
Fallback for missing flag emoji on Windows (source)
Emoji support
Emoji support varies across browsers and operating systems. By default, emoji-picker-
element will hide unsupported emoji from the picker.
To work around this, you can use a custom emoji font or polyfill flag emoji on Windows.
Custom emoji font
To use a custom emoji font, first set the --emoji-font-family CSS property:
emoji-picker {
--emoji-font-family: MyCustomFont;
}
Then, specify the maximum emoji version supported by the font (see Emojipedia for a list of
versions).
In HTML:
<emoji-picker emoji-version="14.0"></emoji-picker>
Or JavaScript:
const picker = new Picker({

emojiVersion: 14.0
});
If the emoji-version / emojiVersion option is set, then emoji-picker-element will not

attempt to detect unsupported emoji or hide them.
Also note that support for color fonts varies across browsers and OSes, and some browsers
may have bugs or not render the font at all. Be careful to test your supported browsers
when using this approach.
Polyfilling flag emoji on Windows
As of this writing, Windows does not support country flag emoji. This is only a problem in
Chromium-based browsers, because Firefox ships with its own emoji font.
To work around this, you can use country-flag-emoji-polyfill:
import { polyfillCountryFlagEmojis } from 'country-flag-emoji-polyfill';
// emoji-picker-element will use "Twemoji Mozilla" and fall back to other fonts for n
polyfillCountryFlagEmojis('Twemoji Mozilla');
Note that you do not need to do this if you are using a custom emoji font.
Styling
emoji-picker-element uses Shadow DOM, so its inner styling cannot be (easily) changed
with arbitrary CSS. Refer to the API below for style customization.
Size
emoji-picker-element has a default size, but you can change it to whatever you want:
emoji-picker {
width: 400px;
height: 300px;
}
For instance, to make it expand to fit whatever container you give it:
emoji-picker {
width: 100%;
height: 100%;
}
Dark mode
By default, emoji-picker-element will automatically switch to dark mode based on
prefers-color-scheme . Or you can add the class dark or light to force dark/light mode:
<emoji-picker class="dark"></emoji-picker>
<emoji-picker class="light"></emoji-picker>
CSS variables
Most colors and sizes can be styled with CSS variables. For example:
emoji-picker {
--num-columns: 6;
--emoji-size: 3rem;
--background: gray;
}
Here is a full list of options:
Default
Variable Default Description
(dark)
Background of the
--background #fff #222
entire <emoji-picker>
--border-
#e0e0e0 #444
color
--border- Width of border used in

1px
size most of the picker
--button-
Background of an active
active- #e6e6e6 #555555
button
background
--button-
Background of a
hover- #d9d9d9 #484848
hovered button
background
Vertical/horizontal
padding on category
--category-
var(--emoji-padding) emoji, if you want it to
emoji-padding
be different from --
emoji-padding
Width/height of
--category- category emoji, if you
var(--emoji-size)
emoji-size want it to be different
from --emoji-size
Font color of custom

--category-
#111 #efefef emoji category
font-color
headings
Font size of custom

--category-
1rem emoji category
font-size
headings
"Twemoji Mozilla","Apple
Color Emoji","Segoe UI
Emoji","Segoe UI Font family for a custom
--emoji-font-
Symbol","Noto Color emoji font (as opposed
family
Emoji","EmojiOne to native emoji)
Color","Android
Emoji",sans-serif
Default
(dark)
--emoji- Vertical and horizontal

0.5rem
padding padding on emoji
Width and height of all

--emoji-size 1.375rem
emoji
--indicator- Color of the nav

#385ac1 #5373ec
color indicator
--indicator- Height of the nav

3px
height indicator
--input-
#999 #ccc
border-color
--input-
0.5rem
border-radius
--input-
1px
border-size
--input-font-
#111 #efefef
color
--input-font-
1rem
size
--input-line-
1.5
height
--input-
0.25rem
padding
--input-
placeholder- #999 #ccc
color
--num- How many columns to

8
columns display in the emoji grid
--outline-
#999 #fff Focus outline color
color
--outline-
2px Focus outline width
size
Default
(dark)
--skintone- Border radius of the

1rem
border-radius skintone dropdown
Focus outline
For accessibility reasons, emoji-picker-element displays a prominent focus ring. If you
want to hide the focus ring for non-keyboard users (e.g. mouse and touch only), then use
the focus-visible polyfill, e.g.:
import 'focus-visible';
const picker = new Picker();

applyFocusVisiblePolyfill(picker.shadowRoot);
emoji-picker-element already ships with the proper CSS for both the :focus-visible
standard and the polyfill.
Small screen sizes

For small screen sizes, you should probably add some CSS like the following:
@media screen and (max-width: 320px) {

emoji-picker {
--num-columns: 6;
--category-emoji-size: 1.125rem;
}
}
emoji-picker-element does not ship with any CSS to explicitly handle small screen sizes.
The right CSS depends on which screen sizes your app supports, and the size of the picker
within your app. Perhaps in the future container queries can solve this problem.
Custom styling
If you absolutely must go beyond the styling API above, you can do something like this:
const style = document.createElement('style');

style.textContent = `/* custom shadow dom styles here */`
picker.shadowRoot.appendChild(style);
JavaScript API
Picker
Basic usage:
import { Picker } from 'emoji-picker-element';

document.body.appendChild(picker);
The new Picker(options) constructor supports several options:
Name Type Default Des
Func
sort
categ
customCategorySorting function - strin
(sort
alpha
by d
Array
customEmoji CustomEmoji[] -
custo
URL
the e
"https://cdn.jsdelivr.net/npm/emoji- data
dataSource string picker-element- ( dat
data@^1/en/emojibase/data.json" sourc
when
an at
Maxi
supp
emoj
as a
(e.g.
emojiVersion number - or 1
Setti
disab
defa
supp
dete
Name Type Default Des
i18n
i18n I18n - (see
for d
locale string "en" Loca
The e
use f
skin
skinToneEmoji string " 🖐️" picke
tone
when
an at
For instance:

locale: 'fr',
dataSource: '/fr-emoji.json'
})
These values can also be set at runtime:

picker.dataSource = '/my-emoji.json';
Some values can also be set as declarative attributes:
<emoji-picker
locale="fr"
data-source="/fr-emoji.json"
skin-tone-emoji="✌"
></emoji-picker>
Note that complex properties like i18n or customEmoji are not supported as attributes,
because the DOM only supports string attributes, not complex objects.
Events
emoji-click
The emoji-click event is fired when an emoji is selected by the user. Example format:
{
emoji: {
annotation: 'thumbs up',
group: 1,
order: 280,
shortcodes: ['thumbsup', '+1', 'yes'],
tags: ['+1', 'hand', 'thumb', 'up'],
unicode: '👍️',
version: 0.6,
skins: [
{ tone: 1, unicode: '👍🏻', version: 1 },
{ tone: 2, unicode: '👍🏼', version: 1 },
{ tone: 3, unicode: '👍🏽', version: 1 },
{ tone: 4, unicode: '👍🏾', version: 1 },
{ tone: 5, unicode: '👍🏿', version: 1 }
]
},
skinTone: 4,
unicode: '👍🏾'
}
And usage:
picker.addEventListener('emoji-click', event => {

console.log(event.detail); // will log something like the above
});
Note that unicode will represent whatever the emoji should look like with the given
skinTone . If the skinTone is 0, or if the emoji has no skin tones, then no skin tone is
applied to unicode .
skin-tone-change
This event is fired whenever the user selects a new skin tone. Example format:
{
skinTone: 5
}
And usage:
picker.addEventListener('skin-tone-change', event => {

console.log(event.detail); // will log something like the above
})
Note that skin tones are an integer from 0 (default) to 1 (light) through 5 (dark).
Internationalization
The i18n parameter specifies translations for the picker interface. Here is the default
English i18n object:
{
"categories": {
"custom": "Custom",
"smileys-emotion": "Smileys and emoticons",
"people-body": "People and body",
"animals-nature": "Animals and nature",
"food-drink": "Food and drink",
"travel-places": "Travel and places",
"activities": "Activities",
"objects": "Objects",
"symbols": "Symbols",
"flags": "Flags"
},
"categoriesLabel": "Categories",
"emojiUnsupportedMessage": "Your browser does not support color emoji.",
"favoritesLabel": "Favorites",
"loadingMessage": "Loading…",
"networkErrorMessage": "Could not load emoji.",
"regionLabel": "Emoji picker",
"searchDescription": "When search results are available, press up or down to select
"searchLabel": "Search",
"searchResultsLabel": "Search results",
"skinToneDescription": "When expanded, press up or down to select and enter to choo
"skinToneLabel": "Choose a skin tone (currently {skinTone})",
"skinTones": [
"Default",
"Light",
"Medium-Light",
"Medium",
"Medium-Dark",
"Dark"
],
"skinTonesLabel": "Skin tones"
}
Note that some of these strings are only visible to users of screen readers. They are still
important for accessibility!
Built-in translations
Community-provided translations for some languages are available. You can use them like
so:
import fr from 'emoji-picker-element/i18n/fr';

import de from 'emoji-picker-element/i18n/de';
// French
picker.i18n = fr;
// German
picker.i18n = de;
Note that translations for the interface ( i18n ) are not the same as translations for the
emoji data ( dataSource and locale ). To support both, you should do something like:
import fr from 'emoji-picker-element/i18n/fr';

i18n: fr,
locale: 'fr',
dataSource: 'https://cdn.jsdelivr.net/npm/emoji-picker-element-data@^1/fr/emojibase
});
If a built-in translation for your target language is not available, you can also write your own
translation and pass it in as i18n . Please feel free to contribute your translation here.
Custom category order
By default, custom categories are sorted alphabetically. To change this, pass in your own
customCategorySorting :
picker.customCategorySorting = (category1, category2) => { /* your sorting code */ };
This function should accept two strings and return a number.
Custom emoji with no category will pass in undefined . By default, these are shown first,
with the label "Custom" (determined by i18n.categories.custom ).
Database
You can work with the database API separately, which allows you to query emoji the same
way that the picker does:
import { Database } from 'emoji-picker-element';
const database = new Database();

await database.getEmojiBySearchPrefix('elephant'); // [{unicode: "🐘", ...}]
Note that under the hood, IndexedDB data is partitioned based on the locale . So if you
create two Database s with two different locale s, it will store twice as much data.
Also note that, unlike the picker, the database does not filter emoji based on whether they
are supported by the current browser/OS or not. To detect emoji support, you can use a
library like is-emoji-supported.
Full API:
Constructors
constructor
+ new Database( __namedParameters : object): Database
Create a new Database.
Note that multiple Databases pointing to the same locale will share the same underlying
IndexedDB connection and database.
Parameters:
▪ Default value __namedParameters: object= {}
Name Type Default Description
Array of
customEmoji CustomEmoji[] [] custom
emoji
URL to
"https://cdn.jsdelivr.net/npm/emoji-
fetch the
dataSource string picker-element-
emoji data
data@^1/en/emojibase/data.json"
from
Locale
locale string "en"
string
Returns: Database
Accessors
customEmoji
• get customEmoji(): CustomEmoji[]
Return the custom emoji associated with this Database, or the empty array if none.
Returns: CustomEmoji[]
• set customEmoji( customEmoji : CustomEmoji[]): void
Set the custom emoji for this database. Throws an error if custom emoji are not in the
correct format.
Parameters:
Name Type Description
customEmoji CustomEmoji[]
Returns: void
Methods
close
▸ close(): Promise‹void›
Closes the underlying IndexedDB connection. The Database is not usable after that (or any
other Databases with the same locale).
Note that as soon as any other non-close/delete method is called, the database will
automatically reopen.
Returns: Promise‹void›
delete
▸ delete(): Promise‹void›
Deletes the underlying IndexedDB database. The Database is not usable after that (or any
other Databases with the same locale).
Note that as soon as any other non-close/delete method is called, the database will be
recreated.
getEmojiByGroup
▸ getEmojiByGroup( group : number): Promise‹NativeEmoji[]›
Returns all emoji belonging to a group, ordered by order . Only returns native emoji;
custom emoji don't belong to a group.
Non-numbers throw an error.
Parameters:
group number the group number
Returns: Promise‹NativeEmoji[]›
getEmojiBySearchQuery
▸ getEmojiBySearchQuery( query : string): Promise‹Emoji[]›

Returns all emoji matching the given search query, ordered by order .
Empty/null strings throw an error.
Parameters:
query string search query string
Returns: Promise‹Emoji[]›
getEmojiByShortcode
▸ getEmojiByShortcode( shortcode : string): Promise‹Emoji | null›

Return a single emoji matching the shortcode, or null if not found.
The colons around the shortcode should not be included when querying, e.g. use
"slight_smile", not ":slight_smile:". Uppercase versus lowercase does not matter. Empty/null
strings throw an error.
Parameters:
shortcode string
Returns: Promise‹Emoji | null›
getEmojiByUnicodeOrName
▸ getEmojiByUnicodeOrName( unicodeOrName : string): Promise‹Emoji | null›

Return a single native emoji matching the unicode string, or a custom emoji matching the
name, or null if not found.
In the case of native emoji, the unicode string can be either the main unicode string, or the
unicode of one of the skin tone variants.
Empty/null strings throw an error.
Parameters:
unicodeOrName string unicode (native emoji) or name (custom emoji)
Returns: Promise‹Emoji | null›
getPreferredSkinTone
▸ getPreferredSkinTone(): Promise‹SkinTone›
Get the user's preferred skin tone. Returns 0 if not found.
Returns: Promise‹SkinTone›
getTopFavoriteEmoji
▸ getTopFavoriteEmoji( limit : number): Promise‹Emoji[]›

Get the top favorite emoji in descending order. If there are no favorite emoji yet, returns an
empty array.
Parameters:
limit number maximum number of results to return
Returns: Promise‹Emoji[]›
incrementFavoriteEmojiCount
▸ incrementFavoriteEmojiCount( unicodeOrName : string): Promise‹void›

Increment the favorite count for an emoji by one. The unicode string must be non-empty. It
should correspond to the base (non-skin-tone) unicode string from the emoji object, or in
the case of custom emoji, it should be the name.
Parameters:
unicodeOrName string unicode of a native emoji, or name of a custom emoji
ready
▸ ready(): Promise‹void›
Resolves when the Database is ready, or throws an error if the Database could not initialize.
Note that you don't need to do this before calling other APIs – they will all wait for this
promise to resolve before doing anything.
setPreferredSkinTone
▸ setPreferredSkinTone( skinTone : SkinTone): Promise‹void›

Set the user's preferred skin tone. Non-numbers throw an error.
Parameters:
skinTone SkinTone preferred skin tone
Custom emoji
Both the Picker and the Database support custom emoji. Unlike regular emoji, custom emoji
are kept in-memory. (It's assumed that they're small, and they might frequently change, so
there's not much point in storing them in IndexedDB.)
Custom emoji should follow the format:
[
{
name: 'Garfield',
shortcodes: ['garfield'],
url: 'http://example.com/garfield.png',
category: 'Cats'
},
{
name: 'Heathcliff',
shortcodes: ['heathcliff'],
url: 'http://example.com/heathcliff.png',
category: 'Cats'
},
{
name: 'Scooby-Doo',
shortcodes: ['scooby'],
url: 'http://example.com/scooby.png',
category: 'Dogs'
}
]
Note that names are assumed to be unique (case-insensitive), and it's assumed that the
shortcodes have at least one entry.
The category is optional. If you don't provide it, then the custom emoji will appear in a
single category called "Custom".
To pass custom emoji into the Picker :

customEmoji: [ /* ... */ ]
});
Or the Database :
const database = new Database({

customEmoji: [ /* ... */ ]
});
Custom emoji can also be set at runtime:
picker.customEmoji = [ /* ... */ ];
database.customEmoji = [ /* ... */ ];
Tree-shaking
If you want to import the Database without the Picker , or you want to code-split them
separately, then do:
import Picker from 'emoji-picker-element/picker';

import Database from 'emoji-picker-element/database';
The reason for this is that Picker automatically registers itself as a custom element,
following web component best practices. But this adds side effects, so bundlers like
Webpack and Rollup do not tree-shake as well, unless the modules are imported from
completely separate files.
Within a Svelte project

emoji-picker-element is explicitly designed as a custom element, and won't work as a
direct Svelte component. However, if you're already using Svelte 3, then you can avoid
importing Svelte twice by using:
import Picker from 'emoji-picker-element/svelte';
svelte.js is the same as picker.js , except it import s Svelte rather than bundling it.
While this option can reduce your bundle size, note that it only works if your Svelte version
is compatible with emoji-picker-element 's Svelte version (v3 currently).
Data and offline
Data source and JSON format

If you'd like to host the emoji data ( dataSource ) yourself, you can do:
npm install emoji-picker-element-data@^1
Then host node_modules/emoji-picker-element-data/en/emojibase/data.json (or other

JSON files) on your web server.

dataSource: '/path/to/my/webserver/data.json'
});
See emoji-picker-element-data for details.
Shortcodes
There is no standard for shortcodes, so unlike other emoji data, there is some disagreement
as to what a "shortcode" actually is.
emoji-picker-element-data is based on emojibase-data , which offers several shortcode

packs per language. For instance, you may choose shortcodes from GitHub, Slack, Discord,
or Emojibase (the default). You can browse the available data files on jsdelivr and see more
details on shortcodes in the Emojibase docs.
Cache performance
For optimal cache performance, it's recommended that your server expose an ETag
header. If so, emoji-picker-element can avoid re-downloading the entire JSON file over
and over again. Instead, it will do a HEAD request and just check the ETag .
If the server hosting the JSON file is not the same as the one containing the emoji picker,
then the cross-origin server will also need to expose Access-Control-Allow-Origin: * and
Access-Control-Allow-Headers: ETag (or Access-Control-Allow-Headers: * ). jsdelivr
already does this, which is partly why it is the default.
Note that Safari does not currently support Access-Control-Allow-Headers: * , but it does
support Access-Control-Allow-Headers: ETag .
If emoji-picker-element cannot use the ETag for any reason, it will fall back to the less
performant option, doing a full GET request on every page load.
emojibase-data compatibility (deprecated)

Deprecated: in v1.3.0, emoji-picker-element switched from emojibase-data to emoji-
picker-element-data as its default data source. You can still use emojibase-data , but only v5
is supported, not v6. Support may be removed in a later release.
When using emojibase-data , you must use the full emojibase-data JSON file, not the
"compact" one (i.e. data.json , not compact.json ).
Trimming the emoji data (deprecated)

Deprecated: in v1.3.0, emoji-picker-element switched from emojibase-data to emoji-
picker-element-data as its default data source. With the new emoji-picker-element-data ,
there is no need to trim the emoji down to size. This function is deprecated and may be
removed eventually.
If you are hosting the emojibase-data JSON file yourself and would like it to be as small as
possible, then you can use the utility trimEmojiData function:
import trimEmojiData from 'emoji-picker-element/trimEmojiData.js';

import emojiBaseData from 'emojibase-data/en/data.json';
const trimmedData = trimEmojiData(emojiBaseData);
Or if your version of Node doesn't support ES modules:
const trimEmojiData = require('emoji-picker-element/trimEmojiData.cjs');
Offline-first
emoji-picker-element uses a "stale while revalidate" strategy to update emoji data. In
other words, it will use any existing data it finds in IndexedDB, and lazily update via the
dataSource in case that data has changed. This means it will work offline-first the second
time it runs.
If you would like to manage the database yourself (e.g. to ensure that it's correctly
populated before displaying the Picker ), then create a new Database instance and wait
for its ready() promise to resolve:
const database = new Database();

try {
await database.ready();
} catch (err) {
// Deal with any errors (e.g. offline)
}
If emoji-picker-element fails to fetch the JSON data the first time it loads, then it will
display an error message.
Environments without IndexedDB

emoji-picker-element has a hard requirement on IndexedDB, and will not work without it.
For browsers that don't support IndexedDB, such as Firefox in private browsing mode, you
can polyfill it using fake-indexeddb. Here is a working example and more details.
For Node.js environments such as Jest or JSDom, you can also use fake-indexeddb. A
working example can be found in the tests for this very project.
Design decisions
Some of the reasoning behind why emoji-picker-element is built the way it is.
IndexedDB
The emojibase-data English JSON file is 854kB, and the "compact" version is still 543kB.
That's a lot of data to keep in memory just for an emoji picker. And it's not as if that number
is ever going down; the Unicode Consortium keeps adding more emoji every year.
Using IndexedDB has a few advantages:
1. We don't need to keep the full emoji data in memory at all times.
2. After the first load, there is no need to download, parse, and index the JSON file again,
because it's already available in IndexedDB.
3. If you want, you can even load the IndexedDB data in a web worker, keeping the main
thread free from non-UI data processing.
Native emoji
To avoid downloading a large sprite sheet or font file – which may look out-of-place on
different platforms, or may have IP issues – emoji-picker-element only renders native
emoji by default. This means it is limited to the emoji font actually installed on the user's
device.
To avoid rendering ugly unsupported or half-supported emoji, emoji-picker-element will

automatically detect emoji support and only render the supported characters. (So no empty
boxes or awkward double emoji.) If no color emoji are supported by the browser/OS, then
an error message is displayed (e.g. older browsers, some odd Linux configurations).
That said, emoji-picker-element does support custom emoji fonts if you really want.
JSON loading
Browsers deal with JSON more efficiently when it's loaded via fetch() rather than
embedded in JavaScript. It's faster for the browser to parse JSON than JavaScript, becuase
the data is being parsed in the more tightly-constrained JSON format than the generic
JavaScript format.
Plus, embedding the JSON directly would mean re-parsing the entire object on second load,
which is something we want to avoid since the data is already in IndexedDB.
Browser support
emoji-picker-element only supports the latest versions of Chrome, Firefox, and Safari, as
well as equivalent browsers (Edge, Opera, etc.). If you need support for older browsers, you
will need polyfills for the following things (non-exhaustive list):
Custom elements
Shadow DOM
ES2019+
That said, older browsers may not have a color emoji font installed at all, so emoji-picker-
element will not work in those cases.
Contributing
See CONTRIBUTING.md.
Releases
45 tags
Packages
No packages published
Used by 638
+ 630
Contributors 12
Languages
JavaScript 91.0% HTML 5.3% SCSS 3.5% Other 0.2%

GitHub - Nolanlawson - Emoji-Picker-Element - A Lightweight Emoji Picker For The Modern Web

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

GitHub - Nolanlawson - Emoji-Picker-Element - A Lightweight Emoji Picker For The Modern Web

Uploaded by

Copyright:

Available Formats

21/03/2023, 10:54 GitHub - nolanlawson/emoji-picker-element: A lightweight emoji picker for the modern web

nolanlawson / emoji-picker-element Public

A lightweight emoji picker for the modern web

940 stars 66 forks

Code Issues 15 Pull requests 3 Actions Projects Security Ins

nolanlawson … 3 weeks ago

A lightweight emoji picker, distributed as a web component.

Supports Emoji v14.0 (depending on OS) and custom emoji

npm install emoji-picker-element

<script type="module" src="https://cdn.jsdelivr.net/npm/emoji-picker-element@^1/index

Then use the HTML:

And listen for emoji-click events:

This will log:

Custom emoji font

const picker = new Picker({

If the emoji-version / emojiVersion option is set, then emoji-picker-element will not

Polyfilling flag emoji on Windows

To work around this, you can use country-flag-emoji-polyfill:

import { polyfillCountryFlagEmojis } from 'country-flag-emoji-polyfill';

Here is a full list of options:

--border- Width of border used in

Font color of custom

Font size of custom

--emoji- Vertical and horizontal

Width and height of all

--indicator- Color of the nav

--indicator- Height of the nav

--num- How many columns to

--skintone- Border radius of the

const picker = new Picker();

Small screen sizes

@media screen and (max-width: 320px) {

const style = document.createElement('style');

import { Picker } from 'emoji-picker-element';

The new Picker(options) constructor supports several options:

Name Type Default Des

Name Type Default Des

locale string "en" Loca

const picker = new Picker({

These values can also be set at runtime:

const picker = new Picker();

Some values can also be set as declarative attributes:

picker.addEventListener('emoji-click', event => {

picker.addEventListener('skin-tone-change', event => {

import fr from 'emoji-picker-element/i18n/fr';

import fr from 'emoji-picker-element/i18n/fr';

const picker = new Picker({

Custom category order

picker.customCategorySorting = (category1, category2) => { /* your sorting code */ };

This function should accept two strings and return a number.

import { Database } from 'emoji-picker-element';

const database = new Database();

+ new Database( __namedParameters : object): Database

Create a new Database.

▪ Default value __namedParameters: object= {}

Name Type Default Description

• get customEmoji(): CustomEmoji[]

• set customEmoji( customEmoji : CustomEmoji[]): void

Name Type Description

▸ getEmojiByGroup( group : number): Promise‹NativeEmoji[]›

Non-numbers throw an error.

Name Type Description

group number the group number