Victory

A collection of composable React components for building interactive data v...

ChartingReactD3
FormidableLabs/victoryformidable.com/open-source/victory/victory

README

victory

    an ecosystem of composable React components for building interactive data visualizations.


weekly downloads current version build status Gzip size Maintenance Status


Victory


Contents


- Getting Started
- Victory Native
- API Documentation
- Guides
- Contributing

See the docs and examples on the website: http://formidable.com/open-source/victory.
Experiment with all Victory components in this code sandbox

Getting started


1. Add Victory to your project:

  1. ```sh
  2. # npm
  3. $ npm i --save victory
  4. # or yarn
  5. $ yarn add victory
  6. ```

2. Add your first Victory component:

  1. ``` js
  2. import React from "react";
  3. import { render } from "react-dom";
  4. import { VictoryPie } from "victory";

  6. const PieChart = () => {
  7.   return <VictoryPie />;
  8. };

  10. render(<PieChart />, document.getElementById("app"));
  11. ```

3. VictoryPie component will be rendered, and you should see:

pie


Requirements


Projects using Victory should also depend on [React][]. Victory works with React version 15 and above. As of victory@34.0.0 Victory requires React version 16.3.0 or above

Victory Native


Victory Native shares most of its code with Victory, and has a nearly identical API! To learn more, check out the Victory Native package README.

Contributing

Please see the Contributing guide.

Maintenance Status


Active: Formidable is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.

[react]: https://facebook.github.io/react/