react-twemoji

A simple React wrapper for Twemoji. It calls twemoji.parse() to convert emoji characters to Twemoji images.

Install

yarn add react-twemoji

or, if you use npm,

npm install react-twemoji

Usage

Simply use it to wrap your emotional content. Set options prop to pass options to twemoji.parse.

import Twemoji from 'react-twemoji';

<Twemoji options={{ className: 'twemoji' }}>
  <p>?<span>?</span></p>
</Twemoji>

It outputs following HTML to DOM,

<div>
  <p>
    <img draggable="false" class="twemoji" alt="?" src="https://twemoji.maxcdn.com/2/72x72/1f602.png">
    <span>
      <img draggable="false" class="twemoji" alt="?" src="https://twemoji.maxcdn.com/2/72x72/1f609.png">
    </span>
  </p>
</div>

Props

Name Type Default Description
options Object {} twemoji.parse options
noWrapper Boolean false When it is true, Twemoji will not render a wrapping div to contain children

Run example

yarn run example

then open http://localhost:8080/

Development

Lint

yarn run lint

Test

yarn run test

Build

yarn run build

GitHub