@lion/ui 0.10.1 → 0.11.1
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/README.md +2 -2
- package/components/checkbox-group/src/LionCheckboxIndeterminate.js +39 -16
- package/components/checkbox-group/test-suites/CheckboxIndeterminate.suite.js +189 -1
- package/components/form-core/src/FocusMixin.js +4 -4
- package/components/form-core/src/LionField.js +1 -1
- package/components/input-amount/test/lion-input-amount.test.js +48 -1
- package/components/input-amount/test/parsers.test.js +1 -1
- package/components/localize/src/number/parseNumber.js +21 -12
- package/components/localize/test/number/parseNumber.test.js +1 -1
- package/components/localize/types/LocalizeMixinTypes.ts +0 -5
- package/components/select-rich/src/LionSelectRich.js +18 -2
- package/components/select-rich/test/lion-select-rich-interaction.test.js +139 -20
- package/components/select-rich/test/lion-select-rich.test.js +13 -1
- package/components/validate-messages/translations/pl.js +4 -4
- package/custom-elements.json +47661 -47626
- package/dist-types/components/checkbox-group/src/LionCheckboxIndeterminate.d.ts +10 -0
- package/dist-types/components/checkbox-group/src/LionCheckboxIndeterminate.d.ts.map +1 -1
- package/dist-types/components/checkbox-group/test-suites/CheckboxIndeterminate.suite.d.ts.map +1 -1
- package/dist-types/components/localize/src/number/parseNumber.d.ts.map +1 -1
- package/dist-types/components/localize/types/LocalizeMixinTypes.d.ts +0 -4
- package/dist-types/components/localize/types/LocalizeMixinTypes.d.ts.map +1 -1
- package/dist-types/components/select-rich/src/LionSelectRich.d.ts.map +1 -1
- package/dist-types/tsconfig.tsbuildinfo +1 -1
- package/docs/components/accordion/api-table.md +6 -6
- package/docs/components/button/api-table.md +27 -30
- package/docs/components/calendar/api-table.md +13 -13
- package/docs/components/checkbox-group/api-table.md +305 -329
- package/docs/components/checkbox-group/overview.md +2 -2
- package/docs/components/collapsible/api-table.md +5 -5
- package/docs/components/collapsible/overview.md +1 -1
- package/docs/components/combobox/api-table.md +150 -154
- package/docs/components/combobox/overview.md +1 -1
- package/docs/components/combobox/use-cases.md +1 -1
- package/docs/components/dialog/api-table.md +12 -12
- package/docs/components/dialog/overview.md +1 -1
- package/docs/components/drawer/api-table.md +9 -10
- package/docs/components/fieldset/api-table.md +104 -118
- 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/api-table.md +3 -3
- package/docs/components/icon/use-cases.md +1 -1
- package/docs/components/input/api-table.md +110 -120
- package/docs/components/input/overview.md +1 -1
- package/docs/components/input-amount/api-table.md +129 -142
- package/docs/components/input-amount/overview.md +3 -3
- package/docs/components/input-date/api-table.md +110 -120
- package/docs/components/input-date/overview.md +3 -3
- package/docs/components/input-datepicker/api-table.md +148 -160
- package/docs/components/input-datepicker/overview.md +5 -5
- package/docs/components/input-email/api-table.md +110 -120
- package/docs/components/input-email/overview.md +2 -2
- package/docs/components/input-file/api-table.md +132 -143
- package/docs/components/input-file/overview.md +1 -1
- package/docs/components/input-iban/api-table.md +110 -120
- package/docs/components/input-iban/overview.md +2 -2
- package/docs/components/input-range/api-table.md +116 -126
- package/docs/components/input-range/overview.md +2 -2
- package/docs/components/input-stepper/api-table.md +123 -133
- package/docs/components/input-stepper/overview.md +1 -1
- package/docs/components/input-tel/api-table.md +118 -128
- 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/api-table.md +125 -135
- package/docs/components/input-tel-dropdown/overview.md +1 -1
- package/docs/components/listbox/api-table.md +126 -131
- package/docs/components/listbox/use-cases.md +1 -1
- package/docs/components/pagination/api-table.md +5 -5
- package/docs/components/progress-indicator/api-table.md +9 -10
- package/docs/components/radio-group/api-table.md +234 -258
- package/docs/components/radio-group/overview.md +3 -3
- package/docs/components/select/api-table.md +106 -116
- package/docs/components/select/use-cases.md +1 -1
- package/docs/components/select-rich/api-table.md +169 -178
- package/docs/components/select-rich/use-cases.md +1 -1
- package/docs/components/steps/api-table.md +6 -6
- package/docs/components/switch/api-table.md +117 -128
- package/docs/components/tabs/api-table.md +1 -1
- package/docs/components/tabs/examples.md +1 -1
- package/docs/components/textarea/api-table.md +114 -124
- package/docs/components/tooltip/api-table.md +13 -13
- 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 +1 -1
- package/docs/fundamentals/systems/core/api-table.md +8 -11
- package/docs/fundamentals/systems/core/overview.md +1 -1
- package/docs/fundamentals/systems/form/api-table.md +77 -82
- package/docs/fundamentals/systems/form/formatting-and-parsing.md +4 -4
- 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/api-table.md +19 -19
- package/docs/fundamentals/systems/localize/overview.md +4 -4
- package/docs/fundamentals/systems/overlays/api-table.md +45 -46
- 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/index.md +8 -8
- package/docs/guides/principles/index.md +5 -5
- package/docs/guides/principles/styling.md +1 -1
- package/package.json +1 -1
|
@@ -6,73 +6,72 @@
|
|
|
6
6
|
|
|
7
7
|
| Name | Privacy | Type | Default | Description | Inherited From |
|
|
8
8
|
| ----------------------------- | --------- | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
|
|
9
|
-
| `
|
|
9
|
+
| `backdropNode` | public | `HTMLElement` | | The element that is placed behind the contentNode. When not provided and \`hasBackdrop\` is true,
a backdropNode will be automatically created | |
|
|
10
|
+
| `config` | public | `OverlayConfig` | `{}` | | |
|
|
10
11
|
| `content` | public | `HTMLDialogElement \| HTMLDivElement` | | The contentWrapperNode | |
|
|
11
|
-
| `placementMode` | public | `'global' \| 'local' \| undefined` | | Determines the connection point in DOM (body vs next to invoker). | |
|
|
12
|
-
| `invokerNode` | public | `HTMLElement \| undefined` | | The interactive element (usually a button) invoking the dialog or tooltip | |
|
|
13
|
-
| `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. | |
|
|
14
12
|
| `contentNode` | public | `HTMLElement` | | The most important element: the overlay itself | |
|
|
15
13
|
| `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 | |
|
|
16
|
-
| `backdropNode` | public | `HTMLElement` | | The element that is placed behind the contentNode. When not provided and \`hasBackdrop\` is true,
a backdropNode will be automatically created | |
|
|
17
14
|
| `elementToFocusAfterHide` | public | `HTMLElement` | | The element that should be called \`.focus()\` on after dialog closes | |
|
|
15
|
+
| `elevation` | public | `number` | | | |
|
|
16
|
+
| `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 | |
|
|
17
|
+
| `hasActiveBackdrop` | public | | | | |
|
|
18
|
+
| `hasActiveTrapsKeyboardFocus` | public | | | | |
|
|
18
19
|
| `hasBackdrop` | public | `boolean` | | Whether it should have a backdrop (currently exclusive to globalOverlayController) | |
|
|
19
|
-
| `isBlocking` | public | `boolean` | | Hides other overlays when mutiple are opened (currently exclusive to globalOverlayController) | |
|
|
20
|
-
| `preventsScroll` | public | `boolean` | | Hides other overlays when mutiple are opened (currently exclusive to globalOverlayController) | |
|
|
21
|
-
| `trapsKeyboardFocus` | public | `boolean` | | Rotates tab, implicitly set when 'isModal' | |
|
|
22
20
|
| `hidesOnEsc` | public | `boolean` | | Hides the overlay when pressing \[ esc ] | |
|
|
23
21
|
| `hidesOnOutsideClick` | public | `boolean` | | Hides the overlay when clicking next to it, exluding invoker | |
|
|
24
22
|
| `hidesOnOutsideEsc` | public | `boolean` | | Hides the overlay when pressing esc, even when contentNode has no focus | |
|
|
25
23
|
| `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. | |
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `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. | |
|
|
24
|
+
| `invoker` | public | `HTMLElement \| undefined` | | The invokerNode | |
|
|
25
|
+
| `invokerNode` | public | `HTMLElement \| undefined` | | The interactive element (usually a button) invoking the dialog or tooltip | |
|
|
29
26
|
| `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) | |
|
|
27
|
+
| `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. | |
|
|
28
|
+
| `isBlocking` | public | `boolean` | | Hides other overlays when mutiple are opened (currently exclusive to globalOverlayController) | |
|
|
29
|
+
| `isShown` | public | | | | |
|
|
30
|
+
| `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 | |
|
|
31
|
+
| `manager` | public | | `manager` | | |
|
|
32
|
+
| `placementMode` | public | `'global' \| 'local' \| undefined` | | Determines the connection point in DOM (body vs next to invoker). | |
|
|
30
33
|
| `popperConfig` | public | `PopperOptions` | | Popper configuration. Will be used when placementMode is 'local' | |
|
|
34
|
+
| `preventsScroll` | public | `boolean` | | Hides other overlays when mutiple are opened (currently exclusive to globalOverlayController) | |
|
|
35
|
+
| `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. | |
|
|
36
|
+
| `trapsKeyboardFocus` | public | `boolean` | | Rotates tab, implicitly set when 'isModal' | |
|
|
31
37
|
| `viewportConfig` | public | `ViewportConfig` | | Viewport configuration. Will be used when placementMode is 'global' | |
|
|
32
38
|
| `visibilityTriggerFunction` | public | | | | |
|
|
33
|
-
| `_referenceNode` | protected | `HTMLElement \| undefined` | | | |
|
|
34
|
-
| `elevation` | public | `number` | | | |
|
|
35
|
-
| `isShown` | public | | | | |
|
|
36
|
-
| `hasActiveBackdrop` | public | | | | |
|
|
37
|
-
| `hasActiveTrapsKeyboardFocus` | public | | | | |
|
|
38
|
-
| `manager` | public | | `manager` | | |
|
|
39
|
-
| `config` | public | `OverlayConfig` | `{}` | | |
|
|
40
|
-
| `_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, }` | | |
|
|
41
39
|
| `_contentId` | protected | | `` `overlay-content--${Math.random().toString(36).slice(2, 10)}` `` | | |
|
|
40
|
+
| `_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, }` | | |
|
|
41
|
+
| `_referenceNode` | protected | `HTMLElement \| undefined` | | | |
|
|
42
42
|
|
|
43
43
|
### Methods
|
|
44
44
|
|
|
45
45
|
| Name | Privacy | Description | Parameters | Return | Inherited From |
|
|
46
46
|
| ------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------ | -------------- |
|
|
47
|
-
| `
|
|
48
|
-
| `
|
|
49
|
-
| `_handleZIndex` | protected | Display local overlays on top of elements with no z-index that appear later in the DOM | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
50
|
-
| `show` | public | | `elementToFocusAfterHide: HTMLElement` | | |
|
|
51
|
-
| `_handlePosition` | protected | | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
52
|
-
| `_keepBodySize` | protected | | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
47
|
+
| `disableTrapsKeyboardFocus` | public | | `{ findNewTrap = true }` | | |
|
|
48
|
+
| `enableTrapsKeyboardFocus` | public | | | | |
|
|
53
49
|
| `hide` | public | | | | |
|
|
50
|
+
| `show` | public | | `elementToFocusAfterHide: HTMLElement` | | |
|
|
51
|
+
| `teardown` | public | | | | |
|
|
52
|
+
| `toggle` | public | | | | |
|
|
54
53
|
| `transitionHide` | public | Method to be overriden by subclassers | `hideConfig: {backdropNode:HTMLElement, contentNode:HTMLElement}` | | |
|
|
55
|
-
| `_transitionHide` | protected | | `{ backdropNode, contentNode }, hideConfig: {backdropNode:HTMLElement, contentNode:HTMLElement}` | | |
|
|
56
54
|
| `transitionShow` | public | To be overridden by subclassers | `showConfig: {backdropNode:HTMLElement; contentNode:HTMLElement}` | | |
|
|
57
|
-
| `
|
|
58
|
-
| `
|
|
59
|
-
| `toggle` | public | | | | |
|
|
60
|
-
| `_handleFeatures` | protected | All features are handled here. | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
61
|
-
| `_handleVisibilityTriggers` | protected | | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
62
|
-
| `_handlePreventsScroll` | protected | | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
63
|
-
| `_handleBlocking` | protected | | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
55
|
+
| `updateConfig` | public | Allows to dynamically change the overlay configuration. Needed in case the
presentation of the overlay changes depending on screen size.
Note that this method is the only allowed way to update a configuration of an
OverlayController instance. | `cfgToAdd: OverlayConfig` | | |
|
|
56
|
+
| `_handleAccessibility` | protected | | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
64
57
|
| `_handleBackdrop` | protected | Sets up backdrop on the given overlay. If there was a backdrop on another element
it is removed. Otherwise this is the first time displaying a backdrop, so a animation-in
animation is played. | `{ phase }, config: { animation?: boolean, phase: OverlayPhase }` | | |
|
|
65
|
-
| `
|
|
66
|
-
| `
|
|
67
|
-
| `disableTrapsKeyboardFocus` | public | | `{ findNewTrap = true }` | | |
|
|
68
|
-
| `__escKeyHandler` | protected | | `event: KeyboardEvent` | `void` | |
|
|
58
|
+
| `_handleBlocking` | protected | | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
59
|
+
| `_handleFeatures` | protected | All features are handled here. | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
69
60
|
| `_handleHidesOnEsc` | protected | | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
61
|
+
| `_handleHidesOnOutsideClick` | protected | | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
70
62
|
| `_handleHidesOnOutsideEsc` | protected | | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
71
63
|
| `_handleInheritsReferenceWidth` | protected | | | | |
|
|
72
|
-
| `
|
|
73
|
-
| `
|
|
74
|
-
| `
|
|
64
|
+
| `_handlePosition` | protected | | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
65
|
+
| `_handlePreventsScroll` | protected | | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
66
|
+
| `_handleTrapsKeyboardFocus` | protected | | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
67
|
+
| `_handleVisibilityTriggers` | protected | | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
68
|
+
| `_handleZIndex` | protected | Display local overlays on top of elements with no z-index that appear later in the DOM | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
75
69
|
| `_hasDisabledInvoker` | protected | | | | |
|
|
70
|
+
| `_init` | protected | | | | |
|
|
71
|
+
| `_keepBodySize` | protected | | `{ phase }, config: { phase: OverlayPhase }` | | |
|
|
72
|
+
| `_restoreFocus` | protected | | | | |
|
|
73
|
+
| `_transitionHide` | protected | | `{ backdropNode, contentNode }, hideConfig: {backdropNode:HTMLElement, contentNode:HTMLElement}` | | |
|
|
74
|
+
| `_transitionShow` | protected | | `showConfig: {backdropNode:HTMLElement; contentNode:HTMLElement}` | | |
|
|
76
75
|
|
|
77
76
|
### Events
|
|
78
77
|
|
|
@@ -99,16 +98,16 @@
|
|
|
99
98
|
| Name | Privacy | Description | Parameters | Return | Inherited From |
|
|
100
99
|
| ------------------------------------- | ------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------- | -------------- |
|
|
101
100
|
| `add` | public | Registers an overlay controller. | `ctrlToAdd: OverlayController` | `OverlayController` | |
|
|
102
|
-
| `remove` | public | | `ctrlToRemove: OverlayController` | | |
|
|
103
|
-
| `show` | public | | `ctrlToShow: OverlayController` | | |
|
|
104
|
-
| `hide` | public | | `ctrlToHide: any` | | |
|
|
105
|
-
| `teardown` | public | | | | |
|
|
106
101
|
| `disableTrapsKeyboardFocusForAll` | public | | | | |
|
|
107
|
-
| `
|
|
102
|
+
| `hide` | public | | `ctrlToHide: any` | | |
|
|
108
103
|
| `informTrapsKeyboardFocusGotDisabled` | public | | `{ disabledCtrl, findNewTrap = true }, options: { disabledCtrl?:OverlayController, findNewTrap?:boolean }` | | |
|
|
109
|
-
| `
|
|
104
|
+
| `informTrapsKeyboardFocusGotEnabled` | public | | `placementMode: 'local' \| 'global' \| undefined` | | |
|
|
105
|
+
| `remove` | public | | `ctrlToRemove: OverlayController` | | |
|
|
110
106
|
| `requestToEnableScroll` | public | | | | |
|
|
107
|
+
| `requestToPreventScroll` | public | PreventsScroll | | | |
|
|
111
108
|
| `requestToShowOnly` | public | Blocking | `blockingCtrl: OverlayController` | | |
|
|
112
109
|
| `retractRequestToShowOnly` | public | | `blockingCtrl: OverlayController` | | |
|
|
110
|
+
| `show` | public | | `ctrlToShow: OverlayController` | | |
|
|
111
|
+
| `teardown` | public | | | | |
|
|
113
112
|
|
|
114
113
|
<hr/>
|
|
@@ -99,7 +99,7 @@ export const alertDialog = () => {
|
|
|
99
99
|
|
|
100
100
|
## isTooltip (placementMode: 'local')
|
|
101
101
|
|
|
102
|
-
As specified in the [overlay rationale](https://github.com/ing-bank/lion/blob/
|
|
102
|
+
As specified in the [overlay rationale](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/fundamentals/systems/overlays/rationale.md) there are only two official types of overlays: dialogs and tooltips. And their main differences are:
|
|
103
103
|
|
|
104
104
|
- Dialogs have a modal option, tooltips don’t
|
|
105
105
|
- Dialogs have interactive content, tooltips don’t
|
|
@@ -430,7 +430,7 @@ Features:
|
|
|
430
430
|
|
|
431
431
|
> Popper strictly is scoped on positioning. **It does not change the dimensions of the content node nor the invoker node**.
|
|
432
432
|
> 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.
|
|
433
|
-
> An example implementation can be found in [lion-tooltip](https://github.com/ing-bank/lion/blob/
|
|
433
|
+
> An example implementation can be found in [lion-tooltip](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/components/tooltip/overview.md), where an arrow is set by default.
|
|
434
434
|
|
|
435
435
|
To override the default options we set for local mode, you add a `popperConfig` object to the config passed to the OverlayController.
|
|
436
436
|
Here's a succinct overview of some often used popper properties:
|
|
@@ -6,7 +6,7 @@ Manages their position on the screen relative to other elements, including other
|
|
|
6
6
|
|
|
7
7
|
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.
|
|
8
8
|
|
|
9
|
-
See [lion-dialog](../../../components/dialog/overview.md) and [lion-tooltip](https://github.com/ing-bank/lion/blob/
|
|
9
|
+
See [lion-dialog](../../../components/dialog/overview.md) and [lion-tooltip](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/components/tooltip/overview.md) for example Web Component implementations using the Overlay System.
|
|
10
10
|
|
|
11
11
|
## Features
|
|
12
12
|
|
|
@@ -18,9 +18,9 @@ See [lion-dialog](../../../components/dialog/overview.md) and [lion-tooltip](htt
|
|
|
18
18
|
- lion-overlay web component:
|
|
19
19
|
- Show content when clicking the invoker
|
|
20
20
|
- Have a `.config` object to set or update the OverlayController's configuration
|
|
21
|
-
- [**OverlaysManager**](https://github.com/ing-bank/lion/blob/
|
|
22
|
-
- [**OverlayController**](https://github.com/ing-bank/lion/blob/
|
|
23
|
-
- [**OverlayMixin**](https://github.com/ing-bank/lion/blob/
|
|
21
|
+
- [**OverlaysManager**](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/fundamentals/systems/overlays/use-cases.md#overlaysmanager), a global repository keeping track of all different types of overlays
|
|
22
|
+
- [**OverlayController**](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/fundamentals/systems/overlays/use-cases.md#overlaycontroller), a single controller class for handling overlays
|
|
23
|
+
- [**OverlayMixin**](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/fundamentals/systems/overlays/use-cases.md#overlaymixin), a mixin that can be used to create webcomponents that use the OverlayController under the hood
|
|
24
24
|
|
|
25
25
|
Usually you will use `lion-dialog` (or `lion-tooltip` if this makes more sense).
|
|
26
26
|
|
|
@@ -110,4 +110,4 @@ class MyOverlayComponent extends OverlayMixin(LitElement) {
|
|
|
110
110
|
|
|
111
111
|
## Rationales
|
|
112
112
|
|
|
113
|
-
Please check the [system rationals](https://github.com/ing-bank/lion/blob/
|
|
113
|
+
Please check the [system rationals](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/fundamentals/systems/overlays/rationale.md) folder, where we go more in-depth.
|
|
@@ -21,7 +21,7 @@ The overlay system allows to create different types of overlays like dialogs, to
|
|
|
21
21
|
It's designed to be highly flexible, while still delivering sensible defaults.
|
|
22
22
|
On top of this, the system was built having accessibility in mind.
|
|
23
23
|
|
|
24
|
-
For a detailed rationale, please consult [Rationale](https://github.com/ing-bank/lion/blob/
|
|
24
|
+
For a detailed rationale, please consult [Rationale](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/fundamentals/systems/overlays/rationale.md).
|
|
25
25
|
|
|
26
26
|
```js preview-story
|
|
27
27
|
export const main = () => html`
|
|
@@ -69,7 +69,7 @@ Global refers to overlays where the content is positioned in a global root node
|
|
|
69
69
|
|
|
70
70
|
Overlays can be configured in many ways to suit your needs. We go in-depth into each option in the Overlay System - Configuration chapter.
|
|
71
71
|
|
|
72
|
-
We also export a few [preset configuration objects](https://github.com/ing-bank/lion/blob/
|
|
72
|
+
We also export a few [preset configuration objects](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/fundamentals/systems/overlays/configuration.md).
|
|
73
73
|
|
|
74
74
|
- withModalDialogConfig
|
|
75
75
|
- withDropdownConfig
|
|
@@ -9,7 +9,7 @@ Therefore, they may not have the same quality standards as our other packages.
|
|
|
9
9
|
|
|
10
10
|
| Package | Description |
|
|
11
11
|
| -------------------------------------- | ----------------------- |
|
|
12
|
-
| [sb-action-logger](https://github.com/ing-bank/lion/blob/
|
|
12
|
+
| [sb-action-logger](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/fundamentals/tools/helpers/action-logger.md) | Storybook action logger |
|
|
13
13
|
|
|
14
14
|
## Installation
|
|
15
15
|
|
|
@@ -9,7 +9,7 @@ Primarily useful if two major version of a package with a singleton is used.
|
|
|
9
9
|
npm i --save singleton-manager
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
⚠️ 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/
|
|
12
|
+
⚠️ 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/593b753f0f99acb36ea6009677bc7fdda9184184/docs/fundamentals/tools/singleton-manager/#non-goals).
|
|
13
13
|
|
|
14
14
|
### Example Singleton Users
|
|
15
15
|
|
|
@@ -159,7 +159,7 @@ Steps to reproduce:
|
|
|
159
159
|
1. Page A click on block
|
|
160
160
|
2. Page B => "Blocked: false" (even when hitting the refresh button)
|
|
161
161
|
|
|
162
|
-
➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/
|
|
162
|
+
➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/fundamentals/tools/singleton-manager/example-fail/index.md). <br>
|
|
163
163
|
➡️ See [the code](https://github.com/ing-bank/lion/tree/master/docs/fundamentals/tools/singleton-manager/example-fail/demo-app.js).
|
|
164
164
|
|
|
165
165
|
---
|
|
@@ -202,7 +202,7 @@ See it in action
|
|
|
202
202
|
npm run start:singleton
|
|
203
203
|
```
|
|
204
204
|
|
|
205
|
-
➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/
|
|
205
|
+
➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/fundamentals/tools/singleton-manager/example-success/index.md). <br>
|
|
206
206
|
➡️ See [the code](https://github.com/ing-bank/lion/tree/master/docs/fundamentals/tools/singleton-manager/example-success/demo-app.js).
|
|
207
207
|
|
|
208
208
|
---
|
|
@@ -243,7 +243,7 @@ See it in action
|
|
|
243
243
|
npm run start:singleton-complex
|
|
244
244
|
```
|
|
245
245
|
|
|
246
|
-
➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/
|
|
246
|
+
➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/fundamentals/tools/singleton-manager/example-complex/index.md). <br>
|
|
247
247
|
➡️ See [the code](https://github.com/ing-bank/lion/tree/master/docs/fundamentals/tools/singleton-manager/example-complex/demo-app.js).
|
|
248
248
|
|
|
249
249
|
---
|
|
@@ -75,9 +75,9 @@ if (!customElements.get('dummy-slider')) {
|
|
|
75
75
|
}
|
|
76
76
|
```
|
|
77
77
|
|
|
78
|
-
Custom Fields can be created in just a few steps. All you need is an interaction element (like for instance a slider, a listbox or a combobox) and connect it to the [LionField](https://github.com/ing-bank/lion/blob/
|
|
78
|
+
Custom Fields can be created in just a few steps. All you need is an interaction element (like for instance a slider, a listbox or a combobox) and connect it to the [LionField](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/components/input/overview.md).
|
|
79
79
|
|
|
80
|
-
> In case you want to extend a native element, follow [Extend a native Input](https://github.com/ing-bank/lion/blob/
|
|
80
|
+
> In case you want to extend a native element, follow [Extend a native Input](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/guides/how-to/extend-a-native-input.md).
|
|
81
81
|
|
|
82
82
|
## A) an interaction element
|
|
83
83
|
|
|
@@ -126,7 +126,7 @@ export const createAnInteractiveElement = () => {
|
|
|
126
126
|
## B) your LionField extension
|
|
127
127
|
|
|
128
128
|
Now we want to integrate the slider in our form system to enrich the user interface, get
|
|
129
|
-
validation support and all other [benefits of LionField](https://github.com/ing-bank/lion/blob/
|
|
129
|
+
validation support and all other [benefits of LionField](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/components/input/overview.md).
|
|
130
130
|
We start by creating a component `<slider-field>` that extends from `LionField`.
|
|
131
131
|
Then we follow the steps below:
|
|
132
132
|
|
|
@@ -139,7 +139,7 @@ Then we follow the steps below:
|
|
|
139
139
|
|
|
140
140
|
The `user-input-changed` event is listened to by the FormatMixin: it should be regarded as the
|
|
141
141
|
equivalent of the `input` event of the platform, but for custom built interaction elements.
|
|
142
|
-
You now synchronized [modelValue](https://github.com/ing-bank/lion/blob/
|
|
142
|
+
You now synchronized [modelValue](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/fundamentals/systems/form/model-value.md), which can be regarded as
|
|
143
143
|
the glue to integrate all other functionality like parsing/formatting/serializing, validating,
|
|
144
144
|
tracking interaction states etc.
|
|
145
145
|
|
|
@@ -147,7 +147,7 @@ Then we follow the steps below:
|
|
|
147
147
|
> because those properties will lose their reactivity (they won't be considered anymore in the
|
|
148
148
|
> update loop of LitElement).
|
|
149
149
|
> Whenever a .modelValue/.formattedValue/.serializedValue needs to be computed, use
|
|
150
|
-
> [parser/formatter/serializer](https://github.com/ing-bank/lion/blob/
|
|
150
|
+
> [parser/formatter/serializer](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/fundamentals/systems/form/formatting-and-parsing.md)
|
|
151
151
|
|
|
152
152
|
Implement with the following code:
|
|
153
153
|
|
|
@@ -27,7 +27,7 @@ Large or complex forms might need to be split up into multiple files. This compo
|
|
|
27
27
|
|
|
28
28
|
In the latter case: make sure that your components don't have a shadow root. This can be achieved by rendering into Light DOM. The form registration mechanism relies on light dom by design: as soon as you do start to use shadow roots, you will notice that your form components won't register themselves anymore to their parents.
|
|
29
29
|
|
|
30
|
-
> Today, rendering to light dom is the only way to [stay accessible](https://github.com/ing-bank/lion/blob/
|
|
30
|
+
> Today, rendering to light dom is the only way to [stay accessible](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/fundamentals/rationales/accessibility.md#shadow-roots-and-accessibility).
|
|
31
31
|
|
|
32
32
|
### Example of a component that renders into Light DOM
|
|
33
33
|
|
|
@@ -74,7 +74,7 @@ Extending form components is not recommended for Application Developers: it shou
|
|
|
74
74
|
This team will add the styling and default configuration needed to make it fit the particular Design System.
|
|
75
75
|
|
|
76
76
|
With the toolbox provided by the team that creates your Design System, you should be able to build all your forms. Only if you have a really good reason, look into
|
|
77
|
-
[exceptional cases](https://github.com/ing-bank/lion/blob/
|
|
77
|
+
[exceptional cases](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/guides/how-to/#exceptional-cases) below.
|
|
78
78
|
|
|
79
79
|
### Exceptional cases
|
|
80
80
|
|
|
@@ -82,8 +82,8 @@ If the form component you need is still missing, you have two options:
|
|
|
82
82
|
|
|
83
83
|
- is it a generic primitive that should be part of Lion? Request it in [Lion discussions](https://github.com/ing-bank/lion/discussions)
|
|
84
84
|
- is it a non generic component that is unique to your app?
|
|
85
|
-
- follow [create a custom field](https://github.com/ing-bank/lion/blob/
|
|
86
|
-
- follow [extend a native input](https://github.com/ing-bank/lion/blob/
|
|
85
|
+
- follow [create a custom field](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/guides/how-to/create-a-custom-field.md)
|
|
86
|
+
- follow [extend a native input](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/guides/how-to/extend-a-native-input.md)
|
|
87
87
|
|
|
88
88
|
It's also possible to extend other components, like LionListbox or LionCombobox. You need to be aware that you're building on top of protected apis.
|
|
89
89
|
Changing/overriding functionality is only recommended if the source code in `form-core` is fully understood.
|
|
@@ -11,9 +11,9 @@ import '../../fundamentals/systems/form/assets/h-output.js';
|
|
|
11
11
|
loadDefaultFeedbackMessages();
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
-
Input fields can be created by extending [LionInput](https://github.com/ing-bank/lion/blob/
|
|
14
|
+
Input fields can be created by extending [LionInput](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/components/input/overview.md).
|
|
15
15
|
|
|
16
|
-
> In case you want to wrap a custom form element, follow [Create a custom Field](https://github.com/ing-bank/lion/blob/
|
|
16
|
+
> In case you want to wrap a custom form element, follow [Create a custom Field](https://github.com/ing-bank/lion/blob/593b753f0f99acb36ea6009677bc7fdda9184184/docs/guides/how-to/create-a-custom-field.md).
|
|
17
17
|
|
|
18
18
|
For this tutorial, we create an input that wraps native `input[type=datetime-local]`.
|
|
19
19
|
This is as simple as adding a type:
|