Risibank-web-api NPM

RisiBank Web API

Integrate RisiBank in any front-end application 😎

Intro

The RisiBank Web API is a tiny JS library, it has no dependency and weights around 3kb minified and gzipped.

It allows you to integrate RisiBank in your website in the way that you prefer (overlay, modal, embedded in the page somewhere) with custom styling, and let user select medias from RisiBank.

The RisiBank Web API is the base building block for any application that needs to use RisiBank anywhere on the web.

Getting started

Install RisiBank using a package manager
```
npm i --save risibank-web-api
# or
yarn add risibank-web-api
```
or by saving the web bundle in dist/risibank.min.js and importing it using a script tag
```
<script src="./path/to/your/risibank.js"></script>
```
Import RisiBank (ESM only)
```
import { RisiBank } from 'risibank-web-api';
```
if you are importing RisiBank Web API using a script tag, the RisiBank global variable is automatically available.

Open RisiBank

RisiBank.activate({
    /**
     * Use default options for Overlay + Dark
     * Other defaults are all combinations of Overlay/Modal/Frame and Light/Dark/LightClassic/DarkClassic, e.g. RisiBank.Defaults.Frame.LightClassic
     * @see https://github.com/RisiBank/risibank-web-api/blob/master/src/Defaults.js#L7
     */
    ...RisiBank.Defaults.Overlay.Dark,

    /**
     * What to do when a media is selected
     */
    onSelectMedia: ({ id, media }) => console.log('selected', id, media),
});