igchuk / victory-native

victory components for react native

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Victory Native

Maintenance Status

Usage

Install victory-native:

$ npm install victory-native --save

Install react-native-svg:

$ npm install react-native-svg --save

Link react-native:

$ react-native link react-native-svg

victory-native@^33.0.0 requires react-native-svg@^9.0.0 and react-native@~0.60.0

Please see Peer Dependencies and Version Requirements for requirements for previous versions of victory-native

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;

Peer Dependencies and Version Requirements

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.

  • victory-native@^33.0.0 requires react-native-svg@^9.0.0 and react-native@~0.60.0
  • victory-native@^30.0.0 requires react-native-svg@6.1.x or react-native-svg@^6.5.0and above
  • victory-native@^0.16.2 requires react-native-svg@6.1.x or react-native-svg@^6.5.0
  • victory-native@~0.16.0 requires react-native-svg@6.0.0 No longer supported
  • victory-native@~0.15.0 requires react-native-svg@^5.0.0 No longer supported

Local Development and Demo

If you'd like to contribute to victory-native, you can use the local demo app to test your changes on the iOS simulator.

# Install
$ git clone https://github.com/FormidableLabs/victory-native
$ cd victory-native
$ yarn install
# To run our typescript demo: cd demo/ts
$ cd demo/js
$ yarn install
$ yarn start

# Run the demo from a new terminal window
$ npx react-native run-ios

Changes to lib will be reflected in the demo app.

Documentation

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

Contributor Covenant Code of Conduct

Please review our Code of Conduct before contributing.

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.

About

victory components for react native

License:MIT License


Languages

Language:JavaScript 100.0%