@npmcorp/pui-react-alerts
v8.5.0
Published
React components to display flash messages to the user
Downloads
19
Readme
pui-react-alerts
React components to display flash messages to the user
Pivotal UI React (GitHub, npm) is a collection of React components for rapidly building and prototyping UIs.
This component requires React v0.13
See the Pivotal UI Styleguide for fully rendered examples.
Components
SuccessAlert
Display a flash message to the user indicating success.
var SuccessAlert = require('
#### Properties
- `dismissable`
- `Boolean`: Determines whether the alert can be closed by the user
- `Function`: Called when the user closes the alert
- `withIcon`
- `Boolean`: Whether to show an icon with the alert text.
### InfoAlert
Display an informational flash message to the user.
```js
var InfoAlert = require('
#### Properties
- `dismissable`
- `Boolean`: Determines whether the alert can be closed by the user
- `Function`: Called when the user closes the alert
- `withIcon`
- `Boolean`: Whether to show an icon with the alert text.
### WarningAlert
Display a flash message to warn the user.
```js
var WarningAlert = require('
#### Properties
- `dismissable`
- `Boolean`: Determines whether the alert can be closed by the user
- `Function`: Called when the user closes the alert
- `withIcon`
- `Boolean`: Whether to show an icon with the alert text.
### ErrorAlert
Display a flash message to the user indicating an error condition.
```js
var ErrorAlert = require('
#### Properties
- `dismissable`
- `Boolean`: Determines whether the alert can be closed by the user
- `Function`: Called when the user closes the alert
- `withIcon`
- `Boolean`: Whether to show an icon with the alert text.
*****************************************
(c) Copyright 2015 Pivotal Software, Inc. All Rights Reserved.