🖥️For Developers

Use Case

Installation

# yarn 
yarn add @vip3/vip3-benefit-widget

# npm
npm install add @vip3/vip3-benefit-widget

Quickstart

import { VIP3Widget, LANG, THEME } from '@vip3/vip3-benefit-widget'

// in VUE
<VIP3Widget
  benefit-id={'benefitId'}
  lang={LANG.ZH}
  theme={THEME.Dark}
  open={true}
  @close={() => {
    // close Callback
  }}
/>

// in TSX
<VIP3Widget
  benefitId={'benefitId'}
  lang={LANG.ZH}
  theme={THEME.Dark}
  open={true}
  onClose={() => {
    // close Callback
  }}
/>

props

benefitId

Specify the benefit information to be loaded in widget

benefit Id: string

---

lang

The widget language

lang: enum LANG

LANG.EN | LANG.EN

---

theme

The widget UI Color theme

theme: enum THEME

THEME.Dark | THEME.Light

---

open

If true, the widget is shown.

open: boolean

---

onClose

Callback fired when the widget requests to be closed.

open: func