react-toolbox/components/app_bar/readme.md

33 lines
1.1 KiB
Markdown
Raw Normal View History

2015-10-29 07:48:59 +03:00
# App Bar
The app bar is a special kind of toolbar thats used for branding, navigation, search, and actions. Usually it contains controls on the right and left side and a title with the current section or app name. You should give the content with children elements.
2015-10-31 21:44:51 +03:00
```jsx
import AppBar from 'react-toolbox/lib/app_bar';
2016-05-15 14:23:55 +03:00
import theme from 'react-toolbox/lib/app_bar/style';
const AppBarTest = () => (
2016-05-15 14:23:55 +03:00
<AppBar theme={theme} fixed flat>
<a href="/home">React Toolbox Docs</a>
<Navigation />
</AppBar>
);
```
## Properties
| Name | Type | Default | Description|
2015-10-31 23:55:12 +03:00
|:-----|:-----|:-----|:-----|
| `className` | `String` | `''` | Set a class for the root component.|
| `fixed` | `Bool` | `false` | Determine if the bar should have position `fixed` or `relative`.|
| `flat` | `Bool` | `false` | If true, the AppBar shows a shadow.|
2016-05-15 14:23:55 +03:00
| `theme` | `Object` | `null` | Classnames object defining the component style.|
## Theme interface
| Name | Description|
|:---------|:-----------|
| `appBar` | Root class.|
| `fixed` | Implemented when the app bar is fixed.|
| `flat` | Implemented when the app bar is flat.|