Class IgrLabel<SS>

Type parameters

Hierarchy

IgrInputGroupItem<IIgrLabelProps>
- IgrLabel

Constructors

constructor

Methods

Constructors

constructor

new IgrLabel(props: IIgrLabelProps): IgrLabel

Overrides IgrInputGroupItem.constructor
- Defined in igniteui-inputs/lib/igr-label.ts:52
Parameters
- props: IIgrLabelProps
Returns IgrLabel

Accessors

actualDensity

get actualDensity(): ControlDisplayDensity
set actualDensity(v: ControlDisplayDensity): void

- Defined in igniteui-inputs/lib/igr-label.ts:192
Gets the actual display density to use for the label.

Returns ControlDisplayDensity
- Defined in igniteui-inputs/lib/igr-label.ts:195
Gets the actual display density to use for the label.

Parameters
- v: ControlDisplayDensity
Returns void

actualHighlightTextColor

get actualHighlightTextColor(): string
set actualHighlightTextColor(v: string): void

- Defined in igniteui-inputs/lib/igr-label.ts:210
Gets the actual color to use for the text color.

Returns string
- Defined in igniteui-inputs/lib/igr-label.ts:213
Gets the actual color to use for the text color.

Parameters
- v: string
Returns void

actualHoverHighlightTextColor

get actualHoverHighlightTextColor(): string
set actualHoverHighlightTextColor(v: string): void

- Defined in igniteui-inputs/lib/igr-label.ts:219
Gets the actual color to use for the text color when highlighted and hovered.

Returns string
- Defined in igniteui-inputs/lib/igr-label.ts:222
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

- Defined in igniteui-inputs/lib/igr-label.ts:228
Gets the actual hover color to use for the text.

Returns string
- Defined in igniteui-inputs/lib/igr-label.ts:231
Gets the actual hover color to use for the text.

Parameters
- v: string
Returns void

actualTextColor

get actualTextColor(): string
set actualTextColor(v: string): void

- Defined in igniteui-inputs/lib/igr-label.ts:201
Gets the actual color to use for the text color.

Returns string
- Defined in igniteui-inputs/lib/igr-label.ts:204
Gets the actual color to use for the text color.

Parameters
- v: string
Returns void

actualTextStyle

get actualTextStyle(): FontInfo
set actualTextStyle(v: FontInfo): void

- Defined in igniteui-inputs/lib/igr-label.ts:237
Gets the text style to use for the button.

Returns FontInfo
- Defined in igniteui-inputs/lib/igr-label.ts:240
Gets the text style to use for the button.

Parameters
- v: FontInfo
Returns void

alignItems

get alignItems(): string
set alignItems(v: string): void

- Defined in igniteui-inputs/lib/igr-label.ts:336
Gets or sets the id to use for the checkbox.

Returns string
- Defined in igniteui-inputs/lib/igr-label.ts:339
Gets or sets the id to use for the checkbox.

Parameters
- v: string
Returns void

ariaLabel

get ariaLabel(): string
set ariaLabel(v: string): void

- Defined in igniteui-inputs/lib/igr-label.ts:363
Gets or sets the value of the aria-label attribute.

Returns string
- Defined in igniteui-inputs/lib/igr-label.ts:366
Gets or sets the value of the aria-label attribute.

Parameters
- v: string
Returns void

baseTheme

get baseTheme(): BaseControlTheme
set baseTheme(v: BaseControlTheme): void

- Defined in igniteui-inputs/lib/igr-label.ts:174
Gets or sets the base built in theme to use for the label.

Returns BaseControlTheme
- Defined in igniteui-inputs/lib/igr-label.ts:177
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

- Defined in igniteui-inputs/lib/igr-label.ts:183
Gets or sets the display density to use for the label.

Returns ControlDisplayDensity
- Defined in igniteui-inputs/lib/igr-label.ts:186
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

- Defined in igniteui-inputs/lib/igr-label.ts:399
Gets or sets whether the checkbox is disabled.

Returns boolean
- Defined in igniteui-inputs/lib/igr-label.ts:402
Gets or sets whether the checkbox is disabled.

Parameters
- v: boolean
Returns void

display

get display(): string
set display(v: string): void

- Defined in igniteui-inputs/lib/igr-label.ts:309
Gets or sets the id to use for the checkbox.

Returns string
- Defined in igniteui-inputs/lib/igr-label.ts:312
Gets or sets the id to use for the checkbox.

Parameters
- v: string
Returns void

flexDirection

get flexDirection(): string
set flexDirection(v: string): void

- Defined in igniteui-inputs/lib/igr-label.ts:318
Gets or sets the id to use for the checkbox.

Returns string
- Defined in igniteui-inputs/lib/igr-label.ts:321
Gets or sets the id to use for the checkbox.

Parameters
- v: string
Returns void

flexGrow

get flexGrow(): string
set flexGrow(v: string): void

- Defined in igniteui-inputs/lib/igr-label.ts:327
Gets or sets the flex-grow setting for the button.

Returns string
- Defined in igniteui-inputs/lib/igr-label.ts:330
Gets or sets the flex-grow setting for the button.

Parameters
- v: string
Returns void

for

get for(): string
set for(v: string): void

- Defined in igniteui-inputs/lib/igr-label.ts:354
Gets or sets the for attribute to use for the label.

Returns string
- Defined in igniteui-inputs/lib/igr-label.ts:357
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

- Defined in igniteui-inputs/lib/igr-label.ts:255
Gets or sets the color to use for the text.

Returns string
- Defined in igniteui-inputs/lib/igr-label.ts:258
Gets or sets the color to use for the text.

Parameters
- v: string
Returns void

hoverHighlightTextColor

get hoverHighlightTextColor(): string
set hoverHighlightTextColor(v: string): void

- Defined in igniteui-inputs/lib/igr-label.ts:264
Gets or sets the color to use for the text.

Returns string
- Defined in igniteui-inputs/lib/igr-label.ts:267
Gets or sets the color to use for the text.

Parameters
- v: string
Returns void

hoverTextColor

get hoverTextColor(): string
set hoverTextColor(v: string): void

- Defined in igniteui-inputs/lib/igr-label.ts:291
Gets or sets the color to use for the hovered text of the button regardless of type.

Returns string
- Defined in igniteui-inputs/lib/igr-label.ts:294
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

- Defined in igniteui-inputs/lib/igr-label.ts:300
Gets or sets the id to use for the checkbox.

Returns string
- Defined in igniteui-inputs/lib/igr-label.ts:303
Gets or sets the id to use for the checkbox.

Parameters
- v: string
Returns void

isHover

get isHover(): boolean
set isHover(v: boolean): void

- Defined in igniteui-inputs/lib/igr-label.ts:381
Gets or sets whether the label is hovered.

Returns boolean
- Defined in igniteui-inputs/lib/igr-label.ts:384
Gets or sets whether the label is hovered.

Parameters
- v: boolean
Returns void

name

get name(): string
set name(v: string): void

Inherited from IgrInputGroupItem.name
- Defined in igniteui-inputs/lib/igr-input-group-item.ts:79
Gets or sets name to use for the button.

Returns string
Inherited from IgrInputGroupItem.name
- Defined in igniteui-inputs/lib/igr-input-group-item.ts:82
Gets or sets name to use for the button.

Parameters
- v: string
Returns void

tabIndex

get tabIndex(): number
set tabIndex(v: number): void

- Defined in igniteui-inputs/lib/igr-label.ts:345
Gets or sets TabIndex to use for the checkbox.

Returns number
- Defined in igniteui-inputs/lib/igr-label.ts:348
Gets or sets TabIndex to use for the checkbox.

Parameters
- v: number
Returns void

text

get text(): string
set text(v: string): void

- Defined in igniteui-inputs/lib/igr-label.ts:372
Gets or sets the text for the label.

Returns string
- Defined in igniteui-inputs/lib/igr-label.ts:375
Gets or sets the text for the label.

Parameters
- v: string
Returns void

textColor

get textColor(): string
set textColor(v: string): void

- Defined in igniteui-inputs/lib/igr-label.ts:246
Gets or sets the color to use for the text.

Returns string
- Defined in igniteui-inputs/lib/igr-label.ts:249
Gets or sets the color to use for the text.

Parameters
- v: string
Returns void

textStyle

get textStyle(): FontInfo
set textStyle(v: FontInfo): void

- Defined in igniteui-inputs/lib/igr-label.ts:273
Gets or sets the use for the button.

Returns FontInfo
- Defined in igniteui-inputs/lib/igr-label.ts:276
Gets or sets the use for the button.

Parameters
- v: FontInfo
Returns void

type

get type(): string
set type(v: string): void

- Defined in igniteui-inputs/lib/igr-label.ts:282
Gets or sets the type to use for the label.

Returns string
- Defined in igniteui-inputs/lib/igr-label.ts:285
Gets or sets the type to use for the label.

Parameters
- v: string
Returns void

value

get value(): boolean
set value(v: boolean): void

- Defined in igniteui-inputs/lib/igr-label.ts:390
Gets or sets the value for the label.

Returns boolean
- Defined in igniteui-inputs/lib/igr-label.ts:393
Gets or sets the value for the label.

Parameters
- v: boolean
Returns void

Methods

Optional UNSAFE_componentWillMount

UNSAFE_componentWillMount(): void

Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount
- Defined in E:/Work/6/1996/src/XPlatform/2020.1/Source/RBuild/node_modules/@types/react/index.d.ts:647
Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use componentDidMount or the constructor instead

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns void

Optional UNSAFE_componentWillReceiveProps

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

Inherited from DeprecatedLifecycle.UNSAFE_componentWillReceiveProps
- Defined in E:/Work/6/1996/src/XPlatform/2020.1/Source/RBuild/node_modules/@types/react/index.d.ts:679
Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use static getDerivedStateFromProps instead

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters
- nextProps: Readonly<IIgrLabelProps>
- nextContext: any
Returns void

Optional UNSAFE_componentWillUpdate

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

Inherited from DeprecatedLifecycle.UNSAFE_componentWillUpdate
- Defined in E:/Work/6/1996/src/XPlatform/2020.1/Source/RBuild/node_modules/@types/react/index.d.ts:707
Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use getSnapshotBeforeUpdate instead

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters
- nextProps: Readonly<IIgrLabelProps>
- nextState: Readonly<__type>
- nextContext: any
Returns void

Optional componentDidCatch

componentDidCatch(error: Error, errorInfo: ErrorInfo): void

Inherited from ComponentLifecycle.componentDidCatch
- Defined in E:/Work/6/1996/src/XPlatform/2020.1/Source/RBuild/node_modules/@types/react/index.d.ts:576
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

Overrides IgrInputGroupItem.componentDidMount
- Defined in igniteui-inputs/lib/igr-label.ts:130
Returns void

Optional componentDidUpdate

componentDidUpdate(prevProps: Readonly<IIgrLabelProps>, prevState: Readonly<__type>, snapshot?: SS): void

Inherited from NewLifecycle.componentDidUpdate
- Defined in E:/Work/6/1996/src/XPlatform/2020.1/Source/RBuild/node_modules/@types/react/index.d.ts:618
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

Inherited from DeprecatedLifecycle.componentWillMount
- Defined in E:/Work/6/1996/src/XPlatform/2020.1/Source/RBuild/node_modules/@types/react/index.d.ts:633
Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use componentDidMount or the constructor instead; will stop working in React 17

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns void

Optional componentWillReceiveProps

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

Inherited from DeprecatedLifecycle.componentWillReceiveProps
- Defined in E:/Work/6/1996/src/XPlatform/2020.1/Source/RBuild/node_modules/@types/react/index.d.ts:662
Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use static getDerivedStateFromProps instead; will stop working in React 17

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters
- nextProps: Readonly<IIgrLabelProps>
- nextContext: any
Returns void

componentWillUnmount

componentWillUnmount(): void

Overrides ComponentLifecycle.componentWillUnmount
- Defined in igniteui-inputs/lib/igr-label.ts:124
Returns void

Optional componentWillUpdate

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

Inherited from DeprecatedLifecycle.componentWillUpdate
- Defined in E:/Work/6/1996/src/XPlatform/2020.1/Source/RBuild/node_modules/@types/react/index.d.ts:692
Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters
- nextProps: Readonly<IIgrLabelProps>
- nextState: Readonly<__type>
- nextContext: any
Returns void

Optional getSnapshotBeforeUpdate

getSnapshotBeforeUpdate(prevProps: Readonly<IIgrLabelProps>, prevState: Readonly<__type>): SS | null

Inherited from NewLifecycle.getSnapshotBeforeUpdate
- Defined in E:/Work/6/1996/src/XPlatform/2020.1/Source/RBuild/node_modules/@types/react/index.d.ts:612
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
- prevProps: Readonly<IIgrLabelProps>
- prevState: Readonly<__type>
Returns SS | null

initializeContent

initializeContent(): void

- Defined in igniteui-inputs/lib/igr-label.ts:135
Returns void

onAttachedToUI

onAttachedToUI(): void

- Defined in igniteui-inputs/lib/igr-label.ts:411
Returns void

onDetachedFromUI

onDetachedFromUI(): void

- Defined in igniteui-inputs/lib/igr-label.ts:408
Returns void

render

render(): DetailedReactHTMLElement<object, any>

Overrides IgrInputGroupItem.render
- Defined in igniteui-inputs/lib/igr-label.ts:28
Returns DetailedReactHTMLElement<object, any>

shouldComponentUpdate

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

Overrides IgrInputGroupItem.shouldComponentUpdate
- Defined in igniteui-inputs/lib/igr-label.ts:100
Parameters
- nextProps: any
- nextState: any
Returns boolean

updateStyle

updateStyle(): void

- Defined in igniteui-inputs/lib/igr-label.ts:120
Returns void

Static _createFromInternal

_createFromInternal(internal: any): IgrInputGroupItem

Inherited from IgrInputGroupItem._createFromInternal
- Defined in igniteui-inputs/lib/igr-input-group-item.ts:27
Parameters
- internal: any
Returns IgrInputGroupItem

Class IgrLabel<SS>

Type parameters

SS

Hierarchy

Constructors

Accessors

Methods

Constructors

constructor

Parameters

props: IIgrLabelProps

Returns IgrLabel

Accessors

actualDensity

Returns ControlDisplayDensity

Parameters

v: ControlDisplayDensity

Returns void

actualHighlightTextColor

Returns string

Parameters

v: string

Returns void

actualHoverHighlightTextColor

Returns string

Parameters

v: string

Returns void

actualHoverTextColor

Returns string

Parameters

v: string

Returns void

actualTextColor

Returns string

Parameters

v: string

Returns void

actualTextStyle

Returns FontInfo

Parameters

v: FontInfo

Returns void

alignItems

Returns string

Parameters

v: string

Returns void

ariaLabel

Returns string

Parameters

v: string

Returns void

baseTheme

Returns BaseControlTheme

Parameters

v: BaseControlTheme

Returns void

density

Returns ControlDisplayDensity

Parameters

v: ControlDisplayDensity

Returns void

disabled

Returns boolean

Parameters

v: boolean

Returns void

display

Returns string

Parameters

v: string

Returns void

flexDirection

Returns string

Parameters

v: string

Returns void

flexGrow

Returns string