https://github.com/nespecc/emoji-parser
Multiplatform Emoji client
https://github.com/nespecc/emoji-parser
css emoji emoji-parser fallback-images javascript
Last synced: over 1 year ago
JSON representation
Multiplatform Emoji client
- Host: GitHub
- URL: https://github.com/nespecc/emoji-parser
- Owner: neSpecc
- License: mit
- Created: 2016-08-26T15:16:47.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2019-01-29T13:03:53.000Z (over 7 years ago)
- Last Synced: 2025-03-25T06:23:58.684Z (over 1 year ago)
- Topics: css, emoji, emoji-parser, fallback-images, javascript
- Language: CSS
- Size: 6.69 MB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Multiplatform Emoji client 😎
This Module allows you to use Emoji in your Web application interface.
If Emoji are natively supported by user's paltform, it will be rendered as-is. Otherwhise Module will provide fallback images.
## User Guide
To use Emoji in your interface, follow this steps.
- Include `specc-emoji.js` on your site. Bottom of the `` tag prefered.
- Mark all Elements which may content Emoji with `js-emoji-included` class name.
- Fire
```javascript
Emoji.parse();
```
That's it.
😏
### How it works 🤔
First of all it checks for native Emoji supporting. You can access this feature by `Emoji.supported` property
```javascript
if ( Emoji.supported ){
console.log('Emoji natively supported.');
} else {
console.log('Emoji does not supported.');
}
```
If user's platform does not supports Emoji, Module will find and relpace all smiles with fallback images that looks like
```hmtl
```
Cutted Unicode symbols stores in `data-emoji` attribute. Next, CSS class `emoji.css` will stylize this `` tag with fallback images.
Note that Module requires special CSS file `emoji.css`, which placed in `../css/` (from original script) directory. If you need to specify your own style location, open `specc-emoji.js` and change `CSS_FILE_PATH` property to your path.
```javascript
/**
* @private
* Path where styles stored
*/
var CSS_FILE_PATH = 'css/emoji.css';
```
Same thing with CSS file: it uses fallback images by `../emoji/` address.
## Example
Open `example.html` file.
## Questions
Fell free to give me a feedback on specc.dev@gmail.com 😼