apeman-react-toast/README.md

apeman react package for toast components.

apeman-react-toast
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/apeman-react-labo/apeman-react-toast
[bd_travis_url]: http://travis-ci.org/apeman-react-labo/apeman-react-toast
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-react-labo/apeman-react-toast.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/apeman-react-labo/apeman-react-toast
[bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-react-labo/apeman-react-toast.svg?token=
[bd_license_url]: https://github.com/apeman-react-labo/apeman-react-toast/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-react-labo/apeman-react-toast
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-react-labo/apeman-react-toast.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-react-labo/apeman-react-toast.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-react-labo/apeman-react-toast
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-react-labo/apeman-react-toast.svg
[bd_npm_url]: http://www.npmjs.org/package/apeman-react-toast
[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-react-toast.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

apeman react package for toast components.

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install apeman-react-toast --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Demo.md.hbs" Start -->

<a name="section-doc-guides-02-demo-md"></a>

Demo
-----

[Live demo][demo_url] is hosted on GitHub Pages.

[![Demo Image](./doc/images/screenshot.png)][demo_url]

[demo_url]: http://apeman-react-labo.github.io/apeman-react-toast/demo/demo.html


<!-- Section from "doc/guides/02.Demo.md.hbs" End -->

<!-- Section from "doc/guides/03.Usage.md.hbs" Start -->

<a name="section-doc-guides-03-usage-md"></a>

Usage
---------

```jsx
'use strict'

import React from 'react'
import {ApToast, ApToastStyle} from 'apeman-react-toast'

const ExampleComponent = React.createClass({
  render () {
    return (
      <div>
        <ApToastStyle />
        <ApToast/>
      </div>
    )
  }
})

```



<!-- Section from "doc/guides/03.Usage.md.hbs" End -->

<!-- Section from "doc/guides/04.Components.md.hbs" Start -->

<a name="section-doc-guides-04-components-md"></a>

Components
-----


### ApErrorToast

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| messages |  | [] | |  |
| icon |  | &#x27;fa fa-check-circle&#x27; | |  |
| dismiss |  | null | |  |
| level |  | &#x27;error&#x27; | |  |

### ApInfoToast

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| messages |  | [] | |  |
| icon |  | &#x27;fa fa-exclamation-circle&#x27; | |  |
| dismiss |  | null | |  |
| level |  | &#x27;info&#x27; | |  |

### ApToastGroup

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| default | arrayOf |  | | Default messages |
| info | arrayOf | [] | | Info messages |
| error | arrayOf | [] | | Error messages |
| warn | arrayOf | [] | | Warn messages |
| dismiss | func |  | | Dismiss message |

### ApToastItem

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| text | string |  | |  |
| icon | string |  | |  |

### ApToastStyle

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| style | object | {} | |  |
| normalColor | string | ApStyle.NORMAL_COLOR | |  |
| infoColor | string | ApStyle.INFO_COLOR | |  |
| warnColor | string | ApStyle.WARN_COLOR | |  |
| errorColor | string | ApStyle.ERROR_COLOR | |  |
| transitionDuration |  | 100 | |  |

### ApToast

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| messages | arrayOf | [] | | Messages to show |
| icon | string | null | | Icon to show |
| dismiss | func | null | | Dismiss an item |
| level | string | &#x27;default&#x27; | | Level of toast |
| transitionTimeout |  | 100 | |  |

### ApWarnToast

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| messages |  | [] | |  |
| icon |  | &#x27;fa fa-warning&#x27; | |  |
| dismiss |  | null | |  |
| level |  | &#x27;warn&#x27; | |  |


<!-- Section from "doc/guides/04.Components.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/apeman-react-labo/apeman-react-toast/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [apeman][apeman_url]
+ [apeman-react-labo][apeman_react_labo_url]
+ [React][react_url]

[apeman_url]: https://github.com/apeman-labo/apeman
[apeman_react_labo_url]: https://github.com/apeman-react-labo
[react_url]: https://facebook.github.io/react/

<!-- Links End -->