Skip to main content

interweave-emoji

Build Status npm version npm deps

Provides emoji support for Interweave.

<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

Installation

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

Documentation

https://interweave.dev/docs/exts/emoji

Index

Type aliases

Path

Path: string | (hexcode: Hexcode, config: PathConfig) => string

Size

Size: number | string

Variables

constLATEST_DATASET_VERSION

LATEST_DATASET_VERSION: 7.0.1 = '7.0.1'

constMAX_EMOJI_VERSION

MAX_EMOJI_VERSION: 14 = 14