@lion/ui 0.7.2 → 0.7.4

package/docs/fundamentals/systems/overlays/api-table.md

@@ -0,0 +1,168 @@
+# Systems >> Overlays >> API Table ||90 
+
+## class: `OverlayController`
+
+### Fields
+
+| Name                          | Privacy   | Type                                              | Default                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Description                                                                                                                                                                                                                                                                                                                                                                               | Inherited From |
+| ----------------------------- | --------- | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
+| `invoker`                     | public    | `HTMLElement \| undefined`                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | The invokerNode                                                                                                                                                                                                                                                                                                                                                                           |                |
+| `content`                     | public    | `HTMLDialogElement \| HTMLDivElement`             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | The contentWrapperNode                                                                                                                                                                                                                                                                                                                                                                    |                |
+| `placementMode`               | public    | `'global' \| 'local' \| undefined`                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Determines the connection point in DOM (body vs next to invoker).                                                                                                                                                                                                                                                                                                                         |                |
+| `invokerNode`                 | public    | `HTMLElement \| undefined`                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | The interactive element (usually a button) invoking the dialog or tooltip                                                                                                                                                                                                                                                                                                                 |                |
+| `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.                                                                                                                                                                                |                |
+| `contentNode`                 | public    | `HTMLElement`                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | The most important element: the overlay itself                                                                                                                                                                                                                                                                                                                                            |                |
+| `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 |                |
+| `backdropNode`                | public    | `HTMLElement`                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | The element that is placed behind the contentNode. When not provided and \`hasBackdrop\` is true,
a backdropNode will be automatically created                                                                                                                                                                                                                                        |                |
+| `elementToFocusAfterHide`     | public    | `HTMLElement`                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | The element that should be called \`.focus()\` on after dialog closes                                                                                                                                                                                                                                                                                                                     |                |
+| `hasBackdrop`                 | public    | `boolean`                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Whether it should have a backdrop (currently exclusive to globalOverlayController)                                                                                                                                                                                                                                                                                                        |                |
+| `isBlocking`                  | public    | `boolean`                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Hides other overlays when mutiple are opened (currently exclusive to globalOverlayController)                                                                                                                                                                                                                                                                                             |                |
+| `preventsScroll`              | public    | `boolean`                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Hides other overlays when mutiple are opened (currently exclusive to globalOverlayController)                                                                                                                                                                                                                                                                                             |                |
+| `trapsKeyboardFocus`          | public    | `boolean`                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Rotates tab, implicitly set when 'isModal'                                                                                                                                                                                                                                                                                                                                                |                |
+| `hidesOnEsc`                  | public    | `boolean`                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Hides the overlay when pressing \[ esc ]                                                                                                                                                                                                                                                                                                                                                  |                |
+| `hidesOnOutsideClick`         | public    | `boolean`                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Hides the overlay when clicking next to it, exluding invoker                                                                                                                                                                                                                                                                                                                              |                |
+| `hidesOnOutsideEsc`           | public    | `boolean`                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Hides the overlay when pressing esc, even when contentNode has no focus                                                                                                                                                                                                                                                                                                                   |                |
+| `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.                                      |                |
+| `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                                        |                |
+| `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                                                                                                                                                                                                                      |                |
+| `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)                                                                                                                                                                                              |                |
+| `popperConfig`                | public    | `PopperOptions`                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Popper configuration. Will be used when placementMode is 'local'                                                                                                                                                                                                                                                                                                                          |                |
+| `viewportConfig`              | public    | `ViewportConfig`                                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Viewport configuration. Will be used when placementMode is 'global'                                                                                                                                                                                                                                                                                                                       |                |
+| `visibilityTriggerFunction`   | public    |                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                           |                |
+| `_referenceNode`              | protected | `HTMLElement \| undefined`                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                           |                |
+| `elevation`                   | public    | `number`                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                           |                |
+| `isShown`                     | public    |                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                           |                |
+| `hasActiveBackdrop`           | public    |                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                           |                |
+| `hasActiveTrapsKeyboardFocus` | public    |                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                           |                |
+| `manager`                     | public    |                                                   | `manager`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                                                                                                                                                                           |                |
+| `config`                      | public    | `OverlayConfig`                                   | `{}`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                                                           |                |
+| `_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,
+      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,
+    }` |                                                                                                                                                                                                                                                                                                                                                                                           |                |
+| `_contentId`                  | protected |                                                   | `` `overlay-content--${Math.random().toString(36).slice(2, 10)}` ``                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                                                                                                                                                                                                                                                                                                                                                           |                |
+
+### Methods
+
+| Name                            | Privacy   | Description                                                                                                                                                                                                                                                    | Parameters                                                                                       | Return | Inherited From |
+| ------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------ | -------------- |
+| `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`                                                                        |        |                |
+| `_init`                         | protected |                                                                                                                                                                                                                                                                |                                                                                                  |        |                |
+| `_handleZIndex`                 | protected | Display local overlays on top of elements with no z-index that appear later in the DOM                                                                                                                                                                         | `{ phase }, config: { phase: OverlayPhase }`                                                     |        |                |
+| `show`                          | public    |                                                                                                                                                                                                                                                                | `elementToFocusAfterHide: HTMLElement`                                                           |        |                |
+| `_handlePosition`               | protected |                                                                                                                                                                                                                                                                | `{ phase }, config: { phase: OverlayPhase }`                                                     |        |                |
+| `_keepBodySize`                 | protected |                                                                                                                                                                                                                                                                | `{ phase }, config: { phase: OverlayPhase }`                                                     |        |                |
+| `hide`                          | public    |                                                                                                                                                                                                                                                                |                                                                                                  |        |                |
+| `transitionHide`                | public    | Method to be overriden by subclassers                                                                                                                                                                                                                          | `hideConfig: {backdropNode:HTMLElement, contentNode:HTMLElement}`                                |        |                |
+| `_transitionHide`               | protected |                                                                                                                                                                                                                                                                | `{ backdropNode, contentNode }, hideConfig: {backdropNode:HTMLElement, contentNode:HTMLElement}` |        |                |
+| `transitionShow`                | public    | To be overridden by subclassers                                                                                                                                                                                                                                | `showConfig: {backdropNode:HTMLElement; contentNode:HTMLElement}`                                |        |                |
+| `_transitionShow`               | protected |                                                                                                                                                                                                                                                                | `showConfig: {backdropNode:HTMLElement; contentNode:HTMLElement}`                                |        |                |
+| `_restoreFocus`                 | protected |                                                                                                                                                                                                                                                                |                                                                                                  |        |                |
+| `toggle`                        | public    |                                                                                                                                                                                                                                                                |                                                                                                  |        |                |
+| `_handleFeatures`               | protected | All features are handled here.                                                                                                                                                                                                                                 | `{ phase }, config: { phase: OverlayPhase }`                                                     |        |                |
+| `_handleVisibilityTriggers`     | protected |                                                                                                                                                                                                                                                                | `{ phase }, config: { phase: OverlayPhase }`                                                     |        |                |
+| `_handlePreventsScroll`         | protected |                                                                                                                                                                                                                                                                | `{ phase }, config: { phase: OverlayPhase }`                                                     |        |                |
+| `_handleBlocking`               | protected |                                                                                                                                                                                                                                                                | `{ phase }, config: { phase: OverlayPhase }`                                                     |        |                |
+| `_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 }`                                |        |                |
+| `_handleTrapsKeyboardFocus`     | protected |                                                                                                                                                                                                                                                                | `{ phase }, config: { phase: OverlayPhase }`                                                     |        |                |
+| `enableTrapsKeyboardFocus`      | public    |                                                                                                                                                                                                                                                                |                                                                                                  |        |                |
+| `disableTrapsKeyboardFocus`     | public    |                                                                                                                                                                                                                                                                | `{ findNewTrap = true }`                                                                         |        |                |
+| `_handleHidesOnEsc`             | protected |                                                                                                                                                                                                                                                                | `{ phase }, config: { phase: OverlayPhase }`                                                     |        |                |
+| `_handleHidesOnOutsideEsc`      | protected |                                                                                                                                                                                                                                                                | `{ phase }, config: { phase: OverlayPhase }`                                                     |        |                |
+| `_handleInheritsReferenceWidth` | protected |                                                                                                                                                                                                                                                                |                                                                                                  |        |                |
+| `_handleHidesOnOutsideClick`    | protected |                                                                                                                                                                                                                                                                | `{ phase }, config: { phase: OverlayPhase }`                                                     |        |                |
+| `_handleAccessibility`          | protected |                                                                                                                                                                                                                                                                | `{ phase }, config: { phase: OverlayPhase }`                                                     |        |                |
+| `teardown`                      | public    |                                                                                                                                                                                                                                                                |                                                                                                  |        |                |
+| `_hasDisabledInvoker`           | protected |                                                                                                                                                                                                                                                                |                                                                                                  |        |                |
+
+### Events
+
+| Name   | Type    | Description | Inherited From |
+| ------ | ------- | ----------- | -------------- |
+| `show` | `Event` |             |                |
+| `hide` | `Event` |             |                |
+
+<hr/>
+ 
+
+## class: `OverlaysManager`
+
+### Fields
+
+| Name            | Privacy | Type | Default | Description                                                                                                            | Inherited From |
+| --------------- | ------- | ---- | ------- | ---------------------------------------------------------------------------------------------------------------------- | -------------- |
+| `list`          | public  |      |         | no setter as .list is intended to be read-only&#xA;You can use .add or .remove to modify it                            |                |
+| `shownList`     | public  |      |         | no setter as .shownList is intended to be read-only&#xA;You can use .show or .hide on individual controllers to modify |                |
+| `siblingsInert` | public  |      |         | Features right now only for Global Overlay Manager                                                                     |                |
+
+### Methods
+
+| Name                                  | Privacy | Description                      | Parameters                                                                                                 | Return              | Inherited From |
+| ------------------------------------- | ------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------- | -------------- |
+| `add`                                 | public  | Registers an overlay controller. | `ctrlToAdd: OverlayController`                                                                             | `OverlayController` |                |
+| `remove`                              | public  |                                  | `ctrlToRemove: OverlayController`                                                                          |                     |                |
+| `show`                                | public  |                                  | `ctrlToShow: OverlayController`                                                                            |                     |                |
+| `hide`                                | public  |                                  | `ctrlToHide: any`                                                                                          |                     |                |
+| `teardown`                            | public  |                                  |                                                                                                            |                     |                |
+| `disableTrapsKeyboardFocusForAll`     | public  |                                  |                                                                                                            |                     |                |
+| `informTrapsKeyboardFocusGotEnabled`  | public  |                                  | `placementMode: 'local' \| 'global' \| undefined`                                                          |                     |                |
+| `informTrapsKeyboardFocusGotDisabled` | public  |                                  | `{ disabledCtrl, findNewTrap = true }, options: { disabledCtrl?:OverlayController, findNewTrap?:boolean }` |                     |                |
+| `requestToPreventScroll`              | public  | PreventsScroll                   |                                                                                                            |                     |                |
+| `requestToEnableScroll`               | public  |                                  |                                                                                                            |                     |                |
+| `requestToShowOnly`                   | public  | Blocking                         | `blockingCtrl: OverlayController`                                                                          |                     |                |
+| `retractRequestToShowOnly`            | public  |                                  | `blockingCtrl: OverlayController`                                                                          |                     |                |
+
+<hr/>

package/docs/fundamentals/systems/overlays/configuration.md

@@ -69,7 +69,7 @@ export const placementGlobal = () => {
 
 ## isTooltip (placementMode: 'local')
 
-As specified in the [overlay rationale](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/fundamentals/systems/overlays/rationale.md) there are only two official types of overlays: dialogs and tooltips. And their main differences are:
+As specified in the [overlay rationale](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/fundamentals/systems/overlays/rationale.md) there are only two official types of overlays: dialogs and tooltips. And their main differences are:
 
 - Dialogs have a modal option, tooltips don’t
 - Dialogs have interactive content, tooltips don’t
@@ -374,7 +374,7 @@ Features:
 
 > Popper strictly is scoped on positioning. **It does not change the dimensions of the content node nor the invoker node**.
 > 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.
-> An example implementation can be found in [lion-tooltip](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/components/tooltip/overview.md), where an arrow is set by default.
+> An example implementation can be found in [lion-tooltip](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/components/tooltip/overview.md), where an arrow is set by default.
 
 To override the default options we set for local mode, you add a `popperConfig` object to the config passed to the OverlayController.
 Here's a succinct overview of some often used popper properties:

package/docs/fundamentals/systems/overlays/overview.md

@@ -6,7 +6,7 @@ Manages their position on the screen relative to other elements, including other
 
 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.
 
-See [lion-dialog](../../../components/dialog/overview.md) and [lion-tooltip](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/components/tooltip/overview.md) for example Web Component implementations using the Overlay System.
+See [lion-dialog](../../../components/dialog/overview.md) and [lion-tooltip](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/components/tooltip/overview.md) for example Web Component implementations using the Overlay System.
 
 ## Features
 
@@ -18,9 +18,9 @@ See [lion-dialog](../../../components/dialog/overview.md) and [lion-tooltip](htt
 - lion-overlay web component:
   - Show content when clicking the invoker
   - Have a `.config` object to set or update the OverlayController's configuration
-- [**OverlaysManager**](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/fundamentals/systems/overlays/use-cases.md#overlaysmanager), a global repository keeping track of all different types of overlays
-- [**OverlayController**](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/fundamentals/systems/overlays/use-cases.md#overlaycontroller), a single controller class for handling overlays
-- [**OverlayMixin**](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/fundamentals/systems/overlays/use-cases.md#overlaymixin), a mixin that can be used to create webcomponents that use the OverlayController under the hood
+- [**OverlaysManager**](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/fundamentals/systems/overlays/use-cases.md#overlaysmanager), a global repository keeping track of all different types of overlays
+- [**OverlayController**](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/fundamentals/systems/overlays/use-cases.md#overlaycontroller), a single controller class for handling overlays
+- [**OverlayMixin**](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/fundamentals/systems/overlays/use-cases.md#overlaymixin), a mixin that can be used to create webcomponents that use the OverlayController under the hood
 
 Usually you will use `lion-dialog` (or `lion-tooltip` if this makes more sense).
 
@@ -110,4 +110,4 @@ class MyOverlayComponent extends OverlayMixin(LitElement) {
 
 ## Rationales
 
-Please check the [system rationals](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/fundamentals/systems/overlays/rationale.md) folder, where we go more in-depth.
+Please check the [system rationals](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/fundamentals/systems/overlays/rationale.md) folder, where we go more in-depth.

package/docs/fundamentals/systems/overlays/use-cases.md

@@ -21,7 +21,7 @@ The overlay system allows to create different types of overlays like dialogs, to
 It's designed to be highly flexible, while still delivering sensible defaults.
 On top of this, the system was built having accessibility in mind.
 
-For a detailed rationale, please consult [Rationale](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/fundamentals/systems/overlays/rationale.md).
+For a detailed rationale, please consult [Rationale](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/fundamentals/systems/overlays/rationale.md).
 
 ```js preview-story
 export const main = () => html`
@@ -67,7 +67,7 @@ Global refers to overlays where the content is positioned in a global root node
 
 Overlays can be configured in many ways to suit your needs. We go in-depth into each option in the Overlay System - Configuration chapter.
 
-We also export a few [preset configuration objects](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/fundamentals/systems/overlays/configuration.md).
+We also export a few [preset configuration objects](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/fundamentals/systems/overlays/configuration.md).
 
 - withModalDialogConfig
 - withDropdownConfig
@@ -131,15 +131,12 @@ render() {
 
 or declaratively in your template with the `.config` property
 
-```html
-<demo-el-using-overlaymixin .config=${{ ...withModalDialogConfig() }}>
+```jsx
+<demo-el-using-overlaymixin .config="${{ ...withModalDialogConfig() }}">
   <button slot="invoker">Click me to open the overlay!</button>
   <div slot="content" class="demo-overlay">
     Hello! You can close this notification here:
-    <button
-      @click=${e => e.target.dispatchEvent(new Event('close-overlay', { bubbles: true }))}
-    >
-      ⨯
+    <button @click="${e => e.target.dispatchEvent(new Event('close-overlay', { bubbles: true }))}">
     </button>
   </div>
 </demo-el-using-overlaymixin>

package/docs/fundamentals/tools/helpers/action-logger.md

@@ -40,13 +40,10 @@ const uid = Math.random().toString(36).substr(2, 10);
 
 This connects the logger element to the trigger.
 
-```html
+```jsx
 <div>To log: <code>Hello, World!</code></div>
-<button
-  @click=${e => {
-    e.target.parentElement.querySelector('#logger-${uid}').log('Hello, World!')
-  }}
->Click this button</button>
+<button @click="${e => { e.target.parentElement.querySelector('#logger-${uid}').log('Hello, World!') }}">Click this button
+</button>
 <sb-action-logger id="logger-${uid}"></sb-action-logger>
 ```
 

package/docs/fundamentals/tools/helpers/overview.md

@@ -9,7 +9,7 @@ Therefore, they may not have the same quality standards as our other packages.
 
 | Package                                | Description             |
 | -------------------------------------- | ----------------------- |
-| [sb-action-logger](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/fundamentals/tools/helpers/action-logger.md) | Storybook action logger |
+| [sb-action-logger](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/fundamentals/tools/helpers/action-logger.md) | Storybook action logger |
 
 ## Installation
 

package/docs/fundamentals/tools/singleton-manager/example-complex/demo-app.js

@@ -37,7 +37,9 @@ class DemoApp extends LitElement {
         font-size: 1rem;
         cursor: pointer;
         text-align: center;
-        transition: background 250ms ease-in-out, transform 150ms ease;
+        transition:
+          background 250ms ease-in-out,
+          transform 150ms ease;
       }
 
       button:hover,

package/docs/fundamentals/tools/singleton-manager/example-fail/demo-app.js

@@ -35,7 +35,9 @@ class DemoApp extends LitElement {
         font-size: 1rem;
         cursor: pointer;
         text-align: center;
-        transition: background 250ms ease-in-out, transform 150ms ease;
+        transition:
+          background 250ms ease-in-out,
+          transform 150ms ease;
       }
 
       button:hover,

package/docs/fundamentals/tools/singleton-manager/example-success/demo-app.js

@@ -37,7 +37,9 @@ class DemoApp extends LitElement {
         font-size: 1rem;
         cursor: pointer;
         text-align: center;
-        transition: background 250ms ease-in-out, transform 150ms ease;
+        transition:
+          background 250ms ease-in-out,
+          transform 150ms ease;
       }
 
       button:hover,

package/docs/fundamentals/tools/singleton-manager/overview.md

@@ -9,7 +9,7 @@ Primarily useful if two major version of a package with a singleton is used.
 npm i --save singleton-manager
 ```
 
-⚠️ 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/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/fundamentals/tools/singleton-manager/#non-goals).
+⚠️ 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/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/fundamentals/tools/singleton-manager/#non-goals).
 
 ### Example Singleton Users
 
@@ -159,7 +159,7 @@ Steps to reproduce:
 1. Page A click on block
 2. Page B => "Blocked: false" (even when hitting the refresh button)
 
-➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/fundamentals/tools/singleton-manager/example-fail/index.md). <br>
+➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/fundamentals/tools/singleton-manager/example-fail/index.md). <br>
 ➡️ See [the code](https://github.com/ing-bank/lion/tree/master/docs/fundamentals/tools/singleton-manager/example-fail/demo-app.js).
 
 ---
@@ -202,7 +202,7 @@ See it in action
 npm run start:singleton
 ```
 
-➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/fundamentals/tools/singleton-manager/example-success/index.md). <br>
+➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/fundamentals/tools/singleton-manager/example-success/index.md). <br>
 ➡️ See [the code](https://github.com/ing-bank/lion/tree/master/docs/fundamentals/tools/singleton-manager/example-success/demo-app.js).
 
 ---
@@ -243,7 +243,7 @@ See it in action
 npm run start:singleton-complex
 ```
 
-➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/fundamentals/tools/singleton-manager/example-complex/index.md). <br>
+➡️ See [it on the example page](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/fundamentals/tools/singleton-manager/example-complex/index.md). <br>
 ➡️ See [the code](https://github.com/ing-bank/lion/tree/master/docs/fundamentals/tools/singleton-manager/example-complex/demo-app.js).
 
 ---

package/docs/guides/how-to/create-a-custom-field.md

@@ -75,9 +75,9 @@ if (!customElements.get('dummy-slider')) {
 }
 ```
 
-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/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/components/input/overview.md).
+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/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/components/input/overview.md).
 
-> In case you want to extend a native element, follow [Extend a native Input](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/guides/how-to/extend-a-native-input.md).
+> In case you want to extend a native element, follow [Extend a native Input](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/guides/how-to/extend-a-native-input.md).
 
 ## A) an interaction element
 
@@ -126,7 +126,7 @@ export const createAnInteractiveElement = () => {
 ## B) your LionField extension
 
 Now we want to integrate the slider in our form system to enrich the user interface, get
-validation support and all other [benefits of LionField](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/components/input/overview.md).
+validation support and all other [benefits of LionField](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/components/input/overview.md).
 We start by creating a component `<slider-field>` that extends from `LionField`.
 Then we follow the steps below:
 
@@ -139,7 +139,7 @@ Then we follow the steps below:
 
   The `user-input-changed` event is listened to by the FormatMixin: it should be regarded as the
   equivalent of the `input` event of the platform, but for custom built interaction elements.
-  You now synchronized [modelValue](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/fundamentals/systems/form/model-value.md), which can be regarded as
+  You now synchronized [modelValue](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/fundamentals/systems/form/model-value.md), which can be regarded as
   the glue to integrate all other functionality like parsing/formatting/serializing, validating,
   tracking interaction states etc.
 
@@ -147,7 +147,7 @@ Then we follow the steps below:
 > because those properties will loose their reactivity (they won't be considered anymore in the
 > update loop of LitElement).
 > Whenever a .modelValue/.formattedValue/.serializedValue needs to be computed, use
-> [parser/formatter/serializer](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/fundamentals/systems/form/formatting-and-parsing.md)
+> [parser/formatter/serializer](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/fundamentals/systems/form/formatting-and-parsing.md)
 
 Implement with the following code:
 

package/docs/guides/how-to/create-a-form.md

@@ -63,7 +63,7 @@ class MyForm extends LitElement {
 }
 ```
 
-> Today, rendering to light dom is the only way to [stay accessible](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/fundamentals/rationales/accessibility.md#shadow-roots-and-accessibility).
+> Today, rendering to light dom is the only way to [stay accessible](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/fundamentals/rationales/accessibility.md#shadow-roots-and-accessibility).
 
 The 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.
 
@@ -73,7 +73,7 @@ Extending form components is not recommended for Application Developers: it shou
 This team will add the styling and default configuration needed to make it fit the particular Design System.
 
 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
-[exceptional cases](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/guides/how-to/#exceptional-cases) below.
+[exceptional cases](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/guides/how-to/#exceptional-cases) below.
 
 ### Exceptional cases
 
@@ -81,8 +81,8 @@ If the form component you need is still missing, you have two options:
 
 - is it a generic primitive that should be part of Lion? Request it in [Lion discussions](https://github.com/ing-bank/lion/discussions)
 - is it a non generic component that is unique to your app?
-  - follow [create a custom field](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/guides/how-to/create-a-custom-field.md)
-  - follow [extend a native input](https://github.com/ing-bank/lion/blob/8fd9ec4df166dd45f230eb032e3b1c151fd6240d/docs/guides/how-to/extend-a-native-input.md)
+  - follow [create a custom field](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/guides/how-to/create-a-custom-field.md)
+  - follow [extend a native input](https://github.com/ing-bank/lion/blob/15a9d70cb690d26e6a2af8a6b5dbdda7e7b0112e/docs/guides/how-to/extend-a-native-input.md)
 
 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.
 Changing/overriding functionality is only recommended if the source code in `form-core` is fully understood.