apeman-react-list/README.md

apeman react package for list component.

apeman-react-list
==========

<!---
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-list
[bd_travis_url]: http://travis-ci.org/apeman-react-labo/apeman-react-list
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-react-labo/apeman-react-list.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/apeman-react-labo/apeman-react-list
[bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-react-labo/apeman-react-list.svg?token=
[bd_license_url]: https://github.com/apeman-react-labo/apeman-react-list/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-react-labo/apeman-react-list
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-react-labo/apeman-react-list.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-react-labo/apeman-react-list.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-react-labo/apeman-react-list
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-react-labo/apeman-react-list.svg
[bd_npm_url]: http://www.npmjs.org/package/apeman-react-list
[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-react-list.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 list component.

<!-- 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-list --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-list/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 {
  ApList,
  ApListItem,
  ApListItemText,
  ApListItemArrowIcon,
  ApListStyle
} from 'apeman-react-list'

const ExampleComponent = React.createClass({
  render () {
    const s = this
    return (
      <div>
        <ApListStyle />
        <ApList>
          <ApListItem onTap={ (e) => { s.handleTap(e, 1) } }>
            <ApListItemText>Item 01</ApListItemText>
            <ApListItemArrowIcon />
          </ApListItem>
          <ApListItem onTap={ (e) => { s.handleTap(e, 2) } }>
            <ApListItemText>Item 02</ApListItemText>
            <ApListItemArrowIcon />
          </ApListItem>
        </ApList>
      </div>
    )
  },
  handleTap () {

  }
})

```



<!-- 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
-----


### ApListBarMessage

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |

### ApListBar

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |

### ApListBody

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |

### ApListFooter

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| spinning | bool | false | | Show spinner |
| spinner | string | ApSpinner.DEFAULT_THEME | | Spinner theme |

### ApListHeader

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |

### ApListItemArrowIcon

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| direction | enum | &#x27;right&#x27; | |  |

### ApListItemIcon

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |

### ApListItemImage

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| src | string | null | |  |
| alt | string | null | |  |
| scale | enum | &#x27;fill&#x27; | |  |
| width | number | null | |  |
| height | number | null | |  |

### ApListItemText

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |

### ApListItem

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| disclosure | bool | false | |  |
| imgSrc | string | null | |  |
| imgAlt | string | null | |  |
| imgWidth | number | 72 | |  |
| title | string | null | | Titlte of item |
| subTitle | string | null | | Sub titlte of item |
| height | number | 48 | | Item height |
| data | object | null | | Data for events |

### ApListMoreButton

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| text | string | &#x27;Load More&#x27; | |  |
| enabled | bool | false | |  |

### ApListStyle

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| style | object | {} | |  |
| borderColor |  | &#x27;#EEE&#x27; | |  |
| backgroundColor |  | ApStyle.DEFAULT_BACKGROUND_COLOR | |  |
| headerColor |  | ApStyle.CAPTION_COLOR | |  |
| headerBorderColor |  | ApStyle.CAPTION_BORDER_COLOR | |  |
| rowHeight |  | ApStyle.ROW_HEIGHT | |  |

### ApList

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| spinning | bool | false | | Shows spin |
| spinner | string | ApSpinner.DEFAULT_THEME | | Theme of spinner |
| minHeight | number | null | | Min height of list |
| empty | bool | false | | Mark as empty |
| alt | string | &#x27;Not data found&#x27; | | Alt text to show when empty |


<!-- 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-list/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 -->