Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrXButton

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    Returns IgrXButton

Properties

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>

See

https://reactjs.org/docs/context.html

Readonly props

props: Readonly<IIgrXButtonProps> & Readonly<{
    children?: ReactNode;
}>

refs

refs: {
    [key: string]: ReactInstance;
}

Deprecated

https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<{}>

Static Optional contextType

contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}

See

https://reactjs.org/docs/context.html#classcontexttype

Accessors

actualAmbientShadowColor

  • get actualAmbientShadowColor(): string

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

    Returns string

  • set actualAmbientShadowColor(v): void

  • Parameters

    • v: string

    Returns void

actualBackgroundColor

  • get actualBackgroundColor(): string

  • Gets the color to use for the actual background.

    Returns string

  • set actualBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

actualBorderColor

  • get actualBorderColor(): string

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

    Returns string

  • set actualBorderColor(v): void

  • Parameters

    • v: string

    Returns void

actualBorderWidth

  • get actualBorderWidth(): number

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

    Returns number

  • set actualBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

actualCornerRadiusBottomLeft

  • get actualCornerRadiusBottomLeft(): number

  • Returns number

  • set actualCornerRadiusBottomLeft(v): void

  • Parameters

    • v: number

    Returns void

actualCornerRadiusBottomRight

  • get actualCornerRadiusBottomRight(): number

  • Returns number

  • set actualCornerRadiusBottomRight(v): void

  • Parameters

    • v: number

    Returns void

actualCornerRadiusTopLeft

  • get actualCornerRadiusTopLeft(): number

  • Returns number

  • set actualCornerRadiusTopLeft(v): void

  • Parameters

    • v: number

    Returns void

actualCornerRadiusTopRight

  • get actualCornerRadiusTopRight(): number

  • Returns number

  • set actualCornerRadiusTopRight(v): void

  • Parameters

    • v: number

    Returns void

actualDensity

  • get actualDensity(): ControlDisplayDensity

  • Gets the actual display density to use for the label.

    Returns ControlDisplayDensity

  • set actualDensity(v): void

  • Parameters

    • v: ControlDisplayDensity

    Returns void

actualDisableRipple

  • get actualDisableRipple(): boolean

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

    Returns boolean

  • set actualDisableRipple(v): void

  • Parameters

    • v: boolean

    Returns void

actualDisabledBackgroundColor

  • get actualDisabledBackgroundColor(): string

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

    Returns string

  • set actualDisabledBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

actualDisabledBorderColor

  • get actualDisabledBorderColor(): string

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

    Returns string

  • set actualDisabledBorderColor(v): void

  • Parameters

    • v: string

    Returns void

actualDisabledElevation

  • get actualDisabledElevation(): number

  • Gets the actual disabled elevation to use for the button.

    Returns number

  • set actualDisabledElevation(v): void

  • Parameters

    • v: number

    Returns void

actualDisabledTextColor

  • get actualDisabledTextColor(): string

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

    Returns string

  • set actualDisabledTextColor(v): void

  • Parameters

    • v: string

    Returns void

actualElevationMode

  • get actualElevationMode(): ElevationMode

  • Gets the actual disabled elevation to use for the button.

    Returns ElevationMode

  • set actualElevationMode(v): void

  • Parameters

    • v: ElevationMode

    Returns void

actualFocusBackgroundColor

  • get actualFocusBackgroundColor(): string

  • Gets the color to use for the actual background.

    Returns string

  • set actualFocusBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

actualFocusElevation

  • get actualFocusElevation(): number

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

    Returns number

  • set actualFocusElevation(v): void

  • Parameters

    • v: number

    Returns void

actualFocusTextColor

  • get actualFocusTextColor(): string

  • Gets the actual color to use for the focused text.

    Returns string

  • set actualFocusTextColor(v): void

  • Parameters

    • v: string

    Returns void

actualHoverBackgroundColor

  • get actualHoverBackgroundColor(): string

  • Gets the hover color to use for the actual background.

    Returns string

  • set actualHoverBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

actualHoverElevation

  • get actualHoverElevation(): number

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

    Returns number

  • set actualHoverElevation(v): void

  • Parameters

    • v: number

    Returns void

actualHoverTextColor

  • get actualHoverTextColor(): string

  • Gets the color to use for the actual background.

    Returns string

  • set actualHoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

actualPenumbraShadowColor

  • get actualPenumbraShadowColor(): string

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

    Returns string

  • set actualPenumbraShadowColor(v): void

  • Parameters

    • v: string

    Returns void

actualRestingElevation

  • get actualRestingElevation(): number

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

    Returns number

  • set actualRestingElevation(v): void

  • Parameters

    • v: number

    Returns void

actualRippleColor

  • get actualRippleColor(): string

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

    Returns string

  • set actualRippleColor(v): void

  • Parameters

    • v: string

    Returns void

actualTextColor

  • get actualTextColor(): string

  • Gets the color to use for the actual background.

    Returns string

  • set actualTextColor(v): void

  • Parameters

    • v: string

    Returns void

actualUmbraShadowColor

  • get actualUmbraShadowColor(): string

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

    Returns string

  • set actualUmbraShadowColor(v): void

  • Parameters

    • v: string

    Returns void

alignItems

  • get alignItems(): string

  • Gets or sets the id to use for the checkbox.

    Returns string

  • set alignItems(v): void

  • Parameters

    • v: string

    Returns void

ariaLabel

  • get ariaLabel(): string

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

    Returns string

  • set ariaLabel(v): void

  • Parameters

    • v: string

    Returns void

backgroundColor

  • get backgroundColor(): string

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

    Returns string

  • set backgroundColor(v): void

  • Parameters

    • v: string

    Returns void

baseTheme

  • get baseTheme(): BaseControlTheme

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

    Returns BaseControlTheme

  • set baseTheme(v): void

  • Parameters

    • v: BaseControlTheme

    Returns void

borderColor

  • get borderColor(): string

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

    Returns string

  • set borderColor(v): void

  • Parameters

    • v: string

    Returns void

borderWidth

  • get borderWidth(): number

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

    Returns number

  • set borderWidth(v): void

  • Parameters

    • v: number

    Returns void

clickTunneling

  • get clickTunneling(): boolean

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

    Returns boolean

  • set clickTunneling(v): void

  • Parameters

    • v: boolean

    Returns void

clicked

  • get clicked(): ((s, e) => void)

  • Returns ((s, e) => void)

  • set clicked(ev): void

  • Parameters

    Returns void

contentPaddingBottom

  • get contentPaddingBottom(): number

  • Gets or sets the bottom padding for the button content.

    Returns number

  • set contentPaddingBottom(v): void

  • Parameters

    • v: number

    Returns void

contentPaddingLeft

  • get contentPaddingLeft(): number

  • Gets or sets the left padding for the button content.

    Returns number

  • set contentPaddingLeft(v): void

  • Parameters

    • v: number

    Returns void

contentPaddingRight

  • get contentPaddingRight(): number

  • Gets or sets the right padding for the button content.

    Returns number

  • set contentPaddingRight(v): void

  • Parameters

    • v: number

    Returns void

contentPaddingTop

  • get contentPaddingTop(): number

  • Gets or sets the top padding for the button content.

    Returns number

  • set contentPaddingTop(v): void

  • Parameters

    • v: number

    Returns void

cornerRadiusBottomLeft

  • get cornerRadiusBottomLeft(): number

  • Returns number

  • set cornerRadiusBottomLeft(v): void

  • Parameters

    • v: number

    Returns void

cornerRadiusBottomRight

  • get cornerRadiusBottomRight(): number

  • Returns number

  • set cornerRadiusBottomRight(v): void

  • Parameters

    • v: number

    Returns void

cornerRadiusTopLeft

  • get cornerRadiusTopLeft(): number

  • Returns number

  • set cornerRadiusTopLeft(v): void

  • Parameters

    • v: number

    Returns void

cornerRadiusTopRight

  • get cornerRadiusTopRight(): number

  • Returns number

  • set cornerRadiusTopRight(v): void

  • Parameters

    • v: number

    Returns void

density

  • get density(): ControlDisplayDensity

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

    Returns ControlDisplayDensity

  • set density(v): void

  • Parameters

    • v: ControlDisplayDensity

    Returns void

disableHover

  • get disableHover(): boolean

  • Gets or sets whether the hover effect is disabled.

    Returns boolean

  • set disableHover(v): void

  • Parameters

    • v: boolean

    Returns void

disablePointer

  • get disablePointer(): boolean

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

    Returns boolean

  • set disablePointer(v): void

  • Parameters

    • v: boolean

    Returns void

disableRipple

  • get disableRipple(): boolean

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

    Returns boolean

  • set disableRipple(v): void

  • Parameters

    • v: boolean

    Returns void

disableTransitions

  • get disableTransitions(): boolean

  • Gets or sets whether the checkbox transitions are disabled.

    Returns boolean

  • set disableTransitions(v): void

  • Parameters

    • v: boolean

    Returns void

disabled

  • get disabled(): boolean

  • Gets or sets whether the checkbox is disabled.

    Returns boolean

  • set disabled(v): void

  • Parameters

    • v: boolean

    Returns void

disabledBackgroundColor

  • get disabledBackgroundColor(): string

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

    Returns string

  • set disabledBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

disabledBorderColor

  • get disabledBorderColor(): string

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

    Returns string

  • set disabledBorderColor(v): void

  • Parameters

    • v: string

    Returns void

disabledElevation

  • get disabledElevation(): number

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

    Returns number

  • set disabledElevation(v): void

  • Parameters

    • v: number

    Returns void

disabledTextColor

  • get disabledTextColor(): string

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

    Returns string

  • set disabledTextColor(v): void

  • Parameters

    • v: string

    Returns void

display

  • get display(): string

  • Gets or sets the id to use for the checkbox.

    Returns string

  • set display(v): void

  • Parameters

    • v: string

    Returns void

displayType

  • get displayType(): ButtonDisplayStyle

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

    Returns ButtonDisplayStyle

  • set displayType(v): void

  • Parameters

    • v: ButtonDisplayStyle

    Returns void

elevationMode

  • get elevationMode(): ElevationMode

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

    Returns ElevationMode

  • set elevationMode(v): void

  • Parameters

    • v: ElevationMode

    Returns void

fabBackgroundColor

  • get fabBackgroundColor(): string

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

    Returns string

  • set fabBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

fabBorderColor

  • get fabBorderColor(): string

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

    Returns string

  • set fabBorderColor(v): void

  • Parameters

    • v: string

    Returns void

fabBorderWidth

  • get fabBorderWidth(): number

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

    Returns number

  • set fabBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

fabCornerRadiusBottomLeft

  • get fabCornerRadiusBottomLeft(): number

  • Returns number

  • set fabCornerRadiusBottomLeft(v): void

  • Parameters

    • v: number

    Returns void

fabCornerRadiusBottomRight

  • get fabCornerRadiusBottomRight(): number

  • Returns number

  • set fabCornerRadiusBottomRight(v): void

  • Parameters

    • v: number

    Returns void

fabCornerRadiusTopLeft

  • get fabCornerRadiusTopLeft(): number

  • Returns number

  • set fabCornerRadiusTopLeft(v): void

  • Parameters

    • v: number

    Returns void

fabCornerRadiusTopRight

  • get fabCornerRadiusTopRight(): number

  • Returns number

  • set fabCornerRadiusTopRight(v): void

  • Parameters

    • v: number

    Returns void

fabDisabledBackgroundColor

  • get fabDisabledBackgroundColor(): string

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

    Returns string

  • set fabDisabledBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

fabDisabledBorderColor

  • get fabDisabledBorderColor(): string

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

    Returns string

  • set fabDisabledBorderColor(v): void

  • Parameters

    • v: string

    Returns void

fabDisabledElevation

  • get fabDisabledElevation(): number

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

    Returns number

  • set fabDisabledElevation(v): void

  • Parameters

    • v: number

    Returns void

fabDisabledTextColor

  • get fabDisabledTextColor(): string

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

    Returns string

  • set fabDisabledTextColor(v): void

  • Parameters

    • v: string

    Returns void

fabFocusBackgroundColor

  • get fabFocusBackgroundColor(): string

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

    Returns string

  • set fabFocusBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

fabFocusElevation

  • get fabFocusElevation(): number

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

    Returns number

  • set fabFocusElevation(v): void

  • Parameters

    • v: number

    Returns void

fabFocusTextColor

  • get fabFocusTextColor(): string

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

    Returns string

  • set fabFocusTextColor(v): void

  • Parameters

    • v: string

    Returns void

fabHoverBackgroundColor

  • get fabHoverBackgroundColor(): string

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

    Returns string

  • set fabHoverBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

fabHoverElevation

  • get fabHoverElevation(): number

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

    Returns number

  • set fabHoverElevation(v): void

  • Parameters

    • v: number

    Returns void

fabHoverTextColor

  • get fabHoverTextColor(): string

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

    Returns string

  • set fabHoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

fabRestingElevation

  • get fabRestingElevation(): number

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

    Returns number

  • set fabRestingElevation(v): void

  • Parameters

    • v: number

    Returns void

fabRippleColor

  • get fabRippleColor(): string

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

    Returns string

  • set fabRippleColor(v): void

  • Parameters

    • v: string

    Returns void

fabTextColor

  • get fabTextColor(): string

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

    Returns string

  • set fabTextColor(v): void

  • Parameters

    • v: string

    Returns void

fillAvailableSpace

  • get fillAvailableSpace(): boolean

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

    Returns boolean

  • set fillAvailableSpace(v): void

  • Parameters

    • v: boolean

    Returns void

flatBackgroundColor

  • get flatBackgroundColor(): string

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

    Returns string

  • set flatBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

flatBorderColor

  • get flatBorderColor(): string

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

    Returns string

  • set flatBorderColor(v): void

  • Parameters

    • v: string

    Returns void

flatBorderWidth

  • get flatBorderWidth(): number

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

    Returns number

  • set flatBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

flatCornerRadiusBottomLeft

  • get flatCornerRadiusBottomLeft(): number

  • Returns number

  • set flatCornerRadiusBottomLeft(v): void

  • Parameters

    • v: number

    Returns void

flatCornerRadiusBottomRight

  • get flatCornerRadiusBottomRight(): number

  • Returns number

  • set flatCornerRadiusBottomRight(v): void

  • Parameters

    • v: number

    Returns void

flatCornerRadiusTopLeft

  • get flatCornerRadiusTopLeft(): number

  • Returns number

  • set flatCornerRadiusTopLeft(v): void

  • Parameters

    • v: number

    Returns void

flatCornerRadiusTopRight

  • get flatCornerRadiusTopRight(): number

  • Returns number

  • set flatCornerRadiusTopRight(v): void

  • Parameters

    • v: number

    Returns void

flatDisabledBackgroundColor

  • get flatDisabledBackgroundColor(): string

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

    Returns string

  • set flatDisabledBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

flatDisabledBorderColor

  • get flatDisabledBorderColor(): string

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

    Returns string

  • set flatDisabledBorderColor(v): void

  • Parameters

    • v: string

    Returns void

flatDisabledElevation

  • get flatDisabledElevation(): number

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

    Returns number

  • set flatDisabledElevation(v): void

  • Parameters

    • v: number

    Returns void

flatDisabledTextColor

  • get flatDisabledTextColor(): string

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

    Returns string

  • set flatDisabledTextColor(v): void

  • Parameters

    • v: string

    Returns void

flatFocusBackgroundColor

  • get flatFocusBackgroundColor(): string

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

    Returns string

  • set flatFocusBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

flatFocusElevation

  • get flatFocusElevation(): number

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

    Returns number

  • set flatFocusElevation(v): void

  • Parameters

    • v: number

    Returns void

flatFocusTextColor

  • get flatFocusTextColor(): string

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

    Returns string

  • set flatFocusTextColor(v): void

  • Parameters

    • v: string

    Returns void

flatHoverBackgroundColor

  • get flatHoverBackgroundColor(): string

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

    Returns string

  • set flatHoverBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

flatHoverElevation

  • get flatHoverElevation(): number

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

    Returns number

  • set flatHoverElevation(v): void

  • Parameters

    • v: number

    Returns void

flatHoverTextColor

  • get flatHoverTextColor(): string

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

    Returns string

  • set flatHoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

flatRestingElevation

  • get flatRestingElevation(): number

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

    Returns number

  • set flatRestingElevation(v): void

  • Parameters

    • v: number

    Returns void

flatRippleColor

  • get flatRippleColor(): string

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

    Returns string

  • set flatRippleColor(v): void

  • Parameters

    • v: string

    Returns void

flatTextColor

  • get flatTextColor(): string

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

    Returns string

  • set flatTextColor(v): void

  • Parameters

    • v: string

    Returns void

flexDirection

  • get flexDirection(): string

  • Gets or sets the id to use for the checkbox.

    Returns string

  • set flexDirection(v): void

  • Parameters

    • v: string

    Returns void

flexGrow

  • get flexGrow(): string

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

    Returns string

  • set flexGrow(v): void

  • Parameters

    • v: string

    Returns void

focusBackgroundColor

  • get focusBackgroundColor(): string

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

    Returns string

  • set focusBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

focusElevation

  • get focusElevation(): number

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

    Returns number

  • set focusElevation(v): void

  • Parameters

    • v: number

    Returns void

focusTextColor

  • get focusTextColor(): string

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

    Returns string

  • set focusTextColor(v): void

  • Parameters

    • v: string

    Returns void

focused

  • get focused(): boolean

  • Gets or sets if the checkbox is Focused.

    Returns boolean

  • set focused(v): void

  • Parameters

    • v: boolean

    Returns void

gotFocus

  • get gotFocus(): ((s, e) => void)

  • Returns ((s, e) => void)

      • (s, e): void

      • Parameters

        Returns void

  • set gotFocus(ev): void

  • Parameters

    • ev: ((s, e) => void)
        • (s, e): void

        • Parameters

          Returns void

    Returns void

horizontalContentAlignment

  • get horizontalContentAlignment(): HorizontalAlignment

  • Returns HorizontalAlignment

  • set horizontalContentAlignment(v): void

  • Parameters

    • v: HorizontalAlignment

    Returns void

hoverBackgroundColor

  • get hoverBackgroundColor(): string

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

    Returns string

  • set hoverBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

hoverElevation

  • get hoverElevation(): number

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

    Returns number

  • set hoverElevation(v): void

  • Parameters

    • v: number

    Returns void

hoverTextColor

  • get hoverTextColor(): string

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

    Returns string

  • set hoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

iconBackgroundColor

  • get iconBackgroundColor(): string

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

    Returns string

  • set iconBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

iconBorderColor

  • get iconBorderColor(): string

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

    Returns string

  • set iconBorderColor(v): void

  • Parameters

    • v: string

    Returns void

iconBorderWidth

  • get iconBorderWidth(): number

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

    Returns number

  • set iconBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

iconCornerRadiusBottomLeft

  • get iconCornerRadiusBottomLeft(): number

  • Returns number

  • set iconCornerRadiusBottomLeft(v): void

  • Parameters

    • v: number

    Returns void

iconCornerRadiusBottomRight

  • get iconCornerRadiusBottomRight(): number

  • Returns number

  • set iconCornerRadiusBottomRight(v): void

  • Parameters

    • v: number

    Returns void

iconCornerRadiusTopLeft

  • get iconCornerRadiusTopLeft(): number

  • Returns number

  • set iconCornerRadiusTopLeft(v): void

  • Parameters

    • v: number

    Returns void

iconCornerRadiusTopRight

  • get iconCornerRadiusTopRight(): number

  • Returns number

  • set iconCornerRadiusTopRight(v): void

  • Parameters

    • v: number

    Returns void

iconDisabledBackgroundColor

  • get iconDisabledBackgroundColor(): string

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

    Returns string

  • set iconDisabledBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

iconDisabledBorderColor

  • get iconDisabledBorderColor(): string

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

    Returns string

  • set iconDisabledBorderColor(v): void

  • Parameters

    • v: string

    Returns void

iconDisabledElevation

  • get iconDisabledElevation(): number

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

    Returns number

  • set iconDisabledElevation(v): void

  • Parameters

    • v: number

    Returns void

iconDisabledTextColor

  • get iconDisabledTextColor(): string

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

    Returns string

  • set iconDisabledTextColor(v): void

  • Parameters

    • v: string

    Returns void

iconFocusBackgroundColor

  • get iconFocusBackgroundColor(): string

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

    Returns string

  • set iconFocusBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

iconFocusElevation

  • get iconFocusElevation(): number

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

    Returns number

  • set iconFocusElevation(v): void

  • Parameters

    • v: number

    Returns void

iconFocusTextColor

  • get iconFocusTextColor(): string

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

    Returns string

  • set iconFocusTextColor(v): void

  • Parameters

    • v: string

    Returns void

iconHoverBackgroundColor

  • get iconHoverBackgroundColor(): string

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

    Returns string

  • set iconHoverBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

iconHoverElevation

  • get iconHoverElevation(): number

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

    Returns number

  • set iconHoverElevation(v): void

  • Parameters

    • v: number

    Returns void

iconHoverTextColor

  • get iconHoverTextColor(): string

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

    Returns string

  • set iconHoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

iconRestingElevation

  • get iconRestingElevation(): number

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

    Returns number

  • set iconRestingElevation(v): void

  • Parameters

    • v: number

    Returns void

iconRippleColor

  • get iconRippleColor(): string

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

    Returns string

  • set iconRippleColor(v): void

  • Parameters

    • v: string

    Returns void

iconTextColor

  • get iconTextColor(): string

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

    Returns string

  • set iconTextColor(v): void

  • Parameters

    • v: string

    Returns void

id

  • get id(): string

  • Gets or sets the id to use for the checkbox.

    Returns string

  • set id(v): void

  • Parameters

    • v: string

    Returns void

inputId

  • get inputId(): string

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

    Returns string

  • set inputId(v): void

  • Parameters

    • v: string

    Returns void

isFocusStyleEnabled

  • get isFocusStyleEnabled(): boolean

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

    Returns boolean

  • set isFocusStyleEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

isHover

  • get isHover(): boolean

  • Gets or sets whether the checkbox is checked.

    Returns boolean

  • set isHover(v): void

  • Parameters

    • v: boolean

    Returns void

lostFocus

  • get lostFocus(): ((s, e) => void)

  • Returns ((s, e) => void)

      • (s, e): void

      • Parameters

        Returns void

  • set lostFocus(ev): void

  • Parameters

    • ev: ((s, e) => void)
        • (s, e): void

        • Parameters

          Returns void

    Returns void

minHeight

  • get minHeight(): number

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

    Returns number

  • set minHeight(v): void

  • Parameters

    • v: number

    Returns void

minWidth

  • get minWidth(): number

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

    Returns number

  • set minWidth(v): void

  • Parameters

    • v: number

    Returns void

name

  • get name(): string

  • Gets or sets name to use for the button.

    Returns string

  • set name(v): void

  • Parameters

    • v: string

    Returns void

nativeElement

  • get nativeElement(): HTMLElement

  • Returns HTMLElement

outlinedBackgroundColor

  • get outlinedBackgroundColor(): string

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

    Returns string

  • set outlinedBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedBorderColor

  • get outlinedBorderColor(): string

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

    Returns string

  • set outlinedBorderColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedBorderWidth

  • get outlinedBorderWidth(): number

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

    Returns number

  • set outlinedBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

outlinedCornerRadiusBottomLeft

  • get outlinedCornerRadiusBottomLeft(): number

  • Returns number

  • set outlinedCornerRadiusBottomLeft(v): void

  • Parameters

    • v: number

    Returns void

outlinedCornerRadiusBottomRight

  • get outlinedCornerRadiusBottomRight(): number

  • Returns number

  • set outlinedCornerRadiusBottomRight(v): void

  • Parameters

    • v: number

    Returns void

outlinedCornerRadiusTopLeft

  • get outlinedCornerRadiusTopLeft(): number

  • Returns number

  • set outlinedCornerRadiusTopLeft(v): void

  • Parameters

    • v: number

    Returns void

outlinedCornerRadiusTopRight

  • get outlinedCornerRadiusTopRight(): number

  • Returns number

  • set outlinedCornerRadiusTopRight(v): void

  • Parameters

    • v: number

    Returns void

outlinedDisabledBackgroundColor

  • get outlinedDisabledBackgroundColor(): string

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

    Returns string

  • set outlinedDisabledBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedDisabledBorderColor

  • get outlinedDisabledBorderColor(): string

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

    Returns string

  • set outlinedDisabledBorderColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedDisabledElevation

  • get outlinedDisabledElevation(): number

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

    Returns number

  • set outlinedDisabledElevation(v): void

  • Parameters

    • v: number

    Returns void

outlinedDisabledTextColor

  • get outlinedDisabledTextColor(): string

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

    Returns string

  • set outlinedDisabledTextColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedFocusBackgroundColor

  • get outlinedFocusBackgroundColor(): string

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

    Returns string

  • set outlinedFocusBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedFocusElevation

  • get outlinedFocusElevation(): number

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

    Returns number

  • set outlinedFocusElevation(v): void

  • Parameters

    • v: number

    Returns void

outlinedFocusTextColor

  • get outlinedFocusTextColor(): string

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

    Returns string

  • set outlinedFocusTextColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedHoverBackgroundColor

  • get outlinedHoverBackgroundColor(): string

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

    Returns string

  • set outlinedHoverBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedHoverElevation

  • get outlinedHoverElevation(): number

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

    Returns number

  • set outlinedHoverElevation(v): void

  • Parameters

    • v: number

    Returns void

outlinedHoverTextColor

  • get outlinedHoverTextColor(): string

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

    Returns string

  • set outlinedHoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedRestingElevation

  • get outlinedRestingElevation(): number

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

    Returns number

  • set outlinedRestingElevation(v): void

  • Parameters

    • v: number

    Returns void

outlinedRippleColor

  • get outlinedRippleColor(): string

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

    Returns string

  • set outlinedRippleColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedTextColor

  • get outlinedTextColor(): string

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

    Returns string

  • set outlinedTextColor(v): void

  • Parameters

    • v: string

    Returns void

raisedBackgroundColor

  • get raisedBackgroundColor(): string

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

    Returns string

  • set raisedBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

raisedBorderColor

  • get raisedBorderColor(): string

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

    Returns string

  • set raisedBorderColor(v): void

  • Parameters

    • v: string

    Returns void

raisedBorderWidth

  • get raisedBorderWidth(): number

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

    Returns number

  • set raisedBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

raisedCornerRadiusBottomLeft

  • get raisedCornerRadiusBottomLeft(): number

  • Returns number

  • set raisedCornerRadiusBottomLeft(v): void

  • Parameters

    • v: number

    Returns void

raisedCornerRadiusBottomRight

  • get raisedCornerRadiusBottomRight(): number

  • Returns number

  • set raisedCornerRadiusBottomRight(v): void

  • Parameters

    • v: number

    Returns void

raisedCornerRadiusTopLeft

  • get raisedCornerRadiusTopLeft(): number

  • Returns number

  • set raisedCornerRadiusTopLeft(v): void

  • Parameters

    • v: number

    Returns void

raisedCornerRadiusTopRight

  • get raisedCornerRadiusTopRight(): number

  • Returns number

  • set raisedCornerRadiusTopRight(v): void

  • Parameters

    • v: number

    Returns void

raisedDisabledBackgroundColor

  • get raisedDisabledBackgroundColor(): string

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

    Returns string

  • set raisedDisabledBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

raisedDisabledBorderColor

  • get raisedDisabledBorderColor(): string

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

    Returns string

  • set raisedDisabledBorderColor(v): void

  • Parameters

    • v: string

    Returns void

raisedDisabledElevation

  • get raisedDisabledElevation(): number

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

    Returns number

  • set raisedDisabledElevation(v): void

  • Parameters

    • v: number

    Returns void

raisedDisabledTextColor

  • get raisedDisabledTextColor(): string

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

    Returns string

  • set raisedDisabledTextColor(v): void

  • Parameters

    • v: string

    Returns void

raisedFocusBackgroundColor

  • get raisedFocusBackgroundColor(): string

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

    Returns string

  • set raisedFocusBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

raisedFocusElevation

  • get raisedFocusElevation(): number

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

    Returns number

  • set raisedFocusElevation(v): void

  • Parameters

    • v: number

    Returns void

raisedFocusTextColor

  • get raisedFocusTextColor(): string

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

    Returns string

  • set raisedFocusTextColor(v): void

  • Parameters

    • v: string

    Returns void

raisedHoverBackgroundColor

  • get raisedHoverBackgroundColor(): string

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

    Returns string

  • set raisedHoverBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

raisedHoverElevation

  • get raisedHoverElevation(): number

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

    Returns number

  • set raisedHoverElevation(v): void

  • Parameters

    • v: number

    Returns void

raisedHoverTextColor

  • get raisedHoverTextColor(): string

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

    Returns string

  • set raisedHoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

raisedRestingElevation

  • get raisedRestingElevation(): number

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

    Returns number

  • set raisedRestingElevation(v): void

  • Parameters

    • v: number

    Returns void

raisedRippleColor

  • get raisedRippleColor(): string

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

    Returns string

  • set raisedRippleColor(v): void

  • Parameters

    • v: string

    Returns void

raisedTextColor

  • get raisedTextColor(): string

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

    Returns string

  • set raisedTextColor(v): void

  • Parameters

    • v: string

    Returns void

restingElevation

  • get restingElevation(): number

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

    Returns number

  • set restingElevation(v): void

  • Parameters

    • v: number

    Returns void

rippleColor

  • get rippleColor(): string

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

    Returns string

  • set rippleColor(v): void

  • Parameters

    • v: string

    Returns void

stopPropagation

  • get stopPropagation(): boolean

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

    Returns boolean

  • set stopPropagation(v): void

  • Parameters

    • v: boolean

    Returns void

tabIndex

  • get tabIndex(): number

  • Gets or sets TabIndex to use for the checkbox.

    Returns number

  • set tabIndex(v): void

  • Parameters

    • v: number

    Returns void

textColor

  • get textColor(): string

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

    Returns string

  • set textColor(v): void

  • Parameters

    • v: string

    Returns void

textStyle

  • get textStyle(): string

  • Gets or sets the use for the button.

    Returns string

  • set textStyle(v): void

  • Parameters

    • v: string

    Returns void

value

  • get value(): any

  • Gets or sets value to use for the checkbox.

    Returns any

  • set value(v): void

  • Parameters

    • v: any

    Returns void

verticalContentAlignment

  • get verticalContentAlignment(): VerticalAlignment

  • Returns VerticalAlignment

  • set verticalContentAlignment(v): void

  • Parameters

    • v: VerticalAlignment

    Returns void

Methods

Optional UNSAFE_componentWillMount

Optional UNSAFE_componentWillReceiveProps

Optional UNSAFE_componentWillUpdate

Optional componentDidCatch

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • Returns void

Optional componentDidUpdate

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<IIgrXButtonProps>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    Returns void

Optional componentWillMount

Optional componentWillReceiveProps

componentWillUnmount

  • Returns void

Optional componentWillUpdate

destroy

  • Returns void

ensureActualCornerRadius

  • Returns void

ensureCornerRadius

  • Returns void

ensureFabCornerRadius

  • Returns void

ensureFlatCornerRadius

  • Returns void

ensureIconCornerRadius

  • Returns void

ensureOutlinedCornerRadius

  • Returns void

ensureRaisedCornerRadius

  • Returns void

exportSerializedVisualModel

  • Returns a serialized copy of the exported visual model

    Returns string

exportVisualModel

  • Exports visual information about the current state of the grid.

    Returns any

findByName

  • Parameters

    • name: string

    Returns any

forceUpdate

  • Parameters

    • Optional callback: (() => void)
        • (): void

        • Returns void

    Returns void

Optional getSnapshotBeforeUpdate

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns any

initializeContent

  • Returns void

onAttachedToUI

  • Returns void

onDetachedFromUI

  • Returns void

render

  • Returns DetailedReactHTMLElement<{
        children: any[];
        className: string;
        ref: ((ref) => void);
    }, any>

setState

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void

        • Returns void

    Returns void

shouldComponentUpdate

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

updateStyle

  • Returns void

Static _createFromInternal

  • _createFromInternal(internal): IgrXButton

  • Parameters

    • internal: any

    Returns IgrXButton