https://github.com/peterchenhdu/pl-checkbox
checkbox component
https://github.com/peterchenhdu/pl-checkbox
Last synced: 4 months ago
JSON representation
checkbox component
- Host: GitHub
- URL: https://github.com/peterchenhdu/pl-checkbox
- Owner: peterchenhdu
- License: mit
- Created: 2016-11-24T07:41:38.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-11-24T09:15:41.000Z (over 8 years ago)
- Last Synced: 2025-02-18T01:04:57.588Z (4 months ago)
- Language: JavaScript
- Size: 11.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
Awesome Lists containing this project
README
# pl-checkbox
---
### 该仓库基于 https://github.com/react-component/checkbox 进行修改，用于个人学习。
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]
[![gemnasium deps][gemnasium-image]][gemnasium-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/pl-checkbox.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/pl-checkbox
[travis-image]: https://travis-ci.org/peterchenhdu/pl-checkbox.svg?branch=master
[travis-url]: https://travis-ci.org/peterchenhdu/pl-checkbox
[coveralls-image]: https://img.shields.io/coveralls/peterchenhdu/pl-checkbox.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/peterchenhdu/pl-checkbox?branch=master
[gemnasium-image]: http://img.shields.io/gemnasium/peterchenhdu/pl-checkbox.svg?style=flat-square
[gemnasium-url]: https://gemnasium.com/peterchenhdu/pl-checkbox
[download-image]: https://img.shields.io/npm/dm/pl-checkbox.svg?style=flat-square
[download-url]: https://www.npmjs.com/package/pl-checkbox
## install
[](https://npmjs.org/package/pl-checkbox)
## Usage
```js
import React from 'react'
import Checkbox from 'pl-checkbox';
export default class Index extends React.Component{
constructor(props){
super(props);
}
render(){
return (
这是一个chechbox :
);
}
}
```
## API
### props
name
type
default
description
prefixCls
String
rc-checkbox
className
String
''
additional class name of root node
name
String
same with native input checkbox
checked
enum: 0,1,2
defaultChecked
enum: 0,1,2
0
same with native input checkbox
onChange
Function(e:Event, checked:Number)
called when checkbox is changed. e is native event, checked is original checked state.
## Development
```
npm install
npm start
```
## Example
http://localhost:8001/examples/
online example: http://react-component.github.io/checkbox/examples/
## Test Case
```
npm test
npm run chrome-test
```
## Coverage
```
npm run coverage
```
open coverage/ dir
## License
pl-checkbox is released under the MIT license.