remark-emoji

WebJar for remark-emoji

License	MIT
GroupId	org.webjars.npm
ArtifactId	remark-emoji
Last Version	2.1.0
Release Date	Aug 24, 2020
Type	jar
Description	remark-emoji WebJar for remark-emoji
Project URL	https://www.webjars.org
Source Code Management	https://github.com/rhysd/remark-emoji

Download remark-emoji

Filename	Size
remark-emoji-2.1.0.pom
remark-emoji-2.1.0.jar	7 KB
remark-emoji-2.1.0-sources.jar	22 bytes
remark-emoji-2.1.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/remark-emoji/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>remark-emoji</artifactId>
    <version>2.1.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/remark-emoji/
implementation 'org.webjars.npm:remark-emoji:2.1.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/remark-emoji/
implementation ("org.webjars.npm:remark-emoji:2.1.0")

Apache Buildr

'org.webjars.npm:remark-emoji:jar:2.1.0'

Apache Ivy

<dependency org="org.webjars.npm" name="remark-emoji" rev="2.1.0">
  <artifact name="remark-emoji" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='remark-emoji', version='2.1.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "remark-emoji" % "2.1.0"

Leiningen

[org.webjars.npm/remark-emoji "2.1.0"]

Dependencies

compile (3)

Group / Artifact	Type	Version
org.webjars.npm » emoticon	jar	[3.2.0,4)
org.webjars.npm : node-emoji	jar	[1.10.0,2)
org.webjars.npm : unist-util-visit	jar	[2.0.2,3)

Project Modules

There are no modules declared in this project.

remark-emoji

This is a remark plugin to replace :emoji: to real UTF-8 emojis in text.

Demo

You can find a demo in the following Codesandbox.

Usage

remark().use(emoji [, options]);

const remark = require('remark');
const emoji = require('remark-emoji');

const doc = 'Emojis in this text will be replaced: :dog: :+1:';
console.log(remark().use(emoji).process(doc).contents);
// => Emojis in this text will be replaced: 🐶 👍

Options

options.padSpaceAfter

Setting 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.emoticon

Setting to true means that emoticon shortcodes are supported (e.g. :-) will be replaced by 😃 ). Default value is false.

License

Distributed under the MIT License.

Versions

Version
2.1.0 Aug 24, 2020