element-book 7.0.2 → 7.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -12,5 +12,4 @@ export declare function createBookTreeFromEntries({ entries, everythingTitle, ev
12
12
  debug: boolean;
13
13
  }): BookTree;
14
14
  export declare function traverseToImmediateParent(entryOrNode: Readonly<BookEntry> | BookTreeNode, currentTree: Readonly<BookTreeNode>): BookTreeNode | undefined;
15
- export declare function getSortedNodeChildren(nodeA: Readonly<BookTreeNode>, nodeB: Readonly<BookTreeNode>): number;
16
15
  export declare function flattenTree(node: Readonly<BookTreeNode>): BookTreeNode[];
@@ -122,24 +122,11 @@ export function traverseToImmediateParent(entryOrNode, currentTree) {
122
122
  }, currentTree);
123
123
  return immediateParentNode;
124
124
  }
125
- export function getSortedNodeChildren(nodeA, nodeB) {
126
- if (nodeA.entry.entryType !== nodeB.entry.entryType) {
127
- if (isBookEntry(nodeA.entry, BookEntryTypeEnum.ElementExample)) {
128
- return -1;
129
- }
130
- if (isBookEntry(nodeB.entry, BookEntryTypeEnum.ElementExample)) {
131
- return 1;
132
- }
133
- }
134
- return nodeA.entry.title.localeCompare(nodeB.entry.title);
135
- }
136
125
  export function flattenTree(node) {
137
126
  const hasErrors = !!node.entry.errors.length;
138
127
  const childNodes = hasErrors
139
128
  ? []
140
- : Object.values(node.children)
141
- .sort(getSortedNodeChildren)
142
- .map((child) => flattenTree(child));
129
+ : Object.values(node.children).map((child) => flattenTree(child));
143
130
  const entries = [
144
131
  node,
145
132
  ...childNodes,
@@ -5,3 +5,4 @@ export declare const BookNav: import("element-vir").DeclarativeElementDefinition
5
5
  selectedPath: ReadonlyArray<string> | undefined;
6
6
  router: BookRouter | undefined;
7
7
  }, {}, {}, `book-nav-${string}`, "book-nav-internal-indent", import("lit-html").HTMLTemplateResult>;
8
+ export declare function scrollSelectedNavElementIntoView(bookNavInstance: typeof BookNav.instanceType): Promise<void>;
@@ -1,3 +1,4 @@
1
+ import { checkIfEntirelyInScrollView, waitForAnimationFrame } from '@augment-vir/browser';
1
2
  import { areJsonEqual } from '@augment-vir/common';
2
3
  import { assign, classMap, css, html, renderIf } from 'element-vir';
3
4
  import { Element16Icon, ViraIcon } from 'vira';
@@ -112,3 +113,14 @@ export const BookNav = defineBookElement()({
112
113
  `;
113
114
  },
114
115
  });
116
+ export async function scrollSelectedNavElementIntoView(bookNavInstance) {
117
+ await waitForAnimationFrame(2);
118
+ const selected = bookNavInstance.shadowRoot.querySelector('.selected');
119
+ if (!selected) {
120
+ throw new Error('Failed to find selected nav tree element.');
121
+ }
122
+ if (await checkIfEntirelyInScrollView(selected)) {
123
+ return;
124
+ }
125
+ selected.scrollIntoView({ behavior: 'smooth', block: 'center' });
126
+ }
@@ -8,7 +8,7 @@ import { createBookRouter } from '../../../routing/create-book-router';
8
8
  import { colorThemeCssVars, setThemeCssVars } from '../../color-theme/color-theme';
9
9
  import { createTheme } from '../../color-theme/create-color-theme';
10
10
  import { ChangeRouteEvent } from '../../events/change-route.event';
11
- import { BookNav } from '../book-nav.element';
11
+ import { BookNav, scrollSelectedNavElementIntoView } from '../book-nav.element';
12
12
  import { BookError } from '../common/book-error.element';
13
13
  import { BookEntryDisplay } from '../entry-display/book-entry-display.element';
14
14
  import { BookPageControls } from '../entry-display/book-page/book-page-controls.element';
@@ -65,6 +65,11 @@ export const ElementBookApp = defineElement()({
65
65
  top: 0;
66
66
  }
67
67
  `,
68
+ initCallback({ host }) {
69
+ setTimeout(() => {
70
+ scrollNav(host);
71
+ }, 1000);
72
+ },
68
73
  cleanupCallback({ state, updateState }) {
69
74
  if (state.router) {
70
75
  state.router.removeAllRouteListeners();
@@ -167,6 +172,11 @@ export const ElementBookApp = defineElement()({
167
172
  console.error(`Failed to find '${BookEntryDisplay.tagName}' for scrolling.`);
168
173
  }
169
174
  updateRoutes(event.detail);
175
+ const navElement = host.shadowRoot.querySelector(BookNav.tagName);
176
+ if (!(navElement instanceof BookNav)) {
177
+ throw new Error(`Failed to find child '${BookNav.tagName}'`);
178
+ }
179
+ scrollNav(host);
170
180
  })}
171
181
  ${listen(BookPageControls.events.controlValueChange, (event) => {
172
182
  if (!state.treeBasedCurrentControls) {
@@ -221,3 +231,10 @@ export const ElementBookApp = defineElement()({
221
231
  }
222
232
  },
223
233
  });
234
+ async function scrollNav(host) {
235
+ const navElement = host.shadowRoot.querySelector(BookNav.tagName);
236
+ if (!(navElement instanceof BookNav)) {
237
+ throw new Error(`Failed to find child '${BookNav.tagName}'`);
238
+ }
239
+ await scrollSelectedNavElementIntoView(navElement);
240
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "element-book",
3
- "version": "7.0.2",
3
+ "version": "7.0.4",
4
4
  "keywords": [
5
5
  "book",
6
6
  "design system",
@@ -39,18 +39,18 @@
39
39
  "test:watch": "web-test-runner --color --watch --config configs/web-test-runner.config.mjs"
40
40
  },
41
41
  "dependencies": {
42
- "@augment-vir/browser": "^15.2.1",
43
- "@augment-vir/common": "^15.2.1",
42
+ "@augment-vir/browser": "^15.3.0",
43
+ "@augment-vir/common": "^15.3.0",
44
44
  "colorjs.io": "0.4.3",
45
45
  "element-vir": "^14.0.3",
46
46
  "lit-css-vars": "^2.0.3",
47
47
  "object-shape-tester": "^0.3.0",
48
48
  "spa-router-vir": "^2.1.0",
49
49
  "typed-event-target": "^1.2.1",
50
- "vira": "^0.5.0"
50
+ "vira": "^0.5.1"
51
51
  },
52
52
  "devDependencies": {
53
- "@augment-vir/browser-testing": "^15.2.1",
53
+ "@augment-vir/browser-testing": "^15.3.0",
54
54
  "@open-wc/testing": "^3.2.0",
55
55
  "@types/chai": "^4.3.5",
56
56
  "@types/mocha": "^10.0.1",