superset/superset-frontend/temporary_superset_ui/superset-ui/plugins/superset-ui-plugins

@superset-ui/plugins 🔌💡

@superset-ui/legacy-* packages are extracted from the classic Apache Superset and converted into plugins. These packages are extracted with minimal changes (almost as-is). They also depend on legacy API (viz.py) to function.

@superset-ui/plugin-* packages are newer and has higher quality in general. A key difference that they do not depend on viz.py (which contain visualization-specific python code) and interface with /api/v1/query/ instead: a new generic endpoint instead meant to serve all visualizations.

We are not accepting pull requests for new community-contributed plugins to be merged into this repository at the moment. We will keep it lean for now to improve the standard and reduce operational load on maintenance. Bug fixes are welcome.

In the future, we plan to have a template for new repository or generator for everybody to setup a single plugin repository easily on his/her own. This way anybody can create and publish a Superset plugin.

Demo (Storybook)

Most recent release: https://apache-superset.github.io/superset-ui-plugins/

Current master: https://superset-ui-plugins.netlify.com

Packages

Package	Version	Note
@superset-ui/plugin-chart-word-cloud
@superset-ui/preset-chart-xy		experimental

Package	Version
@superset-ui/legacy-preset-chart-big-number
@superset-ui/legacy-preset-chart-nvd3
@superset-ui/legacy-plugin-chart-calendar
@superset-ui/legacy-plugin-chart-chord
@superset-ui/legacy-plugin-chart-country-map
@superset-ui/legacy-plugin-chart-event-flow
@superset-ui/legacy-plugin-chart-force-directed
@superset-ui/legacy-plugin-chart-heatmap
@superset-ui/legacy-plugin-chart-histogram
@superset-ui/legacy-plugin-chart-horizon
@superset-ui/legacy-plugin-chart-iframe
@superset-ui/legacy-plugin-chart-markup
@superset-ui/legacy-plugin-chart-map-box
@superset-ui/legacy-plugin-chart-paired-t-test
@superset-ui/legacy-plugin-chart-parallel-coordinates
@superset-ui/legacy-plugin-chart-partition
@superset-ui/legacy-plugin-chart-pivot-table
@superset-ui/legacy-plugin-chart-rose
@superset-ui/legacy-plugin-chart-sankey
@superset-ui/legacy-plugin-chart-sankey-loop
@superset-ui/legacy-plugin-chart-sunburst
@superset-ui/legacy-plugin-chart-table
@superset-ui/legacy-plugin-chart-treemap
@superset-ui/legacy-plugin-chart-word-cloud
@superset-ui/legacy-plugin-chart-world-map

Development

lerna and yarn are used to manage versions and dependencies between packages in this monorepo.

superset-ui/
  lerna.json
  package.json
  ...
  packages/
    package1/
      package.json
      ...
      src/
      test/
      ...
      lib/
      esm/
      ...
    ...

Installation

1. clone this repo
2. have yarn install package dependencies and manage the symlinking between packages for you

git clone ...superset-ui-plugins && cd superset-ui-plugins
yarn install
yarn build

Builds, linting, and testing

Each package defines its own build config, linting, and testing. You can have lerna run commands across all packages using the syntax yarn run test (or yarn run test:watch for watch mode) from the root @superset-ui-plugins directory.

• Using Storybook - You can test your components independently from Superset app.
• Debugging Superset plugins in Superset app - Sometimes something went wrong and you have to do it.

Committing

This repository follows conventional commits guideline for commit messages and has a commitlint hook which will require you to have the valid commit message before committing. You can use npm run commit to help you create a commit message.

Publishing

Prerequisite: You'll need an npmjs.com account that is part of the @superset-ui organization.

1. Make sure you're logged in to NPM from your shell. Run npm login if necessary.
2. To make the release, run yarn run release and follow the prompts.

License

Apache-2.0