@pine-ds/core 4.12.0 → 5.0.0

package/dist/types/components.d.ts

@@ -76,7 +76,7 @@ export namespace Components {
     }
     interface PdsAccordion {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
           * @defaultValue null
          */
         "componentId": string;
@@ -88,7 +88,7 @@ export namespace Components {
     }
     interface PdsAlert {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -143,7 +143,7 @@ export namespace Components {
          */
         "badgeLabel"?: string;
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -780,7 +780,7 @@ export namespace Components {
     }
     interface PdsButton {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -903,7 +903,7 @@ export namespace Components {
     }
     interface PdsChip {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -1189,7 +1189,7 @@ export namespace Components {
          */
         "border": boolean;
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -1442,7 +1442,7 @@ export namespace Components {
     }
     interface PdsDivider {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -1531,7 +1531,7 @@ export namespace Components {
     }
     interface PdsDropdownMenu {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -1546,7 +1546,7 @@ export namespace Components {
          */
         "clickItem": () => Promise<void>;
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -1590,7 +1590,7 @@ export namespace Components {
     }
     interface PdsDropdownMenuSeparator {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -1605,7 +1605,7 @@ export namespace Components {
      */
     interface PdsFilter {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance, used to build its internal popover's `id`. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -1632,7 +1632,7 @@ export namespace Components {
     }
     interface PdsFilters {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
     }
@@ -1643,7 +1643,7 @@ export namespace Components {
          */
         "alt"?: string;
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -2155,7 +2155,7 @@ export namespace Components {
          */
         "searchPlaceholder": string;
         /**
-          * Singular form of the selected-count trigger text. Pass a translated string to localize it; `{count}` is interpolated.
+          * Singular form of the selected-count trigger text. Pass a translated string to localize it; `{count}` is interpolated. A single selection shows the item's name instead, so this applies to other counts that a locale's plural rules treat as singular, and to a single selection whose item has no text.
           * @defaultValue '{count} item'
          */
         "selectedCountLabelOne": string;
@@ -2165,12 +2165,12 @@ export namespace Components {
          */
         "selectedCountLabelOther": string;
         /**
-          * Full CLDR plural forms for the selected-count trigger text, for locales with more than the English `one`/`other` categories (e.g. Polish `few`/`many`, Arabic `zero`/`two`). Accepts an object property or a JSON string attribute keyed by CLDR category — `{ one, other, few, many, two, zero }`. Any form omitted here falls back to `selectedCountLabelOne`/`selectedCountLabelOther`. `{count}` is interpolated.
+          * Full CLDR plural forms for the selected-count trigger text, for locales with more than the English `one`/`other` categories (e.g. Polish `few`/`many`, Arabic `zero`/`two`). Accepts an object property or a JSON string attribute keyed by CLDR category — `{ one, other, few, many, two, zero }`. Any form omitted here falls back to `selectedCountLabelOne`/`selectedCountLabelOther`. `{count}` is interpolated. A single selection shows the item's name instead of any form, unless the item has no text.
           * @defaultValue undefined
          */
         "selectedCountLabels"?: PluralForms | string;
         /**
-          * Display mode for selected items outside the dropdown panel. `'count'` shows "N item(s)" text in the trigger (default). `'pill'` renders selected items as dismissible pds-chip tags.
+          * Display mode for selected items outside the dropdown panel. `'count'` shows the item's name in the trigger when one is selected and "N items" text otherwise (default). `'pill'` renders selected items as dismissible pds-chip tags.
           * @default 'count'
          */
         "selectedDisplay": 'count' | 'pill';
@@ -2196,7 +2196,7 @@ export namespace Components {
     }
     interface PdsPopover {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance, used to build its portal element's `id`. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -2274,7 +2274,7 @@ export namespace Components {
     }
     interface PdsProperty {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -2351,7 +2351,7 @@ export namespace Components {
      */
     interface PdsRadioGroup {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance, used to build its helper and error message `id`s. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -2508,7 +2508,7 @@ export namespace Components {
          */
         "border": boolean;
         /**
-          * A unique identifier used for the sortable container `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -2557,7 +2557,7 @@ export namespace Components {
      */
     interface PdsSortableItem {
         /**
-          * A unique identifier used for the sortable item `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -2591,11 +2591,11 @@ export namespace Components {
          */
         "disabled"?: boolean;
         /**
-          * Displays message text describing an invalid state.
+          * Displays an error message below the switch. It becomes the switch's accessible description only while `invalid` is set.
          */
         "errorMessage"?: string;
         /**
-          * Displays help text for additional description of an input.
+          * Displays a message or hint below the switch.
          */
         "helperMessage": string;
         /**
@@ -2603,12 +2603,12 @@ export namespace Components {
          */
         "hideLabel": boolean;
         /**
-          * Determines the input 'invalid' state, signifying an error is present.
+          * Determines whether or not the switch is invalid.
           * @default false
          */
         "invalid"?: boolean;
         /**
-          * Displays text to describe the input.
+          * Text to be displayed as the switch label.
          */
         "label": string;
         /**
@@ -2678,7 +2678,7 @@ export namespace Components {
          */
         "compact": boolean;
         /**
-          * A unique identifier used for the table `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -2818,7 +2818,7 @@ export namespace Components {
          */
         "activeTabName"?: string;
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance, passed down to its tabs and panels. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -3029,7 +3029,7 @@ export namespace Components {
      */
     interface PdsTooltip {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance, used to build its portal element's `id`. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -4042,7 +4042,7 @@ declare namespace LocalJSX {
     }
     interface PdsAccordion {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
           * @defaultValue null
          */
         "componentId"?: string;
@@ -4058,7 +4058,7 @@ declare namespace LocalJSX {
     }
     interface PdsAlert {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId"?: string;
         /**
@@ -4117,7 +4117,7 @@ declare namespace LocalJSX {
          */
         "badgeLabel"?: string;
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId"?: string;
         /**
@@ -4754,7 +4754,7 @@ declare namespace LocalJSX {
     }
     interface PdsButton {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId"?: string;
         /**
@@ -4893,7 +4893,7 @@ declare namespace LocalJSX {
     }
     interface PdsChip {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId"?: string;
         /**
@@ -5187,7 +5187,7 @@ declare namespace LocalJSX {
          */
         "border"?: boolean;
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId"?: string;
         /**
@@ -5448,7 +5448,7 @@ declare namespace LocalJSX {
     }
     interface PdsDivider {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId"?: string;
         /**
@@ -5545,7 +5545,7 @@ declare namespace LocalJSX {
     }
     interface PdsDropdownMenu {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId"?: string;
         /**
@@ -5556,7 +5556,7 @@ declare namespace LocalJSX {
     }
     interface PdsDropdownMenuItem {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId"?: string;
         /**
@@ -5604,7 +5604,7 @@ declare namespace LocalJSX {
     }
     interface PdsDropdownMenuSeparator {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId"?: string;
         /**
@@ -5619,7 +5619,7 @@ declare namespace LocalJSX {
      */
     interface PdsFilter {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance, used to build its internal popover's `id`. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -5650,7 +5650,7 @@ declare namespace LocalJSX {
     }
     interface PdsFilters {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId"?: string;
     }
@@ -5661,7 +5661,7 @@ declare namespace LocalJSX {
          */
         "alt"?: string;
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId"?: string;
         /**
@@ -6221,7 +6221,7 @@ declare namespace LocalJSX {
          */
         "searchPlaceholder"?: string;
         /**
-          * Singular form of the selected-count trigger text. Pass a translated string to localize it; `{count}` is interpolated.
+          * Singular form of the selected-count trigger text. Pass a translated string to localize it; `{count}` is interpolated. A single selection shows the item's name instead, so this applies to other counts that a locale's plural rules treat as singular, and to a single selection whose item has no text.
           * @defaultValue '{count} item'
          */
         "selectedCountLabelOne"?: string;
@@ -6231,12 +6231,12 @@ declare namespace LocalJSX {
          */
         "selectedCountLabelOther"?: string;
         /**
-          * Full CLDR plural forms for the selected-count trigger text, for locales with more than the English `one`/`other` categories (e.g. Polish `few`/`many`, Arabic `zero`/`two`). Accepts an object property or a JSON string attribute keyed by CLDR category — `{ one, other, few, many, two, zero }`. Any form omitted here falls back to `selectedCountLabelOne`/`selectedCountLabelOther`. `{count}` is interpolated.
+          * Full CLDR plural forms for the selected-count trigger text, for locales with more than the English `one`/`other` categories (e.g. Polish `few`/`many`, Arabic `zero`/`two`). Accepts an object property or a JSON string attribute keyed by CLDR category — `{ one, other, few, many, two, zero }`. Any form omitted here falls back to `selectedCountLabelOne`/`selectedCountLabelOther`. `{count}` is interpolated. A single selection shows the item's name instead of any form, unless the item has no text.
           * @defaultValue undefined
          */
         "selectedCountLabels"?: PluralForms | string;
         /**
-          * Display mode for selected items outside the dropdown panel. `'count'` shows "N item(s)" text in the trigger (default). `'pill'` renders selected items as dismissible pds-chip tags.
+          * Display mode for selected items outside the dropdown panel. `'count'` shows the item's name in the trigger when one is selected and "N items" text otherwise (default). `'pill'` renders selected items as dismissible pds-chip tags.
           * @default 'count'
          */
         "selectedDisplay"?: 'count' | 'pill';
@@ -6258,7 +6258,7 @@ declare namespace LocalJSX {
     }
     interface PdsPopover {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance, used to build its portal element's `id`. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId"?: string;
         /**
@@ -6332,7 +6332,7 @@ declare namespace LocalJSX {
     }
     interface PdsProperty {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId"?: string;
         /**
@@ -6413,7 +6413,7 @@ declare namespace LocalJSX {
      */
     interface PdsRadioGroup {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance, used to build its helper and error message `id`s. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId"?: string;
         /**
@@ -6594,7 +6594,7 @@ declare namespace LocalJSX {
          */
         "border"?: boolean;
         /**
-          * A unique identifier used for the sortable container `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -6647,7 +6647,7 @@ declare namespace LocalJSX {
      */
     interface PdsSortableItem {
         /**
-          * A unique identifier used for the sortable item `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId"?: string;
         /**
@@ -6681,7 +6681,7 @@ declare namespace LocalJSX {
          */
         "disabled"?: boolean;
         /**
-          * Displays message text describing an invalid state.
+          * Displays an error message below the switch. It becomes the switch's accessible description only while `invalid` is set.
          */
         "errorMessage"?: string;
         /**
@@ -6689,7 +6689,7 @@ declare namespace LocalJSX {
          */
         "form"?: string;
         /**
-          * Displays help text for additional description of an input.
+          * Displays a message or hint below the switch.
          */
         "helperMessage"?: string;
         /**
@@ -6697,12 +6697,12 @@ declare namespace LocalJSX {
          */
         "hideLabel"?: boolean;
         /**
-          * Determines the input 'invalid' state, signifying an error is present.
+          * Determines whether or not the switch is invalid.
           * @default false
          */
         "invalid"?: boolean;
         /**
-          * Displays text to describe the input.
+          * Text to be displayed as the switch label.
          */
         "label"?: string;
         /**
@@ -6710,7 +6710,7 @@ declare namespace LocalJSX {
          */
         "name"?: string;
         /**
-          * Emits an event on input change.
+          * Emitted when the user toggles the switch, by a click or `Space`. `detail` is the native `change` event, so read the new state from the switch's `checked`.  This event will not emit when programmatically setting the `checked` property.
          */
         "onPdsSwitchChange"?: (event: PdsSwitchCustomEvent<InputEvent>) => void;
         /**
@@ -6768,7 +6768,7 @@ declare namespace LocalJSX {
          */
         "compact"?: boolean;
         /**
-          * A unique identifier used for the table `id` attribute.
+          * A unique identifier for this component instance. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -6896,7 +6896,7 @@ declare namespace LocalJSX {
          */
         "activeTabName"?: string;
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance, passed down to its tabs and panels. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId": string;
         /**
@@ -7127,7 +7127,7 @@ declare namespace LocalJSX {
      */
     interface PdsTooltip {
         /**
-          * A unique identifier used for the underlying component `id` attribute.
+          * A unique identifier for this component instance, used to build its portal element's `id`. Does not set the host element's `id` attribute — set `id` directly if you need one.
          */
         "componentId"?: string;
         /**