API Reference > ui-framework > Widget > NavigationWidget

NavigationWidget<SS> Class

Navigation Widget React component.

Extends

Methods

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

Defined in

Last Updated: 13 June, 2024