Skip to main content

Class: abstract AbstractComponent<P, S, SS>

Defined in: packages/react-page-renderer/src/component/AbstractComponent.ts:10

The base class for all view components.

Extends​

  • Component<P, S, SS>

Type Parameters​

• P = unknown

• S = unknown

• SS = unknown

Constructors​

new AbstractComponent()​

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

Defined in: node_modules/@types/react/index.d.ts:1015

Parameters​

props​

P

Returns​

AbstractComponent<P, S, SS>

Inherited from​

Component<P, S, SS>.constructor

new AbstractComponent()​

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

Defined in: node_modules/@types/react/index.d.ts:1020

Parameters​

props​

P

context​

any

Returns​

AbstractComponent<P, S, SS>

Deprecated​

See​

React Docs

Inherited from​

Component<P, S, SS>.constructor

Properties​

context​

context: PageContextType

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

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.

Example​

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​

React Docs

Overrides​

Component.context

props​

readonly props: Readonly<P>

Defined in: node_modules/@types/react/index.d.ts:1033

Inherited from​

Component.props

refs​

refs: object

Defined in: node_modules/@types/react/index.d.ts:1040

Index Signature​

[key: string]: ReactInstance

Deprecated​

See​

Legacy React Docs

Inherited from​

Component.refs

state​

state: Readonly<S>

Defined in: node_modules/@types/react/index.d.ts:1034

Inherited from​

Component.state

contextType​

static contextType: Context<PageContextType> = PageContext

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

If set, this.context will be set at runtime to the current value of the given Context.

Example​

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://react.dev/reference/react/Component#static-contexttype

Overrides​

Component.contextType

Accessors​

utils​

Get Signature​

get utils(): Utils

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

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.

Methods​

componentDidCatch()?​

optional componentDidCatch(error, errorInfo): void

Defined in: node_modules/@types/react/index.d.ts:1397

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

Parameters​

error​

Error

errorInfo​

ErrorInfo

Returns​

void

Inherited from​

Component.componentDidCatch

componentDidMount()?​

optional componentDidMount(): void

Defined in: node_modules/@types/react/index.d.ts:1376

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

Returns​

void

Inherited from​

Component.componentDidMount

componentDidUpdate()?​

optional componentDidUpdate(prevProps, prevState, snapshot?): void

Defined in: node_modules/@types/react/index.d.ts:1439

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<P>

prevState​

Readonly<S>

snapshot?​

SS

Returns​

void

Inherited from​

Component.componentDidUpdate

componentWillMount()?​

optional componentWillMount(): void

Defined in: node_modules/@types/react/index.d.ts:1455

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 StaticLifecycle.getDerivedStateFromProps 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

componentWillReceiveProps()?​

optional componentWillReceiveProps(nextProps, nextContext): void

Defined in: node_modules/@types/react/index.d.ts:1486

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 StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters​

nextProps​

Readonly<P>

nextContext​

any

Returns​

void

Deprecated​

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

See​

Inherited from​

Component.componentWillReceiveProps

componentWillUnmount()?​

optional componentWillUnmount(): void

Defined in: node_modules/@types/react/index.d.ts:1392

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

componentWillUpdate()?​

optional componentWillUpdate(nextProps, nextState, nextContext): void

Defined in: node_modules/@types/react/index.d.ts:1518

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 StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters​

nextProps​

Readonly<P>

nextState​

Readonly<S>

nextContext​

any

Returns​

void

Deprecated​

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

See​

Inherited from​

Component.componentWillUpdate

cssClasses()​

cssClasses(classRules, includeComponentClassName): string

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

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

Parameters​

classRules​

CSS 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.

string | {} | string[]

includeComponentClassName​

boolean = false

Returns​

string

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

Examples​

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

fire()​

fire(eventTarget, eventName, data?): void

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

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

Parameters​

eventTarget​

EventTarget

EventTarget compatible node.

eventName​

string

The name of the event.

data?​

any

Data to send within the event.

Returns​

void

forceUpdate()​

forceUpdate(callback?): void

Defined in: node_modules/@types/react/index.d.ts:1030

Parameters​

callback?​

() => void

Returns​

void

Inherited from​

Component.forceUpdate

getSnapshotBeforeUpdate()?​

optional getSnapshotBeforeUpdate(prevProps, prevState): null | SS

Defined in: node_modules/@types/react/index.d.ts:1433

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 this method prevents any of the deprecated lifecycle events from running.

Parameters​

prevProps​

Readonly<P>

prevState​

Readonly<S>

Returns​

null | SS

Inherited from​

Component.getSnapshotBeforeUpdate

link(name, params): string

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

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​

name​

string

The route name.

params​

Router parameters and extraneous parameters to add to the URL as a query string.

Returns​

string

The generated URL.

listen()​

listen(eventTarget, eventName, listener): void

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

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​

eventTarget​

EventTarget

The react component or event target at which the listener should listen for the event.

eventName​

string

The name of the event for which to listen.

listener​

(event) => void

The listener for event to register.

Returns​

void

localize()​

localize(key, params): string

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

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

Parameters​

key​

never

Localization key.

params​

Values for replacing the placeholders in the localization phrase.

Returns​

string

Localized phrase.

render()​

render(): ReactNode

Defined in: node_modules/@types/react/index.d.ts:1031

Returns​

ReactNode

Inherited from​

Component.render

setState()​

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

Defined in: node_modules/@types/react/index.d.ts:1025

Type Parameters​

• K extends string | number | symbol

Parameters​

state​

null | S | (prevState, props) => null | S | Pick<S, K> | Pick<S, K>

callback?​

() => void

Returns​

void

Inherited from​

Component.setState

shouldComponentUpdate()?​

optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

Defined in: node_modules/@types/react/index.d.ts:1387

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​

nextProps​

Readonly<P>

nextState​

Readonly<S>

nextContext​

any

Returns​

boolean

Inherited from​

Component.shouldComponentUpdate

unlisten()​

unlisten(eventTarget, eventName, listener): void

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

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

Parameters​

eventTarget​

EventTarget

The react component or event target at which the listener should listen for the event.

eventName​

string

The name of the event for which to listen.

listener​

(event) => void

The listener for event to register.

Returns​

void

UNSAFE_componentWillMount()?​

optional UNSAFE_componentWillMount(): void

Defined in: node_modules/@types/react/index.d.ts:1470

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 StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Returns​

void

Deprecated​

16.3, use componentDidMount or the constructor instead

See​

Inherited from​

Component.UNSAFE_componentWillMount

UNSAFE_componentWillReceiveProps()?​

optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

Defined in: node_modules/@types/react/index.d.ts:1504

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 StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters​

nextProps​

Readonly<P>

nextContext​

any

Returns​

void

Deprecated​

16.3, use static StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps instead

See​

Inherited from​

Component.UNSAFE_componentWillReceiveProps

UNSAFE_componentWillUpdate()?​

optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

Defined in: node_modules/@types/react/index.d.ts:1534

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 StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters​

nextProps​

Readonly<P>

nextState​

Readonly<S>

nextContext​

any

Returns​

void

Deprecated​

16.3, use getSnapshotBeforeUpdate instead

See​

Inherited from​

Component.UNSAFE_componentWillUpdate