Interface CheckboxProps

Hierarchy

Properties

autoFocus? className? confirmationConfig? confirmationMode? disabled? error? id? inlineMode? label? name onBlur? onChange? onFocus? tooltipContent? value?

Properties

Optional autoFocus

autoFocus?: boolean

Whether or not the control should start focused (default: false)

Optional className

className?: string

CSS Class name for additional styles

Optional confirmationConfig

confirmationConfig?: ConfirmationConfig

Optional text overrides for the confirmation pop up.

Optional confirmationMode

confirmationMode?: "None" | "Advanced"

If set to 'Advanced', action will require confirmation via a confirmation pop up. (default: 'None')

Optional disabled

disabled?: boolean

Whether or not the control is disabled (default: false)

Optional error

error?: string

If set, indicates the control has an error and will display this prop as the error message

Optional id

id?: string

Form control id

Optional inlineMode

inlineMode?: boolean

Hide options not needed in the “inline” scenario

Optional label

label?: string

Form control label

name

name: string

Name of form control, required and must be unique from other form control names. This name should match the the name of the object corresponding to this control.

Optional onBlur

onBlur?: ((event) => void)

Type declaration

    • (event): void

    • Raised when the element has been selected

      Parameters

      • event: ChangeEvent<HTMLInputElement>

      Returns void

Optional onChange

onChange?: ((value) => void)

Type declaration

    • (value): void

    • Parameters

      • value: boolean

      Returns void

Optional onFocus

onFocus?: ((event) => void)

Type declaration

    • (event): void

    • Raised when the element has been de-selected

      Parameters

      • event: ChangeEvent<HTMLInputElement>

      Returns void

Optional tooltipContent

tooltipContent?: ReactNode

A tooltip of additional information

Optional value

value?: boolean

Current value the form control has

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc