Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 1.46 KB

README.md

File metadata and controls

66 lines (43 loc) · 1.46 KB

Flipper-UI logo

Flipper-UI

React UI based on the

@mui/material
toolkit for the web.

npm package npm downloads

Installation

Flipper-UI is available as an npm package.

npm install flipper-ui
yarn add flipper-ui

Usage

Here is a quick example to get you started, it's all you need:

import React from 'react'
import { render } from 'react-dom'
import { Button } from 'flipper-ui'

const App = () => {
  return (
    <Button variant="contained" color="primary">
      Hello World
    </Button>
  )
}

render(<App />, document.getElementById('root'))

Documentation

Check out our documentation website. You can also interact with the components there!

Contributing

Bug reports, feature requests and other contributions are more than welcome!
Whenever possible, please make a pull request with the implementation instead of just requesting it.

If the feature is big, open an issue first for discussion.

License

This project is licensed under the terms of the MIT license.