@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
|
+
- API Table
|
|
4
|
+
- Select Rich
|
|
5
|
+
title: 'Select Rich: API Table'
|
|
6
|
+
eleventyNavigation:
|
|
7
|
+
key: API Table >> Select Rich
|
|
8
|
+
title: API Table
|
|
9
|
+
order: 90
|
|
10
|
+
parent: Select Rich
|
|
11
|
+
---
|
|
12
|
+
# Select Rich: API Table
|
|
13
|
+
|
|
2
14
|
|
|
3
15
|
## class: `LionSelectInvoker`, `lion-select-invoker`
|
|
4
16
|
|
|
@@ -6,29 +18,29 @@
|
|
|
6
18
|
|
|
7
19
|
| Name | Privacy | Type | Default | Description | Inherited From |
|
|
8
20
|
| ------------------------ | --------- | ------------------------ | ---------- | ------------------------------------------------------------------------------------------------------------------- | -------------- |
|
|
9
|
-
| `
|
|
21
|
+
| `active` | public | `boolean` | `false` | | LionButton |
|
|
22
|
+
| `disabled` | public | `boolean` | `false` | | LionButton |
|
|
23
|
+
| `hostElement` | public | `LionSelectRich \| null` | `null` | The LionSelectRich element this invoker is part of. Will be set on connectedCallback of
LionSelectRich | |
|
|
10
24
|
| `readOnly` | public | `boolean` | `false` | When the connected LionSelectRich instance is readOnly,
this should be reflected in the invoker as well | |
|
|
11
25
|
| `selectedElement` | public | `LionOption \| null` | `null` | The option element that is currently selected | |
|
|
12
|
-
| `hostElement` | public | `LionSelectRich \| null` | `null` | The LionSelectRich element this invoker is part of. Will be set on connectedCallback of
LionSelectRich | |
|
|
13
26
|
| `singleOption` | public | `boolean` | `false` | When the connected LionSelectRich instance has only one option,
this should be reflected in the invoker as well | |
|
|
14
|
-
| `type` | public | `string` | `'button'` | | LionButton |
|
|
15
27
|
| `tabIndex` | public | `number` | | | LionButton |
|
|
16
|
-
| `
|
|
17
|
-
| `disabled` | public | `boolean` | `false` | | LionButton |
|
|
18
|
-
| `active` | public | `boolean` | `false` | | LionButton |
|
|
28
|
+
| `type` | public | `string` | `'button'` | | LionButton |
|
|
19
29
|
| `_buttonId` | protected | | | | LionButton |
|
|
30
|
+
| `_contentWrapperNode` | protected | | | | |
|
|
31
|
+
| `_requestedToBeDisabled` | protected | `boolean` | `false` | | LionButton |
|
|
20
32
|
|
|
21
33
|
### Methods
|
|
22
34
|
|
|
23
35
|
| Name | Privacy | Description | Parameters | Return | Inherited From |
|
|
24
36
|
| ---------------------------- | --------- | ------------------------------------------------------------------------------------------------ | ---------- | -------------------------------------- | -------------- |
|
|
25
|
-
| `
|
|
26
|
-
| `_noSelectionTemplate` | protected | To be overriden for a placeholder, used when \`hasNoDefaultSelected\` is true on the select rich | | `TemplateResult` | |
|
|
27
|
-
| `_beforeTemplate` | protected | | | | |
|
|
28
|
-
| `_afterTemplate` | protected | | | | |
|
|
37
|
+
| `click` | public | | | | LionButton |
|
|
29
38
|
| `makeRequestToBeDisabled` | public | | | | LionButton |
|
|
30
39
|
| `retractRequestToBeDisabled` | public | | | | LionButton |
|
|
31
|
-
| `
|
|
40
|
+
| `_afterTemplate` | protected | | | | |
|
|
41
|
+
| `_beforeTemplate` | protected | | | | |
|
|
42
|
+
| `_contentTemplate` | protected | | | `TemplateResult\|Node[]\|string\|null` | |
|
|
43
|
+
| `_noSelectionTemplate` | protected | To be overriden for a placeholder, used when \`hasNoDefaultSelected\` is true on the select rich | | `TemplateResult` | |
|
|
32
44
|
|
|
33
45
|
### Attributes
|
|
34
46
|
|
|
@@ -52,188 +64,179 @@
|
|
|
52
64
|
|
|
53
65
|
| Name | Privacy | Type | Default | Description | Inherited From |
|
|
54
66
|
| ------------------------------ | --------- | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
|
|
55
|
-
| `slots` | public | `SlotsMap` | | Adds ".\_feedbackNode" as described below | LionListbox |
|
|
56
|
-
| `_invokerNode` | protected | `LionSelectInvoker` | | | |
|
|
57
|
-
| `_focusableNode` | protected | `HTMLElement` | | The focusable element:
could be an input, textarea, select, button or any other element with tabindex > -1 | LionListbox |
|
|
58
|
-
| `_scrollTargetNode` | protected | `HTMLElement` | | | LionListbox |
|
|
59
|
-
| `_overlayInvokerNode` | protected | | | | OverlayMixin |
|
|
60
|
-
| `_overlayContentNode` | protected | | | | OverlayMixin |
|
|
61
|
-
| `navigateWithinInvoker` | public | `Boolean` | `false` | When invoker has focus, up and down arrow keys changes active state of listbox,
without opening overlay. | |
|
|
62
|
-
| `interactionMode` | public | `'windows/linux'\|'mac'\|'auto'` | `'auto'` | Aligns behavior for 'selectionFollowFocus' and 'navigateWithinInvoker' with
platform. When 'auto' (default), platform is automatically detected | |
|
|
63
|
-
| `singleOption` | public | `boolean` | `false` | | |
|
|
64
|
-
| `_arrowWidth` | protected | `number` | `28` | | |
|
|
65
|
-
| `config` | public | `Partial<OverlayConfig>` | `{}` | Configure the many options of the \`OverlayController\` | OverlayMixin |
|
|
66
|
-
| `_overlayReferenceNode` | protected | | | | OverlayMixin |
|
|
67
|
-
| `_overlayBackdropNode` | protected | | | | OverlayMixin |
|
|
68
|
-
| `_overlayContentWrapperNode` | protected | | | | OverlayMixin |
|
|
69
|
-
| `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 |
|
|
70
|
-
| `_inputNode` | protected | | | The interactive (form) element. Can be a native element like input/textarea/select or
an element with tabindex > -1 | LionListbox |
|
|
71
|
-
| `_listboxNode` | protected | | | | LionListbox |
|
|
72
|
-
| `_listboxActiveDescendantNode` | protected | `HTMLElement` | | | LionListbox |
|
|
73
|
-
| `_listboxSlot` | protected | `HTMLElement` | | | LionListbox |
|
|
74
|
-
| `_activeDescendantOwnerNode` | protected | `HTMLElement` | | | LionListbox |
|
|
75
67
|
| `activeIndex` | public | | | | LionListbox |
|
|
68
|
+
| `autofocus` | public | `boolean` | `false` | | LionListbox |
|
|
76
69
|
| `checkedIndex` | public | `number \| number[]` | | | LionListbox |
|
|
70
|
+
| `config` | public | `Partial<OverlayConfig>` | `{}` | Configure the many options of the \`OverlayController\` | OverlayMixin |
|
|
71
|
+
| `defaultValidators` | public | `Validator[]` | `[]` | Used by Subclassers to add default Validators to a particular FormControl.
A date input for instance, always needs the isDate validator. | LionListbox |
|
|
72
|
+
| `dirty` | public | `boolean` | `false` | True when user has changed the value of the field. | LionListbox |
|
|
73
|
+
| `disabled` | public | `boolean` | `false` | | LionListbox |
|
|
74
|
+
| `done` | public | `boolean` | `false` | | LionListbox |
|
|
75
|
+
| `fieldName` | public | `string` | | Will be used in validation messages to refer to the current field | LionListbox |
|
|
76
|
+
| `filled` | public | `boolean` | `false` | True when the modelValue is non-empty (see \_isEmpty in FormControlMixin) | LionListbox |
|
|
77
|
+
| `focused` | public | `boolean` | `false` | Whether the focusable element within (\`.\_focusableNode\`) is focused.
Reflects to attribute '\[focused]' as a styling hook | LionListbox |
|
|
78
|
+
| `focusedVisible` | public | `boolean` | `false` | Whether the focusable element within (\`.\_focusableNode\`) matches ':focus-visible'
Reflects to attribute '\[focused-visible]' as a styling hook
See: https\://developer.mozilla.org/en-US/docs/Web/CSS/:focus-visible | LionListbox |
|
|
79
|
+
| `formattedValue` | public | | | | LionListbox |
|
|
80
|
+
| `formElements` | public | `FormControlsCollection` | `new FormControlsCollection()` | Closely mimics the natively supported HTMLFormControlsCollection. It can be accessed
both like an array and an object (based on control/element names). | LionListbox |
|
|
81
|
+
| `hasFeedbackFor` | public | `ValidationType[]` | `[]` | As soon as validation happens (after modelValue/validators/validator param change), this
array is updated with the active ValidationTypes ('error'\|'warning'\|'success'\|'info' etc.).
Notice the difference with \`.showsFeedbackFor\`, which filters \`.hasFeedbackFor\` based on
\`.feedbackCondition()\`.

For styling purposes, will be reflected to \[has-feedback-for="error warning"]. This can
be useful for subtle visual feedback on keyup, like a red/green border around an input. | LionListbox |
|
|
77
82
|
| `hasNoDefaultSelected` | public | `boolean` | `false` | When setting this to true, on initial render, no option will be selected.
It is advisable to override \`\_noSelectionTemplate\` method in the select-invoker
to render some kind of placeholder initially | LionListbox |
|
|
78
|
-
| `orientation` | public | `string` | `'vertical'` | Informs screen reader and affects keyboard navigation.
By default 'vertical' | LionListbox |
|
|
79
|
-
| `rotateKeyboardNavigation` | public | `boolean` | `false` | Will give first option active state when navigated to the next option from
last option. | LionListbox |
|
|
80
|
-
| `selectionFollowsFocus` | public | `boolean` | `false` | When true, will synchronize activedescendant and selected element on
arrow key navigation.
This behavior can usually be seen on \<select> on the Windows platform.
Note that this behavior cannot be used when multiple-choice is true.
See: https\://www\.w3.org/TR/wai-aria-practices/#kbd\_selection\_follows\_focus | LionListbox |
|
|
81
|
-
| `_noTypeAhead` | public | `boolean` | `false` | When false, a user can type on which the focus will jump to the matching option | LionListbox |
|
|
82
|
-
| `_typeAheadTimeout` | protected | `number` | `1000` | The pending char sequence that will set active list item | LionListbox |
|
|
83
|
-
| `_listboxActiveDescendant` | protected | `number \| null` | `null` | | LionListbox |
|
|
84
|
-
| `_repropagationRole` | public | `'child'\|'choice-group'\|'fieldset'` | `'choice-group'` | Based on the role, details of handling model-value-changed repropagation differ. | LionListbox |
|
|
85
|
-
| `_listboxReceivesNoFocus` | protected | `boolean` | `false` | When listbox is coupled to a textbox (in case we are dealing with a combobox),
spaces should not select an element (they need to be put in the textbox) | LionListbox |
|
|
86
|
-
| `_oldModelValue` | protected | `string \| string[] \| undefined` | `undefined` | | LionListbox |
|
|
87
|
-
| `label` | public | `string` | `''` | The label text for the input node.
When no value is defined, textContent of \[slot=label] will be used | LionListbox |
|
|
88
83
|
| `helpText` | public | `string` | `''` | The helpt text for the input node.
When no value is defined, textContent of \[slot=help-text] will be used | LionListbox |
|
|
89
|
-
| `
|
|
90
|
-
| `
|
|
91
|
-
| `
|
|
92
|
-
| `
|
|
93
|
-
| `readOnly` | public | `boolean` | `false` | A Boolean attribute which, if present, indicates that the user should not be able to edit
the value of the input. The difference between disabled and readonly is that read-only
controls can still function, whereas disabled controls generally do not function as
controls until they are enabled.
(From: https\://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-readonly) | LionListbox |
|
|
84
|
+
| `initComplete` | public | `Promise<any>` | `new Promise((resolve, reject) => { this.__resolveInitComplete = resolve; this.__rejectInitComplete = reject; })` | initComplete resolves after all pending initialization logic
(for instance \`\<form-group .serializedValue=${{ child1: 'a', child2: 'b' }}>\`)
is executed | LionListbox |
|
|
85
|
+
| `interactionMode` | public | `'windows/linux'\|'mac'\|'auto'` | `'auto'` | Aligns behavior for 'selectionFollowFocus' and 'navigateWithinInvoker' with
platform. When 'auto' (default), platform is automatically detected | |
|
|
86
|
+
| `isPending` | public | `boolean` | `false` | Flag indicating whether async validation is pending.
Creates attribute \[is-pending] as a styling hook | LionListbox |
|
|
87
|
+
| `label` | public | `string` | `''` | The label text for the input node.
When no value is defined, textContent of \[slot=label] will be used | LionListbox |
|
|
94
88
|
| `labelSrOnly` | public | `boolean` | `false` | The label will only be visible for srceen readers when true | LionListbox |
|
|
95
|
-
| `_inputId` | protected | `string` | | Unique id that can be used in all light dom | LionListbox |
|
|
96
|
-
| `_ariaLabelledNodes` | public | `HTMLElement[]` | `[]` | Contains all elements that should end up in aria-labelledby of \`.\_inputNode\` | LionListbox |
|
|
97
|
-
| `_ariaDescribedNodes` | public | `HTMLElement[]` | `[]` | Contains all elements that should end up in aria-describedby of \`.\_inputNode\` | LionListbox |
|
|
98
|
-
| `_isRepropagationEndpoint` | public | `boolean` | `false` | By default, a field with \_repropagationRole 'choice-group' will act as an
'endpoint'. This means it will be considered as an individual field: for
a select, individual options will not be part of the formPath. They
will.
Similarly, components that (a11y wise) need to be fieldsets, but 'interaction wise'
(from Application Developer perspective) need to be more like fields
(think of an amount-input with a currency select box next to it), can set this
to true to hide private internals in the formPath. | LionListbox |
|
|
99
89
|
| `modelValue` | public | | | | LionListbox |
|
|
100
|
-
| `serializedValue` | public | | | | LionListbox |
|
|
101
|
-
| `formattedValue` | public | | | | LionListbox |
|
|
102
|
-
| `operationMode` | public | `OperationMode` | | Types of input interaction of the FormControl (for instance 'enter'\|'select'\|'upload') | LionListbox |
|
|
103
90
|
| `multipleChoice` | public | `boolean` | `false` | When false (default), modelValue and serializedValue will reflect the
currently selected choice (usually a string). When true, modelValue will and
serializedValue will be an array of strings. | LionListbox |
|
|
104
|
-
| `
|
|
105
|
-
| `
|
|
106
|
-
| `
|
|
107
|
-
| `
|
|
108
|
-
| `done` | public | `boolean` | `false` | | LionListbox |
|
|
109
|
-
| `focused` | public | `boolean` | `false` | Whether the focusable element within (\`.\_focusableNode\`) is focused.
Reflects to attribute '\[focused]' as a styling hook | LionListbox |
|
|
110
|
-
| `focusedVisible` | public | `boolean` | `false` | Whether the focusable element within (\`.\_focusableNode\`) matches ':focus-visible'
Reflects to attribute '\[focused-visible]' as a styling hook
See: https\://developer.mozilla.org/en-US/docs/Web/CSS/:focus-visible | LionListbox |
|
|
111
|
-
| `autofocus` | public | `boolean` | `false` | | LionListbox |
|
|
112
|
-
| `_feedbackConditionMeta` | protected | | | Allows Subclassers to add meta info for feedbackCondition | LionListbox |
|
|
113
|
-
| `touched` | public | `boolean` | `false` | True when user has focused and left(blurred) the field. | LionListbox |
|
|
114
|
-
| `dirty` | public | `boolean` | `false` | True when user has changed the value of the field. | LionListbox |
|
|
91
|
+
| `navigateWithinInvoker` | public | `Boolean` | `false` | When invoker has focus, up and down arrow keys changes active state of listbox,
without opening overlay. | |
|
|
92
|
+
| `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 |
|
|
93
|
+
| `operationMode` | public | `OperationMode` | | Types of input interaction of the FormControl (for instance 'enter'\|'select'\|'upload') | LionListbox |
|
|
94
|
+
| `orientation` | public | `string` | `'vertical'` | Informs screen reader and affects keyboard navigation.
By default 'vertical' | LionListbox |
|
|
115
95
|
| `prefilled` | public | `boolean` | `false` | True when user has left non-empty field or input is prefilled.
The name must be seen from the point of view of the input field:
once the user enters the input field, the value is non-empty. | LionListbox |
|
|
116
|
-
| `
|
|
117
|
-
| `
|
|
118
|
-
| `
|
|
119
|
-
| `
|
|
120
|
-
| `
|
|
121
|
-
| `hasFeedbackFor` | public | `ValidationType[]` | `[]` | As soon as validation happens (after modelValue/validators/validator param change), this
array is updated with the active ValidationTypes ('error'\|'warning'\|'success'\|'info' etc.).
Notice the difference with \`.showsFeedbackFor\`, which filters \`.hasFeedbackFor\` based on
\`.feedbackCondition()\`.

For styling purposes, will be reflected to \[has-feedback-for="error warning"]. This can
be useful for subtle visual feedback on keyup, like a red/green border around an input. | LionListbox |
|
|
96
|
+
| `readOnly` | public | `boolean` | `false` | A Boolean attribute which, if present, indicates that the user should not be able to edit
the value of the input. The difference between disabled and readonly is that read-only
controls can still function, whereas disabled controls generally do not function as
controls until they are enabled.
(From: https\://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-readonly) | LionListbox |
|
|
97
|
+
| `registrationComplete` | public | `Promise<any> & {done?:boolean}` | `new Promise((resolve, reject) => { this.__resolveRegistrationComplete = resolve; this.__rejectRegistrationComplete = reject; })` | registrationComplete waits for all children formElements to have registered | LionListbox |
|
|
98
|
+
| `rotateKeyboardNavigation` | public | `boolean` | `false` | Will give first option active state when navigated to the next option from
last option. | LionListbox |
|
|
99
|
+
| `selectionFollowsFocus` | public | `boolean` | `false` | When true, will synchronize activedescendant and selected element on
arrow key navigation.
This behavior can usually be seen on \<select> on the Windows platform.
Note that this behavior cannot be used when multiple-choice is true.
See: https\://www\.w3.org/TR/wai-aria-practices/#kbd\_selection\_follows\_focus | LionListbox |
|
|
100
|
+
| `serializedValue` | public | | | | LionListbox |
|
|
122
101
|
| `showsFeedbackFor` | public | `ValidationType[]` | `[]` | Based on outcome of feedbackCondition, this array decides what ValidationTypes should be
shown in validationFeedback, based on meta data like interaction states.

For styling purposes, it reflects it \`\[shows-feedback-for="error warning"]\` | LionListbox |
|
|
102
|
+
| `singleOption` | public | `boolean` | `false` | | |
|
|
103
|
+
| `slots` | public | `SlotsMap` | | Adds ".\_feedbackNode" as described below | LionListbox |
|
|
104
|
+
| `submitted` | public | | | | LionListbox |
|
|
105
|
+
| `touched` | public | `boolean` | `false` | True when user has focused and left(blurred) the field. | LionListbox |
|
|
123
106
|
| `validationStates` | public | `ValidationStates` | `{}` | The outcome of a validation 'round'. Keyed by ValidationType and Validator name | LionListbox |
|
|
124
|
-
| `isPending` | public | `boolean` | `false` | Flag indicating whether async validation is pending.
Creates attribute \[is-pending] as a styling hook | LionListbox |
|
|
125
107
|
| `validators` | public | `Validator[]` | `[]` | Used by Application Developers to add Validators to a FormControl. | LionListbox |
|
|
126
|
-
| `
|
|
127
|
-
| `
|
|
128
|
-
| `
|
|
108
|
+
| `_activeDescendantOwnerNode` | protected | `HTMLElement` | | | LionListbox |
|
|
109
|
+
| `_allValidators` | protected | `Validator[]` | | Combination of validators provided by Application Developer and the default validators | LionListbox |
|
|
110
|
+
| `_ariaDescribedNodes` | public | `HTMLElement[]` | `[]` | Contains all elements that should end up in aria-describedby of \`.\_inputNode\` | LionListbox |
|
|
111
|
+
| `_ariaLabelledNodes` | public | `HTMLElement[]` | `[]` | Contains all elements that should end up in aria-labelledby of \`.\_inputNode\` | LionListbox |
|
|
112
|
+
| `_arrowWidth` | protected | `number` | `28` | | |
|
|
113
|
+
| `_feedbackConditionMeta` | protected | | | Allows Subclassers to add meta info for feedbackCondition | LionListbox |
|
|
114
|
+
| `_feedbackNode` | protected | | | Element where validation feedback will be rendered to | LionListbox |
|
|
115
|
+
| `_focusableNode` | protected | `HTMLElement` | | The focusable element:
could be an input, textarea, select, button or any other element with tabindex > -1 | LionListbox |
|
|
116
|
+
| `_helpTextNode` | protected | | | Element where help text will be rendered to | LionListbox |
|
|
117
|
+
| `_inputId` | protected | `string` | | Unique id that can be used in all light dom | LionListbox |
|
|
118
|
+
| `_inputNode` | protected | | | The interactive (form) element. Can be a native element like input/textarea/select or
an element with tabindex > -1 | LionListbox |
|
|
119
|
+
| `_invokerNode` | protected | `LionSelectInvoker` | | | |
|
|
120
|
+
| `_isFormOrFieldset` | protected | `boolean` | `false` | Flag that determines how ".formElements" should behave.
For a regular fieldset (see LionFieldset) we expect ".formElements"
to be accessible as an object.
In case of a radio-group, a checkbox-group or a select/listbox,
it should act like an array (see ChoiceGroupMixin).
Usually, when false, we deal with a choice-group (radio-group, checkbox-group,
(multi)select) | LionListbox |
|
|
121
|
+
| `_isRepropagationEndpoint` | public | `boolean` | `false` | By default, a field with \_repropagationRole 'choice-group' will act as an
'endpoint'. This means it will be considered as an individual field: for
a select, individual options will not be part of the formPath. They
will.
Similarly, components that (a11y wise) need to be fieldsets, but 'interaction wise'
(from Application Developer perspective) need to be more like fields
(think of an amount-input with a currency select box next to it), can set this
to true to hide private internals in the formPath. | LionListbox |
|
|
122
|
+
| `_labelNode` | protected | | | Element where label will be rendered to | LionListbox |
|
|
123
|
+
| `_leaveEvent` | protected | `string` | `'blur'` | The event that triggers the touched state | LionListbox |
|
|
124
|
+
| `_listboxActiveDescendant` | protected | `number \| null` | `null` | | LionListbox |
|
|
125
|
+
| `_listboxActiveDescendantNode` | protected | `HTMLElement` | | | LionListbox |
|
|
126
|
+
| `_listboxNode` | protected | | | | LionListbox |
|
|
127
|
+
| `_listboxReceivesNoFocus` | protected | `boolean` | `false` | When listbox is coupled to a textbox (in case we are dealing with a combobox),
spaces should not select an element (they need to be put in the textbox) | LionListbox |
|
|
128
|
+
| `_listboxSlot` | protected | `HTMLElement` | | | LionListbox |
|
|
129
|
+
| `_noTypeAhead` | public | `boolean` | `false` | When false, a user can type on which the focus will jump to the matching option | LionListbox |
|
|
130
|
+
| `_oldModelValue` | protected | `string \| string[] \| undefined` | `undefined` | | LionListbox |
|
|
131
|
+
| `_overlayBackdropNode` | protected | | | | OverlayMixin |
|
|
132
|
+
| `_overlayContentNode` | protected | | | | OverlayMixin |
|
|
133
|
+
| `_overlayContentWrapperNode` | protected | | | | OverlayMixin |
|
|
134
|
+
| `_overlayInvokerNode` | protected | | | | OverlayMixin |
|
|
135
|
+
| `_overlayReferenceNode` | protected | | | | OverlayMixin |
|
|
136
|
+
| `_repropagationRole` | public | `'child'\|'choice-group'\|'fieldset'` | `'choice-group'` | Based on the role, details of handling model-value-changed repropagation differ. | LionListbox |
|
|
129
137
|
| `_requestedToBeDisabled` | protected | `boolean` | `false` | | LionListbox |
|
|
130
|
-
| `
|
|
138
|
+
| `_scrollTargetNode` | protected | `HTMLElement` | | | LionListbox |
|
|
139
|
+
| `_typeAheadTimeout` | protected | `number` | `1000` | The pending char sequence that will set active list item | LionListbox |
|
|
140
|
+
| `_valueChangedEvent` | protected | `string` | `'model-value-changed'` | The event that triggers the dirty state | LionListbox |
|
|
141
|
+
| `_visibleMessagesAmount` | protected | `number` | `1` | The amount of feedback messages that will visible in LionValidationFeedback | LionListbox |
|
|
131
142
|
|
|
132
143
|
### Methods
|
|
133
144
|
|
|
134
|
-
| Name | Privacy | Description | Parameters
|
|
135
|
-
| ---------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
136
|
-
| `
|
|
137
|
-
| `
|
|
138
|
-
| `
|
|
139
|
-
| `
|
|
140
|
-
| `
|
|
141
|
-
| `
|
|
142
|
-
| `
|
|
143
|
-
| `
|
|
144
|
-
| `
|
|
145
|
-
| `
|
|
146
|
-
| `
|
|
147
|
-
| `
|
|
148
|
-
| `
|
|
149
|
-
| `
|
|
150
|
-
| `
|
|
151
|
-
| `
|
|
152
|
-
| `
|
|
153
|
-
|
|
154
|
-
| `
|
|
155
|
-
| `
|
|
156
|
-
| `
|
|
157
|
-
| `
|
|
158
|
-
| `
|
|
159
|
-
| `
|
|
160
|
-
| `
|
|
161
|
-
| `
|
|
162
|
-
| `
|
|
163
|
-
| `
|
|
164
|
-
| `
|
|
165
|
-
| `
|
|
166
|
-
| `
|
|
167
|
-
| `
|
|
168
|
-
| `
|
|
169
|
-
| `
|
|
170
|
-
| `
|
|
171
|
-
| `
|
|
172
|
-
| `
|
|
173
|
-
| `
|
|
174
|
-
| `
|
|
175
|
-
| `
|
|
176
|
-
| `
|
|
177
|
-
| `
|
|
178
|
-
| `
|
|
179
|
-
| `
|
|
180
|
-
| `
|
|
181
|
-
| `
|
|
182
|
-
| `
|
|
183
|
-
| `
|
|
184
|
-
| `
|
|
185
|
-
| `
|
|
186
|
-
| `
|
|
187
|
-
| `
|
|
188
|
-
| `
|
|
189
|
-
| `
|
|
190
|
-
| `_inputGroupTemplate` | protected | |
|
|
191
|
-
| `
|
|
192
|
-
| `
|
|
193
|
-
| `
|
|
194
|
-
| `
|
|
195
|
-
| `
|
|
196
|
-
| `
|
|
197
|
-
| `
|
|
198
|
-
| `
|
|
199
|
-
| `
|
|
200
|
-
| `
|
|
201
|
-
| `
|
|
202
|
-
| `
|
|
203
|
-
| `
|
|
204
|
-
| `
|
|
205
|
-
| `
|
|
206
|
-
| `
|
|
207
|
-
| `
|
|
208
|
-
| `
|
|
209
|
-
| `
|
|
210
|
-
| `
|
|
211
|
-
| `
|
|
212
|
-
| `
|
|
213
|
-
| `
|
|
214
|
-
| `
|
|
215
|
-
| `
|
|
216
|
-
| `
|
|
217
|
-
| `
|
|
218
|
-
| `
|
|
219
|
-
| `
|
|
220
|
-
| `
|
|
221
|
-
| `
|
|
222
|
-
| `
|
|
223
|
-
| `
|
|
224
|
-
| `
|
|
225
|
-
| `
|
|
226
|
-
| `
|
|
227
|
-
| `
|
|
228
|
-
| `
|
|
229
|
-
| `_updateFeedbackComponent` | protected | Responsible for retrieving messages from Validators and
(delegation of) rendering them.

For \`.\_feedbackNode\` (extension of LionValidationFeedback):
- retrieve messages from highest prio Validators
- provide the result to custom feedback node and let the
custom node decide on their renderings

In both cases:
- we compute the 'show' flag (like 'hasErrorVisible') for all types
- we set the customValidity message of the highest prio Validator
- we set aria-invalid="true" in case hasErrorVisible is true | | | LionListbox |
|
|
230
|
-
| `feedbackCondition` | public | Allows the Application Developer to specify when a feedback message should be shown | `type: string, meta: object, currentCondition: ((type: string, meta: object) => boolean)` | `boolean` | LionListbox |
|
|
231
|
-
| `_hasFeedbackVisibleFor` | protected | Used to translate \`.hasFeedbackFor\` and \`.shouldShowFeedbackFor\` to \`.showsFeedbackFor\` | `type: string` | | LionListbox |
|
|
232
|
-
| `_updateShouldShowFeedbackFor` | protected | | | | LionListbox |
|
|
233
|
-
| `_prioritizeAndFilterFeedback` | protected | Orders all active validators in this.\_\_validationResult.
Can also filter out occurrences (based on interaction states) | `{ validationResult }, opts: { validationResult: Validator[] }` | `Validator[]` | LionListbox |
|
|
234
|
-
| `makeRequestToBeDisabled` | public | | | | LionListbox |
|
|
235
|
-
| `retractRequestToBeDisabled` | public | | | | LionListbox |
|
|
236
|
-
| `click` | public | | | | LionListbox |
|
|
145
|
+
| Name | Privacy | Description | Parameters | Return | Inherited From |
|
|
146
|
+
| ---------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | --------------------------- | -------------- |
|
|
147
|
+
| `addFormElement` | public | | `child: LionOption & FormControlHost, indexToInsertAt: Number` | | LionListbox |
|
|
148
|
+
| `addToAriaDescribedBy` | public | Allows to add element references to aria-describedby attribute. | `element: HTMLElement, { idPrefix = '', reorder = true }, customConfig: {idPrefix?:string; reorder?: boolean}` | | LionListbox |
|
|
149
|
+
| `addToAriaLabelledBy` | public | Allows to add extra element references to aria-labelledby attribute. | `element: HTMLElement, { idPrefix = '', reorder = true }, customConfig: {idPrefix?:string; reorder?: boolean}` | | LionListbox |
|
|
150
|
+
| `attachShadow` | public | | `options: ShadowRootInit` | `ShadowRoot` | LionListbox |
|
|
151
|
+
| `blur` | public | Calls \`blur()\` on focusable element within | | | LionListbox |
|
|
152
|
+
| `clear` | public | | | | LionListbox |
|
|
153
|
+
| `click` | public | | | | LionListbox |
|
|
154
|
+
| `close` | public | Hides the overlay | | | OverlayMixin |
|
|
155
|
+
| `createScopedElement` | public | | `tagName` | | LionListbox |
|
|
156
|
+
| `defineScopedElement` | public | Defines a scoped element. | `tagName: string, classToBeRegistered: typeof HTMLElement` | | LionListbox |
|
|
157
|
+
| `feedbackCondition` | public | Allows the Application Developer to specify when a feedback message should be shown | `type: string, meta: object, currentCondition: ((type: string, meta: object) => boolean)` | `boolean` | LionListbox |
|
|
158
|
+
| `focus` | public | Calls \`focus()\` on focusable element within | | | LionListbox |
|
|
159
|
+
| `initInteractionState` | public | Evaluations performed on connectedCallback.
This method is public, so it can be called at a later moment (when we need to wait for
registering children for instance) as well.
Since this method will be called twice in last mentioned scenario, it must stay idempotent. | | | LionListbox |
|
|
160
|
+
| `isRegisteredFormElement` | public | | `el: ElementWithParentFormGroup` | | LionListbox |
|
|
161
|
+
| `makeRequestToBeDisabled` | public | | | | LionListbox |
|
|
162
|
+
| `open` | public | Shows the overlay | | | OverlayMixin |
|
|
163
|
+
| `removeFormElement` | public | | `child: FormRegisteringHost` | | LionListbox |
|
|
164
|
+
| `removeFromAriaDescribedBy` | public | Allows to remove element references from aria-describedby attribute. | `element: HTMLElement` | | LionListbox |
|
|
165
|
+
| `removeFromAriaLabelledBy` | public | Allows to remove element references from aria-labelledby attribute. | `element: HTMLElement` | | LionListbox |
|
|
166
|
+
| `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 |
|
|
167
|
+
| `reset` | public | | | | LionListbox |
|
|
168
|
+
| `resetInteractionState` | public | Resets touched and dirty, and recomputes prefilled | | | LionListbox |
|
|
169
|
+
| `retractRequestToBeDisabled` | public | | | | LionListbox |
|
|
170
|
+
| `setCheckedIndex` | public | If an array is passed for multiple-choice, it will check the indexes in array, and uncheck the rest
If a number is passed, the item with the passed index is checked without unchecking others
For single choice, \_\_onChildCheckedChanged we ensure that we uncheck siblings | `index: number\|number[]` | | LionListbox |
|
|
171
|
+
| `toggle` | public | Toggles the overlay | | | OverlayMixin |
|
|
172
|
+
| `updateSync` | public | An abstraction that has the exact same api as \`requestUpdate\`, but taking
into account:
- \[member order independence]\(https\://github.com/webcomponents/gold-standard/wiki/Member-Order-Independence)
- property effects start when all (light) dom has initialized (on firstUpdated)
- property effects don't interrupt the first meaningful paint
- compatible with propertyAccessor.\`hasChanged\`: no manual checks needed or accidentally
run property effects / events when no change happened
effects when values didn't change
All code previously present in requestUpdate can be placed in this method. | `name: string, oldValue: ?` | | LionListbox |
|
|
173
|
+
| `validate` | public | Triggered by:
 \- modelValue change
 \- change in the 'validators' array
 \- change in the config of an individual Validator

Three situations are handled:
- a1) the FormControl is empty: further execution is halted. When the Required Validator
(being mutually exclusive to the other Validators) is applied, it will end up in the
validation result (as the only Validator, since further execution was halted).
- a2) there are synchronous Validators: this is the most common flow. When modelValue hasn't
changed since last async results were generated, 'sync results' are merged with the
'async results'.
- a3) there are asynchronous Validators: for instance when server side evaluation is needed.
Executions are scheduled and awaited and the 'async results' are merged with the
'sync results'.

- b) there are MetaValidators. After steps a1, a2, or a3 are finished, the holistic
MetaValidators (evaluating the total result of the 'regular' (a1, a2 and a3) validators)
will be run...

Situations a2 and a3 are not mutually exclusive and can be triggered within one \`validate()\`
call. Situation b will occur after every call. | `{ clearCurrentResult = false }, opts: { clearCurrentResult?: boolean }` | | LionListbox |
|
|
174
|
+
| `_alignInvokerWidth` | protected | Align invoker width with content width
Make sure display is not set to "none" while calculating the content width | | | |
|
|
175
|
+
| `_checkSingleChoiceElements` | protected | | `ev: CustomEvent & {target:FormControl}` | | LionListbox |
|
|
176
|
+
| `_completeRegistration` | protected | Resolves the registrationComplete promise. Subclassers can delay if needed | | | LionListbox |
|
|
177
|
+
| `_connectSlotMixin` | protected | | | | LionListbox |
|
|
178
|
+
| `_defineOverlay` | protected | | `{ contentNode, invokerNode, referenceNode, backdropNode, contentWrapperNode }, config: DefineOverlayConfig` | `OverlayController` | OverlayMixin |
|
|
179
|
+
| `_defineOverlayConfig` | protected | | | `OverlayConfig` | OverlayMixin |
|
|
180
|
+
| `_dispatchInitialModelValueChangedEvent` | protected | | | | LionListbox |
|
|
181
|
+
| `_enhanceLightDomA11y` | protected | | | | LionListbox |
|
|
182
|
+
| `_enhanceLightDomA11yForAdditionalSlots` | protected | Enhances additional slots(prefix, suffix, before, after) defined by developer.

When boolean attribute data-label or data-description is found,
the slot element will be connected to the input via aria-labelledby or aria-describedby | `additionalSlots: string[]` | | LionListbox |
|
|
183
|
+
| `_enhanceLightDomClasses` | protected | | | | LionListbox |
|
|
184
|
+
| `_feedbackTemplate` | protected | | | `TemplateResult` | LionListbox |
|
|
185
|
+
| `_getAriaDescriptionElements` | protected | This function exposes descripion elements that a FormGroup should expose to its
children. See FormGroupMixin.\_\_getAllDescriptionElementsInParentChain() | | `Array.<HTMLElement>` | LionListbox |
|
|
186
|
+
| `_getCheckedElements` | protected | In the select disabled options are still going to a possible value for example
when prefilling or programmatically setting it. | | | LionListbox |
|
|
187
|
+
| `_getFromAllFormElements` | protected | Implicit :( | `property: string, filterFn: (el: FormControl, property?: string) => boolean` | `{[name:string]: any}` | LionListbox |
|
|
188
|
+
| `_getFromAllFormElementsFilter` | protected | A filter function which will exclude a form field when returning false
By default, exclude form fields which are disabled

The type is be passed as well for more fine grained control, e.g.
distinguish the filter when fetching modelValue versus serializedValue | `el: FormControl, type: string` | `boolean` | LionListbox |
|
|
189
|
+
| `_getNextEnabledOption` | protected | | `currentIndex: number, offset: number` | | LionListbox |
|
|
190
|
+
| `_getPreviousEnabledOption` | protected | | `currentIndex: number, offset: number` | | LionListbox |
|
|
191
|
+
| `_groupOneTemplate` | protected | | | `TemplateResult` | LionListbox |
|
|
192
|
+
| `_groupTwoTemplate` | protected | | | `TemplateResult` | LionListbox |
|
|
193
|
+
| `_handleTypeAhead` | protected | | `ev: KeyboardEvent, { setAsChecked }, options: {setAsChecked:boolean}` | | LionListbox |
|
|
194
|
+
| `_hasFeedbackVisibleFor` | protected | Used to translate \`.hasFeedbackFor\` and \`.shouldShowFeedbackFor\` to \`.showsFeedbackFor\` | `type: string` | | LionListbox |
|
|
195
|
+
| `_helpTextTemplate` | protected | | | `TemplateResult` | LionListbox |
|
|
196
|
+
| `_inputGroupAfterTemplate` | protected | | | `TemplateResult` | LionListbox |
|
|
197
|
+
| `_inputGroupBeforeTemplate` | protected | | | `TemplateResult` | LionListbox |
|
|
198
|
+
| `_inputGroupInputTemplate` | protected | | | `TemplateResult` | LionListbox |
|
|
199
|
+
| `_inputGroupPrefixTemplate` | protected | | | `TemplateResult \| nothing` | LionListbox |
|
|
200
|
+
| `_inputGroupSuffixTemplate` | protected | | | `TemplateResult \| nothing` | LionListbox |
|
|
201
|
+
| `_inputGroupTemplate` | protected | | | `TemplateResult` | LionListbox |
|
|
202
|
+
| `_isEmpty` | protected | Used for Required validation and computation of interaction states | `modelValue: any` | `boolean` | LionListbox |
|
|
203
|
+
| `_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 |
|
|
204
|
+
| `_isPrivateSlot` | protected | | `slotName: string` | `boolean` | LionListbox |
|
|
205
|
+
| `_iStateOnLeave` | protected | Sets touched value to true and reevaluates prefilled state.
When false, on next interaction, user will start with a clean state. | | | LionListbox |
|
|
206
|
+
| `_iStateOnValueChange` | protected | Sets dirty value and validates when already touched or invalid | | | LionListbox |
|
|
207
|
+
| `_labelTemplate` | protected | | | `TemplateResult` | LionListbox |
|
|
208
|
+
| `_listboxOnClick` | protected | | `ev: MouseEvent` | | LionListbox |
|
|
209
|
+
| `_listboxOnKeyDown` | protected | | `ev: KeyboardEvent` | | LionListbox |
|
|
210
|
+
| `_listboxOnKeyUp` | protected | | `ev: KeyboardEvent` | | LionListbox |
|
|
211
|
+
| `_noDefaultSelectedInheritsWidth` | protected | With no selected element, we should override the inheritsReferenceWidth in most cases.
By default, we will set it to 'min', and then set it back to what it was initially when
something is selected.
As a subclasser you can override this behavior. | | | |
|
|
212
|
+
| `_onBeforeRepropagateChildrenValues` | protected | Hook for Subclassers to add logic before repropagation | `ev: CustomEvent` | | LionListbox |
|
|
213
|
+
| `_onChildActiveChanged` | protected | | `{ target }, ev: Event & { target: LionOption }` | | LionListbox |
|
|
214
|
+
| `_onDirtyChanged` | protected | Dispatches event on touched state change | | | LionListbox |
|
|
215
|
+
| `_onFormElementsChanged` | protected | | | | |
|
|
216
|
+
| `_onLabelClick` | protected | | | | LionListbox |
|
|
217
|
+
| `_onListboxContentChanged` | protected | A Subclasser can perform additional logic whenever the elements inside the listbox are
updated. For instance, when a combobox does server side autocomplete, we want to
match highlighted parts client side. | | | LionListbox |
|
|
218
|
+
| `_onRequestToAddFormElement` | protected | Hook for Subclassers to perform logic before an element is added | `ev: CustomEvent` | | LionListbox |
|
|
219
|
+
| `_onRequestToChangeFormElementName` | protected | | `ev: CustomEvent` | | LionListbox |
|
|
220
|
+
| `_onRequestToRemoveFormElement` | protected | | `ev: CustomEvent` | | LionListbox |
|
|
221
|
+
| `_onTouchedChanged` | protected | Dispatches event on touched state change | | | LionListbox |
|
|
222
|
+
| `_onValidatorUpdated` | protected | | `e: Event\|CustomEvent` | | LionListbox |
|
|
223
|
+
| `_prioritizeAndFilterFeedback` | protected | Orders all active validators in this.\_\_validationResult.
Can also filter out occurrences (based on interaction states) | `{ validationResult }, opts: { validationResult: Validator[] }` | `Validator[]` | LionListbox |
|
|
224
|
+
| `_repropagationCondition` | protected | Based on provided target, this condition determines whether received model-value-changed
event should be repropagated | `target: FormControlHost` | | LionListbox |
|
|
225
|
+
| `_scrollIntoView` | protected | | `el: HTMLElement, scrollTargetEl: HTMLElement` | | LionListbox |
|
|
226
|
+
| `_setCheckedElements` | protected | | `value: string \| any[], check: Function` | | LionListbox |
|
|
227
|
+
| `_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 |
|
|
228
|
+
| `_setupListboxNode` | protected | | | | LionListbox |
|
|
229
|
+
| `_setupOpenCloseListeners` | protected | | | | OverlayMixin |
|
|
230
|
+
| `_setupOverlayCtrl` | protected | | | | OverlayMixin |
|
|
231
|
+
| `_showFeedbackConditionFor` | protected | Default feedbackCondition condition, used by Subclassers, that will be used when
\`feedbackCondition()\` is not overridden by Application Developer.
Show the validity feedback when returning true, don't show when false | `type: string, meta: InteractionStates` | | LionListbox |
|
|
232
|
+
| `_teardownListboxNode` | protected | | | | LionListbox |
|
|
233
|
+
| `_teardownOpenCloseListeners` | protected | | | | OverlayMixin |
|
|
234
|
+
| `_teardownOverlayCtrl` | protected | | | | OverlayMixin |
|
|
235
|
+
| `_throwWhenInvalidChildModelValue` | protected | | `child: FormControl` | | LionListbox |
|
|
236
|
+
| `_triggerInitialModelValueChangedEvent` | protected | | | | LionListbox |
|
|
237
|
+
| `_uncheckChildren` | protected | | `exclude: LionOption\|LionOption[]` | | LionListbox |
|
|
238
|
+
| `_updateFeedbackComponent` | protected | Responsible for retrieving messages from Validators and
(delegation of) rendering them.

For \`.\_feedbackNode\` (extension of LionValidationFeedback):
- retrieve messages from highest prio Validators
- provide the result to custom feedback node and let the
custom node decide on their renderings

In both cases:
- we compute the 'show' flag (like 'hasErrorVisible') for all types
- we set the customValidity message of the highest prio Validator
- we set aria-invalid="true" in case hasErrorVisible is true | | | LionListbox |
|
|
239
|
+
| `_updateShouldShowFeedbackFor` | protected | | | | LionListbox |
|
|
237
240
|
|
|
238
241
|
### Events
|
|
239
242
|
|