@internetarchive/collection-browser 1.8.0 → 1.9.0-alpha1

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.
Files changed (269) hide show
  1. package/.editorconfig +29 -29
  2. package/.github/workflows/ci.yml +26 -26
  3. package/.github/workflows/gh-pages-main.yml +39 -39
  4. package/.github/workflows/npm-publish.yml +39 -39
  5. package/.github/workflows/pr-preview.yml +38 -38
  6. package/.husky/pre-commit +4 -4
  7. package/LICENSE +661 -661
  8. package/README.md +83 -83
  9. package/dist/index.d.ts +9 -9
  10. package/dist/index.js +9 -9
  11. package/dist/src/app-root.d.ts +54 -54
  12. package/dist/src/app-root.js +293 -293
  13. package/dist/src/assets/img/icons/arrow-left.d.ts +2 -2
  14. package/dist/src/assets/img/icons/arrow-left.js +2 -2
  15. package/dist/src/assets/img/icons/arrow-right.d.ts +2 -2
  16. package/dist/src/assets/img/icons/arrow-right.js +2 -2
  17. package/dist/src/assets/img/icons/chevron.d.ts +2 -2
  18. package/dist/src/assets/img/icons/chevron.js +2 -2
  19. package/dist/src/assets/img/icons/contract.d.ts +2 -2
  20. package/dist/src/assets/img/icons/contract.js +2 -2
  21. package/dist/src/assets/img/icons/empty-query.d.ts +2 -2
  22. package/dist/src/assets/img/icons/empty-query.js +2 -2
  23. package/dist/src/assets/img/icons/expand.d.ts +2 -2
  24. package/dist/src/assets/img/icons/expand.js +2 -2
  25. package/dist/src/assets/img/icons/eye-closed.d.ts +2 -2
  26. package/dist/src/assets/img/icons/eye-closed.js +2 -2
  27. package/dist/src/assets/img/icons/eye.d.ts +2 -2
  28. package/dist/src/assets/img/icons/eye.js +2 -2
  29. package/dist/src/assets/img/icons/favorite-filled.d.ts +1 -1
  30. package/dist/src/assets/img/icons/favorite-filled.js +2 -2
  31. package/dist/src/assets/img/icons/login-required.d.ts +1 -1
  32. package/dist/src/assets/img/icons/login-required.js +2 -2
  33. package/dist/src/assets/img/icons/mediatype/account.d.ts +1 -1
  34. package/dist/src/assets/img/icons/mediatype/account.js +2 -2
  35. package/dist/src/assets/img/icons/mediatype/audio.d.ts +1 -1
  36. package/dist/src/assets/img/icons/mediatype/audio.js +2 -2
  37. package/dist/src/assets/img/icons/mediatype/collection.d.ts +1 -1
  38. package/dist/src/assets/img/icons/mediatype/collection.js +2 -2
  39. package/dist/src/assets/img/icons/mediatype/data.d.ts +1 -1
  40. package/dist/src/assets/img/icons/mediatype/data.js +2 -2
  41. package/dist/src/assets/img/icons/mediatype/etree.d.ts +1 -1
  42. package/dist/src/assets/img/icons/mediatype/etree.js +2 -2
  43. package/dist/src/assets/img/icons/mediatype/film.d.ts +1 -1
  44. package/dist/src/assets/img/icons/mediatype/film.js +2 -2
  45. package/dist/src/assets/img/icons/mediatype/images.d.ts +1 -1
  46. package/dist/src/assets/img/icons/mediatype/images.js +2 -2
  47. package/dist/src/assets/img/icons/mediatype/radio.d.ts +1 -1
  48. package/dist/src/assets/img/icons/mediatype/radio.js +2 -2
  49. package/dist/src/assets/img/icons/mediatype/software.d.ts +1 -1
  50. package/dist/src/assets/img/icons/mediatype/software.js +2 -2
  51. package/dist/src/assets/img/icons/mediatype/texts.d.ts +1 -1
  52. package/dist/src/assets/img/icons/mediatype/texts.js +2 -2
  53. package/dist/src/assets/img/icons/mediatype/tv.d.ts +1 -1
  54. package/dist/src/assets/img/icons/mediatype/tv.js +2 -2
  55. package/dist/src/assets/img/icons/mediatype/video.d.ts +1 -1
  56. package/dist/src/assets/img/icons/mediatype/video.js +2 -2
  57. package/dist/src/assets/img/icons/mediatype/web.d.ts +1 -1
  58. package/dist/src/assets/img/icons/mediatype/web.js +2 -2
  59. package/dist/src/assets/img/icons/null-result.d.ts +2 -2
  60. package/dist/src/assets/img/icons/null-result.js +2 -2
  61. package/dist/src/assets/img/icons/restricted.d.ts +1 -1
  62. package/dist/src/assets/img/icons/restricted.js +2 -2
  63. package/dist/src/assets/img/icons/reviews.d.ts +1 -1
  64. package/dist/src/assets/img/icons/reviews.js +2 -2
  65. package/dist/src/assets/img/icons/upload.d.ts +1 -1
  66. package/dist/src/assets/img/icons/upload.js +2 -2
  67. package/dist/src/assets/img/icons/views.d.ts +1 -1
  68. package/dist/src/assets/img/icons/views.js +2 -2
  69. package/dist/src/circular-activity-indicator.d.ts +5 -5
  70. package/dist/src/circular-activity-indicator.js +17 -17
  71. package/dist/src/collection-browser.d.ts +469 -469
  72. package/dist/src/collection-browser.js +1666 -1653
  73. package/dist/src/collection-browser.js.map +1 -1
  74. package/dist/src/collection-facets/facet-tombstone-row.d.ts +5 -5
  75. package/dist/src/collection-facets/facet-tombstone-row.js +15 -15
  76. package/dist/src/collection-facets/facets-template.d.ts +20 -20
  77. package/dist/src/collection-facets/facets-template.js +152 -152
  78. package/dist/src/collection-facets/more-facets-content.d.ts +77 -77
  79. package/dist/src/collection-facets/more-facets-content.js +359 -359
  80. package/dist/src/collection-facets/more-facets-pagination.d.ts +36 -36
  81. package/dist/src/collection-facets/more-facets-pagination.js +196 -196
  82. package/dist/src/collection-facets/toggle-switch.d.ts +41 -41
  83. package/dist/src/collection-facets/toggle-switch.js +94 -94
  84. package/dist/src/collection-facets.d.ts +99 -99
  85. package/dist/src/collection-facets.js +471 -471
  86. package/dist/src/empty-placeholder.d.ts +21 -21
  87. package/dist/src/empty-placeholder.js +69 -69
  88. package/dist/src/expanded-date-picker.d.ts +43 -43
  89. package/dist/src/expanded-date-picker.js +109 -109
  90. package/dist/src/language-code-handler/language-code-handler.d.ts +37 -37
  91. package/dist/src/language-code-handler/language-code-handler.js +26 -26
  92. package/dist/src/language-code-handler/language-code-mapping.d.ts +1 -1
  93. package/dist/src/language-code-handler/language-code-mapping.js +562 -562
  94. package/dist/src/mediatype/mediatype-config.d.ts +3 -3
  95. package/dist/src/mediatype/mediatype-config.js +85 -85
  96. package/dist/src/models.d.ts +162 -149
  97. package/dist/src/models.js +256 -195
  98. package/dist/src/models.js.map +1 -1
  99. package/dist/src/restoration-state-handler.d.ts +70 -63
  100. package/dist/src/restoration-state-handler.js +355 -326
  101. package/dist/src/restoration-state-handler.js.map +1 -1
  102. package/dist/src/sort-filter-bar/alpha-bar-tooltip.d.ts +6 -6
  103. package/dist/src/sort-filter-bar/alpha-bar-tooltip.js +24 -24
  104. package/dist/src/sort-filter-bar/alpha-bar.d.ts +21 -21
  105. package/dist/src/sort-filter-bar/alpha-bar.js +128 -128
  106. package/dist/src/sort-filter-bar/img/compact.d.ts +1 -1
  107. package/dist/src/sort-filter-bar/img/compact.js +2 -2
  108. package/dist/src/sort-filter-bar/img/list.d.ts +1 -1
  109. package/dist/src/sort-filter-bar/img/list.js +2 -2
  110. package/dist/src/sort-filter-bar/img/sort-toggle-disabled.d.ts +1 -1
  111. package/dist/src/sort-filter-bar/img/sort-toggle-disabled.js +2 -2
  112. package/dist/src/sort-filter-bar/img/sort-toggle-down.d.ts +1 -1
  113. package/dist/src/sort-filter-bar/img/sort-toggle-down.js +2 -2
  114. package/dist/src/sort-filter-bar/img/sort-toggle-up.d.ts +1 -1
  115. package/dist/src/sort-filter-bar/img/sort-toggle-up.js +2 -2
  116. package/dist/src/sort-filter-bar/img/sort-triangle.d.ts +1 -1
  117. package/dist/src/sort-filter-bar/img/sort-triangle.js +2 -2
  118. package/dist/src/sort-filter-bar/img/tile.d.ts +1 -1
  119. package/dist/src/sort-filter-bar/img/tile.js +2 -2
  120. package/dist/src/sort-filter-bar/sort-filter-bar.d.ts +201 -199
  121. package/dist/src/sort-filter-bar/sort-filter-bar.js +622 -617
  122. package/dist/src/sort-filter-bar/sort-filter-bar.js.map +1 -1
  123. package/dist/src/styles/item-image-styles.d.ts +8 -8
  124. package/dist/src/styles/item-image-styles.js +9 -9
  125. package/dist/src/styles/sr-only.d.ts +1 -1
  126. package/dist/src/styles/sr-only.js +2 -2
  127. package/dist/src/tiles/base-tile-component.d.ts +18 -18
  128. package/dist/src/tiles/base-tile-component.js +59 -59
  129. package/dist/src/tiles/collection-browser-loading-tile.d.ts +5 -5
  130. package/dist/src/tiles/collection-browser-loading-tile.js +15 -15
  131. package/dist/src/tiles/grid/account-tile.d.ts +18 -18
  132. package/dist/src/tiles/grid/account-tile.js +72 -72
  133. package/dist/src/tiles/grid/collection-tile.d.ts +15 -15
  134. package/dist/src/tiles/grid/collection-tile.js +80 -80
  135. package/dist/src/tiles/grid/item-tile.d.ts +27 -27
  136. package/dist/src/tiles/grid/item-tile.js +134 -134
  137. package/dist/src/tiles/grid/styles/tile-grid-shared-styles.d.ts +1 -1
  138. package/dist/src/tiles/grid/styles/tile-grid-shared-styles.js +8 -8
  139. package/dist/src/tiles/grid/tile-stats.d.ts +11 -11
  140. package/dist/src/tiles/grid/tile-stats.js +48 -48
  141. package/dist/src/tiles/hover/hover-pane-controller.d.ts +219 -219
  142. package/dist/src/tiles/hover/hover-pane-controller.js +352 -352
  143. package/dist/src/tiles/hover/tile-hover-pane.d.ts +15 -15
  144. package/dist/src/tiles/hover/tile-hover-pane.js +38 -38
  145. package/dist/src/tiles/image-block.d.ts +17 -17
  146. package/dist/src/tiles/image-block.js +72 -72
  147. package/dist/src/tiles/item-image.d.ts +35 -35
  148. package/dist/src/tiles/item-image.js +117 -117
  149. package/dist/src/tiles/list/tile-list-compact-header.d.ts +6 -6
  150. package/dist/src/tiles/list/tile-list-compact-header.js +38 -38
  151. package/dist/src/tiles/list/tile-list-compact.d.ts +15 -15
  152. package/dist/src/tiles/list/tile-list-compact.js +114 -114
  153. package/dist/src/tiles/list/tile-list.d.ts +46 -46
  154. package/dist/src/tiles/list/tile-list.js +298 -298
  155. package/dist/src/tiles/mediatype-icon.d.ts +9 -9
  156. package/dist/src/tiles/mediatype-icon.js +47 -47
  157. package/dist/src/tiles/overlay/icon-overlay.d.ts +10 -10
  158. package/dist/src/tiles/overlay/icon-overlay.js +40 -40
  159. package/dist/src/tiles/overlay/icon-text-overlay.d.ts +9 -9
  160. package/dist/src/tiles/overlay/icon-text-overlay.js +38 -38
  161. package/dist/src/tiles/overlay/text-overlay.d.ts +10 -10
  162. package/dist/src/tiles/overlay/text-overlay.js +42 -42
  163. package/dist/src/tiles/text-snippet-block.d.ts +27 -27
  164. package/dist/src/tiles/text-snippet-block.js +73 -73
  165. package/dist/src/tiles/tile-dispatcher.d.ts +50 -50
  166. package/dist/src/tiles/tile-dispatcher.js +185 -185
  167. package/dist/src/tiles/tile-display-value-provider.d.ts +43 -43
  168. package/dist/src/tiles/tile-display-value-provider.js +80 -80
  169. package/dist/src/utils/analytics-events.d.ts +24 -24
  170. package/dist/src/utils/analytics-events.js +26 -26
  171. package/dist/src/utils/array-equals.d.ts +4 -4
  172. package/dist/src/utils/array-equals.js +10 -10
  173. package/dist/src/utils/format-count.d.ts +7 -7
  174. package/dist/src/utils/format-count.js +76 -76
  175. package/dist/src/utils/format-date.d.ts +2 -2
  176. package/dist/src/utils/format-date.js +25 -25
  177. package/dist/src/utils/format-unit-size.d.ts +2 -2
  178. package/dist/src/utils/format-unit-size.js +33 -33
  179. package/dist/src/utils/local-date-from-utc.d.ts +9 -9
  180. package/dist/src/utils/local-date-from-utc.js +15 -15
  181. package/dist/src/utils/sha1.d.ts +2 -2
  182. package/dist/src/utils/sha1.js +8 -8
  183. package/dist/test/collection-browser.test.d.ts +1 -1
  184. package/dist/test/collection-browser.test.js +808 -808
  185. package/dist/test/collection-facets/facets-template.test.d.ts +1 -1
  186. package/dist/test/collection-facets/facets-template.test.js +134 -134
  187. package/dist/test/collection-facets/more-facets-content.test.d.ts +1 -1
  188. package/dist/test/collection-facets/more-facets-content.test.js +133 -133
  189. package/dist/test/collection-facets/more-facets-pagination.test.d.ts +1 -1
  190. package/dist/test/collection-facets/more-facets-pagination.test.js +117 -117
  191. package/dist/test/collection-facets/toggle-switch.test.d.ts +1 -1
  192. package/dist/test/collection-facets/toggle-switch.test.js +73 -73
  193. package/dist/test/collection-facets.test.d.ts +2 -2
  194. package/dist/test/collection-facets.test.js +645 -645
  195. package/dist/test/empty-placeholder.test.d.ts +1 -1
  196. package/dist/test/empty-placeholder.test.js +56 -56
  197. package/dist/test/expanded-date-picker.test.d.ts +1 -1
  198. package/dist/test/expanded-date-picker.test.js +95 -95
  199. package/dist/test/icon-overlay.test.d.ts +1 -1
  200. package/dist/test/icon-overlay.test.js +24 -24
  201. package/dist/test/image-block.test.d.ts +1 -1
  202. package/dist/test/image-block.test.js +48 -48
  203. package/dist/test/item-image.test.d.ts +1 -1
  204. package/dist/test/item-image.test.js +84 -84
  205. package/dist/test/mediatype-config.test.d.ts +1 -1
  206. package/dist/test/mediatype-config.test.js +16 -16
  207. package/dist/test/mocks/mock-analytics-handler.d.ts +10 -10
  208. package/dist/test/mocks/mock-analytics-handler.js +15 -15
  209. package/dist/test/mocks/mock-collection-name-cache.d.ts +9 -9
  210. package/dist/test/mocks/mock-collection-name-cache.js +17 -17
  211. package/dist/test/mocks/mock-search-responses.d.ts +19 -19
  212. package/dist/test/mocks/mock-search-responses.js +623 -623
  213. package/dist/test/mocks/mock-search-service.d.ts +15 -15
  214. package/dist/test/mocks/mock-search-service.js +48 -48
  215. package/dist/test/restoration-state-handler.test.d.ts +1 -1
  216. package/dist/test/restoration-state-handler.test.js +270 -218
  217. package/dist/test/restoration-state-handler.test.js.map +1 -1
  218. package/dist/test/sort-filter-bar/alpha-bar-tooltip.test.d.ts +1 -1
  219. package/dist/test/sort-filter-bar/alpha-bar-tooltip.test.js +12 -12
  220. package/dist/test/sort-filter-bar/alpha-bar.test.d.ts +1 -1
  221. package/dist/test/sort-filter-bar/alpha-bar.test.js +73 -73
  222. package/dist/test/sort-filter-bar/sort-filter-bar.test.d.ts +1 -1
  223. package/dist/test/sort-filter-bar/sort-filter-bar.test.js +378 -378
  224. package/dist/test/text-overlay.test.d.ts +1 -1
  225. package/dist/test/text-overlay.test.js +48 -48
  226. package/dist/test/text-snippet-block.test.d.ts +1 -1
  227. package/dist/test/text-snippet-block.test.js +57 -57
  228. package/dist/test/tile-stats.test.d.ts +1 -1
  229. package/dist/test/tile-stats.test.js +33 -33
  230. package/dist/test/tiles/grid/account-tile.test.d.ts +1 -1
  231. package/dist/test/tiles/grid/account-tile.test.js +76 -76
  232. package/dist/test/tiles/grid/collection-tile.test.d.ts +1 -1
  233. package/dist/test/tiles/grid/collection-tile.test.js +73 -73
  234. package/dist/test/tiles/grid/item-tile.test.d.ts +1 -1
  235. package/dist/test/tiles/grid/item-tile.test.js +254 -254
  236. package/dist/test/tiles/hover/hover-pane-controller.test.d.ts +1 -1
  237. package/dist/test/tiles/hover/hover-pane-controller.test.js +257 -257
  238. package/dist/test/tiles/hover/tile-hover-pane.test.d.ts +1 -1
  239. package/dist/test/tiles/hover/tile-hover-pane.test.js +13 -13
  240. package/dist/test/tiles/list/tile-list-compact.test.d.ts +1 -1
  241. package/dist/test/tiles/list/tile-list-compact.test.js +143 -143
  242. package/dist/test/tiles/list/tile-list.test.d.ts +1 -1
  243. package/dist/test/tiles/list/tile-list.test.js +242 -242
  244. package/dist/test/tiles/tile-dispatcher.test.d.ts +1 -1
  245. package/dist/test/tiles/tile-dispatcher.test.js +67 -67
  246. package/dist/test/tiles/tile-display-value-provider.test.d.ts +1 -1
  247. package/dist/test/tiles/tile-display-value-provider.test.js +141 -141
  248. package/dist/test/utils/array-equals.test.d.ts +1 -1
  249. package/dist/test/utils/array-equals.test.js +26 -26
  250. package/dist/test/utils/format-count.test.d.ts +1 -1
  251. package/dist/test/utils/format-count.test.js +23 -23
  252. package/dist/test/utils/format-date.test.d.ts +1 -1
  253. package/dist/test/utils/format-date.test.js +17 -17
  254. package/dist/test/utils/format-unit-size.test.d.ts +1 -1
  255. package/dist/test/utils/format-unit-size.test.js +17 -17
  256. package/dist/test/utils/local-date-from-utc.test.d.ts +1 -1
  257. package/dist/test/utils/local-date-from-utc.test.js +26 -26
  258. package/local.archive.org.cert +86 -86
  259. package/local.archive.org.key +27 -27
  260. package/package.json +1 -1
  261. package/renovate.json +6 -6
  262. package/src/collection-browser.ts +24 -8
  263. package/src/models.ts +193 -109
  264. package/src/restoration-state-handler.ts +66 -40
  265. package/src/sort-filter-bar/sort-filter-bar.ts +34 -27
  266. package/test/restoration-state-handler.test.ts +68 -1
  267. package/tsconfig.json +21 -21
  268. package/web-dev-server.config.mjs +30 -30
  269. package/web-test-runner.config.mjs +41 -41
@@ -1,5 +1,5 @@
1
- import { svg } from 'lit';
1
+ import { svg } from 'lit';
2
2
  export const sortIcon = svg `
3
3
  <svg viewBox="0 0 100 55" xmlns="http://www.w3.org/2000/svg"><path d="m50 0 50 55h-100z"/></svg>
4
- `;
4
+ `;
5
5
  //# sourceMappingURL=sort-triangle.js.map
@@ -1 +1 @@
1
- export declare const tileIcon: import("lit-html").TemplateResult<2>;
1
+ export declare const tileIcon: import("lit-html").TemplateResult<2>;
@@ -1,5 +1,5 @@
1
- import { svg } from 'lit';
1
+ import { svg } from 'lit';
2
2
  export const tileIcon = svg `
3
3
  <svg viewBox="0 0 100 100" xmlns="http://www.w3.org/2000/svg"><path d="m64 54v46h-28v-46zm36 0v46h-28v-46zm-72 0v46h-28v-46zm36-54v46h-28v-46zm36 0v46h-28v-46zm-72 0v46h-28v-46z"/></svg>
4
- `;
4
+ `;
5
5
  //# sourceMappingURL=tile.js.map
@@ -1,199 +1,201 @@
1
- import { LitElement, PropertyValues, TemplateResult } from 'lit';
2
- import type { SharedResizeObserverInterface, SharedResizeObserverResizeHandlerInterface } from '@internetarchive/shared-resize-observer';
3
- import '@internetarchive/ia-dropdown';
4
- import type { SortDirection } from '@internetarchive/search-service';
5
- import { CollectionDisplayMode, PrefixFilterCounts, PrefixFilterType, SortField } from '../models';
6
- import './alpha-bar';
7
- declare type AlphaSelector = 'creator' | 'title';
8
- export declare class SortFilterBar extends LitElement implements SharedResizeObserverResizeHandlerInterface {
9
- /** Which display mode the tiles are being rendered with (grid/list-detail/list-compact) */
10
- displayMode?: CollectionDisplayMode;
11
- /** The default sort direction to use if none is set */
12
- defaultSortDirection: SortDirection | null;
13
- /** The default sort field to use if none is set */
14
- defaultSortField: Exclude<SortField, SortField.default>;
15
- /** The current sort direction (asc/desc), or null if none is set */
16
- sortDirection: SortDirection | null;
17
- /** The field currently being sorted on (e.g., 'title'). Defaults to relevance. */
18
- selectedSort: SortField;
19
- /** The currently selected title letter filter, or null if none is set */
20
- selectedTitleFilter: string | null;
21
- /** The currently selected creator letter filter, or null if none is set */
22
- selectedCreatorFilter: string | null;
23
- /** Whether to show the Relevance sort option (default `true`) */
24
- showRelevance: boolean;
25
- /** Maps of result counts for letters on the alphabet bar, for each letter filter type */
26
- prefixFilterCountMap?: Record<PrefixFilterType, PrefixFilterCounts>;
27
- resizeObserver?: SharedResizeObserverInterface;
28
- /**
29
- * Which of the alphabet bars (title/creator) should be shown, or null if one
30
- * should not currently be rendered.
31
- */
32
- alphaSelectorVisible: AlphaSelector | null;
33
- /**
34
- * Whether the transparent backdrop to catch clicks outside the dropdown menu
35
- * should be rendered.
36
- */
37
- dropdownBackdropVisible: boolean;
38
- /**
39
- * The width of the desktop view sort option container, updated upon each resize.
40
- * Used for dynamically determining whether to use desktop or mobile view.
41
- */
42
- desktopSortContainerWidth: number;
43
- /**
44
- * The width of the full sort bar, updated upon each resize.
45
- * Used for dynamically determining whether to use desktop or mobile view.
46
- */
47
- selectorBarContainerWidth: number;
48
- /**
49
- * The container for all the desktop view's sort options.
50
- * Used for dynamically determining whether to use desktop or mobile view.
51
- */
52
- private desktopSortContainer;
53
- /**
54
- * The container for the full sort bar.
55
- * Used for dynamically determining whether to use desktop or mobile view.
56
- */
57
- private sortSelectorContainer;
58
- /** The dropdown component containing options for weekly and all-time views */
59
- private viewsDropdown;
60
- /** The dropdown component containing the four date options */
61
- private dateDropdown;
62
- /** The single, consolidated dropdown component shown in mobile view */
63
- private mobileDropdown;
64
- render(): TemplateResult<1>;
65
- updated(changed: PropertyValues): void;
66
- private setupEscapeListeners;
67
- private boundSortBarSelectorEscapeListener;
68
- disconnectedCallback(): void;
69
- private disconnectResizeObserver;
70
- private setupResizeObserver;
71
- handleResize(entry: ResizeObserverEntry): void;
72
- /**
73
- * Whether to show the mobile sort bar because there is not enough space
74
- * for the desktop sort bar.
75
- */
76
- private get mobileSelectorVisible();
77
- /**
78
- * Template to render the alphabet bar, or `nothing` if it should not be rendered
79
- * for the current sort
80
- */
81
- private get alphaBarTemplate();
82
- /** Template to render the sort direction toggle button */
83
- private get sortDirectionSelectorTemplate();
84
- /** Template to render the sort direction button's icon in the correct current state */
85
- private get sortDirectionIcon();
86
- /** The template to render all the sort options in desktop view */
87
- private get desktopSortSelectorTemplate();
88
- /** The template to render all the sort options in mobile view */
89
- private get mobileSortSelectorTemplate();
90
- /**
91
- * This generates each of the non-dropdown sort option links.
92
- *
93
- * It manages the display value and the selected state of the option.
94
- *
95
- * @param sortField
96
- * @param options {
97
- * onClick?: (e: Event) => void; If this is provided, it will also be called when the option is clicked.
98
- * displayName?: TemplateResult; The name to display for the option. Defaults to the sortField display name.
99
- * selected?: boolean; true if the option is selected. Defaults to the selectedSort === sortField.
100
- * }
101
- * @returns
102
- */
103
- private getSortDisplayOption;
104
- /**
105
- * Generates a dropdown component containing multiple grouped sort options.
106
- *
107
- * @param options.displayName The name to use for the dropdown's visible label
108
- * @param options.id The id to apply to the dropdown element
109
- * @param options.dropdownOptions An array of option objects used to populate the dropdown
110
- * @param options.selectedOption The id of the option that should be initially selected
111
- * @param options.selected A boolean indicating whether this dropdown should use its
112
- * selected appearance
113
- * @param options.onOptionSelected A handler for optionSelected events coming from the dropdown
114
- * @param options.onDropdownClick A handler for click events on the dropdown
115
- * @param options.onLabelInteraction A handler for click events and Enter/Space keydown events
116
- * on the dropdown's label
117
- */
118
- private getSortDropdown;
119
- /** Generates a single dropdown option object for the given sort field */
120
- private getDropdownOption;
121
- /** Handler for when any sort dropdown option is selected */
122
- private dropdownOptionSelected;
123
- /** The template to render for the views dropdown */
124
- private get viewsDropdownTemplate();
125
- /** The template to render for the date dropdown */
126
- private get dateDropdownTemplate();
127
- /** Handler for when a new mobile sort dropdown option is selected */
128
- private mobileSortChanged;
129
- /** Template for rendering the three display mode options */
130
- private get displayOptionTemplate();
131
- /**
132
- * Template for rendering the transparent backdrop to capture clicks outside the
133
- * dropdown menu while it is open.
134
- */
135
- private get dropdownBackdrop();
136
- /** Closes all of the sorting dropdown components' menus */
137
- private closeDropdowns;
138
- private selectDropdownSortField;
139
- private clearAlphaBarFilters;
140
- private setSortDirection;
141
- /** Toggles the current sort direction between 'asc' and 'desc' */
142
- private toggleSortDirection;
143
- private handleSortDirectionClicked;
144
- private setSelectedSort;
145
- /** The current sort field, or the default one if no explicit sort is set */
146
- private get finalizedSortField();
147
- /** The current sort direction, or the default one if no explicit direction is set */
148
- private get finalizedSortDirection();
149
- /**
150
- * There are four date sort options.
151
- *
152
- * This checks to see if the current sort is one of them.
153
- *
154
- * @readonly
155
- * @private
156
- * @type {boolean}
157
- * @memberof SortFilterBar
158
- */
159
- private get dateOptionSelected();
160
- /**
161
- * There are two view sort options.
162
- *
163
- * This checks to see if the current sort is one of them.
164
- *
165
- * @readonly
166
- * @private
167
- * @type {boolean}
168
- * @memberof SortFilterBar
169
- */
170
- private get viewOptionSelected();
171
- /**
172
- * The display name of the current date field
173
- *
174
- * @readonly
175
- * @private
176
- * @type {string}
177
- * @memberof SortFilterBar
178
- */
179
- private get dateSortField();
180
- /**
181
- * The display name of the current view field
182
- *
183
- * @readonly
184
- * @private
185
- * @type {string}
186
- * @memberof SortFilterBar
187
- */
188
- private get viewSortField();
189
- private get titleSelectorBar();
190
- private get creatorSelectorBar();
191
- private titleLetterChanged;
192
- private creatorLetterChanged;
193
- private emitTitleLetterChangedEvent;
194
- private emitCreatorLetterChangedEvent;
195
- private displayModeChanged;
196
- private emitSortChangedEvent;
197
- static get styles(): import("lit").CSSResult[];
198
- }
199
- export {};
1
+ import { LitElement, PropertyValues, TemplateResult } from 'lit';
2
+ import type { SharedResizeObserverInterface, SharedResizeObserverResizeHandlerInterface } from '@internetarchive/shared-resize-observer';
3
+ import '@internetarchive/ia-dropdown';
4
+ import type { SortDirection } from '@internetarchive/search-service';
5
+ import { CollectionDisplayMode, PrefixFilterCounts, PrefixFilterType, SortField } from '../models';
6
+ import './alpha-bar';
7
+ declare type AlphaSelector = 'creator' | 'title';
8
+ export declare class SortFilterBar extends LitElement implements SharedResizeObserverResizeHandlerInterface {
9
+ /** Which display mode the tiles are being rendered with (grid/list-detail/list-compact) */
10
+ displayMode?: CollectionDisplayMode;
11
+ /** The default sort direction to use if none is set */
12
+ defaultSortDirection: SortDirection | null;
13
+ /** The default sort field to use if none is set */
14
+ defaultSortField: Exclude<SortField, SortField.default>;
15
+ /** The current sort direction (asc/desc), or null if none is set */
16
+ sortDirection: SortDirection | null;
17
+ /** The field currently being sorted on (e.g., 'title'). Defaults to relevance. */
18
+ selectedSort: SortField;
19
+ /** The currently selected title letter filter, or null if none is set */
20
+ selectedTitleFilter: string | null;
21
+ /** The currently selected creator letter filter, or null if none is set */
22
+ selectedCreatorFilter: string | null;
23
+ /** Whether to show the Relevance sort option (default `true`) */
24
+ showRelevance: boolean;
25
+ /** Maps of result counts for letters on the alphabet bar, for each letter filter type */
26
+ prefixFilterCountMap?: Record<PrefixFilterType, PrefixFilterCounts>;
27
+ resizeObserver?: SharedResizeObserverInterface;
28
+ /**
29
+ * Which of the alphabet bars (title/creator) should be shown, or null if one
30
+ * should not currently be rendered.
31
+ */
32
+ alphaSelectorVisible: AlphaSelector | null;
33
+ /**
34
+ * Whether the transparent backdrop to catch clicks outside the dropdown menu
35
+ * should be rendered.
36
+ */
37
+ dropdownBackdropVisible: boolean;
38
+ /**
39
+ * The width of the desktop view sort option container, updated upon each resize.
40
+ * Used for dynamically determining whether to use desktop or mobile view.
41
+ */
42
+ desktopSortContainerWidth: number;
43
+ /**
44
+ * The width of the full sort bar, updated upon each resize.
45
+ * Used for dynamically determining whether to use desktop or mobile view.
46
+ */
47
+ selectorBarContainerWidth: number;
48
+ /**
49
+ * The container for all the desktop view's sort options.
50
+ * Used for dynamically determining whether to use desktop or mobile view.
51
+ */
52
+ private desktopSortContainer;
53
+ /**
54
+ * The container for the full sort bar.
55
+ * Used for dynamically determining whether to use desktop or mobile view.
56
+ */
57
+ private sortSelectorContainer;
58
+ /** The dropdown component containing options for weekly and all-time views */
59
+ private viewsDropdown;
60
+ /** The dropdown component containing the four date options */
61
+ private dateDropdown;
62
+ /** The single, consolidated dropdown component shown in mobile view */
63
+ private mobileDropdown;
64
+ render(): TemplateResult<1>;
65
+ updated(changed: PropertyValues): void;
66
+ private setupEscapeListeners;
67
+ private boundSortBarSelectorEscapeListener;
68
+ disconnectedCallback(): void;
69
+ private disconnectResizeObserver;
70
+ private setupResizeObserver;
71
+ handleResize(entry: ResizeObserverEntry): void;
72
+ /**
73
+ * Whether to show the mobile sort bar because there is not enough space
74
+ * for the desktop sort bar.
75
+ */
76
+ private get mobileSelectorVisible();
77
+ /**
78
+ * Template to render the alphabet bar, or `nothing` if it should not be rendered
79
+ * for the current sort
80
+ */
81
+ private get alphaBarTemplate();
82
+ /** Template to render the sort direction toggle button */
83
+ private get sortDirectionSelectorTemplate();
84
+ /** Template to render the sort direction button's icon in the correct current state */
85
+ private get sortDirectionIcon();
86
+ /** The template to render all the sort options in desktop view */
87
+ private get desktopSortSelectorTemplate();
88
+ /** The template to render all the sort options in mobile view */
89
+ private get mobileSortSelectorTemplate();
90
+ /**
91
+ * This generates each of the non-dropdown sort option links.
92
+ *
93
+ * It manages the display value and the selected state of the option.
94
+ *
95
+ * @param sortField
96
+ * @param options {
97
+ * onClick?: (e: Event) => void; If this is provided, it will also be called when the option is clicked.
98
+ * displayName?: TemplateResult; The name to display for the option. Defaults to the sortField display name.
99
+ * selected?: boolean; true if the option is selected. Defaults to the selectedSort === sortField.
100
+ * }
101
+ * @returns
102
+ */
103
+ private getSortDisplayOption;
104
+ /**
105
+ * Generates a dropdown component containing multiple grouped sort options.
106
+ *
107
+ * @param options.displayName The name to use for the dropdown's visible label
108
+ * @param options.id The id to apply to the dropdown element
109
+ * @param options.dropdownOptions An array of option objects used to populate the dropdown
110
+ * @param options.selectedOption The id of the option that should be initially selected
111
+ * @param options.selected A boolean indicating whether this dropdown should use its
112
+ * selected appearance
113
+ * @param options.onOptionSelected A handler for optionSelected events coming from the dropdown
114
+ * @param options.onDropdownClick A handler for click events on the dropdown
115
+ * @param options.onLabelInteraction A handler for click events and Enter/Space keydown events
116
+ * on the dropdown's label
117
+ */
118
+ private getSortDropdown;
119
+ /** Generates a single dropdown option object for the given sort field */
120
+ private getDropdownOption;
121
+ /** Handler for when any sort dropdown option is selected */
122
+ private dropdownOptionSelected;
123
+ /** The template to render for the views dropdown */
124
+ private get viewsDropdownTemplate();
125
+ /** The template to render for the date dropdown */
126
+ private get dateDropdownTemplate();
127
+ /** Handler for when a new mobile sort dropdown option is selected */
128
+ private mobileSortChanged;
129
+ /** Template for rendering the three display mode options */
130
+ private get displayOptionTemplate();
131
+ /**
132
+ * Template for rendering the transparent backdrop to capture clicks outside the
133
+ * dropdown menu while it is open.
134
+ */
135
+ private get dropdownBackdrop();
136
+ /** Closes all of the sorting dropdown components' menus */
137
+ private closeDropdowns;
138
+ private selectDropdownSortField;
139
+ private clearAlphaBarFilters;
140
+ private setSortDirection;
141
+ /** Toggles the current sort direction between 'asc' and 'desc' */
142
+ private toggleSortDirection;
143
+ private handleSortDirectionClicked;
144
+ private setSelectedSort;
145
+ /** The current sort field, or the default one if no explicit sort is set */
146
+ private get finalizedSortField();
147
+ /** The current sort direction, or the default one if no explicit direction is set */
148
+ private get finalizedSortDirection();
149
+ /** Whether the sort direction button should be enabled for the current sort */
150
+ private get canChangeSortDirection();
151
+ /**
152
+ * There are four date sort options.
153
+ *
154
+ * This checks to see if the current sort is one of them.
155
+ *
156
+ * @readonly
157
+ * @private
158
+ * @type {boolean}
159
+ * @memberof SortFilterBar
160
+ */
161
+ private get dateOptionSelected();
162
+ /**
163
+ * There are two view sort options.
164
+ *
165
+ * This checks to see if the current sort is one of them.
166
+ *
167
+ * @readonly
168
+ * @private
169
+ * @type {boolean}
170
+ * @memberof SortFilterBar
171
+ */
172
+ private get viewOptionSelected();
173
+ /**
174
+ * The display name of the current date field
175
+ *
176
+ * @readonly
177
+ * @private
178
+ * @type {string}
179
+ * @memberof SortFilterBar
180
+ */
181
+ private get dateSortField();
182
+ /**
183
+ * The display name of the current view field
184
+ *
185
+ * @readonly
186
+ * @private
187
+ * @type {string}
188
+ * @memberof SortFilterBar
189
+ */
190
+ private get viewSortField();
191
+ private get titleSelectorBar();
192
+ private get creatorSelectorBar();
193
+ private titleLetterChanged;
194
+ private creatorLetterChanged;
195
+ private emitTitleLetterChangedEvent;
196
+ private emitCreatorLetterChangedEvent;
197
+ private displayModeChanged;
198
+ private emitSortChangedEvent;
199
+ static get styles(): import("lit").CSSResult[];
200
+ }
201
+ export {};