victory README

The project's README from github.com/FormidableLabs/victory. As one markdown file: README.md.

Victory — Formidable, We build the modern web an ecosystem of composable React components for building interactive data visualizations.

weekly downloads current version build status Maintenance Status

Victory

Contents

Getting started

  1. Add Victory to your project:
# npm
$ npm i --save victory
# or yarn
$ yarn add victory
  1. Add your first Victory component:
import React from "react";
import { render } from "react-dom";
import { VictoryPie } from "victory";

const PieChart = () => {
  return <VictoryPie />;
};

render(<PieChart />, document.getElementById("app"));
  1. VictoryPie component will be rendered, and you should see:

pie


Requirements

Projects using Victory should also depend on React. As of [email protected] 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 to work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.

victory (FormidableLabs/victory)

Searching Database…

11.2K ·GitHub
Victory
What is this?Victory is a collection of composable React components for building interactive data visualizations like charts and graphs.
Is this a component library I just drop into a React app, or something bigger?It is a library of individual React components (VictoryPie, VictoryChart, etc.) that you compose together, not a full framework. A companion package, Victory Native, shares nearly the same API for React Native on iOS and Android.
How do I add it to a project?Add the victory package to your project, then import and render a component such as VictoryPie to see it work.
Do I need a specific React version?Yes, your project needs to depend on React 16.3.0 or above.
If I want it on mobile, is it the exact same package?No, for React Native apps you use the separate Victory Native package; it mirrors most of the code and API but is maintained as its own package.
Where can I actually render these charts?On the web with React, and on iOS/Android apps via React Native using Victory Native.
Can I try Victory without setting up a project first?Yes, there is a code sandbox linked from the project where you can experiment with all Victory components directly in the browser.
Is the project actively maintained?Yes, Formidable states it is actively working on Victory and expects to continue doing so, including handling bug reports and feature requests.
What kinds of charts does Victory provide?It ships a set of composable chart primitives such as VictoryPie and VictoryChart that can be combined to build custom data visualizations.
What are similar projects?echarts, visx, d3, plotly.js, morphlet, react-native-ui-kitten, tremor-npm, react-native-elements
Which topics is it in?d3, charting-library, react-components, charts, react-native, svg, visualization, component-library, data-visualization, ui-components, mobile, ios
Creator
FormidableLabs
Size
64.1 MB
Stars
11.2K
Updated
CommitDec 19Releasev37.3.6Jan 14
Age
11y
Commits · 90 Days