npm.io
4.0.0 β€’ Published 2 years ago

skin-tone

Licence
MIT
Version
4.0.0
Deps
0
Size
6 kB
Vulns
0
Weekly
0
Stars
64

skin-tone

Change the skin tone of an emoji

The Fitzpatrick scale is used to specify skin tones for emoji characters which represent humans.

Install

npm install skin-tone

Usage

import skinTone from 'skin-tone';

skinTone('πŸ‘', 'brown');
//=> 'πŸ‘πŸΎ'

skinTone('πŸ‘', 'white');
//=> 'πŸ‘πŸ»'

// Can also remove skin tone.
skinTone('πŸ‘πŸΎ', 'none');
//=> 'πŸ‘'

// Just passes it through when not supported.
skinTone('πŸ¦„', 'darkBrown');
//=> 'πŸ¦„'

API

skinTone(emoji, type)
emoji

Type: string

Emoji to modify.

type

Type: 'none' | 'white' | 'creamWhite' | 'lightBrown' | 'brown' | 'darkBrown'

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)

Skin tone to use for emoji.

Keywords