react-basic-kit

Base UI components to help set your component system on the right path

Getting Started

Install with yarn or npm

yarn add react-basic-kit

npm i -S react-basic-kit

@TODO basic usage example

Roadmap

Base UI components

• [ ] Layout
• [x] Typography
• [ ] Iconography
• [ ] Controls
• [ ] Alerts
• [ ] Tables
• [ ] Theming

Extensions

• [ ] Headless, styling from theme
• [ ] Themed kits, more granular tokenisation
• [ ] Dat.gui control kit
• [ ] App basics kit for stock components, headers, menus, navigation etc

Exports

Layout

• [x] Pane
• [x] View
• [x] Box
• [x] Flex
• [x] Spread
• [x] Stack
• [x] Spacer
• [x] Hidden
• [x] Card
• [ ] Grid
• [x] Image
• [x] Aspect
• [ ] Tabs
• [ ] Accordion

Typography

• [x] Headings
• [x] Body
• [x] Text
• [x] Blockquote
• [x] Code, Pre
• [x] List
• [x] Badge

Controls

• [x] Button
• [x] Button Groups
• [x] Link/Anchor
• [x] Range Slider
• [ ] Progress (inputless controlled range)
• [x] Input
• [ ] Textarea
• [ ] Radio
• [x] Checkbox
• [ ] Toggle/Switch
• [x] Select (native dropdown)
• [ ] Dropdown (custom styled dropdown)
• [ ] Number Input
• [ ] Form

Iconography

• [x] Icon
• [ ] Common Icon Set

Alerts

• [ ] Growl
• [ ] Notification
• [ ] Modal

### Tables

• [ ] Definition List
• [ ] Table
• [ ] Table Controls

### Utility

• [ ] Spinner
• [x] Placeholder
• [ ] Loading dots
• [ ] Tooltip

Theming

• [x] Base Theme Structure
• [ ] Colour Structure
• [ ] Variant Structure
• [ ] Utilities / Mixins

Contributing

Pull requests are always welcome, the project uses the standard code style. Please run npm test to ensure all tests are passing and add tests for any new features or updates.

For bugs and feature requests, please create an issue.

See the root readme for more information about how the repository is structured.

License

MIT