Class IgrLabel<SS>

Type parameters

  • SS

Hierarchy

Constructors

constructor

Accessors

actualDensity

  • get actualDensity(): ControlDisplayDensity
  • set actualDensity(v: ControlDisplayDensity): void
  • Gets the actual display density to use for the label.

    Returns ControlDisplayDensity

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

    Parameters

    • v: ControlDisplayDensity

    Returns void

actualHighlightTextColor

  • get actualHighlightTextColor(): string
  • set actualHighlightTextColor(v: string): void
  • Gets the actual color to use for the text color.

    Returns string

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

    Parameters

    • v: string

    Returns void

actualHoverHighlightTextColor

  • get actualHoverHighlightTextColor(): string
  • set actualHoverHighlightTextColor(v: string): void
  • Gets the actual color to use for the text color when highlighted and hovered.

    Returns string

  • Gets the actual color to use for the text color when highlighted and hovered.

    Parameters

    • v: string

    Returns void

actualHoverTextColor

  • get actualHoverTextColor(): string
  • set actualHoverTextColor(v: string): void
  • Gets the actual hover color to use for the text.

    Returns string

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

    Parameters

    • v: string

    Returns void

actualTextColor

  • get actualTextColor(): string
  • set actualTextColor(v: string): void
  • Gets the actual color to use for the text color.

    Returns string

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

    Parameters

    • v: string

    Returns void

actualTextStyle

  • get actualTextStyle(): FontInfo
  • set actualTextStyle(v: FontInfo): void
  • Gets the text style to use for the button.

    Returns FontInfo

  • Gets the text style to use for the button.

    Parameters

    • v: FontInfo

    Returns void

alignItems

  • get alignItems(): string
  • set alignItems(v: string): void
  • Gets or sets the id to use for the checkbox.

    Returns string

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

    Parameters

    • v: string

    Returns void

ariaLabel

  • get ariaLabel(): string
  • set ariaLabel(v: string): void
  • Gets or sets the value of the aria-label attribute.

    Returns string

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

    Parameters

    • v: string

    Returns void

baseTheme

  • get baseTheme(): BaseControlTheme
  • set baseTheme(v: BaseControlTheme): void
  • Gets or sets the base built in theme to use for the label.

    Returns BaseControlTheme

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

    Parameters

    • v: BaseControlTheme

    Returns void

density

  • get density(): ControlDisplayDensity
  • set density(v: ControlDisplayDensity): void
  • Gets or sets the display density to use for the label.

    Returns ControlDisplayDensity

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

    Parameters

    • v: ControlDisplayDensity

    Returns void

disabled

  • get disabled(): boolean
  • set disabled(v: boolean): void
  • Gets or sets whether the checkbox is disabled.

    Returns boolean

  • Gets or sets whether the checkbox is disabled.

    Parameters

    • v: boolean

    Returns void

display

  • get display(): string
  • set display(v: string): void
  • Gets or sets the id to use for the checkbox.

    Returns string

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

    Parameters

    • v: string

    Returns void

flexDirection

  • get flexDirection(): string
  • set flexDirection(v: string): void
  • Gets or sets the id to use for the checkbox.

    Returns string

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

    Parameters

    • v: string

    Returns void

flexGrow

  • get flexGrow(): string
  • set flexGrow(v: string): void
  • Gets or sets the flex-grow setting for the button.

    Returns string

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

    Parameters

    • v: string

    Returns void

for

  • get for(): string
  • set for(v: string): void
  • Gets or sets the for attribute to use for the label.

    Returns string

  • Gets or sets the for attribute to use for the label.

    Parameters

    • v: string

    Returns void

highlightTextColor

  • get highlightTextColor(): string
  • set highlightTextColor(v: string): void
  • Gets or sets the color to use for the text.

    Returns string

  • Gets or sets the color to use for the text.

    Parameters

    • v: string

    Returns void

hoverHighlightTextColor

  • get hoverHighlightTextColor(): string
  • set hoverHighlightTextColor(v: string): void
  • Gets or sets the color to use for the text.

    Returns string

  • Gets or sets the color to use for the text.

    Parameters

    • v: string

    Returns void

hoverTextColor

  • get hoverTextColor(): string
  • set hoverTextColor(v: string): void
  • Gets or sets the color to use for the hovered text of the button regardless of type.

    Returns string

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

    Parameters

    • v: string

    Returns void

id

  • get id(): string
  • set id(v: string): void
  • Gets or sets the id to use for the checkbox.

    Returns string

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

    Parameters

    • v: string

    Returns void

isHover

  • get isHover(): boolean
  • set isHover(v: boolean): void
  • Gets or sets whether the label is hovered.

    Returns boolean

  • Gets or sets whether the label is hovered.

    Parameters

    • v: boolean

    Returns void

name

  • get name(): string
  • set name(v: string): void
  • Gets or sets name to use for the button.

    Returns string

  • Gets or sets name to use for the button.

    Parameters

    • v: string

    Returns void

tabIndex

  • get tabIndex(): number
  • set tabIndex(v: number): void
  • Gets or sets TabIndex to use for the checkbox.

    Returns number

  • Gets or sets TabIndex to use for the checkbox.

    Parameters

    • v: number

    Returns void

text

  • get text(): string
  • set text(v: string): void
  • Gets or sets the text for the label.

    Returns string

  • Gets or sets the text for the label.

    Parameters

    • v: string

    Returns void

textColor

  • get textColor(): string
  • set textColor(v: string): void
  • Gets or sets the color to use for the text.

    Returns string

  • Gets or sets the color to use for the text.

    Parameters

    • v: string

    Returns void

textStyle

  • get textStyle(): FontInfo
  • set textStyle(v: FontInfo): void
  • Gets or sets the use for the button.

    Returns FontInfo

  • Gets or sets the use for the button.

    Parameters

    • v: FontInfo

    Returns void

type

  • get type(): string
  • set type(v: string): void
  • Gets or sets the type to use for the label.

    Returns string

  • Gets or sets the type to use for the label.

    Parameters

    • v: string

    Returns void

value

  • get value(): boolean
  • set value(v: boolean): void
  • Gets or sets the value for the label.

    Returns boolean

  • Gets or sets the value for the label.

    Parameters

    • v: boolean

    Returns void

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IIgrLabelProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IIgrLabelProps>, nextState: Readonly<__type>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<IIgrLabelProps>, prevState: Readonly<__type>, snapshot?: SS): void
  • 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<IIgrLabelProps>
    • prevState: Readonly<__type>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IIgrLabelProps>, nextContext: any): void

componentWillUnmount

  • componentWillUnmount(): void
  • Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IIgrLabelProps>, nextState: Readonly<__type>, nextContext: any): void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IIgrLabelProps>, prevState: Readonly<__type>): SS | null
  • 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 SS | null

initializeContent

  • initializeContent(): void
  • Returns void

onAttachedToUI

  • onAttachedToUI(): void
  • Returns void

onDetachedFromUI

  • onDetachedFromUI(): void
  • Returns void

render

  • render(): DetailedReactHTMLElement<object, any>
  • Returns DetailedReactHTMLElement<object, any>

shouldComponentUpdate

  • shouldComponentUpdate(nextProps: any, nextState: any): boolean

updateStyle

  • updateStyle(): void
  • Returns void

Static _createFromInternal