# @oneboard/widget

> OneBoard widget

Latest version **1.3.2** (published 2022-10-07) · 0 weekly downloads

## Install

```sh
npm install @oneboard/widget
pnpm add @oneboard/widget
yarn add @oneboard/widget
bun add @oneboard/widget
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.2 |
| Published | 2022-10-07 |
| First published | 2022-06-27 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 18.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | OneBoard |
| Maintainers | grebble |

## Links

- npm: https://www.npmjs.com/package/@oneboard/widget
- npm.io page: https://npm.io/package/@oneboard/widget

## Recent versions

- 1.3.2 (latest) — 2022-10-07
- 1.3.1 — 2022-08-02
- 1.3.0 — 2022-08-02
- 1.2.1 — 2022-07-06
- 1.2.0 — 2022-07-01
- 1.1.0 — 2022-07-01
- 1.0.2 — 2022-06-27
- 1.0.1 — 2022-06-27

## README

# `@oneboard/widget`


## Example

```javascript
import OneBoard from '@oneboard/widget';

const oneBoard = new OneBoard({
    appPublicKey: '<AppPublicKey>',
    verificationToken: '<UserVerificationToken>',
  });

oneBoard.openOnBoardingModal();
```

## Installing

```shell
npm install @oneboard/widget
```

Or self-host / CDN

```html
<script src="build/index.js"></script>
```

## Configuration

Specify configuration options when creating a OneBoard instance

##### Example

```javascript
import OneBoard from '@oneboard/widget';

new OneBoard({...options})
```

#### Options

| Option              | Type      | Required  | Desciption                                                                    |
| ------------------- | --------- | --------- | ----------------------------------------------------------------------------- |
| `appPublicKey`      | String    | Yes       |  Public key for your OneBoard application                                     |
| `verificationToken` | String    | No        |  User token for verification request. You van get it from oneboard SDK        |


## API

### openOnBoardingModal([options])

Open OneBoard widget as modal

##### Example

```javascript
oneBoard.openOnBoardingModal({ fullScreen: true });
```

#### Options

- `fullScreen`: (Optional) Lifetime for access token in seconds. Defaults to `false`.




### renderOnBoardingView(container)

Render OneBoard widget view to custom element specified in `container` argument.
- `container` can be CSS selector or DOM Element

##### Example

```html
<div id="oneboard-container"></div>
```

```javascript
oneBoard.renderOnBoardingView('#oneboard-container');
```

---
_Source: https://npm.io/package/@oneboard/widget · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._