This repository is the monorepo for Sigma Computing's Plugin platform. Sigma Plugins provide an API for third-party applications to add additional functionality into an existing Sigma workbook. Plugins are built using Sigma's Plugin API, which communicates data and interaction events between a Sigma workbook and the plugin. Plugins are hosted by their developer and rendered in an iframe in Sigma.
| Package | Description |
|---|---|
@sigmacomputing/plugin | Client SDK for building Sigma plugins. Provides both a standard JavaScript API and a React Hooks API. |
For installation, usage, and API documentation, see the README of each package.
This repo is a Yarn workspaces monorepo orchestrated by Turborepo. See CONTRIBUTING.md for setup instructions and development workflow.
Common scripts available from the repo root:
yarn build # Build all packages
yarn test# Run all package test suites
yarn lint # Lint the codebase
yarn types # Type-check all packagesRelease notes and breaking changes are documented in CHANGELOG.md.