ReviewToolWidget<SS> Class
Beta
Default Tool Widget for standard "review" applications. Provides standard tools to review, and measure elements. This definition will also show a overflow button if there is not enough room to display all the toolbar buttons.
Extends
- Component<ReviewToolWidgetProps, any>
Methods
| Name | Description | |
|---|---|---|
| constructor(props: Readonly<ReviewToolWidgetProps>): ReviewToolWidget | Deprecated |
|
| constructor(props: ReviewToolWidgetProps, context?: any): ReviewToolWidget | Deprecated |
|
| render(): Element |
Inherited methods
| Name | Inherited from | Description |
|---|---|---|
| UNSAFE_componentWillMount(): void Optional | DeprecatedLifecycle | Called immediately before mounting occurs, and before Component#render. |
| UNSAFE_componentWillReceiveProps(nextProps: Readonly<ReviewToolWidgetProps>, nextContext: any): void Optional | DeprecatedLifecycle | Called when the component may be receiving new props. |
| UNSAFE_componentWillUpdate(nextProps: Readonly<ReviewToolWidgetProps>, nextState: Readonly<any>, 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. |
| componentDidUpdate(prevProps: Readonly<ReviewToolWidgetProps>, prevState: Readonly<any>, 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<ReviewToolWidgetProps>, 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<ReviewToolWidgetProps>, nextState: Readonly<any>, nextContext: any): void Optional | DeprecatedLifecycle | Called immediately before rendering when new props or state is received. |
| forceUpdate(callback?: () => void): void | Component | |
| getSnapshotBeforeUpdate(prevProps: Readonly<ReviewToolWidgetProps>, prevState: Readonly<any>): SS | null Optional | NewLifecycle | Runs before React applies the result of render to the document, andreturns an object to be given to componentDidUpdate. |
| setState<K extends undefined>(state: (prevState: Readonly<any>, props: Readonly<ReviewToolWidgetProps>) => null | S | object | null | S | object, callback?: () => void): void | Component | |
| shouldComponentUpdate(nextProps: Readonly<ReviewToolWidgetProps>, nextState: Readonly<any>, 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 | If using the new style context, re-declare this in your class to be theReact.ContextType of your static contextType. |
| contextType Static | undefined | Context<any> | Component | If set, this.context will be set at runtime to the current value of the given Context. |
| props | undefined | Component | |
| refs | [key: string]: ReactInstance | Component | |
| state | Readonly<any> | Component |
Defined in
Last Updated: 08 January, 2020