BaseWidget class

Constructor of BaseWidget.

new BaseWidget(props: Readonly<P>)

Parameters

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

context: unknown

Property Value

Inherited From Component.context

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

static contextType?: Context<any>

Property Value

Inherited From Component.contextType

props: Readonly<P>

Property Value

Inherited From Component.props

See Legacy React Docs

refs: {[key: string]: ReactInstance}

Property Value

Inherited From Component.refs

state: Readonly<S & BaseWidgetState>

Property Value

Inherited From Component.state

The purpose of this method is to provide a way for you to add custom body content to the widget. By overriding this method, you can add additional functionality or styling to the widget's body. If the method is not overridden, the widget will return undefined as the default value for the body, indicating that no custom body content has been defined.

function body(): undefined | Element

Returns

An optional JSX.Element representing the body of the widget.

Called after the component is mounted. You can do initialization that requires DOM nodes here. You can also make network requests here if you need to load data from a remote endpoint.

function componentDidMount(): Promise<void>

Returns

The purpose of this method is to provide a way for you to add custom footer content to the widget. By overriding this method, you can add additional functionality or styling to the widget's footer. If the method is not overridden, the widget will return undefined as the default value for the footer, indicating that no custom footer content has been defined.

function footer(): undefined | Element

Returns

An optional JSX.Element representing the footer of the widget.

Get data required by the widget

function getData(): Promise<S>

Returns

Data for the widget

The purpose of this method is to provide a way for you to add custom header content to the widget. By overriding this method, you can add additional functionality or styling to the widget's header. If the method is not overridden, the widget will return undefined as the default value for the header, indicating that no custom header content has been defined.

function header(): undefined | Element

Returns

An optional JSX.Element representing the header of the widget.

This method is typically called when the widget is in the process of fetching data. The undefined return value is used to indicate that no loading indicator is required. If a loading indicator is required, the method can return a JSX.Element containing the necessary components to render the loading indicator.

function loading(): undefined | Element

Returns

A JSX element or undefined if no loading indicator is required.

Defines the default layout for the widget.

function render(): Element

Returns

Override this method to returns an object that defines the class names for the different parts of the widget. The returned object conforms to the IWidgetClassNames interface which defines the possible keys and values for the class names.

function styling(): IWidgetClassNames

Returns

An object that defines the class names for the different parts of the widget.

Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

function componentDidCatch(error: Error, errorInfo: ErrorInfo)

Parameters

Inherited From Component.componentDidCatch

Called immediately after updating occurs. Not called for the initial render.

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

function componentDidUpdate(prevProps: Readonly<P>, prevState: Readonly<S & BaseWidgetState>, snapshot?: any)

Parameters

Inherited From Component.componentDidUpdate

Called immediately before mounting occurs, and before <xref:Component.render>. Avoid introducing any side-effects or subscriptions in this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

See https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state See https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

function componentWillMount()

Inherited From Component.componentWillMount

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 <xref:Component.setState> generally does not trigger this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

See https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props See https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

function componentWillReceiveProps(nextProps: Readonly<P>, nextContext: any)

Parameters

Inherited From Component.componentWillReceiveProps

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.

function componentWillUnmount()

Inherited From Component.componentWillUnmount

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call <xref:Component.setState> here.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

See https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update See https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

function componentWillUpdate(nextProps: Readonly<P>, nextState: Readonly<S & BaseWidgetState>, nextContext: any)

Parameters

Inherited From Component.componentWillUpdate

function forceUpdate(callback?: () => void)

Parameters

Inherited From Component.forceUpdate

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.

function getSnapshotBeforeUpdate(prevProps: Readonly<P>, prevState: Readonly<S & BaseWidgetState>): any

Parameters

Returns

Inherited From Component.getSnapshotBeforeUpdate

function setState<K>(state: null | (S & BaseWidgetState) | (prevState: Readonly<S & BaseWidgetState>, props: Readonly<P>) => null | (S & BaseWidgetState) | Pick<S & BaseWidgetState, K> | Pick<S & BaseWidgetState, K>, callback?: () => void)

Parameters

Inherited From Component.setState

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, <xref:Component.render>, componentWillUpdate and componentDidUpdate will not be called.

function shouldComponentUpdate(nextProps: Readonly<P>, nextState: Readonly<S & BaseWidgetState>, nextContext: any): boolean

Parameters

Returns

Inherited From Component.shouldComponentUpdate

Called immediately before mounting occurs, and before <xref: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.

See https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state See https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

function UNSAFE_componentWillMount()

Inherited From Component.UNSAFE_componentWillMount

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 <xref: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.

See https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props See https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

function UNSAFE_componentWillReceiveProps(nextProps: Readonly<P>, nextContext: any)

Parameters

Inherited From Component.UNSAFE_componentWillReceiveProps

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call <xref:Component.setState> here.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

See https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update See https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

function UNSAFE_componentWillUpdate(nextProps: Readonly<P>, nextState: Readonly<S & BaseWidgetState>, nextContext: any)

Parameters

Inherited From Component.UNSAFE_componentWillUpdate