@wix/design-system
Version:
@wix/design-system
74 lines (71 loc) • 2.4 kB
Markdown
### 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
- deprecated
### selectionArea
- type: "none" | "hover" | "always"
- description: Controls the selection area highlight visibility
### vAlign
- type: "center" | "top"
- description: Controls checkbox alignment to the label on the Y axis
### size
- type: "small" | "medium"
- description: Controls the size of the checkbox label
### onChange
- type: ChangeEventHandler
- 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.
- internal
### 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: "filled" | "outlined"
- description: Sets the design of the selection area
### selectionAreaPadding
- type: string | number | string & {}
- 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
### onFocus
- type: (event: FocusEvent, triggers: Triggers) => void
- description: No description
### onBlur
- type: (event: FocusEvent, triggers: Triggers) => void
- description: No description
### ref
- type: RefObject
- description: No description