@visma-swno/vsn-navigation 1.1.0-beta.8 → 1.1.0

package/dist/assets/vsn-navigation.d.ts

@@ -16,6 +16,13 @@ declare type BaseTreeItem = {
     id: string;
     /** The label to show for that item, in the relevant language */
     label: string;
+    /** Optional QA identifier rendered as a data-qa-id attribute on the nav item element */
+    'data-qa-id'?: string;
+};
+
+export declare type ButtonClickedEvent = {
+    /** The clicked HTMLButtonElement. Can be used as an anchor to position popups. */
+    target: HTMLButtonElement;
 };
 
 export declare type FeedbackConfig = {
@@ -46,6 +53,8 @@ export declare type NavigationMenu = {
      expand and select that item. When it's not found in items, breadcrumbs will show
      nothing and the side menu will have no element selected */
     currentItem: string;
+    /** Optionally set the current page title. This will be shown as the last item in the breadcrumbs */
+    pageTitle?: string;
     /** Sidebar search config; default disabled when undefined */
     search?: SearchConfig;
 };
@@ -55,6 +64,37 @@ declare type NonEmptyArray<T> = [T, ...T[]];
 export declare type SearchConfig = {
     enabled: boolean;
     shortcut?: string;
+    extraDataSets?: SearchDataSetConfig[];
+};
+
+export declare type SearchDataSetConfig = {
+    /** Stable unique identifier for the dataset, used for selection and lookup */
+    id: string;
+    /** User-facing label for display purposes */
+    label: string;
+    searchFunction: (query: SearchQuery) => Promise<SearchResult>;
+};
+
+export declare class SearchError extends Error {
+    constructor(message: string);
+}
+
+export declare type SearchQuery = {
+    abortController: AbortController;
+    query: string;
+    cursor?: string;
+};
+
+export declare type SearchResult = {
+    nextCursor?: string;
+    results: SearchResultItem[];
+};
+
+export declare type SearchResultItem = {
+    id: string;
+    label: string;
+    url: string;
+    lines?: [string] | [string, string];
 };
 
 export declare type TreeItem = TreeParent | TreeLeaf;
@@ -76,6 +116,7 @@ declare type User = {
 
 export declare type VsnAuth = {
     user: User;
+    profilePictureBaseUrl: string;
     myProfileUrl: string;
 };
 
@@ -105,6 +146,10 @@ export declare class VSNNavigation extends LitElement {
     private _resolvedModules;
     private _modulesLoading;
     private _modulesLoadToken;
+    /** Set at close time: whether focus was inside the side-bar. Gates the focus
+     restore so we don't steal focus when the user closed the side-bar by
+     clicking a focusable element outside (e.g. a top-bar button). */
+    private _restoreFocusToToggle;
     private _resolveModules;
     static styles: CSSResult[];
     willUpdate(changed: Map<string, unknown>): void;
@@ -113,7 +158,23 @@ export declare class VSNNavigation extends LitElement {
     /** Project tree into the shape the side-bar expects: top-level items lifted from the active module. */
     private get _sideBarMenu();
     private _onToggleSideBar;
+    /** Open the side-bar and, once rendered, focus the search field (if enabled).
+     Shared by the hamburger toggle and the CTRL/Cmd+K shortcut. */
+    private _openAndFocusSearch;
     private _onSideBarClose;
+    /** Close the side-bar. Captures `:focus-within` BEFORE flipping the state, since
+     the side-bar becomes display:none and the check would then always be false. */
+    private _closeSideBar;
+    updated(changed: Map<string, unknown>): void;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    /** CTRL+K (Cmd+K on Mac) opens the side-bar and focuses the search field (if enabled). */
+    private _onShortcut;
+    /** Escape closes the side-bar when nothing is focused. Skips when focus is on
+     any element — including inside the side-bar's shadow (activeElement is then
+     the host `<vsn-side-bar>`, not body), so existing in-component Escape
+     handlers (search input clear-then-close) keep their priority. */
+    private _onDocEscape;
     private _onTopBarClick;
     render(): TemplateResult<1>;
 }