Class: AbstractPureComponent<P, S, SS>
@ima/react-page-renderer.AbstractPureComponent
The base class for all view components.
Type parameters
Name | Type |
---|---|
P | unknown |
S | unknown |
SS | unknown |
Hierarchy
PureComponent
<P
,S
,SS
>↳
AbstractPureComponent
Constructors
constructor
• new AbstractPureComponent<P
, S
, SS
>(props
)
Type parameters
Name | Type |
---|---|
P | unknown |
S | unknown |
SS | unknown |
Parameters
Name | Type |
---|---|
props | P | Readonly <P > |
Inherited from
PureComponent<P, S, SS>.constructor
Defined in
node_modules/@types/react/ts5.0/index.d.ts:451
• new AbstractPureComponent<P
, S
, SS
>(props
, context
)
Deprecated
See
https://legacy.reactjs.org/docs/legacy-context.html
Type parameters
Name | Type |
---|---|
P | unknown |
S | unknown |
SS | unknown |
Parameters
Name | Type |
---|---|
props | P |
context | any |
Inherited from
PureComponent<P, S, SS>.constructor
Defined in
node_modules/@types/react/ts5.0/index.d.ts:456
Properties
_utils
• Private
Optional
_utils: Utils
Defined in
packages/react-page-renderer/src/component/AbstractPureComponent.ts:18
context
• context: PageContextType
Overrides
PureComponent.context
Defined in
packages/react-page-renderer/src/component/AbstractPureComponent.ts:16
props
• Readonly
props: Readonly
<P
>
Inherited from
PureComponent.props
Defined in
node_modules/@types/react/ts5.0/index.d.ts:469
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
PureComponent.refs
Defined in
node_modules/@types/react/ts5.0/index.d.ts:475
state
• state: Readonly
<S
>
Inherited from
PureComponent.state
Defined in
node_modules/@types/react/ts5.0/index.d.ts:470
contextType
▪ Static
contextType: Context
<PageContextType
> = PageContext
Overrides
PureComponent.contextType
Defined in
packages/react-page-renderer/src/component/AbstractPureComponent.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/AbstractPureComponent.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.
Deprecated
16.3, use componentDidMount or the constructor instead
See
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Returns
void
Inherited from
PureComponent.UNSAFE_componentWillMount
Defined in
node_modules/@types/react/ts5.0/index.d.ts:666
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.
Deprecated
16.3, use static getDerivedStateFromProps instead
See
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters
Name | Type |
---|---|
nextProps | Readonly <P > |
nextContext | any |
Returns
void
Inherited from
PureComponent.UNSAFE_componentWillReceiveProps
Defined in
node_modules/@types/react/ts5.0/index.d.ts:698
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.
Deprecated
16.3, use getSnapshotBeforeUpdate instead
See
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters
Name | Type |
---|---|
nextProps | Readonly <P > |
nextState | Readonly <S > |
nextContext | any |
Returns
void
Inherited from
PureComponent.UNSAFE_componentWillUpdate
Defined in
node_modules/@types/react/ts5.0/index.d.ts:726
componentDidCatch
▸ Optional
componentDidCatch(error
, errorInfo
): void
Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.
Parameters
Name | Type |
---|---|
error | Error |
errorInfo | ErrorInfo |
Returns
void
Inherited from
PureComponent.componentDidCatch
Defined in
node_modules/@types/react/ts5.0/index.d.ts:595
componentDidMount
▸ Optional
componentDidMount(): void
Called immediately after a component is mounted. Setting state here will trigger re-rendering.
Returns
void
Inherited from
PureComponent.componentDidMount
Defined in
node_modules/@types/react/ts5.0/index.d.ts:574
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
Name | Type |
---|---|
prevProps | Readonly <P > |
prevState | Readonly <S > |
snapshot? | SS |
Returns
void
Inherited from
PureComponent.componentDidUpdate
Defined in
node_modules/@types/react/ts5.0/index.d.ts:637
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.
Deprecated
16.3, use componentDidMount or the constructor instead; will stop working in React 17
See
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Returns
void
Inherited from
PureComponent.componentWillMount
Defined in
node_modules/@types/react/ts5.0/index.d.ts:652
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.
Deprecated
16.3, use static getDerivedStateFromProps instead; will stop working in React 17
See
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters
Name | Type |
---|---|
nextProps | Readonly <P > |
nextContext | any |
Returns
void
Inherited from
PureComponent.componentWillReceiveProps
Defined in
node_modules/@types/react/ts5.0/index.d.ts:681
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
PureComponent.componentWillUnmount
Defined in
node_modules/@types/react/ts5.0/index.d.ts:590
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.
Deprecated
16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17
See
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters
Name | Type |
---|---|
nextProps | Readonly <P > |
nextState | Readonly <S > |
nextContext | any |
Returns
void
Inherited from
PureComponent.componentWillUpdate
Defined in
node_modules/@types/react/ts5.0/index.d.ts:711
cssClasses
▸ cssClasses(classRules
, includeComponentClassName?
): string
Generate a string of CSS classes from the properties of the passed-in object that resolve to true.
Example
this.cssClasses('my-class my-class-modifier', true);
Example
this.cssClasses({
'my-class': true,
'my-class-modifier': this.props.modifier
}, true);
Parameters
Name | Type | Default value | Description |
---|---|---|---|
classRules | string | { [key: string] : boolean ; } | undefined | 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 . |
includeComponentClassName | boolean | false | - |
Returns
string
String of CSS classes that had their property resolved
to true
.
Defined in
packages/react-page-renderer/src/component/AbstractPureComponent.ts:86
fire
▸ fire(eventTarget
, eventName
, data?
): void
Creates and sends a new IMA.js DOM custom event from this component.
Parameters
Name | Type | Description |
---|---|---|
eventTarget | EventTarget | EventTarget compatible node. |
eventName | string | The name of the event. |
data? | any | Data to send within the event. |
Returns
void
Defined in
packages/react-page-renderer/src/component/AbstractPureComponent.ts:100
forceUpdate
▸ forceUpdate(callback?
): void
Parameters
Name | Type |
---|---|
callback? | () => void |
Returns
void
Inherited from
PureComponent.forceUpdate
Defined in
node_modules/@types/react/ts5.0/index.d.ts:466
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
Name | Type |
---|---|
prevProps | Readonly <P > |
prevState | Readonly <S > |
Returns
null
| SS
Inherited from
PureComponent.getSnapshotBeforeUpdate
Defined in
node_modules/@types/react/ts5.0/index.d.ts:631
link
▸ 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
Name | Type | Description |
---|---|---|
name | string | The route name. |
params | Object | Router 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/AbstractPureComponent.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
Name | Type | Description |
---|---|---|
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 : Event ) => void | The listener for event to register. |
Returns
void
Defined in
packages/react-page-renderer/src/component/AbstractPureComponent.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
Name | Type | Description |
---|---|---|
key | never | Localization key. |
params | Object | Values for replacing the placeholders in the localization phrase. |
Returns
string
Localized phrase.
Defined in
packages/react-page-renderer/src/component/AbstractPureComponent.ts:44
render
▸ render(): ReactNode
Returns
ReactNode
Inherited from
PureComponent.render
Defined in
node_modules/@types/react/ts5.0/index.d.ts:467
setState
▸ setState<K
>(state
, callback?
): void
Type parameters
Name | Type |
---|---|
K | extends string | number | symbol |
Parameters
Name | Type |
---|---|
state | null | S | (prevState : Readonly <S >, props : Readonly <P >) => null | S | Pick <S , K > | Pick <S , K > |
callback? | () => void |
Returns
void
Inherited from
PureComponent.setState
Defined in
node_modules/@types/react/ts5.0/index.d.ts:461
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
Name | Type |
---|---|
nextProps | Readonly <P > |
nextState | Readonly <S > |
nextContext | any |
Returns
boolean
Inherited from
PureComponent.shouldComponentUpdate
Defined in
node_modules/@types/react/ts5.0/index.d.ts:585
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
Name | Type | Description |
---|---|---|
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 : Event ) => void | The listener for event to register. |
Returns
void
Defined in
packages/react-page-renderer/src/component/AbstractPureComponent.ts:131