Skip to content

Github emoji strings parsed for React apps! ๐ŸŒŸ

Notifications You must be signed in to change notification settings

eveningkid/react-gh-emojis

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

3 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

React Github Emojis

This project is mostly based on zzarcon's github emoji parser.

Important note: emojis are loaded synchronously, which is the main difference with the original repo. Also, the cool other feature is that this parser turns your string into the corresponding JSX once parsed.

Install

npm install react-gh-emojis

API

  • find(text): Return array with matched emojis in text.
  • all(): Return all emojis.
  • exist(emojiId): Check if requested emoji exists.
  • getUrl(emojiId): Return github's image url of emoji.
  • parse(text = '', options = {}): Parse text and replace emoji tags with actual emoji symbols.
    • options: options.classnames, String with custom class names added to each emoji, separated with whitespace.

License

MIT ยฉ eveningkid

About

Github emoji strings parsed for React apps! ๐ŸŒŸ

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published