# emojitone
> A package for returning emojis with tones
Latest version **0.1.2** (published 2022-03-29) · MIT license · 0 weekly downloads
## Install
```sh
npm install emojitone
pnpm add emojitone
yarn add emojitone
bun add emojitone
```
## Health
**Score 30/100 (F)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities; high quality score.
Warnings: low downloads; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.1.2 |
| Published | 2022-03-29 |
| First published | 2022-03-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Hugo |
| Maintainers | elliottetzkorn |
| Keywords | microbundle, typescript |
## Links
- npm: https://www.npmjs.com/package/emojitone
- Repository: https://github.com/eetzkorn/emojitone.git
- Homepage: https://github.com/eetzkorn/emojitone.git#readme
- Issues: https://github.com/eetzkorn/emojitone.git/issues
- npm.io page: https://npm.io/package/emojitone
## Alternatives
- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads
## Recent versions
- 0.1.2 (latest) — 2022-03-29
- 0.1.1 — 2022-03-29
- 0.1.0 — 2022-03-29
## README
# EmojiTone
## 👋👋🏿👋🏾👋🏽👋🏼👋🏻
Emoji are useful tools for communicating application behavior. I recently finished [a project](https://www.goodvids.so) which heavily uses them and realized while building that I wanted to add an option for users of the project to customize the interface to their liking. There are plenty of packages to do this for theme, but I could not find any for emoji skin tone, so I decided to build EmojiTone.
This package is a simple interface for building with tone-changing emojis. You can use this with state management on your end to allow users to set the tone as part of their user settings. You can then store that state on a server, in the browser, or however you like. This package is just here to help you with the long and complicated switch statements! Enjoy 💓.
## Install
```bash
$ npm install emojitone
# or
$ yarn add emojitone
```
## Use
Using EmojiTone is as simple as importing it and passing in any supported emoji and an accepted tone.
```js
import { et } from 'emojitone'
// Returns 👋🏾
et('👋', 'medium-dark')
```
The accepted tones are:
* `dark`
* `medium-dark`
* `medium`
* `medium-light`
* `light`
## Recommended practices
It is a good idea to combine this package with simple state management on your end. I have built a simple example Next.js application which stores the state in the browser's localestorage to show you what this might look like. Here is [a link](https://emojitone-example.vercel.app) to it running live.
## Currently supported emoji:
👋 🤚 🖐️ ✋ 🖖 🫱 🫲 🫳 🫴 👌 🤌 🤏 ✌️ 🤞 🫰 🤟 🤘 🤙 👈 👉 👆 🖕 👇 ☝️ 🫵 👍 👎 ✊ 👊 🤛 🤜 👏 🙌 🫶 👐 🤲 🤝 🙏 ✍️ 💅 🤳 💪 🦵 🦶 👂 🦻 👃 👶 🧒 👦 👧 🧑 👨 👩 🧓 👴 👵 🙍 🙍♂️ 🙍♀️ 🙎 🙎♂️ 🙎♀️ 🙅 🙅♂️ 🙅♀️ 🙆 🙆♂️ 🙆♀️ 💁 💁♂️ 💁♀️ 🙋 🙋♂️ 🙋♀️ 🧏 🧏♂️ 🧏♀️ 🙇 🙇♂️ 🙇♀️ 🤦 🤦♂️ 🤦♀️ 🤷 🤷♂️ 🤷♀️ 🧑⚕️ 👨⚕️ 👩⚕️ 🧑🎓 👨🎓 👩🎓 🧑🏫 👨🏫 👩🏫 🧑⚖️ 👨⚖️ 👩⚖️ 🧑🌾 👨🌾 👩🌾 🧑🍳 👨🍳 👩🍳 🧑🔧 👨🔧 👩🔧 🧑🏭 👨🏭 👩🏭 🧑💼 👨💼 👩💼 🧑🔬 👨🔬 👩🔬 🧑💻 👨💻 👩💻 🧑🎤 👨🎤 👩🎤 🧑🎨 👨🎨 👩🎨 🧑✈️ 👨✈️ 👩✈️ 🧑🚀 👨🚀 👩🚀 🧑🚒 👨🚒 👩🚒 👮 👮♂️ 👮♀️ 🕵️ 🕵️♂️ 🕵️♀️ 💂 💂♂️ 💂♀️ 🥷 👷 👷♂️ 👷♀️ 🫅 🤴 👸 👳 👳♂️ 👳♀️ 👲 🧕 🤵 🤵♂️ 🤵♀️ 👰 👰♂️ 👰♀️ 🤰 🫃 🫄 🤱 👩🍼 👨🍼 🧑🍼 👼 🎅 🤶 🧑🎄 🦸 🦸♂️ 🦸♀️ 🦹 🦹♂️ 🦹♀️ 🧙 🧙♂️ 🧙♀️ 🧚 🧚♂️ 🧚♀️ 🧛 🧛♂️ 🧛♀️ 🧜 🧜♂️ 🧜♀️ 🧝 🧝♂️ 🧝♀️ 💆 💆♂️ 💆♀️ 💇 💇♂️ 💇♀️ 🚶 🚶♂️ 🚶♀️ 🧍 🧍♂️ 🧍♀️ 🧎 🧎♂️ 🧎♀️ 🧑🦯 👨🦯 👩🦯 🧑🦼 👨🦼 👩🦼 🧑🦽 👨🦽 👩🦽 🏃 🏃♂️ 🏃♀️ 💃 🕺 🕴️ 🧖 🧖♂️ 🧖♀️ 🧗 🧗♂️ 🧗♀️ 🏇 🏂 🏌️ 🏌️♂️ 🏌️♀️ 🏄 🏄♂️ 🏄♀️ 🚣 🚣♂️ 🚣♀️ 🏊 🏊♂️ 🏊♀️ ⛹️ ⛹️♂️ ⛹️♀️ 🏋️ 🏋️♂️ 🏋️♀️ 🚴 🚴♂️ 🚴♀️ 🚵 🚵♂️ 🚵♀️ 🤸 🤸♂️ 🤸♀️ 🤽 🤽♂️ 🤽♀️ 🤾 🤾♂️ 🤾♀️ 🤹 🤹♂️ 🤹♀️ 🧘 🧘♂️ 🧘♀️ 🛀 🛌 🧑🤝🧑 👭 👫 👬 💏 👩❤️💋👨 👨❤️💋👨 👩❤️💋👩 💑 👩❤️👨 👨❤️👨 👩❤️👩
---
_Source: https://npm.io/package/emojitone · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._