@statistikzh/leu 0.22.0 → 0.23.0

package/dist/vue/index.d.ts

@@ -1,20 +1,20 @@
 import type { DefineComponent } from "vue";
 
 import type { LeuAccordion } from "../Accordion.js";
-import type { LeuButtonGroup } from "../ButtonGroup.js";
 import type { LeuButton } from "../Button.js";
 import type { LeuChartWrapper } from "../ChartWrapper.js";
+import type { LeuButtonGroup } from "../ButtonGroup.js";
 import type { LeuCheckbox } from "../Checkbox.js";
 import type { LeuCheckboxGroup } from "../CheckboxGroup.js";
+import type { LeuDropdown } from "../Dropdown.js";
+import type { LeuDialog } from "../Dialog.js";
 import type { LeuChipGroup } from "../ChipGroup.js";
 import type { LeuChipLink } from "../ChipLink.js";
 import type { LeuChipRemovable } from "../ChipRemovable.js";
 import type { LeuChipSelectable, CustomEvent } from "../ChipSelectable.js";
-import type { LeuDialog } from "../Dialog.js";
-import type { LeuDropdown } from "../Dropdown.js";
 import type { LeuFileInput, CustomEvent } from "../FileInput.js";
-import type { LeuIcon } from "../Icon.js";
 import type { LeuInput, CustomEvent } from "../Input.js";
+import type { LeuIcon } from "../Icon.js";
 import type { LeuMenu } from "../Menu.js";
 import type { LeuMenuItem } from "../MenuItem.js";
 import type { LeuMessage, CustomEvent } from "../Message.js";
@@ -43,13 +43,6 @@ type LeuAccordionProps = {
   label?: LeuAccordion["label"];
 };
 
-type LeuButtonGroupProps = {
-  /** The value of the currently selected (active) button */
-  value?: LeuButtonGroup["value"];
-  /** When the value of the group changes by clicking a button */
-  oninput?: (e: CustomEvent<never>) => void;
-};
-
 type LeuButtonProps = {
   /** `aria-label` of the underlying button elements.
 Use it to provide a label when only an icon is visible. */
@@ -89,6 +82,13 @@ When set to `true`, a spinner will be shown in the chart container. */
   hasSlotController?: LeuChartWrapper["hasSlotController"];
 };
 
+type LeuButtonGroupProps = {
+  /** The value of the currently selected (active) button */
+  value?: LeuButtonGroup["value"];
+  /** When the value of the group changes by clicking a button */
+  oninput?: (e: CustomEvent<never>) => void;
+};
+
 type LeuCheckboxProps = {
   /**  */
   checked?: LeuCheckbox["checked"];
@@ -109,6 +109,24 @@ type LeuCheckboxGroupProps = {
   value?: LeuCheckboxGroup["value"];
 };
 
+type LeuDropdownProps = {
+  /**  */
+  label?: LeuDropdown["label"];
+  /**  */
+  expanded?: LeuDropdown["expanded"];
+  /**  */
+  inverted?: LeuDropdown["inverted"];
+};
+
+type LeuDialogProps = {
+  /**  */
+  label?: LeuDialog["label"];
+  /**  */
+  sublabel?: LeuDialog["sublabel"];
+  /**  */
+  open?: LeuDialog["open"];
+};
+
 type LeuChipGroupProps = {
   /**  */
   inverted?: LeuChipGroup["inverted"];
@@ -126,7 +144,7 @@ If the selectionMode is single, only the first item with the given value is chec
 type LeuChipLinkProps = {
   /** The size of the chip */
   size?: LeuChipLink["size"];
-  /**  */
+  /** The URL that the chip links to */
   href?: LeuChipLink["href"];
   /**  */
   inverted?: LeuChipLink["inverted"];
@@ -143,13 +161,13 @@ type LeuChipRemovableProps = {
 };
 
 type LeuChipSelectableProps = {
-  /** The size of the chip. Not supported for radio variant. */
+  /** The size of the chip. Has no effect when variant is "radio" */
   size?: LeuChipSelectable["size"];
-  /** `toggle` or `radio`. Determines if only one or multiple chips can be selected. */
+  /** The variant of the chip. Determines if only one or multiple chips can be selected. */
   variant?: LeuChipSelectable["variant"];
-  /** Whether the chip is selected. */
+  /** Whether the chip is selected */
   checked?: LeuChipSelectable["checked"];
-  /** The value of the chip. */
+  /** The value of the chip */
   value?: LeuChipSelectable["value"];
   /**  */
   inverted?: LeuChipSelectable["inverted"];
@@ -158,37 +176,6 @@ type LeuChipSelectableProps = {
   oninput?: (e: CustomEvent<CustomEvent>) => void;
 };
 
-type LeuDialogProps = {
-  /**  */
-  label?: LeuDialog["label"];
-  /**  */
-  sublabel?: LeuDialog["sublabel"];
-  /**  */
-  open?: LeuDialog["open"];
-  /**  */
-  _dialogRef?: LeuDialog["_dialogRef"];
-};
-
-type LeuDropdownProps = {
-  /**  */
-  label?: LeuDropdown["label"];
-  /**  */
-  expanded?: LeuDropdown["expanded"];
-  /**  */
-  inverted?: LeuDropdown["inverted"];
-  /**  */
-  hasSlotController?: LeuDropdown["hasSlotController"];
-  /**  */
-  _documentClickHandler?: LeuDropdown["_documentClickHandler"];
-  /**  */
-  _menuItemClickHandler?: LeuDropdown["_menuItemClickHandler"];
-  /** Close the dropdown when the user presses the Escape or the Tab key.
-Navigating the menu with the arrow keys is handled by the menu itself. */
-  _keyDownMenuHandler?: LeuDropdown["_keyDownMenuHandler"];
-  /**  */
-  _toggleRef?: LeuDropdown["_toggleRef"];
-};
-
 type LeuFileInputProps = {
   /**  */
   label?: LeuFileInput["label"];
@@ -216,17 +203,12 @@ type LeuFileInputProps = {
   onchange?: (e: CustomEvent<CustomEvent>) => void;
 };
 
-type LeuIconProps = {
-  /** The name of the icon to display. */
-  name?: LeuIcon["name"];
-};
-
 type LeuInputProps = {
   /** Disables the input element. */
   disabled?: LeuInput["disabled"];
-  /** Marks the input element as required. */
+  /** Marks the input element as required */
   required?: LeuInput["required"];
-  /** Adds a button to clear the input element. */
+  /** Adds a button to clear the input element */
   clearable?: LeuInput["clearable"];
   /** The value of the input element. */
   value?: LeuInput["value"];
@@ -234,15 +216,15 @@ type LeuInputProps = {
   name?: LeuInput["name"];
   /** A custom error that is completely independent of the validity state. Useful for displaying server side errors. */
   error?: LeuInput["error"];
-  /** The label of the input element. */
+  /** The label of the input element */
   label?: LeuInput["label"];
-  /** A prefix that relates to the value of the input (e.g. CHF). */
+  /** A prefix that relates to the value of the input (e.g. CHF) */
   prefix?: LeuInput["prefix"];
   /** A suffix that relates to the value of the input (e.g. mm). */
   suffix?: LeuInput["suffix"];
-  /** The size of the input element. */
+  /** The size of the input element */
   size?: LeuInput["size"];
-  /** The icon that is displayed at the end of the input element. */
+  /** The icon that is displayed at the end of the input element */
   icon?: LeuInput["icon"];
   /** A regular expression that the value is checked against. */
   pattern?: LeuInput["pattern"];
@@ -252,6 +234,8 @@ type LeuInputProps = {
   min?: LeuInput["min"];
   /** The maximum value of the input element. */
   max?: LeuInput["max"];
+  /** The step value of the input element. */
+  step?: LeuInput["step"];
   /** The maximum length of the input element. */
   maxlength?: LeuInput["maxlength"];
   /** The minimum length of the input element. */
@@ -260,8 +244,6 @@ type LeuInputProps = {
   validationMessages?: LeuInput["validationMessages"];
   /** Disables the browser's validation. */
   novalidate?: LeuInput["novalidate"];
-  /** The step value of the input element. */
-  step?: LeuInput["step"];
   /**  */
   _validity?: LeuInput["_validity"];
   /**  */
@@ -272,11 +254,14 @@ type LeuInputProps = {
   onchange?: (e: CustomEvent<CustomEvent>) => void;
 };
 
+type LeuIconProps = {
+  /** The name of the icon to display. */
+  name?: LeuIcon["name"];
+};
+
 type LeuMenuProps = {
   /** This has only an effect when the role is 'menu'. It defines which role the menu items will get. Default is 'none'. */
   selects?: LeuMenu["selects"];
-  /**  */
-  value?: LeuMenu["value"];
 };
 
 type LeuMenuItemProps = {
@@ -349,6 +334,13 @@ type LeuPopupProps = {
   shiftPadding?: LeuPopup["shiftPadding"];
   /**  */
   matchSize?: LeuPopup["matchSize"];
+  /** Offsets the popup along the main axis. */
+  "offset-main-axis"?: LeuPopup["offsetMainAxis"];
+  /** Offsets the popup along the cross axis. */
+  "offset-cross-axis"?: LeuPopup["offsetCrossAxis"];
+  /** Offsets the popup along the alignment axis.
+Overrides the `offsetCrossAxis` value. */
+  "offset-alignment-axis"?: LeuPopup["offsetAlignmentAxis"];
   /**  */
   autoSize?: LeuPopup["autoSize"];
   /**  */
@@ -414,8 +406,6 @@ Otherwise it has to be a string. */
 };
 
 type LeuScrollTopProps = {
-  /**  */
-  _showButton?: LeuScrollTop["_showButton"];
   /**  */
   scroll?: LeuScrollTop["scroll"];
 };
@@ -502,20 +492,6 @@ export type CustomElements = {
    */
   "leu-accordion": DefineComponent<LeuAccordionProps>;
 
-  /**
-   * A radio input-like button group component.
-   * It allows only one button to be active at a time.
-   * ---
-   *
-   *
-   * ### **Events:**
-   *  - **input** - When the value of the group changes by clicking a button
-   *
-   * ### **Slots:**
-   *  - _default_ - Slot for the buttons
-   */
-  "leu-button-group": DefineComponent<LeuButtonGroupProps>;
-
   /**
    *
    * ---
@@ -542,6 +518,20 @@ export type CustomElements = {
    */
   "leu-chart-wrapper": DefineComponent<LeuChartWrapperProps>;
 
+  /**
+   * A radio input-like button group component.
+   * It allows only one button to be active at a time.
+   * ---
+   *
+   *
+   * ### **Events:**
+   *  - **input** - When the value of the group changes by clicking a button
+   *
+   * ### **Slots:**
+   *  - _default_ - Slot for the buttons
+   */
+  "leu-button-group": DefineComponent<LeuButtonGroupProps>;
+
   /**
    *
    * ---
@@ -559,6 +549,20 @@ export type CustomElements = {
    */
   "leu-checkbox-group": DefineComponent<LeuCheckboxGroupProps>;
 
+  /**
+   *
+   * ---
+   *
+   */
+  "leu-dropdown": DefineComponent<LeuDropdownProps>;
+
+  /**
+   *
+   * ---
+   *
+   */
+  "leu-dialog": DefineComponent<LeuDialogProps>;
+
   /**
    *
    * ---
@@ -591,7 +595,7 @@ export type CustomElements = {
    *  - **remove** - Dispatched when the user clicks on the chip
    *
    * ### **Methods:**
-   *  - **getValue(): _string_** - Returns the value of the chip. If `value` is not set, it will return the text content
+   *  - **getValue()** - Returns the value of the chip. If `value` is not set, it will return the text content
    *
    * ### **Slots:**
    *  - _default_ - The content of the chip
@@ -618,26 +622,35 @@ export type CustomElements = {
    *
    * ---
    *
-   */
-  "leu-dialog": DefineComponent<LeuDialogProps>;
-
-  /**
-   *
-   * ---
    *
+   * ### **Events:**
+   *  - **input**
+   * - **change**
    */
-  "leu-dropdown": DefineComponent<LeuDropdownProps>;
+  "leu-file-input": DefineComponent<LeuFileInputProps>;
 
   /**
-   *
+   * A text input element.
    * ---
    *
    *
    * ### **Events:**
-   *  - **input**
-   * - **change**
+   *  - **input** - Dispatched when the value of the input element changes.
+   * - **change** - Dispatched when the value of the input element changes and the input element loses focus.
+   *
+   * ### **Methods:**
+   *
+   *
+   *
+   *
+   *
+   *
+   *
+   * - **checkValidity()** - Check input validation
+   *
+   *
    */
-  "leu-file-input": DefineComponent<LeuFileInputProps>;
+  "leu-input": DefineComponent<LeuInputProps>;
 
   /**
    * A component to render all defined zhWeb icons.
@@ -652,28 +665,6 @@ export type CustomElements = {
    */
   "leu-icon": DefineComponent<LeuIconProps>;
 
-  /**
-   * A text input element.
-   * ---
-   *
-   *
-   * ### **Events:**
-   *  - **input** - Dispatched when the value of the input element changes.
-   * - **change** - Dispatched when the value of the input element changes and the input element loses focus.
-   *
-   * ### **Methods:**
-   *  - **getValidationMessages(): _Object_** - Merge custom and default validation messages.
-   * A validation message can be a function or a string.
-   * If it s a function, the function is called with the corresponding
-   * attribute value as argument.
-   * e.g.
-   * `tooLong(this.maxlength)`
-   * This way the framework user can create reasonable validation messages
-   * - **checkValidity(): _boolean_** - Check input validation
-   * - **renderErrorMessages(): _TemplateResult | nothing_** - Creates an error list with an item for the given validity state.
-   */
-  "leu-input": DefineComponent<LeuInputProps>;
-
   /**
    *
    * ---
@@ -687,7 +678,7 @@ export type CustomElements = {
    *
    *
    * ### **Methods:**
-   *  - **getValue(): _string_** - Returns the value of the item. If `value` is not set, it will return the inner text
+   *  - **getValue()** - Returns the value of the item. If `value` is not set, it will return the inner text
    *
    * ### **Slots:**
    *  - _default_ - The label of the menu item
@@ -770,8 +761,7 @@ export type CustomElements = {
    *
    *
    * ### **Methods:**
-   *  - **_handlePointerDown(e: _PointerEvent & {target: HTMLInputElement}_)** - Determine if the "click" (pointer event) is closer the
-   * the value of the other input element. Swap the values if this is the case.
+   *
    */
   "leu-range": DefineComponent<LeuRangeProps>;