Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrXButtonProps

Hierarchy

Hierarchy

  • IIgrXButtonProps

Properties

Properties

Optional actualAmbientShadowColor

actualAmbientShadowColor?: string

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

Optional actualBackgroundColor

actualBackgroundColor?: string

Gets the color to use for the actual background.

Optional actualBorderColor

actualBorderColor?: string

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

Optional actualBorderWidth

actualBorderWidth?: string | number

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

Optional actualCornerRadiusBottomLeft

actualCornerRadiusBottomLeft?: string | number

Optional actualCornerRadiusBottomRight

actualCornerRadiusBottomRight?: string | number

Optional actualCornerRadiusTopLeft

actualCornerRadiusTopLeft?: string | number

Optional actualCornerRadiusTopRight

actualCornerRadiusTopRight?: string | number

Optional actualDensity

actualDensity?: string | ControlDisplayDensity

Gets the actual display density to use for the label.

Optional actualDisableRipple

actualDisableRipple?: string | boolean

Gets whether to actually disable the ripple effect for the button.

Optional actualDisabledBackgroundColor

actualDisabledBackgroundColor?: string

Gets the actual color to use for the disabled background of the button.

Optional actualDisabledBorderColor

actualDisabledBorderColor?: string

Gets the actual color to use for the disabled border of the button.

Optional actualDisabledElevation

actualDisabledElevation?: string | number

Gets the actual disabled elevation to use for the button.

Optional actualDisabledTextColor

actualDisabledTextColor?: string

Gets the actual color to use for the disabled text of the button.

Optional actualElevationMode

actualElevationMode?: string | ElevationMode

Gets the actual disabled elevation to use for the button.

Optional actualFocusBackgroundColor

actualFocusBackgroundColor?: string

Gets the color to use for the actual background.

Optional actualFocusElevation

actualFocusElevation?: string | number

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

Optional actualFocusTextColor

actualFocusTextColor?: string

Gets the actual color to use for the focused text.

Optional actualHoverBackgroundColor

actualHoverBackgroundColor?: string

Gets the hover color to use for the actual background.

Optional actualHoverElevation

actualHoverElevation?: string | number

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

Optional actualHoverTextColor

actualHoverTextColor?: string

Gets the color to use for the actual background.

Optional actualPenumbraShadowColor

actualPenumbraShadowColor?: string

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

Optional actualRestingElevation

actualRestingElevation?: string | number

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

Optional actualRippleColor

actualRippleColor?: string

Gets or sets the color to use for the ripple when the button is pressed.

Optional actualTextColor

actualTextColor?: string

Gets the color to use for the actual background.

Optional actualUmbraShadowColor

actualUmbraShadowColor?: string

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

Optional alignItems

alignItems?: string

Gets or sets the id to use for the checkbox.

Optional ariaLabel

ariaLabel?: string

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

Optional backgroundColor

backgroundColor?: string

Gets or sets the color to use for the background when the button regardless of type.

Optional baseTheme

baseTheme?: string | BaseControlTheme

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

Optional borderColor

borderColor?: string

Gets or sets the border color to use for the button regardless of type.

Optional borderWidth

borderWidth?: string | number

Gets or sets the width to use for the button border regardless of type.

Optional children

children?: ReactNode

Optional clickTunneling

clickTunneling?: string | boolean

Gets or sets if clicking on the button is allowed to tunnel down to button content.

Optional clicked

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

Type declaration

Optional contentPaddingBottom

contentPaddingBottom?: string | number

Gets or sets the bottom padding for the button content.

Optional contentPaddingLeft

contentPaddingLeft?: string | number

Gets or sets the left padding for the button content.

Optional contentPaddingRight

contentPaddingRight?: string | number

Gets or sets the right padding for the button content.

Optional contentPaddingTop

contentPaddingTop?: string | number

Gets or sets the top padding for the button content.

Optional cornerRadiusBottomLeft

cornerRadiusBottomLeft?: string | number

Optional cornerRadiusBottomRight

cornerRadiusBottomRight?: string | number

Optional cornerRadiusTopLeft

cornerRadiusTopLeft?: string | number

Optional cornerRadiusTopRight

cornerRadiusTopRight?: string | number

Optional density

density?: string | ControlDisplayDensity

Gets or sets the display density to use for the button.

Optional disableHover

disableHover?: string | boolean

Gets or sets whether the hover effect is disabled.

Optional disablePointer

disablePointer?: string | boolean

Gets or sets whether the cursor will change into a pointer when the button is hovered.

Optional disableRipple

disableRipple?: string | boolean

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

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 disabledBackgroundColor

disabledBackgroundColor?: string

Gets or sets the color to use for the disabled background of the button when the type is disabled.

Optional disabledBorderColor

disabledBorderColor?: string

Gets or sets the color to use for the disabled border of the button when the type is raised.

Optional disabledElevation

disabledElevation?: string | number

Gets or sets the disabled elevation to use for the button when the type is raised.

Optional disabledTextColor

disabledTextColor?: string

Gets or sets the color to use for the disabled text of the button when the type is raised.

Optional display

display?: string

Gets or sets the id to use for the checkbox.

Optional displayType

displayType?: string | ButtonDisplayStyle

Gets or sets the display style to use for the button.

Optional elevationMode

elevationMode?: string | ElevationMode

Gets or sets the disabled elevation to use for the button when the type is raised.

Optional fabBackgroundColor

fabBackgroundColor?: string

Gets or sets the color to use for the background of the button when the type is floating action button.

Optional fabBorderColor

fabBorderColor?: string

Gets or sets the border color to use for the button when the type is floating action button.

Optional fabBorderWidth

fabBorderWidth?: string | number

Gets or sets the width to use for the button border when the type is floating action button.

Optional fabCornerRadiusBottomLeft

fabCornerRadiusBottomLeft?: string | number

Optional fabCornerRadiusBottomRight

fabCornerRadiusBottomRight?: string | number

Optional fabCornerRadiusTopLeft

fabCornerRadiusTopLeft?: string | number

Optional fabCornerRadiusTopRight

fabCornerRadiusTopRight?: string | number

Optional fabDisabledBackgroundColor

fabDisabledBackgroundColor?: string

Gets or sets the color to use for the disabled background of the button when the type is fab.

Optional fabDisabledBorderColor

fabDisabledBorderColor?: string

Gets or sets the color to use for the disabled border of the button when the type is fab.

Optional fabDisabledElevation

fabDisabledElevation?: string | number

Gets or sets the disabled elevation to use for the button when the type is fab.

Optional fabDisabledTextColor

fabDisabledTextColor?: string

Gets or sets the color to use for the disabled text of the button when the type is fab.

Optional fabFocusBackgroundColor

fabFocusBackgroundColor?: string

Gets or sets the color to use for the backround the button when it is focused and fab.

Optional fabFocusElevation

fabFocusElevation?: string | number

Gets or sets the focus elevation to use for the button when the type is floating action button.

Optional fabFocusTextColor

fabFocusTextColor?: string

Gets or sets the color to use for the text the button when it is focused and fab.

Optional fabHoverBackgroundColor

fabHoverBackgroundColor?: string

Gets or sets the hover color to use for the background of the button when the type is hoveredFab.

Optional fabHoverElevation

fabHoverElevation?: string | number

Gets or sets the hover elevation to use for the button when the type is floating action button.

Optional fabHoverTextColor

fabHoverTextColor?: string

Gets or sets the color to use for the hovered text of the button when type is floating action button.

Optional fabRestingElevation

fabRestingElevation?: string | number

Gets or sets the elevation to use for the button when the type is floating action button.

Optional fabRippleColor

fabRippleColor?: string

Gets or sets the color to use for the background when the button is pressed and the type is floating action button.

Optional fabTextColor

fabTextColor?: string

Gets or sets the color to use for the text of the button when type is floating action button.

Optional fillAvailableSpace

fillAvailableSpace?: string | boolean

Gets or sets whether the button should fill the available space. If false, the button will use an intrinsic size.

Optional flatBackgroundColor

flatBackgroundColor?: string

Gets or sets the color to use for the background of the button when the type is flat.

Optional flatBorderColor

flatBorderColor?: string

Gets or sets the border color to use for the button when the type is flat.

Optional flatBorderWidth

flatBorderWidth?: string | number

Gets or sets the width to use for the button border when the type is flat.

Optional flatCornerRadiusBottomLeft

flatCornerRadiusBottomLeft?: string | number

Optional flatCornerRadiusBottomRight

flatCornerRadiusBottomRight?: string | number

Optional flatCornerRadiusTopLeft

flatCornerRadiusTopLeft?: string | number

Optional flatCornerRadiusTopRight

flatCornerRadiusTopRight?: string | number

Optional flatDisabledBackgroundColor

flatDisabledBackgroundColor?: string

Gets or sets the color to use for the disabled background of the button when the type is flat.

Optional flatDisabledBorderColor

flatDisabledBorderColor?: string

Gets or sets the color to use for the disabled border of the button when the type is flat.

Optional flatDisabledElevation

flatDisabledElevation?: string | number

Gets or sets the disabled elevation to use for the button when the type is flat.

Optional flatDisabledTextColor

flatDisabledTextColor?: string

Gets or sets the color to use for the disabled text of the button when the type is flat.

Optional flatFocusBackgroundColor

flatFocusBackgroundColor?: string

Gets or sets the color to use for the backround the button when it is focused and flat.

Optional flatFocusElevation

flatFocusElevation?: string | number

Gets or sets the focus elevation to use for the button when the type is flat.

Optional flatFocusTextColor

flatFocusTextColor?: string

Gets or sets the color to use for the text the button when it is focused and flat.

Optional flatHoverBackgroundColor

flatHoverBackgroundColor?: string

Gets or sets the hover color to use for the background of the button when the type is flat.

Optional flatHoverElevation

flatHoverElevation?: string | number

Gets or sets the hover elevation to use for the button when the type is flat.

Optional flatHoverTextColor

flatHoverTextColor?: string

Gets or sets the color to use for the hovered text of the button when type is flat.

Optional flatRestingElevation

flatRestingElevation?: string | number

Gets or sets the elevation to use for the button when the type is flat.

Optional flatRippleColor

flatRippleColor?: string

Gets or sets the color to use for the background when the button is pressed and the type is floating action button.

Optional flatTextColor

flatTextColor?: string

Gets or sets the color to use for the text of the button when type is flat.

Optional flexDirection

flexDirection?: string

Gets or sets the id to use for the checkbox.

Optional flexGrow

flexGrow?: string

Gets or sets the flex-grow setting for the button.

Optional focusBackgroundColor

focusBackgroundColor?: string

Gets or sets the color to use for the backround the button when it is focused.

Optional focusElevation

focusElevation?: string | number

Gets or sets the focus elevation to use for the button regardless of type.

Optional focusTextColor

focusTextColor?: string

Gets or sets the color to use for the text of the button when it is focused.

Optional focused

focused?: string | boolean

Gets or sets if the checkbox is Focused.

Optional gotFocus

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

Type declaration

    • (s, e): void

    • Parameters

      Returns void

Optional horizontalContentAlignment

horizontalContentAlignment?: string | HorizontalAlignment

Optional hoverBackgroundColor

hoverBackgroundColor?: string

Gets or sets the hover color to use for the background of the button when the type is hovered.

Optional hoverElevation

hoverElevation?: string | number

Gets or sets the hover elevation to use for the button regardless of type.

Optional hoverTextColor

hoverTextColor?: string

Gets or sets the color to use for the hovered text of the button regardless of type.

Optional iconBackgroundColor

iconBackgroundColor?: string

Gets or sets the color to use for the background of the button when the type is icon.

Optional iconBorderColor

iconBorderColor?: string

Gets or sets the border color to use for the button when the type is icon.

Optional iconBorderWidth

iconBorderWidth?: string | number

Gets or sets the width to use for the button border when the type is icon.

Optional iconCornerRadiusBottomLeft

iconCornerRadiusBottomLeft?: string | number

Optional iconCornerRadiusBottomRight

iconCornerRadiusBottomRight?: string | number

Optional iconCornerRadiusTopLeft

iconCornerRadiusTopLeft?: string | number

Optional iconCornerRadiusTopRight

iconCornerRadiusTopRight?: string | number

Optional iconDisabledBackgroundColor

iconDisabledBackgroundColor?: string

Gets or sets the color to use for the disabled background of the button when the type is icon.

Optional iconDisabledBorderColor

iconDisabledBorderColor?: string

Gets or sets the color to use for the disabled border of the button when the type is icon.

Optional iconDisabledElevation

iconDisabledElevation?: string | number

Gets or sets the disabled elevation to use for the button when the type is icon.

Optional iconDisabledTextColor

iconDisabledTextColor?: string

Gets or sets the color to use for the disabled text of the button when the type is icon.

Optional iconFocusBackgroundColor

iconFocusBackgroundColor?: string

Gets or sets the color to use for the backround the button when it is focused and icon.

Optional iconFocusElevation

iconFocusElevation?: string | number

Gets or sets the focus elevation to use for the button when the type is icon.

Optional iconFocusTextColor

iconFocusTextColor?: string

Gets or sets the color to use for the text the button when it is focused and icon.

Optional iconHoverBackgroundColor

iconHoverBackgroundColor?: string

Gets or sets the hover color to use for the background of the button when the type is hoveredIcon.

Optional iconHoverElevation

iconHoverElevation?: string | number

Gets or sets the hover elevation to use for the button when the type is icon.

Optional iconHoverTextColor

iconHoverTextColor?: string

Gets or sets the color to use for the hovered text of the button when type is icon.

Optional iconRestingElevation

iconRestingElevation?: string | number

Gets or sets the elevation to use for the button when the type is icon.

Optional iconRippleColor

iconRippleColor?: string

Gets or sets the color to use for the background when the button is pressed and the type is floating action button.

Optional iconTextColor

iconTextColor?: string

Gets or sets the color to use for the text of the button when type is icon.

Optional id

id?: string

Gets or sets the id to use for the checkbox.

Optional inputId

inputId?: string

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

Optional isFocusStyleEnabled

isFocusStyleEnabled?: string | boolean

Gets or sets if the button show use styling to show focus.

Optional isHover

isHover?: string | boolean

Gets or sets whether the checkbox is checked.

Optional lostFocus

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

Type declaration

    • (s, e): void

    • Parameters

      Returns void

Optional minHeight

minHeight?: string | number

Gets or sets the min height to use for the button.

Optional minWidth

minWidth?: string | number

Gets or sets the min width to use for the button.

Optional name

name?: string

Gets or sets name to use for the button.

Optional outlinedBackgroundColor

outlinedBackgroundColor?: string

Gets or sets the color to use for the background of the button when the type is outlined.

Optional outlinedBorderColor

outlinedBorderColor?: string

Gets or sets the border color to use for the button when the type is outlined.

Optional outlinedBorderWidth

outlinedBorderWidth?: string | number

Gets or sets the width to use for the button border when the type is outlined.

Optional outlinedCornerRadiusBottomLeft

outlinedCornerRadiusBottomLeft?: string | number

Optional outlinedCornerRadiusBottomRight

outlinedCornerRadiusBottomRight?: string | number

Optional outlinedCornerRadiusTopLeft

outlinedCornerRadiusTopLeft?: string | number

Optional outlinedCornerRadiusTopRight

outlinedCornerRadiusTopRight?: string | number

Optional outlinedDisabledBackgroundColor

outlinedDisabledBackgroundColor?: string

Gets or sets the color to use for the disabled background of the button when the type is outlined.

Optional outlinedDisabledBorderColor

outlinedDisabledBorderColor?: string

Gets or sets the color to use for the disabled border of the button when the type is outlined.

Optional outlinedDisabledElevation

outlinedDisabledElevation?: string | number

Gets or sets the disabled elevation to use for the button when the type is outlined.

Optional outlinedDisabledTextColor

outlinedDisabledTextColor?: string

Gets or sets the color to use for the disabled text of the button when the type is outlined.

Optional outlinedFocusBackgroundColor

outlinedFocusBackgroundColor?: string

Gets or sets the color to use for the backround the button when it is focused and outlined.

Optional outlinedFocusElevation

outlinedFocusElevation?: string | number

Gets or sets the focus elevation to use for the button when the type is outlined.

Optional outlinedFocusTextColor

outlinedFocusTextColor?: string

Gets or sets the color to use for the text the button when it is focused and outlined.

Optional outlinedHoverBackgroundColor

outlinedHoverBackgroundColor?: string

Gets or sets the hover color to use for the background of the button when the type is hoveredOutlined.

Optional outlinedHoverElevation

outlinedHoverElevation?: string | number

Gets or sets the hover elevation to use for the button when the type is outlined.

Optional outlinedHoverTextColor

outlinedHoverTextColor?: string

Gets or sets the color to use for the hovered text of the button when type is outlined.

Optional outlinedRestingElevation

outlinedRestingElevation?: string | number

Gets or sets the elevation to use for the button when the type is outlined.

Optional outlinedRippleColor

outlinedRippleColor?: string

Gets or sets the color to use for the background when the button is pressed and the type is floating action button.

Optional outlinedTextColor

outlinedTextColor?: string

Gets or sets the color to use for the text of the button when type is outlined.

Optional raisedBackgroundColor

raisedBackgroundColor?: string

Gets or sets the color to use for the background of the button when the type is raised.

Optional raisedBorderColor

raisedBorderColor?: string

Gets or sets the border color to use for the button when the type is raised.

Optional raisedBorderWidth

raisedBorderWidth?: string | number

Gets or sets the width to use for the button border when the type is raised.

Optional raisedCornerRadiusBottomLeft

raisedCornerRadiusBottomLeft?: string | number

Optional raisedCornerRadiusBottomRight

raisedCornerRadiusBottomRight?: string | number

Optional raisedCornerRadiusTopLeft

raisedCornerRadiusTopLeft?: string | number

Optional raisedCornerRadiusTopRight

raisedCornerRadiusTopRight?: string | number

Optional raisedDisabledBackgroundColor

raisedDisabledBackgroundColor?: string

Gets or sets the color to use for the disabled background of the button when the type is raised.

Optional raisedDisabledBorderColor

raisedDisabledBorderColor?: string

Gets or sets the color to use for the disabled border of the button when the type is raised.

Optional raisedDisabledElevation

raisedDisabledElevation?: string | number

Gets or sets the disabled elevation to use for the button when the type is raised.

Optional raisedDisabledTextColor

raisedDisabledTextColor?: string

Gets or sets the color to use for the disabled text of the button when the type is raised.

Optional raisedFocusBackgroundColor

raisedFocusBackgroundColor?: string

Gets or sets the color to use for the backround the button when it is focused and raised.

Optional raisedFocusElevation

raisedFocusElevation?: string | number

Gets or sets the focus elevation to use for the button when the type is raised.

Optional raisedFocusTextColor

raisedFocusTextColor?: string

Gets or sets the color to use for the text the button when it is focused and raised.

Optional raisedHoverBackgroundColor

raisedHoverBackgroundColor?: string

Gets or sets the hover color to use for the background of the button when the type is raised.

Optional raisedHoverElevation

raisedHoverElevation?: string | number

Gets or sets the hover elevation to use for the button when the type is raised.

Optional raisedHoverTextColor

raisedHoverTextColor?: string

Gets or sets the color to use for the hovered text of the button when type is raised.

Optional raisedRestingElevation

raisedRestingElevation?: string | number

Gets or sets the elevation to use for the button when the type is raised.

Optional raisedRippleColor

raisedRippleColor?: string

Gets or sets the color to use for the background when the button is pressed and the type is floating action button.

Optional raisedTextColor

raisedTextColor?: string

Gets or sets the color to use for the text of the button when type is raised.

Optional restingElevation

restingElevation?: string | number

Gets or sets the elevation to use for the button regardless of type.

Optional rippleColor

rippleColor?: string

Gets or sets the color to use for the background of the button regardless of type.

Optional stopPropagation

stopPropagation?: string | boolean

Gets or sets whether mouse events on the button will bubble up to parent elements.

Optional tabIndex

tabIndex?: string | number

Gets or sets TabIndex to use for the checkbox.

Optional textColor

textColor?: string

Gets or sets the color to use for the text of the button regardless of type.

Optional textStyle

textStyle?: string

Gets or sets the use for the button.

Optional value

value?: any

Gets or sets value to use for the checkbox.

Optional verticalContentAlignment

verticalContentAlignment?: string | VerticalAlignment