diy / jquery-emojiarea

A rich textarea control that supports emojis, WYSIWYG-style.
298 stars 87 forks source link

.emojiarea()

A small 6kb jQuery plugin for turning regular textareas into ones that support emojis, WYSIWYG style! Set up a list of available emojis, call $('textarea').emojiarea() and you're done (basically). There's a plain-text fallback, so if the browser doesn't support contentEditable, it will degrade gracefully—the user will still be able to use the dropdown menu of emojis.

Screenshot

<textarea>Hello :smile:</textarea>
<script type="text/javascript">$('textarea').emojiarea();</script>

Configuration

Dropdown Menu

Dropdown Screenshot

By default, the plugin will insert a link after the editor that toggles the emoji selector when clicked.

<a href="https://github.com/diy/jquery-emojiarea/blob/master/javascript:void(0)" class="emoji-button">Emojis</a>

If you wish change this behavior and have the button placed before the editor, or change the label of the link, use:

$('textarea').emojiarea({
    buttonLabel: 'Add Emoji',
    buttonPosition: 'before'
});

Alternatively, if you wish to use your own button:

$('textarea').emojiarea({button: '#your-button'});

For customizing the visual appearance, see the CSS / Skinning section.

Available Emojis

$.emojiarea.path = '/path/to/folder/with/icons';
$.emojiarea.icons = {
    ':smile:'     : 'smile.png',
    ':angry:'     : 'angry.png',
    ':flushed:'   : 'flushed.png',
    ':neckbeard:' : 'neckbeard.png',
    ':laughing:'  : 'laughing.png'
};

Defaults

If you wish to set the defaults for $().emojiarea(), extend $.emojiarea.defaults like so:

$.extend($.emojiarea.defaults, {
    buttonPosition: 'before'
});

For a basic set of emojis, see "packs/basic".

CSS / Skinning

See jquery.emojiarea.css for the few fundamental CSS styles needed for this to work.

Basically, you'll want to adjust the following styles:

.emoji-wysiwyg-editor /* the editor box itself */
.emoji-menu > div /* the dropdown menu with options */
.emoji-wysiwyg-editor img /* the emoji images in the editor */

Footnotes

License

Copyright © 2012 DIY Co

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.