Sigma provides several methods to allow users and developers to interact with its systems including web-ui, REST API, Javascript Embed API and an SDK for the React framework.
The Embed-SDK for React offers a higher-level, developer-friendly interface that simplifies integration into applications, in contrast to Sigma’s lower-level JavaScript Embed-API, which provides more granular control but may require additional coding
If the basic instructions below are not sufficient, please review the QuickStart here.
To use the embed-sdk in your project, you can install it using your node package manager.
For each package manager, use the following command:
npm:
npm install @sigmacomputing/react-embed-sdk
yarn:
yarn add @sigmacomputing/react-embed-sdk
pnpm:
pnpm add @sigmacomputing/react-embed-sdk
For each package manager, use the following command:
Using npm:
npm install @sigmacomputing/embed-sdk
yarn:
yarn add @sigmacomputing/embed-sdk
pnpm:
pnpm add @sigmacomputing/embed-sdk
The repo uses turbo for its build system. It currently has 3 packages:
- embed-sdk: "barebones" wrappers over postMessages
- react-embed-sdk: React hooks to easily use the embed-sdk
- docs: Some barebone documentation / examples.
To build:
pnpm run build
We follow semantic versioning. We MAY make breaking changes while in 0.y.z releases, but the maintainers do not plan for any substantial breaking changes until 1.0.0.
Publishes are handled by changesets. To add a changeset, in your PR run:
pnpm changeset
This will prompt you to add a changeset. Once merged, a PR will be opened to bump the version and publish the package.
- Example for adding an inbound event
- Add a changeset for both the embed-sdk and react-embed-sdk.