Skip to main content

Class: BlankManagedRootView<P, S, SS>

Defined in: packages/react-page-renderer/src/component/BlankManagedRootView.ts:18

Blank managed root view does not nothing except for rendering the current page view.

This is the default managed root view.

Extends

  • Component<P, S, SS>

Type Parameters

P extends BlankManagedRootViewProps = BlankManagedRootViewProps

S = unknown

SS = unknown

Constructors

new BlankManagedRootView()

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

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

Parameters

props

P

Returns

BlankManagedRootView<P, S, SS>

Inherited from

Component<P, S, SS>.constructor

new BlankManagedRootView()

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

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

Parameters

props

P

context

any

Returns

BlankManagedRootView<P, S, SS>

Deprecated

See

React Docs

Inherited from

Component<P, S, SS>.constructor

Properties

context

context: unknown

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

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

Inherited from

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 optional contextType: Context<any>

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

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

Accessors

defaultProps

Get Signature

get static defaultProps(): object

Defined in: packages/react-page-renderer/src/component/BlankManagedRootView.ts:23

Returns

object

pageView

pageView: null = null

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


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


render()

render(): null | ReactElement<{}>

Defined in: packages/react-page-renderer/src/component/BlankManagedRootView.ts:32

Returns

null | ReactElement<{}>

Inherit Doc

Overrides

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


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