UNPKG

zent

Version:

一套前端设计语言和基于React的实现

43 lines (32 loc) • 3.14 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
--- title: Checkbox path: component/checkbox group: Basics --- ## Checkbox ### Guides - Checkbox is a [controlled component][https://facebook.github.io/react/docs/forms.html#controlled-components]. You need to set the callback function `onChange` outside the component to handle the changes of `value`. - `value` supports any type of value, inclueding Referrence Type. ### API #### Checkbox API | Property | Description | Type | Default | Alternative | | ------------- | -------------------------------------------------------------------- | --------------------- | ------- | ----------- | | checked | Whether the checkbox is selected | `boolean` | `false` | | value | The value of the components, which is used in `CheckboxGroup` | `any` | | | disabled | Disable the checkbox | `boolean` | | | readOnly | It specifies the component is read-only | `boolean` | | | indeterminate | Show style of partially selection | `boolean` | `false` | | onChange | The callback function that is triggered when the checkbox is changed | `(e:Event) => void` | | | labelStyle | Label inline style | `React.CSSProperties` | | | style | Inline style | `React.CSSProperties` | | | className | The custom class name | `string` | | #### Checkbox Group API | Property | Description | Type | Default | Alternative | | ------------ | -------------------------------------------------------------------------- | ----------------------------------- | --------------- | ----------- | | value | The value when checkbox is checked, which is required | `any[]` | `[]` | | isValueEqual | The function to judge whether the value is equal | `(a: any, b: any) => boolean` | `() => a === b` | | disabled | Disable the checkbox group | `boolean` | | | readOnly | It specifies the component is read-only | `boolean` | | | onChange | The callback function that is triggered when the checkbox group is changed | `(checkedValueList: any[]) => void` | | | className | The custom class name | `string` | | [controlled-components]: https://facebook.github.io/react/docs/forms.html#controlled-components