apeman-react-password
Version:
apeman react package for password component.
172 lines (107 loc) • 4.21 kB
Markdown
apeman-react-password
==========
<!---
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]
[bd_repo_url]: https://github.com/apeman-react-labo/apeman-react-password
[bd_travis_url]: http://travis-ci.org/apeman-react-labo/apeman-react-password
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-react-labo/apeman-react-password.svg?style=flat
[bd_license_url]: https://github.com/apeman-react-labo/apeman-react-password/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-react-labo/apeman-react-password
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-react-labo/apeman-react-password.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-react-labo/apeman-react-password.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-react-labo/apeman-react-password
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-react-labo/apeman-react-password.svg
[bd_npm_url]: http://www.npmjs.org/package/apeman-react-password
[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-react-password.svg?style=flat
[bd_bower_badge_url]: https://img.shields.io/bower/v/apeman-react-password.svg?style=flat
<!-- Badge End -->
<!-- Description Start -->
<a name="description"></a>
apeman react package for password 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-password --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_url]
[demo_url]: http://apeman-react-labo.github.io/apeman-react-password/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 from 'react';
import {ApPassword, ApPasswordStyle} from 'apeman-react-password';
const html = (
<html>
<head>
<ApPasswordStyle></ApPasswordStyle>
</head>
<body>
<ApPassword name="password" onChange={ (e) => {
console.log(e.target.value);
}}></ApPassword>
</body>
</html>
);
```
<!-- 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
-----
### ApPassword
Password input component.
**props**
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| name | string | '' | Name attribute of input/textarea element. |
| value | string | '' | Value of text. |
| placeholder | string | '' | Place holder text. |
### ApPasswordStyle
Style for password.
**props**
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| scoped | boolean | false | Render as scoped style. |
| style | object | {} | Style object. |
| maxWidth |number | 480 | Max width. |
<!-- 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-password/blob/master/LICENSE).
<!-- LICENSE End -->
<!-- Links Start -->
<a name="links"></a>
Links
------
+ [apeman](https://github.com/apeman-labo/apeman)
+ [apeman-react-labo](https://github.com/apeman-react-labo)
+ [React](https://facebook.github.io/react/)
<!-- Links End -->