Class: ViewAdapter
@ima/react-page-renderer.ViewAdapter
An adapter component providing the current page controller's state to the page view component through its properties.
Hierarchy
Component
<ViewAdapterProps
,State
>↳
ViewAdapter
Constructors
constructor
• new ViewAdapter(props
)
Initializes the adapter component.
Parameters
Name | Type | Description |
---|---|---|
props | ViewAdapterProps | Component properties, containing the actual page view and the initial page state to pass to the view. |
Overrides
Component<ViewAdapterProps, State\>.constructor
Defined in
packages/react-page-renderer/src/component/ViewAdapter.ts:42
Properties
_getContextValue
• Private
_getContextValue: (props
: ViewAdapterProps
, state
: State
) => PageContextType
Type declaration
▸ (props
, state
): PageContextType
Parameters
Name | Type |
---|---|
props | ViewAdapterProps |
state | State |
Returns
Defined in
packages/react-page-renderer/src/component/ViewAdapter.ts:26
_managedRootView
• Private
_managedRootView: ComponentType
Defined in
packages/react-page-renderer/src/component/ViewAdapter.ts:25
context
• context: unknown
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://react.dev/reference/react/Component#context
Inherited from
Component.context
Defined in
node_modules/@types/react/ts5.0/index.d.ts:449
contextSelectors
• contextSelectors: (props
: ViewAdapterProps
, state
: State
) => any
[]
Defined in
packages/react-page-renderer/src/component/ViewAdapter.ts:32
createContext
• createContext: MemoizedFn
<(...args
: any
[]) => PageContextType
>
Defined in
packages/react-page-renderer/src/component/ViewAdapter.ts:31
props
• Readonly
props: Readonly
<ViewAdapterProps
>
Inherited from
Component.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
Component.refs
Defined in
node_modules/@types/react/ts5.0/index.d.ts:475
state
• state: Readonly
<State
>
Inherited from
Component.state
Defined in
node_modules/@types/react/ts5.0/index.d.ts:470
contextType
▪ Static
Optional
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://react.dev/reference/react/Component#static-contexttype
Inherited from
Component.contextType
Defined in
node_modules/@types/react/ts5.0/index.d.ts:432
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
Component.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 <ViewAdapterProps > |
nextContext | any |
Returns
void
Inherited from
Component.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 <ViewAdapterProps > |
nextState | Readonly <State > |
nextContext | any |
Returns
void
Inherited from
Component.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
Component.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
Component.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 <ViewAdapterProps > |
prevState | Readonly <State > |
snapshot? | any |
Returns
void
Inherited from
Component.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
Component.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 <ViewAdapterProps > |
nextContext | any |
Returns
void
Inherited from
Component.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
Component.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 <ViewAdapterProps > |
nextState | Readonly <State > |
nextContext | any |
Returns
void
Inherited from
Component.componentWillUpdate
Defined in
node_modules/@types/react/ts5.0/index.d.ts:711
forceUpdate
▸ forceUpdate(callback?
): void
Parameters
Name | Type |
---|---|
callback? | () => void |
Returns
void
Inherited from
Component.forceUpdate
Defined in
node_modules/@types/react/ts5.0/index.d.ts:466
getContextValue
▸ getContextValue(props
, state
): PageContextType
Parameters
Name | Type |
---|---|
props | ViewAdapterProps |
state | State |
Returns
Defined in
packages/react-page-renderer/src/component/ViewAdapter.ts:89
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 <ViewAdapterProps > |
prevState | Readonly <State > |
Returns
any
Inherited from
Component.getSnapshotBeforeUpdate
Defined in
node_modules/@types/react/ts5.0/index.d.ts:631
render
▸ render(): FunctionComponentElement
<ProviderProps
<PageContextType
>> | CElement
<ErrorBoundaryProps
, ErrorBoundary
>
Inherit Doc
Returns
FunctionComponentElement
<ProviderProps
<PageContextType
>> | CElement
<ErrorBoundaryProps
, ErrorBoundary
>
Overrides
Component.render
Defined in
packages/react-page-renderer/src/component/ViewAdapter.ts:99
setState
▸ setState<K
>(state
, callback?
): void
Type parameters
Name | Type |
---|---|
K | extends string | number |
Parameters
Name | Type |
---|---|
state | null | State | (prevState : Readonly <State >, props : Readonly <ViewAdapterProps >) => null | State | Pick <State , K > | Pick <State , K > |
callback? | () => void |
Returns
void
Inherited from
Component.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 <ViewAdapterProps > |
nextState | Readonly <State > |
nextContext | any |
Returns
boolean
Inherited from
Component.shouldComponentUpdate
Defined in
node_modules/@types/react/ts5.0/index.d.ts:585
getDerivedStateFromProps
▸ Static
getDerivedStateFromProps(props
, state
): State
Parameters
Name | Type |
---|---|
props | ViewAdapterProps |
state | State |
Returns
State
Defined in
packages/react-page-renderer/src/component/ViewAdapter.ts:71