@lion/ui 0.16.0 → 0.17.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.
- package/collapsible.js +1 -0
- package/components/button/src/LionButton.js +5 -0
- package/components/button/test-suites/LionButton.suite.js +1 -0
- package/components/calendar/src/LionCalendar.js +2 -0
- package/components/collapsible/src/DisclosureMixin.js +313 -0
- package/components/collapsible/types/DisclosureMixinTypes.ts +48 -0
- package/components/combobox/src/utils/makeMatchingTextBold.js +3 -1
- package/components/combobox/test/lion-combobox.test.js +105 -0
- package/components/form-core/src/form-group/FormGroupMixin.js +7 -0
- package/components/form-core/src/registration/FormRegistrarMixin.js +11 -0
- package/components/form-core/test/FormControlMixin.test.js +1 -0
- package/components/form-core/test/validate/Validator.test.js +2 -0
- package/components/form-core/test-suites/ValidateMixin.suite.js +2 -0
- package/components/form-core/test-suites/ValidateMixinFeedbackPart.suite.js +1 -0
- package/components/input-datepicker/src/LionInputDatepicker.js +6 -2
- package/components/input-datepicker/src/localizeNamespaceLoader.js +1 -0
- package/components/input-datepicker/test/lion-input-datepicker.test.js +17 -2
- package/components/input-datepicker/translations/bg.js +1 -1
- package/components/input-datepicker/translations/cs.js +1 -1
- package/components/input-datepicker/translations/de.js +1 -1
- package/components/input-datepicker/translations/en.js +1 -1
- package/components/input-datepicker/translations/es.js +1 -1
- package/components/input-datepicker/translations/fr.js +1 -1
- package/components/input-datepicker/translations/hu.js +1 -1
- package/components/input-datepicker/translations/it.js +1 -1
- package/components/input-datepicker/translations/nl.js +1 -1
- package/components/input-datepicker/translations/pl.js +1 -1
- package/components/input-datepicker/translations/ro.js +1 -1
- package/components/input-datepicker/translations/ru.js +1 -1
- package/components/input-datepicker/translations/sk.js +1 -1
- package/components/input-datepicker/translations/tr.js +1 -1
- package/components/input-datepicker/translations/uk.js +1 -1
- package/components/input-datepicker/translations/zh.js +1 -1
- package/components/input-stepper/src/LionInputStepper.js +15 -7
- package/components/input-stepper/test-suites/lion-input-stepper.suite.js +28 -4
- package/components/localize/test/date/formatDate.test.js +1 -0
- package/components/menu/CHANGELOG.md +37 -0
- package/components/menu/README.md +335 -0
- package/components/menu/index.js +2 -0
- package/components/menu/lion-menu-overlay.js +3 -0
- package/components/menu/lion-menu.js +3 -0
- package/components/menu/lion-spinbutton.js +3 -0
- package/components/menu/lion-toolbar.js +3 -0
- package/components/menu/lion-tree.js +3 -0
- package/components/menu/package.json +46 -0
- package/components/menu/requirements.temp.md +12 -0
- package/components/menu/src/InteractiveListMixin.js +796 -0
- package/components/menu/src/LionMenu.js +250 -0
- package/components/menu/src/LionMenuHybrid.js +46 -0
- package/components/menu/src/LionMenuOverlay.js +155 -0
- package/components/menu/src/LionSpinbutton.js +213 -0
- package/components/menu/src/LionToolbar.js +94 -0
- package/components/menu/src/LionTree.js +52 -0
- package/components/menu/src/MultiLevelListMixin.js +275 -0
- package/components/menu/src/utils/isInView.js +26 -0
- package/components/menu/src/utils/listItemInteractions.js +104 -0
- package/components/menu/src/utils/uuid.js +3 -0
- package/components/menu/test/lion-menu.test.js +3 -0
- package/components/menu/test-suites/InteractiveListMixin.suite.js +142 -0
- package/components/menu/types/InteractiveListMixinTypes.d.ts +82 -0
- package/components/navigation-bar/README.md +1 -0
- package/components/navigation-bar/src/LionNavigationBar.js +449 -0
- package/components/navigation-bar/src/types.js +41 -0
- package/components/overlays/NEXT.md +49 -0
- package/components/overlays/src/OverlayController.js +165 -115
- package/components/overlays/src/OverlayMixin.js +75 -12
- package/components/overlays/src/OverlaysManager.js +102 -4
- package/components/overlays/src/overlayShadowDomStyle.js +2 -2
- package/components/overlays/src/utils/adopt-styles.js +2 -1
- package/components/overlays/src/utils/get-focusable-elements.js +4 -0
- package/components/overlays/src/utils/is-equal-config.js +4 -1
- package/components/overlays/test/OverlayController.test.js +117 -6
- package/components/overlays/test/OverlaysManager.test.js +1 -1
- package/components/overlays/types/OverlayConfig.ts +19 -4
- package/components/select-rich/test/lion-select-rich.test.js +3 -0
- package/custom-elements.json +12958 -2510
- package/dist-types/components/button/src/LionButton.d.ts +1 -0
- package/dist-types/components/button/src/LionButton.d.ts.map +1 -1
- package/dist-types/components/button/test-suites/LionButton.suite.d.ts.map +1 -1
- package/dist-types/components/calendar/src/LionCalendar.d.ts.map +1 -1
- package/dist-types/components/collapsible/src/DisclosureMixin.d.ts +3 -0
- package/dist-types/components/collapsible/src/DisclosureMixin.d.ts.map +1 -0
- package/dist-types/components/collapsible/types/DisclosureMixinTypes.d.ts +24 -0
- package/dist-types/components/collapsible/types/DisclosureMixinTypes.d.ts.map +1 -0
- package/dist-types/components/combobox/src/utils/makeMatchingTextBold.d.ts.map +1 -1
- package/dist-types/components/dialog/src/LionDialog.d.ts +2 -1
- package/dist-types/components/dialog/src/LionDialog.d.ts.map +1 -1
- package/dist-types/components/form-core/src/form-group/FormGroupMixin.d.ts.map +1 -1
- package/dist-types/components/form-core/src/registration/FormRegistrarMixin.d.ts.map +1 -1
- package/dist-types/components/form-core/test-suites/ValidateMixin.suite.d.ts.map +1 -1
- package/dist-types/components/form-core/test-suites/ValidateMixinFeedbackPart.suite.d.ts.map +1 -1
- package/dist-types/components/input-datepicker/src/LionInputDatepicker.d.ts.map +1 -1
- package/dist-types/components/input-datepicker/src/localizeNamespaceLoader.d.ts.map +1 -1
- package/dist-types/components/input-stepper/src/LionInputStepper.d.ts +4 -2
- package/dist-types/components/input-stepper/src/LionInputStepper.d.ts.map +1 -1
- package/dist-types/components/input-stepper/test-suites/lion-input-stepper.suite.d.ts.map +1 -1
- package/dist-types/components/menu/index.d.ts +3 -0
- package/dist-types/components/menu/index.d.ts.map +1 -0
- package/dist-types/components/menu/lion-menu-overlay.d.ts +2 -0
- package/dist-types/components/menu/lion-menu-overlay.d.ts.map +1 -0
- package/dist-types/components/menu/lion-menu.d.ts +2 -0
- package/dist-types/components/menu/lion-menu.d.ts.map +1 -0
- package/dist-types/components/menu/lion-spinbutton.d.ts +2 -0
- package/dist-types/components/menu/lion-spinbutton.d.ts.map +1 -0
- package/dist-types/components/menu/lion-toolbar.d.ts +2 -0
- package/dist-types/components/menu/lion-toolbar.d.ts.map +1 -0
- package/dist-types/components/menu/lion-tree.d.ts +2 -0
- package/dist-types/components/menu/lion-tree.d.ts.map +1 -0
- package/dist-types/components/menu/src/InteractiveListMixin.d.ts +611 -0
- package/dist-types/components/menu/src/InteractiveListMixin.d.ts.map +1 -0
- package/dist-types/components/menu/src/LionMenu.d.ts +563 -0
- package/dist-types/components/menu/src/LionMenu.d.ts.map +1 -0
- package/dist-types/components/menu/src/LionMenuHybrid.d.ts +19 -0
- package/dist-types/components/menu/src/LionMenuHybrid.d.ts.map +1 -0
- package/dist-types/components/menu/src/LionMenuOverlay.d.ts +1006 -0
- package/dist-types/components/menu/src/LionMenuOverlay.d.ts.map +1 -0
- package/dist-types/components/menu/src/LionSpinbutton.d.ts +58 -0
- package/dist-types/components/menu/src/LionSpinbutton.d.ts.map +1 -0
- package/dist-types/components/menu/src/LionToolbar.d.ts +8 -0
- package/dist-types/components/menu/src/LionToolbar.d.ts.map +1 -0
- package/dist-types/components/menu/src/LionTree.d.ts +445 -0
- package/dist-types/components/menu/src/LionTree.d.ts.map +1 -0
- package/dist-types/components/menu/src/MultiLevelListMixin.d.ts +493 -0
- package/dist-types/components/menu/src/MultiLevelListMixin.d.ts.map +1 -0
- package/dist-types/components/menu/src/utils/isInView.d.ts +9 -0
- package/dist-types/components/menu/src/utils/isInView.d.ts.map +1 -0
- package/dist-types/components/menu/src/utils/listItemInteractions.d.ts +42 -0
- package/dist-types/components/menu/src/utils/listItemInteractions.d.ts.map +1 -0
- package/dist-types/components/menu/src/utils/uuid.d.ts +2 -0
- package/dist-types/components/menu/src/utils/uuid.d.ts.map +1 -0
- package/dist-types/components/menu/test/lion-menu.test.d.ts +2 -0
- package/dist-types/components/menu/test/lion-menu.test.d.ts.map +1 -0
- package/dist-types/components/menu/test-suites/InteractiveListMixin.suite.d.ts +13 -0
- package/dist-types/components/menu/test-suites/InteractiveListMixin.suite.d.ts.map +1 -0
- package/dist-types/components/navigation-bar/src/LionNavigationBar.d.ts +226 -0
- package/dist-types/components/navigation-bar/src/LionNavigationBar.d.ts.map +1 -0
- package/dist-types/components/navigation-bar/src/types.d.ts +85 -0
- package/dist-types/components/navigation-bar/src/types.d.ts.map +1 -0
- package/dist-types/components/overlays/src/OverlayController.d.ts +7 -13
- package/dist-types/components/overlays/src/OverlayController.d.ts.map +1 -1
- package/dist-types/components/overlays/src/OverlayMixin.d.ts +3 -0
- package/dist-types/components/overlays/src/OverlayMixin.d.ts.map +1 -1
- package/dist-types/components/overlays/src/OverlaysManager.d.ts +33 -2
- package/dist-types/components/overlays/src/OverlaysManager.d.ts.map +1 -1
- package/dist-types/components/overlays/src/utils/get-focusable-elements.d.ts.map +1 -1
- package/dist-types/components/overlays/src/utils/is-equal-config.d.ts.map +1 -1
- package/dist-types/components/overlays/types/OverlayConfig.d.ts +6 -2
- package/dist-types/components/overlays/types/OverlayConfig.d.ts.map +1 -1
- package/dist-types/components/select-rich/src/LionSelectRich.d.ts +11 -2
- package/dist-types/components/select-rich/src/LionSelectRich.d.ts.map +1 -1
- package/dist-types/exports/define/lion-item.d.ts +2 -0
- package/dist-types/exports/define/lion-item.d.ts.map +1 -0
- package/dist-types/exports/define/lion-menu-overlay.d.ts +2 -0
- package/dist-types/exports/define/lion-menu-overlay.d.ts.map +1 -0
- package/dist-types/exports/define/lion-menu.d.ts +2 -0
- package/dist-types/exports/define/lion-menu.d.ts.map +1 -0
- package/dist-types/exports/define/lion-navigation-bar.d.ts +2 -0
- package/dist-types/exports/define/lion-navigation-bar.d.ts.map +1 -0
- package/dist-types/exports/define/lion-toolbar.d.ts +2 -0
- package/dist-types/exports/define/lion-toolbar.d.ts.map +1 -0
- package/dist-types/exports/define/lion-tree.d.ts +2 -0
- package/dist-types/exports/define/lion-tree.d.ts.map +1 -0
- package/dist-types/exports/menu.d.ts +7 -0
- package/dist-types/exports/menu.d.ts.map +1 -0
- package/dist-types/exports/navigation-bar.d.ts +2 -0
- package/dist-types/exports/navigation-bar.d.ts.map +1 -0
- package/dist-types/exports/overlays.d.ts +2 -0
- package/dist-types/exports/types/overlays.d.ts +1 -0
- package/dist-types/exports/types/overlays.d.ts.map +1 -1
- package/dist-types/tsconfig.tsbuildinfo +1 -1
- package/docs/components/checkbox-group/overview.md +2 -2
- package/docs/components/collapsible/overview.md +1 -1
- package/docs/components/combobox/overview.md +1 -1
- package/docs/components/combobox/use-cases.md +1 -1
- package/docs/components/dialog/overview.md +1 -1
- package/docs/components/fieldset/overview.md +5 -5
- package/docs/components/form/overview.md +3 -3
- package/docs/components/form/use-cases.md +2 -2
- package/docs/components/icon/use-cases.md +1 -1
- package/docs/components/index.md +1 -1
- package/docs/components/input/overview.md +1 -1
- package/docs/components/input-amount/overview.md +3 -3
- package/docs/components/input-date/overview.md +3 -3
- package/docs/components/input-datepicker/overview.md +5 -5
- package/docs/components/input-datepicker/use-cases.md +16 -1
- package/docs/components/input-email/overview.md +2 -2
- package/docs/components/input-file/overview.md +1 -1
- package/docs/components/input-iban/overview.md +2 -2
- package/docs/components/input-range/api-table.md +1 -1
- package/docs/components/input-range/overview.md +2 -2
- package/docs/components/input-stepper/api-table.md +2 -2
- package/docs/components/input-stepper/overview.md +1 -1
- package/docs/components/input-stepper/use-cases.md +26 -0
- package/docs/components/input-tel/overview.md +1 -1
- package/docs/components/input-tel/use-cases.md +6 -6
- package/docs/components/input-tel-dropdown/overview.md +1 -1
- package/docs/components/listbox/use-cases.md +1 -1
- package/docs/components/menu/api-table.md +450 -0
- package/docs/components/menu/applyMenuDemoStyles.js +173 -0
- package/docs/components/menu/extensions.md +216 -0
- package/docs/components/menu/index.md +13 -0
- package/docs/components/menu/overview.md +422 -0
- package/docs/components/radio-group/overview.md +3 -3
- package/docs/components/select/use-cases.md +1 -1
- package/docs/components/select-rich/api-table.md +1 -1
- package/docs/components/select-rich/use-cases.md +2 -2
- package/docs/components/tabs/examples.md +1 -1
- package/docs/fundamentals/index.md +4 -4
- package/docs/fundamentals/node-tools/publish-docs/overview.md +3 -3
- package/docs/fundamentals/node-tools/rocket-preset-extend-lion-docs/overview.md +2 -2
- package/docs/fundamentals/rationales/accessibility.md +1 -1
- package/docs/fundamentals/systems/core/SlotMixin.md +18 -18
- package/docs/fundamentals/systems/core/overview.md +1 -1
- package/docs/fundamentals/systems/form/formatting-and-parsing.md +4 -4
- package/docs/fundamentals/systems/form/interaction-states.md +0 -1
- package/docs/fundamentals/systems/form/model-value.md +1 -1
- package/docs/fundamentals/systems/form/overview.md +28 -28
- package/docs/fundamentals/systems/form/validate.md +2 -2
- package/docs/fundamentals/systems/localize/overview.md +4 -4
- package/docs/fundamentals/systems/localize/text.md +1 -1
- package/docs/fundamentals/systems/overlays/api-table.md +98 -50
- package/docs/fundamentals/systems/overlays/configuration.md +2 -2
- package/docs/fundamentals/systems/overlays/overview.md +5 -5
- package/docs/fundamentals/systems/overlays/use-cases.md +2 -2
- package/docs/fundamentals/tools/helpers/overview.md +1 -1
- package/docs/fundamentals/tools/singleton-manager/overview.md +4 -4
- package/docs/guides/how-to/create-a-custom-field.md +5 -5
- package/docs/guides/how-to/create-a-form.md +4 -4
- package/docs/guides/how-to/extend-a-native-input.md +2 -2
- package/docs/guides/how-to/index.md +14 -0
- package/docs/guides/index.md +8 -8
- package/docs/guides/principles/index.md +5 -5
- package/docs/guides/principles/styling.md +1 -2
- package/exports/collapsible.js +1 -0
- package/exports/define/lion-item.js +3 -0
- package/exports/define/lion-menu-overlay.js +3 -0
- package/exports/define/lion-menu.js +3 -0
- package/exports/define/lion-navigation-bar.js +3 -0
- package/exports/define/lion-toolbar.js +3 -0
- package/exports/define/lion-tree.js +3 -0
- package/exports/menu.js +6 -0
- package/exports/navigation-bar.js +1 -0
- package/exports/overlays.js +2 -0
- package/exports/types/overlays.ts +1 -0
- package/menu.js +6 -0
- package/navigation-bar.js +1 -0
- package/overlays.js +2 -0
- package/package.json +1 -1
|
@@ -17,40 +17,40 @@ eleventyNavigation:
|
|
|
17
17
|
|
|
18
18
|
### Fields
|
|
19
19
|
|
|
20
|
-
| Name | Privacy | Type | Default
|
|
21
|
-
| --------------------------- | --------- | ------------------------------------------------- |
|
|
22
|
-
| `backdropNode` | public | `HTMLElement` |
|
|
23
|
-
| `config` | public | `OverlayConfig` | `{}`
|
|
24
|
-
| `content` | public | `HTMLDialogElement \| HTMLDivElement` |
|
|
25
|
-
| `contentNode` | public | `HTMLElement` |
|
|
26
|
-
| `contentWrapperNode` | public | `HTMLElement` |
|
|
27
|
-
| `elementToFocusAfterHide` | public | `HTMLElement` |
|
|
28
|
-
| `elevation` | public | `number` |
|
|
29
|
-
| `handlesAccessibility` | public | `boolean` |
|
|
30
|
-
| `hasActiveBackdrop` | public | |
|
|
31
|
-
| `hasBackdrop` | public | `boolean` |
|
|
32
|
-
| `hidesOnEsc` | public | `boolean` |
|
|
33
|
-
| `hidesOnOutsideClick` | public | `boolean` |
|
|
34
|
-
| `hidesOnOutsideEsc` | public | `boolean` |
|
|
35
|
-
| `inheritsReferenceWidth` | public | `'max' \| 'full' \| 'min' \| 'none' \| undefined` |
|
|
36
|
-
| `invoker` | public | `HTMLElement \| undefined` |
|
|
37
|
-
| `invokerNode` | public | `HTMLElement \| undefined` |
|
|
38
|
-
| `invokerRelation` | public | `'label' \| 'description'\| undefined` |
|
|
39
|
-
| `isAlertDialog` | public | |
|
|
40
|
-
| `isBlocking` | public | `boolean` |
|
|
41
|
-
| `isShown` | public | |
|
|
42
|
-
| `isTooltip` | public | `boolean` |
|
|
43
|
-
| `manager` | public | | `manager`
|
|
44
|
-
| `placementMode` | public | `'global' \| 'local' \| undefined`
|
|
45
|
-
| `popperConfig` | public | `PopperOptions` |
|
|
46
|
-
| `preventsScroll` | public | `boolean` |
|
|
47
|
-
| `referenceNode` | public | `HTMLElement` |
|
|
48
|
-
| `trapsKeyboardFocus` | public | `boolean` |
|
|
49
|
-
| `viewportConfig` | public | `ViewportConfig` |
|
|
50
|
-
| `visibilityTriggerFunction` | public | |
|
|
51
|
-
| `_contentId` | protected | | `` `overlay-content--${Math.random().toString(36).slice(2, 10)}` ``
|
|
52
|
-
| `_defaultConfig` | protected | `OverlayConfig` | `{ placementMode: undefined, contentNode: config.contentNode, contentWrapperNode: config.contentWrapperNode, invokerNode: config.invokerNode, backdropNode: config.backdropNode, referenceNode: undefined, elementToFocusAfterHide: config.invokerNode, inheritsReferenceWidth: 'none', hasBackdrop: false, isBlocking: false, preventsScroll: false, trapsKeyboardFocus: false, hidesOnEsc: false, hidesOnOutsideEsc: false, hidesOnOutsideClick: false, isTooltip: false, isAlertDialog: false, invokerRelation: 'description', visibilityTriggerFunction: undefined, handlesAccessibility: false, popperConfig: { placement: 'top', strategy: 'fixed', modifiers: [ { name: 'preventOverflow', enabled: true, options: { boundariesElement: 'viewport', padding: 8, // viewport-margin for shifting/sliding }, }, { name: 'flip', options: { boundariesElement: 'viewport', padding: 16, // viewport-margin for flipping }, }, { name: 'offset', enabled: true, options: { offset: [0, 8], // horizontal and vertical margin (distance between popper and referenceElement) }, }, { name: 'arrow', enabled: false, }, ], }, viewportConfig: { placement: 'center', }, zIndex: 9999, }` | | |
|
|
53
|
-
| `_referenceNode` | protected | `HTMLElement \| undefined` |
|
|
20
|
+
| Name | Privacy | Type | Default | Description | Inherited From |
|
|
21
|
+
| --------------------------- | --------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
|
|
22
|
+
| `backdropNode` | public | `HTMLElement` | | The element that is placed behind the contentNode. When not provided and \`hasBackdrop\` is true,
a backdropNode will be automatically created | |
|
|
23
|
+
| `config` | public | `OverlayConfig` | `{}` | | |
|
|
24
|
+
| `content` | public | `HTMLDialogElement \| HTMLDivElement` | | The contentWrapperNode | |
|
|
25
|
+
| `contentNode` | public | `HTMLElement` | | The most important element: the overlay itself | |
|
|
26
|
+
| `contentWrapperNode` | public | `HTMLElement` | | The wrapper element of contentNode, used to supply inline positioning styles. When a Popper
arrow is needed, it acts as parent of the arrow node. Will be automatically created for global
and non projected contentNodes. Required when used in shadow dom mode or when Popper arrow is
supplied. Essential for allowing webcomponents to style their projected contentNodes | |
|
|
27
|
+
| `elementToFocusAfterHide` | public | `HTMLElement` | | The element that should be called \`.focus()\` on after dialog closes | |
|
|
28
|
+
| `elevation` | public | `number` | | | |
|
|
29
|
+
| `handlesAccessibility` | public | `boolean` | | For non \`isTooltip\`:
 \- sets aria-expanded="true/false" and aria-haspopup="true" on invokerNode
 \- sets aria-controls on invokerNode
 \- returns focus to invokerNode on hide
 \- sets focus to overlay content(?)

For \`isTooltip\`:
 \- sets role="tooltip" and aria-labelledby/aria-describedby on the content | |
|
|
30
|
+
| `hasActiveBackdrop` | public | | | | |
|
|
31
|
+
| `hasBackdrop` | public | `boolean` | | Whether it should have a backdrop (currently exclusive to globalOverlayController) | |
|
|
32
|
+
| `hidesOnEsc` | public | `boolean` | | Hides the overlay when pressing \[ esc ] | |
|
|
33
|
+
| `hidesOnOutsideClick` | public | `boolean` | | Hides the overlay when clicking next to it, exluding invoker | |
|
|
34
|
+
| `hidesOnOutsideEsc` | public | `boolean` | | Hides the overlay when pressing esc, even when contentNode has no focus | |
|
|
35
|
+
| `inheritsReferenceWidth` | public | `'max' \| 'full' \| 'min' \| 'none' \| undefined` | | Will align contentNode with referenceNode (invokerNode by default) for local overlays.
Usually needed for dropdowns. 'max' will prevent contentNode from exceeding width of
referenceNode, 'min' guarantees that contentNode will be at least as wide as referenceNode.
'full' will make sure that the invoker width always is the same. | |
|
|
36
|
+
| `invoker` | public | `HTMLElement \| undefined` | | The invokerNode | |
|
|
37
|
+
| `invokerNode` | public | `HTMLElement \| undefined` | | The interactive element (usually a button) invoking the dialog or tooltip | |
|
|
38
|
+
| `invokerRelation` | public | `'label' \| 'description'\| undefined` | | By default, the tooltip content is a 'description' for the invoker (uses aria-describedby).
Setting this property to 'label' makes the content function as a label (via aria-labelledby) | |
|
|
39
|
+
| `isAlertDialog` | public | | | The alertdialog role is to be used on modal alert dialogs that interrupt a user's workflow
to communicate an important message and require a response. | |
|
|
40
|
+
| `isBlocking` | public | `boolean` | | Hides other overlays when mutiple are opened (currently exclusive to globalOverlayController) | |
|
|
41
|
+
| `isShown` | public | | | | |
|
|
42
|
+
| `isTooltip` | public | `boolean` | | Has a totally different interaction- and accessibility pattern from all other overlays.
Will behave as role="tooltip" element instead of a role="dialog" element | |
|
|
43
|
+
| `manager` | public | | `manager` | | |
|
|
44
|
+
| `placementMode` | public | `'global' \| 'local' \| 'custom' \| undefined` | | Determines the connection point in DOM (body vs next to invoker). | |
|
|
45
|
+
| `popperConfig` | public | `PopperOptions` | | Popper configuration. Will be used when placementMode is 'local' | |
|
|
46
|
+
| `preventsScroll` | public | `boolean` | | Hides other overlays when mutiple are opened (currently exclusive to globalOverlayController) | |
|
|
47
|
+
| `referenceNode` | public | `HTMLElement` | | The element that is used to position the overlay content relative to. Usually,
this is the same element as invokerNode. Should only be provided when invokerNode should not
be positioned against. | |
|
|
48
|
+
| `trapsKeyboardFocus` | public | `boolean` | | Rotates tab, implicitly set when 'isModal' | |
|
|
49
|
+
| `viewportConfig` | public | `ViewportConfig` | | Viewport configuration. Will be used when placementMode is 'global' | |
|
|
50
|
+
| `visibilityTriggerFunction` | public | | | | |
|
|
51
|
+
| `_contentId` | protected | | `` `overlay-content--${Math.random().toString(36).slice(2, 10)}` `` | | |
|
|
52
|
+
| `_defaultConfig` | protected | `OverlayConfig` | `{ placementMode: undefined, contentNode: config.contentNode, contentWrapperNode: config.contentWrapperNode, invokerNode: config.invokerNode, backdropNode: config.backdropNode, referenceNode: undefined, elementToFocusAfterHide: config.invokerNode, inheritsReferenceWidth: 'none', hasBackdrop: false, isBlocking: false, preventsScroll: false, trapsKeyboardFocus: false, hidesOnEsc: false, hidesOnOutsideEsc: false, hidesOnOutsideClick: false, isTooltip: false, isAlertDialog: false, invokerRelation: 'description', visibilityTriggerFunction: undefined, handlesAccessibility: false, popperConfig: { placement: 'top', strategy: 'fixed', modifiers: [ { name: 'preventOverflow', enabled: true, options: { boundariesElement: 'viewport', padding: 8, // viewport-margin for shifting/sliding }, }, { name: 'flip', options: { boundariesElement: 'viewport', padding: 16, // viewport-margin for flipping }, }, { name: 'offset', enabled: true, options: { offset: [0, 8], // horizontal and vertical margin (distance between popper and referenceElement) }, }, { name: 'arrow', enabled: false, }, ], }, viewportConfig: { placement: 'center', }, zIndex: 9999, isOpenable: true, focusContentOnOpen: false, // This means that content will have visually-hidden / sr-only styles. This is handy for: // - hidden menus that should be "indexable" by screen readers (like the Links list in VO: https://support.apple.com/en-gb/guide/voiceover/mchlp2719/mac) // - "more" menus that put content in a dropdown that do not fit in the current row // - menus that should generally open on tab. // @ts-ignore - hideVisually is an extension property hideVisually: false, }` | | |
|
|
53
|
+
| `_referenceNode` | protected | `HTMLElement \| undefined` | | | |
|
|
54
54
|
|
|
55
55
|
### Methods
|
|
56
56
|
|
|
@@ -96,28 +96,76 @@ eleventyNavigation:
|
|
|
96
96
|
<hr/>
|
|
97
97
|
|
|
98
98
|
|
|
99
|
+
## class: `OverlayMixin`
|
|
100
|
+
|
|
101
|
+
### Fields
|
|
102
|
+
|
|
103
|
+
| Name | Privacy | Type | Default | Description | Inherited From |
|
|
104
|
+
| ---------------------------- | --------- | ------------------------ | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
|
|
105
|
+
| `config` | public | `Partial<OverlayConfig>` | `{}` | Configure the many options of the \`OverlayController\` | |
|
|
106
|
+
| `opened` | public | `boolean` | `false` | If you add the opened attribute a dialog will be opened on page load. The invoker can be left out
in case the user does not need to be able to reopen the dialog. | |
|
|
107
|
+
| `_overlayBackdropNode` | protected | | | | |
|
|
108
|
+
| `_overlayContentNode` | protected | | | | |
|
|
109
|
+
| `_overlayContentWrapperNode` | protected | | | | |
|
|
110
|
+
| `_overlayInvokerNode` | protected | | | | |
|
|
111
|
+
| `_overlayReferenceNode` | protected | | | | |
|
|
112
|
+
|
|
113
|
+
### Methods
|
|
114
|
+
|
|
115
|
+
| Name | Privacy | Description | Parameters | Return | Inherited From |
|
|
116
|
+
| ---------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------- | -------------- |
|
|
117
|
+
| `close` | public | Hides the overlay | | | |
|
|
118
|
+
| `open` | public | Shows the overlay | | | |
|
|
119
|
+
| `repositionOverlay` | public | Sometimes it's needed to recompute Popper position of an overlay, for instance when we have
an opened combobox and the surrounding context changes (the space consumed by the textbox
increases vertically) | | | |
|
|
120
|
+
| `toggle` | public | Toggles the overlay | | | |
|
|
121
|
+
| `_defineOverlay` | protected | | `{ contentNode, invokerNode, referenceNode, backdropNode, contentWrapperNode }, config: DefineOverlayConfig` | `OverlayController` | |
|
|
122
|
+
| `_defineOverlayConfig` | protected | | | `OverlayConfig` | |
|
|
123
|
+
| `_isPermanentlyDisconnected` | protected | When we're moving around in dom, disconnectedCallback gets called.
Before we decide to teardown, let's wait to see if we were not just moving nodes around. | | `Promise<boolean>` | |
|
|
124
|
+
| `_setOpenedWithoutPropertyEffects` | protected | When the opened state is changed by an Application Developer,cthe OverlayController is
requested to show/hide. It might happen that this request is not honoured
(intercepted in before-hide for instance), so that we need to sync the controller state
to this webcomponent again, preventing eternal loops. | `newOpened: boolean` | | |
|
|
125
|
+
| `_setupOpenCloseListeners` | protected | | | | |
|
|
126
|
+
| `_setupOverlayCtrl` | protected | | | | |
|
|
127
|
+
| `_teardownOpenCloseListeners` | protected | | | | |
|
|
128
|
+
| `_teardownOverlayCtrl` | protected | | | | |
|
|
129
|
+
|
|
130
|
+
### Events
|
|
131
|
+
|
|
132
|
+
| Name | Type | Description | Inherited From |
|
|
133
|
+
| ---------------- | ------------- | ----------- | -------------- |
|
|
134
|
+
| `opened-changed` | `CustomEvent` | | |
|
|
135
|
+
|
|
136
|
+
### Attributes
|
|
137
|
+
|
|
138
|
+
| Name | Field | Inherited From |
|
|
139
|
+
| -------- | ------ | -------------- |
|
|
140
|
+
| `opened` | opened | |
|
|
141
|
+
|
|
142
|
+
<hr/>
|
|
143
|
+
|
|
144
|
+
|
|
99
145
|
## class: `OverlaysManager`
|
|
100
146
|
|
|
101
147
|
### Fields
|
|
102
148
|
|
|
103
|
-
| Name
|
|
104
|
-
|
|
|
105
|
-
| `list`
|
|
106
|
-
| `shownList`
|
|
107
|
-
| `siblingsInert`
|
|
149
|
+
| Name | Privacy | Type | Default | Description | Inherited From |
|
|
150
|
+
| ---------------- | --------- | --------- | ------- | ---------------------------------------------------------------------------------------------------------------------- | -------------- |
|
|
151
|
+
| `list` | public | | | no setter as .list is intended to be read-only
You can use .add or .remove to modify it | |
|
|
152
|
+
| `shownList` | public | | | no setter as .shownList is intended to be read-only
You can use .show or .hide on individual controllers to modify | |
|
|
153
|
+
| `siblingsInert` | public | | | Features right now only for Global Overlay Manager | |
|
|
154
|
+
| `_siblingsInert` | protected | `boolean` | `false` | | |
|
|
108
155
|
|
|
109
156
|
### Methods
|
|
110
157
|
|
|
111
|
-
| Name | Privacy | Description | Parameters
|
|
112
|
-
| -------------------------- | ------- | -------------------------------- |
|
|
113
|
-
| `add` | public | Registers an overlay controller. | `ctrlToAdd: OverlayController`
|
|
114
|
-
| `hide` | public | | `ctrlToHide: any`
|
|
115
|
-
| `remove` | public | | `ctrlToRemove: OverlayController`
|
|
116
|
-
| `requestToEnableScroll` | public | | `currentController: OverlayController`
|
|
117
|
-
| `
|
|
118
|
-
| `
|
|
119
|
-
| `
|
|
120
|
-
| `
|
|
121
|
-
| `
|
|
158
|
+
| Name | Privacy | Description | Parameters | Return | Inherited From |
|
|
159
|
+
| -------------------------- | ------- | -------------------------------- | -------------------------------------------- | ------------------- | -------------- |
|
|
160
|
+
| `add` | public | Registers an overlay controller. | `ctrlToAdd: OverlayController` | `OverlayController` | |
|
|
161
|
+
| `hide` | public | | `ctrlToHide: any` | | |
|
|
162
|
+
| `remove` | public | | `ctrlToRemove: OverlayController` | | |
|
|
163
|
+
| `requestToEnableScroll` | public | | `currentController: OverlayController` | | |
|
|
164
|
+
| `requestToKeepBodySize` | public | PreventsScroll | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
165
|
+
| `requestToPreventScroll` | public | | | | |
|
|
166
|
+
| `requestToShowOnly` | public | Blocking | `blockingCtrl: OverlayController` | | |
|
|
167
|
+
| `retractRequestToShowOnly` | public | | `blockingCtrl: OverlayController` | | |
|
|
168
|
+
| `show` | public | | `ctrlToShow: OverlayController` | | |
|
|
169
|
+
| `teardown` | public | | | | |
|
|
122
170
|
|
|
123
171
|
<hr/>
|
|
@@ -112,7 +112,7 @@ export const alertDialog = () => {
|
|
|
112
112
|
|
|
113
113
|
## isTooltip (placementMode: 'local')
|
|
114
114
|
|
|
115
|
-
As specified in the [overlay rationale](https://github.com/ing-bank/lion/blob/
|
|
115
|
+
As specified in the [overlay rationale](https://github.com/ing-bank/lion/blob/0b7e90a96113c0d006ea2c744446a64a29c31306/docs/fundamentals/systems/overlays/rationale.md) there are only two official types of overlays: dialogs and tooltips. And their main differences are:
|
|
116
116
|
|
|
117
117
|
- Dialogs have a modal option, tooltips don’t
|
|
118
118
|
- Dialogs have interactive content, tooltips don’t
|
|
@@ -446,7 +446,7 @@ Features:
|
|
|
446
446
|
|
|
447
447
|
> Popper strictly is scoped on positioning. **It does not change the dimensions of the content node nor the invoker node**.
|
|
448
448
|
> This also means that if you use the arrow feature, you are in charge of styling it properly, use the data-popper-placement attribute for this.
|
|
449
|
-
> An example implementation can be found in [lion-tooltip](https://github.com/ing-bank/lion/blob/
|
|
449
|
+
> An example implementation can be found in [lion-tooltip](https://github.com/ing-bank/lion/blob/0b7e90a96113c0d006ea2c744446a64a29c31306/docs/components/tooltip/overview.md), where an arrow is set by default.
|
|
450
450
|
|
|
451
451
|
To override the default options we set for local mode, you add a `popperConfig` object to the config passed to the OverlayController.
|
|
452
452
|
Here's a succinct overview of some often used popper properties:
|
|
@@ -19,7 +19,7 @@ Manages their position on the screen relative to other elements, including other
|
|
|
19
19
|
|
|
20
20
|
Its purpose is to make it easy to use our Overlay System declaratively. It can be easily extended where needed, to override event listeners and more.
|
|
21
21
|
|
|
22
|
-
See [lion-dialog](../../../components/dialog/overview.md) and [lion-tooltip](https://github.com/ing-bank/lion/blob/
|
|
22
|
+
See [lion-dialog](../../../components/dialog/overview.md) and [lion-tooltip](https://github.com/ing-bank/lion/blob/0b7e90a96113c0d006ea2c744446a64a29c31306/docs/components/tooltip/overview.md) for example Web Component implementations using the Overlay System.
|
|
23
23
|
|
|
24
24
|
## Features
|
|
25
25
|
|
|
@@ -31,9 +31,9 @@ See [lion-dialog](../../../components/dialog/overview.md) and [lion-tooltip](htt
|
|
|
31
31
|
- lion-overlay web component:
|
|
32
32
|
- Show content when clicking the invoker
|
|
33
33
|
- Have a `.config` object to set or update the OverlayController's configuration
|
|
34
|
-
- [**OverlaysManager**](https://github.com/ing-bank/lion/blob/
|
|
35
|
-
- [**OverlayController**](https://github.com/ing-bank/lion/blob/
|
|
36
|
-
- [**OverlayMixin**](https://github.com/ing-bank/lion/blob/
|
|
34
|
+
- [**OverlaysManager**](https://github.com/ing-bank/lion/blob/0b7e90a96113c0d006ea2c744446a64a29c31306/docs/fundamentals/systems/overlays/use-cases.md#overlaysmanager), a global repository keeping track of all different types of overlays
|
|
35
|
+
- [**OverlayController**](https://github.com/ing-bank/lion/blob/0b7e90a96113c0d006ea2c744446a64a29c31306/docs/fundamentals/systems/overlays/use-cases.md#overlaycontroller), a single controller class for handling overlays
|
|
36
|
+
- [**OverlayMixin**](https://github.com/ing-bank/lion/blob/0b7e90a96113c0d006ea2c744446a64a29c31306/docs/fundamentals/systems/overlays/use-cases.md#overlaymixin), a mixin that can be used to create webcomponents that use the OverlayController under the hood
|
|
37
37
|
|
|
38
38
|
Usually you will use `lion-dialog` (or `lion-tooltip` if this makes more sense).
|
|
39
39
|
|
|
@@ -123,4 +123,4 @@ class MyOverlayComponent extends OverlayMixin(LitElement) {
|
|
|
123
123
|
|
|
124
124
|
## Rationales
|
|
125
125
|
|
|
126
|
-
Please check the [system rationals](https://github.com/ing-bank/lion/blob/
|
|
126
|
+
Please check the [system rationals](https://github.com/ing-bank/lion/blob/0b7e90a96113c0d006ea2c744446a64a29c31306/docs/fundamentals/systems/overlays/rationale.md) folder, where we go more in-depth.
|
|
@@ -34,7 +34,7 @@ The overlay system allows to create different types of overlays like dialogs, to
|
|
|
34
34
|
It's designed to be highly flexible, while still delivering sensible defaults.
|
|
35
35
|
On top of this, the system was built having accessibility in mind.
|
|
36
36
|
|
|
37
|
-
For a detailed rationale, please consult [Rationale](https://github.com/ing-bank/lion/blob/
|
|
37
|
+
For a detailed rationale, please consult [Rationale](https://github.com/ing-bank/lion/blob/0b7e90a96113c0d006ea2c744446a64a29c31306/docs/fundamentals/systems/overlays/rationale.md).
|
|
38
38
|
|
|
39
39
|
```js preview-story
|
|
40
40
|
export const main = () => html`
|
|
@@ -82,7 +82,7 @@ Global refers to overlays where the content is positioned in a global root node
|
|
|
82
82
|
|
|
83
83
|
Overlays can be configured in many ways to suit your needs. We go in-depth into each option in the Overlay System - Configuration chapter.
|
|
84
84
|
|
|
85
|
-
We also export a few [preset configuration objects](https://github.com/ing-bank/lion/blob/
|
|
85
|
+
We also export a few [preset configuration objects](https://github.com/ing-bank/lion/blob/0b7e90a96113c0d006ea2c744446a64a29c31306/docs/fundamentals/systems/overlays/configuration.md).
|
|
86
86
|
|
|
87
87
|
- withModalDialogConfig
|
|
88
88
|
- withDropdownConfig
|
|
@@ -22,7 +22,7 @@ Therefore, they may not have the same quality standards as our other packages.
|
|
|
22
22
|
|
|
23
23
|
| Package | Description |
|
|
24
24
|
| -------------------------------------- | ----------------------- |
|
|
25
|
-
| [sb-action-logger](https://github.com/ing-bank/lion/blob/
|
|
25
|
+
| [sb-action-logger](https://github.com/ing-bank/lion/blob/0b7e90a96113c0d006ea2c744446a64a29c31306/docs/fundamentals/tools/helpers/action-logger.md) | Storybook action logger |
|
|
26
26
|
|
|
27
27
|
## Installation
|
|
28
28
|
|
|
@@ -22,7 +22,7 @@ Primarily useful if two major version of a package with a singleton is used.
|
|
|
22
22
|
npm i --save singleton-manager
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
⚠️ You need to make SURE that only ONE version of `singleton-manager` is installed. For how see [Non Goals](https://github.com/ing-bank/lion/blob/
|
|
25
|
+
⚠️ You need to make SURE that only ONE version of `singleton-manager` is installed. For how see [Non Goals](https://github.com/ing-bank/lion/blob/0b7e90a96113c0d006ea2c744446a64a29c31306/docs/fundamentals/tools/singleton-manager/#non-goals).
|
|
26
26
|
|
|
27
27
|
### Example Singleton Users
|
|
28
28
|
|
|
@@ -172,7 +172,7 @@ Steps to reproduce:
|
|
|
172
172
|
1. Page A click on block
|
|
173
173
|
2. Page B => "Blocked: false" (even when hitting the refresh button)
|
|
174
174
|
|
|
175
|
-
➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/
|
|
175
|
+
➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/0b7e90a96113c0d006ea2c744446a64a29c31306/docs/fundamentals/tools/singleton-manager/example-fail/index.md). <br>
|
|
176
176
|
➡️ See [the code](https://github.com/ing-bank/lion/tree/master/docs/fundamentals/tools/singleton-manager/example-fail/demo-app.js).
|
|
177
177
|
|
|
178
178
|
---
|
|
@@ -215,7 +215,7 @@ See it in action
|
|
|
215
215
|
npm run start:singleton
|
|
216
216
|
```
|
|
217
217
|
|
|
218
|
-
➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/
|
|
218
|
+
➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/0b7e90a96113c0d006ea2c744446a64a29c31306/docs/fundamentals/tools/singleton-manager/example-success/index.md). <br>
|
|
219
219
|
➡️ See [the code](https://github.com/ing-bank/lion/tree/master/docs/fundamentals/tools/singleton-manager/example-success/demo-app.js).
|
|
220
220
|
|
|
221
221
|
---
|
|
@@ -256,7 +256,7 @@ See it in action
|
|
|
256
256
|
npm run start:singleton-complex
|
|
257
257
|
```
|
|
258
258
|
|
|
259
|
-
➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/
|
|
259
|
+
➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/0b7e90a96113c0d006ea2c744446a64a29c31306/docs/fundamentals/tools/singleton-manager/example-complex/index.md). <br>
|
|
260
260
|
➡️ See [the code](https://github.com/ing-bank/lion/tree/master/docs/fundamentals/tools/singleton-manager/example-complex/demo-app.js).
|
|
261
261
|
|
|
262
262
|
---
|