Skip to content

rafaelklaessen/vx-components-react

Repository files navigation

vx-components-react

npm version npm downloads license publish size install size dependencies devDependencies peerDependencies

Installation

vx-components-react is available as an npm package:

// npm
npm install vx-components-react

// yarn
yarn add vx-components-react

Documentation & demos

You can find the documentation and demos here.

Quick example

View the demos to see all components.

import React from 'react';
import ReactDOM from 'react-dom';
import { Button } from 'vx-components-react';

const App = () => (
  <Button primary>
    Foo bar
  </Button>
);

ReactDOM.render(App, document.getElementById('root'));

Development

To run the demo locally, run:

// npm
npm install & npm run docs

// yarn
yarn install && yarn docs

This will run the styleguide used in the demo locally. It will automatically update whenever you change a component.

The demo uses react-styleguidist, read more about it here.

License

MIT