remark-emoji
Advanced tools
Package description
The remark-emoji npm package is a plugin for the remark processor that allows you to convert text-based emoji shortcodes into their corresponding Unicode emoji characters. This can be particularly useful for rendering markdown content with emojis in a more visually appealing way.
Convert Emoji Shortcodes to Unicode
This feature allows you to convert text-based emoji shortcodes (e.g., :heart:) into their corresponding Unicode emoji characters (❤️). The code sample demonstrates how to use the remark-emoji plugin with the remark processor to achieve this conversion.
const remark = require('remark');
const emoji = require('remark-emoji');
const markdown = 'I :heart: remark-emoji!';
remark()
.use(emoji)
.process(markdown, function (err, file) {
if (err) throw err;
console.log(String(file));
});The markdown-it-emoji package is a plugin for the markdown-it parser that converts emoji shortcodes into Unicode emoji characters. It offers similar functionality to remark-emoji but is designed to work with the markdown-it ecosystem instead of remark.
The emojione package provides a comprehensive set of tools for working with emojis, including converting shortcodes to Unicode and vice versa. While it offers broader functionality beyond just markdown processing, it can be used in conjunction with markdown parsers to achieve similar results to remark-emoji.
The emoji-dictionary package provides a simple way to convert emoji shortcodes to Unicode characters and vice versa. It is a lightweight alternative that can be integrated into various text processing workflows, including markdown processing, to achieve similar functionality to remark-emoji.
Changelog
v4.0.0 - 10 Aug 2023
[Changes][v4.0.0]
<!-- Generated by https://github.com/rhysd/changelog-from-release v3.7.2 -->Readme
remark-emoji is a remark plugin to replace :emoji: to real UTF-8
emojis in text. Accessibility support and Emoticon support are optionally available.
You can find a demo in the following Codesandbox.
remark().use(emoji [, options]);
import {remark} from 'remark';
import emoji from 'remark-emoji';
const doc = 'Emojis in this text will be replaced: :dog: :+1:';
const processor = remark().use(emoji);
const file = await processor.process(doc);
console.log(String(file));
// => Emojis in this text will be replaced: 🐶 👍
Note that this package is ESM only from v3.0.0 since remark packages migrated to ESM.
options.accessibleSetting to true makes the converted emoji text accessible with role and aria-label attributes. Each emoji
text is wrapped with <span> element. Note that role attribute is not allowed by default. Please add it to
the sanitization schema used by remark's HTML transformer.
For example,
import {remark} from 'remark';
import toHtml from 'remark-html';
import {defaultSchema} from 'hast-util-sanitize'
import emoji from 'remark-emoji';
// Allow using `role` attribute in transformed HTML document
const schema = structuredClone(defaultSchema);
if ('span' in schema.attributes) {
schema.attributes.span.push('role');
} else {
schema.attributes.span = ['role'];
}
const processor = remark()
.use(emoji, { accessible: true })
.use(toHtml, { sanitize: schema });
const file = await processor.process('Hello :dog:!');
console.log(String(file));
yields
Hello <span role="img" aria-label="dog emoji">🐶</span>!
Default value is false.
options.padSpaceAfterSetting to true means that an extra whitespace is added after emoji.
This is useful when browser handle emojis with half character length and following character is hidden.
Default value is false.
options.emoticonSetting to true means that emoticon shortcodes are supported (e.g. :-)
will be replaced by 😃). Default value is false.
remark-emoji package contains TypeScript type definitions. The package is ready for use with TypeScript.
Note that the legacy node (or node10) resolution at moduleResolution
is not available since it enforces CommonJS module resolution and this package is ESM only. Please use node16,
bundler, or nodenext to enable ESM module resolution.
Distributed under the MIT License.
FAQs
Emoji transformer plugin for Remark
The npm package remark-emoji receives a total of 364,991 weekly downloads. As such, remark-emoji popularity was classified as popular.
We found that remark-emoji demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.