Gecko [ gandhischool.edu.np ]

Name	Size	Permission
lib	[ DIR ]	dr-xr-xr-x
LICENSE	1.05 KB	-rw-rw-rw-
README.md	1.82 KB	-rw-rw-rw-
karma.conf.js	521 B	-rw-rw-rw-
package.json	1.74 KB	-rw-rw-rw-
tests.webpack.js	93 B	-rw-rw-rw-

Code Editor : README.md

# react-twemoji
A simple [React](https://facebook.github.io/react/) wrapper for [Twemoji](https://github.com/jdecked/twemoji).
It calls twemoji.parse() to convert emoji characters to Twemoji images.

## Install

```shell
yarn add react-twemoji
```

or, if you use npm,

```shell
npm install react-twemoji
```

## Usage

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

```jsx
import Twemoji from 'react-twemoji';

<Twemoji options={{ className: 'twemoji' }}>
 😂😉
</Twemoji>
```

It outputs the following HTML to DOM,

```html
<div>
 
 <img draggable="false" class="twemoji" alt="😂" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/72x72/1f602.png">
 
 <img draggable="false" class="twemoji" alt="😉" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/72x72/1f609.png">
 
 
</div>
```

### Props

| Name | Type | Default | Description|
|:---- |:---- |:---- |:----|
| `options` | `object` | `undefined` | `twemoji.parse` options. |
| `noWrapper` | `boolean` | `false` | When it is `true`, `Twemoji` will not render a wrapping element (with `tag`) to contain its children. Note that since `twemoji.parse` needs a DOM element reference, any direct pure text child of `Twemoji` is not parsed when `noWrapper` is `true`. E.g. `foo` in `<Twemoji noWrapper={true}>foobar</Twemoji>` is not parsed. |
| `tag` | `string` | `div` | The tag of the wrapping element. This option is ignored when `noWrapper` is `true`. |

### Run example

```sh
yarn run example
```
then open http://localhost:8080/

## Development
### Lint

```sh
yarn run lint
```

### Test

```sh
yarn run test
```

### Build

```sh
yarn run build
```

${this.title}

Code Editor : README.md