Skip to content

heftybyte/victory-chart

 
 

Repository files navigation

[![Travis Status][trav_img]][trav_site]

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

# Run the demo app server
$ npm start

# Open the demo app
$ open http://localhost:3000

# Run tests
$ npm test

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! [React]: https://facebook.github.io/react/ [prop-types]: https://github.com/reactjs/prop-types [trav_img]: https://api.travis-ci.org/FormidableLabs/victory-chart.svg [trav_site]: https://travis-ci.org/FormidableLabs/victory-chart