CheckboxField

Checkboxes allow the user to select one or more items from a collection.

View source code
  • isChecked
    boolean

    Whether the checkbox is checked.

  • label
    ReactNode

    Content to display in the label.

  • onChange
    ChangeEventHandler<HTMLInputElement>

    Handler that is called when the value changes.

  • className
    string

    className for the element.

  • fit
    "content" | "parent"

    Whether the CheckboxField should fit its parent or content.

    Default: content
  • id
    string

    The id of the CheckboxField.

  • isDisabled
    boolean

    Whether the CheckboxField is disabled.

  • isIndeterminate
    boolean

    Whether the checkbox is indeterminate.

  • name
    string

    The name of the CheckboxField, used when submitting an HTML form.

    Default:
  • value
    string

    The current value (controlled).