Class: ErrorBoundary
Hierarchy
Component
<ErrorProps
,ErrorAppState
>↳
ErrorBoundary
Constructors
constructor
• new ErrorBoundary(props
)
Parameters
Name | Type |
---|---|
props | ErrorProps |
Overrides
Component<ErrorProps, ErrorAppState\>.constructor
Defined in
packages/ui-components/src/components/ErrorBoundary/ErrorBoundary.tsx:14
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/ts5.0/index.d.ts:1001
props
• Readonly
props: Readonly
<ErrorProps
>
Inherited from
Component.props
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1021
refs
• refs: Object
Deprecated
See
Index signature
▪ [key: string
]: ReactInstance
Inherited from
Component.refs
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1028
state
• state: Readonly
<ErrorAppState
>
Inherited from
Component.state
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1022
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/ts5.0/index.d.ts:983
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 NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.
Deprecated
16.3, use ComponentLifecycle.componentDidMount 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:1458
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 NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.
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
Parameters
Name | Type |
---|---|
nextProps | Readonly <ErrorProps > |
nextContext | any |
Returns
void
Inherited from
Component.UNSAFE_componentWillReceiveProps
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1492
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 NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps 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 <ErrorProps > |
nextState | Readonly <ErrorAppState > |
nextContext | any |
Returns
void
Inherited from
Component.UNSAFE_componentWillUpdate
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1522
componentDidCatch
▸ componentDidCatch(error
, info
): void
Parameters
Name | Type |
---|---|
error | Error |
info | object |
Returns
void
Overrides
Component.componentDidCatch
Defined in
packages/ui-components/src/components/ErrorBoundary/ErrorBoundary.tsx:19
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:1364
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 <ErrorProps > |
prevState | Readonly <ErrorAppState > |
snapshot? | any |
Returns
void
Inherited from
Component.componentDidUpdate
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1427
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 NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.
Deprecated
16.3, use ComponentLifecycle.componentDidMount 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:1443
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 NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.
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
Parameters
Name | Type |
---|---|
nextProps | Readonly <ErrorProps > |
nextContext | any |
Returns
void
Inherited from
Component.componentWillReceiveProps
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1474
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:1380
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 NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps 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 <ErrorProps > |
nextState | Readonly <ErrorAppState > |
nextContext | any |
Returns
void
Inherited from
Component.componentWillUpdate
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1506
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:1018
getSnapshotBeforeUpdate
▸ Optional
getSnapshotBeforeUpdate(prevProps
, prevState
): any
Runs before React applies the result of Component.render render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before Component.render 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 <ErrorProps > |
prevState | Readonly <ErrorAppState > |
Returns
any
Inherited from
Component.getSnapshotBeforeUpdate
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1421
render
▸ render(): Element
Returns
Element
Overrides
Component.render
Defined in
packages/ui-components/src/components/ErrorBoundary/ErrorBoundary.tsx:23
setState
▸ setState<K
>(state
, callback?
): void
Type parameters
Name | Type |
---|---|
K | extends keyof ErrorAppState |
Parameters
Name | Type |
---|---|
state | null | ErrorAppState | (prevState : Readonly <ErrorAppState >, props : Readonly <ErrorProps >) => null | ErrorAppState | Pick <ErrorAppState , K > | Pick <ErrorAppState , K > |
callback? | () => void |
Returns
void
Inherited from
Component.setState
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1013
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 <ErrorProps > |
nextState | Readonly <ErrorAppState > |
nextContext | any |
Returns
boolean
Inherited from
Component.shouldComponentUpdate
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1375