@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)
}

| Parameter | Type | Description | | :-------- | :------- | :------------------------- | | workspaceAlias | string | Required. Your subdomain | | widgetAliasOrID | string | Optional. widget Id or alias ( you can find it on widget details page in olvy dashbaord ) |

Methods

To show widget

showWidget(workspaceAlias,widgetAliasOrID)

| Parameter | Type | Description | | :-------- | :------- | :------------------------- | | workspaceAlias | string | Required. Your subdomain | | widgetAliasOrID | string | Required. widget Id or alias ( you can find it on widget details page in olvy dashbaord ) |

To hide widget

hideWidget(workspaceAlias,widgetAliasOrID)

| Parameter | Type | Description | | :-------- | :------- | :------------------------- | | workspaceAlias | string | Required. Your subdomain | | widgetAliasOrID | string | Required. widget Id or alias ( you can find it on widget details page in olvy dashbaord ) |

To set user

setUser(workspaceAlias, userObject) 

| Parameter | Type | Description | | :-------- | :------- | :------------------------- | | workspaceAlias | string | Required. Your subdomain | | userObject | object | Required. |

To set feedback meta info

setFeedbackMetaInfo (workspaceAlias, metaInfo)

| Parameter | Type | Description | | :-------- | :------- | :------------------------- | | workspaceAlias | string | Required. Your subdomain | | metaInfo | object | Required. |

To refresh unread count

refreshUnreadCount(workspaceAlias,widgetAliasOrID) 

| Parameter | Type | Description | | :-------- | :------- | :------------------------- | | workspaceAlias | string | Required. Your subdomain | | widgetAliasOrID | string | Required. widget Id or alias ( you can find it on widget details page in olvy dashbaord ) |

To show unread releases count

getUnreadReleasesCount(workspaceAlias,widgetAliasOrID)

| Parameter | Type | Description | | :-------- | :------- | :------------------------- | | workspaceAlias | string | Required. Your subdomain | | widgetAliasOrID | string | Required. widget Id or alias ( you can find it on widget details page in olvy dashbaord ) |

To remove unread indicator element

removeUnreadIndicatorElement(workspaceAlias,widgetAliasOrID)

| Parameter | Type | Description | | :-------- | :------- | :------------------------- | | workspaceAlias | string | Required. Your subdomain | | widgetAliasOrID | string | Required. widget Id or alias ( you can find it on widget details page in olvy dashbaord ) |

To add unread indicator element

addUnreadIndicatorElement(workspaceAlias,widgetAliasOrID, count) 

| Parameter | Type | Description | | :-------- | :------- | :------------------------- | | workspaceAlias | string | Required. Your subdomain | | widgetAliasOrID | string | Required. widget Id or alias ( you can find it on widget details page in olvy dashbaord ) |

To get last opened timestamp

getLastOpenedTimestamp(workspaceAlias,widgetAliasOrID)

| Parameter | Type | Description | | :-------- | :------- | :------------------------- | | workspaceAlias | string | Required. Your subdomain | | widgetAliasOrID | string | Required. widget Id or alias ( you can find it on widget details page in olvy dashbaord ) |

To refresh the widget

refresh(workspaceAlias,widgetAliasOrID)

| Parameter | Type | Description | | :-------- | :------- | :------------------------- | | workspaceAlias | string | Required. Your subdomain | | widgetAliasOrID | string | Required. widget Id or alias ( you can find it on widget details page in olvy dashbaord ) |

To teardown the widget

teardown(workspaceAlias,widgetAliasOrID)

| Parameter | Type | Description | | :-------- | :------- | :------------------------- | | workspaceAlias | string | Required. Your subdomain | | widgetAliasOrID | string | Required. widget Id or alias ( you can find it on widget details page in olvy dashbaord ) |

To create feedback

createFeedback(workspaceAlias,params)

| Parameter | Type | Description | | :-------- | :------- | :------------------------- | | workspaceAlias | string | Required. Your subdomain | | params | object | Required. |

Tests

  npm run test:unit