5.1.0 โ€ข Published 2 years ago

@syedsadiqali11/emoji-mart v5.1.0

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

๐Ÿ’พ Data

Data required for the picker to work has been completely decoupled from the library. That gives developers the flexibility to better control their app bundle size and let them choose how and when this data is loaded. Data can be:

Bundled directly into your codebase

Pros: Picker renders instantly, data is available offline Cons: Slower initial page load (bigger file to load)

yarn install @emoji-mart/data
import data from '@emoji-mart/data'
import { Picker } from 'emoji-mart'

new Picker({ data })

Fetched remotely

Pros: Data fetched only when needed, does not affect your app bundle size Cons: Network latency, doesnโ€™t work offline (unless you configure a ServiceWorker)

import { Picker } from 'emoji-mart'
new Picker({
  data: async () => {
    const response = await fetch(
      'https://cdn.jsdelivr.net/npm/@emoji-mart/data',
    )

    return response.json()
  }
})

In this example data is fetched from a content delivery network, but it could also be fetched from your own domain if you want to host the data.

๐Ÿง‘โ€๐Ÿ’ป Usage

React

npm install --save emoji-mart @emoji-mart/data
import React, { useEffect, useRef } from 'react'
import { render } from 'react-dom'

import data from '@emoji-mart/data'
import { Picker } from 'emoji-mart'

function EmojiPicker(props) {
  const ref = useRef()

  useEffect(() => {
    new Picker({ ...props, data, ref })
  }, [])

  return <div ref={ref} />
}

render(<EmojiPicker onEmojiSelect={console.log} />, document.querySelector('#picker'))

Browser

<script type="module">
  import data from 'https://cdn.jsdelivr.net/npm/@emoji-mart/data'
  import * as EmojiMart from 'https://cdn.jsdelivr.net/npm/emoji-mart@latest/dist/index.js'

  const picker = new EmojiMart.Picker({ data, onEmojiSelect: console.log })
  document.querySelector('#picker').appendChild(picker)
</script>

๐Ÿ—บ Internationalization

EmojiMart UI supports multiple languages, feel free to open a PR if yours is missing.

import i18n from '@emoji-mart/data/i18n/fr.json'
i18n.search_no_results_1 = 'Aucun emoji'

new Picker({ i18n })

Given the small file size, English is built-in and doesnโ€™t need to be provided.

๐Ÿ“š Documentation

Coming soon. See examples for now.

๐Ÿค“ Built for modern browsers

EmojiMart relies on these APIs, you may need to include polyfills if you need to support older browsers:

๐Ÿ›  Development

yarn install
yarn dev
abortcontroller-polyfillacornansi-stylesbase-xbrowserslistanymatchboolbasebinary-extensionsbracescallsiteschalkcaniuse-apibuffer-fromclonechokidarchrome-trace-eventcolor-namecolor-convertcss-declaration-sortercolordcosmiconfigcss-treecommandercss-whatcss-selectcssnanocssnano-preset-defaultcssocssnano-utilscssescdetect-libccaniuse-litedomutilsdom-serializerdomhandlerdotenventitiesescaladedotenv-expandfraction.jselectron-to-chromiumerror-exescape-string-regexpget-portglobalsfill-rangeglob-parenthas-flaghtmlnanohtmlparser2fseventsimmutableimport-freshis-arrayishis-binary-pathis-globis-extglobis-jsonjs-tokensjson-parse-even-better-errorsdomelementtypejson-source-maplilconfigis-numberlines-and-columnslmdbjson5lodash.uniqlodash.memoizemsgpackrmdn-datamsgpackr-extractnode-gyp-buildnode-addon-apinode-releasesnode-gyp-build-optional-packagesnormalize-pathnth-checknormalize-rangeordered-binarynullthrowsnanoidpath-typeparse-jsonpicocolorspicomatchpostcsspostcss-calcpostcss-colorminpostcss-convert-valuesparent-modulenormalize-urlpostcss-merge-longhandpostcss-merge-rulespostcss-discard-emptypostcss-minify-gradientspostcss-minify-font-valuespostcss-discard-commentspostcss-discard-duplicatespostcss-discard-overriddenpostcss-minify-paramspostcss-minify-selectorspostcss-normalize-positionspostcss-normalize-repeat-stylepostcss-normalize-display-valuespostcss-normalize-charsetpostcss-normalize-timing-functionspostcss-normalize-unicodepostcss-normalize-stringpostcss-normalize-whitespacepostcss-ordered-valuespostcss-reduce-initialpostcss-normalize-urlpostcss-reduce-transformspostcss-unique-selectorspostcss-value-parserpostcss-svgopostcss-selector-parserposthtml-parserposthtml-renderreaddirpposthtmlregenerator-runtimereact-refreshsasssafe-bufferresolve-fromsemversource-map-supportstylehackstersersupports-colorstablesvgotype-festto-regex-rangeutil-deprecatetimsortupdate-browserslist-dbutility-typesyamlxxhash-wasmsource-map-jssource-mapweak-lru-cachev8-compile-cache
5.1.0

2 years ago