interweave-emoji/README.md

Emoji support for Interweave.

# Interweave with Emoji

[![Build Status](https://github.com/milesj/interweave/workflows/Build/badge.svg)](https://github.com/milesj/interweave/actions?query=branch%3Amaster)
[![npm version](https://badge.fury.io/js/interweave-emoji.svg)](https://www.npmjs.com/package/interweave-emoji)
[![npm deps](https://david-dm.org/milesj/interweave.svg?path=packages/emoji)](https://www.npmjs.com/package/interweave-emoji)

Provides emoji support for [Interweave](https://github.com/milesj/interweave).

```tsx
<Interweave
	content="This will convert emoji unicode characters (🌀), shortcodes (:cyclone:), and emoticons to SVGs! :)"
	matchers={[
		new EmojiMatcher('emoji', {
			convertEmoticon: true,
			convertShortcode: true,
		}),
	]}
	emojiPath={getSvgPathForEmoji}
/>
```

## Requirements

- [Emojibase](https://emojibase.dev)

## Installation

```
yarn add interweave interweave-emoji emojibase
// Or
npm install interweave interweave-emoji emojibase
```

## Documentation

[https://interweave.dev/docs/exts/emoji](https://interweave.dev/docs/exts/emoji)