@thebigcrunch/sdk

0.5.30 • Public • Published

TheBigCrunch SDK

Introduction

TheBigCrunch SDK is used to seemlessly embed cells from TheBigCrunch into your website. When the cell changes your website changes. Using the SDK you can also react to changes made in TheBigCrunch and change the display of your site.

API

Crunch(spaceId, callback)

Used to fetch and display cells from TheBigCrunch

  • spaceId - The id of the space from TheBigCrunch you would like to display eg. dGJjXy0yOF8tNTM=
  • callback - a callback function
    • callback function is provided, the function is called with the data of the cell

Vizzy (options { spaceId, selector, onChange, onConfig })

Used to create Vizzy's in TheBigCrunch.

  • options

    • selector
    • onChange a function that is called when the cell value changes
    • onConfig
    • spaceId Why is this needed?

HandleData(spaceId, selector, data, onChange)

  • spaceId The id of the space from TheBigCrunch you would like to display
  • selector A selector that selects the element on your page where the cell is to be displayed
  • data -
  • onChange Not used

Readme

Keywords

Package Sidebar

Install

npm i @thebigcrunch/sdk

Weekly Downloads

2

Version

0.5.30

License

ISC

Unpacked Size

2.49 MB

Total Files

47

Last publish

Collaborators

  • jordle
  • simon-o-matic
  • zhaoyi0113