react-toolbox/components/dialog/readme.md

41 lines
1.1 KiB
Markdown
Raw Normal View History

2015-07-06 13:53:37 +03:00
# Dialog
```
var Dialog = require('react-toolbox/components/dialog');
var actions = [
{ caption: "Cancel", style: "transparent", onClick: this.onClose }
,
{ caption: "Save", style: "transparent", onClick: this.onSave }
]
<Dialog title='Hello World' actions={actions}>
/* -- more content -- */
</Dialog>
```
## Properties
| Name | Type | Default | Description|
|:- |:-: | :- |:-|
| **actions** | Array | | A array of actions callbacks for the component.|
2015-07-07 12:30:22 +03:00
| **active** | Boolean | | If true, component will be shows.|
2015-07-06 13:53:37 +03:00
| **className** | String | "normal" | Set the class-styles of the Component.|
| **title** | String | | The text string to use for the title of the component.|
| **type** | String | | Type of the component, overwrite this property if you need set a different stylesheet.|
## Methods
#### show
Shows the dialog.
```
dialog_instance.show();
```
#### hide
Hides the dialog.
```
dialog_instance.hide();
```