1 | apeman-react-captcha
|
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-captcha
|
18 | [bd_travis_url]: http://travis-ci.org/apeman-react-labo/apeman-react-captcha
|
19 | [bd_travis_shield_url]: http://img.shields.io/travis/apeman-react-labo/apeman-react-captcha.svg?style=flat
|
20 | [bd_travis_com_url]: http://travis-ci.com/apeman-react-labo/apeman-react-captcha
|
21 | [bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-react-labo/apeman-react-captcha.svg?token=
|
22 | [bd_license_url]: https://github.com/apeman-react-labo/apeman-react-captcha/blob/master/LICENSE
|
23 | [bd_codeclimate_url]: http://codeclimate.com/github/apeman-react-labo/apeman-react-captcha
|
24 | [bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-react-labo/apeman-react-captcha.svg?style=flat
|
25 | [bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-react-labo/apeman-react-captcha.svg?style=flat
|
26 | [bd_gemnasium_url]: https://gemnasium.com/apeman-react-labo/apeman-react-captcha
|
27 | [bd_gemnasium_shield_url]: https://gemnasium.com/apeman-react-labo/apeman-react-captcha.svg
|
28 | [bd_npm_url]: http://www.npmjs.org/package/apeman-react-captcha
|
29 | [bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-react-captcha.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 captcha component.
|
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-captcha --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 | [![Demo Image](./doc/images/screenshot.png)][demo_url]
|
77 |
|
78 | [demo_url]: http://apeman-react-labo.github.io/apeman-react-captcha/demo/demo.html
|
79 |
|
80 |
|
81 |
|
82 |
|
83 |
|
84 |
|
85 | <a name="section-doc-guides-03-usage-md"></a>
|
86 | Usage
|
87 | ---------
|
88 |
|
89 | ```jsx
|
90 | 'use strict'
|
91 |
|
92 | import React from 'react'
|
93 | import {ApCaptcha, ApCaptchaStyle} from 'apeman-react-captcha'
|
94 |
|
95 | const ExampleComponent = React.createClass({
|
96 | getInitialState () {
|
97 | return {
|
98 | captchaSrc: './captcha.svg'
|
99 | }
|
100 | },
|
101 | render () {
|
102 | const s = this
|
103 | let { state } = s
|
104 | return (
|
105 | <div>
|
106 | <ApCaptchaStyle />
|
107 | <ApCaptcha src={ state.captchaSrc }
|
108 | refreshText="refresh"
|
109 | onRefresh={ s.refreshCaptcha }/>
|
110 | </div>
|
111 | )
|
112 | },
|
113 | refreshCaptcha () {
|
114 | const s = this
|
115 | let time = new Date().getTime()
|
116 | console.log('refreshCaptcha:', time)
|
117 | s.setState({
|
118 | captchaSrc: `./images/mock-captcha.svg?t=${time}`
|
119 | })
|
120 | }
|
121 | })
|
122 |
|
123 | ```
|
124 |
|
125 |
|
126 |
|
127 |
|
128 |
|
129 |
|
130 |
|
131 | <a name="section-doc-guides-04-components-md"></a>
|
132 | Components
|
133 | -----
|
134 |
|
135 |
|
136 | ### ApCaptchaStyle
|
137 |
|
138 | **Props**
|
139 |
|
140 | | Name | Type | Default | Description |
|
141 | | ---- | ---- | ------- | ----------- |
|
142 | | style | object | {} | | |
|
143 |
|
144 | ### ApCaptchaSvg
|
145 |
|
146 | **Props**
|
147 |
|
148 | | Name | Type | Default | Description |
|
149 | | ---- | ---- | ------- | ----------- |
|
150 | | version | | '1.1' | | |
|
151 | | xmlns | | 'http://www.w3.org/2000/svg' | | |
|
152 | | text | | null | | |
|
153 | | width | | 256 | | |
|
154 | | height | | 92 | | |
|
155 |
|
156 | ### ApCaptcha
|
157 |
|
158 | **Props**
|
159 |
|
160 | | Name | Type | Default | Description |
|
161 | | ---- | ---- | ------- | ----------- |
|
162 | | src | string | null | | Image source url |
|
163 | | onRefresh | func | null | | Handler for refresh |
|
164 | | refreshIcon | string | 'fa fa-refresh' | | |
|
165 | | refreshText | string | '' | | |
|
166 | | imageWidth | number | 240 | | |
|
167 | | imageHeight | number | 94 | | |
|
168 | | onImageLoad | func | null | | |
|
169 | | onImageError | func | null | | |
|
170 | | spinning | bool | false | | |
|
171 | | spinnerTheme | string | ApSpinner.DEFAULT_THEME | | |
|
172 |
|
173 |
|
174 |
|
175 |
|
176 |
|
177 |
|
178 |
|
179 |
|
180 |
|
181 | <a name="license"></a>
|
182 |
|
183 | License
|
184 | -------
|
185 | This software is released under the [MIT License](https://github.com/apeman-react-labo/apeman-react-captcha/blob/master/LICENSE).
|
186 |
|
187 |
|
188 |
|
189 |
|
190 |
|
191 | <a name="links"></a>
|
192 |
|
193 | Links
|
194 | ------
|
195 |
|
196 | + [apeman][apeman_url]
|
197 | + [apeman-react-labo][apeman_react_labo_url]
|
198 | + [React][react_url]
|
199 |
|
200 | [apeman_url]: https://github.com/apeman-labo/apeman
|
201 | [apeman_react_labo_url]: https://github.com/apeman-react-labo
|
202 | [react_url]: https://facebook.github.io/react/
|
203 |
|
204 |
|