@bitsler/emoji-mart-vue

v5.4.14

Published

3 years ago

Customizable Slack-like emoji picker for VueJS

Downloads

0High
0Medium
0Low

isildurx

unibtc

vue vuejs emoji picker

This project is a fork of https://github.com/jm-david/emoji-mart-vue with many performance fixes.

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

It is not published to npm, to install from github, use npm install --save serebrov/emoji-mart-vue#4.0.0. (check the list of releases for available versions).

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

Installation

It is not published to npm, to install from github, use

npm install --save serebrov/emoji-mart-vue#4.0.0.

Check the list of releases for available versions).

Components

Picker

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

Import CSS with default styles:

import 'emoji-mart-vue/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:

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

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

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

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

I18n

search: 'Search',
notfound: 'No Emoji Found',
categories: {
  search: 'Search Results',
  recent: 'Frequently Used',
  people: 'Smileys & People',
  nature: 'Animals & Nature',
  foods: 'Food & Drink',
  activity: 'Activity',
  places: 'Travel & Places',
  objects: 'Objects',
  symbols: 'Symbols',
  flags: 'Flags',
  custom: 'Custom',
}

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:

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

<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) | A Fn to choose whether an emoji should be displayed or not |

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:

import data from 'emoji-mart-vue/data/messenger.json'
import { NimblePicker, EmojiIndex } from 'emoji-mart-vue'

let emojisToShowFilter = function(emoji) {
	// check the emoji properties, see the examples of emoji object below
	return true // return true to include or false to exclude
}
let include = ['people', 'nature']
// or exclude:
// let exclude = ['flags']

const custom = [
	{
		name: 'Octocat',
		short_names: ['octocat'],
		text: '',
		emoticons: [],
		keywords: ['github'],
		imageUrl: 'https://assets-cdn.github.com/images/icons/emoji/octocat.png?v7',
	},
]

let index = new EmojiIndex(data, {
	emojisToShowFilter,
	include,
	exclude,
	custom,
})

Examples of `emoji` object:

{
  id: 'smiley',
  name: 'Smiling Face with Open Mouth',
  colons: ':smiley:',
  text: ':)',
  emoticons: [
    '=)',
    '=-)'
  ],
  skin: null,
  native: '😃'
}

{
  id: 'santa',
  name: 'Father Christmas',
  colons: ':santa::skin-tone-3:',
  text: '',
  emoticons: [],
  skin: 3,
  native: '🎅🏼'
}

{
  id: 'octocat',
  name: 'Octocat',
  colons: ':octocat',
  text: '',
  emoticons: [],
  custom: true,
  imageUrl: 'https://assets-cdn.github.com/images/icons/emoji/octocat.png?v7'
}

Emoji

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

<emoji :emoji="{ id: 'santa', skin: 3 }" :size="16" />
<emoji emoji=":santa::skin-tone-3:" :size="16" />
<emoji emoji="santa" set="emojione" :size="16" />

| 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/[email protected]/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:

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

<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.

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

const emojiIndex = new EmojiIndex(data)
emojiIndex.search('christmas').map((o) => o.native)
// => [🎄, 🎅🏼, 🔔, 🎁, ⛄️, ❄️]

With custom data

import data from 'emoji-mart-vue/data/messenger'
import { EmojiIndex } from 'emoji-mart-vue'

let emojiIndex = new EmojiIndex(data)
emojiIndex.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.

import { store } from 'emoji-mart-vue'

store.setHandlers({
	getter: (key) => {
		// Get from your own storage (sync)
	},

	setter: (key, value) => {
		// Persist in your own storage (can be async)
	},
})

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.

$ npm build
$ npm start

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

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

hpx 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

# Checkout build branch
git checkout build

# Merge latest master into it
git merge master

# Build
npm run build
npm run dev:docs

# Add build files
git add buiid/
git add docs/
git commit -m "Rebuild"

# Push changes
git push origin HEAD

# Tag the new release, add the description for tag
# Hint: refer PRs with #17 (PR id) to later have links to PRs in github releases
git tag 3.1.1 -a

# Push the tags
git push origin --tags

## 🎩 Hat tips!

Original react emoji picker: [missive/emoji-mart](https://github.com/missive/emoji-mart).
Vue port: [jm-david/emoji-mart-vue](https://github.com/jm-david/emoji-mart-vue)

Powered by [iamcal/emoji-data](https://github.com/iamcal/emoji-data) and inspired by [iamcal/js-emoji](https://github.com/iamcal/js-emoji).<br>
🙌🏼  [Cal Henderson](https://github.com/iamcal).