0.3.2 • Published 8 years ago
thermal-ui v0.3.2
Thermal UI Components
:fire::fire::fire:
Usage
npm install react styled-components react-router-dom@next thermal-ui
Table of Contents
- Layout
- Typography
- General
- Navigation
- BottomBar
- Breadcrumb
- Dropdown
- Menu
- Tabs
- TopBar
- Steps
- Fields
- Checkbox
- DatePicker
- Form
- Input
- Radio
- Rate
- Select
- Slider
- Switch
- Upload
- Display
- Badge
- Card
- Carousel
- Calendar
- Code
- List
- ListItem
- Timeline
- Table
- Feedback
- Alert
- Dialogue
- Loader
- Notification
- ProgressBar
Layout
Standard display components to build your app in the cleanest way possible.
Container
<Container flex flexColumn padded>
children
</Container>
Column
<Column smCol={12} mdCol={12} lgCol={12}>
children
</Column>
Row
<Row>
<Column></Column>
<Column></Column>
<Column></Column>
</Row>
Typography
A set of wrappers to create consistent and styled text, no matter the screen
Hero
<Hero right center color="#F9F9F9">
Lorem Ipsum Hero
</Hero>
Headline
<Headline right center color="#F9F9F9">
Lorem Ipsum Headline
</Headline>
Title
<Title right center color="#F9F9F9">
Lorem Ipsum Title
</Title>
Subtitle
<Subtitle right center color="#F9F9F9">
Lorem Ipsum Subtitle
</Subtitle>
Text
<Text right center color="#F9F9F9">
Lorem Ipsum Text
</Text>
General
Button
<Button primary color="#FFF">button text</Button>
Icon
<Icon />
Navigation
BottomBar
<BottomBar>
Something in the bottom bar <Button>button too</Button>
</BottomBar>
Breadcrumb
<Breadcrumb />
Dropdown
<Button>
<Dropdown />
</Button>
<Icon>
<Dropdown />
</Icon>
Fields
<Input type="string:default" />
Display
Card
<Card title="some string">
something in the card
<CardActions actions={{'some action': function() { /* something */}}}/>
</Card>
Feedback
Contributing
Some gotcha's while updating/extending.
- If you don't spread the props out of and into the styled component then you're going to have a bad time. This creates a bad diff tree for react but it can deal better than you pulling your hair out if you're using this library in another project and can't override a prop or add a className.
- Make sure you align your contribution with the Style Guide
- Submit a PR
- On PR approval:
- merge into master
- pull master locally
npm version <major|minor|patch> -m "tell us about the change"
git push origin master && git push origin v<version-npm-gives-you>
- Profit???