retext-emoji
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatretext plugin to support emoji (
❤️
), gemoji (:heart:
), and
emoticons (<3
).Contents
* [`unified().use(retextEmoji[, options])`](#unifieduseretextemoji-options)
* [`Options`](#options)
What is this?
This package is a unified (retext) plugin to classify emoji (❤️
),
gemoji (:heart:
), and emoticons (<3
) as a specific node, and to optionally
transform them from one type to another.When should I use this?
You can either use this plugin any time there are emoji, gemoji, or emoticons in prose that are (incorrectly) warned about by linting plugins, or you can use it to transform them.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install retext-emoji
In Deno with
esm.sh
esmsh:import retextEmoji from 'https://esm.sh/retext-emoji@9'
In browsers with
esm.sh
esmsh:<script type="module">
import retextEmoji from 'https://esm.sh/retext-emoji@9?bundle'
</script>
Use
import retext from 'retext'
import emoji from 'retext-emoji'
const file = await retext()
.use(emoji, {convert: 'encode'})
.process('I’m going to bed. :zzz:')
console.log(String(file))
Yields:
I’m going to bed. 💤
API
This package exports no identifiers. The default export isretextEmoji
api-retext-emoji.unified().use(retextEmoji[, options])
Plugin to support emoji (❤️
), gemoji (:heart:
), and emoticons (<3
).Parameters
options
(Options
api-options, optional)
— configuration
Returns
Transform (Transformer
unified-transformer).Options
Configuration (TypeScript type).Fields
convert
('encode'
or'decode'
, optional)
— whether to decode (`❤️` and `<3` to `:heart:`), encode (`:heart:` and
`<3` to `❤️`), or do nothing
Data
retext-emoji
supports every emoticon
emoticon and gemoji
gemoji.Syntax tree
This plugin applies several nlcst utilities to build the AST. See their readmes for the node types supported in the tree:— emoticons
— emoji and gemoji
Types
This package is fully typed with TypeScript. It exports the additional typeOptions
api-options.The
Emoticon
node is exposed from
nlcst-emoticon-modifier
nlcst-emoticon-modifier.Compatibility
Projects maintained by the unified collective are compatible with maintained versions of Node.js.When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line,
retext-emoji@^9
,
compatible with Node.js 16.Contribute
Seecontributing.md
contributing in retextjs/.github
health for ways
to get started.
See support.md
support for ways to get help.This project has a code of conductcoc. By interacting with this repository, organisation, or community you agree to abide by its terms.