Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/tunoltd/emoji-mart-native

One component to pick them all 👊🏼
https://github.com/tunoltd/emoji-mart-native

custom-emojis emoji-component emoji-mart emoji-picker modalpicker

Last synced: 3 months ago
JSON representation

One component to pick them all 👊🏼

Awesome Lists containing this project

README 

          


  
Emoji Mart Native is a Slack-like customizable
emoji picker component for React Native ported from [Emoji Mart]

  
Example app • Changelog

  

Build Status




Supporting emoji-mart-native



The ongoing development of Emoji Mart Native is made possible entirely by the support of these awesome [backers](https://github.com/tunoltd/emoji-mart-native/blob/master/BACKERS.md). If you'd like to join them, please consider becoming a [backer or sponsor on GitHub](https://github.com/sponsors/pederjohnsen).



Platinum Sponsors



Gold Sponsors



---





  picker




## Installation



`npm install --save emoji-mart-native`



## Components



### Picker



Renders _inline-block_ & center aligned if parent is wider than picker.

To render picker in a fullscreen modal use [``](#modalpicker).



```jsx

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



```



| Prop | Required | Default | Description |

| ---- | :------: | ------- | ----------- |

| **autoFocus** | | `false` | Auto focus the search input when mounted |

| **color** | | `#ae65c5` | The top bar anchors select and hover color |

| **include** | | `[]` | Only load included categories. Accepts [I18n categories keys](#i18n). 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](#i18n). |

| **custom** | | `[]` | [Custom emojis](#custom-emojis) |

| **recent** | | | Pass your own frequently used emojis as array of string IDs |

| **enableFrequentEmojiSort** | | `false` | Instantly sort “Frequently Used” category |

| **emojiSize** | | `30` | The emoji width and height |

| **emojiMargin** | | `14` | The emoji margin |

| **anchorSize** | | `24` | The anchor emoji width and height |

| **onClick** | | | Params: `(emoji, event) => {}`. Not called when emoji is selected with `enter` |

| **onSelect** | | | Params: `(emoji) => {}` |

| **onSkinChange** | | | Params: `(skin) => {}` |

| **showCloseButton** | | `false` | Shows the close button which triggers **onPressClose** |

| **onPressClose** | | | Trigger when user press close button |

| **perLine** | | `7` | Number 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 * rows`) |

| **rows** | | `3` | Number of rows. While there's no minimum or maximum, this will affect the picker’s height. This will set _Frequently Used_ length as well (`perLine * rows`) |

| **pagesToEagerLoad** | | `2` | Number of pages to eager load each side of currently active page. |

| **i18n** | | [`{…}`](#i18n) | [An object](#i18n) containing localized strings |

| **native** | | `false` | Renders the native unicode emoji |

| **set** | | `apple` | The emoji set: `'apple', 'google', 'twitter', 'facebook'` |

| **theme** | | `light` | The picker theme: `'auto', 'light', 'dark'` Note: `auto` uses `Appearance` and only works when using `react-native` 0.62.0 or above |

| **sheetSize** | | `64` | The emoji [sheet size](#sheet-sizes): `16, 20, 32, 64` |

| **sheetColumns** | | `60` | The emoji sheet columns |

| **sheetRows** | | `60` | The emoji sheet rows |

| **spriteSheetFn** | | `((set, sheetSize) => …)` | [A Fn](#spritesheetfn) that returns that image sheet to use for emojis. Useful for avoiding a request if you have the sheet locally. |

| **useLocalImages** | | false | [Local image requires](#local-image-requires) |

| **emojisToShowFilter** | | `((emoji) => true)` | A Fn to choose whether an emoji should be displayed or not |

| **showPreview** | | `true` | Display preview section |

| **showSkinTones** | | `true` | Display skin tones picker |

| **skin** | | | Forces skin color: `1, 2, 3, 4, 5, 6` |

| **defaultSkin** | | `1` | Default skin color: `1, 2, 3, 4, 5, 6` |

| **skinEmoji** | | | The emoji used to pick a skin tone. Uses an emoji-less skin tone picker by default |

| **skinEmojiSize** | | `28` | The skin emoji width and height |

| **style** | | | Inline styles applied to the root element. Useful for positioning |

| **notFoundEmoji** | | `sleuth_or_spy` | The emoji shown when there are no search results |

| **notFound** | | | [Not Found](#not-found) |

| **categoryEmojis** | | `{}` | [Custom category emojis](#custom-category-emojis) |

| **fontSize** | | 15 | Font size used for all text in the picker |



#### I18n



```js

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

}

```



#### SpriteSheetFn



By default the picker source the emoji sheets online, this may not be the best solution and you may want to bundle the emoji sheets with your app.

For the best results it's recommended to include any emoji sheets you use in the platform specific app package.



You can either provide your own emoji sheets or use ones available from libraries such as [`iamcal/emoji-data`](https://github.com/iamcal/emoji-data#installation):



```

npm install emoji-datasource-apple

npm install emoji-datasource-google

npm install emoji-datasource-twitter

npm install emoji-datasource-facebook

```



```jsx

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



const localSpriteSheets = {

  ...

  twitter: {

    ...

    '20': {uri: `https://unpkg.com/emoji-datasource@5.0.1/sheet_${set}_${sheetSize}.png`}, // Loads asset from web

    '32': require('./node_modules/emoji-datasource-twitter/img/twitter/sheets/32.png'), // Loads static asset

    '64': {uri: 'twitter_emoji_64'}, // Loads asset from app package

  },

  ...

};



  {uri: `https://unpkg.com/emoji-datasource@5.0.1/sheet_${set}_${sheetSize}.png`}

}>



  localSpriteSheets[set][sheetSize]

}>

```



#### Sheet sizes

Sheets are served from [unpkg](https://unpkg.com), a global CDN that serves files published to [npm](https://www.npmjs.com).



| Set | Size (`sheetSize: 16`) | Size (`sheetSize: 20`) | Size (`sheetSize: 32`) | Size (`sheetSize: 64`) |

| --- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |

| apple | 407 KB | 561 KB | 1.34 MB | 3.60 MB |

| facebook | 416 KB | 579 KB | 1.38 MB | 3.68 MB |

| google | 362 KB | 489 KB | 1.12 MB | 2.78 MB |

| twitter | 361 KB | 485 KB | 1.05 MB | 2.39 MB |



#### Datasets

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 | 611 KB |

| apple | 548 KB |

| facebook | 468 KB |

| google | 518 KB |

| twitter | 517 KB |



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



```js

import data from 'emoji-mart-native/data/apple.json'

import { NimblePicker } from 'emoji-mart-native'



```



#### Examples of `emoji` object:

```js

{

  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,

  image: {uri: 'https://github.githubassets.com/images/icons/emoji/octocat.png'}

}

```



#### Local image requires

By default the picker source the emoji images online, this may not be the best solution and you may want to bundle the emojis with your app.



| Set | Size (on disk) |

| --- | -------------- |

| all | 1.6 MB |

| apple | 776 KB |

| facebook | 690 KB |

| google | 742 KB |

| twitter | 752 KB |



To use local image requires you need to install the individual sets you need in your project using the individual sets npm packages from https://github.com/iamcal/emoji-data#installation:



```

npm install emoji-datasource-apple

npm install emoji-datasource-google

npm install emoji-datasource-twitter

npm install emoji-datasource-facebook

```



```js

import { NimblePicker, NimbleEmoji } from 'emoji-mart-native'

import data from 'emoji-mart-native/data/facebook.json'

import dataRequires from 'emoji-mart-native/data/local-images/facebook'

const {emojis: localEmojis} = dataRequires



```



### ModalPicker

Renders the picker in a fullscreen modal.



```jsx

import { ModalPicker } from 'emoji-mart-native'

;

```



| Prop | Required | Default | Description |

| ---- | :------: | ------- | ----------- |

| **...PickerProps** | | | |

| **isVisible** | | `false` | When true shows the modal with the picker |



### EmojiButton

Renders an emoji button that can be used to trigger showing a hidden picker.



```jsx

import { EmojiButton } from 'emoji-mart-native'

const emojiImage = require('assets/emoji-image.png')



```



| Prop | Required | Default | Description |

| ---- | :------: | ------- | ----------- |

| **onButtonPress** | | | Trigger when user press the button |

| **buttonImage** | | ![emoji-icon.png](https://raw.githubusercontent.com/tunoltd/emoji-mart-native/master/dist/assets/emoji-icon.png) | The image used for rendering the button |

| **buttonSize** | | 18 | The button width and height |



### Emoji

```jsx

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



```



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

| **onPress** | | | Params: `(emoji, event) => {}` |

| **onLongPress** | | | Params: `(emoji, event) => {}` |

| [**fallback**](#unsupported-emojis-fallback) | | | Params: `(emoji, props) => {}` |

| **set** | | `apple` | The emoji set: `'apple', 'google', 'twitter', 'facebook'` |

| **sheetSize** | | `64` | The emoji [sheet size](#sheet-sizes): `16, 20, 32, 64` |

| **sheetColumns** | | `60` | The emoji sheet columns |

| **sheetRows** | | `60` | The emoji sheet rows |

| **spriteSheetFn** | | ``((set, sheetSize) => {uri: `https://unpkg.com/emoji-datasource@5.0.1/sheet_${set}_${sheetSize}.png`})`` | [A Fn](#spritesheetfn) that returns that image sheet to use for emojis. Useful for avoiding a request if you have the sheet locally. |

| **useLocalImages** | | false | [Local image requires](#local-image-requires) |

| **skin** | | `1` | Skin color: `1, 2, 3, 4, 5, 6` |

| [**html**](#using-with-dangerouslysetinnerhtml) | | `false` | Returns an HTML string to use with `dangerouslySetInnerHTML` |



#### Unsupported emojis fallback

Certain sets don’t support all emojis. 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:



```js

 {

    return emoji ? `:${emoji.short_names[0]}:` : props.emoji

  }}

/>

```



## Custom emojis

You can provide custom emojis which will show up in their own category. You can either use a single image as `image` or use a spritesheet as shown in the third object.



```js

import { Picker, NimbleEmoji, getEmojiDataFromCustom } from 'emoji-mart-native'



const customEmojis = [

  {

    name: 'Octocat',

    short_names: ['octocat'],

    text: '',

    emoticons: [],

    keywords: ['github'],

    image: {uri: 'https://github.githubassets.com/images/icons/emoji/octocat.png'},

    customCategory: 'GitHub'

  },

  {

    name: 'Trollface',

    short_names: ['troll', 'trollface'],

    text: '',

    emoticons: [],

    keywords: ['troll'],

    image: require('assets/trollface.png')

  },

  {

    name: 'Test Flag',

    short_names: ['test'],

    text: '',

    emoticons: [],

    keywords: ['test', 'flag'],

    spriteSheet: {uri: 'https://unpkg.com/emoji-datasource-twitter@5.0.1/img/twitter/sheets-256/64.png'},

    sheet_x: 1,

    sheet_y: 1,

    size: 64,

    sheetColumns: 60,

    sheetRows: 60

  },

  {

    name: 'Test Flag',

    short_names: ['test'],

    text: '',

    emoticons: [],

    keywords: ['test', 'flag'],

    spriteSheet: require('assets/twitter/sheets-256/64.png'),

    sheet_x: 1,

    sheet_y: 1,

    size: 64,

    sheetColumns: 60,

    sheetRows: 60

  }

]



const emoji = getEmojiDataFromCustom('troll', customEmojis, emojiData);



```



The `customCategory` string is optional. If you include it, then the custom emoji will be shown in whatever

categories you define. If you don't include it, then there will just be one category called "Custom".



## Not Found

You can provide a custom Not Found object which will allow the appearance of the not found search results to change. In this case, we change the default 'sleuth_or_spy' emoji to Octocat when our search finds no results.



```js

import { Picker } from 'emoji-mart'



const notFound = () => 



```



## Custom category emojis

You can provide custom emojis for the category anchors. You only need to supply the ones you want changed from the default ones.



```js

import { Picker } from 'emoji-mart'



const categoryEmojis = {

  recent: 'fire',

  people: 'see_no_evil',

  nature: 'beetle',

  foods: 'kiwifruit',

  activity: 'table_tennis_paddle_and_ball',

  places: 'airplane',

  objects: 'postal_horn',

  symbols: 'copyright',

  flags: 'triangular_flag_on_post',

  custom: 'hammer_and_wrench',

}



```



## Headless search

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



```js

import { emojiIndex } from 'emoji-mart-native'



emojiIndex.search('christmas').map((o) => o.native)

// => [🎄, 🎅🏼, 🔔, 🎁, ⛄️, ❄️]

```



### With custom data

```js

import data from 'emoji-mart-native/datasets/facebook'

import { NimbleEmojiIndex } from 'emoji-mart-native'



let emojiIndex = new NimbleEmojiIndex(data)

emojiIndex.search('christmas')

```



## Get emoji data from Native

You can get emoji data from native emoji unicode using the `getEmojiDataFromNative` util function.



```js

import { getEmojiDataFromNative, Emoji } from 'emoji-mart-native'

import data from 'emoji-mart-native/data/all.json'



const emojiData = getEmojiDataFromNative('🏊🏽‍♀️', 'apple', data)



```



#### Example of `emojiData` object:

```js

emojiData: {

  "id": "woman-swimming",

  "name": "Woman Swimming",

  "colons": ":woman-swimming::skin-tone-4:",

  "emoticons": [],

  "unified": "1f3ca-1f3fd-200d-2640-fe0f",

  "skin": 4,

  "native": "🏊🏽‍♀️"

}

```



## Storage

By default EmojiMartNative 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.



```js

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



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 Native** return more results than most emoji picker, they’re more accurate and sorted by relevance.



summer



#### Emoticons

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



emoticons



#### Results intersection

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



hand-raised



### Fully customizable

#### Anchors color, title and default emoji

customizable-color



#### Emojis sizes and length

size-and-length



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



customizable-skin



#### Multiple sets supported

Apple / Google / Twitter / Facebook



sets



## Not opinionated

**Emoji Mart Native** 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 `EmojiMartNative.Emoji` component. You could also use `emoji.colons` to insert text into a textarea or `emoji.native` to use the emoji.



### Removing prop-types



To remove [prop-types](https://github.com/facebook/prop-types) in production, use [babel-plugin-transform-react-remove-prop-types](https://github.com/oliviertassinari/babel-plugin-transform-react-remove-prop-types):



```bash

npm install --save-dev babel-plugin-transform-react-remove-prop-types

```



Then add to your `.babelrc`:



```json

"plugins": [

  [

    "transform-react-remove-prop-types",

    {

      "removeImport": true,

      "additionalLibraries": [

        "../../utils/shared-props"

      ]

    }

  ]

]

```



You'll also need to ensure that Babel is transpiling `emoji-mart-native`, e.g. [by not excluding `node_modules` in `babel-loader`](https://github.com/babel/babel-loader#usage).



## Development



```bash

yarn build

```



### Testing Changes



To easier test changes as you make them, you can run `yarn build:link -- --out-dir /$project/node_modules/emoji-mart-native/dist` replacing `$project` with your projects or the example apps location.



## 🎩 Hat tips!

Ported from code brought to you by the Missive team


Powered by [iamcal/emoji-data](https://github.com/iamcal/emoji-data) and inspired by [iamcal/js-emoji](https://github.com/iamcal/js-emoji).


🙌🏼  [Cal Henderson](https://github.com/iamcal).