/react-vega

Convert Vega spec into React class conveniently

Primary LanguageJavaScriptOtherNOASSERTION

react-vega & react-vega-lite

Codecov branch Build Status David

react + vega|vega-lite

Demo

http://vega.github.io/react-vega/

Packages

Click on package name below to see its documentation.

Package Version
react-vega Version
react-vega-lite Version

Development

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

react-vega/
  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 ...react-vega && cd react-vega
yarn install

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 directory.

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 and given write access to react-vega and react-vega-lite.

  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