react-toolbox/components/drawer/readme.md

38 lines
919 B
Markdown
Raw Normal View History

2015-07-01 09:38:07 +03:00
# Aside
```
var Aside = require('react-toolbox/components/aside');
2015-07-01 09:38:07 +03:00
<Aside>
<header/>
<section>
<h1>Hello World</h1>
</section>
<footer/>
</Aside>
```
## Properties
| Name | Type | Default | Description|
|:- |:-: | :- |:-|
| **active** | Bool | false | If true, component will be show by default.|
2015-07-07 12:30:22 +03:00
| **className** | String | | Sets the class-styles of the Component.|
2015-07-01 09:38:07 +03:00
| **hideable** | Bool | false | If true, the componente can be hideable clicking in it.|
2015-07-07 12:30:22 +03:00
| **type** | String | "left" | Type of the component, overwrite this property if you need set a different stylesheet. Options: "left" or "right"|
2015-07-01 09:38:07 +03:00
## Methods
#### show
2015-07-07 12:30:22 +03:00
Show component.
2015-07-01 09:38:07 +03:00
```
aside_instance.show();
```
#### hide
2015-07-07 12:30:22 +03:00
Hide component.
2015-07-01 09:38:07 +03:00
```
aside_instance.hide();
```