@synerise/ds-checkbox v1.0.10
id: checkbox
title: Checkbox
Checkbox UI Component
Checkbox component
Based on Ant Design Checkbox
API
Property | Description | Type | Default |
---|---|---|---|
autoFocus | Get focus when component mounted | boolean | false |
checked | Specifies whether the checkbox is selected. | boolean | false |
defaultChecked | Specifies the initial state: whether or not the checkbox is selected. | boolean | false |
description | Checkbox description | string | - |
disabled | Disable checkbox | boolean | false |
errorText | Error message, if provided sets error state on checkbox | string | - |
hasError | Determines if checkbox is in error state | boolean | false |
indeterminate | Indeterminate checked state of checkbox | boolean | false |
onChange | The callback function that is triggered when the state changes. | (e:Event)=>void | - |
withoutPadding | Reset padding of CheckboxWrapper | boolean | false |
Checkbox Group
Property | Description | Type | Default |
---|---|---|---|
defaultValue | Default selected value | string / number / boolean /string[] / number[] / boolean[] | [] |
disabled | Disable all checkboxes | boolean | false |
name | The name property of all input[type="checkbox"] children | string | - |
options | Specifies options | string / number / boolean /string[] / number[] / boolean[] | [] |
value | Used for setting the currently selected value. | string / number / boolean /string[] / number[] / boolean[] | [] |
onChange | The callback function that is triggered when the state changes. | (value: string / number / boolean) => void | - |
Methods
Checkbox
Name | Description |
---|---|
blur() | remove focus |
focus() | get focus |
7 months ago
7 months ago
7 months ago
5 months ago
5 months ago
6 months ago
6 months ago
6 months ago
7 months ago
7 months ago
5 months ago
7 months ago
8 months ago
8 months ago
8 months ago
8 months ago
9 months ago
8 months ago
8 months ago
9 months ago
9 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
10 months ago
12 months ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago