FormidableLabs/victory-chart

Name: victory-chart

Owner: Formidable

Description: Chart Component for Victory

Created: 2015-08-01 06:05:36.0

Updated: 2018-01-16 20:06:09.0

Pushed: 2018-01-16 23:01:05.0

Homepage: http://formidable.com/open-source/victory/docs/victory-chart/

Size: 16212

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Travis Status

VictoryChart

A flexible charting component for React. VictoryChart composes other victory components into reusable charts. Acting as a coordinator rather than a stand-alone component, VictoryChart reconciles props such as domain and scale for child components, and provides a set of sensible defaults.

VictoryChart includes:

API Documentation

Detailed documentation and interactive examples can be found at http://formidable.com/open-source/victory/docs/victory-chart

Requirements

Projects using Victory should also depend on React and prop-types.

Issues

To make it easier to manage issues across all of Victory, we have disabled issues on this repo. Please open issues in the main victory repo instead. You can track our progress on issues here

Development
n the demo app server
m start

en the demo app
en http://localhost:3000

n tests
m test
Multi-repo development

Victory uses lank for multi-repo development. Use a lank workflow to test changes in victory dependencies. Here's an example of setting up lank to test changes in victory-core from victory-chart

First, make sure that all of your Victory repos are siblings in the same directory

stall lank globally
m install -g lank

Victory repos are already configured with appropriate .lankrc and lank scripts. To test changes in victory-core from victory-chart:

n all commands from the root of `victory-chart`
 victory-chart

n `lank link` to remove `victory-core` from node_modules
nk link

tch for changes to lanked repos. Leave this process running in its own terminal window
m run lank-watch

n a dev server with your lanked repos. In a new terminal window...
m run lank-run

Refresh your browser to pick up changes.

For more on the development environment, see DEVELOPMENT in the project builder archetype.

Contributing

Please review our Code of Conduct before contributing.

For a detailed contribution guide, please see CONTRIBUTING in the project builder archetype.

Caveats git installs using npm 2 may fail in postinstall. If you are consuming Victory via git installs please use npm >=3.0.0

IMPORTANT

This project is in a pre-release state. We're hard at work fixing bugs and improving the API. Be prepared for breaking changes!


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.