1.6.9 • Published 7 years ago

@luchanso/emoji-mart v1.6.9

Weekly downloads
1
License
BSD-3-Clause
Repository
github
Last release
7 years ago

Installation

npm install --save emoji-mart

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
autoFocusfalseAuto focus the search input when mounted
color#ae65c5The top bar anchors select and hover color
emojidepartment_storeThe emoji shown when no emojis are hovered, set to an empty string to show nothing
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
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', 'messenger', 'facebook'
sheetSize64The emoji sheet size: 16, 20, 32, 64
backgroundImageFn((set, sheetSize) => …)A Fn that returns that image sheet to use for emojis. Useful for avoiding a request if you have the sheet locally.
emojisToShowFilter((emoji) => true)A Fn to choose whether an emoji should be displayed or not
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',
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.

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:',
  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'

<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

Custom emojis

You can provide custom emojis which will show up in their own category.

import { Picker } from 'emoji-mart'

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

<Picker custom={customEmojis} />

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'

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

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.

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 / Messenger / Facebook

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 start
$ open example/index.html

🎩 Hat tips!

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

1.6.9

7 years ago

1.6.8

7 years ago

1.6.7

7 years ago

1.6.6

7 years ago

1.6.5

7 years ago

1.6.4

7 years ago

1.6.3

7 years ago

1.6.2

7 years ago

1.6.1

7 years ago

1.6.0

7 years ago

1.5.1

7 years ago

1.5.0

7 years ago

1.4.4

7 years ago

1.4.3

7 years ago

1.4.2

7 years ago

1.4.1

7 years ago

1.4.0

7 years ago

1.3.0

7 years ago

1.2.2

7 years ago

1.1.0

7 years ago