0.1.3 • Published 5 years ago

ec-chat v0.1.3

Weekly downloads
15
License
-
Repository
github
Last release
5 years ago

ec-chat

Vue chat component

Install

npm i --save ec-chat

Usage

Import the component

import ECChat from "ec-chat";

Register the component

components: {
  "ec-chat": ECChat
}

Import style sheet

@import "~ec-chat/dist/ECChat.css";

Use it

<ec-chat
  :messages="messages"
  :fetching-messages="fetchingMessages"
  :user="user._id"
  :send-message="sendMessage"
  :get-user-by-id="getUserById"
/>
NameTypeDescription
messagesMessageArray of all messages, sorted by creation date
fetching-messagesBooleanIs fetching messages
userStringLogged user id
send-messageFunction(message: Message) => PromiseFunction for sending a new message
get-user-by-idFunction(userId: String) => UserFunction for getting user object by user id

Objects

Message

{
  user: String, // user id
  created: Date,
  text: String
}

User

{
  _id: String,
  name: String,
  color: String // Hex
}

Project setup

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.