Info on ASCII emoticons
npm install emoticon[![Build][badge-build-image]][badge-build-url]
[![Coverage][badge-coverage-image]][badge-coverage-url]
[![Downloads][badge-downloads-image]][badge-downloads-url]
[![Size][badge-size-image]][badge-size-url]
List of emoticons.
* What is this?
* When should I use this?
* Install
* Use
* API
* emoticon
* List of emoticons
* Types
* Compatibility
* Security
* Related
* Contribute
* License
This package contains info on ASCII emoticons.
:p
You can use this package for several reasons, typically in a build script,
for example to figure out which text emoticons map to what emoji.
This package is [ESM only][github-gist-esm].
In Node.js (version 14.14+), install with [npm][npm-install]:
``sh`
npm install emoticon
In Deno with [esm.sh][esm-sh]:
`js`
import {emoticon} from 'https://esm.sh/emoticon@4'
In browsers with [esm.sh][esm-sh]:
`html`
`js
import {emoticon} from 'emoticon'
console.log(emoticon.slice(0, 3))
`
Yields:
`js`
[
{
description: 'angry face',
emoji: '😠',
emoticons: [
'>:(', '>:[',
'>:-(', '>:-[',
'>=(', '>=[',
'>=-(', '>=-['
],
name: 'angry',
tags: [ 'mad', 'annoyed' ]
},
{
description: 'smiling face with smiling eyes',
emoji: '😊',
emoticons: [
':")', ':"]', ':"D',
':-")', ':-"]', ':-"D',
'=")', '="]', '="D',
'=-")', '=-"]', '=-"D'
],
name: 'blush',
tags: [ 'proud' ]
},
{
description: 'broken heart',
emoji: '💔',
emoticons: [ '<\\3', '3' ],
name: 'broken_heart',
tags: []
}
]
This package exports the identifier emoticon.
There is no default export.
List of emoticons (Array), where each entry has the following
fields:
* description (string)wooorm/gemoji
— associated description (from [][github-gemoji])emoji
* (string)emoticons
— corresponding emoji
* (Array)name
— ASCII emoticons
* (string)wooorm/gemoji
— name of an emoticon (preferred name from [][github-gemoji])tags
* (Array)wooorm/gemoji
— associated tags (from [][github-gemoji])
See [support.md][file-support].
This package is fully typed with [TypeScript][].
It exports an additional type Emoticon.
This package is at least compatible with all maintained versions of Node.js.
As of now, that is Node.js 14.14+.
It also works in Deno and modern browsers.
This package is safe.
* [wooorm/gemoji][github-gemoji]words/emoji-emotion
— info on gemoji (GitHub emoji)
* wooorm/emoticon
— list of emoji rated for valence
* wooorm/strip-skin-tone
— info on ASCII emoticons
* wooorm.com/checkmoji`
— strip skin-tones from emoji
*
— check emoji across platforms
Yes please!
See [How to Contribute to Open Source][open-source-guide-contribute].
[MIT][file-license] © [Titus Wormer][wooorm]
[badge-build-image]: https://github.com/wooorm/emoticon/workflows/main/badge.svg
[badge-build-url]: https://github.com/wooorm/emoticon/actions
[badge-coverage-image]: https://img.shields.io/codecov/c/github/wooorm/emoticon.svg
[badge-coverage-url]: https://codecov.io/github/wooorm/emoticon
[badge-downloads-image]: https://img.shields.io/npm/dm/emoticon.svg
[badge-downloads-url]: https://www.npmjs.com/package/emoticon
[badge-size-image]: https://img.shields.io/bundlejs/size/emoticon
[badge-size-url]: https://bundlejs.com/?q=emoticon
[esm-sh]: https://esm.sh
[github-gist-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[file-license]: license
[file-support]: support.md
[npm-install]: https://docs.npmjs.com/cli/install
[typescript]: https://www.typescriptlang.org
[wooorm]: https://wooorm.com
[github-gemoji]: https://github.com/wooorm/gemoji
[open-source-guide-contribute]: https://opensource.guide/how-to-contribute/