Skip to main content

Class: AbstractComponent<P, S, SS>

@ima/react-page-renderer.AbstractComponent

The base class for all view components.

Type parameters

NameType
Punknown
Sunknown
SSunknown

Hierarchy

  • Component<P, S, SS>

    AbstractComponent

Constructors

constructor

new AbstractComponent<P, S, SS>(props)

Type parameters

NameType
Punknown
Sunknown
SSunknown

Parameters

NameType
propsP | Readonly<P>

Inherited from

Component<P, S, SS>.constructor

Defined in

node_modules/@types/react/index.d.ts:515

new AbstractComponent<P, S, SS>(props, context)

Type parameters

NameType
Punknown
Sunknown
SSunknown

Parameters

NameType
propsP
contextany

Deprecated

See

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

Inherited from

Component<P, S, SS>.constructor

Defined in

node_modules/@types/react/index.d.ts:520

Properties

_utils

Private Optional _utils: Utils

Defined in

packages/react-page-renderer/src/component/AbstractComponent.ts:18


context

context: PageContextType

Overrides

Component.context

Defined in

packages/react-page-renderer/src/component/AbstractComponent.ts:16


props

Readonly props: Readonly<P>

Inherited from

Component.props

Defined in

node_modules/@types/react/index.d.ts:533


refs

refs: Object

Deprecated

https://legacy.reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Index signature

[key: string]: ReactInstance

Inherited from

Component.refs

Defined in

node_modules/@types/react/index.d.ts:539


state

state: Readonly<S>

Inherited from

Component.state

Defined in

node_modules/@types/react/index.d.ts:534


contextType

Static contextType: Context<PageContextType> = PageContext

Overrides

Component.contextType

Defined in

packages/react-page-renderer/src/component/AbstractComponent.ts:15

Accessors

utils

get utils(): Utils

Returns the utilities for the view components. The returned value is the value bound to the $Utils object container constant.

Returns

Utils

The utilities for the view components.

Defined in

packages/react-page-renderer/src/component/AbstractComponent.ts:26

Methods

UNSAFE_componentWillMount

Optional UNSAFE_componentWillMount(): void

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.

Returns

void

Deprecated

16.3, use componentDidMount or the constructor instead

See

Inherited from

Component.UNSAFE_componentWillMount

Defined in

node_modules/@types/react/index.d.ts:730


UNSAFE_componentWillReceiveProps

Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

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.

Parameters

NameType
nextPropsReadonly<P>
nextContextany

Returns

void

Deprecated

16.3, use static getDerivedStateFromProps instead

See

Inherited from

Component.UNSAFE_componentWillReceiveProps

Defined in

node_modules/@types/react/index.d.ts:762


UNSAFE_componentWillUpdate

Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

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.

Parameters

NameType
nextPropsReadonly<P>
nextStateReadonly<S>
nextContextany

Returns

void

Deprecated

16.3, use getSnapshotBeforeUpdate instead

See

Inherited from

Component.UNSAFE_componentWillUpdate

Defined in

node_modules/@types/react/index.d.ts:790


componentDidCatch

Optional componentDidCatch(error, errorInfo): void

Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

Parameters

NameType
errorError
errorInfoErrorInfo

Returns

void

Inherited from

Component.componentDidCatch

Defined in

node_modules/@types/react/index.d.ts:659


componentDidMount

Optional componentDidMount(): void

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

Returns

void

Inherited from

Component.componentDidMount

Defined in

node_modules/@types/react/index.d.ts:638


componentDidUpdate

Optional componentDidUpdate(prevProps, prevState, snapshot?): 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

NameType
prevPropsReadonly<P>
prevStateReadonly<S>
snapshot?SS

Returns

void

Inherited from

Component.componentDidUpdate

Defined in

node_modules/@types/react/index.d.ts:701


componentWillMount

Optional componentWillMount(): void

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.

Returns

void

Deprecated

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

See

Inherited from

Component.componentWillMount

Defined in

node_modules/@types/react/index.d.ts:716


componentWillReceiveProps

Optional componentWillReceiveProps(nextProps, nextContext): void

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.

Parameters

NameType
nextPropsReadonly<P>
nextContextany

Returns

void

Deprecated

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

See

Inherited from

Component.componentWillReceiveProps

Defined in

node_modules/@types/react/index.d.ts:745


componentWillUnmount

Optional componentWillUnmount(): void

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

Inherited from

Component.componentWillUnmount

Defined in

node_modules/@types/react/index.d.ts:654


componentWillUpdate

Optional componentWillUpdate(nextProps, nextState, nextContext): void

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.

Parameters

NameType
nextPropsReadonly<P>
nextStateReadonly<S>
nextContextany

Returns

void

Deprecated

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

See

Inherited from

Component.componentWillUpdate

Defined in

node_modules/@types/react/index.d.ts:775


cssClasses

cssClasses(classRules, includeComponentClassName?): string

Generate a string of CSS classes from the properties of the passed-in object that resolve to true.

Parameters

NameTypeDefault valueDescription
classRulesstring | { [key: string]: boolean; } | string[]undefinedCSS classes in a string separated by whitespace, or a map of CSS class names to boolean values. The CSS class name will be included in the result only if the value is true.
includeComponentClassNamebooleanfalse-

Returns

string

String of CSS classes that had their property resolved to true.

Example

this.cssClasses('my-class my-class-modifier', true);

Example

this.cssClasses({
'my-class': true,
'my-class-modifier': this.props.modifier
}, true);

Defined in

packages/react-page-renderer/src/component/AbstractComponent.ts:86


fire

fire(eventTarget, eventName, data?): void

Creates and sends a new IMA.js DOM custom event from this component.

Parameters

NameTypeDescription
eventTargetEventTargetEventTarget compatible node.
eventNamestringThe name of the event.
data?anyData to send within the event.

Returns

void

Defined in

packages/react-page-renderer/src/component/AbstractComponent.ts:100


forceUpdate

forceUpdate(callback?): void

Parameters

NameType
callback?() => void

Returns

void

Inherited from

Component.forceUpdate

Defined in

node_modules/@types/react/index.d.ts:530


getSnapshotBeforeUpdate

Optional getSnapshotBeforeUpdate(prevProps, prevState): null | SS

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

NameType
prevPropsReadonly<P>
prevStateReadonly<S>

Returns

null | SS

Inherited from

Component.getSnapshotBeforeUpdate

Defined in

node_modules/@types/react/index.d.ts:695


link(name, params?): string

Generates an absolute URL using the provided route name (see the

app/config/routes.js file). The provided parameters will replace the placeholders in the route pattern, while the extraneous parameters will be appended to the generated URL's query string.

Parameters

NameTypeDescription
namestringThe route name.
paramsObjectRouter parameters and extraneous parameters to add to the URL as a query string.

Returns

string

The generated URL.

Defined in

packages/react-page-renderer/src/component/AbstractComponent.ts:62


listen

listen(eventTarget, eventName, listener): void

Registers the provided event listener for execution whenever an IMA.js DOM custom event of the specified name occurs at the specified event target.

Parameters

NameTypeDescription
eventTargetEventTargetThe react component or event target at which the listener should listen for the event.
eventNamestringThe name of the event for which to listen.
listener(event: Event) => voidThe listener for event to register.

Returns

void

Defined in

packages/react-page-renderer/src/component/AbstractComponent.ts:114


localize

localize(key, params?): string

Returns the localized phrase identified by the specified key. The placeholders in the localization phrase will be replaced by the provided values.

Parameters

NameTypeDescription
keyneverLocalization key.
paramsObjectValues for replacing the placeholders in the localization phrase.

Returns

string

Localized phrase.

Defined in

packages/react-page-renderer/src/component/AbstractComponent.ts:44


render

render(): ReactNode

Returns

ReactNode

Inherited from

Component.render

Defined in

node_modules/@types/react/index.d.ts:531


setState

setState<K>(state, callback?): void

Type parameters

NameType
Kextends string | number | symbol

Parameters

NameType
statenull | S | (prevState: Readonly<S>, props: Readonly<P>) => null | S | Pick<S, K> | Pick<S, K>
callback?() => void

Returns

void

Inherited from

Component.setState

Defined in

node_modules/@types/react/index.d.ts:525


shouldComponentUpdate

Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

Called to determine whether the change in props and state should trigger a re-render.

Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

Parameters

NameType
nextPropsReadonly<P>
nextStateReadonly<S>
nextContextany

Returns

boolean

Inherited from

Component.shouldComponentUpdate

Defined in

node_modules/@types/react/index.d.ts:649


unlisten

unlisten(eventTarget, eventName, listener): void

Deregisters the provided event listener for an IMA.js DOM custom event of the specified name at the specified event target.

Parameters

NameTypeDescription
eventTargetEventTargetThe react component or event target at which the listener should listen for the event.
eventNamestringThe name of the event for which to listen.
listener(event: Event) => voidThe listener for event to register.

Returns

void

Defined in

packages/react-page-renderer/src/component/AbstractComponent.ts:131