UNPKG

@wix/design-system

Version:

@wix/design-system

www.wixdesignsystem.com

73 lines (69 loc) • 2.41 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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
### dataHook - type: string - description: Applies a data-hook HTML attribute that can be used in tests ### checked - type: boolean - description: Specifies whether a checkbox is selected ### disabled - type: boolean - description: Specifies whether a checkbox is disabled ### required - type: boolean - description: Specifies whether a checkbox is required ### hasError - type: boolean - description: Specifies whether a checkbox has an error ### id - type: string - description: Assigns a unique identifier for the checkbox ### indeterminate - type: boolean - description: Specifies whether a checkbox is in an indeterminate state ### errorMessage - type: string - description: The error message when there's an error ### selectionArea - type: CheckboxSelectionArea - description: Controls the selection area highlight visibility ### vAlign - type: CheckboxVAlign - description: Controls checkbox alignment to the label on the Y axis ### size - type: CheckboxLabelSize - description: Controls the size of the checkbox label ### onChange - type: ChangeEventHandler<HTMLInputElement> - description: Defines a callback function which is called every time the checkbox state is changed ### className - type: string - description: Specifies a CSS class name to be appended to the component’s root element. ### tooltipProps - type: TooltipCommonProps - description: Allows you to pass all common tooltip props. ### tooltipContent - type: ReactNode - description: Defines a message to be displayed in a tooltip. Tooltip is displayed on a checkbox hover. ### selectionAreaSkin - type: CheckboxSelectionAreaSkin - description: Sets the design of the selection area ### selectionAreaPadding - type: Padding<string | number> - description: Sets the amount of white space around the checkbox label in pixels ### children - type: ReactNode - description: Defines a checkbox label ### ellipsis - type: boolean - description: Truncates text that is longer than its parent container and displays ellipsis at the end of the last line. ### maxLines - type: number - description: Truncates label text at a specific number of lines when using ellipsis ### focusableOnFocus - type: React.FocusEventHandler<E> - description: No description ### focusableOnBlur - type: React.FocusEventHandler<E> - description: No description ### ref - type: React.RefObject<E> - description: No description