Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrXButtonGroup

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

actualButtons

actualButtons: IgrXButton[]

The style mappings actually present in the treemap. Do not directly modify this array. This array's contents can be modified by causing React to reproject the child content. Or adding and removing ranges from the manual ranges collection on the ranges property.

contentButtons

contentButtons: IgrXButton[]

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<IIgrXButtonGroupProps> & 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

actualDensity

  • get actualDensity(): ControlDisplayDensity

  • Gets the actual display density to use for the button group.

    Returns ControlDisplayDensity

  • set actualDensity(v): void

  • Parameters

    • v: ControlDisplayDensity

    Returns void

actualItemBackgroundColor

  • get actualItemBackgroundColor(): string

  • Gets the actual item background color.

    Returns string

  • set actualItemBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

actualItemBorderColor

  • get actualItemBorderColor(): string

  • Gets the actual item border color.

    Returns string

  • set actualItemBorderColor(v): void

  • Parameters

    • v: string

    Returns void

actualItemBorderWidth

  • get actualItemBorderWidth(): number

  • Gets the actual item border width.

    Returns number

  • set actualItemBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

actualItemCornerRadius

  • get actualItemCornerRadius(): number

  • Gets the actual item corner radius for the appropriate corners.

    Returns number

  • set actualItemCornerRadius(v): void

  • Parameters

    • v: number

    Returns void

actualItemDisabledBackgroundColor

  • get actualItemDisabledBackgroundColor(): string

  • Gets the actual item background color.

    Returns string

  • set actualItemDisabledBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

actualItemDisabledBorderColor

  • get actualItemDisabledBorderColor(): string

  • Gets the actual item border color.

    Returns string

  • set actualItemDisabledBorderColor(v): void

  • Parameters

    • v: string

    Returns void

actualItemDisabledTextColor

  • get actualItemDisabledTextColor(): string

  • Gets the actual item text color.

    Returns string

  • set actualItemDisabledTextColor(v): void

  • Parameters

    • v: string

    Returns void

actualItemHoverBackgroundColor

  • get actualItemHoverBackgroundColor(): string

  • Gets the actual item hovered background color.

    Returns string

  • set actualItemHoverBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

actualItemHoverTextColor

  • get actualItemHoverTextColor(): string

  • Gets the actual item text color.

    Returns string

  • set actualItemHoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

actualItemTextColor

  • get actualItemTextColor(): string

  • Gets the actual item text color.

    Returns string

  • set actualItemTextColor(v): void

  • Parameters

    • v: string

    Returns void

actualSelectedItemBackgroundColor

  • get actualSelectedItemBackgroundColor(): string

  • Gets the actual selected item background color.

    Returns string

  • set actualSelectedItemBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

actualSelectedItemHoverBackgroundColor

  • get actualSelectedItemHoverBackgroundColor(): string

  • Gets the actual selected item hovered background color.

    Returns string

  • set actualSelectedItemHoverBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

actualSelectedItemHoverTextColor

  • get actualSelectedItemHoverTextColor(): string

  • Gets the actual selected item hovered text color.

    Returns string

  • set actualSelectedItemHoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

actualSelectedItemTextColor

  • get actualSelectedItemTextColor(): string

  • Gets the stroke actual selected item text color.

    Returns string

  • set actualSelectedItemTextColor(v): void

  • Parameters

    • v: string

    Returns void

baseTheme

  • get baseTheme(): BaseControlTheme

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

    Returns BaseControlTheme

  • set baseTheme(v): void

  • Parameters

    • v: BaseControlTheme

    Returns void

buttons

density

  • get density(): ControlDisplayDensity

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

    Returns ControlDisplayDensity

  • set density(v): void

  • Parameters

    • v: ControlDisplayDensity

    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

displayType

  • get displayType(): ButtonGroupDisplayStyle

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

    Returns ButtonGroupDisplayStyle

  • set displayType(v): void

  • Parameters

    • v: ButtonGroupDisplayStyle

    Returns void

flatItemBackgroundColor

  • get flatItemBackgroundColor(): string

  • Gets or sets the color to use the background of the buttons in the group when type is flat.

    Returns string

  • set flatItemBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

flatItemBorderColor

  • get flatItemBorderColor(): string

  • Gets or sets the color to use the border of the buttons in the group when type is flat.

    Returns string

  • set flatItemBorderColor(v): void

  • Parameters

    • v: string

    Returns void

flatItemBorderWidth

  • get flatItemBorderWidth(): number

  • Gets or sets the border width to use for the buttons in the group when type is flat.

    Returns number

  • set flatItemBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

flatItemCornerRadius

  • get flatItemCornerRadius(): number

  • Gets or sets the corner radius to use for the appropriate corners for the flat type item buttons.

    Returns number

  • set flatItemCornerRadius(v): void

  • Parameters

    • v: number

    Returns void

flatItemDisabledBackgroundColor

  • get flatItemDisabledBackgroundColor(): string

  • Gets or sets the disabled color to use the background of the buttons in the group when type is flat.

    Returns string

  • set flatItemDisabledBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

flatItemDisabledBorderColor

  • get flatItemDisabledBorderColor(): string

  • Gets or sets the disabled color to use the border of the buttons in the group when type is flat.

    Returns string

  • set flatItemDisabledBorderColor(v): void

  • Parameters

    • v: string

    Returns void

flatItemDisabledTextColor

  • get flatItemDisabledTextColor(): string

  • Gets or sets the disabled color to use the text of the buttons in the group when type is flat.

    Returns string

  • set flatItemDisabledTextColor(v): void

  • Parameters

    • v: string

    Returns void

flatItemHoverBackgroundColor

  • get flatItemHoverBackgroundColor(): string

  • Gets or sets the color to use the hovered background of the buttons in the group when type is flat.

    Returns string

  • set flatItemHoverBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

flatItemHoverTextColor

  • get flatItemHoverTextColor(): string

  • Gets or sets the color to use the hovered text of the buttons in the group when type is flat.

    Returns string

  • set flatItemHoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

flatItemTextColor

  • get flatItemTextColor(): string

  • Gets or sets the color to use the text of the buttons in the group when type is flat.

    Returns string

  • set flatItemTextColor(v): void

  • Parameters

    • v: string

    Returns void

flatSelectedItemBackgroundColor

  • get flatSelectedItemBackgroundColor(): string

  • Gets or sets the color to use the background of the buttons in the group that are selected when type is flat.

    Returns string

  • set flatSelectedItemBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

flatSelectedItemHoverBackgroundColor

  • get flatSelectedItemHoverBackgroundColor(): string

  • Gets or sets the color to use the hovered background of the buttons in the group that are selected when type is flat.

    Returns string

  • set flatSelectedItemHoverBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

flatSelectedItemHoverTextColor

  • get flatSelectedItemHoverTextColor(): string

  • Gets or sets the color to use the hovered text of the buttons in the group that are selected when type is flat.

    Returns string

  • set flatSelectedItemHoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

flatSelectedItemTextColor

  • get flatSelectedItemTextColor(): string

  • Gets or sets the color to use the text of the buttons in the group that are selected when type is flat.

    Returns string

  • set flatSelectedItemTextColor(v): void

  • Parameters

    • v: string

    Returns void

i

  • get i(): XButtonGroup

  • Returns XButtonGroup

id

  • get id(): string

  • Gets or sets the id to use for the button group.

    Returns string

  • set id(v): void

  • Parameters

    • v: string

    Returns void

isMultiSelect

  • get isMultiSelect(): boolean

  • Gets or sets whether the group supports multi-select.

    Returns boolean

  • set isMultiSelect(v): void

  • Parameters

    • v: boolean

    Returns void

itemBackgroundColor

  • get itemBackgroundColor(): string

  • Gets or sets the color to use the background of the buttons in the group.

    Returns string

  • set itemBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

itemBorderColor

  • get itemBorderColor(): string

  • Gets or sets the color to use the border of the buttons in the group.

    Returns string

  • set itemBorderColor(v): void

  • Parameters

    • v: string

    Returns void

itemBorderWidth

  • get itemBorderWidth(): number

  • Gets or sets the border width to use for the buttons in the group.

    Returns number

  • set itemBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

itemCornerRadius

  • get itemCornerRadius(): number

  • Gets or sets the corner radius to use for the appropriate corners for the item buttons.

    Returns number

  • set itemCornerRadius(v): void

  • Parameters

    • v: number

    Returns void

itemDisabledBackgroundColor

  • get itemDisabledBackgroundColor(): string

  • Gets or sets the disabled color to use the background of the buttons in the group.

    Returns string

  • set itemDisabledBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

itemDisabledBorderColor

  • get itemDisabledBorderColor(): string

  • Gets or sets the disabled color to use the border of the buttons in the group.

    Returns string

  • set itemDisabledBorderColor(v): void

  • Parameters

    • v: string

    Returns void

itemDisabledTextColor

  • get itemDisabledTextColor(): string

  • Gets or sets the disabled color to use the text of the buttons in the group.

    Returns string

  • set itemDisabledTextColor(v): void

  • Parameters

    • v: string

    Returns void

itemHoverBackgroundColor

  • get itemHoverBackgroundColor(): string

  • Gets or sets the color to use the hovered background of the buttons in the group.

    Returns string

  • set itemHoverBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

itemHoverTextColor

  • get itemHoverTextColor(): string

  • Gets or sets the color to use the hovered text of the buttons in the group.

    Returns string

  • set itemHoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

itemTextColor

  • get itemTextColor(): string

  • Gets or sets the color to use the text of the buttons in the group.

    Returns string

  • set itemTextColor(v): void

  • Parameters

    • v: string

    Returns void

orientation

  • get orientation(): ButtonGroupOrientation

  • Gets or sets the oreientation to use the button group when type is outlined.

    Returns ButtonGroupOrientation

  • set orientation(v): void

  • Parameters

    Returns void

outlinedItemBackgroundColor

  • get outlinedItemBackgroundColor(): string

  • Gets or sets the color to use the background of the buttons in the group when type is outlined.

    Returns string

  • set outlinedItemBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedItemBorderColor

  • get outlinedItemBorderColor(): string

  • Gets or sets the color to use the border of the buttons in the group when type is outlined.

    Returns string

  • set outlinedItemBorderColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedItemBorderWidth

  • get outlinedItemBorderWidth(): number

  • Gets or sets the border width to use for the buttons in the group when type is outlined.

    Returns number

  • set outlinedItemBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

outlinedItemCornerRadius

  • get outlinedItemCornerRadius(): number

  • Gets or sets the corner radius to use for the appropriate corners for the outlined type item buttons.

    Returns number

  • set outlinedItemCornerRadius(v): void

  • Parameters

    • v: number

    Returns void

outlinedItemDisabledBackgroundColor

  • get outlinedItemDisabledBackgroundColor(): string

  • Gets or sets the disabled color to use the background of the buttons in the group when type is outlined.

    Returns string

  • set outlinedItemDisabledBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedItemDisabledBorderColor

  • get outlinedItemDisabledBorderColor(): string

  • Gets or sets the disabled color to use the border of the buttons in the group when type is outlined.

    Returns string

  • set outlinedItemDisabledBorderColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedItemDisabledTextColor

  • get outlinedItemDisabledTextColor(): string

  • Gets or sets the disabled color to use the text of the buttons in the group when type is outlined.

    Returns string

  • set outlinedItemDisabledTextColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedItemHoverBackgroundColor

  • get outlinedItemHoverBackgroundColor(): string

  • Gets or sets the color to use the hovered background of the buttons in the group when type is outlined.

    Returns string

  • set outlinedItemHoverBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedItemHoverTextColor

  • get outlinedItemHoverTextColor(): string

  • Gets or sets the color to use the hovered text of the buttons in the group when type is outlined.

    Returns string

  • set outlinedItemHoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedItemTextColor

  • get outlinedItemTextColor(): string

  • Gets or sets the color to use the text of the buttons in the group when type is outlined.

    Returns string

  • set outlinedItemTextColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedSelectedItemBackgroundColor

  • get outlinedSelectedItemBackgroundColor(): string

  • Gets or sets the color to use the background of the buttons in the group that are selected when type is outlined.

    Returns string

  • set outlinedSelectedItemBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedSelectedItemHoverBackgroundColor

  • get outlinedSelectedItemHoverBackgroundColor(): string

  • Gets or sets the color to use the hovered background of the buttons in the group that are selected when type is outlined.

    Returns string

  • set outlinedSelectedItemHoverBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedSelectedItemHoverTextColor

  • get outlinedSelectedItemHoverTextColor(): string

  • Gets or sets the color to use the hovered text of the buttons in the group that are selected when type is outlined.

    Returns string

  • set outlinedSelectedItemHoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

outlinedSelectedItemTextColor

  • get outlinedSelectedItemTextColor(): string

  • Gets or sets the color to use the text of the buttons in the group that are selected when type is outlined.

    Returns string

  • set outlinedSelectedItemTextColor(v): void

  • Parameters

    • v: string

    Returns void

selectedIndices

  • get selectedIndices(): number[]

  • Gets the currently selected button indices.

    Returns number[]

  • set selectedIndices(v): void

  • Parameters

    • v: number[]

    Returns void

selectedItemBackgroundColor

  • get selectedItemBackgroundColor(): string

  • Gets or sets the color to use the background of the buttons in the group that are selected.

    Returns string

  • set selectedItemBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

selectedItemHoverBackgroundColor

  • get selectedItemHoverBackgroundColor(): string

  • Gets or sets the color to use the hovered background of the buttons in the group that are selected.

    Returns string

  • set selectedItemHoverBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

selectedItemHoverTextColor

  • get selectedItemHoverTextColor(): string

  • Gets or sets the color to use the hovered text of the buttons in the group that are selected.

    Returns string

  • set selectedItemHoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

selectedItemTextColor

  • get selectedItemTextColor(): string

  • Gets or sets the color to use the text of the buttons in the group that are selected.

    Returns string

  • set selectedItemTextColor(v): void

  • Parameters

    • v: string

    Returns void

selectionChanged

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

    Returns void

Optional componentWillMount

Optional componentWillReceiveProps

componentWillUnmount

  • Returns void

Optional componentWillUpdate

destroy

  • 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