react-toolbox/components/app_bar/readme.md

29 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.
```javascript
import AppBar from 'react-toolbox/app_bar';
const AppBarTest = () => (
<AppBar fixed flat>
<a href="/home">React Toolbox Docs</a>
<Navigation />
</AppBar>
);
```
Coming soon, the `AppBar` component will support arbitrary content attributes for left and right content and a title, for now it's just a wrapper.
## Properties
| Name | Type | Default | Description|
|:- |:-: | :- |:-|
| **className** | String | `''` | Set a class for the root component.|
| **flat** | Bool | `false` | If true, the AppBar shows a shadow.|
| **fixed** | Bool | `false` | Determine if the bar should have position `fixed` or `relative`.|
## Structure
It renders an HTML `header` tag with the given `className` so to style it you just need to use a class and apply CSS over the node.