Skip to content
On this page

NcEmojiPicker

Props

Prop nameDescriptionTypeValuesDefault
activeSetThe emoji-setstring-'native'
showPreviewShow preview section when hovering emojiboolean-false
previewFallbackEmojiThe fallback emoji in the preview sectionstring-'grinning'
previewFallbackTitleThe fallback text in the preview sectionstring-t('Pick an emoji')
closeOnSelectWhether to close the emoji picker after picking oneboolean-true
containerSelector for the popover containerstring|object|Element|boolean-'body'

Events

Event namePropertiesDescription
selectEmits a string containing the emoji e.g. '👩🏿‍💻'
select-dataEmits a object with more data about the picked emoji

Slots

NameDescriptionBindings
default

General description

This component allows the user to pick an emoji.

Usage

  • Listen to the select event and pass in an HTML element that will be treated as a trigger:
vue
<template>
  <div>
    <NcEmojiPicker @select="select" style="display: inline-block">
      <NcButton> Click Me </NcButton>
    </NcEmojiPicker>
    <span>selected emoji: {{ emoji }}</span>
  </div>
</template>
<script>
export default {
  data() {
    return {
      emoji: ""
    };
  },
  methods: {
    select(emoji) {
      this.emoji = emoji;
    }
  }
};
</script>
  • Showing a preview and keeping it open after a user selected an emoji
vue
<template>
  <div>
    <NcEmojiPicker
      :close-on-select="false"
      :show-preview="true"
      @select="select"
      style="display: inline-block"
    >
      <NcButton> Click Me </NcButton>
    </NcEmojiPicker>
    <span>selected emoji: {{ emoji }}</span>
  </div>
</template>
<script>
export default {
  data() {
    return {
      emoji: ""
    };
  },
  methods: {
    select(emoji) {
      this.emoji = emoji;
    }
  }
};
</script>