UNPKG

3.93 kBMarkdownView Raw
1apeman-react-label
2==========
3
4<!---
5This file is generated by ape-tmpl. Do not update manually.
6--->
7
8<!-- Badge Start -->
9<a name="badges"></a>
10
11[![Build Status][bd_travis_shield_url]][bd_travis_url]
12[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
13[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
14[![npm Version][bd_npm_shield_url]][bd_npm_url]
15[![JS Standard][bd_standard_shield_url]][bd_standard_url]
16
17[bd_repo_url]: https://github.com/apeman-react-labo/apeman-react-label
18[bd_travis_url]: http://travis-ci.org/apeman-react-labo/apeman-react-label
19[bd_travis_shield_url]: http://img.shields.io/travis/apeman-react-labo/apeman-react-label.svg?style=flat
20[bd_travis_com_url]: http://travis-ci.com/apeman-react-labo/apeman-react-label
21[bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-react-labo/apeman-react-label.svg?token=
22[bd_license_url]: https://github.com/apeman-react-labo/apeman-react-label/blob/master/LICENSE
23[bd_codeclimate_url]: http://codeclimate.com/github/apeman-react-labo/apeman-react-label
24[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-react-labo/apeman-react-label.svg?style=flat
25[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-react-labo/apeman-react-label.svg?style=flat
26[bd_gemnasium_url]: https://gemnasium.com/apeman-react-labo/apeman-react-label
27[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-react-labo/apeman-react-label.svg
28[bd_npm_url]: http://www.npmjs.org/package/apeman-react-label
29[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-react-label.svg?style=flat
30[bd_standard_url]: http://standardjs.com/
31[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
32
33<!-- Badge End -->
34
35
36<!-- Description Start -->
37<a name="description"></a>
38
39apeman react package label component.
40
41<!-- Description End -->
42
43
44<!-- Overview Start -->
45<a name="overview"></a>
46
47
48
49<!-- Overview End -->
50
51
52<!-- Sections Start -->
53<a name="sections"></a>
54
55<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->
56
57<a name="section-doc-guides-01-installation-md"></a>
58Installation
59-----
60
61```bash
62$ npm install apeman-react-label --save
63```
64
65
66<!-- Section from "doc/guides/01.Installation.md.hbs" End -->
67
68<!-- Section from "doc/guides/03.Usage.md.hbs" Start -->
69
70<a name="section-doc-guides-03-usage-md"></a>
71Usage
72---------
73
74```jsx
75'use strict'
76
77import React from 'react'
78import {ApLabel, ApLabelStyle} from 'apeman-react-label'
79
80let html = (
81 <html>
82 <head>
83 <ApLabelStyle/>
84 </head>
85 <body>
86 <ApLabel htmlFor="input-01">hoge</ApLabel>
87 </body>
88 </html>
89)
90
91```
92
93
94
95<!-- Section from "doc/guides/03.Usage.md.hbs" End -->
96
97<!-- Section from "doc/guides/04.Components.md.hbs" Start -->
98
99<a name="section-doc-guides-04-components-md"></a>
100Components
101-----
102
103
104### ApLabelStyle
105
106**Props**
107
108| Name | Type | Default | Description |
109| ---- | ---- | ------- | ----------- |
110| style | object | {} | | |
111
112### ApLabel
113
114**Props**
115
116| Name | Type | Default | Description |
117| ---- | ---- | ------- | ----------- |
118| htmlFor | string | null | | |
119
120
121<!-- Section from "doc/guides/04.Components.md.hbs" End -->
122
123
124<!-- Sections Start -->
125
126
127<!-- LICENSE Start -->
128<a name="license"></a>
129
130License
131-------
132This software is released under the [MIT License](https://github.com/apeman-react-labo/apeman-react-label/blob/master/LICENSE).
133
134<!-- LICENSE End -->
135
136
137<!-- Links Start -->
138<a name="links"></a>
139
140Links
141------
142
143+ [apeman][apeman_url]
144+ [apeman-react-labo][apeman_react_labo_url]
145+ [React][react_url]
146+ [Demo of apeman-react-label][demo_of_apeman_react_label_url]
147
148[apeman_url]: https://github.com/apeman-labo/apeman
149[apeman_react_labo_url]: https://github.com/apeman-react-labo
150[react_url]: https://facebook.github.io/react/
151[demo_of_apeman_react_label_url]: http://apeman-demo-labo.github.io/apeman-react-label/demo/demo.html
152
153<!-- Links End -->