Class: default¶
Defined in: src/components/error-boundary/ErrorBoundary.tsx:25
Extends¶
Component\<Props,State>
Constructors¶
Constructor¶
new default(
props):ErrorBoundary
Defined in: src/components/error-boundary/ErrorBoundary.tsx:26
Parameters¶
props¶
Props
Returns¶
ErrorBoundary
Overrides¶
Component<Props, State>.constructor
Properties¶
context¶
context:
unknown
Defined in: node_modules/@types/react/index.d.ts:955
If using React 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
props¶
readonlyprops:Readonly\<P>
Defined in: node_modules/@types/react/index.d.ts:979
Inherited from¶
Component.props
state¶
state:
Readonly\<S>
Defined in: node_modules/@types/react/index.d.ts:980
Inherited from¶
Component.state
contextType?¶
staticoptionalcontextType?:Context\<any>
Defined in: node_modules/@types/react/index.d.ts:931
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
~~propTypes?~~¶
staticoptionalpropTypes?:any
Defined in: node_modules/@types/react/index.d.ts:937
Ignored by React.
Deprecated¶
Only kept in types for backwards compatibility. Will be removed in a future major release.
Inherited from¶
Component.propTypes
Methods¶
componentDidCatch()¶
componentDidCatch(
error,errorInfo):void
Defined in: src/components/error-boundary/ErrorBoundary.tsx:35
Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.
Parameters¶
error¶
Error
errorInfo¶
ErrorInfo
Returns¶
void
Overrides¶
Component.componentDidCatch
componentDidMount()?¶
optionalcomponentDidMount():void
Defined in: node_modules/@types/react/index.d.ts:1198
Called immediately after a component is mounted. Setting state here will trigger re-rendering.
Returns¶
void
Inherited from¶
Component.componentDidMount
componentDidUpdate()?¶
optionalcomponentDidUpdate(prevProps,prevState,snapshot?):void
Defined in: node_modules/@types/react/index.d.ts:1261
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?¶
any
Returns¶
void
Inherited from¶
Component.componentDidUpdate
~~componentWillMount()?~~¶
optionalcomponentWillMount():void
Defined in: node_modules/@types/react/index.d.ts:1277
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.
Returns¶
void
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
Inherited from¶
Component.componentWillMount
~~componentWillReceiveProps()?~~¶
optionalcomponentWillReceiveProps(nextProps,nextContext):void
Defined in: node_modules/@types/react/index.d.ts:1308
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.
Parameters¶
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
componentWillUnmount()?¶
optionalcomponentWillUnmount():void
Defined in: node_modules/@types/react/index.d.ts:1214
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()?~~¶
optionalcomponentWillUpdate(nextProps,nextState,nextContext):void
Defined in: node_modules/@types/react/index.d.ts:1340
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.
Parameters¶
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
forceUpdate()¶
forceUpdate(
callback?):void
Defined in: node_modules/@types/react/index.d.ts:976
Parameters¶
callback?¶
() => void
Returns¶
void
Inherited from¶
Component.forceUpdate
getSnapshotBeforeUpdate()?¶
optionalgetSnapshotBeforeUpdate(prevProps,prevState):any
Defined in: node_modules/@types/react/index.d.ts:1255
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¶
prevProps¶
Readonly\<P>
prevState¶
Readonly\<S>
Returns¶
any
Inherited from¶
Component.getSnapshotBeforeUpdate
render()¶
render():
ReactNode
Defined in: src/components/error-boundary/ErrorBoundary.tsx:43
Returns¶
ReactNode
Overrides¶
Component.render
setState()¶
setState\<
K>(state,callback?):void
Defined in: node_modules/@types/react/index.d.ts:971
Type Parameters¶
K¶
K extends "hasError"
Parameters¶
state¶
State | ((prevState, props) => State | Pick\<State, K> | null) | Pick\<State, K> | null
callback?¶
() => void
Returns¶
void
Inherited from¶
Component.setState
shouldComponentUpdate()?¶
optionalshouldComponentUpdate(nextProps,nextState,nextContext):boolean
Defined in: node_modules/@types/react/index.d.ts:1209
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()?~~¶
optionalUNSAFE_componentWillMount():void
Defined in: node_modules/@types/react/index.d.ts:1292
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.
Returns¶
void
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
Inherited from¶
Component.UNSAFE_componentWillMount
~~UNSAFE_componentWillReceiveProps()?~~¶
optionalUNSAFE_componentWillReceiveProps(nextProps,nextContext):void
Defined in: node_modules/@types/react/index.d.ts:1326
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.
Parameters¶
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
~~UNSAFE_componentWillUpdate()?~~¶
optionalUNSAFE_componentWillUpdate(nextProps,nextState,nextContext):void
Defined in: node_modules/@types/react/index.d.ts:1356
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.
Parameters¶
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
getDerivedStateFromError()¶
staticgetDerivedStateFromError():State
Defined in: src/components/error-boundary/ErrorBoundary.tsx:31
Returns¶
State