vestusola / vue-chat-emoji

A simple chat emoji for vuejs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Vue Chat Emoji

npm (scoped) npm (scoped)

A simple chat emoji integration for vuejs!

  • Emoji picker
  • Input conversion (hello :birthday_cake:! => hello πŸŽ‚ !)

Preview

Vue Chat Emoji list

Installation

npm install vue-chat-emoji

Usage

using inside component

<template>
  <div id="app">
    <Emoji />
  </div>
</template>

<script>
import { VueChatEmoji, emojis } from 'vue-chat-emoji'
require("vue-chat-emoji/dist/vue-chat-emoji.css");
export default {
  components: {
    Emoji: VueChatEmoji
  }
}
</script>

using globally

import Vue from "vue";
import App from "./App.vue";
 
import { VueChatEmoji } from 'vue-chat-emoji';
Vue.component("Emoji", VueChatEmoji);
require("vue-chat-emoji/dist/vue-chat-emoji.min.css");

Vue.config.productionTip = false;
Vue.use(Emoji);
 
new Vue({
  render: h => h(App)
}).$mount("#app");

Events

Name Description
click Emitted when emoji is clicked.
<template>
  <div id="app">
    <Emoji @click="selectedEmoji"/>
  </div>
</template>

<script>
import { VueChatEmoji, emojis } from 'vue-chat-emoji'
export default {
  components: {
    Emoji: VueChatEmoji
  },
  methods: {
    selectedEmoji(args) {
      console.log(args); /* return {...}*/
    }
  }
}
</script>

Methods

List of methods in emojis
Usage Description
get() List all emojis. Return [{...}].
all() List all emojis. Return [{...}]
encodeEmoji() Convert emoji character to string. e.g ":birthday_cake:" => "πŸŽ‚"
decodeEmoji() Convert valid emoji key to character. e.g "πŸŽ‚" => ":birthday_cake:"
getRandomEmoji() Return random emoji. Return {...}
findEmojiByKey() Return {...} if found and undefined if not found.
findEmojiByName() Return {...} if found and undefined if not found.
searchEmojiByName() Return [{...}] if found and [] if search not found.
findEmojiByGroup() Return [{...}] if found and [] if search not found.
<template>
  <div id="app">
    <Emoji searchLabel="Search emoji here" />
  </div>
</template>

<script>
import { VueChatEmoji, emojis } from 'vue-chat-emoji'
export default {
  components: {
    Emoji: VueChatEmoji
  },
  methods: {
    getAllEmojis() {
      console.log(emojis.all()); // [{...}]
      this.emojifyString("Here is your πŸŽ‚.") /* => Here is your :birthday_cake:.*/
      this.unEmojifyString("Here is your :birthday_cake:.") /* Here is your πŸŽ‚.*/
    },
    unEmojifyString(str) {
      console.log(emojis.decodeEmoji(str)) 
    },
    emojifyString(str) {
      console.log(emojis.encodeEmoji(str));
    }
  },
  mounted() {
    this.getAllEmojis();
  }
}
</script>

Props

Name Type Description
backgroundColor String (Style property) set the emoji container background color. Default: #f5f5f5 or whitesmoke
radius String or Number (Style property) Set the emoji container border radius. Default: 8
selectedCategory String Set default emoji category. Default: "Smileys & Emotion"
color String Set emoji container color. Default: "#000"
icon String Set emoji icon. Default: "fa fa-smile"
open Boolean Hide or show emoji container. Default: false
toggle Event To hide or show emoji container
width String Set emoji container width. Default: 96%
height String Set emoji container height. Default: 250px
searchLabel String Set search input field placeholder. Default: "Search". Note that HTML attributes are case-insensitive and camelCased props need to use their kebab-case equivalents when using in-DOM templates. You should probably use "search-label" instead of "searchLabel".

Using without NPM

  <!DOCTYPE html>
  <!--[if lt IE 7]>      <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
  <!--[if IE 7]>         <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
  <!--[if IE 8]>         <html class="no-js lt-ie9"> <![endif]-->
  <!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]-->
    <head>
      <meta charset="utf-8">
      <meta http-equiv="X-UA-Compatible" content="IE=edge">
      <title>Vue Starter</title>
      <meta name="description" content="">
      <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
      <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.13.0/css/all.min.css" integrity="sha512-L7MWcK7FNPcwNqnLdZq86lTHYLdQqZaz5YcAgE+5cnGmlw8JT03QB2+oxL100UeB6RlzZLUxCGSS4/++mNZdxw==" crossorigin="anonymous" />
      <link rel="stylesheet" href="https://unpkg.com/vue-chat-emoji@1.1.27/dist/vue-chat-emoji.min.css">
    </head>
    <body>
      <!--[if lt IE 7]>
        <p class="browsehappy">You are using an <strong>outdated</strong> browser. Please <a href="#">upgrade your browser</a> to improve your experience.</p>
      <![endif]-->
      <div id="app">
        <Emoji search-label="Search emoji here" />
      </div>

      <script src="https://cdn.jsdelivr.net/npm/vue@2.x/dist/vue.js"></script>
      <script src="https://unpkg.com/vue-chat-emoji@1.1.27/dist/vue-chat-emoji.min.js"></script>
      <script>
        new Vue({
          el: "#app",
          components: { Emoji: VueChatEmoji.VueChatEmoji },
          created() {
            
          }
        })
      </script>
    </body>
  </html>

About

A simple chat emoji for vuejs

License:MIT License


Languages

Language:JavaScript 97.8%Language:Vue 2.1%Language:HTML 0.1%