@lion/ui 0.11.0 → 0.11.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/components/checkbox-group/src/LionCheckboxIndeterminate.js +39 -16
- package/components/checkbox-group/test-suites/CheckboxIndeterminate.suite.js +189 -1
- package/components/combobox/test/lion-combobox.test.js +75 -1
- package/components/form-core/src/FocusMixin.js +4 -4
- package/components/form-core/src/LionField.js +1 -1
- package/components/localize/src/date/parseDate.js +6 -1
- package/components/localize/src/date/utils/checkYearFormat.js +8 -0
- package/components/localize/test/date/parseDate.test.js +6 -0
- package/components/localize/types/LocalizeMixinTypes.ts +0 -5
- package/components/select-rich/src/LionSelectRich.js +1 -1
- package/components/select-rich/test/lion-select-rich.test.js +13 -1
- package/custom-elements.json +47758 -47690
- package/dist-types/components/checkbox-group/src/LionCheckboxIndeterminate.d.ts +10 -0
- package/dist-types/components/checkbox-group/src/LionCheckboxIndeterminate.d.ts.map +1 -1
- package/dist-types/components/checkbox-group/test-suites/CheckboxIndeterminate.suite.d.ts.map +1 -1
- package/dist-types/components/localize/src/date/parseDate.d.ts.map +1 -1
- package/dist-types/components/localize/src/date/utils/checkYearFormat.d.ts +7 -0
- package/dist-types/components/localize/src/date/utils/checkYearFormat.d.ts.map +1 -0
- package/dist-types/components/localize/types/LocalizeMixinTypes.d.ts +0 -4
- package/dist-types/components/localize/types/LocalizeMixinTypes.d.ts.map +1 -1
- package/dist-types/tsconfig.tsbuildinfo +1 -1
- package/docs/components/accordion/api-table.md +19 -7
- package/docs/components/accordion/index.md +10 -0
- package/docs/components/accordion/overview.md +13 -1
- package/docs/components/accordion/reference.md +13 -1
- package/docs/components/accordion/use-cases.md +13 -1
- package/docs/components/button/api-table.md +40 -31
- package/docs/components/button/examples.md +13 -1
- package/docs/components/button/extensions.md +13 -1
- package/docs/components/button/index.md +11 -1
- package/docs/components/button/overview.md +13 -1
- package/docs/components/button/use-cases.md +13 -1
- package/docs/components/calendar/api-table.md +26 -14
- package/docs/components/calendar/index.md +11 -1
- package/docs/components/calendar/overview.md +13 -1
- package/docs/components/calendar/use-cases.md +13 -1
- package/docs/components/checkbox-group/api-table.md +318 -330
- package/docs/components/checkbox-group/index.md +11 -1
- package/docs/components/checkbox-group/overview.md +15 -3
- package/docs/components/checkbox-group/use-cases.md +13 -1
- package/docs/components/collapsible/api-table.md +18 -6
- package/docs/components/collapsible/examples.md +13 -1
- package/docs/components/collapsible/index.md +11 -1
- package/docs/components/collapsible/overview.md +14 -2
- package/docs/components/collapsible/use-cases.md +13 -1
- package/docs/components/combobox/api-table.md +163 -155
- package/docs/components/combobox/extensions.md +13 -1
- package/docs/components/combobox/index.md +11 -1
- package/docs/components/combobox/overview.md +14 -2
- package/docs/components/combobox/use-cases.md +14 -2
- package/docs/components/dialog/api-table.md +25 -13
- package/docs/components/dialog/index.md +11 -1
- package/docs/components/dialog/overview.md +14 -2
- package/docs/components/dialog/use-cases.md +13 -1
- package/docs/components/drawer/api-table.md +22 -11
- package/docs/components/drawer/index.md +11 -1
- package/docs/components/drawer/overview.md +13 -1
- package/docs/components/drawer/use-cases.md +13 -1
- package/docs/components/fieldset/api-table.md +117 -119
- package/docs/components/fieldset/index.md +11 -1
- package/docs/components/fieldset/overview.md +18 -6
- package/docs/components/fieldset/use-cases.md +13 -1
- package/docs/components/form/api-table.md +12 -1
- package/docs/components/form/index.md +11 -1
- package/docs/components/form/overview.md +16 -4
- package/docs/components/form/use-cases.md +15 -3
- package/docs/components/icon/api-table.md +16 -4
- package/docs/components/icon/index.md +11 -1
- package/docs/components/icon/overview.md +13 -1
- package/docs/components/icon/use-cases.md +14 -2
- package/docs/components/index.md +11 -1
- package/docs/components/input/api-table.md +123 -121
- package/docs/components/input/index.md +11 -1
- package/docs/components/input/overview.md +14 -2
- package/docs/components/input/use-cases.md +13 -1
- package/docs/components/input-amount/api-table.md +142 -143
- package/docs/components/input-amount/index.md +11 -1
- package/docs/components/input-amount/overview.md +16 -4
- package/docs/components/input-amount/use-cases.md +13 -1
- package/docs/components/input-date/api-table.md +123 -121
- package/docs/components/input-date/index.md +11 -1
- package/docs/components/input-date/overview.md +16 -4
- package/docs/components/input-date/use-cases.md +13 -1
- package/docs/components/input-datepicker/api-table.md +161 -161
- package/docs/components/input-datepicker/index.md +11 -1
- package/docs/components/input-datepicker/overview.md +18 -6
- package/docs/components/input-datepicker/use-cases.md +13 -1
- package/docs/components/input-email/api-table.md +123 -121
- package/docs/components/input-email/index.md +11 -1
- package/docs/components/input-email/overview.md +15 -3
- package/docs/components/input-email/use-cases.md +13 -1
- package/docs/components/input-file/api-table.md +145 -144
- package/docs/components/input-file/index.md +11 -1
- package/docs/components/input-file/overview.md +14 -2
- package/docs/components/input-file/use-cases.md +13 -1
- package/docs/components/input-iban/api-table.md +123 -121
- package/docs/components/input-iban/index.md +11 -1
- package/docs/components/input-iban/overview.md +15 -3
- package/docs/components/input-iban/use-cases.md +13 -1
- package/docs/components/input-range/api-table.md +129 -127
- package/docs/components/input-range/index.md +11 -1
- package/docs/components/input-range/overview.md +15 -3
- package/docs/components/input-range/use-cases.md +13 -1
- package/docs/components/input-stepper/api-table.md +136 -134
- package/docs/components/input-stepper/index.md +11 -1
- package/docs/components/input-stepper/overview.md +14 -2
- package/docs/components/input-stepper/use-cases.md +13 -1
- package/docs/components/input-tel/api-table.md +131 -129
- package/docs/components/input-tel/index.md +11 -1
- package/docs/components/input-tel/overview.md +14 -2
- package/docs/components/input-tel/use-cases.md +19 -7
- package/docs/components/input-tel-dropdown/api-table.md +138 -136
- package/docs/components/input-tel-dropdown/extensions.md +13 -1
- package/docs/components/input-tel-dropdown/index.md +11 -1
- package/docs/components/input-tel-dropdown/overview.md +14 -2
- package/docs/components/input-tel-dropdown/use-cases.md +13 -1
- package/docs/components/listbox/api-table.md +139 -132
- package/docs/components/listbox/index.md +11 -1
- package/docs/components/listbox/overview.md +13 -1
- package/docs/components/listbox/use-cases.md +14 -2
- package/docs/components/pagination/api-table.md +18 -6
- package/docs/components/pagination/index.md +11 -1
- package/docs/components/pagination/overview.md +13 -1
- package/docs/components/pagination/use-cases.md +13 -1
- package/docs/components/progress-indicator/api-table.md +22 -11
- package/docs/components/progress-indicator/examples.md +13 -1
- package/docs/components/progress-indicator/index.md +11 -1
- package/docs/components/progress-indicator/overview.md +13 -1
- package/docs/components/radio-group/api-table.md +247 -259
- package/docs/components/radio-group/index.md +11 -1
- package/docs/components/radio-group/overview.md +16 -4
- package/docs/components/radio-group/use-cases.md +13 -1
- package/docs/components/select/api-table.md +119 -117
- package/docs/components/select/index.md +11 -1
- package/docs/components/select/overview.md +13 -1
- package/docs/components/select/use-cases.md +14 -2
- package/docs/components/select-rich/api-table.md +182 -179
- package/docs/components/select-rich/examples.md +13 -1
- package/docs/components/select-rich/index.md +11 -1
- package/docs/components/select-rich/overview.md +13 -1
- package/docs/components/select-rich/use-cases.md +14 -2
- package/docs/components/steps/api-table.md +19 -7
- package/docs/components/steps/index.md +11 -1
- package/docs/components/steps/overview.md +13 -1
- package/docs/components/steps/use-cases.md +13 -1
- package/docs/components/switch/api-table.md +130 -129
- package/docs/components/switch/index.md +11 -1
- package/docs/components/switch/overview.md +13 -1
- package/docs/components/switch/reference.md +13 -1
- package/docs/components/switch/use-cases.md +13 -1
- package/docs/components/tabs/api-table.md +14 -2
- package/docs/components/tabs/examples.md +14 -2
- package/docs/components/tabs/index.md +11 -1
- package/docs/components/tabs/overview.md +13 -1
- package/docs/components/tabs/use-cases.md +13 -1
- package/docs/components/textarea/api-table.md +127 -125
- package/docs/components/textarea/index.md +11 -1
- package/docs/components/textarea/overview.md +13 -1
- package/docs/components/textarea/use-cases.md +13 -1
- package/docs/components/tooltip/api-table.md +26 -14
- package/docs/components/tooltip/examples.md +13 -1
- package/docs/components/tooltip/index.md +11 -1
- package/docs/components/tooltip/overview.md +13 -1
- package/docs/components/tooltip/use-cases.md +13 -1
- package/docs/fundamentals/index.md +4 -4
- package/docs/fundamentals/node-tools/babel-plugin-extend-docs/index.md +12 -0
- package/docs/fundamentals/node-tools/babel-plugin-extend-docs/overview.md +13 -0
- package/docs/fundamentals/node-tools/index.md +10 -0
- package/docs/fundamentals/node-tools/providence-analytics/index.md +12 -0
- package/docs/fundamentals/node-tools/providence-analytics/overview.md +13 -0
- package/docs/fundamentals/node-tools/publish-docs/index.md +12 -0
- package/docs/fundamentals/node-tools/publish-docs/overview.md +16 -3
- package/docs/fundamentals/node-tools/remark-extend/index.md +12 -0
- package/docs/fundamentals/node-tools/remark-extend/overview.md +13 -0
- package/docs/fundamentals/node-tools/rocket-preset-extend-lion-docs/index.md +12 -0
- package/docs/fundamentals/node-tools/rocket-preset-extend-lion-docs/overview.md +15 -2
- package/docs/fundamentals/rationales/TypeScript.md +12 -0
- package/docs/fundamentals/rationales/accessibility.md +13 -1
- package/docs/fundamentals/rationales/index.md +10 -0
- package/docs/fundamentals/rationales/side-effects.md +12 -0
- package/docs/fundamentals/rationales/versioning.md +12 -0
- package/docs/fundamentals/systems/core/SlotMixin.md +14 -1
- package/docs/fundamentals/systems/core/api-table.md +22 -12
- package/docs/fundamentals/systems/core/index.md +12 -0
- package/docs/fundamentals/systems/core/overview.md +14 -1
- package/docs/fundamentals/systems/form/api-table.md +91 -83
- package/docs/fundamentals/systems/form/formatting-and-parsing.md +17 -4
- package/docs/fundamentals/systems/form/index.md +12 -0
- package/docs/fundamentals/systems/form/interaction-states.md +13 -0
- package/docs/fundamentals/systems/form/model-value.md +14 -1
- package/docs/fundamentals/systems/form/overview.md +41 -28
- package/docs/fundamentals/systems/form/styling.md +13 -0
- package/docs/fundamentals/systems/form/use-cases.md +13 -0
- package/docs/fundamentals/systems/form/validate.md +15 -2
- package/docs/fundamentals/systems/icon/index.md +12 -0
- package/docs/fundamentals/systems/icon/overview.md +13 -0
- package/docs/fundamentals/systems/index.md +10 -0
- package/docs/fundamentals/systems/localize/api-table.md +33 -20
- package/docs/fundamentals/systems/localize/dates.md +13 -0
- package/docs/fundamentals/systems/localize/index.md +12 -0
- package/docs/fundamentals/systems/localize/numbers.md +13 -0
- package/docs/fundamentals/systems/localize/overview.md +17 -4
- package/docs/fundamentals/systems/localize/rationale.md +13 -0
- package/docs/fundamentals/systems/localize/text.md +13 -0
- package/docs/fundamentals/systems/localize/use-cases.md +13 -0
- package/docs/fundamentals/systems/overlays/_configuration-positioning.md +11 -0
- package/docs/fundamentals/systems/overlays/_edge-cases.md +10 -0
- package/docs/fundamentals/systems/overlays/api-table.md +59 -47
- package/docs/fundamentals/systems/overlays/configuration.md +15 -2
- package/docs/fundamentals/systems/overlays/index.md +12 -0
- package/docs/fundamentals/systems/overlays/overview.md +18 -5
- package/docs/fundamentals/systems/overlays/rationale.md +13 -0
- package/docs/fundamentals/systems/overlays/use-cases.md +15 -2
- package/docs/fundamentals/tools/ajax/index.md +12 -0
- package/docs/fundamentals/tools/ajax/overview.md +13 -0
- package/docs/fundamentals/tools/ajax/use-cases.md +13 -0
- package/docs/fundamentals/tools/helpers/action-logger.md +13 -0
- package/docs/fundamentals/tools/helpers/index.md +12 -0
- package/docs/fundamentals/tools/helpers/overview.md +14 -1
- package/docs/fundamentals/tools/index.md +10 -0
- package/docs/fundamentals/tools/singleton-manager/example-complex/index.md +13 -0
- package/docs/fundamentals/tools/singleton-manager/example-fail/index.md +13 -0
- package/docs/fundamentals/tools/singleton-manager/example-success/index.md +13 -0
- package/docs/fundamentals/tools/singleton-manager/index.md +12 -0
- package/docs/fundamentals/tools/singleton-manager/overview.md +17 -4
- package/docs/guides/how-to/create-a-custom-field.md +18 -6
- package/docs/guides/how-to/create-a-form.md +17 -5
- package/docs/guides/how-to/extend-a-native-input.md +15 -3
- package/docs/guides/how-to/get-started.md +13 -1
- package/docs/guides/how-to/index.md +11 -1
- package/docs/guides/index.md +19 -9
- package/docs/guides/principles/definitions-and-terms.md +13 -1
- package/docs/guides/principles/index.md +16 -6
- package/docs/guides/principles/scoped-elements.md +13 -1
- package/docs/guides/principles/styling.md +14 -2
- package/docs/guides/principles/subclasser-apis.md +13 -1
- package/package.json +1 -1
|
@@ -1,4 +1,16 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- Textarea
|
|
4
|
+
- Overview
|
|
5
|
+
title: 'Textarea: Overview'
|
|
6
|
+
eleventyNavigation:
|
|
7
|
+
key: 'Textarea: Overview'
|
|
8
|
+
order: 10
|
|
9
|
+
parent: Textarea
|
|
10
|
+
title: Overview
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Textarea: Overview
|
|
2
14
|
|
|
3
15
|
A webcomponent that enhances the functionality of the native `<input type="textarea">` element.
|
|
4
16
|
Its purpose is to provide a way for users to write text that is multiple lines long.
|
|
@@ -1,4 +1,16 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- Textarea
|
|
4
|
+
- Use Cases
|
|
5
|
+
title: 'Textarea: Use Cases'
|
|
6
|
+
eleventyNavigation:
|
|
7
|
+
key: 'Textarea: Use Cases'
|
|
8
|
+
order: 20
|
|
9
|
+
parent: Textarea
|
|
10
|
+
title: Use Cases
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Textarea: Use Cases
|
|
2
14
|
|
|
3
15
|
```js script
|
|
4
16
|
import { html } from '@mdjs/mdjs-preview';
|
|
@@ -1,4 +1,16 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- API Table
|
|
4
|
+
- Tooltip
|
|
5
|
+
title: 'Tooltip: API Table'
|
|
6
|
+
eleventyNavigation:
|
|
7
|
+
key: API Table >> Tooltip
|
|
8
|
+
title: API Table
|
|
9
|
+
order: 90
|
|
10
|
+
parent: Tooltip
|
|
11
|
+
---
|
|
12
|
+
# Tooltip: API Table
|
|
13
|
+
|
|
2
14
|
|
|
3
15
|
## class: `LionTooltip`, `lion-tooltip`
|
|
4
16
|
|
|
@@ -6,36 +18,36 @@
|
|
|
6
18
|
|
|
7
19
|
| Name | Privacy | Type | Default | Description | Inherited From |
|
|
8
20
|
| ---------------------------- | --------- | ------------------------ | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
|
|
21
|
+
| `config` | public | `Partial<OverlayConfig>` | `{}` | Configure the many options of the \`OverlayController\` | OverlayMixin |
|
|
9
22
|
| `hasArrow` | public | `boolean` | `false` | Whether an arrow should be displayed | ArrowMixin |
|
|
10
23
|
| `invokerRelation` | public | `'label'\|'description'` | `'description'` | Decides whether the tooltip invoker text should be considered a description
(sets aria-describedby) or a label (sets aria-labelledby). | |
|
|
24
|
+
| `opened` | public | `boolean` | `false` | If you add the opened attribute a dialog will be opened on page load. The invoker can be left out
in case the user does not need to be able to reopen the dialog. | OverlayMixin |
|
|
11
25
|
| `_arrowNode` | protected | | | | ArrowMixin |
|
|
12
|
-
| `config` | public | `Partial<OverlayConfig>` | `{}` | Configure the many options of the \`OverlayController\` | OverlayMixin |
|
|
13
|
-
| `_overlayInvokerNode` | protected | | | | OverlayMixin |
|
|
14
|
-
| `_overlayReferenceNode` | protected | | | | OverlayMixin |
|
|
15
26
|
| `_overlayBackdropNode` | protected | | | | OverlayMixin |
|
|
16
27
|
| `_overlayContentNode` | protected | | | | OverlayMixin |
|
|
17
28
|
| `_overlayContentWrapperNode` | protected | | | | OverlayMixin |
|
|
18
|
-
| `
|
|
29
|
+
| `_overlayInvokerNode` | protected | | | | OverlayMixin |
|
|
30
|
+
| `_overlayReferenceNode` | protected | | | | OverlayMixin |
|
|
19
31
|
|
|
20
32
|
### Methods
|
|
21
33
|
|
|
22
34
|
| Name | Privacy | Description | Parameters | Return | Inherited From |
|
|
23
35
|
| ---------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------ | -------------- |
|
|
24
|
-
| `
|
|
36
|
+
| `close` | public | Hides the overlay | | | OverlayMixin |
|
|
37
|
+
| `open` | public | Shows the overlay | | | OverlayMixin |
|
|
38
|
+
| `repositionOverlay` | public | Sometimes it's needed to recompute Popper position of an overlay, for instance when we have
an opened combobox and the surrounding context changes (the space consumed by the textbox
increases vertically) | | | OverlayMixin |
|
|
39
|
+
| `toggle` | public | Toggles the overlay | | | OverlayMixin |
|
|
25
40
|
| `_arrowNodeTemplate` | protected | | | | ArrowMixin |
|
|
26
41
|
| `_arrowTemplate` | protected | | | | ArrowMixin |
|
|
27
|
-
| `_getPopperArrowConfig` | protected | | `popperConfigToExtendFrom: Partial<PopperOptions>` | `Partial<PopperOptions>` | ArrowMixin |
|
|
28
42
|
| `_defineOverlay` | protected | | `{ contentNode, invokerNode, referenceNode, backdropNode, contentWrapperNode }, config: DefineOverlayConfig` | `OverlayController` | OverlayMixin |
|
|
43
|
+
| `_defineOverlayConfig` | protected | Overrides arrow and keepTogether modifier to be enabled,
and adds onCreate and onUpdate hooks to sync from popper state | | `OverlayConfig` | OverlayMixin |
|
|
44
|
+
| `_getPopperArrowConfig` | protected | | `popperConfigToExtendFrom: Partial<PopperOptions>` | `Partial<PopperOptions>` | ArrowMixin |
|
|
45
|
+
| `_isPermanentlyDisconnected` | protected | When we're moving around in dom, disconnectedCallback gets called.
Before we decide to teardown, let's wait to see if we were not just moving nodes around. | | `Promise<boolean>` | OverlayMixin |
|
|
46
|
+
| `_setOpenedWithoutPropertyEffects` | protected | When the opened state is changed by an Application Developer,cthe OverlayController is
requested to show/hide. It might happen that this request is not honoured
(intercepted in before-hide for instance), so that we need to sync the controller state
to this webcomponent again, preventing eternal loops. | `newOpened: boolean` | | OverlayMixin |
|
|
29
47
|
| `_setupOpenCloseListeners` | protected | | | | OverlayMixin |
|
|
30
|
-
| `_teardownOpenCloseListeners` | protected | | | | OverlayMixin |
|
|
31
48
|
| `_setupOverlayCtrl` | protected | | | | OverlayMixin |
|
|
49
|
+
| `_teardownOpenCloseListeners` | protected | | | | OverlayMixin |
|
|
32
50
|
| `_teardownOverlayCtrl` | protected | | | | OverlayMixin |
|
|
33
|
-
| `_setOpenedWithoutPropertyEffects` | protected | When the opened state is changed by an Application Developer,cthe OverlayController is
requested to show/hide. It might happen that this request is not honoured
(intercepted in before-hide for instance), so that we need to sync the controller state
to this webcomponent again, preventing eternal loops. | `newOpened: boolean` | | OverlayMixin |
|
|
34
|
-
| `toggle` | public | Toggles the overlay | | | OverlayMixin |
|
|
35
|
-
| `open` | public | Shows the overlay | | | OverlayMixin |
|
|
36
|
-
| `close` | public | Hides the overlay | | | OverlayMixin |
|
|
37
|
-
| `repositionOverlay` | public | Sometimes it's needed to recompute Popper position of an overlay, for instance when we have
an opened combobox and the surrounding context changes (the space consumed by the textbox
increases vertically) | | | OverlayMixin |
|
|
38
|
-
| `_isPermanentlyDisconnected` | protected | When we're moving around in dom, disconnectedCallback gets called.
Before we decide to teardown, let's wait to see if we were not just moving nodes around. | | `Promise<boolean>` | OverlayMixin |
|
|
39
51
|
|
|
40
52
|
### Events
|
|
41
53
|
|
|
@@ -1,4 +1,16 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- Tooltip
|
|
4
|
+
- Examples
|
|
5
|
+
title: 'Tooltip: Examples'
|
|
6
|
+
eleventyNavigation:
|
|
7
|
+
key: 'Tooltip: Examples'
|
|
8
|
+
order: 30
|
|
9
|
+
parent: Tooltip
|
|
10
|
+
title: Examples
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Tooltip: Examples
|
|
2
14
|
|
|
3
15
|
```js script
|
|
4
16
|
import { html } from '@mdjs/mdjs-preview';
|
|
@@ -1,4 +1,16 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- Tooltip
|
|
4
|
+
- Overview
|
|
5
|
+
title: 'Tooltip: Overview'
|
|
6
|
+
eleventyNavigation:
|
|
7
|
+
key: 'Tooltip: Overview'
|
|
8
|
+
order: 10
|
|
9
|
+
parent: Tooltip
|
|
10
|
+
title: Overview
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Tooltip: Overview
|
|
2
14
|
|
|
3
15
|
A web component used for basic popups on hover.
|
|
4
16
|
Its purpose is to show content appearing when the user hovers over an invoker element with the cursor or with the keyboard, or if the invoker element is focused.
|
|
@@ -1,4 +1,16 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- Tooltip
|
|
4
|
+
- Use Cases
|
|
5
|
+
title: 'Tooltip: Use Cases'
|
|
6
|
+
eleventyNavigation:
|
|
7
|
+
key: 'Tooltip: Use Cases'
|
|
8
|
+
order: 20
|
|
9
|
+
parent: Tooltip
|
|
10
|
+
title: Use Cases
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Tooltip: Use Cases
|
|
2
14
|
|
|
3
15
|
```js script
|
|
4
16
|
import { css, html } from '@mdjs/mdjs-preview';
|
|
@@ -9,11 +9,11 @@ Here you find more details about what we offer.
|
|
|
9
9
|
|
|
10
10
|
Let's see what each section describes.
|
|
11
11
|
|
|
12
|
-
1. [Systems](https://github.com/ing-bank/lion/blob/
|
|
12
|
+
1. [Systems](https://github.com/ing-bank/lion/blob/87a1cb4d5bec301af6688be2c7bf778344d2ae42/docs/fundamentals/systems/core/overview.md) <br>
|
|
13
13
|
These are the fundamental systems that power all of our components.
|
|
14
|
-
2. [Tools](https://github.com/ing-bank/lion/blob/
|
|
14
|
+
2. [Tools](https://github.com/ing-bank/lion/blob/87a1cb4d5bec301af6688be2c7bf778344d2ae42/docs/fundamentals/tools/helpers/overview.md) <br>
|
|
15
15
|
Frontend Tools useful for web development but are not visual and therefore are not components.
|
|
16
|
-
3. [Node Tools](https://github.com/ing-bank/lion/blob/
|
|
16
|
+
3. [Node Tools](https://github.com/ing-bank/lion/blob/87a1cb4d5bec301af6688be2c7bf778344d2ae42/docs/fundamentals/node-tools/babel-plugin-extend-docs/overview.md) <br>
|
|
17
17
|
Node tools to analyse the code and for extending the documentation.
|
|
18
|
-
4. [Rationales](https://github.com/ing-bank/lion/blob/
|
|
18
|
+
4. [Rationales](https://github.com/ing-bank/lion/blob/87a1cb4d5bec301af6688be2c7bf778344d2ae42/docs/fundamentals/rationales/side-effects.md) <br>
|
|
19
19
|
The reasoning behind some of our decisions.
|
|
@@ -1 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- Babel Extend Docs
|
|
4
|
+
- Node Tools
|
|
5
|
+
title: 'Node Tools: Babel Extend Docs'
|
|
6
|
+
eleventyNavigation:
|
|
7
|
+
key: Node Tools >> Babel Extend Docs
|
|
8
|
+
title: Babel Extend Docs
|
|
9
|
+
order: 10
|
|
10
|
+
parent: Node Tools
|
|
11
|
+
---
|
|
12
|
+
|
|
1
13
|
# Node Tools >> Babel Extend Docs ||10
|
|
@@ -1,3 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- Overview
|
|
4
|
+
- Babel Extend Docs
|
|
5
|
+
- Node Tools
|
|
6
|
+
title: 'Babel Extend Docs: Overview'
|
|
7
|
+
eleventyNavigation:
|
|
8
|
+
key: Node Tools >> Babel Extend Docs >> Overview
|
|
9
|
+
title: Overview
|
|
10
|
+
order: 10
|
|
11
|
+
parent: Node Tools >> Babel Extend Docs
|
|
12
|
+
---
|
|
13
|
+
|
|
1
14
|
# Node Tools >> Babel Extend Docs >> Overview ||10
|
|
2
15
|
|
|
3
16
|
A plugin which rewrites imports and templates according to a configuration.
|
|
@@ -1 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- Providence Analytics
|
|
4
|
+
- Node Tools
|
|
5
|
+
title: 'Node Tools: Providence Analytics'
|
|
6
|
+
eleventyNavigation:
|
|
7
|
+
key: Node Tools >> Providence Analytics
|
|
8
|
+
title: Providence Analytics
|
|
9
|
+
order: 20
|
|
10
|
+
parent: Node Tools
|
|
11
|
+
---
|
|
12
|
+
|
|
1
13
|
# Node Tools >> Providence Analytics ||20
|
|
@@ -1,3 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- Overview
|
|
4
|
+
- Providence Analytics
|
|
5
|
+
- Node Tools
|
|
6
|
+
title: 'Providence Analytics: Overview'
|
|
7
|
+
eleventyNavigation:
|
|
8
|
+
key: Node Tools >> Providence Analytics >> Overview
|
|
9
|
+
title: Overview
|
|
10
|
+
order: 10
|
|
11
|
+
parent: Node Tools >> Providence Analytics
|
|
12
|
+
---
|
|
13
|
+
|
|
1
14
|
# Node Tools >> Providence Analytics >> Overview ||10
|
|
2
15
|
|
|
3
16
|
```js script
|
|
@@ -1,3 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- Overview
|
|
4
|
+
- Publish Docs
|
|
5
|
+
- Node Tools
|
|
6
|
+
title: 'Publish Docs: Overview'
|
|
7
|
+
eleventyNavigation:
|
|
8
|
+
key: Node Tools >> Publish Docs >> Overview
|
|
9
|
+
title: Overview
|
|
10
|
+
order: 10
|
|
11
|
+
parent: Node Tools >> Publish Docs
|
|
12
|
+
---
|
|
13
|
+
|
|
1
14
|
# Node Tools >> Publish Docs >> Overview ||10
|
|
2
15
|
|
|
3
16
|
A tool that copies and processes your documentation (in a monorepo) so it can be published/shipped with your package.
|
|
@@ -31,7 +44,7 @@ For a Mono Repository
|
|
|
31
44
|
```md
|
|
32
45
|
# My Pkg
|
|
33
46
|
|
|
34
|
-
[=> See Source <=](https://github.com/ing-bank/lion/blob/
|
|
47
|
+
[=> See Source <=](https://github.com/ing-bank/lion/blob/87a1cb4d5bec301af6688be2c7bf778344d2ae42/docs/fundamentals/docs/deep/dir/overview.md)
|
|
35
48
|
```
|
|
36
49
|
|
|
37
50
|
## CLI flags
|
|
@@ -61,7 +74,7 @@ Bring the `overview.md` in a docs folder along.
|
|
|
61
74
|
👉 `packages/[my-package]/docs/overview.md`
|
|
62
75
|
|
|
63
76
|
```md
|
|
64
|
-
[=> See Source <=](https://github.com/ing-bank/lion/blob/
|
|
77
|
+
[=> See Source <=](https://github.com/ing-bank/lion/blob/87a1cb4d5bec301af6688be2c7bf778344d2ae42/docs/fundamentals/docs/deep/dir/overview.md)
|
|
65
78
|
```
|
|
66
79
|
|
|
67
80
|
Add a `use-cases.md`
|
|
@@ -69,7 +82,7 @@ Add a `use-cases.md`
|
|
|
69
82
|
👉 `packages/[my-package]/docs/use-cases.md`
|
|
70
83
|
|
|
71
84
|
```md
|
|
72
|
-
[=> See Source <=](https://github.com/ing-bank/lion/blob/
|
|
85
|
+
[=> See Source <=](https://github.com/ing-bank/lion/blob/87a1cb4d5bec301af6688be2c7bf778344d2ae42/docs/fundamentals/docs/deep/dir/use-cases.md)
|
|
73
86
|
```
|
|
74
87
|
|
|
75
88
|
So you will end up with something like this in your package.
|
|
@@ -1,3 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- Overview
|
|
4
|
+
- Remark Extend
|
|
5
|
+
- Node Tools
|
|
6
|
+
title: 'Remark Extend: Overview'
|
|
7
|
+
eleventyNavigation:
|
|
8
|
+
key: Node Tools >> Remark Extend >> Overview
|
|
9
|
+
title: Overview
|
|
10
|
+
order: 10
|
|
11
|
+
parent: Node Tools >> Remark Extend
|
|
12
|
+
---
|
|
13
|
+
|
|
1
14
|
# Node Tools >> Remark Extend >> Overview ||10
|
|
2
15
|
|
|
3
16
|
A plugin for remark to extend markdown by importing from source files.
|
|
@@ -1,3 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- Overview
|
|
4
|
+
- Extend Docs
|
|
5
|
+
- Node Tools
|
|
6
|
+
title: 'Extend Docs: Overview'
|
|
7
|
+
eleventyNavigation:
|
|
8
|
+
key: Node Tools >> Extend Docs >> Overview
|
|
9
|
+
title: Overview
|
|
10
|
+
order: 10
|
|
11
|
+
parent: Node Tools >> Extend Docs
|
|
12
|
+
---
|
|
13
|
+
|
|
1
14
|
# Node Tools >> Extend Docs >> Overview ||10
|
|
2
15
|
|
|
3
16
|
When maintaining your own extension layer of lion you most likely want to maintain a similar documentation.
|
|
@@ -7,7 +20,7 @@ To do this automatically you can use this preset for [rocket](https://rocket.mod
|
|
|
7
20
|
|
|
8
21
|
## Features
|
|
9
22
|
|
|
10
|
-
- Import lion documentation and adjust it using [remark-extend](https://github.com/ing-bank/lion/blob/
|
|
23
|
+
- Import lion documentation and adjust it using [remark-extend](https://github.com/ing-bank/lion/blob/87a1cb4d5bec301af6688be2c7bf778344d2ae42/docs/fundamentals/node-tools/remark-extend/overview.md)
|
|
11
24
|
- Renames named imports and all it's usage
|
|
12
25
|
- Adjusts import paths
|
|
13
26
|
- Replace tags in template literals
|
|
@@ -38,7 +51,7 @@ export default {
|
|
|
38
51
|
|
|
39
52
|
## Reusing documentation
|
|
40
53
|
|
|
41
|
-
To take an existing documentation you can "import" it using [remark-extend](https://github.com/ing-bank/lion/blob/
|
|
54
|
+
To take an existing documentation you can "import" it using [remark-extend](https://github.com/ing-bank/lion/blob/87a1cb4d5bec301af6688be2c7bf778344d2ae42/docs/fundamentals/node-tools/remark-extend/overview.md).
|
|
42
55
|
|
|
43
56
|
As an example you can create `docs/components/tabs/overview.md`.
|
|
44
57
|
|
|
@@ -1,3 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- TypeScript
|
|
4
|
+
- Rationales
|
|
5
|
+
title: 'Rationales: TypeScript'
|
|
6
|
+
eleventyNavigation:
|
|
7
|
+
key: Rationales >> TypeScript
|
|
8
|
+
title: TypeScript
|
|
9
|
+
order: 30
|
|
10
|
+
parent: Rationales
|
|
11
|
+
---
|
|
12
|
+
|
|
1
13
|
# Rationales >> TypeScript ||30
|
|
2
14
|
|
|
3
15
|
[TypeScript](https://www.typescriptlang.org) is superset of JavaScript and a popular tool for getting strongly typed syntax and better autocompletion in JavaScript.
|
|
@@ -1,3 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- Accessibility
|
|
4
|
+
- Rationales
|
|
5
|
+
title: 'Rationales: Accessibility'
|
|
6
|
+
eleventyNavigation:
|
|
7
|
+
key: Rationales >> Accessibility
|
|
8
|
+
title: Accessibility
|
|
9
|
+
order: 5
|
|
10
|
+
parent: Rationales
|
|
11
|
+
---
|
|
12
|
+
|
|
1
13
|
# Rationales >> Accessibility ||5
|
|
2
14
|
|
|
3
15
|
In Lion accessibility is a first class citizen. That means accessibility is never an afterthought.
|
|
@@ -25,4 +37,4 @@ Internally, we delegate all intricacies involved in managing light dom to SlotMi
|
|
|
25
37
|
SlotMixin automatically mediates between light dom provided by the user ('public slots') and light dom provided by the component author ('private slots').
|
|
26
38
|
Also, SlotMixin allows to hook into the reactive update loop of LitElement (automatically rerendering on property changes) and it automatically respects
|
|
27
39
|
the scoped registry belonging to the shadow root.
|
|
28
|
-
More details about SlotMixin can be found in the [SlotMixin documentation](https://github.com/ing-bank/lion/blob/
|
|
40
|
+
More details about SlotMixin can be found in the [SlotMixin documentation](https://github.com/ing-bank/lion/blob/87a1cb4d5bec301af6688be2c7bf778344d2ae42/docs/fundamentals/systems/core/SlotMixin.md)
|
|
@@ -1,3 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- Side Effects
|
|
4
|
+
- Rationales
|
|
5
|
+
title: 'Rationales: Side Effects'
|
|
6
|
+
eleventyNavigation:
|
|
7
|
+
key: Rationales >> Side Effects
|
|
8
|
+
title: Side Effects
|
|
9
|
+
order: 10
|
|
10
|
+
parent: Rationales
|
|
11
|
+
---
|
|
12
|
+
|
|
1
13
|
# Rationales >> Side Effects ||10
|
|
2
14
|
|
|
3
15
|
All our packages are side effect free due to the fact that es modules are always side effect free even when changing other es modules. Only code which accesses browser globals like `window`, `console` in the root of the module will be treated a side effect and always included.
|
|
@@ -1,3 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- Versioning Lion
|
|
4
|
+
- Rationales
|
|
5
|
+
title: 'Rationales: Versioning Lion'
|
|
6
|
+
eleventyNavigation:
|
|
7
|
+
key: Rationales >> Versioning Lion
|
|
8
|
+
title: Versioning Lion
|
|
9
|
+
order: 20
|
|
10
|
+
parent: Rationales
|
|
11
|
+
---
|
|
12
|
+
|
|
1
13
|
# Rationales >> Versioning Lion ||20
|
|
2
14
|
|
|
3
15
|
Since Lion is a monorepository where each package is published separately under the `@lion` scope, we have packages that depend on other packages.
|
|
@@ -1,3 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- SlotMixin
|
|
4
|
+
- Core
|
|
5
|
+
- Systems
|
|
6
|
+
title: 'Core: SlotMixin'
|
|
7
|
+
eleventyNavigation:
|
|
8
|
+
key: Systems >> Core >> SlotMixin
|
|
9
|
+
title: SlotMixin
|
|
10
|
+
order: 20
|
|
11
|
+
parent: Systems >> Core
|
|
12
|
+
---
|
|
13
|
+
|
|
1
14
|
# Systems >> Core >> SlotMixin ||20
|
|
2
15
|
|
|
3
16
|
The SlotMixin is made for solving accessibility challenges that inherently come with the usage of shadow dom.
|
|
@@ -152,4 +165,4 @@ This will make sure that the slot provided by the user always takes precedence a
|
|
|
152
165
|
|
|
153
166
|
### Default slot
|
|
154
167
|
|
|
155
|
-
As can be seen in the example of [SlotFunctionResults](https://github.com/ing-bank/lion/blob/
|
|
168
|
+
As can be seen in the example of [SlotFunctionResults](https://github.com/ing-bank/lion/blob/87a1cb4d5bec301af6688be2c7bf778344d2ae42/docs/fundamentals/systems/core/#slotfunctionresults), '' can be used to add content to the default slot
|
|
@@ -1,4 +1,17 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
|
+
parts:
|
|
3
|
+
- API Table
|
|
4
|
+
- Core
|
|
5
|
+
- Systems
|
|
6
|
+
title: 'Core: API Table'
|
|
7
|
+
eleventyNavigation:
|
|
8
|
+
key: API Table >> Core >> Systems
|
|
9
|
+
title: API Table
|
|
10
|
+
order: 90
|
|
11
|
+
parent: Systems >> Core
|
|
12
|
+
---
|
|
13
|
+
# Core: API Table
|
|
14
|
+
|
|
2
15
|
|
|
3
16
|
## class: `EventTargetShim`
|
|
4
17
|
|
|
@@ -7,8 +20,8 @@
|
|
|
7
20
|
| Name | Privacy | Type | Default | Description | Inherited From |
|
|
8
21
|
| --------------------- | ------- | ---- | ------------------------------ | ----------- | -------------- |
|
|
9
22
|
| `addEventListener` | public | | `delegatedAddEventListener` | | |
|
|
10
|
-
| `removeEventListener` | public | | `delegatedRemoveEventListener` | | |
|
|
11
23
|
| `dispatchEvent` | public | | `delegatedDispatchEvent` | | |
|
|
24
|
+
| `removeEventListener` | public | | `delegatedRemoveEventListener` | | |
|
|
12
25
|
|
|
13
26
|
<hr/>
|
|
14
27
|
|
|
@@ -17,18 +30,15 @@
|
|
|
17
30
|
|
|
18
31
|
### Fields
|
|
19
32
|
|
|
20
|
-
| Name | Privacy
|
|
21
|
-
| ------------- |
|
|
22
|
-
| `
|
|
23
|
-
| `scopedClass` | public | | `` `${this.host.localName}-${Math.floor(Math.random() * 10000)}` `` | | |
|
|
33
|
+
| Name | Privacy | Type | Default | Description | Inherited From |
|
|
34
|
+
| ------------- | ------- | ---- | ------------------------------------------------------------------- | ----------- | -------------- |
|
|
35
|
+
| `scopedClass` | public | | `` `${this.host.localName}-${Math.floor(Math.random() * 10000)}` `` | | |
|
|
24
36
|
|
|
25
37
|
### Methods
|
|
26
38
|
|
|
27
|
-
| Name
|
|
28
|
-
|
|
|
29
|
-
| `hostConnected`
|
|
30
|
-
| `hostDisconnected`
|
|
31
|
-
| `__setupStyleTag` | protected | | | | |
|
|
32
|
-
| `__teardownStyleTag` | protected | | | | |
|
|
39
|
+
| Name | Privacy | Description | Parameters | Return | Inherited From |
|
|
40
|
+
| ------------------ | ------- | ----------- | ---------- | ------ | -------------- |
|
|
41
|
+
| `hostConnected` | public | | | | |
|
|
42
|
+
| `hostDisconnected` | public | | | | |
|
|
33
43
|
|
|
34
44
|
<hr/>
|