1.0.4 โ€ข Published 5 years ago

react-native-emoji-select-board v1.0.4

Weekly downloads
-
License
MIT
Repository
-
Last release
5 years ago

React Native Emoji

react native emoji component

Install

npm install react-native-emoji-select-board --save

Usage

UI Component

  • step 1

    	Import the component package.
    
    	```js
    	import EmojiBoard from 'react-native-emoji-select-board';
    	```
  • step 2

    	Write the component code in the proper place of your page render.
    
    	```js
    	<EmojiBoard
    		 onEmojiIconPress={this._onEmojiIconPress.bind(this)}
    		 onBackspacePress={this._onBackspacePress.bind(this)}
    		 show={this.state.showEmojiicons}
    		 concise={true}
    		 showHistoryBar={true}
    		 showPlusBar={true}

    />

    	```
    	> **Tip:**  The attribute `onEmojiIconPress ` can get the emojiicos results like `{code:'๐Ÿ˜', name: 'GRIMACING FACE'}`. The attribute `show ` will control that if the component is visible.  The attribute `onBackspacePress ` will add a function for backspace button. 

props

PropTypeDescriptionRequiredDefault
onEmojiIconPressFunctioncallback function when the emojiicons is pressedYesNone
onBackspacePressFunctioncallback function when the backspace button is pressedYESNone
showBoolshow the componentYESfalse
conciseBoolconcise mod with less emojiNotrue
showHistoryBarBoolenable history functionNotrue
showPlusBarBoolenable more emojiicons function(is on developing, if you have interesting on this, welcome pull request.)Nofalse
asyncRenderBoolasync renderNofalse
blackListArrayput some emojis into black list by using short_nameNo[]

API

Import

import * as emojiicons from 'react-native-emoji-select-board';
  1. stringify

    //Most database can't restore the emoji string๐Ÿ˜ค,so we map 
    //them to common string.
    
    const string = emojiicons.stringify('This is source emoji ๐Ÿ˜');
    console.log(string);
    //output
    'This is source emoji [GRIMACING FACE]'
  2. parse

    //If we want to show the emoji(fetch from database) in view page
    //we need parse the string
    
    const emoji = emojiicons.parse('This is source emoji [GRIMACING FACE]');
    console.log(emoji);
    //output
    'This is source emoji ๐Ÿ˜'
  3. splitter

    //this api is for backspace function
    const emoji = emojiicons.splitter('emoji๐Ÿ˜');
    console.log(emoji);
    //output
    ['e','m','o','j','i','๐Ÿ˜']