Class: BlankManagedRootView<P, S, SS>
@ima/react-page-renderer.BlankManagedRootView
Blank managed root view does not nothing except for rendering the current page view.
This is the default managed root view.
Type parameters
Name | Type |
---|---|
P | extends BlankManagedRootViewProps = BlankManagedRootViewProps |
S | unknown |
SS | unknown |
Hierarchy
Component
\<P
,S
,SS
>↳
BlankManagedRootView
Constructors
constructor
• new BlankManagedRootView\<P
, S
, SS
>(props
)
Type parameters
Name | Type |
---|---|
P | extends BlankManagedRootViewProps = BlankManagedRootViewProps |
S | unknown |
SS | unknown |
Parameters
Name | Type |
---|---|
props | P |
Inherited from
Component\<P, S, SS>.constructor
Defined in
node_modules/@types/react/index.d.ts:1008
• new BlankManagedRootView\<P
, S
, SS
>(props
, context
)
Type parameters
Name | Type |
---|---|
P | extends BlankManagedRootViewProps = BlankManagedRootViewProps |
S | unknown |
SS | unknown |
Parameters
Name | Type |
---|---|
props | P |
context | any |
Deprecated
See
Inherited from
Component\<P, S, SS>.constructor
Defined in
node_modules/@types/react/index.d.ts:1013
Properties
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.
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
Inherited from
Component.context
Defined in
node_modules/@types/react/index.d.ts:1006
props
• Readonly
props: Readonly
\<P
>
Inherited from
Component.props
Defined in
node_modules/@types/react/index.d.ts:1026
refs
• refs: Object
Deprecated
See
Index signature
▪ [key: string
]: ReactInstance
Inherited from
Component.refs
Defined in
node_modules/@types/react/index.d.ts:1033
state
• state: Readonly
\<S
>
Inherited from
Component.state
Defined in
node_modules/@types/react/index.d.ts:1027
contextType
▪ Static
Optional
contextType: Context
\<any
>
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
Inherited from
Component.contextType
Defined in
node_modules/@types/react/index.d.ts:988
Accessors
defaultProps
• Static
get
defaultProps(): Object
Returns
Object
Name | Type |
---|---|
pageView | null |
Defined in
packages/react-page-renderer/src/component/BlankManagedRootView.ts:23
Methods
UNSAFE_componentWillMount
▸ Optional
UNSAFE_componentWillMount(): void
Called immediately before mounting occurs, and before 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
- 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
Inherited from
Component.UNSAFE_componentWillMount
Defined in
node_modules/@types/react/index.d.ts:1463
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 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
Name | Type |
---|---|
nextProps | Readonly \<P > |
nextContext | any |
Returns
void
Deprecated
16.3, use static StaticLifecycle.getDerivedStateFromProps 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
Inherited from
Component.UNSAFE_componentWillReceiveProps
Defined in
node_modules/@types/react/index.d.ts:1497
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 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
Name | Type |
---|---|
nextProps | Readonly \<P > |
nextState | Readonly \<S > |
nextContext | any |
Returns
void
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
Inherited from
Component.UNSAFE_componentWillUpdate
Defined in
node_modules/@types/react/index.d.ts:1527
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:1390
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:1369
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
Component.componentDidUpdate
Defined in
node_modules/@types/react/index.d.ts:1432
componentWillMount
▸ Optional
componentWillMount(): void
Called immediately before mounting occurs, and before 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
- 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
Inherited from
Component.componentWillMount
Defined in
node_modules/@types/react/index.d.ts:1448
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 setState generally does not trigger this method.
Note: the presence of getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.
Parameters
Name | Type |
---|---|
nextProps | Readonly \<P > |
nextContext | any |
Returns
void
Deprecated
16.3, use static StaticLifecycle.getDerivedStateFromProps 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
Inherited from
Component.componentWillReceiveProps
Defined in
node_modules/@types/react/index.d.ts:1479
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:1385
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 setState here.
Note: the presence of getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.
Parameters
Name | Type |
---|---|
nextProps | Readonly \<P > |
nextState | Readonly \<S > |
nextContext | any |
Returns
void
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
Inherited from
Component.componentWillUpdate
Defined in
node_modules/@types/react/index.d.ts:1511
forceUpdate
▸ forceUpdate(callback?
): void
Parameters
Name | Type |
---|---|
callback? | () => void |
Returns
void
Inherited from
Component.forceUpdate
Defined in
node_modules/@types/react/index.d.ts:1023
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 this method prevents any of the deprecated lifecycle events from running.
Parameters
Name | Type |
---|---|
prevProps | Readonly \<P > |
prevState | Readonly \<S > |
Returns
null
| SS
Inherited from
Component.getSnapshotBeforeUpdate
Defined in
node_modules/@types/react/index.d.ts:1426
render
▸ render(): null
| ReactElement
\<{}, string
| JSXElementConstructor
\<any
>>
Returns
null
| ReactElement
\<{}, string
| JSXElementConstructor
\<any
>>
Inherit Doc
Overrides
Component.render
Defined in
packages/react-page-renderer/src/component/BlankManagedRootView.ts:32
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
Component.setState
Defined in
node_modules/@types/react/index.d.ts:1018
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, render, componentWillUpdate
and componentDidUpdate
will not be called.
Parameters
Name | Type |
---|---|
nextProps | Readonly \<P > |
nextState | Readonly \<S > |
nextContext | any |
Returns
boolean
Inherited from
Component.shouldComponentUpdate
Defined in
node_modules/@types/react/index.d.ts:1380