11# emojify.js
22
3- [ ![ Maintenance] ( https://img.shields.io/maintenance/no/red.svg )] ( )
4-
5- [ ![ npm version] [ ico-npm ]] [ package-npm ]
6- [ ![ Bower version] [ ico-bower ]] [ package-bower ]
7- [ ![ MIT Licensed] [ ico-license ]] [ license ]
8- [ ![ Gitter chat] [ ico-gitter ]] [ gitter ]
9-
10- ---
11-
12- > This project is currently unmaintained.
3+ Note: This is fork rewrite version of emojify.js with TypeScript and up-to-date dependencies.
134
145---
156
16- Master | Develop
17- --- | ---
18- [ ![ Master branch build status] [ ico-build ]] [ travis ] | [ ![ Develop branch build status] [ ico-build-dev ]] [ travis ]
19- [ ![ Master branch Windows build status] [ ico-windows-build ]] [ appveyor ] | [ ![ Develop branch Windows build status] [ ico-windows-build-dev ]] [ appveyor ]
20-
21- [ ![ Browser Results] ( https://ci.testling.com/hassankhan/emojify.js.png )] ( https://ci.testling.com/hassankhan/emojify.js )
22-
237A swiss-army-knife for all emoji, in Javascript. Used by [ Gitter] ( https://gitter.im/ ) and [ Mapbox] ( https://www.mapbox.com/blog/emoji-map-markers/ ) .
248
259The emoji keywords are as described by [ emoji-cheat-sheet.com] ( http://www.emoji-cheat-sheet.com ) .
2610
27- Go to this project's [ GitHub pages] ( http://hassankhan.github.com/emojify.js ) to see the code in action.
28-
2911## Features
3012
3113- Fast
@@ -40,27 +22,9 @@ Go to this project's [GitHub pages](http://hassankhan.github.com/emojify.js) to
4022
4123## Installation
4224
43- Care about old browsers compatibility? Use https://github.com/es-shims/es5-shim
44-
45- ### Via cdnjs
46-
47- emojify.js is now available on cdnjs - https://cdnjs.com/libraries/emojify.js
48-
49- Add this to the rest of your stylesheet imports:
50-
51- ` <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/emojify.js/1.1.0/css/basic/emojify.min.css" /> `
52-
53- Then add this to your Javascript code:
54-
55- ` <script src="//cdnjs.cloudflare.com/ajax/libs/emojify.js/1.1.0/js/emojify.min.js"></script> `
56-
57- ### Via Bower
58-
59- ` bower install emojify.js --save `
60-
6125### Via npm
6226
63- ` npm install emojify.js --save `
27+ ` npm install @yukaii/ emojify.js --save `
6428
6529## API
6630
@@ -97,8 +61,8 @@ emojify.setConfig({tag_type : 'div'});
9761- ` element ` - Optional HTML element to restrict the emojification to.
9862- ` replacer ` - Optional Function to override emoji replacement behaviour with your own. The function will receive two arguments, the emoji pattern found (` emoji ` ), and the emoji name (` name ` ). In the case of emoticons, for example, ` emoji = ':)' ` and ` name = 'smile' ` . Your function must return a HTMLElement.
9963
100-
10164##### Browser
65+
10266``` js
10367emojify .run ();
10468// OR
@@ -113,6 +77,7 @@ emojify.run(null, function(emoji, emojiName){
11377```
11478
11579##### Node.js
80+
11681Requires you to have jsdom installed:
11782` npm i jsdom --save `
11883
@@ -126,13 +91,15 @@ jsdom.env({
12691 }
12792});
12893```
94+
12995---
13096
13197### replace(string, [ callback] )
13298
13399* This works in the browser and on Node*
134100
135101#### Parameters
102+
136103- ` string ` - String to emojify
137104- ` callback ` - Optional callback function to output emoji with
138105
@@ -163,6 +130,7 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md).
163130
164131- [ All Contributors] ( https://github.com/hassankhan/emojify.js/contributors )
165132- [ Hassan Khan] ( https://github.com/hassankhan )
133+ - [ Yukai Huang] ( https://github.com/Yukaii )
166134
167135## License
168136
0 commit comments