ActionItemButton<SS> Class

A Toolbar button React Component that executes an action defined by a CommandItemDef or a ToolItemDef.

Extends

Methods

Name Description
constructor(props: ActionItemButtonProps): ActionItemButton    
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<ActionItemButtonProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
UNSAFE_componentWillUpdate(nextProps: Readonly<ActionItemButtonProps>, 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<ActionItemButtonProps>, 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<ActionItemButtonProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
componentWillUpdate(nextProps: Readonly<ActionItemButtonProps>, nextState: Readonly<BaseItemState>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received.
forceUpdate(callback?: () => void): void Component<ActionItemButtonProps, BaseItemState>  
getSnapshotBeforeUpdate(prevProps: Readonly<ActionItemButtonProps>, 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<ActionItemButtonProps>) => null | S | { T } | null | S | { T }, callback?: () => void): void Component<ActionItemButtonProps, BaseItemState>  
shouldComponentUpdate(nextProps: Readonly<ActionItemButtonProps>, nextState: Readonly<BaseItemState>, 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<ActionItemButtonProps, BaseItemState> If using the new style context, re-declare this in your class to be the
contextType Static undefined | Context<any> Component<ActionItemButtonProps, BaseItemState> If set, this.context will be set at runtime to the current value of the given Context.
props Readonly<ActionItemButtonProps> & Readonly<{ children?: ReactNode }> Component<ActionItemButtonProps, BaseItemState>  
refs [key: string]: ReactInstance Component<ActionItemButtonProps, BaseItemState>  

Defined in

Last Updated: 13 June, 2024