Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrXInputGroup

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

actualInputs

actualInputs: IgrXInputGroupItem<IIgrXInputGroupItemProps>[]

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.

contentInputs

contentInputs: IgrXInputGroupItem<IIgrXInputGroupItemProps>[]

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

actualBackgroundColor

  • get actualBackgroundColor(): string

  • Gets the actual opacity to use for the underline ripple element.

    Returns string

  • set actualBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

actualBorderColor

  • get actualBorderColor(): string

  • Gets the actual item background color.

    Returns string

  • set actualBorderColor(v): void

  • Parameters

    • v: string

    Returns void

actualBorderWidth

  • get actualBorderWidth(): number

  • Gets the actual item border width.

    Returns number

  • set actualBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

actualContentPaddingBottom

  • get actualContentPaddingBottom(): number

  • Returns number

  • set actualContentPaddingBottom(v): void

  • Parameters

    • v: number

    Returns void

actualContentPaddingLeft

  • get actualContentPaddingLeft(): number

  • Returns number

  • set actualContentPaddingLeft(v): void

  • Parameters

    • v: number

    Returns void

actualContentPaddingRight

  • get actualContentPaddingRight(): number

  • Returns number

  • set actualContentPaddingRight(v): void

  • Parameters

    • v: number

    Returns void

actualContentPaddingTop

  • get actualContentPaddingTop(): number

  • Returns number

  • set actualContentPaddingTop(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 input group.

    Returns ControlDisplayDensity

  • set actualDensity(v): void

  • Parameters

    • v: ControlDisplayDensity

    Returns void

actualFocusBorderColor

  • get actualFocusBorderColor(): string

  • Gets the actual item border color.

    Returns string

  • set actualFocusBorderColor(v): void

  • Parameters

    • v: string

    Returns void

actualFocusBorderWidth

  • get actualFocusBorderWidth(): number

  • Gets the actual item border width.

    Returns number

  • set actualFocusBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

actualFocusUnderlineColor

  • get actualFocusUnderlineColor(): string

  • Gets the actual color to use for the underline element when focused.

    Returns string

  • set actualFocusUnderlineColor(v): void

  • Parameters

    • v: string

    Returns void

actualFocusUnderlineOpacity

  • get actualFocusUnderlineOpacity(): number

  • Gets the actual opacity to use for the underline element when focused.

    Returns number

  • set actualFocusUnderlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

actualFocusUnderlineRippleOpacity

  • get actualFocusUnderlineRippleOpacity(): number

  • Gets the actual opacity to use for the underline ripple element when focused.

    Returns number

  • set actualFocusUnderlineRippleOpacity(v): void

  • Parameters

    • v: number

    Returns void

actualHoverUnderlineColor

  • get actualHoverUnderlineColor(): string

  • Gets the actual color to use for the underline element.

    Returns string

  • set actualHoverUnderlineColor(v): void

  • Parameters

    • v: string

    Returns void

actualHoverUnderlineOpacity

  • get actualHoverUnderlineOpacity(): number

  • Gets the actual opacity to use for the underline element when hovered.

    Returns number

  • set actualHoverUnderlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

actualHoverUnderlineWidth

  • get actualHoverUnderlineWidth(): number

  • Gets the width to use for the underline element when hovered.

    Returns number

  • set actualHoverUnderlineWidth(v): void

  • Parameters

    • v: number

    Returns void

actualIsExpanded

  • get actualIsExpanded(): boolean

  • Gets or sets whether the input group is expanded or not.

    Returns boolean

  • set actualIsExpanded(v): void

  • Parameters

    • v: boolean

    Returns void

actualUnderlineColor

  • get actualUnderlineColor(): string

  • Gets the actual color to use for the underline element.

    Returns string

  • set actualUnderlineColor(v): void

  • Parameters

    • v: string

    Returns void

actualUnderlineOpacity

  • get actualUnderlineOpacity(): number

  • Gets the actual opacity to use for the underline element.

    Returns number

  • set actualUnderlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

actualUnderlineRippleColor

  • get actualUnderlineRippleColor(): string

  • Gets the actual color to use for the underline ripple element.

    Returns string

  • set actualUnderlineRippleColor(v): void

  • Parameters

    • v: string

    Returns void

actualUnderlineRippleOpacity

  • get actualUnderlineRippleOpacity(): number

  • Gets the actual opacity to use for the underline ripple element.

    Returns number

  • set actualUnderlineRippleOpacity(v): void

  • Parameters

    • v: number

    Returns void

actualUnderlineRippleWidth

  • get actualUnderlineRippleWidth(): number

  • Gets the actual width to use for the underline element.

    Returns number

  • set actualUnderlineRippleWidth(v): void

  • Parameters

    • v: number

    Returns void

actualUnderlineWidth

  • get actualUnderlineWidth(): number

  • Gets the actual width to use for the underline element.

    Returns number

  • set actualUnderlineWidth(v): void

  • Parameters

    • v: number

    Returns void

backgroundColor

  • get backgroundColor(): string

  • Gets or sets the background color to use for the input group.

    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 label.

    Returns BaseControlTheme

  • set baseTheme(v): void

  • Parameters

    • v: BaseControlTheme

    Returns void

borderColor

  • get borderColor(): string

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

    Returns string

  • set borderColor(v): void

  • Parameters

    • v: string

    Returns void

borderTypeBackgroundColor

  • get borderTypeBackgroundColor(): string

  • Gets or sets the background color to use for the input group when type is border.

    Returns string

  • set borderTypeBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

borderTypeBorderColor

  • get borderTypeBorderColor(): string

  • Gets or sets the color to use the border of the input group when type is border.

    Returns string

  • set borderTypeBorderColor(v): void

  • Parameters

    • v: string

    Returns void

borderTypeBorderWidth

  • get borderTypeBorderWidth(): number

  • Gets or sets the border width to use for the border of the item group when using type line.

    Returns number

  • set borderTypeBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

borderTypeContentPaddingBottom

  • get borderTypeContentPaddingBottom(): number

  • Returns number

  • set borderTypeContentPaddingBottom(v): void

  • Parameters

    • v: number

    Returns void

borderTypeContentPaddingLeft

  • get borderTypeContentPaddingLeft(): number

  • Returns number

  • set borderTypeContentPaddingLeft(v): void

  • Parameters

    • v: number

    Returns void

borderTypeContentPaddingRight

  • get borderTypeContentPaddingRight(): number

  • Returns number

  • set borderTypeContentPaddingRight(v): void

  • Parameters

    • v: number

    Returns void

borderTypeContentPaddingTop

  • get borderTypeContentPaddingTop(): number

  • Returns number

  • set borderTypeContentPaddingTop(v): void

  • Parameters

    • v: number

    Returns void

borderTypeCornerRadiusBottomLeft

  • get borderTypeCornerRadiusBottomLeft(): number

  • Returns number

  • set borderTypeCornerRadiusBottomLeft(v): void

  • Parameters

    • v: number

    Returns void

borderTypeCornerRadiusBottomRight

  • get borderTypeCornerRadiusBottomRight(): number

  • Returns number

  • set borderTypeCornerRadiusBottomRight(v): void

  • Parameters

    • v: number

    Returns void

borderTypeCornerRadiusTopLeft

  • get borderTypeCornerRadiusTopLeft(): number

  • Returns number

  • set borderTypeCornerRadiusTopLeft(v): void

  • Parameters

    • v: number

    Returns void

borderTypeCornerRadiusTopRight

  • get borderTypeCornerRadiusTopRight(): number

  • Returns number

  • set borderTypeCornerRadiusTopRight(v): void

  • Parameters

    • v: number

    Returns void

borderTypeFocusBorderColor

  • get borderTypeFocusBorderColor(): string

  • Gets or sets the focus color to use the border of the input group when type is border.

    Returns string

  • set borderTypeFocusBorderColor(v): void

  • Parameters

    • v: string

    Returns void

borderTypeFocusBorderWidth

  • get borderTypeFocusBorderWidth(): number

  • Gets or sets the border width to use for the border of the item group when focused when type is border.

    Returns number

  • set borderTypeFocusBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

borderTypeFocusUnderlineColor

  • get borderTypeFocusUnderlineColor(): string

  • Gets or sets the color to use for the underline element when type is border.

    Returns string

  • set borderTypeFocusUnderlineColor(v): void

  • Parameters

    • v: string

    Returns void

borderTypeFocusUnderlineOpacity

  • get borderTypeFocusUnderlineOpacity(): number

  • Gets or sets the color to use for the underline element when type is border.

    Returns number

  • set borderTypeFocusUnderlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

borderTypeFocusUnderlineRippleOpacity

  • get borderTypeFocusUnderlineRippleOpacity(): number

  • Gets or sets the opacity to use for the underline ripple element when focused when type is border.

    Returns number

  • set borderTypeFocusUnderlineRippleOpacity(v): void

  • Parameters

    • v: number

    Returns void

borderTypeHoverUnderlineColor

  • get borderTypeHoverUnderlineColor(): string

  • Gets or sets the color to use for the underline element when type is border.

    Returns string

  • set borderTypeHoverUnderlineColor(v): void

  • Parameters

    • v: string

    Returns void

borderTypeHoverUnderlineOpacity

  • get borderTypeHoverUnderlineOpacity(): number

  • Gets or sets the color to use for the underline element when type is border.

    Returns number

  • set borderTypeHoverUnderlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

borderTypeHoverUnderlineWidth

  • get borderTypeHoverUnderlineWidth(): number

  • Gets or sets the width to use for the underline element when hovered when type is border.

    Returns number

  • set borderTypeHoverUnderlineWidth(v): void

  • Parameters

    • v: number

    Returns void

borderTypeUnderlineColor

  • get borderTypeUnderlineColor(): string

  • Gets or sets the color to use for the underline element when type is border.

    Returns string

  • set borderTypeUnderlineColor(v): void

  • Parameters

    • v: string

    Returns void

borderTypeUnderlineOpacity

  • get borderTypeUnderlineOpacity(): number

  • Gets or sets the color to use for the underline element when type is border.

    Returns number

  • set borderTypeUnderlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

borderTypeUnderlineRippleColor

  • get borderTypeUnderlineRippleColor(): string

  • Gets or sets the color to use for the underline ripple element when type is border.

    Returns string

  • set borderTypeUnderlineRippleColor(v): void

  • Parameters

    • v: string

    Returns void

borderTypeUnderlineRippleOpacity

  • get borderTypeUnderlineRippleOpacity(): number

  • Gets or sets the opacity to use for the underline ripple element when type is border.

    Returns number

  • set borderTypeUnderlineRippleOpacity(v): void

  • Parameters

    • v: number

    Returns void

borderTypeUnderlineRippleWidth

  • get borderTypeUnderlineRippleWidth(): number

  • Gets or sets the width to use for the underline element when type is border.

    Returns number

  • set borderTypeUnderlineRippleWidth(v): void

  • Parameters

    • v: number

    Returns void

borderTypeUnderlineWidth

  • get borderTypeUnderlineWidth(): number

  • Gets or sets the width to use for the underline element when type is border.

    Returns number

  • set borderTypeUnderlineWidth(v): void

  • Parameters

    • v: number

    Returns void

borderWidth

  • get borderWidth(): number

  • Gets or sets the border width to use for the border of the item group.

    Returns number

  • set borderWidth(v): void

  • Parameters

    • v: number

    Returns void

boxTypeBackgroundColor

  • get boxTypeBackgroundColor(): string

  • Gets or sets the background color to use for the input group when type is box.

    Returns string

  • set boxTypeBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

boxTypeBorderColor

  • get boxTypeBorderColor(): string

  • Gets or sets the color to use the border of the input group when type is box.

    Returns string

  • set boxTypeBorderColor(v): void

  • Parameters

    • v: string

    Returns void

boxTypeBorderWidth

  • get boxTypeBorderWidth(): number

  • Gets or sets the border width to use for the border of the item group when using type line.

    Returns number

  • set boxTypeBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

boxTypeContentPaddingBottom

  • get boxTypeContentPaddingBottom(): number

  • Returns number

  • set boxTypeContentPaddingBottom(v): void

  • Parameters

    • v: number

    Returns void

boxTypeContentPaddingLeft

  • get boxTypeContentPaddingLeft(): number

  • Returns number

  • set boxTypeContentPaddingLeft(v): void

  • Parameters

    • v: number

    Returns void

boxTypeContentPaddingRight

  • get boxTypeContentPaddingRight(): number

  • Returns number

  • set boxTypeContentPaddingRight(v): void

  • Parameters

    • v: number

    Returns void

boxTypeContentPaddingTop

  • get boxTypeContentPaddingTop(): number

  • Returns number

  • set boxTypeContentPaddingTop(v): void

  • Parameters

    • v: number

    Returns void

boxTypeCornerRadiusBottomLeft

  • get boxTypeCornerRadiusBottomLeft(): number

  • Returns number

  • set boxTypeCornerRadiusBottomLeft(v): void

  • Parameters

    • v: number

    Returns void

boxTypeCornerRadiusBottomRight

  • get boxTypeCornerRadiusBottomRight(): number

  • Returns number

  • set boxTypeCornerRadiusBottomRight(v): void

  • Parameters

    • v: number

    Returns void

boxTypeCornerRadiusTopLeft

  • get boxTypeCornerRadiusTopLeft(): number

  • Returns number

  • set boxTypeCornerRadiusTopLeft(v): void

  • Parameters

    • v: number

    Returns void

boxTypeCornerRadiusTopRight

  • get boxTypeCornerRadiusTopRight(): number

  • Returns number

  • set boxTypeCornerRadiusTopRight(v): void

  • Parameters

    • v: number

    Returns void

boxTypeFocusBorderColor

  • get boxTypeFocusBorderColor(): string

  • Gets or sets the focus color to use the border of the input group when type is box.

    Returns string

  • set boxTypeFocusBorderColor(v): void

  • Parameters

    • v: string

    Returns void

boxTypeFocusBorderWidth

  • get boxTypeFocusBorderWidth(): number

  • Gets or sets the border width to use for the border of the item group when focused when type is box.

    Returns number

  • set boxTypeFocusBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

boxTypeFocusUnderlineColor

  • get boxTypeFocusUnderlineColor(): string

  • Gets or sets the color to use for the underline element when type is box.

    Returns string

  • set boxTypeFocusUnderlineColor(v): void

  • Parameters

    • v: string

    Returns void

boxTypeFocusUnderlineOpacity

  • get boxTypeFocusUnderlineOpacity(): number

  • Gets or sets the color to use for the underline element when type is box.

    Returns number

  • set boxTypeFocusUnderlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

boxTypeFocusUnderlineRippleOpacity

  • get boxTypeFocusUnderlineRippleOpacity(): number

  • Gets or sets the opacity to use for the underline ripple element when focused when type is box.

    Returns number

  • set boxTypeFocusUnderlineRippleOpacity(v): void

  • Parameters

    • v: number

    Returns void

boxTypeHoverUnderlineColor

  • get boxTypeHoverUnderlineColor(): string

  • Gets or sets the color to use for the underline element when type is box.

    Returns string

  • set boxTypeHoverUnderlineColor(v): void

  • Parameters

    • v: string

    Returns void

boxTypeHoverUnderlineOpacity

  • get boxTypeHoverUnderlineOpacity(): number

  • Gets or sets the color to use for the underline element when type is box.

    Returns number

  • set boxTypeHoverUnderlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

boxTypeHoverUnderlineWidth

  • get boxTypeHoverUnderlineWidth(): number

  • Gets or sets the width to use for the underline element when hovered when type is box.

    Returns number

  • set boxTypeHoverUnderlineWidth(v): void

  • Parameters

    • v: number

    Returns void

boxTypeUnderlineColor

  • get boxTypeUnderlineColor(): string

  • Gets or sets the color to use for the underline element when type is box.

    Returns string

  • set boxTypeUnderlineColor(v): void

  • Parameters

    • v: string

    Returns void

boxTypeUnderlineOpacity

  • get boxTypeUnderlineOpacity(): number

  • Gets or sets the color to use for the underline element when type is box.

    Returns number

  • set boxTypeUnderlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

boxTypeUnderlineRippleColor

  • get boxTypeUnderlineRippleColor(): string

  • Gets or sets the color to use for the underline ripple element when type is box.

    Returns string

  • set boxTypeUnderlineRippleColor(v): void

  • Parameters

    • v: string

    Returns void

boxTypeUnderlineRippleOpacity

  • get boxTypeUnderlineRippleOpacity(): number

  • Gets or sets the opacity to use for the underline ripple element when type is box.

    Returns number

  • set boxTypeUnderlineRippleOpacity(v): void

  • Parameters

    • v: number

    Returns void

boxTypeUnderlineRippleWidth

  • get boxTypeUnderlineRippleWidth(): number

  • Gets or sets the width to use for the underline element when type is box.

    Returns number

  • set boxTypeUnderlineRippleWidth(v): void

  • Parameters

    • v: number

    Returns void

boxTypeUnderlineWidth

  • get boxTypeUnderlineWidth(): number

  • Gets or sets the width to use for the underline element when type is box.

    Returns number

  • set boxTypeUnderlineWidth(v): void

  • Parameters

    • v: number

    Returns void

contentPaddingBottom

  • get contentPaddingBottom(): number

  • Returns number

  • set contentPaddingBottom(v): void

  • Parameters

    • v: number

    Returns void

contentPaddingLeft

  • get contentPaddingLeft(): number

  • Returns number

  • set contentPaddingLeft(v): void

  • Parameters

    • v: number

    Returns void

contentPaddingRight

  • get contentPaddingRight(): number

  • Returns number

  • set contentPaddingRight(v): void

  • Parameters

    • v: number

    Returns void

contentPaddingTop

  • get contentPaddingTop(): number

  • 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 input 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(): InputGroupDisplayType

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

    Returns InputGroupDisplayType

  • set displayType(v): void

  • Parameters

    Returns void

focusBorderColor

  • get focusBorderColor(): string

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

    Returns string

  • set focusBorderColor(v): void

  • Parameters

    • v: string

    Returns void

focusBorderWidth

  • get focusBorderWidth(): number

  • Gets or sets the border width to use for the border of the item group when focused.

    Returns number

  • set focusBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

focusUnderlineColor

  • get focusUnderlineColor(): string

  • Gets or sets the color to use for the underline element.

    Returns string

  • set focusUnderlineColor(v): void

  • Parameters

    • v: string

    Returns void

focusUnderlineOpacity

  • get focusUnderlineOpacity(): number

  • Gets or sets the color to use for the underline element.

    Returns number

  • set focusUnderlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

focusUnderlineRippleOpacity

  • get focusUnderlineRippleOpacity(): number

  • Gets or sets the opacity to use for the underline ripple element when focused.

    Returns number

  • set focusUnderlineRippleOpacity(v): void

  • Parameters

    • v: number

    Returns void

hoverUnderlineColor

  • get hoverUnderlineColor(): string

  • Gets or sets the color to use for the underline element.

    Returns string

  • set hoverUnderlineColor(v): void

  • Parameters

    • v: string

    Returns void

hoverUnderlineOpacity

  • get hoverUnderlineOpacity(): number

  • Gets or sets the color to use for the underline element.

    Returns number

  • set hoverUnderlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

hoverUnderlineWidth

  • get hoverUnderlineWidth(): number

  • Gets or sets the width to use for the underline element when hovered.

    Returns number

  • set hoverUnderlineWidth(v): void

  • Parameters

    • v: number

    Returns void

i

  • get i(): XInputGroup

  • Returns XInputGroup

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

inputHasValue

  • get inputHasValue(): boolean

  • Returns boolean

inputs

isExpanded

  • get isExpanded(): boolean

  • Gets or sets whether the input group is expanded or not.

    Returns boolean

  • set isExpanded(v): void

  • Parameters

    • v: boolean

    Returns void

isFocused

  • get isFocused(): boolean

  • Gets or sets whether the input group is hovered or not.

    Returns boolean

  • set isFocused(v): void

  • Parameters

    • v: boolean

    Returns void

isHovered

  • get isHovered(): boolean

  • Gets or sets whether the input group is hovered or not.

    Returns boolean

  • set isHovered(v): void

  • Parameters

    • v: boolean

    Returns void

lineTypeBackgroundColor

  • get lineTypeBackgroundColor(): string

  • Gets or sets the background color to use for the input group when type is line.

    Returns string

  • set lineTypeBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

lineTypeBorderColor

  • get lineTypeBorderColor(): string

  • Gets or sets the color to use the border of the input group when type is line.

    Returns string

  • set lineTypeBorderColor(v): void

  • Parameters

    • v: string

    Returns void

lineTypeBorderWidth

  • get lineTypeBorderWidth(): number

  • Gets or sets the border width to use for the border of the item group when using type line.

    Returns number

  • set lineTypeBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

lineTypeContentPaddingBottom

  • get lineTypeContentPaddingBottom(): number

  • Returns number

  • set lineTypeContentPaddingBottom(v): void

  • Parameters

    • v: number

    Returns void

lineTypeContentPaddingLeft

  • get lineTypeContentPaddingLeft(): number

  • Returns number

  • set lineTypeContentPaddingLeft(v): void

  • Parameters

    • v: number

    Returns void

lineTypeContentPaddingRight

  • get lineTypeContentPaddingRight(): number

  • Returns number

  • set lineTypeContentPaddingRight(v): void

  • Parameters

    • v: number

    Returns void

lineTypeContentPaddingTop

  • get lineTypeContentPaddingTop(): number

  • Returns number

  • set lineTypeContentPaddingTop(v): void

  • Parameters

    • v: number

    Returns void

lineTypeCornerRadiusBottomLeft

  • get lineTypeCornerRadiusBottomLeft(): number

  • Returns number

  • set lineTypeCornerRadiusBottomLeft(v): void

  • Parameters

    • v: number

    Returns void

lineTypeCornerRadiusBottomRight

  • get lineTypeCornerRadiusBottomRight(): number

  • Returns number

  • set lineTypeCornerRadiusBottomRight(v): void

  • Parameters

    • v: number

    Returns void

lineTypeCornerRadiusTopLeft

  • get lineTypeCornerRadiusTopLeft(): number

  • Returns number

  • set lineTypeCornerRadiusTopLeft(v): void

  • Parameters

    • v: number

    Returns void

lineTypeCornerRadiusTopRight

  • get lineTypeCornerRadiusTopRight(): number

  • Returns number

  • set lineTypeCornerRadiusTopRight(v): void

  • Parameters

    • v: number

    Returns void

lineTypeFocusBorderColor

  • get lineTypeFocusBorderColor(): string

  • Gets or sets the focus color to use the border of the input group when type is line.

    Returns string

  • set lineTypeFocusBorderColor(v): void

  • Parameters

    • v: string

    Returns void

lineTypeFocusBorderWidth

  • get lineTypeFocusBorderWidth(): number

  • Gets or sets the border width to use for the border of the item group when focused when type is line.

    Returns number

  • set lineTypeFocusBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

lineTypeFocusUnderlineColor

  • get lineTypeFocusUnderlineColor(): string

  • Gets or sets the color to use for the underline element when type is line.

    Returns string

  • set lineTypeFocusUnderlineColor(v): void

  • Parameters

    • v: string

    Returns void

lineTypeFocusUnderlineOpacity

  • get lineTypeFocusUnderlineOpacity(): number

  • Gets or sets the color to use for the underline element when type is line.

    Returns number

  • set lineTypeFocusUnderlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

lineTypeFocusUnderlineRippleOpacity

  • get lineTypeFocusUnderlineRippleOpacity(): number

  • Gets or sets the opacity to use for the underline ripple element when focused when type is line.

    Returns number

  • set lineTypeFocusUnderlineRippleOpacity(v): void

  • Parameters

    • v: number

    Returns void

lineTypeHoverUnderlineColor

  • get lineTypeHoverUnderlineColor(): string

  • Gets or sets the color to use for the underline element when type is line.

    Returns string

  • set lineTypeHoverUnderlineColor(v): void

  • Parameters

    • v: string

    Returns void

lineTypeHoverUnderlineOpacity

  • get lineTypeHoverUnderlineOpacity(): number

  • Gets or sets the color to use for the underline element when type is line.

    Returns number

  • set lineTypeHoverUnderlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

lineTypeHoverUnderlineWidth

  • get lineTypeHoverUnderlineWidth(): number

  • Gets or sets the width to use for the underline element when hovered when type is line.

    Returns number

  • set lineTypeHoverUnderlineWidth(v): void

  • Parameters

    • v: number

    Returns void

lineTypeUnderlineColor

  • get lineTypeUnderlineColor(): string

  • Gets or sets the color to use for the underline element when type is line.

    Returns string

  • set lineTypeUnderlineColor(v): void

  • Parameters

    • v: string

    Returns void

lineTypeUnderlineOpacity

  • get lineTypeUnderlineOpacity(): number

  • Gets or sets the color to use for the underline element when type is line.

    Returns number

  • set lineTypeUnderlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

lineTypeUnderlineRippleColor

  • get lineTypeUnderlineRippleColor(): string

  • Gets or sets the color to use for the underline ripple element when type is line.

    Returns string

  • set lineTypeUnderlineRippleColor(v): void

  • Parameters

    • v: string

    Returns void

lineTypeUnderlineRippleOpacity

  • get lineTypeUnderlineRippleOpacity(): number

  • Gets or sets the opacity to use for the underline ripple element when type is line.

    Returns number

  • set lineTypeUnderlineRippleOpacity(v): void

  • Parameters

    • v: number

    Returns void

lineTypeUnderlineRippleWidth

  • get lineTypeUnderlineRippleWidth(): number

  • Gets or sets the width to use for the underline element when type is line.

    Returns number

  • set lineTypeUnderlineRippleWidth(v): void

  • Parameters

    • v: number

    Returns void

lineTypeUnderlineWidth

  • get lineTypeUnderlineWidth(): number

  • Gets or sets the width to use for the underline element when type is line.

    Returns number

  • set lineTypeUnderlineWidth(v): void

  • Parameters

    • v: number

    Returns void

searchTypeBackgroundColor

  • get searchTypeBackgroundColor(): string

  • Gets or sets the background color to use for the input group when type is search.

    Returns string

  • set searchTypeBackgroundColor(v): void

  • Parameters

    • v: string

    Returns void

searchTypeBorderColor

  • get searchTypeBorderColor(): string

  • Gets or sets the color to use the search of the input group when type is search.

    Returns string

  • set searchTypeBorderColor(v): void

  • Parameters

    • v: string

    Returns void

searchTypeBorderWidth

  • get searchTypeBorderWidth(): number

  • Gets or sets the search width to use for the border of the item group when using type line.

    Returns number

  • set searchTypeBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

searchTypeContentPaddingBottom

  • get searchTypeContentPaddingBottom(): number

  • Returns number

  • set searchTypeContentPaddingBottom(v): void

  • Parameters

    • v: number

    Returns void

searchTypeContentPaddingLeft

  • get searchTypeContentPaddingLeft(): number

  • Returns number

  • set searchTypeContentPaddingLeft(v): void

  • Parameters

    • v: number

    Returns void

searchTypeContentPaddingRight

  • get searchTypeContentPaddingRight(): number

  • Returns number

  • set searchTypeContentPaddingRight(v): void

  • Parameters

    • v: number

    Returns void

searchTypeContentPaddingTop

  • get searchTypeContentPaddingTop(): number

  • Returns number

  • set searchTypeContentPaddingTop(v): void

  • Parameters

    • v: number

    Returns void

searchTypeCornerRadiusBottomLeft

  • get searchTypeCornerRadiusBottomLeft(): number

  • Returns number

  • set searchTypeCornerRadiusBottomLeft(v): void

  • Parameters

    • v: number

    Returns void

searchTypeCornerRadiusBottomRight

  • get searchTypeCornerRadiusBottomRight(): number

  • Returns number

  • set searchTypeCornerRadiusBottomRight(v): void

  • Parameters

    • v: number

    Returns void

searchTypeCornerRadiusTopLeft

  • get searchTypeCornerRadiusTopLeft(): number

  • Returns number

  • set searchTypeCornerRadiusTopLeft(v): void

  • Parameters

    • v: number

    Returns void

searchTypeCornerRadiusTopRight

  • get searchTypeCornerRadiusTopRight(): number

  • Returns number

  • set searchTypeCornerRadiusTopRight(v): void

  • Parameters

    • v: number

    Returns void

searchTypeFocusBorderColor

  • get searchTypeFocusBorderColor(): string

  • Gets or sets the focus color to use the search of the input group when type is search.

    Returns string

  • set searchTypeFocusBorderColor(v): void

  • Parameters

    • v: string

    Returns void

searchTypeFocusBorderWidth

  • get searchTypeFocusBorderWidth(): number

  • Gets or sets the search width to use for the border of the item group when focused when type is search.

    Returns number

  • set searchTypeFocusBorderWidth(v): void

  • Parameters

    • v: number

    Returns void

searchTypeFocusUnderlineColor

  • get searchTypeFocusUnderlineColor(): string

  • Gets or sets the color to use for the underline element when type is search.

    Returns string

  • set searchTypeFocusUnderlineColor(v): void

  • Parameters

    • v: string

    Returns void

searchTypeFocusUnderlineOpacity

  • get searchTypeFocusUnderlineOpacity(): number

  • Gets or sets the color to use for the underline element when type is search.

    Returns number

  • set searchTypeFocusUnderlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

searchTypeFocusUnderlineRippleOpacity

  • get searchTypeFocusUnderlineRippleOpacity(): number

  • Gets or sets the opacity to use for the underline ripple element when focused when type is search.

    Returns number

  • set searchTypeFocusUnderlineRippleOpacity(v): void

  • Parameters

    • v: number

    Returns void

searchTypeHoverUnderlineColor

  • get searchTypeHoverUnderlineColor(): string

  • Gets or sets the color to use for the underline element when type is search.

    Returns string

  • set searchTypeHoverUnderlineColor(v): void

  • Parameters

    • v: string

    Returns void

searchTypeHoverUnderlineOpacity

  • get searchTypeHoverUnderlineOpacity(): number

  • Gets or sets the color to use for the underline element when type is search.

    Returns number

  • set searchTypeHoverUnderlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

searchTypeHoverUnderlineWidth

  • get searchTypeHoverUnderlineWidth(): number

  • Gets or sets the width to use for the underline element when hovered when type is search.

    Returns number

  • set searchTypeHoverUnderlineWidth(v): void

  • Parameters

    • v: number

    Returns void

searchTypeUnderlineColor

  • get searchTypeUnderlineColor(): string

  • Gets or sets the color to use for the underline element when type is search.

    Returns string

  • set searchTypeUnderlineColor(v): void

  • Parameters

    • v: string

    Returns void

searchTypeUnderlineOpacity

  • get searchTypeUnderlineOpacity(): number

  • Gets or sets the color to use for the underline element when type is search.

    Returns number

  • set searchTypeUnderlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

searchTypeUnderlineRippleColor

  • get searchTypeUnderlineRippleColor(): string

  • Gets or sets the color to use for the underline ripple element when type is search.

    Returns string

  • set searchTypeUnderlineRippleColor(v): void

  • Parameters

    • v: string

    Returns void

searchTypeUnderlineRippleOpacity

  • get searchTypeUnderlineRippleOpacity(): number

  • Gets or sets the opacity to use for the underline ripple element when type is search.

    Returns number

  • set searchTypeUnderlineRippleOpacity(v): void

  • Parameters

    • v: number

    Returns void

searchTypeUnderlineRippleWidth

  • get searchTypeUnderlineRippleWidth(): number

  • Gets or sets the width to use for the underline element when type is search.

    Returns number

  • set searchTypeUnderlineRippleWidth(v): void

  • Parameters

    • v: number

    Returns void

searchTypeUnderlineWidth

  • get searchTypeUnderlineWidth(): number

  • Gets or sets the width to use for the underline element when type is search.

    Returns number

  • set searchTypeUnderlineWidth(v): void

  • Parameters

    • v: number

    Returns void

underlineColor

  • get underlineColor(): string

  • Gets or sets the color to use for the underline element.

    Returns string

  • set underlineColor(v): void

  • Parameters

    • v: string

    Returns void

underlineOpacity

  • get underlineOpacity(): number

  • Gets or sets the color to use for the underline element.

    Returns number

  • set underlineOpacity(v): void

  • Parameters

    • v: number

    Returns void

underlineRippleColor

  • get underlineRippleColor(): string

  • Gets or sets the color to use for the underline ripple element.

    Returns string

  • set underlineRippleColor(v): void

  • Parameters

    • v: string

    Returns void

underlineRippleOpacity

  • get underlineRippleOpacity(): number

  • Gets or sets the opacity to use for the underline ripple element.

    Returns number

  • set underlineRippleOpacity(v): void

  • Parameters

    • v: number

    Returns void

underlineRippleWidth

  • get underlineRippleWidth(): number

  • Gets or sets the width to use for the underline element.

    Returns number

  • set underlineRippleWidth(v): void

  • Parameters

    • v: number

    Returns void

underlineWidth

  • get underlineWidth(): number

  • Gets or sets the width to use for the underline element.

    Returns number

  • set underlineWidth(v): void

  • Parameters

    • v: number

    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

    Returns void

Optional componentWillMount

Optional componentWillReceiveProps

componentWillUnmount

  • Returns void

Optional componentWillUpdate

destroy

  • Returns void

ensureActualContentPadding

  • Returns void

ensureActualCornerRadius

  • Returns void

ensureBorderTypeContentPadding

  • Returns void

ensureBorderTypeCornerRadius

  • Returns void

ensureBoxTypeContentPadding

  • Returns void

ensureBoxTypeCornerRadius

  • Returns void

ensureContentPadding

  • Returns void

ensureCornerRadius

  • Returns void

ensureLineTypeContentPadding

  • Returns void

ensureLineTypeCornerRadius

  • Returns void

ensureSearchTypeContentPadding

  • Returns void

ensureSearchTypeCornerRadius

  • 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