/mainsail-ui

Mainsail UI — The React UI kit of Breeze.

Primary LanguageJavaScriptMIT LicenseMIT

Mainsail UI Logo

The React UI kit of Breeze

NPM code style: prettier Auto Release Uses Storybook Linting & Tests Build

Storybook is used for local development of components in an isolated environment.

  • Create React App is used solely for the setup of Storybook
  • Rollup is used for bundling the library
  • Auto is used for releases

Getting Started

View the Mainsail UI storybook for more documentation and usage details.

Installing (to a project)

Install the npm package just like any other.

npm install mainsail-ui

// or

yarn add mainsail-ui

Then import and use your desired component:

import { Button } from "mainsail-ui";

<Button text="Do Stuff" />;

Contributing & Development

Please see the dev docs for valuable information on Contributing.