# tf-react-checkbox

> react版本的checkbox组件

Latest version **0.1.3** (published 2019-11-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install tf-react-checkbox
pnpm add tf-react-checkbox
yarn add tf-react-checkbox
bun add tf-react-checkbox
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2019-11-22 |
| First published | 2018-11-28 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 311.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | tffed |

## Links

- npm: https://www.npmjs.com/package/tf-react-checkbox
- Repository: http://gitlab.tf56.lo/tf-components/tf-react-checkbox
- npm.io page: https://npm.io/package/tf-react-checkbox

## Recent versions

- 0.1.3 (latest) — 2019-11-22
- 0.1.2 — 2019-05-05
- 0.1.1 — 2018-11-28

## README

## checkbox组件

> 本组件基于yarn构建, 仅支持react版本, 模拟ant design的checkbox组件

### 安装

```
npm i tf-react-checkbox
```

### 引入

```javascript
import Checkbox from 'tf-react-checkbox'
import 'tf-react-checkbox/dist/index.css'
```

### api属性

```javascript
// Checkbox
wrapClass: '', 
value: '',
defaultValue: '',
checked: false, //	指定当前是否选中	
defaultChecked: false,//	初始是否选中
disabled: false,//	失效状态
onChange: () => {}	//变化时回调函数

// CheckboxGroup
defaultValue: [], //	默认选中的选项	
disabled: false,//	整组失效	
options: [], //	指定可选项	
value: [], //	指定选中的选项
onChange: (checkedVal) => {} //	变化时回调函数
```

### 使用

```javascript
// Checkbox
function onChange(e, isChecked, val) {
  console.log(`checked = ${isChecked}`);
}
<Checkbox onChange={onChange}>Checkbox</Checkbox>
// ======================

const CheckboxGroup = Checkbox.Group;

function onChange(checkedValues) {
  console.log('checked = ', checkedValues);
}

const plainOptions = ['Apple', 'Pear', 'Orange'];
const options = [
  { label: 'Apple', value: 'Apple' },
  { label: 'Pear', value: 'Pear' },
  { label: 'Orange', value: 'Orange' },
];
const optionsWithDisabled = [
  { label: 'Apple', value: 'Apple' },
  { label: 'Pear', value: 'Pear' },
  { label: 'Orange', value: 'Orange' },
];

  <div>
    <CheckboxGroup options={plainOptions} defaultValue={['Apple']} onChange={onChange2} />
    <CheckboxGroup options={options} defaultValue={['Pear']} onChange={onChange2} />
    <CheckboxGroup options={optionsWithDisabled} disabled defaultValue={['Apple']} onChange={onChange2} />
  </div>
```


### 更新日志

```
0.1.3
  去掉警告信息
  
0.1.0
  版本发布
```

---
_Source: https://npm.io/package/tf-react-checkbox · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._