Class AppBarApi

constructor

• new AppBarApi(uiController: UIController): AppBarApi

  Instantiates an AppBarApi class.

  Parameters

  • uiController: UIController

    The UI controller this app bar api belongs to

  Returns AppBarApi

buttons

createAppbarPanel

• createAppbarPanel(
      buttonProps: IconButtonPropsExtend,
      panelProps: TypePanelProps,
  ): TypeButtonPanel | null

  Creates a button on the app-bar that will open a panel.

  Parameters

  • buttonProps: IconButtonPropsExtend

    Button properties (icon, tooltip)

  • panelProps: TypePanelProps

    Panel properties (icon, title, content)

  Returns TypeButtonPanel | null

  The created button panel, or null if inputs are missing

getActiveAppBarTab

• getActiveAppBarTab(): ActiveAppBarTabType

  Gets the active app bar tab.

  Returns ActiveAppBarTabType

  The active app bar tab info

  Deprecated

  Legacy support. Should be removed.

getAppBarButtonPanelById

• getAppBarButtonPanelById(buttonPanelId: string): TypeButtonPanel | null

  Gets a button panel from the app-bar by its id.

  Parameters

  • buttonPanelId: string

    The id of the button panel to get

  Returns TypeButtonPanel | null

  The matching button panel, or null if not found

removeAppbarPanel

• removeAppbarPanel(buttonPanelId: string): void

  Removes an app-bar panel using an id.

  Parameters

  • buttonPanelId: string

    The id of the panel to remove

  Returns void

selectTab

• selectTab(tabId: string, open?: boolean, isFocusTrapped?: boolean): void

  Selects a tab by id.

  Parameters

  • tabId: string

    The id of the tab to be selected

  • open: boolean = true

    Optional open (true) or closed (false) panel (default: true)

  • isFocusTrapped: boolean = true

    Optional whether focus should be trapped (default: true)

  Returns void

  Deprecated

  Legacy support. Should use uiController.setActiveAppBarTab directly instead.