Skip to content

drakedeveloper/V-Emoji-Picker

 
 

V-Emoji-Picker

This simple package using Emojis Natives

npm bundlephobia npm vue2 CodeFactor example: Android


Contents


Installation

yarn add v-emoji-picker

Usage

<template>
  <div id="app">
    <VEmojiPicker @select="selectEmoji" />
  </div>
</template>

<script>
import VEmojiPicker from 'v-emoji-picker';

export default {
  name: 'Demo',
  components: {
    VEmojiPicker
  },
  data: () => ({}),
  methods: {
    selectEmoji(emoji) {
      console.log(emoji)
    }
  }
}
</script>

or Global

import Vue from "vue";
import App from "./App.vue";

import VEmojiPicker from 'v-emoji-picker';

Vue.config.productionTip = false;
Vue.use(VEmojiPicker);

new Vue({
  render: h => h(App)
}).$mount("#app");

Props

{
  @Prop({ default: () => [] as IEmoji[] }) customEmojis!: IEmoji[];
  @Prop({ default: () => [] as ICategory[] }) customCategories!: ICategory[];
  @Prop({ default: 5 }) emojisByRow!: number;
  @Prop({ default: false }) continuousList!: boolean;
  @Prop({ default: true }) showSearch!: boolean;
  @Prop({ default: true }) showCategories!: boolean;
  @Prop({ default: "Pesquisar..." }) labelSearch!: string;
  @Prop({ default: "Peoples" }) initalCategory!: string;
  @Prop({ default: () => [] as string[] }) exceptCategories!: string[];
}

Events

{
  select: 'Emit event on Selected Emoji',
  changeCategory: 'Emit event on Change Category'
}

Using custom Emojis

Array of items with Interface IEmoji

interface IEmoji {
  data: string;
  category: string;
  aliases: string[];
}

set in Prop customEmojis

Using custom Categories

Array of items with Interface ICategory

interface ICategory {
  name: string;
  icon: string;
}

set in Prop customCategories

Using SVG

Doc coming soon...

Updates version 2

  • Prop customEmojis
  • Prop customCategories
  • Prop exceptCategories
  • Folder /data removed
  • Interface Emoji updated
  • Support to Emojis SVG/Img/Natives (text)

Migrate to version 2

This was a one-time change to keep it clear and dynamic.

  • Prop pack removed (async auto import default emojis natives - text)
  • Prop showCategory changed to showCategories
  • Event content event.emoji changed to event.data

Structure Emoji

Size

License

FOSSA Status

About

🌟 A Lightweight and customizable package of Emoji Picker in Vue using emojis natives (unicode).

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 83.3%
  • Vue 13.3%
  • JavaScript 2.6%
  • Other 0.8%