API Reference > ui-framework > Widget > Widget

Widget<S, SS, S> Class

Widget React component. A Widget is a collection of UI components tied to a particular Zone that allows the user to view and/or modify data relevant to their current context.

Extends

Methods

Name Description
constructor(props: WidgetProps): Widget    
render(): null    

Inherited methods

Name Inherited from Description
UNSAFE_componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render.
UNSAFE_componentWillReceiveProps(nextProps: Readonly<WidgetProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
UNSAFE_componentWillUpdate(nextProps: Readonly<WidgetProps>, nextState: Readonly<S>, 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<WidgetProps>, prevState: Readonly<S>, 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<WidgetProps>, 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<WidgetProps>, nextState: Readonly<S>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received.
forceUpdate(callback?: () => void): void Component<WidgetProps>  
getSnapshotBeforeUpdate(prevProps: Readonly<WidgetProps>, prevState: Readonly<S>): SS | null Optional NewLifecycle Runs before React applies the result of render to the document, and
setState<K extends undefined>(state: (prevState: Readonly<S>, props: Readonly<WidgetProps>) => null | S | { T } | null | S | { T }, callback?: () => void): void Component<WidgetProps>  
shouldComponentUpdate(nextProps: Readonly<WidgetProps>, nextState: Readonly<S>, 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<WidgetProps> If using the new style context, re-declare this in your class to be the
contextType Static undefined | Context<any> Component<WidgetProps> If set, this.context will be set at runtime to the current value of the given Context.
props Readonly<WidgetProps> & Readonly<{ children?: ReactNode }> Component<WidgetProps>  
refs [key: string]: ReactInstance Component<WidgetProps>  
state Readonly<S> Component<WidgetProps>  

Defined in

Last Updated: 13 June, 2024