46 lines
988 B
TypeScript
46 lines
988 B
TypeScript
|
declare namespace skinTone {
|
|||
|
|
type Tone =
|
|||
|
|
| 'none'
|
|||
|
|
| 'white'
|
|||
|
|
| 'creamWhite'
|
|||
|
|
| 'lightBrown'
|
|||
|
|
| 'brown'
|
|||
|
|
| 'darkBrown';
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
Change the skin tone of an emoji 👌👌🏻👌🏼👌🏽👌🏾👌🏿.
|
|||
|
|
|
|||
|
|
@param emoji - Emoji to modify.
|
|||
|
|
@param tone - Skin tone to use for `emoji`.
|
|||
|
|
|
|||
|
|
- `'none'` : *(Removes skin tone)*
|
|||
|
|
- `'white'` : 🏻 *(Fitzpatrick Type-1–2)*
|
|||
|
|
- `'creamWhite'` : 🏼 *(Fitzpatrick Type-3)*
|
|||
|
|
- `'lightBrown'` : 🏽 *(Fitzpatrick Type-4)*
|
|||
|
|
- `'brown'` : 🏾 *(Fitzpatrick Type-5)*
|
|||
|
|
- `'darkBrown'` : 🏿 *(Fitzpatrick Type-6)*
|
|||
|
|
|
|||
|
|
@example
|
|||
|
|
```
|
|||
|
|
import skinTone = require('skin-tone');
|
|||
|
|
|
|||
|
|
skinTone('👍', 'brown');
|
|||
|
|
//=> '👍🏾'
|
|||
|
|
|
|||
|
|
skinTone('👍', 'white');
|
|||
|
|
//=> '👍🏻'
|
|||
|
|
|
|||
|
|
// can also remove skin tone
|
|||
|
|
skinTone('👍🏾', 'none');
|
|||
|
|
//=> '👍'
|
|||
|
|
|
|||
|
|
// just passes it through when not supported
|
|||
|
|
skinTone('🦄', 'darkBrown');
|
|||
|
|
//=> '🦄'
|
|||
|
|
```
|
|||
|
|
*/
|
|||
|
|
declare function skinTone(emoji: string, tone: skinTone.Tone): string;
|
|||
|
|
|
|||
|
|
export = skinTone;
|