Class IgrXExpansionPanel

Hierarchy

Component<IIgrXExpansionPanelProps>
- IgrXExpansionPanel

Constructors

Properties

Constructors

constructor

new IgrXExpansionPanel(props): IgrXExpansionPanel
Overrides React.Component<IIgrXExpansionPanelProps>.constructor
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:31
Parameters
- props: IIgrXExpansionPanelProps
Returns IgrXExpansionPanel

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

actualAmbientShadowColor

get actualAmbientShadowColor(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:139
Gets or sets the color to use for the check mark when the checkbox is checked.

Returns string
set actualAmbientShadowColor(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:140
Parameters
- v: string
Returns void

actualCaptionTextColor

get actualCaptionTextColor(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:54
Gets or sets the color to use for the actual header caption text.

Returns string
set actualCaptionTextColor(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:55
Parameters
- v: string
Returns void

actualDescriptionTextColor

get actualDescriptionTextColor(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:79
Gets or sets the color to use for the actual header description text.

Returns string
set actualDescriptionTextColor(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:80
Parameters
- v: string
Returns void

actualElevation

get actualElevation(): number
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:99
Gets or sets the elevation of the border shadow

Returns number
set actualElevation(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:100
Parameters
- v: number
Returns void

actualHeaderBackgroundColor

get actualHeaderBackgroundColor(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:114
Gets or sets the color to use for the actual background of the header.

Returns string
set actualHeaderBackgroundColor(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:115
Parameters
- v: string
Returns void

actualPenumbraShadowColor

get actualPenumbraShadowColor(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:134
Gets or sets the color to use for the check mark when the checkbox is checked.

Returns string
set actualPenumbraShadowColor(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:135
Parameters
- v: string
Returns void

actualUmbraShadowColor

get actualUmbraShadowColor(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:129
Gets or sets the color to use for the check mark when the checkbox is checked.

Returns string
set actualUmbraShadowColor(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:130
Parameters
- v: string
Returns void

caption

get caption(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:44
Gets / sets the caption to display in the header area.

Returns string
set caption(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:45
Parameters
- v: string
Returns void

captionCollapsedTextColor

get captionCollapsedTextColor(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:59
Gets or sets the color to use for the header caption text when the panel is collapsed.

Returns string
set captionCollapsedTextColor(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:60
Parameters
- v: string
Returns void

captionExpandedTextColor

get captionExpandedTextColor(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:64
Gets or sets the color to use for the header caption text when the panel is expanded.

Returns string
set captionExpandedTextColor(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:65
Parameters
- v: string
Returns void

captionTextColor

get captionTextColor(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:49
Gets or sets the color to use for the header caption text.

Returns string
set captionTextColor(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:50
Parameters
- v: string
Returns void

description

get description(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:69
Gets / sets the description to display in the header area.

Returns string
set description(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:70
Parameters
- v: string
Returns void

descriptionCollapsedTextColor

get descriptionCollapsedTextColor(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:84
Gets or sets the color to use for the header description text when the panel is collapsed.

Returns string
set descriptionCollapsedTextColor(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:85
Parameters
- v: string
Returns void

descriptionExpandedTextColor

get descriptionExpandedTextColor(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:89
Gets or sets the color to use for the header description text when the panel is expanded.

Returns string
set descriptionExpandedTextColor(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:90
Parameters
- v: string
Returns void

descriptionTextColor

get descriptionTextColor(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:74
Gets or sets the color to use for the header description text.

Returns string
set descriptionTextColor(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:75
Parameters
- v: string
Returns void

elevation

get elevation(): number
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:94
Gets or sets the elevation to use for the button regardless of type.

Returns number
set elevation(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:95
Parameters
- v: number
Returns void

expanded

get expanded(): boolean
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:104
Gets / sets the expanded state of the panel.

Returns boolean
set expanded(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:105
Parameters
- v: boolean
Returns void

headerBackgroundColor

get headerBackgroundColor(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:109
Gets or sets the color to use for the background of the header.

Returns string
set headerBackgroundColor(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:110
Parameters
- v: string
Returns void

headerCollapsedBackgroundColor

get headerCollapsedBackgroundColor(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:119
Gets or sets the color to use for the background of the header when the panel is expanded.

Returns string
set headerCollapsedBackgroundColor(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:120
Parameters
- v: string
Returns void

headerExpandedBackgroundColor

get headerExpandedBackgroundColor(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:124
Gets or sets the color to use for the background of the header when the panel is expanded.

Returns string
set headerExpandedBackgroundColor(v): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:125
Parameters
- v: string
Returns void

height

get height(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:17
Returns string
set height(value): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:16
Parameters
- value: string
Returns void

i

get i(): XExpansionPanel
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:40
Returns XExpansionPanel

onCollapsed

get onCollapsed(): ((s, e) => void)
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:170
Fires when the expansion panel is collapsed.

Returns ((s, e) => void)
- - (s, e): void
  - Fires when the expansion panel is collapsed.
    
    Parameters
    - s: IgrXExpansionPanel
    - e: IgrOnCollapsedEventArgs
    Returns void
set onCollapsed(ev): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:171
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgrXExpansionPanel
      - e: IgrOnCollapsedEventArgs
      Returns void
Returns void

onExpanded

get onExpanded(): ((s, e) => void)
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:174
Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgrXExpansionPanel
    - e: IgrOnExpandedEventArgs
    Returns void
set onExpanded(ev): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:175
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgrXExpansionPanel
      - e: IgrOnExpandedEventArgs
      Returns void
Returns void

width

get width(): string
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:19
Returns string
set width(value): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:18
Parameters
- value: string
Returns void

Methods

`Optional` UNSAFE_componentWillMount

UNSAFE_componentWillMount(): void
Inherited from React.Component.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 React.Component.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<IIgrXExpansionPanelProps>
- nextContext: any
Returns void

`Optional` UNSAFE_componentWillUpdate

UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void
Inherited from React.Component.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<IIgrXExpansionPanelProps>
- nextState: Readonly<{}>
- nextContext: any
Returns void

collapse

collapse(): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:154
Collapses the contents of the expansion panel.

Returns void

`Optional` componentDidCatch

componentDidCatch(error, errorInfo): void
Inherited from React.Component.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 React.Component.componentDidMount
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:37
Returns void

`Optional` componentDidUpdate

componentDidUpdate(prevProps, prevState, snapshot?): void
Inherited from React.Component.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<IIgrXExpansionPanelProps>
- prevState: Readonly<{}>
- Optional snapshot: any
Returns void

`Optional` componentWillMount

componentWillMount(): void
Inherited from React.Component.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 React.Component.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<IIgrXExpansionPanelProps>
- nextContext: any
Returns void

componentWillUnmount

componentWillUnmount(): void
Overrides React.Component.componentWillUnmount
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:36
Returns void

`Optional` componentWillUpdate

componentWillUpdate(nextProps, nextState, nextContext): void
Inherited from React.Component.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<IIgrXExpansionPanelProps>
- nextState: Readonly<{}>
- nextContext: any
Returns void

destroy

destroy(): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:35
Returns void

expand

expand(): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:159
Expands the contents of the expansion panel.

Returns void

findByName

findByName(name): any
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:141
Parameters
- name: string
Returns any

forceUpdate

forceUpdate(callback?): void
Inherited from React.Component.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 React.Component.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<IIgrXExpansionPanelProps>
- prevState: Readonly<{}>
Returns any

initializeContent

initializeContent(): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:38
Returns void

render

render(): DetailedReactHTMLElement<{
    children: any[];
    className: string;
    ref: ((ref) => void);
}, any>
Overrides React.Component.render
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:25
Returns DetailedReactHTMLElement<{
    children: any[];
    className: string;
    ref: ((ref) => void);
}, any>

setState

setState<K>(state, callback?): void
Inherited from React.Component.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 React.Component.shouldComponentUpdate
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:32
Parameters
- nextProps: any
- nextState: any
Returns boolean

toggle

toggle(): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:164
Toggles the expanded state of the expansion panel.

Returns void

updateStyle

updateStyle(): void
- Defined in dist/igniteui-react-layouts/lib/igr-x-expansion-panel.d.ts:34
Returns void

Class IgrXExpansionPanel

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

props: IIgrXExpansionPanelProps

Returns IgrXExpansionPanel

Properties

context

See

Readonly props

refs

Deprecated

Type declaration

[key: string]: ReactInstance

state

Static Optional contextType

See

Accessors

actualAmbientShadowColor

Returns string

Parameters

v: string

Returns void

actualCaptionTextColor

Returns string

Parameters

v: string

Returns void

actualDescriptionTextColor

Returns string

Parameters

v: string

Returns void

actualElevation

Returns number

Parameters

v: number

Returns void

actualHeaderBackgroundColor

Returns string

Parameters

v: string

Returns void

actualPenumbraShadowColor

Returns string

Parameters

v: string

Returns void

actualUmbraShadowColor

Returns string

Parameters

v: string

Returns void

caption

Returns string

Parameters

v: string

Returns void

captionCollapsedTextColor

Returns string

Parameters

v: string

Returns void

captionExpandedTextColor

Returns string

Parameters

v: string

Returns void

captionTextColor

Returns string

Parameters

v: string

Returns void

description

`Readonly` props

`Static` `Optional` contextType