Checkbox

CheckboxElementProps

• accessibilityLabel

  A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.

  string

• checked

  Whether the control is active.

  boolean

• command

  Sets the action the `commandFor` should take when this clickable is activated. See the documentation of particular components for the actions they support. - `--auto`: a default action for the target component. - `--show`: shows the target component. - `--hide`: hides the target component. - `--toggle`: toggles the target component. - `--copy`: copies the target ClipboardItem.

  '--auto' | '--show' | '--hide' | '--toggle'

• commandFor

  ID of a component that should respond to activations (e.g. clicks) on this component. See `command` for how to control the behavior of the target.

  string

• defaultChecked

  Whether the control is active by default.

  boolean

• disabled

  Disables the control, disallowing any interaction.

  boolean

• error

  Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.

  string

• id

  A unique identifier for the element.

  string

• label

  Visual content to use as the control label.

  string

• name

  An identifier for the control that is unique within the nearest containing `Form` component.

  string

• required

  Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.

  boolean

• value

  The value used in form data when the control is checked.

  string

export interface CheckboxElementProps extends Pick<CheckboxProps$1, 'accessibilityLabel' | 'checked' | 'command' | 'commandFor' | 'defaultChecked' | 'disabled' | 'error' | 'id' | 'label' | 'name' | 'required' | 'value'> {
    command?: Extract<CheckboxProps$1['command'], '--auto' | '--show' | '--hide' | '--toggle'>;
}

CheckboxElementEvents

• change

  A callback that is run whenever the control is changed.

  ((event: CallbackEventListener<typeof tagName>) => void) | null

export interface CheckboxElementEvents {
    /**
     * A callback that is run whenever the control is changed.
     */
    change?: ((event: CallbackEventListener<typeof tagName>) => void) | null;
}

CallbackEventListener

(EventListener & {
    (event: CallbackEvent<TTagName, TEvent>): void;
}) | null

CallbackEvent

TEvent & {
    currentTarget: HTMLElementTagNameMap[TTagName];
}