@lion/ui 0.24.0 → 0.25.0

package/vscode.html-custom-data.json

@@ -104,7 +104,7 @@
     },
     {
       "name": "lion-combobox",
-      "description": "LionCombobox: implements the wai-aria combobox design pattern and integrates it as a Lion\nFormControl\n\n\n---\n\n\n\n\n### **Events:**\n - **model-value-changed** - undefined\n- **opened-changed** - undefined\n\n### **Methods:**\n - **close()** - Hides the overlay\n- **matchCondition(option: _LionOption_, textboxValue: _string_)** - When the preconfigurable `match-mode` conditions are not sufficient,\none can define a custom matching function.\n- **open()** - Shows the overlay\n- **parser(value: _string|string[]_): _*_** - Converts viewValue to modelValue\n- **repositionOverlay()** - Sometimes it's needed to recompute Popper position of an overlay, for instance when we have\nan opened combobox and the surrounding context changes (the space consumed by the textbox\nincreases vertically)\n- **toggle()** - Toggles the overlay\n- **_autoSelectCondition()** - When this condition is false, an end user will have to manually select a suggested\noption from the list (by default when autocomplete is 'none' or 'list').\nFor autocomplete 'both' or 'inline', it will automatically select on a match.\n- **_getFocusableInvokerEl(focusableElOrWrapper: _Element | null | undefined_): _Element | null_** - Returns the element that can actually receive focus inside the passed\ninvoker (wrapper) element: the element itself when it is focusable,\notherwise the first focusable descendant.\n- **_getTextboxValueFromOption(option: _LionOption_): _string_** - Return the value to be used for the input value\n- **_handleAutocompletion()** - Handles autocompletion. This entails:\n- list: shows a list on keydown character press\n- filter: filters list of potential matches according to matchmode or provided matchCondition\n- focus: automatically focuses closest match (makes it the activedescendant)\n- check: automatically checks/selects closest match when selection-follows-focus is enabled\n(this is the default configuration)\n- complete: completes the textbox value inline (the 'missing characters' will be added as\nselected text)\n- **_isPermanentlyDisconnected(): _Promise<boolean>_** - When we're moving around in dom, disconnectedCallback gets called.\nBefore we decide to teardown, let's wait to see if we were not just moving nodes around.\n- **_setOpenedWithoutPropertyEffects(newOpened: _boolean_)** - When the opened state is changed by an Application Developer,cthe OverlayController is\nrequested to show/hide. It might happen that this request is not honoured\n(intercepted in before-hide for instance), so that we need to sync the controller state\nto this webcomponent again, preventing eternal loops.\n\n### **Slots:**\n - **listbox** - The listbox element for the combobox, e.g. <lion-options>\n- **selection-display** - The selection display element for the combobox, e.g. <lion-selection-display>",
+      "description": "LionCombobox: implements the wai-aria combobox design pattern and integrates it as a Lion\nFormControl\n\n\n---\n\n\n\n\n### **Events:**\n - **model-value-changed** - undefined\n- **opened-changed** - undefined\n\n### **Methods:**\n - **close()** - Hides the overlay\n- **matchCondition(option: _LionOption_, textboxValue: _string_)** - When the preconfigurable `match-mode` conditions are not sufficient,\none can define a custom matching function.\n- **open()** - Shows the overlay\n- **parser(value: _string|string[]_): _*_** - Converts viewValue to modelValue\n- **repositionOverlay()** - Sometimes it's needed to recompute Popper position of an overlay, for instance when we have\nan opened combobox and the surrounding context changes (the space consumed by the textbox\nincreases vertically)\n- **toggle()** - Toggles the overlay\n- **_autoSelectCondition()** - When this condition is false, an end user will have to manually select a suggested\noption from the list (by default when autocomplete is 'none' or 'list').\nFor autocomplete 'both' or 'inline', it will automatically select on a match.\n- **_getFocusableInvokerEl(focusableElOrWrapper: _Element|null|undefined_): _Element|null_** - Returns the element that can actually receive focus inside the passed\ninvoker (wrapper) element: the element itself when it is focusable,\notherwise the first focusable descendant. Custom invokers without a\nfocusable light DOM descendant remain click targets themselves.\n- **_getTextboxValueFromOption(option: _LionOption_): _string_** - Return the value to be used for the input value\n- **_handleAutocompletion()** - Handles autocompletion. This entails:\n- list: shows a list on keydown character press\n- filter: filters list of potential matches according to matchmode or provided matchCondition\n- focus: automatically focuses closest match (makes it the activedescendant)\n- check: automatically checks/selects closest match when selection-follows-focus is enabled\n(this is the default configuration)\n- complete: completes the textbox value inline (the 'missing characters' will be added as\nselected text)\n- **_isPermanentlyDisconnected(): _Promise<boolean>_** - When we're moving around in dom, disconnectedCallback gets called.\nBefore we decide to teardown, let's wait to see if we were not just moving nodes around.\n- **_setOpenedWithoutPropertyEffects(newOpened: _boolean_)** - When the opened state is changed by an Application Developer,cthe OverlayController is\nrequested to show/hide. It might happen that this request is not honoured\n(intercepted in before-hide for instance), so that we need to sync the controller state\nto this webcomponent again, preventing eternal loops.\n\n### **Slots:**\n - **listbox** - The listbox element for the combobox, e.g. <lion-options>\n- **selection-display** - The selection display element for the combobox, e.g. <lion-selection-display>",
       "attributes": [
         {
           "name": "autocomplete",
@@ -143,7 +143,7 @@
     },
     {
       "name": "lion-dialog",
-      "description": "\n\n\n---\n\n\n\n\n### **Events:**\n - **opened-changed** - undefined\n\n### **Methods:**\n - **close()** - Hides the overlay\n- **open()** - Shows the overlay\n- **repositionOverlay()** - Sometimes it's needed to recompute Popper position of an overlay, for instance when we have\nan opened combobox and the surrounding context changes (the space consumed by the textbox\nincreases vertically)\n- **toggle()** - Toggles the overlay\n- **_getFocusableInvokerEl(focusableElOrWrapper: _Element | null | undefined_): _Element | null_** - Returns the element that can actually receive focus inside the passed\ninvoker (wrapper) element: the element itself when it is focusable,\notherwise the first focusable descendant.\n- **_isPermanentlyDisconnected(): _Promise<boolean>_** - When we're moving around in dom, disconnectedCallback gets called.\nBefore we decide to teardown, let's wait to see if we were not just moving nodes around.\n- **_setOpenedWithoutPropertyEffects(newOpened: _boolean_)** - When the opened state is changed by an Application Developer,cthe OverlayController is\nrequested to show/hide. It might happen that this request is not honoured\n(intercepted in before-hide for instance), so that we need to sync the controller state\nto this webcomponent again, preventing eternal loops.",
+      "description": "\n\n\n---\n\n\n\n\n### **Events:**\n - **opened-changed** - undefined\n\n### **Methods:**\n - **close()** - Hides the overlay\n- **open()** - Shows the overlay\n- **repositionOverlay()** - Sometimes it's needed to recompute Popper position of an overlay, for instance when we have\nan opened combobox and the surrounding context changes (the space consumed by the textbox\nincreases vertically)\n- **toggle()** - Toggles the overlay\n- **_getFocusableInvokerEl(focusableElOrWrapper: _Element|null|undefined_): _Element|null_** - Returns the element that can actually receive focus inside the passed\ninvoker (wrapper) element: the element itself when it is focusable,\notherwise the first focusable descendant. Custom invokers without a\nfocusable light DOM descendant remain click targets themselves.\n- **_isPermanentlyDisconnected(): _Promise<boolean>_** - When we're moving around in dom, disconnectedCallback gets called.\nBefore we decide to teardown, let's wait to see if we were not just moving nodes around.\n- **_setOpenedWithoutPropertyEffects(newOpened: _boolean_)** - When the opened state is changed by an Application Developer,cthe OverlayController is\nrequested to show/hide. It might happen that this request is not honoured\n(intercepted in before-hide for instance), so that we need to sync the controller state\nto this webcomponent again, preventing eternal loops.",
       "attributes": [
         { "name": "is-alert-dialog", "values": [] },
         {
@@ -353,7 +353,7 @@
     },
     {
       "name": "lion-input-datepicker",
-      "description": "\n\n\n---\n\n\n\n\n### **Events:**\n - **opened-changed** - undefined\n- **user-input-changed** - undefined\n\n### **Methods:**\n - **clear()** - Clears modelValue.\nInteraction states are not cleared (use resetInteractionState for this)\n- **close()** - Hides the overlay\n- **open()** - Shows the overlay\n- **repositionOverlay()** - Sometimes it's needed to recompute Popper position of an overlay, for instance when we have\nan opened combobox and the surrounding context changes (the space consumed by the textbox\nincreases vertically)\n- **reset()** - Resets modelValue to initial value.\nInteraction states are cleared\n- **toggle()** - Toggles the overlay\n- **_calendarTemplate()** - Subclassers can replace this with their custom extension of\nLionCalendar, like `<my-calendar id=\"calendar\"></my-calendar>`\n- **_getFocusableInvokerEl(focusableElOrWrapper: _Element | null | undefined_): _Element | null_** - Returns the element that can actually receive focus inside the passed\ninvoker (wrapper) element: the element itself when it is focusable,\notherwise the first focusable descendant.\n- **_invokerIconTemplate()** - Subclassers can replace this with their custom extension invoker icon\n- **_invokerTemplate()** - Subclassers can replace this with their custom extension invoker,\nlike `<my-button><calendar-icon></calendar-icon></my-button>`\n- **_isPermanentlyDisconnected(): _Promise<boolean>_** - When we're moving around in dom, disconnectedCallback gets called.\nBefore we decide to teardown, let's wait to see if we were not just moving nodes around.\n- **_onCalendarOverlayOpened()** - Lifecycle callback for subclassers\n- **_onCalendarUserSelectedChanged({ target: { selectedDate } }, opts: _{ target: { selectedDate: Date }}_)** - Triggered when a user selects a date from the calendar overlay\n- **_onChange(ev: _Event=_)** - Dispatches custom bubble event\n- **_onValidatorUpdated(e: _Event|CustomEvent_, metaData: _{validator: Validator}_)** - Responsible for listening param change event and\nsync the calendar dates with the updated validator params\n- **_overlayTemplate()** - Defining this overlay as a templates from OverlayMixin\nthis is our source to give as .contentNode to OverlayController.\nImportant: do not change the name of this method.\n- **_setOpenedWithoutPropertyEffects(newOpened: _boolean_)** - When the opened state is changed by an Application Developer,cthe OverlayController is\nrequested to show/hide. It might happen that this request is not honoured\n(intercepted in before-hide for instance), so that we need to sync the controller state\nto this webcomponent again, preventing eternal loops.",
+      "description": "\n\n\n---\n\n\n\n\n### **Events:**\n - **opened-changed** - undefined\n- **user-input-changed** - undefined\n\n### **Methods:**\n - **clear()** - Clears modelValue.\nInteraction states are not cleared (use resetInteractionState for this)\n- **close()** - Hides the overlay\n- **open()** - Shows the overlay\n- **repositionOverlay()** - Sometimes it's needed to recompute Popper position of an overlay, for instance when we have\nan opened combobox and the surrounding context changes (the space consumed by the textbox\nincreases vertically)\n- **reset()** - Resets modelValue to initial value.\nInteraction states are cleared\n- **toggle()** - Toggles the overlay\n- **_calendarTemplate()** - Subclassers can replace this with their custom extension of\nLionCalendar, like `<my-calendar id=\"calendar\"></my-calendar>`\n- **_getFocusableInvokerEl(focusableElOrWrapper: _Element|null|undefined_): _Element|null_** - Returns the element that can actually receive focus inside the passed\ninvoker (wrapper) element: the element itself when it is focusable,\notherwise the first focusable descendant. Custom invokers without a\nfocusable light DOM descendant remain click targets themselves.\n- **_invokerIconTemplate()** - Subclassers can replace this with their custom extension invoker icon\n- **_invokerTemplate()** - Subclassers can replace this with their custom extension invoker,\nlike `<my-button><calendar-icon></calendar-icon></my-button>`\n- **_isPermanentlyDisconnected(): _Promise<boolean>_** - When we're moving around in dom, disconnectedCallback gets called.\nBefore we decide to teardown, let's wait to see if we were not just moving nodes around.\n- **_onCalendarOverlayOpened()** - Lifecycle callback for subclassers\n- **_onCalendarUserSelectedChanged({ target: { selectedDate } }, opts: _{ target: { selectedDate: Date }}_)** - Triggered when a user selects a date from the calendar overlay\n- **_onChange(ev: _Event=_)** - Dispatches custom bubble event\n- **_onValidatorUpdated(e: _Event|CustomEvent_, metaData: _{validator: Validator}_)** - Responsible for listening param change event and\nsync the calendar dates with the updated validator params\n- **_overlayTemplate()** - Defining this overlay as a templates from OverlayMixin\nthis is our source to give as .contentNode to OverlayController.\nImportant: do not change the name of this method.\n- **_setOpenedWithoutPropertyEffects(newOpened: _boolean_)** - When the opened state is changed by an Application Developer,cthe OverlayController is\nrequested to show/hide. It might happen that this request is not honoured\n(intercepted in before-hide for instance), so that we need to sync the controller state\nto this webcomponent again, preventing eternal loops.",
       "attributes": [
         {
           "name": "calendar-heading",
@@ -676,7 +676,7 @@
     },
     {
       "name": "lion-field-with-select",
-      "description": "LionSelectRich: wraps the <lion-listbox> element\n\n\n---\n\n\n\n\n### **Events:**\n - **blur** - undefined\n- **opened-changed** - undefined\n\n### **Methods:**\n - **close()** - Hides the overlay\n- **open()** - Shows the overlay\n- **repositionOverlay()** - Sometimes it's needed to recompute Popper position of an overlay, for instance when we have\nan opened combobox and the surrounding context changes (the space consumed by the textbox\nincreases vertically)\n- **toggle()** - Toggles the overlay\n- **_alignInvokerWidth()** - Align invoker width with content width\nMake sure display is not set to \"none\" while calculating the content width\n- **_getCheckedElements()** - In the select disabled options are still going to a possible value for example\nwhen prefilling or programmatically setting it.\n- **_getFocusableInvokerEl(focusableElOrWrapper: _Element | null | undefined_): _Element | null_** - Returns the element that can actually receive focus inside the passed\ninvoker (wrapper) element: the element itself when it is focusable,\notherwise the first focusable descendant.\n- **_isPermanentlyDisconnected(): _Promise<boolean>_** - When we're moving around in dom, disconnectedCallback gets called.\nBefore we decide to teardown, let's wait to see if we were not just moving nodes around.\n- **_noDefaultSelectedInheritsWidth()** - With no selected element, we should override the inheritsReferenceWidth in most cases.\nBy default, we will set it to 'min', and then set it back to what it was initially when\nsomething is selected.\nAs a subclasser you can override this behavior.\n- **_setOpenedWithoutPropertyEffects(newOpened: _boolean_)** - When the opened state is changed by an Application Developer,cthe OverlayController is\nrequested to show/hide. It might happen that this request is not honoured\n(intercepted in before-hide for instance), so that we need to sync the controller state\nto this webcomponent again, preventing eternal loops.",
+      "description": "LionSelectRich: wraps the <lion-listbox> element\n\n\n---\n\n\n\n\n### **Events:**\n - **blur** - undefined\n- **opened-changed** - undefined\n\n### **Methods:**\n - **close()** - Hides the overlay\n- **open()** - Shows the overlay\n- **repositionOverlay()** - Sometimes it's needed to recompute Popper position of an overlay, for instance when we have\nan opened combobox and the surrounding context changes (the space consumed by the textbox\nincreases vertically)\n- **toggle()** - Toggles the overlay\n- **_alignInvokerWidth()** - Align invoker width with content width\nMake sure display is not set to \"none\" while calculating the content width\n- **_getCheckedElements()** - In the select disabled options are still going to a possible value for example\nwhen prefilling or programmatically setting it.\n- **_getFocusableInvokerEl(focusableElOrWrapper: _Element|null|undefined_): _Element|null_** - Returns the element that can actually receive focus inside the passed\ninvoker (wrapper) element: the element itself when it is focusable,\notherwise the first focusable descendant. Custom invokers without a\nfocusable light DOM descendant remain click targets themselves.\n- **_isPermanentlyDisconnected(): _Promise<boolean>_** - When we're moving around in dom, disconnectedCallback gets called.\nBefore we decide to teardown, let's wait to see if we were not just moving nodes around.\n- **_noDefaultSelectedInheritsWidth()** - With no selected element, we should override the inheritsReferenceWidth in most cases.\nBy default, we will set it to 'min', and then set it back to what it was initially when\nsomething is selected.\nAs a subclasser you can override this behavior.\n- **_setOpenedWithoutPropertyEffects(newOpened: _boolean_)** - When the opened state is changed by an Application Developer,cthe OverlayController is\nrequested to show/hide. It might happen that this request is not honoured\n(intercepted in before-hide for instance), so that we need to sync the controller state\nto this webcomponent again, preventing eternal loops.",
       "attributes": [
         {
           "name": "navigate-within-invoker",
@@ -826,7 +826,7 @@
     },
     {
       "name": "lion-tooltip",
-      "description": "\n\n\n---\n\n\n\n\n### **Events:**\n - **opened-changed** - undefined\n\n### **Methods:**\n - **close()** - Hides the overlay\n- **open()** - Shows the overlay\n- **repositionOverlay()** - Sometimes it's needed to recompute Popper position of an overlay, for instance when we have\nan opened combobox and the surrounding context changes (the space consumed by the textbox\nincreases vertically)\n- **toggle()** - Toggles the overlay\n- **_getFocusableInvokerEl(focusableElOrWrapper: _Element | null | undefined_): _Element | null_** - Returns the element that can actually receive focus inside the passed\ninvoker (wrapper) element: the element itself when it is focusable,\notherwise the first focusable descendant.\n- **_isPermanentlyDisconnected(): _Promise<boolean>_** - When we're moving around in dom, disconnectedCallback gets called.\nBefore we decide to teardown, let's wait to see if we were not just moving nodes around.\n- **_setOpenedWithoutPropertyEffects(newOpened: _boolean_)** - When the opened state is changed by an Application Developer,cthe OverlayController is\nrequested to show/hide. It might happen that this request is not honoured\n(intercepted in before-hide for instance), so that we need to sync the controller state\nto this webcomponent again, preventing eternal loops.",
+      "description": "\n\n\n---\n\n\n\n\n### **Events:**\n - **opened-changed** - undefined\n\n### **Methods:**\n - **close()** - Hides the overlay\n- **open()** - Shows the overlay\n- **repositionOverlay()** - Sometimes it's needed to recompute Popper position of an overlay, for instance when we have\nan opened combobox and the surrounding context changes (the space consumed by the textbox\nincreases vertically)\n- **toggle()** - Toggles the overlay\n- **_getFocusableInvokerEl(focusableElOrWrapper: _Element|null|undefined_): _Element|null_** - Returns the element that can actually receive focus inside the passed\ninvoker (wrapper) element: the element itself when it is focusable,\notherwise the first focusable descendant. Custom invokers without a\nfocusable light DOM descendant remain click targets themselves.\n- **_isPermanentlyDisconnected(): _Promise<boolean>_** - When we're moving around in dom, disconnectedCallback gets called.\nBefore we decide to teardown, let's wait to see if we were not just moving nodes around.\n- **_setOpenedWithoutPropertyEffects(newOpened: _boolean_)** - When the opened state is changed by an Application Developer,cthe OverlayController is\nrequested to show/hide. It might happen that this request is not honoured\n(intercepted in before-hide for instance), so that we need to sync the controller state\nto this webcomponent again, preventing eternal loops.",
       "attributes": [
         {
           "name": "invoker-relation",

package/web-types.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
   "name": "@lion/ui",
-  "version": "0.24.0",
+  "version": "0.25.0",
   "description-markup": "markdown",
   "contributions": {
     "html": {