mirror/twemoji
1
0
Fork 0
mirror of https://github.com/twitter/twemoji.git synced 2024-12-27 03:16:23 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #142 from thesabbir/docs-01

Browse Source 
Basic utilities / helpers added to docs
This commit is contained in:
Andrea Giammarchi 2016-04-27 14:32:15 +01:00
commit f4c7f2c32e
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -252,6 +252,25 @@ twemoji.parse(genericNode, {
```
This will generate urls such `https://twemoji.maxcdn.com/svg/2764.svg` instead of using a specific size based one.
## Utilities
Basic utilities / helpers to convert code points to JavaScript surrogates and vice versa.
#### twemoji.convert.fromCodePoint()
For given an HEX codepoint, returns UTF16 surrogate pairs.
```js
twemoji.convert.fromCodePoint('1f1e8');
// "\ud83c\udde8"
```
#### twemoji.convert.toCodePoint()
For given UTF16 surrogate pairs, returns the equivalent HEX codepoint.
```js
twemoji.convert.toCodePoint('\ud83c\udde8\ud83c\uddf3');
// "1f1e8-1f1f3"
twemoji.convert.toCodePoint('\ud83c\udde8\ud83c\uddf3', '~');
// "1f1e8~1f1f3"
```
## Tips