Introduction

This module integrates the CKEditor Emojione plugin with CKEditor on Drupal 8 and allows users to add unicode emojis through CKEditor.

Requirements

  • CKEditor Module (Core)
  • Libraries API (optional, not required but recommended)

Installation

  1. Install module using composer

    composer require drupal/ckeditor_emojione

  2. Install the Composer Merge Plugin

    composer require wikimedia/composer-merge-plugin

  3. Edit the "composer.json" file of your website and under the "extra": { section add:
    "merge-plugin": {
      "include": [
        "PATH/TO/MODULE/ckeditor_emojione/composer.libraries.json"
      ]
    },
    

    Make sure to replace PATH/TO/MODULE with the location of the module (eg. web/modules/contrib/ckeditor_emojione/composer.libraries.json.

    Note: From now on, every time the "composer.json" file is updated, it will also read the contents of "composer.libraries.json" located at PATH/TO/MODULE/ckeditor_emojione/ and update accordingly.

  4. Install required libraries
  5. composer update drupal/ckeditor_emojione

  6. Enable CKEditor Emojione module in the Drupal admin (/admin/modules) or via drush (drush en ckeditor_emojione).
  7. Configure your WYSIWYG toolbar to include the button (/admin/config/content/formats).

Similar modules

The CKEditor Smiley module integrates the Smiley plugin with CKEditor which produces <img> elements to render emojis; the Emojione plugin uses unicode emojis.

Supporting organizations: 

Project information

Releases