apeman-react-style
Version:
apeman react package for style component.
185 lines (128 loc) • 4.56 kB
Markdown
apeman-react-style
==========
<!---
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-style
[bd_travis_url]: http://travis-ci.org/apeman-react-labo/apeman-react-style
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-react-labo/apeman-react-style.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/apeman-react-labo/apeman-react-style
[bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-react-labo/apeman-react-style.svg?token=
[bd_license_url]: https://github.com/apeman-react-labo/apeman-react-style/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-react-labo/apeman-react-style
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-react-labo/apeman-react-style.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-react-labo/apeman-react-style.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-react-labo/apeman-react-style
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-react-labo/apeman-react-style.svg
[bd_npm_url]: http://www.npmjs.org/package/apeman-react-style
[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-react-style.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 style 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-style --save
```
<!-- Section from "doc/guides/01.Installation.md.hbs" End -->
<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->
<a name="section-doc-guides-02-usage-md"></a>
Usage
---------
Convert react inline style attribute into style tag.
```jsx
'use strict'
import React from 'react'
import {ApStyle} from 'apeman-react-style'
const ExampleComponent = React.createClass({
render () {
let style01 = {
'my-component-01 button': {
backgroundColor: '#FFF',
color: '#555'
}
}
let style02 = {
'my-component-02 button': { /* ... */ }
}
return (
<div>
<ApStyle data={ style01 }/>
<ApStyle data={ style02 }/>
</div>
)
}
})
```
This will results,
```html
<html>
<head>
<style type="text/css">
.my-component-01 button {
background-color: #FFF;
color: #555;
}
.my-component-02 button {
/*...*/
}
</style>
</head>
</html>
```
### Props
| Key | Type | Description |
| --- | ---- | ------ |
| data | string|object | Css string or style data. |
| prefix | string | Parent selector for each styles to add. |
<!-- Section from "doc/guides/02.Usage.md.hbs" End -->
<!-- Section from "doc/guides/04.Components.md.hbs" Start -->
<a name="section-doc-guides-04-components-md"></a>
Components
-----
### ApStyle
**Props**
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| data | string|objectOf | null | | |
| smallMediaData | string|object | null | | |
| mediumMediaData | string|object | null | | |
| largeMediaData | string|object | null | | |
| type | string | 'text/css' | | |
<!-- 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-style/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 -->