@lion/ui 0.4.2 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/components/calendar/src/LionCalendar.js +1 -1
- package/components/calendar/test-helpers/DayObject.js +2 -2
- package/components/combobox/src/LionCombobox.js +79 -28
- package/components/combobox/test/lion-combobox-integrations.test.js +5 -0
- package/components/combobox/test/lion-combobox.test.js +290 -23
- package/components/combobox/test-helpers/combobox-helpers.js +5 -2
- package/components/drawer/src/LionDrawer.js +1 -0
- package/components/form-core/src/FocusMixin.js +2 -0
- package/components/form-core/src/FormControlMixin.js +1 -1
- package/components/form-core/src/choice-group/ChoiceGroupMixin.js +1 -0
- package/components/form-core/src/choice-group/CustomChoiceGroupMixin.js +173 -0
- package/components/form-core/src/utils/getAriaElementsInRightDomOrder.js +7 -14
- package/components/form-core/src/validate/validators/Required.js +2 -2
- package/components/form-core/test/choice-group/CustomChoiceGroupMixin.integrations.test.js +55 -0
- package/components/form-core/test/choice-group/CustomChoiceGroupMixin.test.js +16 -0
- package/components/form-core/test/utils/getAriaElementsInRightDomOrder.test.js +0 -25
- package/components/form-core/test/validate/StringValidators.test.js +1 -1
- package/components/form-core/test-helpers/ExampleValidators.js +1 -3
- package/components/form-core/test-suites/FormRegistrationMixins.suite.js +2 -0
- package/components/form-core/test-suites/NativeTextFieldMixin.suite.js +4 -4
- package/components/form-core/test-suites/ValidateMixin.suite.js +27 -0
- package/components/form-core/test-suites/ValidateMixinFeedbackPart.suite.js +11 -2
- package/components/form-core/test-suites/choice-group/ChoiceGroupMixin.suite.js +1 -0
- package/components/form-core/test-suites/choice-group/CustomChoiceGroupMixin.suite.js +265 -0
- package/components/form-core/types/choice-group/ChoiceGroupMixinTypes.ts +1 -1
- package/components/form-core/types/choice-group/CustomChoiceGroupMixinTypes.ts +30 -0
- package/components/form-core/types/choice-group/index.ts +1 -0
- package/components/helpers/src/SbActionLogger.js +1 -0
- package/components/icon/src/LionIcon.js +1 -9
- package/components/icon/test/lion-icon.test.js +2 -0
- package/components/input-range/test/lion-input-range.test.js +12 -6
- package/components/listbox/src/LionOptions.js +5 -5
- package/components/listbox/src/ListboxMixin.js +1 -16
- package/components/listbox/test/lion-options.test.js +1 -1
- package/components/listbox/test-suites/ListboxMixin.suite.js +1 -1
- package/components/localize/src/date/getMonthNames.js +3 -0
- package/components/localize/src/date/utils/forceDotsForNlnl.js +11 -0
- package/components/localize/src/number/utils/normalize-format-number-to-parts/forceAddGroupSeparators.js +3 -1
- package/components/localize/src/number/utils/normalize-format-number-to-parts/forceSymbols.js +2 -0
- package/components/localize/src/number/utils/normalize-format-number-to-parts/normalizeIntl.js +1 -0
- package/components/localize/test/date/getMonthNames.test.js +1 -0
- package/components/localize/test-helpers/fake-imports.js +1 -0
- package/components/radio-group/src/LionRadioGroup.js +1 -1
- package/components/radio-group/test/lion-radio-group.test.js +29 -0
- package/components/select/test/lion-select.test.js +1 -1
- package/components/switch/src/LionSwitchButton.js +1 -5
- package/components/tabs/src/LionTabs.js +7 -7
- package/components/textarea/src/LionTextarea.js +1 -1
- package/custom-elements.json +102923 -61581
- package/dist-types/components/combobox/src/LionCombobox.d.ts +13 -8
- package/dist-types/components/combobox/src/LionCombobox.d.ts.map +1 -1
- package/dist-types/components/combobox/test-helpers/combobox-helpers.d.ts.map +1 -1
- package/dist-types/components/drawer/src/LionDrawer.d.ts.map +1 -1
- package/dist-types/components/form-core/src/FocusMixin.d.ts.map +1 -1
- package/dist-types/components/form-core/src/choice-group/ChoiceGroupMixin.d.ts.map +1 -1
- package/dist-types/components/form-core/src/choice-group/CustomChoiceGroupMixin.d.ts +4 -0
- package/dist-types/components/form-core/src/choice-group/CustomChoiceGroupMixin.d.ts.map +1 -0
- package/dist-types/components/form-core/src/utils/getAriaElementsInRightDomOrder.d.ts +5 -5
- package/dist-types/components/form-core/src/utils/getAriaElementsInRightDomOrder.d.ts.map +1 -1
- package/dist-types/components/form-core/test/choice-group/CustomChoiceGroupMixin.integrations.test.d.ts +2 -0
- package/dist-types/components/form-core/test/choice-group/CustomChoiceGroupMixin.integrations.test.d.ts.map +1 -0
- package/dist-types/components/form-core/test/choice-group/CustomChoiceGroupMixin.test.d.ts +6 -0
- package/dist-types/components/form-core/test/choice-group/CustomChoiceGroupMixin.test.d.ts.map +1 -0
- package/dist-types/components/form-core/test-helpers/ExampleValidators.d.ts +0 -1
- package/dist-types/components/form-core/test-helpers/ExampleValidators.d.ts.map +1 -1
- package/dist-types/components/form-core/test-suites/FormRegistrationMixins.suite.d.ts.map +1 -1
- package/dist-types/components/form-core/test-suites/ValidateMixin.suite.d.ts.map +1 -1
- package/dist-types/components/form-core/test-suites/ValidateMixinFeedbackPart.suite.d.ts.map +1 -1
- package/dist-types/components/form-core/test-suites/choice-group/ChoiceGroupMixin.suite.d.ts.map +1 -1
- package/dist-types/components/form-core/test-suites/choice-group/CustomChoiceGroupMixin.suite.d.ts +14 -0
- package/dist-types/components/form-core/test-suites/choice-group/CustomChoiceGroupMixin.suite.d.ts.map +1 -0
- package/dist-types/components/form-core/types/choice-group/ChoiceGroupMixinTypes.d.ts +1 -1
- package/dist-types/components/form-core/types/choice-group/ChoiceGroupMixinTypes.d.ts.map +1 -1
- package/dist-types/components/form-core/types/choice-group/CustomChoiceGroupMixinTypes.d.ts +18 -0
- package/dist-types/components/form-core/types/choice-group/CustomChoiceGroupMixinTypes.d.ts.map +1 -0
- package/dist-types/components/form-core/types/choice-group/index.d.ts +1 -0
- package/dist-types/components/form-core/types/choice-group/index.d.ts.map +1 -1
- package/dist-types/components/helpers/src/SbActionLogger.d.ts.map +1 -1
- package/dist-types/components/icon/src/LionIcon.d.ts +0 -9
- package/dist-types/components/icon/src/LionIcon.d.ts.map +1 -1
- package/dist-types/components/listbox/src/LionOptions.d.ts +0 -5
- package/dist-types/components/listbox/src/LionOptions.d.ts.map +1 -1
- package/dist-types/components/listbox/src/ListboxMixin.d.ts.map +1 -1
- package/dist-types/components/localize/src/date/getMonthNames.d.ts.map +1 -1
- package/dist-types/components/localize/src/date/utils/forceDotsForNlnl.d.ts +5 -0
- package/dist-types/components/localize/src/date/utils/forceDotsForNlnl.d.ts.map +1 -0
- package/dist-types/components/localize/src/number/utils/normalize-format-number-to-parts/forceAddGroupSeparators.d.ts.map +1 -1
- package/dist-types/components/localize/src/number/utils/normalize-format-number-to-parts/forceSymbols.d.ts.map +1 -1
- package/dist-types/components/localize/src/number/utils/normalize-format-number-to-parts/normalizeIntl.d.ts.map +1 -1
- package/dist-types/components/localize/test-helpers/fake-imports.d.ts.map +1 -1
- package/dist-types/components/switch/src/LionSwitchButton.d.ts +0 -5
- package/dist-types/components/switch/src/LionSwitchButton.d.ts.map +1 -1
- package/dist-types/components/tabs/src/LionTabs.d.ts.map +1 -1
- package/dist-types/exports/types/form-core.d.ts +1 -1
- package/dist-types/exports/types/form-core.d.ts.map +1 -1
- package/dist-types/tsconfig.tsbuildinfo +1 -1
- package/docs/components/checkbox-group/overview.md +2 -2
- package/docs/components/collapsible/assets/CustomCollapsible.js +4 -0
- package/docs/components/collapsible/overview.md +1 -1
- package/docs/components/combobox/overview.md +1 -1
- package/docs/components/combobox/src/demo-selection-display.js +8 -35
- package/docs/components/combobox/use-cases.md +24 -1
- package/docs/components/dialog/overview.md +1 -1
- package/docs/components/fieldset/overview.md +5 -5
- package/docs/components/form/overview.md +3 -3
- package/docs/components/icon/use-cases.md +1 -1
- package/docs/components/input/overview.md +1 -1
- package/docs/components/input-amount/overview.md +3 -3
- package/docs/components/input-date/overview.md +3 -3
- package/docs/components/input-datepicker/overview.md +5 -5
- package/docs/components/input-email/overview.md +2 -2
- package/docs/components/input-file/overview.md +1 -1
- package/docs/components/input-iban/overview.md +2 -2
- package/docs/components/input-range/overview.md +2 -2
- package/docs/components/input-stepper/overview.md +1 -1
- package/docs/components/input-tel/overview.md +1 -1
- package/docs/components/input-tel/use-cases.md +6 -6
- package/docs/components/input-tel-dropdown/overview.md +1 -1
- package/docs/components/radio-group/overview.md +3 -3
- package/docs/components/select-rich/use-cases.md +1 -1
- package/docs/components/tabs/examples.md +1 -1
- package/docs/fundamentals/index.md +4 -4
- package/docs/fundamentals/node-tools/providence-analytics/LocalConfiguration.md +1 -1
- package/docs/fundamentals/node-tools/providence-analytics/QueryResult.md +1 -1
- package/docs/fundamentals/node-tools/providence-analytics/analyzer.md +1 -1
- package/docs/fundamentals/node-tools/providence-analytics/dashboard.md +1 -1
- package/docs/fundamentals/node-tools/providence-analytics/overview.md +3 -3
- package/docs/fundamentals/node-tools/publish-docs/overview.md +3 -3
- package/docs/fundamentals/node-tools/rocket-preset-extend-lion-docs/overview.md +2 -2
- package/docs/fundamentals/rationales/accessibility.md +3 -3
- package/docs/fundamentals/systems/core/SlotMixin.md +1 -1
- package/docs/fundamentals/systems/core/overview.md +1 -1
- package/docs/fundamentals/systems/form/formatting-and-parsing.md +4 -4
- package/docs/fundamentals/systems/form/model-value.md +1 -1
- package/docs/fundamentals/systems/form/overview.md +28 -28
- package/docs/fundamentals/systems/form/validate.md +18 -2
- package/docs/fundamentals/systems/localize/overview.md +4 -4
- package/docs/fundamentals/systems/overlays/configuration.md +3 -2
- package/docs/fundamentals/systems/overlays/overview.md +5 -5
- package/docs/fundamentals/systems/overlays/use-cases.md +2 -2
- package/docs/fundamentals/tools/helpers/overview.md +1 -1
- package/docs/fundamentals/tools/singleton-manager/example-complex/overlayCompatibility.js +1 -2
- package/docs/fundamentals/tools/singleton-manager/overview.md +4 -4
- package/docs/guides/how-to/create-a-custom-field.md +5 -5
- package/docs/guides/how-to/create-a-form.md +4 -4
- package/docs/guides/how-to/extend-a-native-input.md +2 -2
- package/docs/guides/index.md +8 -8
- package/docs/guides/principles/index.md +5 -5
- package/docs/guides/principles/styling.md +1 -1
- package/exports/types/form-core.ts +5 -1
- package/package.json +1 -1
|
@@ -19,11 +19,11 @@ import '@lion/ui/define/lion-checkbox.js';
|
|
|
19
19
|
</lion-checkbox-group>
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
> Make sure that the checkbox-group also has a name attribute, this is necessary for our [form](https://github.com/ing-bank/lion/blob/
|
|
22
|
+
> Make sure that the checkbox-group also has a name attribute, this is necessary for our [form](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/form/overview.md)'s serialization result.
|
|
23
23
|
|
|
24
24
|
## Features
|
|
25
25
|
|
|
26
|
-
Since it extends from our [fieldset](https://github.com/ing-bank/lion/blob/
|
|
26
|
+
Since it extends from our [fieldset](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/fieldset/overview.md),
|
|
27
27
|
it has all the features a fieldset has.
|
|
28
28
|
|
|
29
29
|
## Installation
|
|
@@ -56,6 +56,8 @@ export class CustomCollapsible extends LionCollapsible {
|
|
|
56
56
|
contentNode.style.setProperty('opacity', '1');
|
|
57
57
|
contentNode.style.setProperty('padding', '12px 0');
|
|
58
58
|
contentNode.style.setProperty('max-height', '0px');
|
|
59
|
+
// @ts-ignore
|
|
60
|
+
// eslint-disable-next-line no-promise-executor-return
|
|
59
61
|
await new Promise(resolve => requestAnimationFrame(() => resolve()));
|
|
60
62
|
contentNode.style.setProperty('max-height', expectedHeight);
|
|
61
63
|
await this._waitForTransition({ contentNode });
|
|
@@ -105,6 +107,8 @@ export class CustomCollapsible extends LionCollapsible {
|
|
|
105
107
|
*/
|
|
106
108
|
async __calculateHeight(contentNode) {
|
|
107
109
|
contentNode.style.setProperty('max-height', '');
|
|
110
|
+
// @ts-ignore
|
|
111
|
+
// eslint-disable-next-line no-promise-executor-return
|
|
108
112
|
await new Promise(resolve => requestAnimationFrame(() => resolve()));
|
|
109
113
|
return this._contentHeight; // Expected height i.e. actual size once collapsed after animation
|
|
110
114
|
}
|
|
@@ -22,7 +22,7 @@ export const main = () => html`
|
|
|
22
22
|
## Features
|
|
23
23
|
|
|
24
24
|
- Use `opened` attribute or `toggle()` method to render default open.
|
|
25
|
-
- `invoker` slot can be custom template e.g. our [button](https://github.com/ing-bank/lion/blob/
|
|
25
|
+
- `invoker` slot can be custom template e.g. our [button](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/button/overview.md) or native `button` with custom styling.
|
|
26
26
|
- Observe the state with the help of `@opened-changed` event.
|
|
27
27
|
- `show()` and `hide()` are helper methods to hide or show the content from outside.
|
|
28
28
|
|
|
@@ -33,7 +33,7 @@ export const main = () => html`
|
|
|
33
33
|
`;
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
[...show more](https://github.com/ing-bank/lion/blob/
|
|
36
|
+
[...show more](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/combobox/extensions.md)
|
|
37
37
|
|
|
38
38
|
## Features
|
|
39
39
|
|
|
@@ -25,7 +25,7 @@ export class DemoSelectionDisplay extends LitElement {
|
|
|
25
25
|
* Can be used to visually indicate the next
|
|
26
26
|
*/
|
|
27
27
|
removeChipOnNextBackspace: Boolean,
|
|
28
|
-
|
|
28
|
+
selectedChoices: Array,
|
|
29
29
|
};
|
|
30
30
|
}
|
|
31
31
|
|
|
@@ -72,12 +72,6 @@ export class DemoSelectionDisplay extends LitElement {
|
|
|
72
72
|
return this.comboboxElement._inputNode;
|
|
73
73
|
}
|
|
74
74
|
|
|
75
|
-
_computeSelectedElements() {
|
|
76
|
-
const { formElements, checkedIndex } = /** @type {LionCombobox} */ (this.comboboxElement);
|
|
77
|
-
const checkedIndexes = Array.isArray(checkedIndex) ? checkedIndex : [checkedIndex];
|
|
78
|
-
return formElements.filter((_, i) => checkedIndexes.includes(i));
|
|
79
|
-
}
|
|
80
|
-
|
|
81
75
|
get multipleChoice() {
|
|
82
76
|
return this.comboboxElement?.multipleChoice;
|
|
83
77
|
}
|
|
@@ -85,7 +79,7 @@ export class DemoSelectionDisplay extends LitElement {
|
|
|
85
79
|
constructor() {
|
|
86
80
|
super();
|
|
87
81
|
|
|
88
|
-
this.
|
|
82
|
+
this.selectedChoices = [];
|
|
89
83
|
|
|
90
84
|
/** @type {EventListener} */
|
|
91
85
|
this.__textboxOnKeyup = this.__textboxOnKeyup.bind(this);
|
|
@@ -110,29 +104,8 @@ export class DemoSelectionDisplay extends LitElement {
|
|
|
110
104
|
*/
|
|
111
105
|
onComboboxElementUpdated(changedProperties) {
|
|
112
106
|
if (changedProperties.has('modelValue')) {
|
|
113
|
-
this.
|
|
114
|
-
}
|
|
115
|
-
}
|
|
116
|
-
|
|
117
|
-
/**
|
|
118
|
-
* Whenever selectedElements are updated, makes sure that latest added elements
|
|
119
|
-
* are shown latest, and deleted elements respect existing order of chips.
|
|
120
|
-
*/
|
|
121
|
-
__reorderChips() {
|
|
122
|
-
const { selectedElements } = this;
|
|
123
|
-
if (this.__prevSelectedEls) {
|
|
124
|
-
const addedEls = selectedElements.filter(e => !this.__prevSelectedEls.includes(e));
|
|
125
|
-
const deletedEls = this.__prevSelectedEls.filter(e => !selectedElements.includes(e));
|
|
126
|
-
if (addedEls.length) {
|
|
127
|
-
this.selectedElements = [...this.__prevSelectedEls, ...addedEls];
|
|
128
|
-
} else if (deletedEls.length) {
|
|
129
|
-
deletedEls.forEach(delEl => {
|
|
130
|
-
this.__prevSelectedEls.splice(this.__prevSelectedEls.indexOf(delEl), 1);
|
|
131
|
-
});
|
|
132
|
-
this.selectedElements = this.__prevSelectedEls;
|
|
133
|
-
}
|
|
107
|
+
this.selectedChoices = this.comboboxElement.modelValue;
|
|
134
108
|
}
|
|
135
|
-
this.__prevSelectedEls = this.selectedElements;
|
|
136
109
|
}
|
|
137
110
|
|
|
138
111
|
/**
|
|
@@ -143,7 +116,7 @@ export class DemoSelectionDisplay extends LitElement {
|
|
|
143
116
|
_selectedElementTemplate(option, highlight) {
|
|
144
117
|
return html`
|
|
145
118
|
<span class="selection-chip ${highlight ? 'selection-chip--highlighted' : ''}">
|
|
146
|
-
${option
|
|
119
|
+
${option}
|
|
147
120
|
</span>
|
|
148
121
|
`;
|
|
149
122
|
}
|
|
@@ -154,9 +127,9 @@ export class DemoSelectionDisplay extends LitElement {
|
|
|
154
127
|
}
|
|
155
128
|
return html`
|
|
156
129
|
<div class="combobox__selection">
|
|
157
|
-
${this.
|
|
130
|
+
${this.selectedChoices.map((option, i) => {
|
|
158
131
|
const highlight = Boolean(
|
|
159
|
-
this.removeChipOnNextBackspace && i === this.
|
|
132
|
+
this.removeChipOnNextBackspace && i === this.selectedChoices.length - 1,
|
|
160
133
|
);
|
|
161
134
|
return this._selectedElementTemplate(option, highlight);
|
|
162
135
|
})}
|
|
@@ -174,8 +147,8 @@ export class DemoSelectionDisplay extends LitElement {
|
|
|
174
147
|
__textboxOnKeyup(ev) {
|
|
175
148
|
if (ev.key === 'Backspace') {
|
|
176
149
|
if (!this._inputNode.value) {
|
|
177
|
-
if (this.removeChipOnNextBackspace && this.
|
|
178
|
-
this.
|
|
150
|
+
if (this.removeChipOnNextBackspace && this.selectedChoices.length) {
|
|
151
|
+
this.comboboxElement.modelValue = this.selectedChoices.slice(0, -1);
|
|
179
152
|
}
|
|
180
153
|
this.removeChipOnNextBackspace = true;
|
|
181
154
|
}
|
|
@@ -231,6 +231,7 @@ This will:
|
|
|
231
231
|
> Please note that the lion-combobox-selection-display below is not exposed and only serves
|
|
232
232
|
> as an example. The selection part of a multiselect combobox is not yet accessible. Please keep
|
|
233
233
|
> in mind that for now, as a Subclasser, you would have to take care of this part yourself.
|
|
234
|
+
> Also keep in mind that the combobox organizes the selected list by its original index in the option list
|
|
234
235
|
|
|
235
236
|
```js preview-story
|
|
236
237
|
export const multipleChoice = () => html`
|
|
@@ -249,6 +250,28 @@ export const multipleChoice = () => html`
|
|
|
249
250
|
`;
|
|
250
251
|
```
|
|
251
252
|
|
|
253
|
+
Alternatively, the multi-choice flag can be combined with .requireMultipleMatch=false to allow users to enter their own options.
|
|
254
|
+
|
|
255
|
+
> Note that the non-matching items will be displayed in the end of the list in the order that were entered. Since those have no index
|
|
256
|
+
> in the option list, they don't have a representing value in the checkedIndex property.
|
|
257
|
+
|
|
258
|
+
```js preview-story
|
|
259
|
+
export const multipleCustomizableChoice = () => html`
|
|
260
|
+
<lion-combobox name="combo" label="Multiple" .requireOptionMatch=${false} multiple-choice>
|
|
261
|
+
<demo-selection-display
|
|
262
|
+
slot="selection-display"
|
|
263
|
+
style="display: contents;"
|
|
264
|
+
></demo-selection-display>
|
|
265
|
+
${lazyRender(
|
|
266
|
+
listboxData.map(
|
|
267
|
+
(entry, i) =>
|
|
268
|
+
html` <lion-option .choiceValue="${entry}" ?checked=${i === 0}>${entry}</lion-option> `,
|
|
269
|
+
),
|
|
270
|
+
)}
|
|
271
|
+
</lion-combobox>
|
|
272
|
+
`;
|
|
273
|
+
```
|
|
274
|
+
|
|
252
275
|
## Validation
|
|
253
276
|
|
|
254
277
|
The combobox works with a `Required` validator to check if it is empty.
|
|
@@ -433,4 +456,4 @@ export const complexObjectChoiceValue = () => html` <complex-object-combobox
|
|
|
433
456
|
## Listbox compatibility
|
|
434
457
|
|
|
435
458
|
All configurations that can be applied to `lion-listbox`, can be applied to `lion-combobox` as well.
|
|
436
|
-
See the [listbox documentation](https://github.com/ing-bank/lion/blob/
|
|
459
|
+
See the [listbox documentation](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/listbox/overview.md) for more information.
|
|
@@ -54,6 +54,6 @@ import '@lion/ui/define/lion-dialog.js';
|
|
|
54
54
|
## Changing the configuration
|
|
55
55
|
|
|
56
56
|
You can use the `.config` property on the dialog to change the configuration.
|
|
57
|
-
The documentation of the full config object can be found in the `overlays` folder or here in [Overlay System - Configuration](https://github.com/ing-bank/lion/blob/
|
|
57
|
+
The documentation of the full config object can be found in the `overlays` folder or here in [Overlay System - Configuration](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/systems/overlays/configuration.md).
|
|
58
58
|
|
|
59
59
|
The `config` property uses a setter to merge the passed configuration with the current, so you only **overwrite what you pass** when updating `config`.
|
|
@@ -20,9 +20,9 @@ export const main = () => html`
|
|
|
20
20
|
|
|
21
21
|
We have three specific fieldset implementations:
|
|
22
22
|
|
|
23
|
-
- [form](https://github.com/ing-bank/lion/blob/
|
|
24
|
-
- [checkbox-group](https://github.com/ing-bank/lion/blob/
|
|
25
|
-
- [radio-group](https://github.com/ing-bank/lion/blob/
|
|
23
|
+
- [form](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/form/overview.md)
|
|
24
|
+
- [checkbox-group](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/checkbox-group/overview.md)
|
|
25
|
+
- [radio-group](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/radio-group/overview.md)
|
|
26
26
|
|
|
27
27
|
A native fieldset element should always have a legend-element for a11y purposes.
|
|
28
28
|
However, our fieldset element is not native and should not have a legend-element.
|
|
@@ -31,8 +31,8 @@ Our fieldset instead has a label attribute or you can add a label with a div- or
|
|
|
31
31
|
## Features
|
|
32
32
|
|
|
33
33
|
- Easy retrieval of form data based on field names
|
|
34
|
-
- Advanced user interaction scenarios via [interaction states](https://github.com/ing-bank/lion/blob/
|
|
35
|
-
- Can have [validate](https://github.com/ing-bank/lion/blob/
|
|
34
|
+
- Advanced user interaction scenarios via [interaction states](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/systems/form/interaction-states.md)
|
|
35
|
+
- Can have [validate](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/systems/form/validate.md) on fieldset level and shows the validation feedback below the fieldset
|
|
36
36
|
- Can disable input fields on fieldset level
|
|
37
37
|
- Accessible out of the box
|
|
38
38
|
|
|
@@ -8,7 +8,7 @@ import '@lion/ui/define/lion-form.js';
|
|
|
8
8
|
```
|
|
9
9
|
|
|
10
10
|
A web component that enhances the functionality of the native `form` component.
|
|
11
|
-
It is designed to interact with (instances of) the [form controls](https://github.com/ing-bank/lion/blob/
|
|
11
|
+
It is designed to interact with (instances of) the [form controls](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/systems/form/overview.md).
|
|
12
12
|
|
|
13
13
|
```js preview-story
|
|
14
14
|
export const main = () => html`
|
|
@@ -26,11 +26,11 @@ export const main = () => html`
|
|
|
26
26
|
- Data synchronization with models
|
|
27
27
|
- Easy retrieval of form data based on field names
|
|
28
28
|
- Advanced validation possibilities
|
|
29
|
-
- Advanced user interaction scenarios via [interaction states](https://github.com/ing-bank/lion/blob/
|
|
29
|
+
- Advanced user interaction scenarios via [interaction states](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/systems/form/interaction-states.md)
|
|
30
30
|
- Registration mechanism for form controls
|
|
31
31
|
- Accessible out of the box
|
|
32
32
|
|
|
33
|
-
For more information about fields that are designed for our `form`, please read [form system](https://github.com/ing-bank/lion/blob/
|
|
33
|
+
For more information about fields that are designed for our `form`, please read [form system](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/systems/form/overview.md).
|
|
34
34
|
|
|
35
35
|
## Installation
|
|
36
36
|
|
|
@@ -26,7 +26,7 @@ icons.addIconResolver('lion', (iconset, name) => {
|
|
|
26
26
|
## Icon sets
|
|
27
27
|
|
|
28
28
|
Icons are displayed using icon sets. These are collections of icons, lazily loaded on demand for performance.
|
|
29
|
-
See the [system documentation](https://github.com/ing-bank/lion/blob/
|
|
29
|
+
See the [system documentation](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/systems/icon/overview.md) to learn more about icon sets.
|
|
30
30
|
|
|
31
31
|
```js preview-story
|
|
32
32
|
export const iconSets = () => html`
|
|
@@ -23,7 +23,7 @@ export const main = () => html`<lion-input label="First Name"></lion-input>`;
|
|
|
23
23
|
- **before**: does not have an active use case yet, but the option is in place.
|
|
24
24
|
- **after**: can be used to show a currency or percentage.
|
|
25
25
|
- Delegates attributes like `type`, `disabled`, `placeholder` and `readonly` to the native input.
|
|
26
|
-
- Can make use of [validation](https://github.com/ing-bank/lion/blob/
|
|
26
|
+
- Can make use of [validation](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/systems/form/validate.md).
|
|
27
27
|
|
|
28
28
|
## Installation
|
|
29
29
|
|
|
@@ -24,13 +24,13 @@ export const main = () => {
|
|
|
24
24
|
|
|
25
25
|
## Features
|
|
26
26
|
|
|
27
|
-
- Based on our [input](https://github.com/ing-bank/lion/blob/
|
|
28
|
-
- Makes use of [formatNumber](https://github.com/ing-bank/lion/blob/
|
|
27
|
+
- Based on our [input](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/input/overview.md)
|
|
28
|
+
- Makes use of [formatNumber](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/systems/localize/numbers.md) for formatting and parsing.
|
|
29
29
|
- Option to show currency as a suffix
|
|
30
30
|
- Option to override locale to change the formatting and parsing
|
|
31
31
|
- Option to provide additional format options overrides
|
|
32
32
|
- Default label in different languages
|
|
33
|
-
- Can make use of number specific [validators](https://github.com/ing-bank/lion/blob/
|
|
33
|
+
- Can make use of number specific [validators](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/systems/form/validate.md) with corresponding error messages in different languages
|
|
34
34
|
- IsNumber (default)
|
|
35
35
|
- MinNumber
|
|
36
36
|
- MaxNumber
|
|
@@ -16,11 +16,11 @@ export const main = () => html` <lion-input-date label="Date"></lion-input-date>
|
|
|
16
16
|
|
|
17
17
|
## Features
|
|
18
18
|
|
|
19
|
-
- Based on our [input](https://github.com/ing-bank/lion/blob/
|
|
20
|
-
- Makes use of [formatDate](https://github.com/ing-bank/lion/blob/
|
|
19
|
+
- Based on our [input](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/input/overview.md)
|
|
20
|
+
- Makes use of [formatDate](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/systems/localize/dates.md) for formatting and parsing.
|
|
21
21
|
- Option to override locale to change the formatting and parsing
|
|
22
22
|
- Default label in different languages
|
|
23
|
-
- Can make use of date specific [validators](https://github.com/ing-bank/lion/blob/
|
|
23
|
+
- Can make use of date specific [validators](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/systems/form/validate.md) with corresponding error messages in different languages
|
|
24
24
|
- IsDate (default)
|
|
25
25
|
- MinDate
|
|
26
26
|
- MaxDate
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
A web component based on the date text input field. Its purpose is to provide a way for users to fill in a date with a datepicker.
|
|
4
4
|
For an input field with a big range, such as `birthday-input`, a datepicker is not the best choice due to the high variance between possible inputs.
|
|
5
|
-
We encourage using our standard [input-date](https://github.com/ing-bank/lion/blob/
|
|
5
|
+
We encourage using our standard [input-date](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/input-date/overview.md) for this.
|
|
6
6
|
|
|
7
7
|
```js script
|
|
8
8
|
import { html } from '@mdjs/mdjs-preview';
|
|
@@ -18,11 +18,11 @@ export const main = () => {
|
|
|
18
18
|
## Features
|
|
19
19
|
|
|
20
20
|
- Input field with a datepicker to help to choose a date
|
|
21
|
-
- Based on our [input-date](https://github.com/ing-bank/lion/blob/
|
|
22
|
-
- Makes use of our [calendar](https://github.com/ing-bank/lion/blob/
|
|
23
|
-
- Makes use of [formatDate](https://github.com/ing-bank/lion/blob/
|
|
21
|
+
- Based on our [input-date](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/input-date/overview.md)
|
|
22
|
+
- Makes use of our [calendar](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/calendar/overview.md) inside the datepicker
|
|
23
|
+
- Makes use of [formatDate](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/systems/localize/dates.md) for formatting and parsing.
|
|
24
24
|
- Option to overwrite locale to change the formatting and parsing
|
|
25
|
-
- Can make use of date specific [validators](https://github.com/ing-bank/lion/blob/
|
|
25
|
+
- Can make use of date specific [validators](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/systems/form/validate.md) with corresponding error messages in different languages
|
|
26
26
|
- IsDate (default)
|
|
27
27
|
- MinDate
|
|
28
28
|
- MaxDate
|
|
@@ -15,8 +15,8 @@ export const main = () => {
|
|
|
15
15
|
|
|
16
16
|
## Features
|
|
17
17
|
|
|
18
|
-
- Based on our [input](https://github.com/ing-bank/lion/blob/
|
|
19
|
-
- Makes use of email [validators](https://github.com/ing-bank/lion/blob/
|
|
18
|
+
- Based on our [input](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/input/overview.md)
|
|
19
|
+
- Makes use of email [validators](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/systems/form/validate.md) with corresponding error messages in different languages
|
|
20
20
|
- IsEmail (default)
|
|
21
21
|
|
|
22
22
|
## Installation
|
|
@@ -15,7 +15,7 @@ export const main = () => {
|
|
|
15
15
|
|
|
16
16
|
## Features
|
|
17
17
|
|
|
18
|
-
- Based on our [input](https://github.com/ing-bank/lion/blob/
|
|
18
|
+
- Based on our [input](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/input/overview.md)
|
|
19
19
|
- Default labels and validation messages in different languages
|
|
20
20
|
- Options for multi file upload and drop-zone.
|
|
21
21
|
|
|
@@ -16,9 +16,9 @@ export const main = () => {
|
|
|
16
16
|
|
|
17
17
|
## Features
|
|
18
18
|
|
|
19
|
-
- Based on our [input](https://github.com/ing-bank/lion/blob/
|
|
19
|
+
- Based on our [input](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/input/overview.md)
|
|
20
20
|
- Default label in different languages
|
|
21
|
-
- Makes use of IBAN specific [validate](https://github.com/ing-bank/lion/blob/
|
|
21
|
+
- Makes use of IBAN specific [validate](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/systems/form/validate.md) with corresponding error messages in different languages
|
|
22
22
|
- IsIBAN (default)
|
|
23
23
|
- IsCountryIBAN
|
|
24
24
|
- Parses IBANs automatically
|
|
@@ -15,11 +15,11 @@ export const main = () => html`
|
|
|
15
15
|
|
|
16
16
|
## Features
|
|
17
17
|
|
|
18
|
-
- Based on our [input](https://github.com/ing-bank/lion/blob/
|
|
18
|
+
- Based on our [input](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/input/overview.md).
|
|
19
19
|
- Shows `modelValue` and `unit` above the range input.
|
|
20
20
|
- Shows `min` and `max` value after the range input.
|
|
21
21
|
- Can hide the `min` and `max` value via `no-min-max-labels`.
|
|
22
|
-
- Makes use of [formatNumber](https://github.com/ing-bank/lion/blob/
|
|
22
|
+
- Makes use of [formatNumber](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/systems/localize/numbers.md) for formatting and parsing.
|
|
23
23
|
|
|
24
24
|
## Installation
|
|
25
25
|
|
|
@@ -18,7 +18,7 @@ export const main = () => html`
|
|
|
18
18
|
|
|
19
19
|
## Features
|
|
20
20
|
|
|
21
|
-
- Based on our [input](https://github.com/ing-bank/lion/blob/
|
|
21
|
+
- Based on our [input](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/input/overview.md).
|
|
22
22
|
- Set `min` and `max` value to define the range.
|
|
23
23
|
- Set `step` value in integer or decimal to increase and decrease the value.
|
|
24
24
|
- Use `ArrowUp` or `ArrowDown` to update the value.
|
|
@@ -39,7 +39,7 @@ export const main = () => {
|
|
|
39
39
|
|
|
40
40
|
## Features
|
|
41
41
|
|
|
42
|
-
- Extends our [input](https://github.com/ing-bank/lion/blob/
|
|
42
|
+
- Extends our [input](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/input/overview.md)
|
|
43
43
|
- Shows a mobile telephone keypad on mobile (by having a native `<input inputmode="tel">` inside)
|
|
44
44
|
- Can be configured with a list of allowed region codes
|
|
45
45
|
- Will be preconfigured with region derived from locale
|
|
@@ -22,7 +22,7 @@ Say we have the following telephone number from Madrid, Spain: `+34919930432`.
|
|
|
22
22
|
It contains a [country code](https://en.wikipedia.org/wiki/Country_code) (34), an [area code](https://en.wikipedia.org/wiki/Telephone_numbering_plan#Area_code) (91) and a [dial code](https://en.wikipedia.org/wiki/Mobile_dial_code) (+34 91).
|
|
23
23
|
Input Tel interprets phone numbers based on their [region code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2): a two character long region representation('ES' in the telephone number above).
|
|
24
24
|
|
|
25
|
-
The table below lists all possible regions worldwide. When [allowed regions](https://github.com/ing-bank/lion/blob/
|
|
25
|
+
The table below lists all possible regions worldwide. When [allowed regions](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/input-tel/#allowed-regions) are not configured,
|
|
26
26
|
all of them will be supported as values of Input Tel.
|
|
27
27
|
|
|
28
28
|
```js story
|
|
@@ -37,11 +37,11 @@ export const regionCodesTable = () => {
|
|
|
37
37
|
The active region (accessible via readonly accessor `.activeRegion`) determines how validation and formatting
|
|
38
38
|
should be applied. It is dependent on the following factors:
|
|
39
39
|
|
|
40
|
-
- [allowed regions](https://github.com/ing-bank/lion/blob/
|
|
41
|
-
[.allowedRegions has only one entry](https://github.com/ing-bank/lion/blob/
|
|
40
|
+
- [allowed regions](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/input-tel/#allowed-regions): a list that determines what is allowed to become .activeRegion. If
|
|
41
|
+
[.allowedRegions has only one entry](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/input-tel/#restrict-to-one-region), .activeRegion will always be this value.
|
|
42
42
|
- the modelValue or viewValue: once it contains sufficient info to derive its region code (and
|
|
43
|
-
the derived code is inside [allowed regions](https://github.com/ing-bank/lion/blob/
|
|
44
|
-
- active locale (and the derived locale is inside [allowed regions](https://github.com/ing-bank/lion/blob/
|
|
43
|
+
the derived code is inside [allowed regions](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/input-tel/#allowed-regions) if configured)
|
|
44
|
+
- active locale (and the derived locale is inside [allowed regions](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/input-tel/#allowed-regions) if configured)
|
|
45
45
|
|
|
46
46
|
What follows from the list above is that .activeRegion can change dynamically, after a value
|
|
47
47
|
change in the text box by the user (or when locales or allowed regions would be changed by the
|
|
@@ -130,7 +130,7 @@ export const heuristic = () => {
|
|
|
130
130
|
Once it is configured, validation and formatting will be restricted to those
|
|
131
131
|
values that are present in this list.
|
|
132
132
|
|
|
133
|
-
> Note that for [InputTelDropdown](https://github.com/ing-bank/lion/blob/
|
|
133
|
+
> Note that for [InputTelDropdown](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/input-tel-dropdown/index.md), only allowed regions will
|
|
134
134
|
> be shown in the dropdown list.
|
|
135
135
|
|
|
136
136
|
```js preview-story
|
|
@@ -19,7 +19,7 @@ export const main = () => {
|
|
|
19
19
|
|
|
20
20
|
## Features
|
|
21
21
|
|
|
22
|
-
- Extends our [input-tel](https://github.com/ing-bank/lion/blob/
|
|
22
|
+
- Extends our [input-tel](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/input-tel/overview.md)
|
|
23
23
|
- Shows dropdown list with all possible regions
|
|
24
24
|
- Shows only allowed regions in dropdown list when .allowedRegions is configured
|
|
25
25
|
- Highlights regions on top of dropdown list when .preferredRegions is configured
|
|
@@ -20,12 +20,12 @@ export const main = () => html`
|
|
|
20
20
|
`;
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
-
- Make sure that to use a name attribute as it is necessary for our [form](https://github.com/ing-bank/lion/blob/
|
|
24
|
-
- If you have many options for a user to pick from, consider using our [select](https://github.com/ing-bank/lion/blob/
|
|
23
|
+
- Make sure that to use a name attribute as it is necessary for our [form](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/form/overview.md)'s serialization result.
|
|
24
|
+
- If you have many options for a user to pick from, consider using our [select](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/select/overview.md) instead.
|
|
25
25
|
|
|
26
26
|
## Features
|
|
27
27
|
|
|
28
|
-
Since it extends from our [fieldset](https://github.com/ing-bank/lion/blob/
|
|
28
|
+
Since it extends from our [fieldset](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/fieldset/overview.md), it has all the features a fieldset has.
|
|
29
29
|
|
|
30
30
|
- Get or set the checked value of the group:
|
|
31
31
|
- modelValue (default) - `checkedValue()`
|
|
@@ -302,7 +302,7 @@ LionSelectRich will give it acces to:
|
|
|
302
302
|
- LionSelectRich itself, via `.hostElement`
|
|
303
303
|
|
|
304
304
|
Code of an advanced custom invoker is shown below (this is the code for the
|
|
305
|
-
invoker used in [IntlSelectRich](https://github.com/ing-bank/lion/blob/
|
|
305
|
+
invoker used in [IntlSelectRich](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/components/select-rich/examples.md)).
|
|
306
306
|
The invoker is usually added in the invoker slot of the LionSelectRich subclass.
|
|
307
307
|
However, it would also be possible for an application developer to provide the invoker
|
|
308
308
|
by putting it in light dom:
|
|
@@ -9,7 +9,7 @@ import './src/lea-tab-panel.js';
|
|
|
9
9
|
|
|
10
10
|
## Lea Tabs
|
|
11
11
|
|
|
12
|
-
Learn how to create the `lea tabs` in our ["introducing lion" blogpost](https://github.com/ing-bank/lion/blob/
|
|
12
|
+
Learn how to create the `lea tabs` in our ["introducing lion" blogpost](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/blog/ing-open-sources-lion.md).
|
|
13
13
|
|
|
14
14
|
```js preview-story
|
|
15
15
|
export const main = () => html`
|
|
@@ -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/64a1b65c989892adfbabaccd892a0af043e35b3b/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/64a1b65c989892adfbabaccd892a0af043e35b3b/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/64a1b65c989892adfbabaccd892a0af043e35b3b/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/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/rationales/side-effects.md) <br>
|
|
19
19
|
The reasoning behind some of our decisions.
|
|
@@ -45,7 +45,7 @@ export default {
|
|
|
45
45
|
### referenceCollections
|
|
46
46
|
|
|
47
47
|
A list of file system paths. They can be defined relative from the current project root or they can be full paths.
|
|
48
|
-
When a [MatchAnalyzer](https://github.com/ing-bank/lion/blob/
|
|
48
|
+
When a [MatchAnalyzer](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/node-tools/providence-analytics/analyzer.md) like `match-imports` or `match-subclasses` is used, the default reference(s) can be configured here. For instance: ['/path/to/@lion/ui/form.js']
|
|
49
49
|
|
|
50
50
|
An example:
|
|
51
51
|
|
|
@@ -108,4 +108,4 @@ QueryOutput structure could be simplified in the future.
|
|
|
108
108
|
|
|
109
109
|
The output files stored in the file system always need to be machine independent:
|
|
110
110
|
this means that all machine specific information, like a complete filepath, needs to be removed from a QueryOutput (paths relative from project root are still allowed).
|
|
111
|
-
In that way, the caching mechanism (based on hash comparisons) as described in [Analyzer](https://github.com/ing-bank/lion/blob/
|
|
111
|
+
In that way, the caching mechanism (based on hash comparisons) as described in [Analyzer](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/node-tools/providence-analytics/analyzer.md) is guaranteed to work across different machines.
|
|
@@ -7,7 +7,7 @@ A few examples are:
|
|
|
7
7
|
- find-exports
|
|
8
8
|
- match-imports
|
|
9
9
|
|
|
10
|
-
An analyzer will give back a [QueryResult](https://github.com/ing-bank/lion/blob/
|
|
10
|
+
An analyzer will give back a [QueryResult](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/node-tools/providence-analytics/QueryResult.md) that will be written to the file system by Providence.
|
|
11
11
|
All analyzers need to extend from the `Analyzer` base class, found in `src/program/analyzers/helpers`.
|
|
12
12
|
|
|
13
13
|
## Public api
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Node Tools >> Providence Analytics >> Dashboard ||30
|
|
2
2
|
|
|
3
|
-
An interactive overview of all aggregated [QueryResults](https://github.com/ing-bank/lion/blob/
|
|
3
|
+
An interactive overview of all aggregated [QueryResults](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/node-tools/providence-analytics/QueryResult.md) can be found in the dashboard.
|
|
4
4
|
The dashboard is a small nodejs server (based on es-dev-server + middleware) and a frontend
|
|
5
5
|
application.
|
|
6
6
|
|
|
@@ -47,7 +47,7 @@ npm i --save-dev providence-analytics
|
|
|
47
47
|
You are now ready to use providence in your project. All
|
|
48
48
|
data will be stored in json files in the folder `./providence-output`
|
|
49
49
|
|
|
50
|
-

|
|
51
51
|
|
|
52
52
|
## Setup: Dashboard
|
|
53
53
|
|
|
@@ -76,7 +76,7 @@ export default {
|
|
|
76
76
|
|
|
77
77
|
Run `npm run providence:dashboard`
|
|
78
78
|
|
|
79
|
-

|
|
80
80
|
|
|
81
81
|
## Setup: about result output
|
|
82
82
|
|
|
@@ -153,7 +153,7 @@ Now you will get a list of all predefined analyzers:
|
|
|
153
153
|
- match-subclasses
|
|
154
154
|
- etc...
|
|
155
155
|
|
|
156
|
-

|
|
157
157
|
|
|
158
158
|
<!--
|
|
159
159
|
## Running providence from its own repo
|
|
@@ -31,7 +31,7 @@ For a Mono Repository
|
|
|
31
31
|
```md
|
|
32
32
|
# My Pkg
|
|
33
33
|
|
|
34
|
-
[=> See Source <=](https://github.com/ing-bank/lion/blob/
|
|
34
|
+
[=> See Source <=](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/docs/deep/dir/overview.md)
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
## CLI flags
|
|
@@ -61,7 +61,7 @@ Bring the `overview.md` in a docs folder along.
|
|
|
61
61
|
👉 `packages/[my-package]/docs/overview.md`
|
|
62
62
|
|
|
63
63
|
```md
|
|
64
|
-
[=> See Source <=](https://github.com/ing-bank/lion/blob/
|
|
64
|
+
[=> See Source <=](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/docs/deep/dir/overview.md)
|
|
65
65
|
```
|
|
66
66
|
|
|
67
67
|
Add a `use-cases.md`
|
|
@@ -69,7 +69,7 @@ Add a `use-cases.md`
|
|
|
69
69
|
👉 `packages/[my-package]/docs/use-cases.md`
|
|
70
70
|
|
|
71
71
|
```md
|
|
72
|
-
[=> See Source <=](https://github.com/ing-bank/lion/blob/
|
|
72
|
+
[=> See Source <=](https://github.com/ing-bank/lion/blob/64a1b65c989892adfbabaccd892a0af043e35b3b/docs/fundamentals/docs/deep/dir/use-cases.md)
|
|
73
73
|
```
|
|
74
74
|
|
|
75
75
|
So you will end up with something like this in your package.
|