fivethirtyeight/victory

Name: victory

Owner: FiveThirtyEight

Description: A collection of composable React components for building interactive data visualizations

Forked from: FormidableLabs/victory

Created: 2016-04-07 19:51:51.0

Updated: 2017-12-30 19:51:38.0

Pushed: 2016-04-07 20:31:12.0

Homepage: http://victory.formidable.com

Size: 29145

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Travis Status Join the chat at https://gitter.im/FormidableLabs/victory

Victory

Victory is an opinionated, but fully overridable, ecosystem of composable React components for building interactive data visualizations. This repo aggregates all of the stable Victory components so they can be conveniently included.

See the docs and examples on the website: http://victory.formidable.com.

You can also join the Gitter chat room at https://gitter.im/FormidableLabs/victory.

Important: This project is in alpha release. We're hard at work fixing bugs and improving the API. Be prepared for breaking changes!

SEMVER Minor version bumps should be considered breaking changes until we hit v1.0.0. Patches can be considered safe.

Get started
  1. Add Victory to your project:

    m install victory --save
    
  2. Add your first Victory component:

    rt React, { Component } from 'react';
    rt { render } from 'react-dom';
    rt { VictoryPie } from 'victory';
    
    s PieChart extends Component {
    er() {
    turn (
    <VictoryPie />
    
    
    
    
    er(<PieChart />, document.getElementById('app'));
    
  3. VictoryPie component will be rendered, and you should see:

VictoryPie

Including components:

Components can be included individually

rt {VictoryLine, VictoryAxis} from "victory"

toryLine/>

Or imported as a set:

rt * as V from "victory"

ictoryLine/>
Components

You can read about these Victory components via interactive docs!

Animation

Wrap any Victory component with VictoryAnimation and it will transition smoothly between states whenever data changes. VictoryAnimation relies on d3's interpolator, so it knows how to transitions between colors, dates, numbers, strings etc.

Contributing

Please see CONTRIBUTING in the project builder archetype.

one the Victory repo
t clone git@github.com:FormidableLabs/victory.git
 victory

n the demo app server
m start

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

n checks (lint and tests)
m test

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

Roadmap

Please see ROADMAP


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.