Skip to content
This repository has been archived by the owner on Sep 29, 2024. It is now read-only.

Latest commit

 

History

History
99 lines (66 loc) · 3.88 KB

README.md

File metadata and controls

99 lines (66 loc) · 3.88 KB

NOTICE This extends the original plugin by groups. (See screenshot at dropdown menu)

About this extension

This was originally created for my project The Msngr, which should have become an open-source end-to-end encrypted messanger. I am always happy about an attribution to me and my website, e.g. <a href="https://pius-ladenburger.de">Pius Ladenburger</a>.

I hope this helps you and makes your day easier.

#.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="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

  • Huge props to Tim Down for the many insightful answers on Stack Overflow having to deal with cross-browser selection handling.
  • If you have a really rad set of emojis and would like to share, please fork this, add them to "packs/", and submit a pull request!
  • For a giant list of emojis (used by Github, Basecamp, et al), see "Emoji cheat sheet".

License

Copyright © 2012 DIY Co and 2015 Pius Ladenburger

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.

I am always happy about an attribution to me and my website, e.g. <a href="https://pius-ladenburger.de">Pius Ladenburger</a>