apeman-react-image/README.md

apeman-react-image
==========

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

const ExampleComponent = React.createClass({
  render () {
    return (
      <div>
        <ApImageStyle backgroundColor='#333'
        />
        <ApImage src='http://example.com/images/sample.png'
                 alt='This is it!'
                 scale='fit'
        />
      </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
-----


### ApImageStyle

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| style | object | {} | |  |
| backgroundColor | string | &#x27;#DDD&#x27; | |  |
| spinColor |  | &#x27;rgba(255,255,255,0.5)&#x27; | |  |

### ApImage

**Props**

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| scale | enum | &#x27;none&#x27; | | Image scaling policy |
| width | number|string | 300 | | Image width |
| height | number|string | 150 | | Image height |
| src | string | null | | Image src string |
| alt | string | &#x27;NO IMAGE&#x27; | | Alt test |
| spinnerTheme | string | ApSpinner.DEFAULT_THEME | | Them of spinner |
| onLoad | func | null | | Handler on image load |
| onError | func | null | | Handler on image error. |


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