1.0.14 โ€ข Published 5 years ago

@kinka/react-native-emoticons v1.0.14

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

React Native Emoticons

react native emoticons component, including emoji

emoticons

latest screenshot sample

emoticons

Install

npm install react-native-emoticons

Usage

UI Component

  • step 1

    	Import the component package.
    
    	```js
    	import Emoticons from 'react-native-emoticons';
    	```
  • step 2

    	Write the component code in the proper place of your page render.
    
    	```js
    	<Emoticons
    		 onEmoticonPress={this._onEmoticonPress.bind(this)}
    		 onBackspacePress={this._onBackspacePress.bind(this)}
    		 show={this.state.showEmoticons}
    		 concise={true}
    		 showHistoryBar={true}
    		 showPlusBar={true}

    />

    	```
    	> **Tip:**  The attribute `onEmoticonPress ` can get the emoticos 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
onEmoticonPressFunctioncallback function when the emoticons is pressedYesNone
onBackspacePressFunctioncallback function when the backspace button is pressedYESNone
showBoolshow the componentYESfalse
conciseBoolconcise mod with less emojiNotrue
showHistoryBarBoolenable history functionNotrue
showPlusBarBoolenable more emoticons function(is on developing, if you have interesting on this, welcome pull request.)Notrue
asyncRenderBoolasync renderNofalse

API

Import

import * as emoticons from 'react-native-emoticons';
  1. stringify

    //Most database can't restore the emoji string๐Ÿ˜ค,so we map 
    //them to common string.
    
    const string = emoticons.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 = emoticons.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 = emoticons.splitter('emoji๐Ÿ˜');
    console.log(emoji);
    //output
    ['e','m','o','j','i','๐Ÿ˜']

Further

Support custom emoticons like weixin