0e1f76f

webcomponents-preview · Jan 26, 2024 · a2eafa3 · a2eafa3
1 parent fa44db8
commit a2eafa3
Show file tree

Hide file tree

Showing 6 changed files with 70 additions and 65 deletions.
diff --git a/latest/components/root/root-navigation/root-navigation.component.d.ts b/latest/components/root/root-navigation/root-navigation.component.d.ts
@@ -21,7 +21,7 @@ export declare class RootNavigation extends LitElement {
     private handleKeyDown;
     private handleKeyUp;
     private handleNavigationToggle;
-    protected renderItem(element: Parsed.Element): TemplateResult;
+    protected renderItem({ name, link }: Parsed.GroupedElement): TemplateResult;
     protected renderItems(items: Parsed.GroupedElements, nested?: boolean): TemplateResult | undefined;
     protected render(): TemplateResult;
 }

diff --git a/latest/custom-elements.json b/latest/custom-elements.json
@@ -3796,9 +3796,9 @@
               },
               "parameters": [
                 {
-                  "name": "element",
+                  "name": "{ name, link }",
                   "type": {
-                    "text": "Parsed.Element"
+                    "text": "Parsed.GroupedElement"
                   }
                 }
               ]

diff --git a/latest/index.js b/latest/index.js
diff --git a/latest/index.js.map b/latest/index.js.map
diff --git a/latest/utils/navigation.utils.d.ts b/latest/utils/navigation.utils.d.ts
@@ -1,18 +1,19 @@
+import type { Config } from '../utils/config.utils.js';
 import type * as Parsed from '../utils/parser.types.js';
 export declare const ROUTE_ELEMENTS = "/element";
 export declare const ROUTE_READMES = "/readme";
-type GroupedNavigationItem = {
-    name: string;
-    link: string;
-};
 /**
  * Creates a navigation item for a given readme.
  */
-export declare function prepareReadmeNavigationItem(name: string, url: string): GroupedNavigationItem;
+export declare function prepareReadmeLink(url: string): string;
 /**
  * Creates a navigation item for a given element.
  */
-export declare function prepareElementNavigationItem(element: Parsed.Element): GroupedNavigationItem;
+export declare function prepareElementLink(element: Parsed.Element): string;
+/**
+ * Prepares a grouped navigation structure of readmes and elements.
+ */
+export declare function prepareNavigation(manifest: Parsed.Manifest, config: Config): Parsed.GroupedElements;
 /**
  * Predicate function to match a given content against a list of search terms.
  */
@@ -21,4 +22,3 @@ export declare function matchesSearch(content: string, terms: string[], minSearc
  * Filters the given navigation items by the given search terms recursively.
  */
 export declare function filterItems(items: Parsed.GroupedElements, terms: string[], minSearchLength?: number): Parsed.GroupedElements;
-export {};
diff --git a/latest/utils/parser.types.d.ts b/latest/utils/parser.types.d.ts
@@ -88,7 +88,12 @@ export type Element = {
  * Grouped elements, even nested.
  * The key is either the group or element name.
  */
-export type GroupedElements = Map<string, Element | GroupedElements>;
+export type GroupedElements = Map<string, GroupedElement | GroupedElements>;
+export type GroupedElement = {
+    link: string;
+    name: string;
+    element: Element;
+};
 /**
  * Wraps a manifest to provide additional meta data.
  */