miguelramosfdz / victory-native

victory components for react native

Victory Native

Usage

Install victory-native:

$ npm install victory-native --save

Install react-native-svg:

$ npm install react-native-svg --save

Note: victory-native requires the following peer dependencies:

• react-native-svg
• react
• react-native

Note: react-native-svg has strict version requirements for both react and react-native. Please match versions to those required by react-native-svg. See the up-to-date requirements on the react-native-svg Readme. We encourage you to use the latest version of react-native-svg possible for your project, as victory-native issues are frequently solved by react-native-svg bugfixes.

Version Requirements

victory-native@~0.15.0 requires peer dependency react-native-svg@^5.0.0 victory-native@~0.16.0 requires peer dependency react-native-svg@^6.0.0

Link react-native-svg:

$ react-native link react-native-svg

Import charts from victory-native. For example,

import React, { Component } from "react";

import { VictoryBar } from "victory-native";

class App extends Component {
  render() {
    return (
      <VictoryBar />
    );
  }
}

export default App;

Documentation

Full documentation can be found here.

Demo

Clone victory-native-demo and follow the instructions there.

Documentation

See the docs and examples on the website https://formidable.com/open-source/victory/docs/native

Local Development

If you'd like to contribute to victory-native, you can use the local demo app to test your changes on the iOS simulator. (But if you're just getting started with victory-native and want to see a demo, we recommend using victory-native-demo, as it supports Android and is simpler to set up.)

# Install
$ npm install -g react-native-cli # if you haven't already
$ git clone https://github.com/FormidableLabs/victory-native
$ cd victory-native
$ npm install

# Start the react-native packager in a terminal that will remain running
$ npm start

# Run the demo from a new terminal window
$ npm run demo:ios

Changes to lib will be reflected in the demo app.

Do not run npm install in the demo/ directory, or the packager packager will crash due to "duplicate @providesModule declarations" found in node_modules/ and demo/node_modules.

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!

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

Contributor Covenant Code of Conduct

Please review our Code of Conduct before contributing.