proklim/public/assets/libs/fg-emoji-picker/README.md

1.5 KiB

Emoji picker created with vanilla javascript

Install with NPM

npm i fg-emoji-picker

Installation & Usage

  1. Put fgEmojiPicker.js file along with full-emoji-list.json.

  2. Include fgEmojiPicker.js inside the head or body of the project

  3. Initialize plugin - new FgEmojiPicker({trigger: 'selector'})

new FgEmojiPicker({
    trigger: 'selector'
})

Options

  • trigger: 'selector'. Multiple selectors also available. Just put selectors in array - trigger: ['selector-1', 'selector-2', 'selector-3']
  • position: ['top', 'left', 'right', 'bottom']
  • dir: 'directory/to/json', // (without json name)
  • removeOnSelection: true, // Hide / remove emoji picker on emoji click
  • closeButton: true,
  • preFetch: true, // load emoji json when function called
  • insertInto: document.querySelector('textarea'), // Takes element (textarea for example) where emoji going to be inserted
  • emit: (emoji, triggerElement) {console.log(emoji)}

emit() collback returns two argumens. First is emoji it self and second is the trigger element.

  • You can close picker by clicking to the blank screen space, however you can remove picker with public 'destroy method' picker.destroy()
const picker = new FgEmojiPicker({
    // dir: './node_modules/fg-emoji-picker/',
    trigger: ['button'],
    position: ['bottom', 'right'],
    preFetch: true,
    insertInto: document.querySelector('textarea'),
    emit(obj, triggerElement) {
        console.log(obj, triggerElement);
    }
});