API Reference > ui-framework > Item > ToolButton ToolButton<SS> Class Tool Button React Component. Extends Component<ToolButtonProps, BaseItemState> Methods Name Description constructor(props: ToolItemProps): ToolButton componentDidMount(): void componentWillUnmount(): 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<ToolButtonProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props. UNSAFE_componentWillUpdate(nextProps: Readonly<ToolButtonProps>, nextState: Readonly<BaseItemState>, 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. componentDidUpdate(prevProps: Readonly<ToolButtonProps>, prevState: Readonly<BaseItemState>, snapshot?: SS): void Optional NewLifecycle Called immediately after updating occurs. componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render. componentWillReceiveProps(nextProps: Readonly<ToolButtonProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props. componentWillUpdate(nextProps: Readonly<ToolButtonProps>, nextState: Readonly<BaseItemState>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received. forceUpdate(callback?: () => void): void Component<ToolButtonProps, BaseItemState> getSnapshotBeforeUpdate(prevProps: Readonly<ToolButtonProps>, prevState: Readonly<BaseItemState>): SS | null Optional NewLifecycle Runs before React applies the result of render to the document, and setState<K extends undefined>(state: (prevState: Readonly<BaseItemState>, props: Readonly<ToolButtonProps>) => null | S | { T } | null | S | { T }, callback?: () => void): void Component<ToolButtonProps, BaseItemState> shouldComponentUpdate(nextProps: Readonly<ToolButtonProps>, nextState: Readonly<BaseItemState>, nextContext: any): boolean Optional ComponentLifecycle Called to determine whether the change in props and state should trigger a re-render. Properties Name Type Description label Accessor ReadOnly string Inherited properties Name Type Inherited from Description context any Component<ToolButtonProps, BaseItemState> If using the new style context, re-declare this in your class to be the contextType Static undefined | Context<any> Component<ToolButtonProps, BaseItemState> If set, this.context will be set at runtime to the current value of the given Context. props Readonly<ToolButtonProps> & Readonly<{ children?: ReactNode }> Component<ToolButtonProps, BaseItemState> refs [key: string]: ReactInstance Component<ToolButtonProps, BaseItemState> Defined in ui/framework/src/ui-framework/toolbar/ToolButton.tsx Line 31 Last Updated: 13 June, 2024