Class: AbstractComponent
@ima/react-page-renderer.AbstractComponent
The base class for all view components.
Hierarchy
Component
↳
AbstractComponent
Constructors
constructor
• new AbstractComponent(props
)
Parameters
Name | Type |
---|---|
props | {} | Readonly <{}> |
Inherited from
Component.constructor
Defined in
node_modules/@types/react/index.d.ts:473
• new AbstractComponent(props
, context
)
Deprecated
See
https://reactjs.org/docs/legacy-context.html
Parameters
Name | Type |
---|---|
props | Object |
context | any |
Inherited from
Component.constructor
Defined in
node_modules/@types/react/index.d.ts:478
Properties
_utils
• Private
Optional
_utils: Utils
Defined in
packages/react-page-renderer/src/component/AbstractComponent.ts:14
context
• context: PageContextInterface
Overrides
Component.context
Defined in
packages/react-page-renderer/src/component/AbstractComponent.ts:12
props
• Readonly
props: Readonly
<{}>
Inherited from
Component.props
Defined in
node_modules/@types/react/index.d.ts:491
refs
• refs: Object
Deprecated
https://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:497
state
• state: Readonly
<{}>
Inherited from
Component.state
Defined in
node_modules/@types/react/index.d.ts:492
contextType
▪ Static
contextType: Context
<PageContextInterface
> = PageContext
Overrides
Component.contextType
Defined in
packages/react-page-renderer/src/component/AbstractComponent.ts:11
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
The utilities for the view components.
Defined in
packages/react-page-renderer/src/component/AbstractComponent.ts:22
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://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
Inherited from
Component.UNSAFE_componentWillMount
Defined in
node_modules/@types/react/index.d.ts:688
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://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
Name | Type |
---|---|
nextProps | Readonly <{}> |
nextContext | any |
Returns
void
Inherited from
Component.UNSAFE_componentWillReceiveProps
Defined in
node_modules/@types/react/index.d.ts:720
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://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
Name | Type |
---|---|
nextProps | Readonly <{}> |
nextState | Readonly <{}> |
nextContext | any |
Returns
void
Inherited from
Component.UNSAFE_componentWillUpdate
Defined in
node_modules/@types/react/index.d.ts:748
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
Component.componentDidCatch
Defined in
node_modules/@types/react/index.d.ts:617
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:596
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 <{}> |
prevState | Readonly <{}> |
snapshot? | any |
Returns
void
Inherited from
Component.componentDidUpdate
Defined in
node_modules/@types/react/index.d.ts:659
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://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
Inherited from
Component.componentWillMount
Defined in
node_modules/@types/react/index.d.ts:674
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://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
Name | Type |
---|---|
nextProps | Readonly <{}> |
nextContext | any |
Returns
void
Inherited from
Component.componentWillReceiveProps
Defined in
node_modules/@types/react/index.d.ts:703
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:612
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://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
Name | Type |
---|---|
nextProps | Readonly <{}> |
nextState | Readonly <{}> |
nextContext | any |
Returns
void
Inherited from
Component.componentWillUpdate
Defined in
node_modules/@types/react/index.d.ts:733
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/AbstractComponent.ts:79
fire
▸ fire(eventName
, target
, data?
): void
Creates and sends a new IMA.js DOM custom event from this component.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
eventName | string | undefined | The name of the event. |
target | EventTarget | undefined | EventTarget compatible node. |
data | undefined | undefined | Data to send within the event. |
Returns
void
Defined in
packages/react-page-renderer/src/component/AbstractComponent.ts:93
forceUpdate
▸ forceUpdate(callback?
): void
Parameters
Name | Type |
---|---|
callback? | () => void |
Returns
void
Inherited from
Component.forceUpdate
Defined in
node_modules/@types/react/index.d.ts:488
getSnapshotBeforeUpdate
▸ Optional
getSnapshotBeforeUpdate(prevProps
, prevState
): any
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 <{}> |
prevState | Readonly <{}> |
Returns
any
Inherited from
Component.getSnapshotBeforeUpdate
Defined in
node_modules/@types/react/index.d.ts:653
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/AbstractComponent.ts:55
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/AbstractComponent.ts:107
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 | string | 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/AbstractComponent.ts:40
render
▸ render(): ReactNode
Returns
ReactNode
Inherited from
Component.render
Defined in
node_modules/@types/react/index.d.ts:489
setState
▸ setState<K
>(state
, callback?
): void
Type parameters
Name | Type |
---|---|
K | extends never |
Parameters
Name | Type |
---|---|
state | null | {} | (prevState : Readonly <{}>, props : Readonly <{}>) => null | {} | Pick <{}, K > | Pick <{}, K > |
callback? | () => void |
Returns
void
Inherited from
Component.setState
Defined in
node_modules/@types/react/index.d.ts:483
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 <{}> |
nextState | Readonly <{}> |
nextContext | any |
Returns
boolean
Inherited from
Component.shouldComponentUpdate
Defined in
node_modules/@types/react/index.d.ts:607
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/AbstractComponent.ts:124