Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/n-shar-ma/unicode-emoji-toolkit
A lightweight, 0 dependency emoji utility library that actually works as you would expect. (Digits are not emojis!) Detect emojis, filter out non emojis or vice-versa, and much more
https://github.com/n-shar-ma/unicode-emoji-toolkit
emoji emoji-unicode emojis hacktoberfest lightweight regex unicode utility vanilla-javascript-library
Last synced: 9 days ago
JSON representation
A lightweight, 0 dependency emoji utility library that actually works as you would expect. (Digits are not emojis!) Detect emojis, filter out non emojis or vice-versa, and much more
- Host: GitHub
- URL: https://github.com/n-shar-ma/unicode-emoji-toolkit
- Owner: N-Shar-ma
- License: mit
- Created: 2021-07-21T18:10:24.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-11-13T22:36:53.000Z (about 3 years ago)
- Last Synced: 2024-12-12T15:53:38.677Z (13 days ago)
- Topics: emoji, emoji-unicode, emojis, hacktoberfest, lightweight, regex, unicode, utility, vanilla-javascript-library
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/unicode-emoji-toolkit
- Size: 6.12 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# unicode-emoji-toolkit
A lightweight, 0 dependency emoji utility library that actually works as you would expect. (Digits are not emojis!) Detect emojis, filter out non emojis or vice-versa, and much more
unicode-emoji-toolkit differs from other libraries that deal with emojis and regex, by being opinionated and **NOT treating digits `[0-9]`, `#` and `*` as emojis**, despite the Unicode Standard officially including them in Emoji characters.
Most people, including me, do not consider these characters to be emojis, and hence this library was born. As you might expect, it still counts #️⃣,*️⃣ and 0️⃣-9️⃣ as emojis
## Installation
Using npm:
```
npm install unicode-emoji-toolkit
```
or
```
npm i unicode-emoji-toolkit
```
## Usage
- Import the library
```
const emj = require("unicode-emoji-toolkit")
```
- `boolean hasEmojis(str: string)`
```
console.log(emj.hasEmojis("💜abc1️⃣"))
// true
```
- `boolean hasNoEmojis(str: string)`
```
console.log(emj.hasNoEmojis("abc1#"))
// true
```
- `boolean hasOnlyEmojis(str: string)`
```
console.log(emj.hasOnlyEmojis("🆗❤🧡💛💲💚💝💜1️⃣"))
// true
```
- `string removeEmojis(str: string)`
```
console.log(emj.removeEmojis("💜abc1️⃣"))
// "abc"
```
- `string removeNonEmojis(str: string)`
```
console.log(emj.removeNonEmojis("💜abc1️⃣"))
// "💜1️⃣"
```
## Contributing
Pull requests for any bug fixes or enhancements are welcome!
- Do create an issue before before starting work on a PR.
- After forking and cloning this repositry to your local machine, run `npm install` to install the developement dependency(jest) for testing.
- After making the proposed changes locally, add tests and update the usage section in the README if and as required.
- Bump up the version by running `npm version [major | minor | patch]` according to the changes made. Refer to [SemVer](https://semver.org) for more help.
- Be sure to run all tests using `npm run test` before pushing, and make a PR only if all tests pass.
## License
[MIT](https://choosealicense.com/licenses/mit/)