react-headzoo-emoji

React Emoji Component
=====================
React component wrapper for the twemoji library
which converts unicode emoji codepoints into emoji images.

A demo is available at http://headzoo.io/react-headzoo-emoji.


$3

npm install --save react-headzoo-emoji

$3

Wrap content where emoji should be converted into images. By default
the emoji are converted into images which are hosted from
maxcdn.com.

``jsx
var React = require('react');
var Emoji = require('react-headzoo-emoji');

var Component = React.createClass({
render: function() {
return (



)
}
});
`

Will produce the following HTML.

`html



`

$3

size Default = 72, Possible values: 16, 36, and 72
The emoji images are available in three sizes: 16x16, 36x36, and 72x72. The
value of this prop determines which size to use.

`jsx

Hello, World! 😀

`


base Default = 'https://twemoji.maxcdn.com'
Changes the base URL for the emoji images. Can be an absolute URL or a
path.

`jsx

Hello, World! 😀

`


ext Default = '.png', Possible values: '.png', '.gif', '.jpg', '.jpeg', '.bmp', '.webp', '.svg', '.svgz'
Specifies the file extension for self hosted emoji images.

`jsx

Hello, World! 😀

`


tag Default = 'SPAN'
By default the component wraps it's children in a tag, but any
tag may be used.

`jsx

Hello, World! 😀

`


imgClassName Default = 'emoji'
Specifies the name of a CSS class which will be added to each created
tag.

`jsx

Hello, World! 😀

`

Outputs.

`html

Hello, World!

`

Note: Use the className property to specify the CSS class added to the
container.


imgStyle Default = {}
Specifies CSS styles which will be applied to each created tag.

`jsx

Hello, World! 😀

`

Outputs.

`html

Hello, World!

`


imgTitle Default = ''
Specifies the title that will be added to each created tag.

`jsx

Hello, World! 😀

`

Outputs.

`html

Hello, World!

`


onParse Default = function(){}
While the component parses it's children, it calls this function for each
unicode codepoint it finds. The callback receives an object with the following
properties: icon, base, size, and ext. Altering the values in the
callback changes the parsed output. The icon value contains the hex value
of the codepoint, which is also used as the image filename, sans extension.


onComplete Default = function(){}
Called when parsing is finished. The callback receives an array of DOM
nodes for each that was created. Provides the chance to alter
the images further, add event listeners, etc. Always called when parsing
finishes, even when no emoji were found.


onError Default = function(){}
Called each time an emoji image fails to load. The callback receives
an object describing the error.

Any other properties are added to the container.

`jsx

Hello, World! 😀

`

Outputs.

`html

Hello, World!

`




$3

The component includes the setGlobalProps() method, which is used to change
the default props used on each component. For instance rather than setting the
base prop on every component instance (a value which may change in the
future) you can instead set it once in your bootstrap process use setGlobalProps().

`jsx
var Emoji = require('react-headzoo-emoji');

Emoji.setGlobalProps({
base: 'http://yoursite.com/images/emoji'
});
`

$3

`sh
npm run test
`

$3

`sh
npm run build
``