@statistikzh/leu 0.21.1 → 0.22.1

package/dist/vue/index.d.ts

@@ -2,17 +2,17 @@ import type { DefineComponent } from "vue";
 
 import type { LeuAccordion } from "../Accordion.js";
 import type { LeuButton } from "../Button.js";
-import type { LeuButtonGroup } from "../ButtonGroup.js";
-import type { LeuChartWrapper } from "../ChartWrapper.js";
 import type { LeuCheckbox } from "../Checkbox.js";
 import type { LeuCheckboxGroup } from "../CheckboxGroup.js";
+import type { LeuButtonGroup } from "../ButtonGroup.js";
+import type { LeuChartWrapper } from "../ChartWrapper.js";
+import type { LeuDropdown } from "../Dropdown.js";
+import type { LeuDialog } from "../Dialog.js";
+import type { LeuFileInput, CustomEvent } from "../FileInput.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 { LeuMenu } from "../Menu.js";
@@ -74,6 +74,26 @@ If it is set, the icon will either show an expanded or collapsed state. */
   fluid?: LeuButton["fluid"];
 };
 
+type LeuCheckboxProps = {
+  /**  */
+  checked?: LeuCheckbox["checked"];
+  /**  */
+  disabled?: LeuCheckbox["disabled"];
+  /**  */
+  value?: LeuCheckbox["value"];
+  /**  */
+  name?: LeuCheckbox["name"];
+};
+
+type LeuCheckboxGroupProps = {
+  /** Defines how the checkboxes should be aligned. */
+  orientation?: LeuCheckboxGroup["orientation"];
+  /** The label of the checkbox group */
+  label?: LeuCheckboxGroup["label"];
+  /**  */
+  value?: LeuCheckboxGroup["value"];
+};
+
 type LeuButtonGroupProps = {
   /** The value of the currently selected (active) button */
   value?: LeuButtonGroup["value"];
@@ -89,24 +109,49 @@ When set to `true`, a spinner will be shown in the chart container. */
   hasSlotController?: LeuChartWrapper["hasSlotController"];
 };
 
-type LeuCheckboxProps = {
+type LeuDropdownProps = {
   /**  */
-  checked?: LeuCheckbox["checked"];
+  label?: LeuDropdown["label"];
   /**  */
-  disabled?: LeuCheckbox["disabled"];
+  expanded?: LeuDropdown["expanded"];
   /**  */
-  value?: LeuCheckbox["value"];
+  inverted?: LeuDropdown["inverted"];
+};
+
+type LeuDialogProps = {
   /**  */
-  name?: LeuCheckbox["name"];
+  label?: LeuDialog["label"];
+  /**  */
+  sublabel?: LeuDialog["sublabel"];
+  /**  */
+  open?: LeuDialog["open"];
 };
 
-type LeuCheckboxGroupProps = {
-  /** Defines how the checkboxes should be aligned. */
-  orientation?: LeuCheckboxGroup["orientation"];
-  /** The label of the checkbox group */
-  label?: LeuCheckboxGroup["label"];
+type LeuFileInputProps = {
   /**  */
-  value?: LeuCheckboxGroup["value"];
+  label?: LeuFileInput["label"];
+  /** A list of acceptable file types. Must be a comma-separated list of [unique file type specifiers](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#unique_file_type_specifiers). */
+  accept?: LeuFileInput["accept"];
+  /** Whether the file input is disabled. */
+  disabled?: LeuFileInput["disabled"];
+  /** Whether the file input allows multiple files. */
+  multiple?: LeuFileInput["multiple"];
+  /** Whether the file input is required. */
+  required?: LeuFileInput["required"];
+  /** The variant of the file list item. `filled` renders a gray background. */
+  variant?: LeuFileInput["variant"];
+  /**  */
+  files?: LeuFileInput["files"];
+  /**  */
+  input?: LeuFileInput["input"];
+  /**  */
+  form?: LeuFileInput["form"];
+  /**  */
+  name?: LeuFileInput["name"];
+  /**  */
+  oninput?: (e: CustomEvent<CustomEvent>) => void;
+  /**  */
+  onchange?: (e: CustomEvent<CustomEvent>) => void;
 };
 
 type LeuChipGroupProps = {
@@ -126,7 +171,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 +188,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,62 +203,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"];
-  /**  */
-  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"];
-  /** A list of acceptable file types. Must be a comma-separated list of [unique file type specifiers](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#unique_file_type_specifiers). */
-  accept?: LeuFileInput["accept"];
-  /** Whether the file input is disabled. */
-  disabled?: LeuFileInput["disabled"];
-  /** Whether the file input allows multiple files. */
-  multiple?: LeuFileInput["multiple"];
-  /** Whether the file input is required. */
-  required?: LeuFileInput["required"];
-  /** The variant of the file list item. `filled` renders a gray background. */
-  variant?: LeuFileInput["variant"];
-  /**  */
-  files?: LeuFileInput["files"];
-  /**  */
-  input?: LeuFileInput["input"];
-  /**  */
-  form?: LeuFileInput["form"];
-  /**  */
-  name?: LeuFileInput["name"];
-  /**  */
-  oninput?: (e: CustomEvent<CustomEvent>) => void;
-  /**  */
-  onchange?: (e: CustomEvent<CustomEvent>) => void;
-};
-
 type LeuIconProps = {
   /** The name of the icon to display. */
   name?: LeuIcon["name"];
@@ -222,9 +211,9 @@ type LeuIconProps = {
 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"];
@@ -232,15 +221,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"];
@@ -250,6 +239,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. */
@@ -258,8 +249,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"];
   /**  */
@@ -273,8 +262,6 @@ type LeuInputProps = {
 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 = {
@@ -412,8 +399,6 @@ Otherwise it has to be a string. */
 };
 
 type LeuScrollTopProps = {
-  /**  */
-  _showButton?: LeuScrollTop["_showButton"];
   /**  */
   scroll?: LeuScrollTop["scroll"];
 };
@@ -512,6 +497,23 @@ export type CustomElements = {
    */
   "leu-button": DefineComponent<LeuButtonProps>;
 
+  /**
+   *
+   * ---
+   *
+   */
+  "leu-checkbox": DefineComponent<LeuCheckboxProps>;
+
+  /**
+   *
+   * ---
+   *
+   *
+   * ### **Slots:**
+   *  - _default_ - Place the checkboxes inside the default slot.
+   */
+  "leu-checkbox-group": DefineComponent<LeuCheckboxGroupProps>;
+
   /**
    * A radio input-like button group component.
    * It allows only one button to be active at a time.
@@ -545,17 +547,25 @@ export type CustomElements = {
    * ---
    *
    */
-  "leu-checkbox": DefineComponent<LeuCheckboxProps>;
+  "leu-dropdown": DefineComponent<LeuDropdownProps>;
 
   /**
    *
    * ---
    *
+   */
+  "leu-dialog": DefineComponent<LeuDialogProps>;
+
+  /**
    *
-   * ### **Slots:**
-   *  - _default_ - Place the checkboxes inside the default slot.
+   * ---
+   *
+   *
+   * ### **Events:**
+   *  - **input**
+   * - **change**
    */
-  "leu-checkbox-group": DefineComponent<LeuCheckboxGroupProps>;
+  "leu-file-input": DefineComponent<LeuFileInputProps>;
 
   /**
    *
@@ -589,7 +599,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
@@ -612,31 +622,6 @@ export type CustomElements = {
    */
   "leu-chip-selectable": DefineComponent<LeuChipSelectableProps>;
 
-  /**
-   *
-   * ---
-   *
-   */
-  "leu-dialog": DefineComponent<LeuDialogProps>;
-
-  /**
-   *
-   * ---
-   *
-   */
-  "leu-dropdown": DefineComponent<LeuDropdownProps>;
-
-  /**
-   *
-   * ---
-   *
-   *
-   * ### **Events:**
-   *  - **input**
-   * - **change**
-   */
-  "leu-file-input": DefineComponent<LeuFileInputProps>;
-
   /**
    * A component to render all defined zhWeb icons.
    * The `fill` of the icon is set to `currentColor` and
@@ -660,15 +645,16 @@ export type CustomElements = {
    * - **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.
+   *
+   *
+   *
+   *
+   *
+   *
+   *
+   * - **checkValidity()** - Check input validation
+   *
+   *
    */
   "leu-input": DefineComponent<LeuInputProps>;
 
@@ -685,7 +671,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
@@ -768,8 +754,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>;