Go to file
Jakub Grzywacz dc41597431
chore: release 0.1.1-beta.1
2021-07-12 17:44:38 +02:00
.circleci chore: initial commit 2021-07-03 19:51:30 +02:00
example refactor: use native panResponder instead of RNGH 2021-07-12 17:42:48 +02:00
scripts chore: add translation 2021-07-12 11:17:39 +02:00
src refactor: use native panResponder instead of RNGH 2021-07-12 17:42:48 +02:00
.editorconfig chore: initial commit 2021-07-03 19:51:30 +02:00
.gitattributes chore: initial commit 2021-07-03 19:51:30 +02:00
.gitignore chore: initial commit 2021-07-03 19:51:30 +02:00
.yarnrc chore: initial commit 2021-07-03 19:51:30 +02:00
CONTRIBUTING.md chore: initial commit 2021-07-03 19:51:30 +02:00
LICENSE chore: initial commit 2021-07-03 19:51:30 +02:00
README.md chore: add category disable props 2021-07-12 13:57:10 +02:00
babel.config.js chore: initial commit 2021-07-03 19:51:30 +02:00
package.json chore: release 0.1.1-beta.1 2021-07-12 17:44:38 +02:00
tsconfig.build.json chore: initial commit 2021-07-03 19:51:30 +02:00
tsconfig.json chore: initial commit 2021-07-03 19:51:30 +02:00
yarn.lock refactor: use native panResponder instead of RNGH 2021-07-12 17:42:48 +02:00

README.md

react-native-emoji-keyboard

Preview

Usage

import EmojiPicker from '{package-name}';

export default function App() {
  const [isOpen, setIsOpen] = React.useState<boolean>(false);

  const handlePick = (emojiObject: EmojiType) => {
    console.log(emojiObject);
    /* example emojiObject = {    {
        "emoji": "❤️",
        "name": "red heart",
        "slug": "red_heart",
      },
    */
  };

  return (
    <EmojiPicker
      onEmojiSelected={handleSelect}
      open={isOpen}
      onClose={() => setIsOpen(false)} />
  )
}

Installation

yarn add {package-name}

or

npm install {package-name}

Full Example

TODO

Accepted props (current implemented)

Name Type Default Value Required Description
onEmojiSelected function undefined yes Callback on emoji selected
open boolean false yes Opens modal picker
onClose function undefined yes Request close modal runs when onEmojiSelected or backdrop pressed
emojiSize number 28 no Custom emoji size
headerStyles TextStyle {} no Override category name styles
knobStyles ViewStyle {} no Override knob styles
containerStyles ViewStyle {} no Override container styles
hideHeader boolean false no Hide category names
expandable boolean true no Show knob and enable expand on swipe up
defaultHeight number | string "40%" no Specify collapsed container height (number is points, string is a percentage of the screen height)
expandedHeight number | string "80%" no Specify expanded container height (number is points, string is a percentage of the screen height) works only if expandable is true
backdropColor string "#00000055" no Change backdrop color and alpha
categoryColor string "#000000" no Change category item color
activeCategoryColor string "#005b96" no Change active category item color
categoryContainerColor string "#e3dbcd" no Change category container color
onCategoryChangeFailed function warn(info) no Callback on category change failed (info: {index, highestMeasuredFrameIndex, averageItemLength})
translation CategoryTranslation en no Translation object see translation section
disabledCategory CategoryTypes[] [] no Hide categories by passing their slugs

Internationalization

Pre-defined

Due to the limited translation possibilities, we only provide a few pre-defined translations into the following languages:

  • en - English
  • pl - Polish

First import lang and use it as translation prop.

import { pl } from '{package-name}';

// ...

translation={pl}

Own

There is possibility to pass own translation to library with the prop called translation like this

translation={{
  smileys_emotion: 'Smileys & Emotion',
  people_body: 'People & Body',
  animals_nature: 'Animals & Nature',
  food_drink: 'Food & Drink',
  travel_places: 'Travel & Places',
  activities: 'Activities',
  objects: 'Objects',
  symbols: 'Symbols',
  flags: 'Flags',
}}

If you have written a translation into your language, we strongly encourage you to create a Pull Request and add your language to the package, following the example of other langs.

License

MIT