@lion/ui 0.18.1 → 0.20.0-menu-system.0

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 (279) hide show
  1. package/collapsible.js +1 -0
  2. package/components/button/src/LionButton.js +4 -0
  3. package/components/button/test-suites/LionButton.suite.js +1 -0
  4. package/components/calendar/src/LionCalendar.js +2 -0
  5. package/components/collapsible/src/DisclosureMixin.js +313 -0
  6. package/components/collapsible/test-suites/DisclosureMixin.suite.js +30 -0
  7. package/components/collapsible/types/DisclosureMixinTypes.ts +48 -0
  8. package/components/combobox/test/lion-combobox.test.js +1 -0
  9. package/components/form-core/src/form-group/FormGroupMixin.js +7 -0
  10. package/components/form-core/src/registration/FormRegistrarMixin.js +11 -0
  11. package/components/form-core/test/FormControlMixin.test.js +1 -0
  12. package/components/form-core/test/validate/Validator.test.js +2 -0
  13. package/components/form-core/test-suites/ValidateMixin.suite.js +2 -0
  14. package/components/form-core/test-suites/ValidateMixinFeedbackPart.suite.js +1 -0
  15. package/components/input-amount-dropdown/src/LionInputAmountDropdown.js +6 -4
  16. package/components/input-amount-dropdown/test/LionInputAmountDropdown.test.js +20 -1
  17. package/components/input-amount-dropdown/test-suites/LionInputAmountDropdown.suite.js +24 -0
  18. package/components/input-datepicker/src/localizeNamespaceLoader.js +1 -0
  19. package/components/input-datepicker/test/lion-input-datepicker.test.js +5 -6
  20. package/components/localize/test/date/formatDate.test.js +1 -0
  21. package/components/menu/CHANGELOG.md +37 -0
  22. package/components/menu/README.md +335 -0
  23. package/components/menu/index.js +2 -0
  24. package/components/menu/lion-menu-overlay.js +3 -0
  25. package/components/menu/lion-menu.js +3 -0
  26. package/components/menu/lion-spinbutton.js +3 -0
  27. package/components/menu/lion-toolbar.js +3 -0
  28. package/components/menu/lion-tree.js +3 -0
  29. package/components/menu/package.json +46 -0
  30. package/components/menu/requirements.temp.md +12 -0
  31. package/components/menu/src/InteractiveListMixin.js +840 -0
  32. package/components/menu/src/LionMenu.js +250 -0
  33. package/components/menu/src/LionMenuHybrid.js +46 -0
  34. package/components/menu/src/LionMenuOverlay.js +155 -0
  35. package/components/menu/src/LionSpinbutton.js +213 -0
  36. package/components/menu/src/LionToolbar.js +94 -0
  37. package/components/menu/src/LionTree.js +52 -0
  38. package/components/menu/src/MoreButtonMenuMixin.js +278 -0
  39. package/components/menu/src/MultiLevelListMixin.js +311 -0
  40. package/components/menu/src/utils/isInView.js +26 -0
  41. package/components/menu/src/utils/listItemInteractions.js +124 -0
  42. package/components/menu/test/InteractiveListMixin.test.js +3 -0
  43. package/components/menu/test/MoreButtonMenuMixin.test.js +4 -0
  44. package/components/menu/test/MultiLevelListMixin.test.js +3 -0
  45. package/components/menu/test/lion-menu-hybrid.test.js +3 -0
  46. package/components/menu/test/lion-menu.test.js +11 -0
  47. package/components/menu/test/lion-toolbar.test.js +8 -0
  48. package/components/menu/test/lion-tree.test.js +7 -0
  49. package/components/menu/test-helpers/mimicKeyPress.js +9 -0
  50. package/components/menu/test-suites/InteractiveListMixin.suite.js +454 -0
  51. package/components/menu/test-suites/LionMenu.suite.js +113 -0
  52. package/components/menu/test-suites/LionMenuHybrid.suite.js +583 -0
  53. package/components/menu/test-suites/MoreButtonMenuMixin.suite.js +372 -0
  54. package/components/menu/test-suites/MultiLevelListMixin.suite.js +303 -0
  55. package/components/menu/types/InteractiveListMixinTypes.d.ts +84 -0
  56. package/components/navigation-bar/README.md +1 -0
  57. package/components/navigation-bar/src/LionNavigationBar.js +439 -0
  58. package/components/navigation-bar/src/types.js +41 -0
  59. package/components/overlays/NEXT.md +49 -0
  60. package/components/overlays/src/OverlayController.js +278 -110
  61. package/components/overlays/src/OverlayMixin.js +58 -11
  62. package/components/overlays/src/OverlaysManager.js +2 -2
  63. package/components/overlays/src/configurations/visibility-trigger-partials/withHoverInteraction.js +100 -26
  64. package/components/overlays/src/utils/adopt-styles.js +3 -2
  65. package/components/overlays/src/utils/get-focusable-elements.js +4 -0
  66. package/components/overlays/src/utils/is-equal-config.js +10 -6
  67. package/components/overlays/test/OverlayController.test.js +127 -14
  68. package/components/overlays/test/utils-tests/is-equal-config.test.js +1 -1
  69. package/components/overlays/test/withHoverInteraction.test.js +90 -0
  70. package/components/overlays/test-suites/OverlayMixin.suite.js +8 -8
  71. package/components/overlays/types/ArrowMixinTypes.ts +3 -1
  72. package/components/overlays/types/OverlayConfig.ts +20 -5
  73. package/components/overlays/types/OverlayMixinTypes.ts +2 -0
  74. package/components/select-rich/test/lion-select-rich.test.js +3 -0
  75. package/custom-elements.json +30446 -17381
  76. package/dist-types/components/button/src/LionButton.d.ts +1 -0
  77. package/dist-types/components/button/src/LionButton.d.ts.map +1 -1
  78. package/dist-types/components/button/test-suites/LionButton.suite.d.ts.map +1 -1
  79. package/dist-types/components/calendar/src/LionCalendar.d.ts.map +1 -1
  80. package/dist-types/components/collapsible/src/DisclosureMixin.d.ts +3 -0
  81. package/dist-types/components/collapsible/src/DisclosureMixin.d.ts.map +1 -0
  82. package/dist-types/components/collapsible/test-suites/DisclosureMixin.suite.d.ts +2 -0
  83. package/dist-types/components/collapsible/test-suites/DisclosureMixin.suite.d.ts.map +1 -0
  84. package/dist-types/components/collapsible/types/DisclosureMixinTypes.d.ts +24 -0
  85. package/dist-types/components/collapsible/types/DisclosureMixinTypes.d.ts.map +1 -0
  86. package/dist-types/components/combobox/src/LionCombobox.d.ts +1 -1
  87. package/dist-types/components/dialog/src/LionDialog.d.ts +6 -2
  88. package/dist-types/components/dialog/src/LionDialog.d.ts.map +1 -1
  89. package/dist-types/components/form-core/src/form-group/FormGroupMixin.d.ts.map +1 -1
  90. package/dist-types/components/form-core/src/registration/FormRegistrarMixin.d.ts.map +1 -1
  91. package/dist-types/components/form-core/test-suites/ValidateMixin.suite.d.ts.map +1 -1
  92. package/dist-types/components/form-core/test-suites/ValidateMixinFeedbackPart.suite.d.ts.map +1 -1
  93. package/dist-types/components/input-amount-dropdown/src/LionInputAmountDropdown.d.ts +0 -9
  94. package/dist-types/components/input-amount-dropdown/src/LionInputAmountDropdown.d.ts.map +1 -1
  95. package/dist-types/components/input-amount-dropdown/test/LionInputAmountDropdown.test.d.ts.map +1 -1
  96. package/dist-types/components/input-amount-dropdown/test-suites/LionInputAmountDropdown.suite.d.ts.map +1 -1
  97. package/dist-types/components/input-datepicker/src/LionInputDatepicker.d.ts +1 -1
  98. package/dist-types/components/input-datepicker/src/localizeNamespaceLoader.d.ts.map +1 -1
  99. package/dist-types/components/menu/index.d.ts +3 -0
  100. package/dist-types/components/menu/index.d.ts.map +1 -0
  101. package/dist-types/components/menu/lion-menu-overlay.d.ts +2 -0
  102. package/dist-types/components/menu/lion-menu-overlay.d.ts.map +1 -0
  103. package/dist-types/components/menu/lion-menu.d.ts +2 -0
  104. package/dist-types/components/menu/lion-menu.d.ts.map +1 -0
  105. package/dist-types/components/menu/lion-spinbutton.d.ts +2 -0
  106. package/dist-types/components/menu/lion-spinbutton.d.ts.map +1 -0
  107. package/dist-types/components/menu/lion-toolbar.d.ts +2 -0
  108. package/dist-types/components/menu/lion-toolbar.d.ts.map +1 -0
  109. package/dist-types/components/menu/lion-tree.d.ts +2 -0
  110. package/dist-types/components/menu/lion-tree.d.ts.map +1 -0
  111. package/dist-types/components/menu/src/InteractiveListMixin.d.ts +617 -0
  112. package/dist-types/components/menu/src/InteractiveListMixin.d.ts.map +1 -0
  113. package/dist-types/components/menu/src/LionMenu.d.ts +635 -0
  114. package/dist-types/components/menu/src/LionMenu.d.ts.map +1 -0
  115. package/dist-types/components/menu/src/LionMenuHybrid.d.ts +19 -0
  116. package/dist-types/components/menu/src/LionMenuHybrid.d.ts.map +1 -0
  117. package/dist-types/components/menu/src/LionMenuOverlay.d.ts +1015 -0
  118. package/dist-types/components/menu/src/LionMenuOverlay.d.ts.map +1 -0
  119. package/dist-types/components/menu/src/LionSpinbutton.d.ts +58 -0
  120. package/dist-types/components/menu/src/LionSpinbutton.d.ts.map +1 -0
  121. package/dist-types/components/menu/src/LionToolbar.d.ts +8 -0
  122. package/dist-types/components/menu/src/LionToolbar.d.ts.map +1 -0
  123. package/dist-types/components/menu/src/LionTree.d.ts +447 -0
  124. package/dist-types/components/menu/src/LionTree.d.ts.map +1 -0
  125. package/dist-types/components/menu/src/MoreButtonMenuMixin.d.ts +39 -0
  126. package/dist-types/components/menu/src/MoreButtonMenuMixin.d.ts.map +1 -0
  127. package/dist-types/components/menu/src/MultiLevelListMixin.d.ts +503 -0
  128. package/dist-types/components/menu/src/MultiLevelListMixin.d.ts.map +1 -0
  129. package/dist-types/components/menu/src/utils/isInView.d.ts +9 -0
  130. package/dist-types/components/menu/src/utils/isInView.d.ts.map +1 -0
  131. package/dist-types/components/menu/src/utils/listItemInteractions.d.ts +48 -0
  132. package/dist-types/components/menu/src/utils/listItemInteractions.d.ts.map +1 -0
  133. package/dist-types/components/menu/test/InteractiveListMixin.test.d.ts +2 -0
  134. package/dist-types/components/menu/test/InteractiveListMixin.test.d.ts.map +1 -0
  135. package/dist-types/components/menu/test/MoreButtonMenuMixin.test.d.ts +2 -0
  136. package/dist-types/components/menu/test/MoreButtonMenuMixin.test.d.ts.map +1 -0
  137. package/dist-types/components/menu/test/MultiLevelListMixin.test.d.ts +2 -0
  138. package/dist-types/components/menu/test/MultiLevelListMixin.test.d.ts.map +1 -0
  139. package/dist-types/components/menu/test/lion-menu-hybrid.test.d.ts +2 -0
  140. package/dist-types/components/menu/test/lion-menu-hybrid.test.d.ts.map +1 -0
  141. package/dist-types/components/menu/test/lion-menu.test.d.ts +2 -0
  142. package/dist-types/components/menu/test/lion-menu.test.d.ts.map +1 -0
  143. package/dist-types/components/menu/test/lion-toolbar.test.d.ts +2 -0
  144. package/dist-types/components/menu/test/lion-toolbar.test.d.ts.map +1 -0
  145. package/dist-types/components/menu/test/lion-tree.test.d.ts +2 -0
  146. package/dist-types/components/menu/test/lion-tree.test.d.ts.map +1 -0
  147. package/dist-types/components/menu/test-helpers/mimicKeyPress.d.ts +7 -0
  148. package/dist-types/components/menu/test-helpers/mimicKeyPress.d.ts.map +1 -0
  149. package/dist-types/components/menu/test-suites/InteractiveListMixin.suite.d.ts +14 -0
  150. package/dist-types/components/menu/test-suites/InteractiveListMixin.suite.d.ts.map +1 -0
  151. package/dist-types/components/menu/test-suites/LionMenu.suite.d.ts +9 -0
  152. package/dist-types/components/menu/test-suites/LionMenu.suite.d.ts.map +1 -0
  153. package/dist-types/components/menu/test-suites/LionMenuHybrid.suite.d.ts +5 -0
  154. package/dist-types/components/menu/test-suites/LionMenuHybrid.suite.d.ts.map +1 -0
  155. package/dist-types/components/menu/test-suites/MoreButtonMenuMixin.suite.d.ts +14 -0
  156. package/dist-types/components/menu/test-suites/MoreButtonMenuMixin.suite.d.ts.map +1 -0
  157. package/dist-types/components/menu/test-suites/MultiLevelListMixin.suite.d.ts +11 -0
  158. package/dist-types/components/menu/test-suites/MultiLevelListMixin.suite.d.ts.map +1 -0
  159. package/dist-types/components/navigation-bar/src/LionNavigationBar.d.ts +238 -0
  160. package/dist-types/components/navigation-bar/src/LionNavigationBar.d.ts.map +1 -0
  161. package/dist-types/components/navigation-bar/src/types.d.ts +85 -0
  162. package/dist-types/components/navigation-bar/src/types.d.ts.map +1 -0
  163. package/dist-types/components/overlays/src/OverlayController.d.ts +24 -12
  164. package/dist-types/components/overlays/src/OverlayController.d.ts.map +1 -1
  165. package/dist-types/components/overlays/src/OverlayMixin.d.ts.map +1 -1
  166. package/dist-types/components/overlays/src/configurations/visibility-trigger-partials/withHoverInteraction.d.ts +8 -2
  167. package/dist-types/components/overlays/src/configurations/visibility-trigger-partials/withHoverInteraction.d.ts.map +1 -1
  168. package/dist-types/components/overlays/src/utils/get-focusable-elements.d.ts.map +1 -1
  169. package/dist-types/components/overlays/src/utils/is-equal-config.d.ts.map +1 -1
  170. package/dist-types/components/overlays/test/withHoverInteraction.test.d.ts +2 -0
  171. package/dist-types/components/overlays/test/withHoverInteraction.test.d.ts.map +1 -0
  172. package/dist-types/components/overlays/types/ArrowMixinTypes.d.ts.map +1 -1
  173. package/dist-types/components/overlays/types/OverlayConfig.d.ts +12 -2
  174. package/dist-types/components/overlays/types/OverlayConfig.d.ts.map +1 -1
  175. package/dist-types/components/overlays/types/OverlayMixinTypes.d.ts +1 -0
  176. package/dist-types/components/overlays/types/OverlayMixinTypes.d.ts.map +1 -1
  177. package/dist-types/components/select-rich/src/LionSelectRich.d.ts +11 -3
  178. package/dist-types/components/select-rich/src/LionSelectRich.d.ts.map +1 -1
  179. package/dist-types/components/tooltip/src/LionTooltip.d.ts +1 -1
  180. package/dist-types/exports/define/lion-item.d.ts +2 -0
  181. package/dist-types/exports/define/lion-item.d.ts.map +1 -0
  182. package/dist-types/exports/define/lion-menu-overlay.d.ts +2 -0
  183. package/dist-types/exports/define/lion-menu-overlay.d.ts.map +1 -0
  184. package/dist-types/exports/define/lion-menu.d.ts +2 -0
  185. package/dist-types/exports/define/lion-menu.d.ts.map +1 -0
  186. package/dist-types/exports/define/lion-navigation-bar.d.ts +2 -0
  187. package/dist-types/exports/define/lion-navigation-bar.d.ts.map +1 -0
  188. package/dist-types/exports/define/lion-toolbar.d.ts +2 -0
  189. package/dist-types/exports/define/lion-toolbar.d.ts.map +1 -0
  190. package/dist-types/exports/define/lion-tree.d.ts +2 -0
  191. package/dist-types/exports/define/lion-tree.d.ts.map +1 -0
  192. package/dist-types/exports/menu-test-suites.d.ts +4 -0
  193. package/dist-types/exports/menu-test-suites.d.ts.map +1 -0
  194. package/dist-types/exports/menu.d.ts +7 -0
  195. package/dist-types/exports/menu.d.ts.map +1 -0
  196. package/dist-types/exports/navigation-bar.d.ts +2 -0
  197. package/dist-types/exports/navigation-bar.d.ts.map +1 -0
  198. package/dist-types/exports/overlays.d.ts +3 -0
  199. package/dist-types/exports/overlays.d.ts.map +1 -1
  200. package/dist-types/tsconfig.tsbuildinfo +1 -1
  201. package/docs/components/checkbox-group/overview.md +2 -2
  202. package/docs/components/collapsible/overview.md +1 -1
  203. package/docs/components/combobox/api-table.md +21 -8
  204. package/docs/components/combobox/overview.md +1 -1
  205. package/docs/components/combobox/use-cases.md +1 -1
  206. package/docs/components/dialog/api-table.md +31 -6
  207. package/docs/components/dialog/overview.md +1 -1
  208. package/docs/components/fieldset/overview.md +5 -5
  209. package/docs/components/form/overview.md +3 -3
  210. package/docs/components/form/use-cases.md +2 -2
  211. package/docs/components/icon/use-cases.md +1 -1
  212. package/docs/components/input/overview.md +1 -1
  213. package/docs/components/input-amount/overview.md +3 -3
  214. package/docs/components/input-amount-dropdown/api-table.md +1 -1
  215. package/docs/components/input-date/overview.md +3 -3
  216. package/docs/components/input-datepicker/api-table.md +21 -4
  217. package/docs/components/input-datepicker/overview.md +5 -5
  218. package/docs/components/input-email/overview.md +2 -2
  219. package/docs/components/input-file/overview.md +1 -1
  220. package/docs/components/input-iban/overview.md +2 -2
  221. package/docs/components/input-range/overview.md +2 -2
  222. package/docs/components/input-stepper/overview.md +1 -1
  223. package/docs/components/input-tel/overview.md +1 -1
  224. package/docs/components/input-tel/use-cases.md +6 -6
  225. package/docs/components/input-tel-dropdown/overview.md +1 -1
  226. package/docs/components/listbox/use-cases.md +1 -1
  227. package/docs/components/menu/api-table.md +460 -0
  228. package/docs/components/menu/applyMenuDemoStyles.js +173 -0
  229. package/docs/components/menu/extensions.md +262 -0
  230. package/docs/components/menu/index.md +13 -0
  231. package/docs/components/menu/overview.md +422 -0
  232. package/docs/components/menu/use-cases.md +77 -0
  233. package/docs/components/radio-group/overview.md +3 -3
  234. package/docs/components/select/use-cases.md +1 -1
  235. package/docs/components/select-rich/api-table.md +21 -5
  236. package/docs/components/select-rich/use-cases.md +2 -2
  237. package/docs/components/tabs/examples.md +1 -1
  238. package/docs/components/tooltip/api-table.md +36 -11
  239. package/docs/components/tooltip/use-cases.md +22 -0
  240. package/docs/fundamentals/index.md +4 -4
  241. package/docs/fundamentals/node-tools/publish-docs/overview.md +3 -3
  242. package/docs/fundamentals/node-tools/rocket-preset-extend-lion-docs/overview.md +2 -2
  243. package/docs/fundamentals/rationales/accessibility.md +1 -1
  244. package/docs/fundamentals/systems/core/SlotMixin.md +1 -1
  245. package/docs/fundamentals/systems/core/overview.md +1 -1
  246. package/docs/fundamentals/systems/form/formatting-and-parsing.md +4 -4
  247. package/docs/fundamentals/systems/form/model-value.md +1 -1
  248. package/docs/fundamentals/systems/form/overview.md +28 -28
  249. package/docs/fundamentals/systems/form/validate.md +2 -2
  250. package/docs/fundamentals/systems/localize/overview.md +4 -4
  251. package/docs/fundamentals/systems/overlays/api-table.md +36 -34
  252. package/docs/fundamentals/systems/overlays/configuration.md +2 -2
  253. package/docs/fundamentals/systems/overlays/overview.md +5 -5
  254. package/docs/fundamentals/systems/overlays/use-cases.md +2 -2
  255. package/docs/fundamentals/tools/helpers/overview.md +1 -1
  256. package/docs/fundamentals/tools/singleton-manager/overview.md +4 -4
  257. package/docs/guides/how-to/create-a-custom-field.md +5 -5
  258. package/docs/guides/how-to/create-a-form.md +4 -4
  259. package/docs/guides/how-to/extend-a-native-input.md +2 -2
  260. package/docs/guides/how-to/index.md +1 -1
  261. package/docs/guides/index.md +8 -8
  262. package/docs/guides/principles/index.md +5 -5
  263. package/docs/guides/principles/styling.md +1 -1
  264. package/exports/collapsible.js +1 -0
  265. package/exports/define/lion-item.js +3 -0
  266. package/exports/define/lion-menu-overlay.js +3 -0
  267. package/exports/define/lion-menu.js +3 -0
  268. package/exports/define/lion-navigation-bar.js +3 -0
  269. package/exports/define/lion-toolbar.js +3 -0
  270. package/exports/define/lion-tree.js +3 -0
  271. package/exports/menu-test-suites.js +4 -0
  272. package/exports/menu.js +7 -0
  273. package/exports/navigation-bar.js +1 -0
  274. package/exports/overlays.js +6 -0
  275. package/menu-test-suites.js +4 -0
  276. package/menu.js +7 -0
  277. package/navigation-bar.js +1 -0
  278. package/overlays.js +6 -0
  279. package/package.json +1 -1
package/docs/components/menu/api-table.md ADDED
@@ -0,0 +1,460 @@
1
+ ---
2
+ parts:
3
+ - API Table
4
+ - Menu
5
+ title: 'Menu: API Table'
6
+ eleventyNavigation:
7
+ key: API Table >> Menu
8
+ title: API Table
9
+ order: 90
10
+ parent: Menu
11
+ ---
12
+ # Menu: API Table
13
+
14
+
15
+ ## class: `LionMenu`, `lion-menu`
16
+
17
+ ### Fields
18
+
19
+ | Name | Privacy | Type | Default | Description | Inherited From |
20
+ | --------------------------- | --------- | ---------------------------------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------- |
21
+ | `activeIndex` | public | | | | InteractiveListMixin |
22
+ | `activeItem` | public | | | | InteractiveListMixin |
23
+ | `bar` | public | `boolean` | `false` | Enable bar to use \[role="menubar"] and horizontal navigation | |
24
+ | `behaveAsAccordion` | public | `boolean` | `true` | When true, will have a maximum of one submenu open at a time | MultiLevelListMixin |
25
+ | `checkedIndex` | public | `number \| number[]` | | | InteractiveListMixin |
26
+ | `handleFocus` | public | `boolean` | `true` | | MultiLevelListMixin |
27
+ | `invokerInteraction` | public | `string` | `'click'` | | |
28
+ | `invokerNode` | public | `HTMLElement` | `undefined` | When an invokerNode is supplied (usually by a parent level menu), it will take precedence
over \[slot=invoker] and previousElementSibling with \[data-invoker] attribute | MultiLevelListMixin |
29
+ | `isInteractiveList` | public | | | Since we cannot check instanceof with mixins, use this getter instead.
This way, the outside world can confirm the type of an element | InteractiveListMixin |
30
+ | `itemWrap` | public | `boolean` | | | InteractiveListMixin |
31
+ | `level` | public | `number` | `1` | The level of nested menus. Will be reflected as attribute for styling purposes | MultiLevelListMixin |
32
+ | `listItems` | public | `HTMLElement[]` | | When used with FormRegistrarMixin, children will register themselves. Otherwise,
\_\_listItems are gathered via a slotchange listener | InteractiveListMixin |
33
+ | `multipleChoice` | public | `boolean` | `false` | | InteractiveListMixin |
34
+ | `noPreselect` | public | `boolean` | `true` | By default, checkedIndex is set to 0. When noPreselect is true,
checkedIndex will not be set | InteractiveListMixin |
35
+ | `orientation` | public | `string` | `'vertical'` | | InteractiveListMixin |
36
+ | `parentList` | public | `InteractiveList` | `undefined` | The parent list if level > 1 | MultiLevelListMixin |
37
+ | `rotateKeyboardNavigation` | public | `boolean` | `false` | | InteractiveListMixin |
38
+ | `selectionFollowsFocus` | public | `boolean` | `false` | | InteractiveListMixin |
39
+ | `slots` | public | | | | InteractiveListMixin |
40
+ | `_activateOnCharTimeout` | protected | `number` | `2000` | The pending char sequence that will set active list item | InteractiveListMixin |
41
+ | `_activateOnTypedChars` | public | `boolean` | `true` | By default, a typed character (or a sequence thereof) will be matched against
the values of list items. The first and closest match, becomes active
(focused or activedescendant depending on \_matchMode) | InteractiveListMixin |
42
+ | `_activeMode` | public | `'activedescendant'\|'roving-tabindex'\|'tabbable-disclosure'\|'none'` | `'roving-tabindex'` | Whenever possible (for \[role="listbox\|menu"], usually with one level) we use an
\[active descendant]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/#kbd\_focus\_activedescendant).
For \[role=toolbar], we use a \[roving tabindex]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/#kbd\_roving\_tabindex)
Other examples:
- \[role="menubar"]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/examples/menubar/menubar-1/menubar-1.html)
- \[role="tree"]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/examples/treeview/treeview-1/treeview-1b.html)
For disclosure menus, we need keyboard navigation, but treat every list item
(more precisely its anchor child) as a tab stop. | InteractiveListMixin |
43
+ | `_childrenRoles` | protected | `InteractiveListItemRole[]` | | The roles to look for when children are registered to listItems | InteractiveListMixin |
44
+ | `_contentNode` | protected | | | | MultiLevelListMixin |
45
+ | `_hasSmartChildren` | protected | `boolean` | `false` | When children are 'smart' (like LionOption), checked and active states will be set
to them and they are responsible for setting \[aria-selected].
When false, \`get listItems()\` needs to be configured to point to the list items. | InteractiveListMixin |
46
+ | `_hasSmartListItems` | public | | | | InteractiveListMixin |
47
+ | `_interactiveChildrenRoles` | protected | | | | InteractiveListMixin |
48
+ | `_invokerNode` | protected | | | | MultiLevelListMixin |
49
+ | `_listItemsSlot` | protected | `HTMLSlotElement` | | Place in the template that contains children with .\_childrenRoles | InteractiveListMixin |
50
+ | `_listNode` | protected | `HTMLElement` | | This is the (usually focusable, unless combobox) element that will contain \[aria-activedescendant]
Depending on the children, role will be "listbox\|menu\|menubar\|tree\|toolbar" | InteractiveListMixin |
51
+ | `_listRole` | protected | `'menu'\|'menubar'\|'listbox'\|'tree'\|'toolbar'` | `'menu'` | The role that will be put on \_listNode | InteractiveListMixin |
52
+ | `_onPopState` | protected | | | | InteractiveListMixin |
53
+ | `_scrollTargetNode` | protected | | | | InteractiveListMixin |
54
+ | `_subListMap` | protected | `Map<HTMLElement\|LionItem,InteractiveList>` | `new Map()` | | MultiLevelListMixin |
55
+
56
+ ### Methods
57
+
58
+ | Name | Privacy | Description | Parameters | Return | Inherited From |
59
+ | ---------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ------ | -------------------- |
60
+ | `setCheckedIndex` | public | Allows groups within one level. In case we deal with menuitemcheckbox,&#xA;we treat it as multiple choice group | `index: number` | | InteractiveListMixin |
61
+ | `toggle` | public | | `ev: Event` | | MultiLevelListMixin |
62
+ | `_getNextEnabledOption` | protected | | `currentIndex: number, offset: number` | | InteractiveListMixin |
63
+ | `_getPreviousEnabledOption` | protected | | `currentIndex: number, offset: number` | | InteractiveListMixin |
64
+ | `_initListItems` | protected | When \_listItemsSlot receives new items, they are initialized via this method | `newItems: *` | | InteractiveListMixin |
65
+ | `_matchCharsAgainstItem` | protected | | `{ chars, item }, config: {chars: string[], item: HTMLElement}` | | InteractiveListMixin |
66
+ | `_onListClick` | protected | | `ev: MouseEvent` | | InteractiveListMixin |
67
+ | `_onListFocusIn` | protected | | `ev: FocusEvent` | | InteractiveListMixin |
68
+ | `_onListKeyDown` | protected | Handles various keyboard controls | `ev: *` | | InteractiveListMixin |
69
+ | `_onListKeyUp` | protected | | `ev: KeyboardEvent` | | InteractiveListMixin |
70
+ | `_setupList` | protected | | | | InteractiveListMixin |
71
+ | `_syncCurrentPageWithLocationHref` | protected | | `location: Location` | | InteractiveListMixin |
72
+
73
+ ### Attributes
74
+
75
+ | Name | Field | Inherited From |
76
+ | ---------------------------- | ------------------------ | -------------------- |
77
+ | `bar` | bar | |
78
+ | `invokerNode` | invokerNode | MultiLevelListMixin |
79
+ | `behave-as-accordion` | behaveAsAccordion | MultiLevelListMixin |
80
+ | `level` | level | MultiLevelListMixin |
81
+ | `orientation` | orientation | InteractiveListMixin |
82
+ | `multiple-choice` | multipleChoice | InteractiveListMixin |
83
+ | `selection-follows-focus` | selectionFollowsFocus | InteractiveListMixin |
84
+ | `rotate-keyboard-navigation` | rotateKeyboardNavigation | InteractiveListMixin |
85
+ | `no-preselect` | noPreselect | InteractiveListMixin |
86
+ | `item-wrap` | itemWrap | InteractiveListMixin |
87
+ | `_activateOnTypedChars` | \_activateOnTypedChars | InteractiveListMixin |
88
+ | `_hasSmartListItems` | \_hasSmartListItems | InteractiveListMixin |
89
+ | `_activeMode` | \_activeMode | InteractiveListMixin |
90
+
91
+ <hr/>
92
+
93
+
94
+ ## class: `LionMenuHybrid`
95
+
96
+ ### Fields
97
+
98
+ | Name | Privacy | Type | Default | Description | Inherited From |
99
+ | ---------------------------- | --------- | ---------------------------------------------------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------- |
100
+ | `activeIndex` | public | | | | LionMenu |
101
+ | `activeItem` | public | | | | LionMenu |
102
+ | `bar` | public | `boolean` | `false` | Enable bar to use \[role="menubar"] and horizontal navigation | LionMenu |
103
+ | `behaveAsAccordion` | public | `boolean` | `false` | When true, will have a maximum of one submenu open at a time | LionMenu |
104
+ | `checkedIndex` | public | `number \| number[]` | | | LionMenu |
105
+ | `config` | public | `Partial<OverlayConfig>` | `{}` | Configure the many options of the \`OverlayController\` | OverlayMixin |
106
+ | `handleFocus` | public | `boolean` | `true` | | LionMenu |
107
+ | `invokerInteraction` | public | `string` | `'click'` | | LionMenu |
108
+ | `invokerNode` | public | `HTMLElement` | `undefined` | When an invokerNode is supplied (usually by a parent level menu), it will take precedence&#xA;over \[slot=invoker] and previousElementSibling with \[data-invoker] attribute | LionMenu |
109
+ | `isInteractiveList` | public | | | Since we cannot check instanceof with mixins, use this getter instead.&#xA;This way, the outside world can confirm the type of an element | LionMenu |
110
+ | `itemWrap` | public | `boolean` | | | LionMenu |
111
+ | `level` | public | `number` | `1` | The level of nested menus. Will be reflected as attribute for styling purposes | LionMenu |
112
+ | `listItems` | public | `HTMLElement[]` | | When used with FormRegistrarMixin, children will register themselves. Otherwise,&#xA;\_\_listItems are gathered via a slotchange listener | LionMenu |
113
+ | `multipleChoice` | public | `boolean` | `false` | | LionMenu |
114
+ | `noPreselect` | public | `boolean` | `false` | By default, checkedIndex is set to 0. When noPreselect is true,&#xA;checkedIndex will not be set | LionMenu |
115
+ | `openableMode` | public | `'disclosure'\|'overlay'` | `'disclosure'` | Terminology aligned with https\://open-ui.org/components/openable.explainer/ | |
116
+ | `opened` | public | `boolean` | `false` | If you add the opened attribute a dialog will be opened on page load. The invoker can be left out&#xA;in case the user does not need to be able to reopen the dialog. | OverlayMixin |
117
+ | `orientation` | public | `string` | `'vertical'` | | LionMenu |
118
+ | `parentList` | public | `InteractiveList` | `undefined` | The parent list if level > 1 | LionMenu |
119
+ | `rotateKeyboardNavigation` | public | `boolean` | `false` | | LionMenu |
120
+ | `selectionFollowsFocus` | public | `boolean` | `false` | | LionMenu |
121
+ | `slots` | public | | | | LionMenu |
122
+ | `_activateOnCharTimeout` | protected | `number` | `2000` | The pending char sequence that will set active list item | LionMenu |
123
+ | `_activateOnTypedChars` | public | `boolean` | `false` | By default, a typed character (or a sequence thereof) will be matched against&#xA;the values of list items. The first and closest match, becomes active&#xA;(focused or activedescendant depending on \_matchMode) | LionMenu |
124
+ | `_activeMode` | public | `'activedescendant'\|'roving-tabindex'\|'tabbable-disclosure'\|'none'` | `'activedescendant'` | Whenever possible (for \[role="listbox\|menu"], usually with one level) we use an&#xA;\[active descendant]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/#kbd\_focus\_activedescendant).&#xA;For \[role=toolbar], we use a \[roving tabindex]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/#kbd\_roving\_tabindex)&#xA;Other examples:&#xA;- \[role="menubar"]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/examples/menubar/menubar-1/menubar-1.html)&#xA;- \[role="tree"]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/examples/treeview/treeview-1/treeview-1b.html)&#xA;For disclosure menus, we need keyboard navigation, but treat every list item&#xA;(more precisely its anchor child) as a tab stop. | LionMenu |
125
+ | `_childrenRoles` | protected | `InteractiveListItemRole[]` | | The roles to look for when children are registered to listItems | LionMenu |
126
+ | `_contentNode` | protected | | | | LionMenu |
127
+ | `_hasSmartChildren` | protected | `boolean` | `false` | When children are 'smart' (like LionOption), checked and active states will be set&#xA;to them and they are responsible for setting \[aria-selected].&#xA;When false, \`get listItems()\` needs to be configured to point to the list items. | LionMenu |
128
+ | `_hasSmartListItems` | public | | | | LionMenu |
129
+ | `_interactiveChildrenRoles` | protected | | | | LionMenu |
130
+ | `_invokerNode` | protected | | | | LionMenu |
131
+ | `_listItemsSlot` | protected | `HTMLSlotElement` | | Place in the template that contains children with .\_childrenRoles | LionMenu |
132
+ | `_listNode` | protected | `HTMLElement` | | This is the (usually focusable, unless combobox) element that will contain \[aria-activedescendant]&#xA;Depending on the children, role will be "listbox\|menu\|menubar\|tree\|toolbar" | LionMenu |
133
+ | `_listRole` | protected | `'menu'\|'menubar'\|'listbox'\|'tree'\|'toolbar'` | `'menu'` | The role that will be put on \_listNode | LionMenu |
134
+ | `_onOverlayShow` | protected | | | | OverlayWithListInvokerMixin |
135
+ | `_onPopState` | protected | | | | LionMenu |
136
+ | `_overlayBackdropNode` | protected | | | | OverlayMixin |
137
+ | `_overlayContentNode` | protected | | | make sure OverlayMixin gets the contentNode defined by DisclosureMixin | OverlayMixin |
138
+ | `_overlayContentWrapperNode` | protected | | | | OverlayMixin |
139
+ | `_overlayInvokerNode` | protected | | | make sure OverlayMixin gets the invokerNode defined by DisclosureMixin | OverlayMixin |
140
+ | `_overlayReferenceNode` | protected | | | | OverlayMixin |
141
+ | `_scrollTargetNode` | protected | | | | LionMenu |
142
+ | `_shouldSetupOverlay` | protected | `boolean` | `false` | | |
143
+ | `_subListMap` | protected | `Map<HTMLElement\|LionItem,InteractiveList>` | `new Map()` | | LionMenu |
144
+
145
+ ### Methods
146
+
147
+ | Name | Privacy | Description | Parameters | Return | Inherited From |
148
+ | ---------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------- | -------------- |
149
+ | `close` | public | Hides the overlay | | | OverlayMixin |
150
+ | `open` | public | Shows the overlay | | | OverlayMixin |
151
+ | `repositionOverlay` | public | Sometimes it's needed to recompute Popper position of an overlay, for instance when we have&#xA;an opened combobox and the surrounding context changes (the space consumed by the textbox&#xA;increases vertically) | | | OverlayMixin |
152
+ | `setCheckedIndex` | public | When \`multipleChoice\` is false, will toggle, else will check provided index | `index: Number` | | LionMenu |
153
+ | `toggle` | public | Toggles the overlay | `ev: Event` | | LionMenu |
154
+ | `_defineOverlay` | protected | | `{ contentNode, invokerNode, referenceNode, backdropNode, contentWrapperNode }, config: DefineOverlayConfig` | `OverlayController` | OverlayMixin |
155
+ | `_defineOverlayConfig` | protected | | | `OverlayConfig` | OverlayMixin |
156
+ | `_getNextEnabledOption` | protected | | `currentIndex: number, offset: number` | | LionMenu |
157
+ | `_getPreviousEnabledOption` | protected | | `currentIndex: number, offset: number` | | LionMenu |
158
+ | `_initListItems` | protected | When \_listItemsSlot receives new items, they are initialized via this method | `newItems: LionItem[]\|HTMLElement[]` | | LionMenu |
159
+ | `_isPermanentlyDisconnected` | protected | When we're moving around in dom, disconnectedCallback gets called.&#xA;Before we decide to teardown, let's wait to see if we were not just moving nodes around. | | `Promise<boolean>` | OverlayMixin |
160
+ | `_matchCharsAgainstItem` | protected | | `{ chars, item }, config: {chars: string[], item: HTMLElement}` | | LionMenu |
161
+ | `_onListClick` | protected | | `ev: MouseEvent` | | LionMenu |
162
+ | `_onListFocusIn` | protected | | `ev: FocusEvent` | | LionMenu |
163
+ | `_onListKeyDown` | protected | Handles various keyboard controls | `ev: KeyboardEvent` | | LionMenu |
164
+ | `_onListKeyUp` | protected | | `ev: KeyboardEvent` | | LionMenu |
165
+ | `_setOpenedWithoutPropertyEffects` | protected | When the opened state is changed by an Application Developer,cthe OverlayController is&#xA;requested to show/hide. It might happen that this request is not honoured&#xA;(intercepted in before-hide for instance), so that we need to sync the controller state&#xA;to this webcomponent again, preventing eternal loops. | `newOpened: boolean` | | OverlayMixin |
166
+ | `_setupList` | protected | | | | LionMenu |
167
+ | `_setupOpenCloseListeners` | protected | | | | OverlayMixin |
168
+ | `_setupOverlayCtrl` | protected | | | | OverlayMixin |
169
+ | `_syncCurrentPageWithLocationHref` | protected | | `location: Location` | | LionMenu |
170
+ | `_teardownOpenCloseListeners` | protected | | | | OverlayMixin |
171
+ | `_teardownOverlayCtrl` | protected | | | | OverlayMixin |
172
+
173
+ ### Events
174
+
175
+ | Name | Type | Description | Inherited From |
176
+ | ---------------- | ------------- | ----------- | -------------- |
177
+ | `opened-changed` | `CustomEvent` | | OverlayMixin |
178
+
179
+ ### Attributes
180
+
181
+ | Name | Field | Inherited From |
182
+ | ---------------------------- | ------------------------ | -------------- |
183
+ | `openable-mode` | openableMode | |
184
+ | `opened` | opened | OverlayMixin |
185
+ | `orientation` | orientation | LionMenu |
186
+ | `multiple-choice` | multipleChoice | LionMenu |
187
+ | `selection-follows-focus` | selectionFollowsFocus | LionMenu |
188
+ | `rotate-keyboard-navigation` | rotateKeyboardNavigation | LionMenu |
189
+ | `no-preselect` | noPreselect | LionMenu |
190
+ | `item-wrap` | itemWrap | LionMenu |
191
+ | `_activateOnTypedChars` | \_activateOnTypedChars | LionMenu |
192
+ | `_hasSmartListItems` | \_hasSmartListItems | LionMenu |
193
+ | `_activeMode` | \_activeMode | LionMenu |
194
+ | `invokerNode` | invokerNode | LionMenu |
195
+ | `behave-as-accordion` | behaveAsAccordion | LionMenu |
196
+ | `level` | level | LionMenu |
197
+ | `bar` | bar | LionMenu |
198
+
199
+ <hr/>
200
+
201
+
202
+ ## class: `LionMenuOverlay`, `lion-menu-overlay`
203
+
204
+ ### Fields
205
+
206
+ | Name | Privacy | Type | Default | Description | Inherited From |
207
+ | ---------------------------- | --------- | ---------------------------------------------------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------- |
208
+ | `activeIndex` | public | | | | LionMenu |
209
+ | `activeItem` | public | | | | LionMenu |
210
+ | `bar` | public | `boolean` | `false` | Enable bar to use \[role="menubar"] and horizontal navigation | LionMenu |
211
+ | `behaveAsAccordion` | public | `boolean` | `false` | When true, will have a maximum of one submenu open at a time | LionMenu |
212
+ | `checkedIndex` | public | `number \| number[]` | | | LionMenu |
213
+ | `config` | public | `Partial<OverlayConfig>` | `{}` | Configure the many options of the \`OverlayController\` | OverlayMixin |
214
+ | `handleFocus` | public | `boolean` | `true` | | LionMenu |
215
+ | `invokerInteraction` | public | `string` | `'click'` | | LionMenu |
216
+ | `invokerNode` | public | `HTMLElement` | `undefined` | When an invokerNode is supplied (usually by a parent level menu), it will take precedence&#xA;over \[slot=invoker] and previousElementSibling with \[data-invoker] attribute | LionMenu |
217
+ | `isInteractiveList` | public | | | Since we cannot check instanceof with mixins, use this getter instead.&#xA;This way, the outside world can confirm the type of an element | LionMenu |
218
+ | `itemWrap` | public | `boolean` | | | LionMenu |
219
+ | `level` | public | `number` | `1` | The level of nested menus. Will be reflected as attribute for styling purposes | LionMenu |
220
+ | `listItems` | public | `HTMLElement[]` | | When used with FormRegistrarMixin, children will register themselves. Otherwise,&#xA;\_\_listItems are gathered via a slotchange listener | LionMenu |
221
+ | `multipleChoice` | public | `boolean` | `false` | | LionMenu |
222
+ | `noPreselect` | public | `boolean` | `false` | By default, checkedIndex is set to 0. When noPreselect is true,&#xA;checkedIndex will not be set | LionMenu |
223
+ | `opened` | public | `boolean` | `false` | If you add the opened attribute a dialog will be opened on page load. The invoker can be left out&#xA;in case the user does not need to be able to reopen the dialog. | OverlayMixin |
224
+ | `orientation` | public | `string` | `'vertical'` | | LionMenu |
225
+ | `parentList` | public | `InteractiveList` | `undefined` | The parent list if level > 1 | LionMenu |
226
+ | `rotateKeyboardNavigation` | public | `boolean` | `false` | | LionMenu |
227
+ | `selectionFollowsFocus` | public | `boolean` | `false` | | LionMenu |
228
+ | `slots` | public | | | | LionMenu |
229
+ | `_activateOnCharTimeout` | protected | `number` | `2000` | The pending char sequence that will set active list item | LionMenu |
230
+ | `_activateOnTypedChars` | public | `boolean` | `false` | By default, a typed character (or a sequence thereof) will be matched against&#xA;the values of list items. The first and closest match, becomes active&#xA;(focused or activedescendant depending on \_matchMode) | LionMenu |
231
+ | `_activeMode` | public | `'activedescendant'\|'roving-tabindex'\|'tabbable-disclosure'\|'none'` | `'activedescendant'` | Whenever possible (for \[role="listbox\|menu"], usually with one level) we use an&#xA;\[active descendant]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/#kbd\_focus\_activedescendant).&#xA;For \[role=toolbar], we use a \[roving tabindex]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/#kbd\_roving\_tabindex)&#xA;Other examples:&#xA;- \[role="menubar"]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/examples/menubar/menubar-1/menubar-1.html)&#xA;- \[role="tree"]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/examples/treeview/treeview-1/treeview-1b.html)&#xA;For disclosure menus, we need keyboard navigation, but treat every list item&#xA;(more precisely its anchor child) as a tab stop. | LionMenu |
232
+ | `_childrenRoles` | protected | `InteractiveListItemRole[]` | | The roles to look for when children are registered to listItems | LionMenu |
233
+ | `_contentNode` | protected | | | | LionMenu |
234
+ | `_hasSmartChildren` | protected | `boolean` | `false` | When children are 'smart' (like LionOption), checked and active states will be set&#xA;to them and they are responsible for setting \[aria-selected].&#xA;When false, \`get listItems()\` needs to be configured to point to the list items. | LionMenu |
235
+ | `_hasSmartListItems` | public | | | | LionMenu |
236
+ | `_interactiveChildrenRoles` | protected | | | | LionMenu |
237
+ | `_invokerNode` | protected | | | | LionMenu |
238
+ | `_listItemsSlot` | protected | `HTMLSlotElement` | | Place in the template that contains children with .\_childrenRoles | LionMenu |
239
+ | `_listNode` | protected | `HTMLElement` | | This is the (usually focusable, unless combobox) element that will contain \[aria-activedescendant]&#xA;Depending on the children, role will be "listbox\|menu\|menubar\|tree\|toolbar" | LionMenu |
240
+ | `_listRole` | protected | `'menu'\|'menubar'\|'listbox'\|'tree'\|'toolbar'` | `'menu'` | The role that will be put on \_listNode | LionMenu |
241
+ | `_onOverlayShow` | protected | | | | OverlayWithListInvokerMixin |
242
+ | `_onPopState` | protected | | | | LionMenu |
243
+ | `_overlayBackdropNode` | protected | | | | OverlayMixin |
244
+ | `_overlayContentNode` | protected | | | make sure OverlayMixin gets the contentNode defined by DisclosureMixin | OverlayMixin |
245
+ | `_overlayContentWrapperNode` | protected | | | | OverlayMixin |
246
+ | `_overlayInvokerNode` | protected | | | make sure OverlayMixin gets the invokerNode defined by DisclosureMixin | OverlayMixin |
247
+ | `_overlayReferenceNode` | protected | | | | OverlayMixin |
248
+ | `_scrollTargetNode` | protected | | | | LionMenu |
249
+ | `_subListMap` | protected | `Map<HTMLElement\|LionItem,InteractiveList>` | `new Map()` | | LionMenu |
250
+
251
+ ### Methods
252
+
253
+ | Name | Privacy | Description | Parameters | Return | Inherited From |
254
+ | ---------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------- | -------------- |
255
+ | `close` | public | Hides the overlay | | | OverlayMixin |
256
+ | `open` | public | Shows the overlay | | | OverlayMixin |
257
+ | `repositionOverlay` | public | Sometimes it's needed to recompute Popper position of an overlay, for instance when we have&#xA;an opened combobox and the surrounding context changes (the space consumed by the textbox&#xA;increases vertically) | | | OverlayMixin |
258
+ | `setCheckedIndex` | public | When \`multipleChoice\` is false, will toggle, else will check provided index | `index: Number` | | LionMenu |
259
+ | `toggle` | public | Toggles the overlay | `ev: Event` | | LionMenu |
260
+ | `_defineOverlay` | protected | | `{ contentNode, invokerNode, referenceNode, backdropNode, contentWrapperNode }, config: DefineOverlayConfig` | `OverlayController` | OverlayMixin |
261
+ | `_defineOverlayConfig` | protected | | | `OverlayConfig` | OverlayMixin |
262
+ | `_getNextEnabledOption` | protected | | `currentIndex: number, offset: number` | | LionMenu |
263
+ | `_getPreviousEnabledOption` | protected | | `currentIndex: number, offset: number` | | LionMenu |
264
+ | `_initListItems` | protected | When \_listItemsSlot receives new items, they are initialized via this method | `newItems: LionItem[]\|HTMLElement[]` | | LionMenu |
265
+ | `_isPermanentlyDisconnected` | protected | When we're moving around in dom, disconnectedCallback gets called.&#xA;Before we decide to teardown, let's wait to see if we were not just moving nodes around. | | `Promise<boolean>` | OverlayMixin |
266
+ | `_matchCharsAgainstItem` | protected | | `{ chars, item }, config: {chars: string[], item: HTMLElement}` | | LionMenu |
267
+ | `_onListClick` | protected | | `ev: MouseEvent` | | LionMenu |
268
+ | `_onListFocusIn` | protected | | `ev: FocusEvent` | | LionMenu |
269
+ | `_onListKeyDown` | protected | Handles various keyboard controls | `ev: KeyboardEvent` | | LionMenu |
270
+ | `_onListKeyUp` | protected | | `ev: *` | | LionMenu |
271
+ | `_setOpenedWithoutPropertyEffects` | protected | When the opened state is changed by an Application Developer,cthe OverlayController is&#xA;requested to show/hide. It might happen that this request is not honoured&#xA;(intercepted in before-hide for instance), so that we need to sync the controller state&#xA;to this webcomponent again, preventing eternal loops. | `newOpened: boolean` | | OverlayMixin |
272
+ | `_setupList` | protected | | | | LionMenu |
273
+ | `_setupOpenCloseListeners` | protected | | | | OverlayMixin |
274
+ | `_setupOverlayCtrl` | protected | | | | OverlayMixin |
275
+ | `_syncCurrentPageWithLocationHref` | protected | | `location: Location` | | LionMenu |
276
+ | `_teardownOpenCloseListeners` | protected | | | | OverlayMixin |
277
+ | `_teardownOverlayCtrl` | protected | | | | OverlayMixin |
278
+
279
+ ### Events
280
+
281
+ | Name | Type | Description | Inherited From |
282
+ | ---------------- | ------------- | ----------- | -------------- |
283
+ | `opened-changed` | `CustomEvent` | | OverlayMixin |
284
+
285
+ ### Attributes
286
+
287
+ | Name | Field | Inherited From |
288
+ | ---------------------------- | ------------------------ | -------------- |
289
+ | `opened` | opened | OverlayMixin |
290
+ | `orientation` | orientation | LionMenu |
291
+ | `multiple-choice` | multipleChoice | LionMenu |
292
+ | `selection-follows-focus` | selectionFollowsFocus | LionMenu |
293
+ | `rotate-keyboard-navigation` | rotateKeyboardNavigation | LionMenu |
294
+ | `no-preselect` | noPreselect | LionMenu |
295
+ | `item-wrap` | itemWrap | LionMenu |
296
+ | `_activateOnTypedChars` | \_activateOnTypedChars | LionMenu |
297
+ | `_hasSmartListItems` | \_hasSmartListItems | LionMenu |
298
+ | `_activeMode` | \_activeMode | LionMenu |
299
+ | `invokerNode` | invokerNode | LionMenu |
300
+ | `behave-as-accordion` | behaveAsAccordion | LionMenu |
301
+ | `level` | level | LionMenu |
302
+ | `bar` | bar | LionMenu |
303
+
304
+ <hr/>
305
+
306
+
307
+ ## class: `LionToolbar`, `lion-toolbar`
308
+
309
+ ### Fields
310
+
311
+ | Name | Privacy | Type | Default | Description | Inherited From |
312
+ | --------------------------- | --------- | ---------------------------------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- |
313
+ | `activeIndex` | public | | | | LionMenu |
314
+ | `activeItem` | public | | | | LionMenu |
315
+ | `bar` | public | `boolean` | `true` | Enable bar to use \[role="menubar"] and horizontal navigation | LionMenu |
316
+ | `behaveAsAccordion` | public | `boolean` | `false` | When true, will have a maximum of one submenu open at a time | LionMenu |
317
+ | `checkedIndex` | public | `number \| number[]` | | | LionMenu |
318
+ | `handleFocus` | public | `boolean` | `true` | | LionMenu |
319
+ | `invokerInteraction` | public | `string` | `'click'` | | LionMenu |
320
+ | `invokerNode` | public | `HTMLElement` | `undefined` | When an invokerNode is supplied (usually by a parent level menu), it will take precedence&#xA;over \[slot=invoker] and previousElementSibling with \[data-invoker] attribute | LionMenu |
321
+ | `isInteractiveList` | public | | | Since we cannot check instanceof with mixins, use this getter instead.&#xA;This way, the outside world can confirm the type of an element | LionMenu |
322
+ | `itemWrap` | public | `boolean` | | | LionMenu |
323
+ | `level` | public | `number` | `1` | The level of nested menus. Will be reflected as attribute for styling purposes | LionMenu |
324
+ | `listItems` | public | `HTMLElement[]` | | When used with FormRegistrarMixin, children will register themselves. Otherwise,&#xA;\_\_listItems are gathered via a slotchange listener | LionMenu |
325
+ | `multipleChoice` | public | `boolean` | `false` | | LionMenu |
326
+ | `noPreselect` | public | `boolean` | `true` | By default, checkedIndex is set to 0. When noPreselect is true,&#xA;checkedIndex will not be set | LionMenu |
327
+ | `orientation` | public | `string` | `'vertical'` | | LionMenu |
328
+ | `parentList` | public | `InteractiveList` | `undefined` | The parent list if level > 1 | LionMenu |
329
+ | `rotateKeyboardNavigation` | public | `boolean` | `false` | | LionMenu |
330
+ | `selectionFollowsFocus` | public | `boolean` | `false` | | LionMenu |
331
+ | `slots` | public | | | | LionMenu |
332
+ | `_activateOnCharTimeout` | protected | `number` | `2000` | The pending char sequence that will set active list item | LionMenu |
333
+ | `_activateOnTypedChars` | public | `boolean` | `false` | By default, a typed character (or a sequence thereof) will be matched against&#xA;the values of list items. The first and closest match, becomes active&#xA;(focused or activedescendant depending on \_matchMode) | LionMenu |
334
+ | `_activeMode` | public | `'activedescendant'\|'roving-tabindex'\|'tabbable-disclosure'\|'none'` | `'roving-tabindex'` | Whenever possible (for \[role="listbox\|menu"], usually with one level) we use an&#xA;\[active descendant]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/#kbd\_focus\_activedescendant).&#xA;For \[role=toolbar], we use a \[roving tabindex]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/#kbd\_roving\_tabindex)&#xA;Other examples:&#xA;- \[role="menubar"]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/examples/menubar/menubar-1/menubar-1.html)&#xA;- \[role="tree"]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/examples/treeview/treeview-1/treeview-1b.html)&#xA;For disclosure menus, we need keyboard navigation, but treat every list item&#xA;(more precisely its anchor child) as a tab stop. | LionMenu |
335
+ | `_childrenRoles` | protected | `InteractiveListItemRole[]` | | The roles to look for when children are registered to listItems | LionMenu |
336
+ | `_contentNode` | protected | | | | LionMenu |
337
+ | `_hasSmartChildren` | protected | `boolean` | `false` | When children are 'smart' (like LionOption), checked and active states will be set&#xA;to them and they are responsible for setting \[aria-selected].&#xA;When false, \`get listItems()\` needs to be configured to point to the list items. | LionMenu |
338
+ | `_hasSmartListItems` | public | | | | LionMenu |
339
+ | `_interactiveChildrenRoles` | protected | | | | LionMenu |
340
+ | `_invokerNode` | protected | | | | LionMenu |
341
+ | `_listItemsSlot` | protected | `HTMLSlotElement` | | Place in the template that contains children with .\_childrenRoles | LionMenu |
342
+ | `_listNode` | protected | `HTMLElement` | | This is the (usually focusable, unless combobox) element that will contain \[aria-activedescendant]&#xA;Depending on the children, role will be "listbox\|menu\|menubar\|tree\|toolbar" | LionMenu |
343
+ | `_listRole` | protected | `'menu'\|'menubar'\|'listbox'\|'tree'\|'toolbar'` | `'toolbar'` | The role that will be put on \_listNode | LionMenu |
344
+ | `_onPopState` | protected | | | | LionMenu |
345
+ | `_scrollTargetNode` | protected | | | | LionMenu |
346
+ | `_subListMap` | protected | `Map<HTMLElement\|LionItem,InteractiveList>` | `new Map()` | | LionMenu |
347
+
348
+ ### Methods
349
+
350
+ | Name | Privacy | Description | Parameters | Return | Inherited From |
351
+ | ---------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ------ | -------------- |
352
+ | `setCheckedIndex` | public | Allows groups (\[role=radiogroup\|checkboxgroup]) within one level.&#xA;In case we deal with \[role=checkbox], we treat it as multiple choice group | `index: number` | | LionMenu |
353
+ | `toggle` | public | | `ev: Event` | | LionMenu |
354
+ | `_getNextEnabledOption` | protected | | `currentIndex: number, offset: number` | | LionMenu |
355
+ | `_getPreviousEnabledOption` | protected | | `currentIndex: number, offset: number` | | LionMenu |
356
+ | `_initListItems` | protected | When \_listItemsSlot receives new items, they are initialized via this method | `newItems: *` | | LionMenu |
357
+ | `_matchCharsAgainstItem` | protected | | `{ chars, item }, config: {chars: string[], item: HTMLElement}` | | LionMenu |
358
+ | `_onListClick` | protected | | `ev: MouseEvent` | | LionMenu |
359
+ | `_onListFocusIn` | protected | | `ev: FocusEvent` | | LionMenu |
360
+ | `_onListKeyDown` | protected | Handles various keyboard controls | `ev: *` | | LionMenu |
361
+ | `_onListKeyUp` | protected | | `ev: KeyboardEvent` | | LionMenu |
362
+ | `_setupList` | protected | | | | LionMenu |
363
+ | `_syncCurrentPageWithLocationHref` | protected | | `location: Location` | | LionMenu |
364
+
365
+ ### Attributes
366
+
367
+ | Name | Field | Inherited From |
368
+ | ---------------------------- | ------------------------ | -------------- |
369
+ | `invokerNode` | invokerNode | LionMenu |
370
+ | `behave-as-accordion` | behaveAsAccordion | LionMenu |
371
+ | `level` | level | LionMenu |
372
+ | `orientation` | orientation | LionMenu |
373
+ | `multiple-choice` | multipleChoice | LionMenu |
374
+ | `selection-follows-focus` | selectionFollowsFocus | LionMenu |
375
+ | `rotate-keyboard-navigation` | rotateKeyboardNavigation | LionMenu |
376
+ | `no-preselect` | noPreselect | LionMenu |
377
+ | `item-wrap` | itemWrap | LionMenu |
378
+ | `_activateOnTypedChars` | \_activateOnTypedChars | LionMenu |
379
+ | `_hasSmartListItems` | \_hasSmartListItems | LionMenu |
380
+ | `_activeMode` | \_activeMode | LionMenu |
381
+ | `bar` | bar | LionMenu |
382
+
383
+ <hr/>
384
+
385
+
386
+ ## class: `LionTree`, `lion-tree`
387
+
388
+ ### Fields
389
+
390
+ | Name | Privacy | Type | Default | Description | Inherited From |
391
+ | --------------------------- | --------- | ---------------------------------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------- |
392
+ | `activeIndex` | public | | | | InteractiveListMixin |
393
+ | `activeItem` | public | | | | InteractiveListMixin |
394
+ | `behaveAsAccordion` | public | `boolean` | `false` | When true, will have a maximum of one submenu open at a time | MultiLevelListMixin |
395
+ | `checkedIndex` | public | `number \| number[]` | | | InteractiveListMixin |
396
+ | `handleFocus` | public | `boolean` | `true` | | MultiLevelListMixin |
397
+ | `invokerInteraction` | public | `string` | `'click'` | | |
398
+ | `invokerNode` | public | `HTMLElement` | `undefined` | When an invokerNode is supplied (usually by a parent level menu), it will take precedence&#xA;over \[slot=invoker] and previousElementSibling with \[data-invoker] attribute | MultiLevelListMixin |
399
+ | `isInteractiveList` | public | | | Since we cannot check instanceof with mixins, use this getter instead.&#xA;This way, the outside world can confirm the type of an element | InteractiveListMixin |
400
+ | `itemWrap` | public | `boolean` | | | InteractiveListMixin |
401
+ | `level` | public | `number` | `1` | The level of nested menus. Will be reflected as attribute for styling purposes | MultiLevelListMixin |
402
+ | `listItems` | public | `HTMLElement[]` | | When used with FormRegistrarMixin, children will register themselves. Otherwise,&#xA;\_\_listItems are gathered via a slotchange listener | InteractiveListMixin |
403
+ | `multipleChoice` | public | `boolean` | `false` | | InteractiveListMixin |
404
+ | `noPreselect` | public | `boolean` | `true` | By default, checkedIndex is set to 0. When noPreselect is true,&#xA;checkedIndex will not be set | InteractiveListMixin |
405
+ | `orientation` | public | `string` | `'vertical'` | | InteractiveListMixin |
406
+ | `parentList` | public | `InteractiveList` | `undefined` | The parent list if level > 1 | MultiLevelListMixin |
407
+ | `rotateKeyboardNavigation` | public | `boolean` | `false` | | InteractiveListMixin |
408
+ | `selectionFollowsFocus` | public | `boolean` | `false` | | InteractiveListMixin |
409
+ | `slots` | public | | | | InteractiveListMixin |
410
+ | `_activateOnCharTimeout` | protected | `number` | `2000` | The pending char sequence that will set active list item | InteractiveListMixin |
411
+ | `_activateOnTypedChars` | public | `boolean` | `true` | By default, a typed character (or a sequence thereof) will be matched against&#xA;the values of list items. The first and closest match, becomes active&#xA;(focused or activedescendant depending on \_matchMode) | InteractiveListMixin |
412
+ | `_activeMode` | public | `'activedescendant'\|'roving-tabindex'\|'tabbable-disclosure'\|'none'` | `'roving-tabindex'` | Whenever possible (for \[role="listbox\|menu"], usually with one level) we use an&#xA;\[active descendant]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/#kbd\_focus\_activedescendant).&#xA;For \[role=toolbar], we use a \[roving tabindex]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/#kbd\_roving\_tabindex)&#xA;Other examples:&#xA;- \[role="menubar"]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/examples/menubar/menubar-1/menubar-1.html)&#xA;- \[role="tree"]\(https\://www\.w3.org/TR/wai-aria-practices-1.1/examples/treeview/treeview-1/treeview-1b.html)&#xA;For disclosure menus, we need keyboard navigation, but treat every list item&#xA;(more precisely its anchor child) as a tab stop. | InteractiveListMixin |
413
+ | `_childrenRoles` | protected | `InteractiveListItemRole[]` | | The roles to look for when children are registered to listItems | InteractiveListMixin |
414
+ | `_contentNode` | protected | | | | MultiLevelListMixin |
415
+ | `_hasSmartChildren` | protected | `boolean` | `false` | When children are 'smart' (like LionOption), checked and active states will be set&#xA;to them and they are responsible for setting \[aria-selected].&#xA;When false, \`get listItems()\` needs to be configured to point to the list items. | InteractiveListMixin |
416
+ | `_hasSmartListItems` | public | | | | InteractiveListMixin |
417
+ | `_interactiveChildrenRoles` | protected | | | | InteractiveListMixin |
418
+ | `_invokerNode` | protected | | | | MultiLevelListMixin |
419
+ | `_listItemsSlot` | protected | `HTMLSlotElement` | | Place in the template that contains children with .\_childrenRoles | InteractiveListMixin |
420
+ | `_listNode` | protected | `HTMLElement` | | This is the (usually focusable, unless combobox) element that will contain \[aria-activedescendant]&#xA;Depending on the children, role will be "listbox\|menu\|menubar\|tree\|toolbar" | InteractiveListMixin |
421
+ | `_listRole` | protected | `'menu'\|'menubar'\|'listbox'\|'tree'\|'toolbar'` | `'tree'` | The role that will be put on \_listNode | InteractiveListMixin |
422
+ | `_onPopState` | protected | | | | InteractiveListMixin |
423
+ | `_scrollTargetNode` | protected | | | | InteractiveListMixin |
424
+ | `_subListMap` | protected | `Map<HTMLElement\|LionItem,InteractiveList>` | `new Map()` | | MultiLevelListMixin |
425
+
426
+ ### Methods
427
+
428
+ | Name | Privacy | Description | Parameters | Return | Inherited From |
429
+ | ---------------------------------- | --------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------- | ------ | -------------------- |
430
+ | `setCheckedIndex` | public | When \`multipleChoice\` is false, will toggle, else will check provided index | `index: Number` | | InteractiveListMixin |
431
+ | `toggle` | public | | `ev: Event` | | MultiLevelListMixin |
432
+ | `_getNextEnabledOption` | protected | | `currentIndex: number, offset: number` | | InteractiveListMixin |
433
+ | `_getPreviousEnabledOption` | protected | | `currentIndex: number, offset: number` | | InteractiveListMixin |
434
+ | `_initListItems` | protected | When \_listItemsSlot receives new items, they are initialized via this method | `newItems: *` | | InteractiveListMixin |
435
+ | `_matchCharsAgainstItem` | protected | | `{ chars, item }, config: {chars: string[], item: HTMLElement}` | | InteractiveListMixin |
436
+ | `_onListClick` | protected | | `ev: MouseEvent` | | InteractiveListMixin |
437
+ | `_onListFocusIn` | protected | | `ev: FocusEvent` | | InteractiveListMixin |
438
+ | `_onListKeyDown` | protected | Handles various keyboard controls | `ev: *` | | InteractiveListMixin |
439
+ | `_onListKeyUp` | protected | | `ev: KeyboardEvent` | | InteractiveListMixin |
440
+ | `_setupList` | protected | | | | InteractiveListMixin |
441
+ | `_syncCurrentPageWithLocationHref` | protected | | `location: Location` | | InteractiveListMixin |
442
+
443
+ ### Attributes
444
+
445
+ | Name | Field | Inherited From |
446
+ | ---------------------------- | ------------------------ | -------------------- |
447
+ | `invokerNode` | invokerNode | MultiLevelListMixin |
448
+ | `behave-as-accordion` | behaveAsAccordion | MultiLevelListMixin |
449
+ | `level` | level | MultiLevelListMixin |
450
+ | `orientation` | orientation | InteractiveListMixin |
451
+ | `multiple-choice` | multipleChoice | InteractiveListMixin |
452
+ | `selection-follows-focus` | selectionFollowsFocus | InteractiveListMixin |
453
+ | `rotate-keyboard-navigation` | rotateKeyboardNavigation | InteractiveListMixin |
454
+ | `no-preselect` | noPreselect | InteractiveListMixin |
455
+ | `item-wrap` | itemWrap | InteractiveListMixin |
456
+ | `_activateOnTypedChars` | \_activateOnTypedChars | InteractiveListMixin |
457
+ | `_hasSmartListItems` | \_hasSmartListItems | InteractiveListMixin |
458
+ | `_activeMode` | \_activeMode | InteractiveListMixin |
459
+
460
+ <hr/>