jcs-elpa / company-emojify

Company completion for Emojify

company-emojify

Company completion for Emojify

Table of Contents

• company-emojify
  • 🏆 Features
  • 💾 Quickstart
  • 🔨 Configuration
    • 🔍 company-emojify-insert-unicode
    • 🔍 company-emojify-emoji-styles
    • 🔍 company-emojify-annotation
    • 🔍 company-emojify-document
  • ❓ FAQ
    • 💫 How is this different from company-emoji?
    • 💫 How to add more emoji?
  • Contribute

🏆 Features

• Uses emojify
• Support both unicode and image displays

💾 Quickstart

(require 'company-emojify)
(add-to-list 'company-backends 'company-emojify)

🔨 Configuration

🔍 company-emojify-insert-unicode

Replace the :shortcode: with the real Unicode character upon completion.

🔍 company-emojify-emoji-styles

Display these emoji styles as candidates, default to '(ascii unicode github).

If you want to limit to a certain style, you can do the following

(setq company-emojify-emoji-styles '(github))  ; Show only the `github` style

See emojify-emoji-styles for more information.

🔍 company-emojify-annotation

Option to display emoji in annotation. It can either be one of the following values,

• nil
• unicode
• image (default)

Notice, it will display unicode if you are in non-graphical environment (terminal).

🔍 company-emojify-document

Display information about the emoji in document buffer, default to t.

❓ FAQ

💫 How is this different from company-emoji?

company-emoji is more lightweight and does not require emojify. However, it does not support display with emoji images. company-emoji would work on its own since it declares its emoji list in company-emoji-list.el. This package reuses the code from emojify hence this would be a better choice if you already have emojify installed.

💫 How to add more emoji?

Unlike company-emoji has specify it's own emoji list. Since we rely on package emojify, please consider contribute to the upstream.

Contribute

If you would like to contribute to this project, you may either clone and make pull requests to this repository. Or you can clone the project and establish your own branch of this tool. Any methods are welcome!