Socket
Socket
Sign inDemoInstall

emoji-mart-lite

Package Overview
Dependencies
6
Maintainers
2
Versions
12
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    emoji-mart-lite

Customizable Slack-like emoji picker for React (lite: native emoji only)


Version published
Maintainers
2
Install size
2.10 MB
Created

Readme

Source

THIS FORK IS NO LONGER MAINTAINED. CONSIDER USING emoji-mart INSTEAD

emoji-mart-lite

emoji-mart-lite is a fork of emoji-mart that only supports native emojis, and prunes additional code/metadata to reduce the size of the package.

To give an idea of the difference in space, as of 2/28/17:

  • emoji-mart bundle sizes: 488k (minified), 84k (when gzipped)
  • emoji-mart-lite bundle sizes: 170k (minified), 45k (when gzipped)

Available on npm!


Emoji Mart is a Slack-like customizable
emoji picker component for React
[Demo]

Missive | Team email, team chat, team tasks, one app
Brought to you by the Missive team

Components

Picker

import { Picker } from 'emoji-mart'

<Picker set='emojione' />
<Picker onClick={this.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' } }} />
PropRequiredDefaultDescription
color#ae65c5The top bar anchors select and hover color
emojidepartment_storeThe emoji shown when no emojis are hovered
emojiSize24The emoji width and height
onClickParams: (emoji, event) => {}
perLine9Number of emojis per line. While there’s no minimum or maximum, this will affect the picker’s width. This will set Frequently Used length as well (perLine * 4)
i18n{…}An object containing localized strings
nativefalseRenders the native unicode emoji
setappleThe emoji set: 'apple', 'google', 'twitter', 'emojione'
sheetSize64The emoji sheet size: 16, 20, 32, 64
backgroundImageFn((set, sheetSize) => `https://unpkg.com/emoji-datasource@2.4.4/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.
emojisToShowFilter((unicode) => true)A Fn to choose whether an emoji should be displayed or not based on its unicode
skin1Default skin color: 1, 2, 3, 4, 5, 6
styleInline styles applied to the root element. Useful for positioning
titleEmoji Mart™The title shown when no emojis are hovered
I18n
search: 'Search',
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',
}
Sheet sizes

Sheets are served from unpkg, a global CDN that serves files published to npm.

SetsheetSizeSize
apple16938.7 kB
apple201.3 MB
apple322.6 MB
apple647.2 MB
emojione16805.5 kB
emojione201.1 MB
emojione322.0 MB
emojione642.7 MB
google16622.6 kB
google20849.8 kB
google321.6 MB
google643.6 MB
twitter16776.0 kB
twitter201.0 MB
twitter321.9 MB
twitter644.2 MB
Examples of emoji object:
{
  id: 'smiley',
  name: 'Smiling Face with Open Mouth',
  colons: ':smiley:',
  emoticons: [
    '=)',
    '=-)'
  ],
  skin: null,
  native: '😃'
}

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

Emoji

import { Emoji } from 'emoji-mart'

<Emoji emoji={{ id: 'santa', skin: 3 }} />
<Emoji emoji=':santa::skin-tone-3:' />
<Emoji emoji='santa' set='emojione' />
PropRequiredDefaultDescription
emojiEither a string or an emoji object
sizeThe emoji width and height.
nativefalseRenders the native unicode emoji
onClickParams: (emoji, event) => {}
onLeaveParams: (emoji, event) => {}
onOverParams: (emoji, event) => {}
setappleThe emoji set: 'apple', 'google', 'twitter', 'emojione'
sheetSize64The emoji sheet size: 16, 20, 32, 64
backgroundImageFn((set, sheetSize) => `https://unpkg.com/emoji-datasource@2.4.4/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.
skin1Skin color: 1, 2, 3, 4, 5, 6

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

import { emojiIndex } from 'emoji-mart'

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

Features

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.

sun-results

Emoticons

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

emoticon-results

Results intersection

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

highfive-results

Fully customizable

Anchors color, title and default emoji

anchors
pick

Emojis sizes and length

sizes

Default skin color

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

skins

It can however be overwritten as per user preference.

colors

Multiple sets supported

Apple / Google / Twitter / EmojiOne

sets

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

$ yarn run build:data
$ yarn run watch
$ open example/index.html

🎩 Hat tips!

Powered by iamcal/emoji-data and inspired by iamcal/js-emoji.
🙌🏼  Cal Henderson.



Missive | Team email, team chat, team tasks, one app
Missive mixes team email and threaded group chat for productive teams.
A single app for all your internal and external communication and a full work management solution.

Keywords

FAQs

Last updated on 21 May 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc