API Reference > ui-framework > Widget > NavigationWidgetDef NavigationWidgetDef Class Definition of a Navigation Widget normally displayed in the top right zone in the 9-Zone Layout system. Extends ToolbarWidgetDefBase Methods Name Description constructor(props: NavigationWidgetProps): NavigationWidgetDef renderCornerItem(): React.ReactNode updateNavigationAid(navigationAidId: string, imodel?: IModelConnection): void Inherited methods Name Inherited from Description canOpen(): boolean WidgetDef createCachedHorizontalItemList(toolbarId: string): void Protected ToolbarWidgetDefBase createCachedVerticalItemList(toolbarId: string): void Protected ToolbarWidgetDefBase createMergedItemList(originalItemList: ItemList | undefined, insertSpecs: ToolbarItemInsertSpec[], insertAtStart: boolean = false): ItemList Protected ToolbarWidgetDefBase Create a Merged ItemList leaving the original ItemList untouched. generateMergedItemLists(): void ToolbarWidgetDefBase getWidgetControl(type: ConfigurableUiControlType): WidgetControl | undefined WidgetDef renderHorizontalToolbar(): React.ReactNode ToolbarWidgetDefBase renderVerticalToolbar(): React.ReactNode ToolbarWidgetDefBase setLabel(v: string | StringGetter): void WidgetDef Set the label. setTooltip(v: string | StringGetter): void WidgetDef Set the tooltip. setUpSyncSupport(props: WidgetProps): void WidgetDef setWidgetState(newState: WidgetState): void WidgetDef initializeFromWidgetProps(widgetProps: WidgetProps, me: WidgetDef): void Static WidgetDef Properties Name Type Description reactElement Accessor ReadOnly React.ReactNode Inherited properties Name Type Inherited from Description _cachedHorizontalItems Protected undefined | ItemList ToolbarWidgetDefBase _cachedVerticalItems Protected undefined | ItemList ToolbarWidgetDefBase activeState Accessor ReadOnly WidgetState WidgetDef applicationData undefined | any WidgetDef badgeType undefined | BadgeType WidgetDef betaBadge undefined | false | true WidgetDef classId string | ConfigurableUiControlConstructor | undefined WidgetDef fillZone boolean WidgetDef horizontalDirection Direction ToolbarWidgetDefBase horizontalItems undefined | ItemList ToolbarWidgetDefBase horizontalPanelAlignment ToolbarPanelAlignment ToolbarWidgetDefBase iconSpec string | React.ReactNode WidgetDef id string WidgetDef isActive Accessor ReadOnly boolean WidgetDef isFloating boolean WidgetDef isFloatingStateSupported boolean WidgetDef isFloatingStateWindowResizable boolean WidgetDef isFreeform boolean WidgetDef isStatusBar boolean WidgetDef isToolSettings boolean WidgetDef isVisible Accessor ReadOnly boolean WidgetDef label Accessor ReadOnly string WidgetDef Get the label string priority number WidgetDef state WidgetState WidgetDef stateChanged boolean WidgetDef stateFunc undefined | (state: Readonly<WidgetState>) => WidgetState WidgetDef syncEventIds string[] WidgetDef tooltip Accessor ReadOnly string WidgetDef Get the tooltip string verticalDirection Direction ToolbarWidgetDefBase verticalItems undefined | ItemList ToolbarWidgetDefBase verticalPanelAlignment ToolbarPanelAlignment ToolbarWidgetDefBase widgetBaseName Accessor string ToolbarWidgetDefBase widgetControl Accessor ReadOnly WidgetControl | undefined WidgetDef widgetType WidgetType WidgetDef Defined in ui/framework/src/ui-framework/widgets/NavigationWidget.tsx Line 31 Last Updated: 13 June, 2024