Class IgrXLabel

Hierarchy

IgrXInputGroupItem<IIgrXLabelProps & React.HTMLAttributes<HTMLElement>>
- IgrXLabel

Constructors

constructor

new IgrXLabel(props): IgrXLabel
Overrides IgrXInputGroupItem.constructor
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:19
Parameters
- props: IIgrXLabelProps & HTMLAttributes<HTMLElement>
Returns IgrXLabel

Properties

context

context: any

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

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

See

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

`Readonly` props

props: Readonly<IIgrXLabelProps & HTMLAttributes<HTMLElement>> & 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
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:51
Gets the actual display density to use for the label.

Returns ControlDisplayDensity
set actualDensity(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:52
Parameters
- v: ControlDisplayDensity
Returns void

actualHighlightTextColor

get actualHighlightTextColor(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:61
Gets the actual color to use for the text color.

Returns string
set actualHighlightTextColor(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:62
Parameters
- v: string
Returns void

actualHoverHighlightTextColor

get actualHoverHighlightTextColor(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:66
Gets the actual color to use for the text color when highlighted and hovered.

Returns string
set actualHoverHighlightTextColor(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:67
Parameters
- v: string
Returns void

actualHoverTextColor

get actualHoverTextColor(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:71
Gets the actual hover color to use for the text.

Returns string
set actualHoverTextColor(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:72
Parameters
- v: string
Returns void

actualTextColor

get actualTextColor(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:56
Gets the actual color to use for the text color.

Returns string
set actualTextColor(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:57
Parameters
- v: string
Returns void

alignItems

get alignItems(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:121
Gets or sets the id to use for the checkbox.

Returns string
set alignItems(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:122
Parameters
- v: string
Returns void

alignSelf

get alignSelf(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:126
Gets or sets the id to use for the checkbox.

Returns string
set alignSelf(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:127
Parameters
- v: string
Returns void

ariaLabel

get ariaLabel(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:141
Gets or sets the value of the aria-label attribute.

Returns string
set ariaLabel(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:142
Parameters
- v: string
Returns void

baseTheme

get baseTheme(): BaseControlTheme
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:41
Gets or sets the base built in theme to use for the label.

Returns BaseControlTheme
set baseTheme(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:42
Parameters
- v: BaseControlTheme
Returns void

density

get density(): ControlDisplayDensity
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:46
Gets or sets the display density to use for the label.

Returns ControlDisplayDensity
set density(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:47
Parameters
- v: ControlDisplayDensity
Returns void

disabled

get disabled(): boolean
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:161
Gets or sets whether the checkbox is disabled.

Returns boolean
set disabled(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:162
Parameters
- v: boolean
Returns void

display

get display(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:106
Gets or sets the id to use for the checkbox.

Returns string
set display(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:107
Parameters
- v: string
Returns void

flexDirection

get flexDirection(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:111
Gets or sets the id to use for the checkbox.

Returns string
set flexDirection(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:112
Parameters
- v: string
Returns void

flexGrow

get flexGrow(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:116
Gets or sets the flex-grow setting for the button.

Returns string
set flexGrow(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:117
Parameters
- v: string
Returns void

for

get for(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:136
Gets or sets the for attribute to use for the label.

Returns string
set for(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:137
Parameters
- v: string
Returns void

highlightTextColor

get highlightTextColor(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:81
Gets or sets the color to use for the text.

Returns string
set highlightTextColor(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:82
Parameters
- v: string
Returns void

hoverHighlightTextColor

get hoverHighlightTextColor(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:86
Gets or sets the color to use for the text.

Returns string
set hoverHighlightTextColor(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:87
Parameters
- v: string
Returns void

hoverTextColor

get hoverTextColor(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:96
Gets or sets the color to use for the hovered text of the button regardless of type.

Returns string
set hoverTextColor(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:97
Parameters
- v: string
Returns void

id

get id(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:101
Gets or sets the id to use for the checkbox.

Returns string
set id(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:102
Parameters
- v: string
Returns void

isHover

get isHover(): boolean
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:151
Gets or sets whether the label is hovered.

Returns boolean
set isHover(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:152
Parameters
- v: boolean
Returns void

name

get name(): string
Inherited from IgrXInputGroupItem.name
- Defined in dist/igniteui-react-inputs/lib/igr-x-input-group-item.d.ts:25
Gets or sets name to use for the button.

Returns string
set name(v): void
Inherited from IgrXInputGroupItem.name
- Defined in dist/igniteui-react-inputs/lib/igr-x-input-group-item.d.ts:26
Parameters
- v: string
Returns void

nativeElement

get nativeElement(): HTMLElement
Inherited from IgrXInputGroupItem.nativeElement
- Defined in dist/igniteui-react-inputs/lib/igr-x-input-group-item.d.ts:8
Returns HTMLElement

tabIndex

get tabIndex(): number
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:131
Gets or sets TabIndex to use for the checkbox.

Returns number
set tabIndex(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:132
Parameters
- v: number
Returns void

text

get text(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:146
Gets or sets the text for the label.

Returns string
set text(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:147
Parameters
- v: string
Returns void

textColor

get textColor(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:76
Gets or sets the color to use for the text.

Returns string
set textColor(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:77
Parameters
- v: string
Returns void

textStyle

get textStyle(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:91
Gets or sets the use for the button.

Returns string
set textStyle(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:92
Parameters
- v: string
Returns void

value

get value(): boolean
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:156
Gets or sets the value for the label.

Returns boolean
set value(v): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:157
Parameters
- v: boolean
Returns void

Methods

`Optional` UNSAFE_componentWillMount

UNSAFE_componentWillMount(): void
Inherited from IgrXInputGroupItem.UNSAFE_componentWillMount
- Defined in node_modules/@types/react/index.d.ts:708
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
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Returns void

`Optional` UNSAFE_componentWillReceiveProps

UNSAFE_componentWillReceiveProps(nextProps, nextContext): void
Inherited from IgrXInputGroupItem.UNSAFE_componentWillReceiveProps
- Defined in node_modules/@types/react/index.d.ts:740
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
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters
- nextProps: Readonly<IIgrXLabelProps & HTMLAttributes<HTMLElement>>
- nextContext: any
Returns void

`Optional` UNSAFE_componentWillUpdate

UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void
Inherited from IgrXInputGroupItem.UNSAFE_componentWillUpdate
- Defined in node_modules/@types/react/index.d.ts:768
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
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters
- nextProps: Readonly<IIgrXLabelProps & HTMLAttributes<HTMLElement>>
- nextState: Readonly<{}>
- nextContext: any
Returns void

`Optional` componentDidCatch

componentDidCatch(error, errorInfo): void
Inherited from IgrXInputGroupItem.componentDidCatch
- Defined in node_modules/@types/react/index.d.ts:637
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 IgrXInputGroupItem.componentDidMount
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:25
Returns void

`Optional` componentDidUpdate

componentDidUpdate(prevProps, prevState, snapshot?): void
Inherited from IgrXInputGroupItem.componentDidUpdate
- Defined in node_modules/@types/react/index.d.ts:679
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<IIgrXLabelProps & HTMLAttributes<HTMLElement>>
- prevState: Readonly<{}>
- Optional snapshot: any
Returns void

`Optional` componentWillMount

componentWillMount(): void
Inherited from IgrXInputGroupItem.componentWillMount
- Defined in node_modules/@types/react/index.d.ts:694
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
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Returns void

`Optional` componentWillReceiveProps

componentWillReceiveProps(nextProps, nextContext): void
Inherited from IgrXInputGroupItem.componentWillReceiveProps
- Defined in node_modules/@types/react/index.d.ts:723
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
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters
- nextProps: Readonly<IIgrXLabelProps & HTMLAttributes<HTMLElement>>
- nextContext: any
Returns void

componentWillUnmount

componentWillUnmount(): void
Overrides IgrXInputGroupItem.componentWillUnmount
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:24
Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

Returns void

`Optional` componentWillUpdate

componentWillUpdate(nextProps, nextState, nextContext): void
Inherited from IgrXInputGroupItem.componentWillUpdate
- Defined in node_modules/@types/react/index.d.ts:753
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
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters
- nextProps: Readonly<IIgrXLabelProps & HTMLAttributes<HTMLElement>>
- nextState: Readonly<{}>
- nextContext: any
Returns void

destroy

destroy(): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:23
Returns void

exportSerializedVisualModel

exportSerializedVisualModel(): string
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:174
Returns a serialized copy of the exported visual model

Returns string

exportVisualModel

exportVisualModel(): any
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:169
Exports visual information about the current state of the grid.

Returns any

findByName

findByName(name): any
Inherited from IgrXInputGroupItem.findByName
- Defined in dist/igniteui-react-inputs/lib/igr-x-input-group-item.d.ts:27
Parameters
- name: string
Returns any

forceUpdate

forceUpdate(callback?): void
Inherited from IgrXInputGroupItem.forceUpdate
- Defined in node_modules/@types/react/index.d.ts:489
Parameters
- Optional callback: (() => void)
  - - (): void
    - Returns void
Returns void

`Optional` getSnapshotBeforeUpdate

getSnapshotBeforeUpdate(prevProps, prevState): any
Inherited from IgrXInputGroupItem.getSnapshotBeforeUpdate
- Defined in node_modules/@types/react/index.d.ts:673
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<IIgrXLabelProps & HTMLAttributes<HTMLElement>>
- prevState: Readonly<{}>
Returns any

initializeContent

initializeContent(): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:26
Returns void

onAttachedToUI

onAttachedToUI(): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:164
Returns void

onDetachedFromUI

onDetachedFromUI(): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:163
Returns void

render

render(): DetailedReactHTMLElement<{
    children: any[];
    className: string;
    ref: ((ref) => void);
}, any>
Overrides IgrXInputGroupItem.render
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:13
Returns DetailedReactHTMLElement<{
    children: any[];
    className: string;
    ref: ((ref) => void);
}, any>

setState

setState<K>(state, callback?): void
Inherited from IgrXInputGroupItem.setState
- Defined in node_modules/@types/react/index.d.ts:484
Type parameters
Type Parameters
- K extends never
Parameters
- state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
- Optional callback: (() => void)
  - - (): void
    - Returns void
Returns void

shouldComponentUpdate

shouldComponentUpdate(nextProps, nextState): boolean
Overrides IgrXInputGroupItem.shouldComponentUpdate
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:20
Parameters
- nextProps: any
- nextState: any
Returns boolean

updateStyle

updateStyle(): void
- Defined in dist/igniteui-react-inputs/lib/igr-x-label.d.ts:22
Returns void

`Static` _createFromInternal

_createFromInternal(internal): IgrXInputGroupItem<IIgrXInputGroupItemProps>
Inherited from IgrXInputGroupItem._createFromInternal
- Defined in dist/igniteui-react-inputs/lib/igr-x-input-group-item.d.ts:15
Parameters
- internal: any
Returns IgrXInputGroupItem<IIgrXInputGroupItemProps>

Class IgrXLabel

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

props: IIgrXLabelProps & HTMLAttributes<HTMLElement>

Returns IgrXLabel

Properties

context

See

Readonly props

refs

Deprecated

Type declaration

[key: string]: ReactInstance

state

Static Optional contextType

See

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

alignItems

Returns string

Parameters

v: string

Returns void

alignSelf

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

`Readonly` props

`Static` `Optional` contextType