API Reference > ui-framework > Widget > ToolWidget ToolWidget<SS> Class ToolWidget React component. Extends Component<ToolWidgetPropsEx, ToolWidgetState> Methods Name Description constructor(props: ToolWidgetPropsEx): ToolWidget componentDidUpdate(prevProps: ToolWidgetPropsEx, _prevState: ToolWidgetState): void render(): React.ReactNode Inherited methods Name Inherited from Description UNSAFE_componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render. UNSAFE_componentWillReceiveProps(nextProps: Readonly<ToolWidgetPropsEx>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props. UNSAFE_componentWillUpdate(nextProps: Readonly<ToolWidgetPropsEx>, nextState: Readonly<ToolWidgetState>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received. componentDidCatch(error: Error, errorInfo: ErrorInfo): void Optional ComponentLifecycle Catches exceptions generated in descendant components. componentDidMount(): void Optional ComponentLifecycle Called immediately after a component is mounted. componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render. componentWillReceiveProps(nextProps: Readonly<ToolWidgetPropsEx>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props. componentWillUnmount(): void Optional ComponentLifecycle Called immediately before a component is destroyed. componentWillUpdate(nextProps: Readonly<ToolWidgetPropsEx>, nextState: Readonly<ToolWidgetState>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received. forceUpdate(callback?: () => void): void Component<ToolWidgetPropsEx, ToolWidgetState> getSnapshotBeforeUpdate(prevProps: Readonly<ToolWidgetPropsEx>, prevState: Readonly<ToolWidgetState>): SS | null Optional NewLifecycle Runs before React applies the result of render to the document, and setState<K extends undefined>(state: (prevState: Readonly<ToolWidgetState>, props: Readonly<ToolWidgetPropsEx>) => null | S | { T } | null | S | { T }, callback?: () => void): void Component<ToolWidgetPropsEx, ToolWidgetState> shouldComponentUpdate(nextProps: Readonly<ToolWidgetPropsEx>, nextState: Readonly<ToolWidgetState>, nextContext: any): boolean Optional ComponentLifecycle Called to determine whether the change in props and state should trigger a re-render. Inherited properties Name Type Inherited from Description context any Component<ToolWidgetPropsEx, ToolWidgetState> If using the new style context, re-declare this in your class to be the contextType Static undefined | Context<any> Component<ToolWidgetPropsEx, ToolWidgetState> If set, this.context will be set at runtime to the current value of the given Context. props Readonly<ToolWidgetPropsEx> & Readonly<{ children?: ReactNode }> Component<ToolWidgetPropsEx, ToolWidgetState> refs [key: string]: ReactInstance Component<ToolWidgetPropsEx, ToolWidgetState> Defined in ui/framework/src/ui-framework/widgets/ToolWidget.tsx Line 83 Last Updated: 13 June, 2024