robin-vue

robin-vue
1,903
Install
npm install robin-vue
Latest Version:0.6.6
Vue:2
Last Updated:Aug 10, 2023
Links: npm
Maintainer: robinapp

robin-vue

Table of Contents
  1. About
  2. Installation
  3. Usage
  4. Available options
  5. License

About

robin-vue is a Vue SDK built to communicate with the Robin API. Now you can integrate Robin with minimal effort and quickly setup an real-time messaging platform in your Vue.js web application.

Installation

## npm
npm install robin-vue

## yarn
yarn add robin-vue

Usage

import Vue from 'vue'
import App from './App.vue'
import RobinChat from 'robin-vue'
import 'robin-vue-sdk/dist/style.css'

Vue.config.productionTip = false

Vue.use(RobinChat)

new Vue({
  el: '#app',
  router,
  store,
  render: h => h(App)
})
<template>
  <div id="app">
    <RobinChat :api-key="apiKey" :user-token="userToken" :user-name="userName" :users="users" :keys="keys" :page-loader="pageLoader" />
  </div>
</template>

<script>

export default {
  name: 'ChatApp',
  components: {
    RobinChat
  },
  data () {
    return {
      apiKey: '...'
      userToken: '...
      pageLoader: true,
      userName: '...',
      keys: {
        userToken: 'user_token',
        profileImage: 'profile_image',
        userName: 'fullname'
      },
      users: [{
        userToken: '...',
        profileImage: '...',
        userName: '...'
      }]
    }
  }
}
</script>

Available options

Attribute Type Default Description
api-key String '' SDK Authorization. (required)
user-token String '' User Authorization. (required)
user-name String '' Name of the current user using Robin. (required)
users Array [] User list - Data should model the keys option (required)
keys Object {} User data structure you want Robin to pull from. (required)
page-loader Boolean True Shows a loader when first mounting

License

Distributed under the MIT License. See LICENSE for more information.

Related Packages

vue

The progressive JavaScript framework for building modern web UI.

588,019,132 54,801
vue
@vueuse/shared
372,738,348 22,398
@vueuse/core

Collection of essential Vue Composition Utilities

367,188,523 22,398
@vitejs/plugin-vue

The official plugin for Vue SFC support in Vite.

333,357,380 686
eslint-plugin-vue

Official ESLint plugin for Vue.js

266,364,830 4,591

Version History

Version Released Vue License
0.6.6 ^2.6.14
0.6.5 ^2.6.14
0.6.4 ^2.6.14
0.6.3 ^2.6.14
0.6.2 ^2.6.14