This project is a fork of https://github.com/jm-david/emoji-mart-vue with many performance fixes, tests and some structural code changes.

The original component was very slow to show/destroy, around 2 seconds to show and even a bit longer to destroy, so it was unusable in a popup.

This was the reason to fork and change it, the demo is here, use the "Show / hide the picker" button to see create/destroy performance

Major changes are:

• Reworked emoji index class: use same index (so same data) for all components.
• Added vue-virtual-scroller for emoji categories
• Render emojis in categories without NimbleEmoji component, there are a lot of emojis to render and there is a noticeable slow down even with virtual scrolling when we render a component per emoji.
• Frozen objects with emoji data to disable Vue change tracking
• Do not create NimbleEmojiIndex globally, as it was loaded (along with the emoji data) even when not used
• Extract CSS into external file, use less inline styles to reduce the amount of generated HTML
• Fixes in CSS for native unicode emojis ported from the original react project
• Excluded ./data/all.json from the js bundle (it was always loaded within the bundle even if it is not needed)
• Updated to babel 7
• Added tests

The original project has been forked from emoji-mart which was written for React

Installation

Install from npm: npm install --save emoji-mart-vue-fast.

It is also possible to install directly from github (could be useful for forks): npm install --save serebrov/emoji-mart-vue#5.4.9.

Here is the list of releases.

Components

Picker

1import { Picker } from 'emoji-mart-vue-fast'

Import CSS with default styles:

1import 'emoji-mart-vue-fast/css/emoji-mart.css'

Note: to have a custom look for the picker, either use own css file without including the standard one or add custom styles on top of standard.

Note: CSS also includes background images for image-based emoji sets (apple, google, twitter, emojione, messenger, facebook). The images are loaded from the unpkg.com. To use self-hosted emojis sheet, override CSS like this:

1/* load emojione sheet from own server */
2.emoji-mart-body .emoji-type-image.emoji-set-emojione {
3	background-image: url(/img/emojione-4.0.4-sheets-256-64.png);
4}

1<picker set="emojione" />
2<picker @select="addEmoji" />
3<picker title="Pick your emoji…" emoji="point_up" />
4<picker :style="{ position: 'absolute', bottom: '20px', right: '20px' }" />
5<picker
6	:i18n="{ search: 'Recherche', categories: { search: 'Résultats de recherche', recent: 'Récents' } }"
7/>

Prop	Required	Default	Description
autoFocus		false	Auto focus the search input when mounted
color		#ae65c5	The top bar anchors select and hover color
emoji		department_store	The emoji shown when no emojis are hovered, set to an empty string to show nothing
emojiSize		24	The emoji width and height; affects font size for native emoji (it is 80% of emojiSize); also the picker width is cacluated dynamically based on emojiSize
perLine		9	Number of emojis per line. While there’s no minimum or maximum, this will affect the picker’s width.
i18n		{…}	An object containing localized strings
native		false	Renders the native unicode emoji
set		apple	The emoji set: 'apple', 'google', 'twitter', 'emojione', 'messenger', 'facebook'
showPreview		true	Display preview section
showSearch		true	Display search section
showCategories		true	Display categories
showSkinTones		true	Display skin tones picker
emojiTooltip		false	Show emojis short name when hovering (title)
skin			Forces skin color: 1, 2, 3, 4, 5, 6
defaultSkin		1	Default skin color: 1, 2, 3, 4, 5, 6
pickerStyles			Inline styles applied to the root element. Useful for positioning
title		Emoji Mart™	The title shown when no emojis are hovered
infiniteScroll		true	Scroll continuously through the categories

Event	Description
select	Params: (emoji) => {}
skin-change	Params: (skin) => {}

The select event can be handled to insert the emoji into the text area or use it in any other way. This component does not enforce the usage pattern and it's up to the application how to handle the emoji after it was selected.

For example:

<picker @select="this.selectEmoji" />

...

selectEmoji(emoji) {
  // Assuming the `textContainer` method that returns the
  // text container component with `enterText` method.
  const textContainer = this.textContainer()
  // Enter the native emoji
  textContainer.enterText(emoji.native)
}

The above will use emoji.native to insert native emoji into the input.

This is the simplest way to use the component, that works relatively well in latest versions of native browsers. Here, we rely on native unicode emoji support, which, theoretically, should be handled just like any other unicode characters.

Although, the support for native unicode emoji is still not perfect: unicode emoji characters are part of the font and the font needs to be colorful. But there is no yet a single standard for color fonts implemented by browsers, so the browser leaves emoji rendering to the operating system.

This way, how the emoji will look depends on the operating system and native unicode emoji will look different on different platforms. Also older operating system versions don't not support all the emojis that are currently in the unicode standard, so it may be necessary to limit emojis to some smaller subset.

More consistent solution is also more complex: we can use emoji.colons to insert emoji in the "colons" syntax (such as :smile:) and use regular expressions to find and render the colons emoji as images. In this case, most likely, the application will keep text emoji representation in the database and replace before rendering wherever needed (browser, mobile app, email).

The emoji.getPosition() might be useful in this case to get the emoji position on the emoji sprite sheet.

The replacement can be done approximately like this:

const COLONS_REGEX = new RegExp(
  '([^:]+)?(:[a-zA-Z0-9-_+]+:(:skin-tone-[2-6]:)?)',
  'g'
)

/**
 * Replace emojis insdie the `text` with `<span>`s.
 */
export function wrapEmoji(text: string): string {
  return text.replace(COLONS_REGEX, function(match, p1, p2) {
    const before = p1 || ''
    // We add "data-text='{emoji.native}'", don't replace it
    if (endsWith(before, 'alt="') || endsWith(before, 'data-text="')) {
      return match
    }
    let emoji = emojiIndex.findEmoji(p2)
    if (!emoji) {
      return match
    }
    return before + emojiToHtml(emoji)
  })
  return text;
}

/**
 * Convert Emoji to HTML to represent it as an image.
 */
export function emojiToHtml(emoji: Emoji): string {
  let style = `background-position: ${emoji.getPosition()}`
  // The src="data:image..." is needed to prevent border around img tags.
  return `<img data-text="${emoji.native}" alt="${
    emoji.colons
  }" src="data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7" class='emoji-text' style="${style}">`
}

Similarly, we can use emoji.native to insert native emoji and then find and replace them with images. In this case, the application can keep the native emoji in the database and replace with images where needed - in this case, it can do the replacement for browser, but keep unicode emoji for native app.

The replacement can be done like this (using the emoji-regex package):

// npm install emoji-regex
import emojiRegex from 'emoji-regex'

import data from 'emoji-mart-vue-fast/data/all.json'
import { EmojiIndex } from 'emoji-mart-vue-fast'

const unicodeEmojiRegex = emojiRegex()

export function wrapEmoji(text: string): string {
  return text.replace(unicodeEmojiRegex, function(match, offset) {
    const before = text.substring(0, offset)
    if (endsWith(before, 'alt="') || endsWith(before, 'data-text="')) {
      // Emoji inside the replaced <img>
      return match
    }
    // Find emoji object by native emoji.
    let emoji = emojiIndex.nativeEmoji(match)
    if (!emoji) {
      // Can't find unicode emoji in our index
      return match
    }
    // See `emojiToHtml` function above.
    return emojiToHtml(emoji)
  })
}

Here we can use emojiIndex.hativeEmoji(native_emoji) to get the emoji object by native emoji and then convert it to the HTML image.

I18n

1search: 'Search',
2notfound: 'No Emoji Found',
3categories: {
4  search: 'Search Results',
5  recent: 'Frequently Used',
6  people: 'Smileys & People',
7  nature: 'Animals & Nature',
8  foods: 'Food & Drink',
9  activity: 'Activity',
10  places: 'Travel & Places',
11  objects: 'Objects',
12  symbols: 'Symbols',
13  flags: 'Flags',
14  custom: 'Custom',
15}

Sheet sizes

Sheets are served from unpkg, a global CDN that serves files published to npm. Note: URLs for background images are specified in the css/emoji-mart.css.

Set	Size (sheetSize: 16)	Size (sheetSize: 20)	Size (sheetSize: 32)	Size (sheetSize: 64)
apple	334 KB	459 KB	1.08 MB	2.94 MB
emojione	315 KB	435 KB	1020 KB	2.33 MB
facebook	322 KB	439 KB	1020 KB	2.50 MB
google	301 KB	409 KB	907 KB	2.17 MB
messenger	325 KB	449 MB	1.05 MB	2.69 MB
twitter	288 KB	389 KB	839 KB	1.82 MB

Datasets and Custom Emojis

While all sets are available by default, you may want to include only a single set data to reduce the size of your bundle.

Set	Size (on disk)
all	570 KB
apple	484 KB
emojione	485 KB
facebook	421 KB
google	483 KB
messenger	197 KB
twitter	484 KB

To use these data files (or any other custom data), use the NimblePicker component:

1import data from 'emoji-mart-vue-fast/data/messenger.json'
2import { NimblePicker, EmojiIndex } from 'emoji-mart-vue-fast'
3let index = new EmojiIndex(data)

1<nimble-picker set="messenger" :data="data" />

Using EmojiIndex, it is also possible to control which emojis data is included or excluded via constructor parameters:

Param	Default	Description
include	[]	Only load included categories. Accepts I18n categories keys. Order will be respected, except for the recent category which will always be the first.
exclude	[]	Don't load excluded categories. Accepts I18n categories keys.
custom	[]	Custom emojis
recent		Pass your own frequently used emojis as array of string IDs
recentLength		Set the number of emojis for the recent category.
emojisToShowFilter		((emoji) => true)

Categories for exclude and include parameters are specified as category id, that are present in data arrays.

Avaiable categories are: people, nature, foods, activity, places, objects, symbols, flags.

For example:

1import data from 'emoji-mart-vue-fast/data/messenger.json'
2import { NimblePicker, EmojiIndex } from 'emoji-mart-vue-fast'
3
4let emojisToShowFilter = function(emoji) {
5	// check the emoji properties, see the examples of emoji object below
6	return true // return true to include or false to exclude
7}
8let include = ['people', 'nature']
9// or exclude:
10// let exclude = ['flags']
11
12const custom = [
13	{
14		name: 'Octocat',
15		short_names: ['octocat'],
16		text: '',
17		emoticons: [],
18		keywords: ['github'],
19		imageUrl: 'https://assets-cdn.github.com/images/icons/emoji/octocat.png?v7',
20	},
21]
22
23let index = new EmojiIndex(data, {
24	emojisToShowFilter,
25	include,
26	exclude,
27	custom,
28})

Examples of emoji object:

1{
2  id: 'smiley',
3  name: 'Smiling Face with Open Mouth',
4  colons: ':smiley:',
5  text: ':)',
6  emoticons: [
7    '=)',
8    '=-)'
9  ],
10  skin: null,
11  native: '😃'
12}
13
14{
15  id: 'santa',
16  name: 'Father Christmas',
17  colons: ':santa::skin-tone-3:',
18  text: '',
19  emoticons: [],
20  skin: 3,
21  native: '🎅🏼'
22}
23
24{
25  id: 'octocat',
26  name: 'Octocat',
27  colons: ':octocat',
28  text: '',
29  emoticons: [],
30  custom: true,
31  imageUrl: 'https://assets-cdn.github.com/images/icons/emoji/octocat.png?v7'
32}

Emoji

1import { Emoji } from 'emoji-mart-vue-fast'

1<emoji emoji=":santa::skin-tone-3:" :size="32" />
2<emoji emoji="santa" set="emojione" :size="32" />
3<emoji :emoji="santaEmojiObject" :size="32" />
4
5<script>
6import data from '../data/all.json'
7let index = new EmojiIndex(data)
8
9export default {
10  computed: {
11    santaEmojiObject() {
12      return index.findEmoji(':santa:')
13    },
14  },
15}
16</script>
17

Prop	Required	Default	Description
emoji	✓		Either a string or an emoji object
size	✓		The emoji width and height.
native		false	Renders the native unicode emoji
fallback			Params: (emoji) => {}
set		apple	The emoji set: 'apple', 'google', 'twitter', 'emojione'
sheetSize		64	The emoji sheet size: 16, 20, 32, 64
backgroundImageFn		((set, sheetSize) => `https://unpkg.com/emoji-datasource@3.0.0/sheet_${set}_${sheetSize}.png`)	A Fn that returns that image sheet to use for emojis. Useful for avoiding a request if you have the sheet locally.
skin		1	Skin color: 1, 2, 3, 4, 5, 6
tooltip		false	Show emoji short name when hovering (title)

Event	Description
select	Params: (emoji) => {}
mouseenter	Params: (emoji) => {}
mouseleave	Params: (emoji) => {}

Unsupported emojis fallback

Certain sets don’t support all emojis (i.e. Messenger & Facebook don’t support :shrug:). By default the Emoji component will not render anything so that the emojis’ don’t take space in the picker when not available. When using the standalone Emoji component, you can however render anything you want by providing the fallback props.

To have the component render :shrug: you would need to:

1function emojiFallback(emoji) {
2	return `:${emoji.short_names[0]}:`
3}

1<emoji set="messenger" emoji="shrug" :size="24" :fallback="emojiFallback" />

Headless search

The Picker doesn’t have to be mounted for you to take advantage of the advanced search results.

1import { EmojiIndex } from 'emoji-mart-vue-fast'
2import data from 'emoji-mart-vue-fast/data/all.json'
3
4const emojiIndex = new EmojiIndex(data)
5emojiIndex.search('christmas').map((o) => o.native)
6// => [🎄, 🎅🏼, 🔔, 🎁, ⛄️, ❄️]

With custom data

1import data from 'emoji-mart-vue-fast/data/messenger'
2import { EmojiIndex } from 'emoji-mart-vue-fast'
3
4let emojiIndex = new EmojiIndex(data)
5emojiIndex.search('christmas')

Storage

By default EmojiMart will store user chosen skin and frequently used emojis in localStorage. That can however be overwritten should you want to store these in your own storage.

1import { store } from 'emoji-mart-vue-fast'
2
3store.setHandlers({
4	getter: (key) => {
5		// Get from your own storage (sync)
6	},
7
8	setter: (key, value) => {
9		// Persist in your own storage (can be async)
10	},
11})

Possible keys are:

Key	Value	Description
skin	1, 2, 3, 4, 5, 6
frequently	{ 'astonished': 11, '+1': 22 }	An object where the key is the emoji name and the value is the usage count
last	'astonished'	(Optional) Used by frequently to be sure the latest clicked emoji will always appear in the “Recent” category

Features

Powerful search

Short name, name and keywords

Not only does Emoji Mart return more results than most emoji picker, they’re more accurate and sorted by relevance.

Emoticons

The only emoji picker that returns emojis when searching for emoticons.

Results intersection

For better results, Emoji Mart split search into words and only returns results matching both terms.

Fully customizable

Anchors color, title and default emoji

Emojis sizes and length

Default skin color

As the developer, you have control over which skin color is used by default.

It can however be overwritten as per user preference.

Multiple sets supported

Apple / Google / Twitter / EmojiOne / Messenger / Facebook

Not opinionated

Emoji Mart doesn’t automatically insert anything into a text input, nor does it show or hide itself. It simply returns an emoji object. It’s up to the developer to mount/unmount (it’s fast!) and position the picker. You can use the returned object as props for the EmojiMart.Emoji component. You could also use emoji.colons to insert text into a textarea or emoji.native to use the emoji.

Development

Build the component and the demo app.

1$ npm build
2$ npm start

Open docs/index.html in browser to see the demo.

Or serve the dir (with npx and http-server:

1hpx http-server ./docs

And open http://127.0.0.1:8080/.

Tests

Run tests with npm run jest.

To debug tests, run npm run jest-debug and then open chrome://inspect in Chrome and open the node inspector client from there.

Building

1# Checkout master branch, update version
2git checkout master
3# Edit package.json, update version
4vim package.json
5
6# Checkout build branch
7git checkout build
8
9# Merge latest master into it
10git merge master
11
12# Build
13NODE_ENV=production npm run build
14npm run dev:docs
15
16# Add build files
17git add buiid/
18git add docs/
19git commit -m "Rebuild"
20
21# Push changes
22git push origin HEAD
23
24# Tag the new release (same as package.json version), add the description for tag
25# Hint: refer PRs with #17 (PR id) to later have links to PRs in github releases
26git tag 3.1.1 -a
27
28# Push the tags
29git push origin --tags
30
31# Publish to npm with `npm publish`
32
33## 🎩 Hat tips!
34
35Original react emoji picker: [missive/emoji-mart](https://github.com/missive/emoji-mart).
36Vue port: [jm-david/emoji-mart-vue](https://github.com/jm-david/emoji-mart-vue)
37
38Powered by [iamcal/emoji-data](https://github.com/iamcal/emoji-data) and inspired by [iamcal/js-emoji](https://github.com/iamcal/js-emoji).<br>
39🙌🏼  [Cal Henderson](https://github.com/iamcal).