Karin API Docs / CheckboxProps

接口: CheckboxProps

定义于: packages/core/src/types/components/checkbox.ts:43

复选框

继承

• ComponentProps

属性

className?

optional className: string

定义于: packages/core/src/types/components/base.ts:37

每个渲染的组件都包裹了一个div，这里可以自定义这个div的className

继承自

ComponentProps.className

---

color?

optional color: "default" | "success" | "primary" | "secondary" | "warning" | "danger"

定义于: packages/core/src/types/components/checkbox.ts:54

复选框的颜色

---

componentClassName?

optional componentClassName: string

定义于: packages/core/src/types/components/base.ts:39

组件本身的className

继承自

ComponentProps.componentClassName

---

componentType

componentType: "checkbox"

定义于: packages/core/src/types/components/checkbox.ts:44

组件类型

重写了

ComponentProps.componentType

---

defaultSelected?

optional defaultSelected: boolean

定义于: packages/core/src/types/components/checkbox.ts:69

默认选中

---

description?

optional description: string

定义于: packages/core/src/types/components/base.ts:35

描述

继承自

ComponentProps.description

---

disableAnimation?

optional disableAnimation: boolean

定义于: packages/core/src/types/components/checkbox.ts:81

禁用动画

---

isDisabled?

optional isDisabled: boolean

定义于: packages/core/src/types/components/checkbox.ts:75

是否禁用

---

isIndeterminate?

optional isIndeterminate: boolean

定义于: packages/core/src/types/components/checkbox.ts:77

不确定性只是呈现性的。无论用户是否进行交互，不确定的视觉呈现都会保持不变

---

isInvalid?

optional isInvalid: boolean

定义于: packages/core/src/types/components/checkbox.ts:79

是否无效

---

isReadOnly?

optional isReadOnly: boolean

定义于: packages/core/src/types/components/checkbox.ts:73

是否只读

---

isRequired?

optional isRequired: boolean

定义于: packages/core/src/types/components/checkbox.ts:71

是否必填

---

isSelected?

optional isSelected: boolean

定义于: packages/core/src/types/components/checkbox.ts:67

是否选中

---

key

key: string

定义于: packages/core/src/types/components/base.ts:31

唯一标识符

继承自

ComponentProps.key

---

label?

optional label: string

定义于: packages/core/src/types/components/checkbox.ts:48

标签

---

lineThrough?

optional lineThrough: boolean

定义于: packages/core/src/types/components/checkbox.ts:65

是否划线

---

name?

optional name: string

定义于: packages/core/src/types/components/checkbox.ts:50

提交 HTML 表单时使用的 checkbox 元素的名称

---

radius?

optional radius: "none" | "sm" | "md" | "lg" | "full"

定义于: packages/core/src/types/components/checkbox.ts:63

复选框的半径

• none: 无
• sm: 小
• md: 中
• lg: 大
• full: 全

---

size?

optional size: "sm" | "md" | "lg"

定义于: packages/core/src/types/components/checkbox.ts:52

复选框的大小

---

value?

optional value: string

定义于: packages/core/src/types/components/checkbox.ts:46

值