Class CheckBox

packages/main/src/CheckBox.ts:90–496

* @class * * ### Overview * * 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-c

 * @csspart icon - Used to style the icon of the `ui5-checkbox`
 */
@customElement({
	tag: "ui5-checkbox",
	languageAware: true,
	formAssociated: true,
	renderer: jsxRenderer,
	template: CheckBoxTemplate,
	styles: checkboxCss,
})
/**
 * Fired when the component checked state changes.
 * @public
 */
@event("change", {
	bubbles: true,
	cancelable: true,
})
/**
 * Fired to make Angular two way data binding work properly.
 * @private
 */
@event("value-changed", {
	bubbles: true,
	cancelable: true,
})
class CheckBox extends UI5Element implements IFormInputElement {
	eventDetails!: {
		"change": void,
		"value-changed": void,
	};

	/**
	 * Receives id(or many ids) of the elements that label the component
	 * @default undefined
	 * @public
	 * @since 1.1.0
	 */
	@property()
	accessibleNameRef?: string;

	/**
	 * Defines the accessible ARIA name of the component.
	 * @public
	 * @default undefined
	 * @since 1.1.0
	 */
	@property()
	accessibleName?: string;

	/**
	 * Defines whether the component is disabled.
	 *
	 * **Note:** A disabled component is completely noninteractive.
	 * @default false
	 * @public
	 */
	@property({ type: Boolean })
	disabled = false;