1 | apeman-react-icon
|
2 | ==========
|
3 |
|
4 |
|
5 | This file is generated by ape-tmpl. Do not update manually.
|
6 | --->
|
7 |
|
8 |
|
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-icon
|
18 | [bd_travis_url]: http://travis-ci.org/apeman-react-labo/apeman-react-icon
|
19 | [bd_travis_shield_url]: http://img.shields.io/travis/apeman-react-labo/apeman-react-icon.svg?style=flat
|
20 | [bd_travis_com_url]: http://travis-ci.com/apeman-react-labo/apeman-react-icon
|
21 | [bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-react-labo/apeman-react-icon.svg?token=
|
22 | [bd_license_url]: https://github.com/apeman-react-labo/apeman-react-icon/blob/master/LICENSE
|
23 | [bd_codeclimate_url]: http://codeclimate.com/github/apeman-react-labo/apeman-react-icon
|
24 | [bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-react-labo/apeman-react-icon.svg?style=flat
|
25 | [bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-react-labo/apeman-react-icon.svg?style=flat
|
26 | [bd_gemnasium_url]: https://gemnasium.com/apeman-react-labo/apeman-react-icon
|
27 | [bd_gemnasium_shield_url]: https://gemnasium.com/apeman-react-labo/apeman-react-icon.svg
|
28 | [bd_npm_url]: http://www.npmjs.org/package/apeman-react-icon
|
29 | [bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-react-icon.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 |
|
34 |
|
35 |
|
36 |
|
37 | <a name="description"></a>
|
38 |
|
39 | apeman react package for icon components.
|
40 |
|
41 |
|
42 |
|
43 |
|
44 |
|
45 | <a name="overview"></a>
|
46 |
|
47 |
|
48 |
|
49 |
|
50 |
|
51 |
|
52 |
|
53 | <a name="sections"></a>
|
54 |
|
55 |
|
56 |
|
57 | <a name="section-doc-guides-01-installation-md"></a>
|
58 | Installation
|
59 | -----
|
60 |
|
61 | ```bash
|
62 | $ npm install apeman-react-icon --save
|
63 | ```
|
64 |
|
65 |
|
66 |
|
67 |
|
68 |
|
69 |
|
70 | <a name="section-doc-guides-02-demo-md"></a>
|
71 | Demo
|
72 | -----
|
73 |
|
74 | [Live demo][demo_url] is hosted on GitHub Pages.
|
75 |
|
76 |
|
77 | [![Demo Image](./doc/images/screenshot.png)][demo_url]
|
78 | -->
|
79 |
|
80 | [demo_url]: http://apeman-react-labo.github.io/apeman-react-icon/demo/demo.html
|
81 |
|
82 |
|
83 |
|
84 |
|
85 |
|
86 |
|
87 | <a name="section-doc-guides-03-usage-md"></a>
|
88 | Usage
|
89 | ---------
|
90 |
|
91 | ```jsx
|
92 | 'use strict'
|
93 |
|
94 | import React from 'react'
|
95 | import {ApFaIcon, ApFaIconStyle} from 'apeman-react-icon'
|
96 |
|
97 | const ExampleComponent = React.createClass({
|
98 | render () {
|
99 | return (
|
100 | <div>
|
101 | <ApFaIconStyle />
|
102 | <ApFaIcon type="money"/>
|
103 | </div>
|
104 | )
|
105 | }
|
106 | })
|
107 |
|
108 |
|
109 | ```
|
110 |
|
111 |
|
112 |
|
113 |
|
114 |
|
115 |
|
116 |
|
117 | <a name="section-doc-guides-04-components-md"></a>
|
118 | Components
|
119 | -----
|
120 |
|
121 |
|
122 | ### ApFaIconStyle
|
123 |
|
124 | **Props**
|
125 |
|
126 | | Name | Type | Default | Description |
|
127 | | ---- | ---- | ------- | ----------- |
|
128 | | style | object | {} | | |
|
129 |
|
130 | ### ApFaIcon
|
131 |
|
132 | **Props**
|
133 |
|
134 | | Name | Type | Default | Description |
|
135 | | ---- | ---- | ------- | ----------- |
|
136 | | type | string | null | | |
|
137 |
|
138 | ### ApIconStyle
|
139 |
|
140 | **Props**
|
141 |
|
142 | | Name | Type | Default | Description |
|
143 | | ---- | ---- | ------- | ----------- |
|
144 | | style | object | {} | | |
|
145 |
|
146 | ### ApIcon
|
147 |
|
148 | **Props**
|
149 |
|
150 | | Name | Type | Default | Description |
|
151 | | ---- | ---- | ------- | ----------- |
|
152 |
|
153 | ### ApIonIconStyle
|
154 |
|
155 | **Props**
|
156 |
|
157 | | Name | Type | Default | Description |
|
158 | | ---- | ---- | ------- | ----------- |
|
159 | | style | object | {} | | |
|
160 |
|
161 | ### ApIonIcon
|
162 |
|
163 | **Props**
|
164 |
|
165 | | Name | Type | Default | Description |
|
166 | | ---- | ---- | ------- | ----------- |
|
167 | | type | string | null | | |
|
168 |
|
169 |
|
170 |
|
171 |
|
172 |
|
173 |
|
174 |
|
175 |
|
176 |
|
177 |
|
178 | <a name="license"></a>
|
179 |
|
180 | License
|
181 | -------
|
182 | This software is released under the [MIT License](https://github.com/apeman-react-labo/apeman-react-icon/blob/master/LICENSE).
|
183 |
|
184 |
|
185 |
|
186 |
|
187 |
|
188 | <a name="links"></a>
|
189 |
|
190 | Links
|
191 | ------
|
192 |
|
193 | + [apeman](https://github.com/apeman-labo/apeman)
|
194 | + [apeman-react-labo](https://github.com/apeman-react-labo)
|
195 | + [React](https://facebook.github.io/react/)
|
196 | + [Font Awesome](http://fontawesome.io/)
|
197 |
|
198 |
|