@olvyhq/widget-vue v0.1.19

@olvyhq/widget-vue

This vue component allows you to easily include Olvy widgets in your Vue applications. The component takes care of all the necessary set up and configuration, allowing you to simply specify which Olvy widget you want to use and any relevant options.

Demo

https://codesandbox.io/s/olvy-widget-vue-g6t0cv

Installation

Install @olvyhq/widget-vue with npm

  npm install @olvyhq/widget-vue

Usage/Examples

In main.js

import { createApp } from 'vue'
import App from './App.vue'
import OlvyWidget from '@olvyhq/widget-vue'
const app =createApp(App)
app.use(OlvyWidget)
app.mount('#app')

How to use

<olvy-widget :config="<Configuration>" >
    <div id="<Target-Element-Id>"> </div>
</olvy-widget>

//Replace <Target-Element-Id> with your target element id and <Configuration> with your configuration

Example

<olvy-widget  :config="{workspaceAlias: 'olvysdktest'}" >
    <div id="olvy-whats-new">Announcement Widget</div>
</olvy-widget>

Configuration

{
    widgetId:"",   // (optional)
    workspaceAlias:""  //(required)
}

Methods

To show widget

showWidget(workspaceAlias,widgetAliasOrID)

To hide widget

hideWidget(workspaceAlias,widgetAliasOrID)

To set user

setUser(workspaceAlias, userObject) 

To set feedback meta info

setFeedbackMetaInfo (workspaceAlias, metaInfo)

To refresh unread count

refreshUnreadCount(workspaceAlias,widgetAliasOrID) 

To show unread releases count

getUnreadReleasesCount(workspaceAlias,widgetAliasOrID)

To remove unread indicator element

removeUnreadIndicatorElement(workspaceAlias,widgetAliasOrID)

To add unread indicator element

addUnreadIndicatorElement(workspaceAlias,widgetAliasOrID, count) 

To get last opened timestamp

getLastOpenedTimestamp(workspaceAlias,widgetAliasOrID)

To refresh the widget

refresh(workspaceAlias,widgetAliasOrID)

To teardown the widget

teardown(workspaceAlias,widgetAliasOrID)

To create feedback

createFeedback(workspaceAlias,params)

Tests

  npm run test:unit