@public-ui/components 2.2.13 → 2.2.14-rc.0

package/dist/types/components.d.ts

@@ -50,6 +50,9 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Focuses the accordion trigger button.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolAlert {
@@ -252,7 +255,13 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Returns the current value.
+         */
         "getValue": () => Promise<Stringified<StencilUnknown> | undefined>;
+        /**
+          * Programmatically focuses the button.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolButtonGroup {
@@ -347,7 +356,13 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Returns the current value.
+         */
         "getValue": () => Promise<Stringified<StencilUnknown> | undefined>;
+        /**
+          * Focuses the button element.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolButtonWc {
@@ -440,6 +455,9 @@ export namespace Components {
           * Defines which variant should be used for presentation.
          */
         "_variant"?: ButtonVariantPropType;
+        /**
+          * Programmatically focuses the native button element.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolCard {
@@ -551,7 +569,13 @@ export namespace Components {
           * Defines the value of the input.
          */
         "_value"?: string;
+        /**
+          * Returns the current value.
+         */
         "getValue": () => Promise<string | undefined>;
+        /**
+          * Focuses the combobox input.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolDetails {
@@ -580,6 +604,9 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Programmatically focuses the collapsible button.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolDrawer {
@@ -603,7 +630,13 @@ export namespace Components {
           * Opens/expands the element when truthy, closes/collapses when falsy.
          */
         "_open"?: OpenPropType;
+        /**
+          * Closes the drawer.
+         */
         "close": () => Promise<void>;
+        /**
+          * Opens the drawer.
+         */
         "open": () => Promise<void>;
     }
     interface KolForm {
@@ -619,6 +652,9 @@ export namespace Components {
           * Defines whether the mandatory-fields-hint should be shown. A string overrides the default text.
          */
         "_requiredText"?: Stringified<boolean>;
+        /**
+          * Scrolls to the error list and focuses its first link.
+         */
         "focusErrorList": () => Promise<void>;
     }
     interface KolHeading {
@@ -906,7 +942,13 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Returns the checked value or null.
+         */
         "getValue": () => Promise<StencilUnknown>;
+        /**
+          * Focuses the checkbox.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolInputColor {
@@ -1008,7 +1050,13 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Returns the selected color value.
+         */
         "getValue": () => Promise<string | undefined>;
+        /**
+          * Focuses the color input.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolInputDate {
@@ -1136,8 +1184,17 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Returns the selected date.
+         */
         "getValue": () => Promise<string | Date | undefined>;
+        /**
+          * Focuses the date input.
+         */
         "kolFocus": () => Promise<void>;
+        /**
+          * Clears the value and resets the input.
+         */
         "reset": () => Promise<void>;
     }
     interface KolInputEmail {
@@ -1270,7 +1327,13 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Returns the current email value.
+         */
         "getValue": () => Promise<string | undefined>;
+        /**
+          * Focuses the email input.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolInputFile {
@@ -1378,7 +1441,13 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Returns the selected file list.
+         */
         "getValue": () => Promise<FileList | null | undefined>;
+        /**
+          * Focuses the file input.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolInputNumber {
@@ -1506,7 +1575,13 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Returns the current numeric value.
+         */
         "getValue": () => Promise<string | undefined>;
+        /**
+          * Focuses the number input.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolInputPassword {
@@ -1635,7 +1710,13 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Returns the current password value.
+         */
         "getValue": () => Promise<string | undefined>;
+        /**
+          * Focuses the password input.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolInputRadio {
@@ -1727,7 +1808,13 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Returns the selected value.
+         */
         "getValue": () => Promise<StencilUnknown | undefined>;
+        /**
+          * Focuses the radio input.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolInputRange {
@@ -1837,7 +1924,13 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Returns the current numeric value.
+         */
         "getValue": () => Promise<number | undefined>;
+        /**
+          * Focuses the numeric input.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolInputText {
@@ -1974,7 +2067,13 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Returns the current text value.
+         */
         "getValue": () => Promise<string | undefined>;
+        /**
+          * Focuses the text input.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolKolibri {
@@ -2053,6 +2152,9 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Programmatically focuses the link.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolLinkButton {
@@ -2129,6 +2231,9 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Focuses the link element.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolLinkGroup {
@@ -2228,6 +2333,9 @@ export namespace Components {
           * Defines which variant should be used for presentation.
          */
         "_variant"?: ButtonVariantPropType;
+        /**
+          * Programmatically focuses the anchor element.
+         */
         "kolFocus": () => Promise<void>;
     }
     /**
@@ -2260,7 +2368,13 @@ export namespace Components {
           * Defines the width of the modal. (max-width: 100%)
          */
         "_width"?: string;
+        /**
+          * Closes the modal dialog and resets the active element.
+         */
         "closeModal": () => Promise<void>;
+        /**
+          * Opens the modal dialog.
+         */
         "openModal": () => Promise<void>;
     }
     interface KolNav {
@@ -2588,7 +2702,13 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Returns the selected values.
+         */
         "getValue": () => Promise<Stringified<W3CInputValue[]> | undefined>;
+        /**
+          * Focuses the select element.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolSingleSelect {
@@ -2689,7 +2809,13 @@ export namespace Components {
           * Defines the value of the input.
          */
         "_value"?: StencilUnknown;
+        /**
+          * Returns the selected value.
+         */
         "getValue": () => Promise<StencilUnknown | undefined>;
+        /**
+          * Focuses the input element.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolSkipNav {
@@ -2810,6 +2936,9 @@ export namespace Components {
           * Defines which variant should be used for presentation.
          */
         "_variant"?: ButtonVariantPropType;
+        /**
+          * Closes the dropdown menu.
+         */
         "closePopup": () => Promise<void>;
     }
     interface KolSymbol {
@@ -2910,6 +3039,9 @@ export namespace Components {
           * Defines how rows can be selected and the current selection.
          */
         "_selection"?: TableSelectionPropType;
+        /**
+          * Returns the data for the currently selected rows.
+         */
         "getSelection": () => Promise<KoliBriTableDataType[] | KoliBriTableDataType | null>;
     }
     interface KolTableStateless {
@@ -3127,11 +3259,23 @@ export namespace Components {
           * @deprecated Use kolFocus instead.
          */
         "focus": () => Promise<void>;
+        /**
+          * Returns the current text value.
+         */
         "getValue": () => Promise<string | undefined>;
+        /**
+          * Focuses the textarea.
+         */
         "kolFocus": () => Promise<void>;
     }
     interface KolToastContainer {
+        /**
+          * Closes all open toasts.
+         */
         "closeAll": (immediate?: boolean) => Promise<void>;
+        /**
+          * Adds a toast to the queue and returns a close function.
+         */
         "enqueue": (toast: Toast) => Promise<() => void>;
     }
     interface KolToolbar {
@@ -3185,9 +3329,21 @@ export namespace Components {
           * Opens/expands the element when truthy, closes/collapses when falsy.
          */
         "_open"?: OpenPropType;
+        /**
+          * Collapses the underlying tree item.
+         */
         "collapse": () => Promise<void>;
+        /**
+          * Expands the underlying tree item.
+         */
         "expand": () => Promise<void>;
+        /**
+          * Focuses the underlying tree item link.
+         */
         "focusLink": () => Promise<void>;
+        /**
+          * Returns whether the underlying tree item is expanded.
+         */
         "isOpen": () => Promise<boolean>;
     }
     interface KolTreeItemWc {
@@ -3207,9 +3363,21 @@ export namespace Components {
           * Opens/expands the element when truthy, closes/collapses when falsy.
          */
         "_open"?: OpenPropType;
+        /**
+          * Collapses the tree item if it has children.
+         */
         "collapse": () => Promise<void>;
+        /**
+          * Expands the tree item if it has children.
+         */
         "expand": () => Promise<void>;
+        /**
+          * Focuses the internal link element.
+         */
         "focusLink": () => Promise<void>;
+        /**
+          * Returns whether the tree item is expanded.
+         */
         "isOpen": () => Promise<boolean>;
     }
     interface KolTreeWc {

package/doc/accordion.md

@@ -135,7 +135,7 @@ Type: `Promise<void>`
 
 ### `kolFocus() => Promise<void>`
 
-
+Focuses the accordion trigger button.
 
 #### Returns
 

package/doc/button-link.md

@@ -88,7 +88,7 @@ Type: `Promise<void>`
 
 ### `getValue() => Promise<Stringified<StencilUnknown> | undefined>`
 
-
+Returns the current value.
 
 #### Returns
 
@@ -98,7 +98,7 @@ Type: `Promise<Stringified<StencilUnknown>>`
 
 ### `kolFocus() => Promise<void>`
 
-
+Focuses the button element.
 
 #### Returns
 

package/doc/button.md

@@ -159,7 +159,7 @@ Type: `Promise<void>`
 
 ### `getValue() => Promise<Stringified<StencilUnknown> | undefined>`
 
-
+Returns the current value.
 
 #### Returns
 
@@ -169,7 +169,7 @@ Type: `Promise<Stringified<StencilUnknown>>`
 
 ### `kolFocus() => Promise<void>`
 
-
+Programmatically focuses the button.
 
 #### Returns
 

package/doc/combobox.md

@@ -78,7 +78,7 @@ Beispiel für die Konstruktion des JSON-Array:
 
 ### `getValue() => Promise<string | undefined>`
 
-
+Returns the current value.
 
 #### Returns
 
@@ -88,7 +88,7 @@ Type: `Promise<string | undefined>`
 
 ### `kolFocus() => Promise<void>`
 
-
+Focuses the combobox input.
 
 #### Returns
 

package/doc/details.md

@@ -116,7 +116,7 @@ Type: `Promise<void>`
 
 ### `kolFocus() => Promise<void>`
 
-
+Programmatically focuses the collapsible button.
 
 #### Returns
 

package/doc/drawer.md

@@ -143,7 +143,7 @@ Optional können Animationen mit Keyframes hinzugefügt werden. Dabei ist es wic
 
 ### `close() => Promise<void>`
 
-
+Closes the drawer.
 
 #### Returns
 
@@ -153,7 +153,7 @@ Type: `Promise<void>`
 
 ### `open() => Promise<void>`
 
-
+Opens the drawer.
 
 #### Returns
 

package/doc/form.md

@@ -36,7 +36,7 @@ Die **Form**-Komponente dient dazu alle Eingabefelder zu umschließen, den Hinwe
 
 ### `focusErrorList() => Promise<void>`
 
-
+Scrolls to the error list and focuses its first link.
 
 #### Returns
 

package/doc/input-checkbox.md

@@ -123,7 +123,7 @@ Type: `Promise<void>`
 
 ### `getValue() => Promise<StencilUnknown>`
 
-
+Returns the checked value or null.
 
 #### Returns
 
@@ -133,7 +133,7 @@ Type: `Promise<StencilUnknown>`
 
 ### `kolFocus() => Promise<void>`
 
-
+Focuses the checkbox.
 
 #### Returns
 

package/doc/input-color.md

@@ -87,7 +87,7 @@ Type: `Promise<void>`
 
 ### `getValue() => Promise<string | undefined>`
 
-
+Returns the selected color value.
 
 #### Returns
 
@@ -97,7 +97,7 @@ Type: `Promise<string | undefined>`
 
 ### `kolFocus() => Promise<void>`
 
-
+Focuses the color input.
 
 #### Returns
 

package/doc/input-date.md

@@ -148,7 +148,7 @@ Type: `Promise<void>`
 
 ### `getValue() => Promise<string | Date | undefined>`
 
-
+Returns the selected date.
 
 #### Returns
 
@@ -158,7 +158,7 @@ Type: `Promise<string | Date | undefined>`
 
 ### `kolFocus() => Promise<void>`
 
-
+Focuses the date input.
 
 #### Returns
 
@@ -168,7 +168,7 @@ Type: `Promise<void>`
 
 ### `reset() => Promise<void>`
 
-
+Clears the value and resets the input.
 
 #### Returns
 

package/doc/input-email.md

@@ -115,7 +115,7 @@ Type: `Promise<void>`
 
 ### `getValue() => Promise<string | undefined>`
 
-
+Returns the current email value.
 
 #### Returns
 
@@ -125,7 +125,7 @@ Type: `Promise<string | undefined>`
 
 ### `kolFocus() => Promise<void>`
 
-
+Focuses the email input.
 
 #### Returns
 

package/doc/input-file.md

@@ -108,7 +108,7 @@ Type: `Promise<void>`
 
 ### `getValue() => Promise<FileList | null | undefined>`
 
-
+Returns the selected file list.
 
 #### Returns
 
@@ -118,7 +118,7 @@ Type: `Promise<FileList | null | undefined>`
 
 ### `kolFocus() => Promise<void>`
 
-
+Focuses the file input.
 
 #### Returns
 

package/doc/input-number.md

@@ -105,7 +105,7 @@ Type: `Promise<void>`
 
 ### `getValue() => Promise<string | undefined>`
 
-
+Returns the current numeric value.
 
 #### Returns
 
@@ -115,7 +115,7 @@ Type: `Promise<string | undefined>`
 
 ### `kolFocus() => Promise<void>`
 
-
+Focuses the number input.
 
 #### Returns
 

package/doc/input-password.md

@@ -106,7 +106,7 @@ Type: `Promise<void>`
 
 ### `getValue() => Promise<string | undefined>`
 
-
+Returns the current password value.
 
 #### Returns
 
@@ -116,7 +116,7 @@ Type: `Promise<string | undefined>`
 
 ### `kolFocus() => Promise<void>`
 
-
+Focuses the password input.
 
 #### Returns
 

package/doc/input-radio.md

@@ -137,7 +137,7 @@ Type: `Promise<void>`
 
 ### `getValue() => Promise<StencilUnknown | undefined>`
 
-
+Returns the selected value.
 
 #### Returns
 
@@ -147,7 +147,7 @@ Type: `Promise<StencilUnknown>`
 
 ### `kolFocus() => Promise<void>`
 
-
+Focuses the radio input.
 
 #### Returns
 

package/doc/input-range.md

@@ -120,7 +120,7 @@ Type: `Promise<void>`
 
 ### `getValue() => Promise<number | undefined>`
 
-
+Returns the current numeric value.
 
 #### Returns
 
@@ -130,7 +130,7 @@ Type: `Promise<number | undefined>`
 
 ### `kolFocus() => Promise<void>`
 
-
+Focuses the numeric input.
 
 #### Returns
 

package/doc/input-text.md

@@ -131,7 +131,7 @@ Type: `Promise<void>`
 
 ### `getValue() => Promise<string | undefined>`
 
-
+Returns the current text value.
 
 #### Returns
 
@@ -141,7 +141,7 @@ Type: `Promise<string | undefined>`
 
 ### `kolFocus() => Promise<void>`
 
-
+Focuses the text input.
 
 #### Returns
 

package/doc/link-button.md

@@ -65,7 +65,7 @@ Type: `Promise<void>`
 
 ### `kolFocus() => Promise<void>`
 
-
+Focuses the link element.
 
 #### Returns