Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrXCheckboxProps

Hierarchy

Hierarchy

  • IIgrXCheckboxProps

Properties

Properties

Optional actualBorderWidth

actualBorderWidth?: string | number

Gets or sets the Width to use for the check mark when the checkbox is checked.

Optional actualCheckedBackgroundColor

actualCheckedBackgroundColor?: string

Gets or sets the color to use for the actual background when the checkbox is checked.

Optional actualCheckedBorderColor

actualCheckedBorderColor?: string

Gets or sets the color to use for the check mark when the checkbox is checked.

Optional actualCornerRadius

actualCornerRadius?: string | number

Gets the actual corner radius to use for the checkbox.

Optional actualTickColor

actualTickColor?: string

Gets or sets the color to use for the check mark when the checkbox is checked.

Optional actualTickStrokeWidth

actualTickStrokeWidth?: string | number

Gets or sets the stroke width to use for the check mark.

Optional actualUncheckedBackgroundColor

actualUncheckedBackgroundColor?: string

Gets or sets the color to use for the actual background when the checkbox is unchecked.

Optional actualUncheckedBorderColor

actualUncheckedBorderColor?: string

Gets or sets the color to use for the check mark when the checkbox is checked.

Optional ariaLabel

ariaLabel?: string

Gets or sets the value of the aria-label attribute.

Optional ariaLabelledBy

ariaLabelledBy?: string

Gets or sets the value of the aria-labelledby attribute.

Optional baseTheme

baseTheme?: string | BaseControlTheme

Gets or sets the base built in theme to use for the checkbox.

Optional borderWidth

borderWidth?: string | number

Gets or sets the Width to use for the check mark when the checkbox is checked.

Optional change

change?: ((s, e) => void)

Type declaration

Optional checked

checked?: string | boolean

Gets or sets whether the checkbox is checked.

Optional checkedBackgroundColor

checkedBackgroundColor?: string

Gets or sets the color to use for the background when the checkbox is checked.

Optional checkedBorderColor

checkedBorderColor?: string

Gets or sets the color to use for the check mark when the checkbox is checked.

Optional children

children?: ReactNode

Optional cornerRadius

cornerRadius?: string | number

Gets or sets the corner radius to use for the checkbox.

Optional disableRipple

disableRipple?: string | boolean

Gets or sets whether to disable the ripple effect for the checkbox.

Optional disableTransitions

disableTransitions?: string | boolean

Gets or sets whether the checkbox transitions are disabled.

Optional disabled

disabled?: string | boolean

Gets or sets whether the checkbox is disabled.

Optional focused

focused?: string | boolean

Gets or sets if the checkbox is Focused.

Optional id

id?: string

Gets or sets the id to use for the checkbox.

Optional indeterminate

indeterminate?: string | boolean

Gets or sets whether the checkbox is indeterminate.

Optional inputId

inputId?: string

Gets or sets the id to use for the internal native checkbox.

Optional labelId

labelId?: string

Gets or sets id to use for the checkbox label.

Optional labelPosition

labelPosition?: string | CheckboxLabelPosition

Gets or sets LabelPosition to use for the checkbox.

Optional name

name?: string

Gets or sets name to use for the checkbox.

Optional required

required?: string | number

Gets or sets if the checkbox is required.

Optional tabIndex

tabIndex?: string | number

Gets or sets TabIndex to use for the checkbox.

Optional tickColor

tickColor?: string

Gets or sets the color to use for the check mark when the checkbox is checked.

Optional tickStrokeWidth

tickStrokeWidth?: string | number

Gets or sets the corner radius to use for the checkbox.

Optional uncheckedBackgroundColor

uncheckedBackgroundColor?: string

Gets or sets the color to use for the background when the checkbox is unchecked.

Optional uncheckedBorderColor

uncheckedBorderColor?: string

Gets or sets the color to use for the check mark when the checkbox is unchecked.

Optional value

value?: any

Gets or sets value to use for the checkbox.