Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 1.35 KB

README.md

File metadata and controls

56 lines (39 loc) · 1.35 KB
Raw

Volst UI Components

A React component library for Volst.

Demo / overview of all components

Install

yarn add @volst/ui-components
npm i @volst/ui-components --save

Usage

The components are documented in the demo, in the top-right you can press "Show Info" to see all the possible props for that component.

An example:

import React from 'react';
import ReactDOM from 'react-dom';
import { VolstTheme, Button } from '@volst/ui-components';

ReactDOM.render(
    <VolstTheme>
        <Button>Foobar</Button>
    </VolstTheme>,
    document.getElementById('root')
);

<VolstTheme /> accepts a theme prop, which can be used to change some project-wide settings. An example:

const theme = {
    primaryColor: '#006b94',
};

<VolstTheme theme={theme} />

See all settings.

Contributing

Please read the contributing guide.

Inspiration