@unblu/floating-js-api
TypeScript icon, indicating that this package has built-in type declarations

8.0.1 • Public • Published

Unblu Floating JS API

The Floating JS API is an optional add-on to the Unblu Floating UI site integration. It allows JavaScript access to the local Floating Unblu UI integration.

Installation

In your project execute the following command which will install the floating-js-api and add it to the package.json file as a dependency.

npm install --save @unblu/floating-js-api

The floating-js-api's version is synchronized with the Unblu Collaboration Server version. To guarantee compatibility between the two, use the latest JS library version that is either equal to or smaller than the Collaboration Server version you are using.

Once installed you can use it like so:

import unblu from "floating-js-api";

const api = await unblu.floating.api.initialize();
// use the floating API

Documentation

See Unblu Floating JS API Documentation for the full documentation of the API.

Examples

For examples how you can integrate Unblu into your website or webapp see Unblu Visitor JS API Examples on GitHub

Package Sidebar

Install

npm i @unblu/floating-js-api

Weekly Downloads

71

Version

8.0.1

License

SEE LICENSE IN LICENSE.md

Unpacked Size

252 kB

Total Files

141

Last publish

Collaborators

  • truebden
  • davideberlein