https://github.com/eveningkid/react-gh-emojis
Github emoji strings parsed for React apps! 🌟
https://github.com/eveningkid/react-gh-emojis
emoji emojis github react reactjs
Last synced: 3 months ago
JSON representation
Github emoji strings parsed for React apps! 🌟
- Host: GitHub
- URL: https://github.com/eveningkid/react-gh-emojis
- Owner: eveningkid
- Created: 2017-03-18T17:15:38.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-18T17:15:53.000Z (about 8 years ago)
- Last Synced: 2025-03-04T23:18:12.174Z (3 months ago)
- Topics: emoji, emojis, github, react, reactjs
- Language: JavaScript
- Size: 17.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React Github Emojis
> This project is mostly based on [zzarcon's github emoji parser](https://github.com/zzarcon/gh-emoji).
**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](//github.com/eveningkid)