# @beisen-phoenix/checkbox

> checkbox

Latest version **3.3.55** (published 2019-11-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install @beisen-phoenix/checkbox
pnpm add @beisen-phoenix/checkbox
yarn add @beisen-phoenix/checkbox
bun add @beisen-phoenix/checkbox
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.3.55 |
| Published | 2019-11-25 |
| First published | 2019-02-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 28.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | beisencorp |

## Links

- npm: https://www.npmjs.com/package/@beisen-phoenix/checkbox
- npm.io page: https://npm.io/package/@beisen-phoenix/checkbox

## Dependencies (3)

- [@beisen-phoenix/tooltip](https://npm.io/package/@beisen-phoenix/tooltip.md) ^3.3.55
- [@beisen-phoenix/style-token](https://npm.io/package/@beisen-phoenix/style-token.md) ^3.3.55
- [@beisen-phoenix/common-utils](https://npm.io/package/@beisen-phoenix/common-utils.md) ^3.3.55

## Recent versions

- 3.3.55 (latest) — 2019-11-25
- 3.2.44-rc.1 (rc) — 2019-10-24
- 3.3.53 — 2019-11-25
- 3.3.52 — 2019-11-24
- 3.3.51 — 2019-11-23
- 3.3.49 — 2019-11-22
- 3.3.47 — 2019-11-22
- 3.3.46 — 2019-11-22
- 3.3.45 — 2019-11-21
- 3.3.43 — 2019-11-21
- 3.3.42 — 2019-11-21
- 3.3.41-beta.1 — 2019-11-21
- 3.3.41 — 2019-11-21
- 3.3.39 — 2019-11-20
- 3.3.38 — 2019-11-20
- … 413 more at https://npm.io/package/@beisen-phoenix/checkbox/versions

## README

# 复选框组件

> @beisen-phoenix/checkbox

## 概述

> 多选框主要用于一组可选项多项选择，或者单独用于标记切换某种状态。分为三类：单独使用、CheckboxGroup、全选。
> 
> 单独使用可以表示两种状态之间的切换，和 switch 类似。区别在于切换 switch 会直接触发状态改变，而 checkbox 一般用于状态标记，需要和提交操作配合。


## API

| 参数 | 说明 | 类型 | 默认值 | 必须 |
| --- | --- | --- | --- | --- |
| label | checkbox的文字说明 | string | 无 | 否 |
| value | checkbox的值 | string、 number | 无 | 是 |
| checked | 是否选中该checkbox | boolean | 无 | 否 |
| defaultChecked | 是否初始选中 | boolean | false | 否 |
| disabled | 禁用checkbox | boolean | false | 否 |
| extraCls | 生成的dom节点的后缀class,一般用于覆盖组件默认样式使用| string | 无| 否 |
| onChange |  发生状态变化后的回调 | (data: (Object:checkbox的数据), e: event) => void | 无 | 否 |
| tipsType | 提示UI类型 `default`【显示为html标签自带title】、`animate`【显示为标准tooltip】 使用'default'有利于性能提升 | string | 'animate' | 否 |
| fontSize | 文字大小 `normal`【12号字】、 `middle`【14号字】 | string | 'normal' | 否 |
| textColor | 文字颜色 `M1` 、`M2`、 `M3` 、`M4` 、`M5` | string | 'M3' | 否 |

### 2019-08-21
删除半选状态

### 2019-09-25
最外层布局由flex改为inline-block,增加最大宽度为100%
无文字时，仅渲染checkbox图标，移除文字节点

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