Class: ErrorBoundary
Hierarchy​
Component<PropsWithChildren<Record<string,unknown>>, {error:Error|null}>↳
ErrorBoundary
Constructors​
constructor​
• new ErrorBoundary(props)
Parameters​
| Name | Type |
|---|---|
props | any |
Overrides​
React.Component<PropsWithChildren<Record<string, unknown\>\>, { error: Error | null }\>.constructor
Defined in​
lib/src/core/components/ErrorBoundary.tsx:7
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.
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​
React.Component.context
Defined in​
node_modules/@types/react/ts5.0/index.d.ts:471
props​
• Readonly props: Readonly<PropsWithChildren<Record<string, unknown>>>
Inherited from​
React.Component.props
Defined in​
node_modules/@types/react/ts5.0/index.d.ts:491
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​
React.Component.refs
Defined in​
node_modules/@types/react/ts5.0/index.d.ts:497
state​
• state: Readonly<{ error: null | Error }>
Inherited from​
React.Component.state
Defined in​
node_modules/@types/react/ts5.0/index.d.ts:492
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​
React.Component.contextType
Defined in​
node_modules/@types/react/ts5.0/index.d.ts:454
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​
React.Component.UNSAFE_componentWillMount
Defined in​
node_modules/@types/react/ts5.0/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://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<PropsWithChildren<Record<string, unknown>>> |
nextContext | any |
Returns​
void
Inherited from​
React.Component.UNSAFE_componentWillReceiveProps
Defined in​
node_modules/@types/react/ts5.0/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://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<PropsWithChildren<Record<string, unknown>>> |
nextState | Readonly<{ error: null | Error }> |
nextContext | any |
Returns​
void
Inherited from​
React.Component.UNSAFE_componentWillUpdate
Defined in​
node_modules/@types/react/ts5.0/index.d.ts:748
componentDidCatch​
â–¸ componentDidCatch(error, errorInfo): void
Parameters​
| Name | Type |
|---|---|
error | Error |
errorInfo | ErrorInfo |
Returns​
void
Overrides​
React.Component.componentDidCatch
Defined in​
lib/src/core/components/ErrorBoundary.tsx:17
componentDidMount​
â–¸ Optional componentDidMount(): void
Called immediately after a component is mounted. Setting state here will trigger re-rendering.
Returns​
void
Inherited from​
React.Component.componentDidMount
Defined in​
node_modules/@types/react/ts5.0/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<PropsWithChildren<Record<string, unknown>>> |
prevState | Readonly<{ error: null | Error }> |
snapshot? | any |
Returns​
void
Inherited from​
React.Component.componentDidUpdate
Defined in​
node_modules/@types/react/ts5.0/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://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​
React.Component.componentWillMount
Defined in​
node_modules/@types/react/ts5.0/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://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<PropsWithChildren<Record<string, unknown>>> |
nextContext | any |
Returns​
void
Inherited from​
React.Component.componentWillReceiveProps
Defined in​
node_modules/@types/react/ts5.0/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​
React.Component.componentWillUnmount
Defined in​
node_modules/@types/react/ts5.0/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://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<PropsWithChildren<Record<string, unknown>>> |
nextState | Readonly<{ error: null | Error }> |
nextContext | any |
Returns​
void
Inherited from​
React.Component.componentWillUpdate
Defined in​
node_modules/@types/react/ts5.0/index.d.ts:733
forceUpdate​
â–¸ forceUpdate(callback?): void
Parameters​
| Name | Type |
|---|---|
callback? | () => void |
Returns​
void
Inherited from​
React.Component.forceUpdate
Defined in​
node_modules/@types/react/ts5.0/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<PropsWithChildren<Record<string, unknown>>> |
prevState | Readonly<{ error: null | Error }> |
Returns​
any
Inherited from​
React.Component.getSnapshotBeforeUpdate
Defined in​
node_modules/@types/react/ts5.0/index.d.ts:653
render​
â–¸ render(): undefined | null | string | number | boolean | ReactFragment | Element
Returns​
undefined | null | string | number | boolean | ReactFragment | Element
Overrides​
React.Component.render
Defined in​
lib/src/core/components/ErrorBoundary.tsx:22
setState​
â–¸ setState<K>(state, callback?): void
Type parameters​
| Name | Type |
|---|---|
K | extends "error" |
Parameters​
| Name | Type |
|---|---|
state | null | { error: null | Error } | (prevState: Readonly<{ error: null | Error }>, props: Readonly<PropsWithChildren<Record<string, unknown>>>) => null | { error: null | Error } | Pick<{ error: null | Error }, K> | Pick<{ error: null | Error }, K> |
callback? | () => void |
Returns​
void
Inherited from​
React.Component.setState
Defined in​
node_modules/@types/react/ts5.0/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<PropsWithChildren<Record<string, unknown>>> |
nextState | Readonly<{ error: null | Error }> |
nextContext | any |
Returns​
boolean
Inherited from​
React.Component.shouldComponentUpdate
Defined in​
node_modules/@types/react/ts5.0/index.d.ts:607
getDerivedStateFromError​
â–¸ Static getDerivedStateFromError(error): Object
Parameters​
| Name | Type |
|---|---|
error | Error |
Returns​
Object
| Name | Type |
|---|---|
error | Error |