Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 1.17 KB

README.md

File metadata and controls

54 lines (34 loc) · 1.17 KB

Bold

React implementation of the Bold Design System.

Build Status codecov

https://bold.bridge.ufsc.br/

WARNING: Beta phase

This project is currently in beta phase (1.0.0-beta.* versions) and its API may change without following semver.

Getting started

# with npm
npm install bold-ui --save

# with yarn
yarn add bold-ui --save

Font family: IBM Plex Sans

<link href="https://fonts.googleapis.com/css?family=IBM+Plex+Sans:400,400i,700,700i" rel="stylesheet" />

Visit https://bold.bridge.ufsc.br/getting-started for more information.

Usage

Quick demonstration of the library usage:

import React from 'react'
import ReactDOM from 'react-dom'
import { Button } from 'bold-ui'

const App = () => {
  return <Button kind='primary'>Hello World</Button>
}

ReactDOM.render(<App />, document.querySelector('#root'))

Storybook

https://bold.bridge.ufsc.br/storybook/

Contributing

See our Contributing guide.