FormidableLabs/victory-pie

Name: victory-pie

Owner: Formidable

Description: D3 pie & donut chart component for React

Created: 2015-07-30 18:21:25.0

Updated: 2018-01-04 17:31:16.0

Pushed: 2018-01-18 18:52:39.0

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

Size: 9789

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

VictoryPie

VictoryPie draws an SVG pie or donut chart with React. Styles and data can be customized by passing in your own values as properties to the component.

Requirements

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

API Documentation

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

Issues

To make it easier to manage issues across all of Victory, we have disabled issues for 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-pie

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-pie:

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

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.

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!

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