Allows the user to set a binary value, such as true/false or yes/no for an item.
The ui5-checkbox component consists of a box and a label that describes its purpose.
If it's checked, an indicator is displayed inside the box.
To check/uncheck the ui5-checkbox, the user has to click or tap the square
box or its label.
The ui5-checkbox component only has 2 states - checked and unchecked.
Clicking or tapping toggles the ui5-checkbox between checked and unchecked state.
You can define the checkbox text with via the text property. If the text exceeds the available width, it is truncated by default.
In case you prefer text to truncate, set the wrappingType property to "None".
The touchable area for toggling the ui5-checkbox ends where the text ends.
You can disable the ui5-checkbox by setting the disabled property to
true,
or use the ui5-checkbox in read-only mode by setting the readonly
property to true.
Determines whether the ui5-checkbox is in display only state. When set to true, the ui5-checkbox is not interactive, not editable, not focusable and not in the tab chain. This setting is used for forms in review mode. Note: When the property disabled is set to true this property has no effect.
Defines whether the component is required. Note: We advise against using the text property of the checkbox when there is a label associated with it to avoid having two required asterisks.
Defines whether the component is displayed as partially checked. Note: The indeterminate state can be set only programmatically and can’t be achieved by user interaction and the resulting visual state depends on the values of the indeterminate and checked properties: - If the component is checked and indeterminate, it will be displayed as partially checked - If the component is checked and it is not indeterminate, it will be displayed as checked - If the component is not checked, it will be displayed as not checked regardless value of the indeterminate attribute
Defines if the component is checked. Note: The property can be changed with user interaction, either by cliking/tapping on the component, or by pressing the Enter or Space key.
Defines whether the component text wraps when there is not enough space. Note: for option "Normal" the text will wrap and the words will not be broken based on hyphenation. Note: for option "None" the text will be truncated with an ellipsis.
Determines the name by which the component will be identified upon submission in an HTML form. Note: This property is only applicable within the context of an HTML Form element.
Defines the form value of the component that is submitted when the checkbox is checked. When a form containing ui5-checkbox elements is submitted, only the values of the checked checkboxes are included in the form data sent to the server. Unchecked checkboxes do not contribute any data to the form submission. This property is particularly useful for checkbox groups, where multiple checkboxes with the same name but different value properties can be used to represent a set of related options.
Checkboxes can be logically grouped using the same name attribute to create a multi-selection form field. When the form is submitted, each checked item will send its individual value to the server, allowing backend processing to identify exactly which options the user selected.