Documentation 📝

To read up on how to use the components head over to Storybook.

Getting started ⛑️

$ yarn add optimus-ui

Or use NPM if you prefer:

$ npm i optimus-ui

Usage 🍩

import './styles.css'
//import the components from the package
import { Button, Typography } from 'optimus-ui'
//make sure to include the stylesheet in the root of your app
import 'optimus-ui/dist/optimus-ui.css'
export default function App() {
  return (
    <div className="App">
      <Typography variant="HeadingThree">Hello CodeSandbox</Typography>
      <h2>Start editing to see some magic happen!</h2>
      <Button variant="BlueDarkButton" size="small">
        Button
      </Button>
    </div>
  )
}

CodeSandbox Templates 💵

• JavaScript Starter
• TypeScript Starter

How to contribute

TBA

License

MIT © Tripplo Software