@porsche-design-system/components-react 4.2.0-rc.4 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (198) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/cjs/lib/components/flyout.wrapper.cjs +3 -3
  3. package/emotion/package.json +1 -8
  4. package/esm/hooks.mjs +1 -1
  5. package/esm/lib/components/accordion.wrapper.d.ts +8 -8
  6. package/esm/lib/components/banner.wrapper.d.ts +16 -16
  7. package/esm/lib/components/button-pure.wrapper.d.ts +32 -32
  8. package/esm/lib/components/button-tile.wrapper.d.ts +28 -28
  9. package/esm/lib/components/button.wrapper.d.ts +24 -24
  10. package/esm/lib/components/canvas.wrapper.d.ts +10 -10
  11. package/esm/lib/components/carousel.wrapper.d.ts +34 -34
  12. package/esm/lib/components/checkbox.wrapper.d.ts +30 -30
  13. package/esm/lib/components/crest.wrapper.d.ts +6 -6
  14. package/esm/lib/components/display.wrapper.d.ts +10 -10
  15. package/esm/lib/components/divider.wrapper.d.ts +4 -4
  16. package/esm/lib/components/drilldown-item.wrapper.d.ts +4 -4
  17. package/esm/lib/components/drilldown-link.wrapper.d.ts +12 -12
  18. package/esm/lib/components/drilldown.wrapper.d.ts +10 -10
  19. package/esm/lib/components/fieldset.wrapper.d.ts +12 -12
  20. package/esm/lib/components/flyout.wrapper.d.ts +31 -21
  21. package/esm/lib/components/flyout.wrapper.mjs +3 -3
  22. package/esm/lib/components/heading.wrapper.d.ts +14 -14
  23. package/esm/lib/components/icon.wrapper.d.ts +10 -10
  24. package/esm/lib/components/inline-notification.wrapper.d.ts +20 -20
  25. package/esm/lib/components/input-date.wrapper.d.ts +40 -40
  26. package/esm/lib/components/input-email.wrapper.d.ts +46 -46
  27. package/esm/lib/components/input-month.wrapper.d.ts +40 -40
  28. package/esm/lib/components/input-number.wrapper.d.ts +38 -38
  29. package/esm/lib/components/input-password.wrapper.d.ts +36 -36
  30. package/esm/lib/components/input-search.wrapper.d.ts +44 -44
  31. package/esm/lib/components/input-tel.wrapper.d.ts +44 -44
  32. package/esm/lib/components/input-text.wrapper.d.ts +44 -44
  33. package/esm/lib/components/input-time.wrapper.d.ts +40 -40
  34. package/esm/lib/components/input-url.wrapper.d.ts +44 -44
  35. package/esm/lib/components/input-week.wrapper.d.ts +40 -40
  36. package/esm/lib/components/link-pure.wrapper.d.ts +28 -28
  37. package/esm/lib/components/link-tile-product.wrapper.d.ts +22 -22
  38. package/esm/lib/components/link-tile.wrapper.d.ts +26 -26
  39. package/esm/lib/components/link.wrapper.d.ts +20 -20
  40. package/esm/lib/components/modal.wrapper.d.ts +20 -20
  41. package/esm/lib/components/model-signature.wrapper.d.ts +12 -12
  42. package/esm/lib/components/multi-select-option.wrapper.d.ts +4 -4
  43. package/esm/lib/components/multi-select.wrapper.d.ts +28 -28
  44. package/esm/lib/components/optgroup.wrapper.d.ts +4 -4
  45. package/esm/lib/components/pagination.wrapper.d.ts +12 -12
  46. package/esm/lib/components/pin-code.wrapper.d.ts +32 -32
  47. package/esm/lib/components/popover.wrapper.d.ts +6 -6
  48. package/esm/lib/components/radio-group-option.wrapper.d.ts +8 -8
  49. package/esm/lib/components/radio-group.wrapper.d.ts +30 -30
  50. package/esm/lib/components/scroller.wrapper.d.ts +6 -6
  51. package/esm/lib/components/segmented-control-item.wrapper.d.ts +12 -12
  52. package/esm/lib/components/segmented-control.wrapper.d.ts +30 -30
  53. package/esm/lib/components/select-option.wrapper.d.ts +4 -4
  54. package/esm/lib/components/select.wrapper.d.ts +30 -30
  55. package/esm/lib/components/sheet.wrapper.d.ts +16 -16
  56. package/esm/lib/components/spinner.wrapper.d.ts +6 -6
  57. package/esm/lib/components/stepper-horizontal-item.wrapper.d.ts +2 -2
  58. package/esm/lib/components/stepper-horizontal.wrapper.d.ts +2 -2
  59. package/esm/lib/components/switch.wrapper.d.ts +16 -16
  60. package/esm/lib/components/table-head-cell.wrapper.d.ts +6 -6
  61. package/esm/lib/components/table.wrapper.d.ts +10 -10
  62. package/esm/lib/components/tabs-bar.wrapper.d.ts +10 -10
  63. package/esm/lib/components/tabs-item.wrapper.d.ts +2 -2
  64. package/esm/lib/components/tabs.wrapper.d.ts +10 -10
  65. package/esm/lib/components/tag-dismissible.wrapper.d.ts +6 -6
  66. package/esm/lib/components/tag.wrapper.d.ts +8 -8
  67. package/esm/lib/components/text-list.wrapper.d.ts +2 -2
  68. package/esm/lib/components/textarea.wrapper.d.ts +48 -48
  69. package/esm/lib/components/wordmark.wrapper.d.ts +8 -8
  70. package/package.json +6 -6
  71. package/ssr/cjs/components/dist/styles/esm/styles-entry.cjs +144 -352
  72. package/ssr/cjs/components/dist/utils/esm/utils-entry.cjs +177 -90
  73. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/components/flyout.wrapper.cjs +4 -4
  74. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/accordion.cjs +1 -1
  75. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/banner.cjs +7 -1
  76. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/canvas.cjs +1 -1
  77. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/carousel.cjs +1 -1
  78. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/checkbox.cjs +1 -1
  79. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/drilldown-item.cjs +1 -1
  80. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/fieldset.cjs +1 -1
  81. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/flyout.cjs +8 -2
  82. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/inline-notification.cjs +1 -1
  83. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/modal.cjs +7 -1
  84. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/multi-select.cjs +1 -1
  85. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/pin-code.cjs +1 -1
  86. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/popover.cjs +2 -2
  87. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/radio-group.cjs +1 -1
  88. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/segmented-control-item.cjs +1 -1
  89. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/select.cjs +1 -1
  90. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/sheet.cjs +7 -1
  91. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/stepper-horizontal.cjs +1 -1
  92. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/table.cjs +1 -1
  93. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/tabs-bar.cjs +1 -1
  94. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/tabs.cjs +1 -1
  95. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/textarea.cjs +1 -1
  96. package/ssr/esm/components/dist/styles/esm/styles-entry.mjs +144 -352
  97. package/ssr/esm/components/dist/utils/esm/utils-entry.mjs +174 -91
  98. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/hooks.mjs +1 -1
  99. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/components/flyout.wrapper.mjs +4 -4
  100. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/accordion.mjs +1 -1
  101. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/banner.mjs +8 -2
  102. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/button.mjs +1 -1
  103. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/canvas.mjs +1 -1
  104. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/carousel.mjs +1 -1
  105. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/checkbox.mjs +1 -1
  106. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/crest.mjs +1 -1
  107. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/drilldown-item.mjs +1 -1
  108. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/fieldset.mjs +1 -1
  109. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/flag.mjs +1 -1
  110. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/flyout.mjs +9 -3
  111. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/icon.mjs +1 -1
  112. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/inline-notification.mjs +1 -1
  113. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/link.mjs +1 -1
  114. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/modal.mjs +8 -2
  115. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/multi-select.mjs +1 -1
  116. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/pin-code.mjs +3 -3
  117. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/popover.mjs +2 -2
  118. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/radio-group.mjs +3 -3
  119. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/segmented-control-item.mjs +1 -1
  120. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/segmented-control.mjs +1 -1
  121. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/select.mjs +1 -1
  122. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/sheet.mjs +8 -2
  123. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/stepper-horizontal.mjs +1 -1
  124. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/table.mjs +1 -1
  125. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/tabs-bar.mjs +1 -1
  126. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/tabs.mjs +1 -1
  127. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/textarea.mjs +1 -1
  128. package/ssr/esm/lib/components/accordion.wrapper.d.ts +8 -8
  129. package/ssr/esm/lib/components/banner.wrapper.d.ts +16 -16
  130. package/ssr/esm/lib/components/button-pure.wrapper.d.ts +32 -32
  131. package/ssr/esm/lib/components/button-tile.wrapper.d.ts +28 -28
  132. package/ssr/esm/lib/components/button.wrapper.d.ts +24 -24
  133. package/ssr/esm/lib/components/canvas.wrapper.d.ts +10 -10
  134. package/ssr/esm/lib/components/carousel.wrapper.d.ts +34 -34
  135. package/ssr/esm/lib/components/checkbox.wrapper.d.ts +30 -30
  136. package/ssr/esm/lib/components/crest.wrapper.d.ts +6 -6
  137. package/ssr/esm/lib/components/display.wrapper.d.ts +10 -10
  138. package/ssr/esm/lib/components/divider.wrapper.d.ts +4 -4
  139. package/ssr/esm/lib/components/drilldown-item.wrapper.d.ts +4 -4
  140. package/ssr/esm/lib/components/drilldown-link.wrapper.d.ts +12 -12
  141. package/ssr/esm/lib/components/drilldown.wrapper.d.ts +10 -10
  142. package/ssr/esm/lib/components/fieldset.wrapper.d.ts +12 -12
  143. package/ssr/esm/lib/components/flyout.wrapper.d.ts +31 -21
  144. package/ssr/esm/lib/components/heading.wrapper.d.ts +14 -14
  145. package/ssr/esm/lib/components/icon.wrapper.d.ts +10 -10
  146. package/ssr/esm/lib/components/inline-notification.wrapper.d.ts +20 -20
  147. package/ssr/esm/lib/components/input-date.wrapper.d.ts +40 -40
  148. package/ssr/esm/lib/components/input-email.wrapper.d.ts +46 -46
  149. package/ssr/esm/lib/components/input-month.wrapper.d.ts +40 -40
  150. package/ssr/esm/lib/components/input-number.wrapper.d.ts +38 -38
  151. package/ssr/esm/lib/components/input-password.wrapper.d.ts +36 -36
  152. package/ssr/esm/lib/components/input-search.wrapper.d.ts +44 -44
  153. package/ssr/esm/lib/components/input-tel.wrapper.d.ts +44 -44
  154. package/ssr/esm/lib/components/input-text.wrapper.d.ts +44 -44
  155. package/ssr/esm/lib/components/input-time.wrapper.d.ts +40 -40
  156. package/ssr/esm/lib/components/input-url.wrapper.d.ts +44 -44
  157. package/ssr/esm/lib/components/input-week.wrapper.d.ts +40 -40
  158. package/ssr/esm/lib/components/link-pure.wrapper.d.ts +28 -28
  159. package/ssr/esm/lib/components/link-tile-product.wrapper.d.ts +22 -22
  160. package/ssr/esm/lib/components/link-tile.wrapper.d.ts +26 -26
  161. package/ssr/esm/lib/components/link.wrapper.d.ts +20 -20
  162. package/ssr/esm/lib/components/modal.wrapper.d.ts +20 -20
  163. package/ssr/esm/lib/components/model-signature.wrapper.d.ts +12 -12
  164. package/ssr/esm/lib/components/multi-select-option.wrapper.d.ts +4 -4
  165. package/ssr/esm/lib/components/multi-select.wrapper.d.ts +28 -28
  166. package/ssr/esm/lib/components/optgroup.wrapper.d.ts +4 -4
  167. package/ssr/esm/lib/components/pagination.wrapper.d.ts +12 -12
  168. package/ssr/esm/lib/components/pin-code.wrapper.d.ts +32 -32
  169. package/ssr/esm/lib/components/popover.wrapper.d.ts +6 -6
  170. package/ssr/esm/lib/components/radio-group-option.wrapper.d.ts +8 -8
  171. package/ssr/esm/lib/components/radio-group.wrapper.d.ts +30 -30
  172. package/ssr/esm/lib/components/scroller.wrapper.d.ts +6 -6
  173. package/ssr/esm/lib/components/segmented-control-item.wrapper.d.ts +12 -12
  174. package/ssr/esm/lib/components/segmented-control.wrapper.d.ts +30 -30
  175. package/ssr/esm/lib/components/select-option.wrapper.d.ts +4 -4
  176. package/ssr/esm/lib/components/select.wrapper.d.ts +30 -30
  177. package/ssr/esm/lib/components/sheet.wrapper.d.ts +16 -16
  178. package/ssr/esm/lib/components/spinner.wrapper.d.ts +6 -6
  179. package/ssr/esm/lib/components/stepper-horizontal-item.wrapper.d.ts +2 -2
  180. package/ssr/esm/lib/components/stepper-horizontal.wrapper.d.ts +2 -2
  181. package/ssr/esm/lib/components/switch.wrapper.d.ts +16 -16
  182. package/ssr/esm/lib/components/table-head-cell.wrapper.d.ts +6 -6
  183. package/ssr/esm/lib/components/table.wrapper.d.ts +10 -10
  184. package/ssr/esm/lib/components/tabs-bar.wrapper.d.ts +10 -10
  185. package/ssr/esm/lib/components/tabs-item.wrapper.d.ts +2 -2
  186. package/ssr/esm/lib/components/tabs.wrapper.d.ts +10 -10
  187. package/ssr/esm/lib/components/tag-dismissible.wrapper.d.ts +6 -6
  188. package/ssr/esm/lib/components/tag.wrapper.d.ts +8 -8
  189. package/ssr/esm/lib/components/text-list.wrapper.d.ts +2 -2
  190. package/ssr/esm/lib/components/textarea.wrapper.d.ts +48 -48
  191. package/ssr/esm/lib/components/wordmark.wrapper.d.ts +8 -8
  192. package/ssr/esm/lib/dsr-components/banner.d.ts +1 -0
  193. package/ssr/esm/lib/dsr-components/flyout.d.ts +1 -0
  194. package/ssr/esm/lib/dsr-components/modal.d.ts +1 -0
  195. package/ssr/esm/lib/dsr-components/popover.d.ts +1 -1
  196. package/ssr/esm/lib/dsr-components/sheet.d.ts +1 -0
  197. package/tailwindcss/index.css +57 -75
  198. package/vanilla-extract/package.json +1 -8
@@ -2,72 +2,72 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { SelectDropdownDirection, BreakpointCustomizable, SelectChangeEventDetail, SelectToggleEventDetail, SelectState } from '../types';
3
3
  export type PSelectProps = BaseProps & {
4
4
  /**
5
- * Displays the select in compact mode.
5
+ * Reduces the control height and padding for use in dense layouts where vertical space is limited.
6
6
  * @default false
7
7
  */
8
8
  compact?: boolean;
9
9
  /**
10
- * Supplementary text providing more context or explanation for the select.
10
+ * Sets a supplementary description displayed below the label to give users additional guidance about the select.
11
11
  * @default ''
12
12
  */
13
13
  description?: string;
14
14
  /**
15
- * Disables the select.
15
+ * Prevents user interaction with the select and excludes its value from form submissions.
16
16
  * @default false
17
17
  */
18
18
  disabled?: boolean;
19
19
  /**
20
- * Changes the direction to which the dropdown list appears.
20
+ * Controls whether the dropdown list opens upward (`up`) or downward (`down`), or determines the direction automatically (`auto`).
21
21
  * @default 'auto'
22
22
  */
23
23
  dropdownDirection?: SelectDropdownDirection;
24
24
  /**
25
- * Shows an input in the dropdown allowing options to be filtered. Will be ignored if the `filter` slot is used.
25
+ * Shows a text input inside the dropdown that filters the visible options as the user types. Ignored when the `filter` slot is used.
26
26
  * @default false
27
27
  */
28
28
  filter?: boolean;
29
29
  /**
30
- * The id of a form element the select should be associated with.
30
+ * Associates the select with a form element by its ID when it is not a direct descendant of that form.
31
31
  */
32
32
  form?: string;
33
33
  /**
34
- * Shows or hides the label. For better accessibility, it is recommended to show the label.
34
+ * Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
35
35
  * @default false
36
36
  */
37
37
  hideLabel?: BreakpointCustomizable<boolean>;
38
38
  /**
39
- * Text content for a user-facing label.
39
+ * Sets the visible label text displayed above the select control to identify its purpose.
40
40
  * @default ''
41
41
  */
42
42
  label?: string;
43
43
  /**
44
- * The message styled depending on validation state.
44
+ * Sets the validation feedback message displayed below the select when `state` is `success` or `error`.
45
45
  * @default ''
46
46
  */
47
47
  message?: string;
48
48
  /**
49
- * The name of the control.
49
+ * Sets the name of the control submitted with the form data, identifying the selected value on the server.
50
50
  */
51
51
  name: string;
52
52
  /**
53
- * Emitted when the select has lost focus.
53
+ * Emitted when the select component loses focus, useful for triggering validation on blur.
54
54
  */
55
55
  onBlur?: (event: CustomEvent<void>) => void;
56
56
  /**
57
- * Emitted when the selection is changed.
57
+ * Emitted when the user selects a different option, carrying the new value in the event detail.
58
58
  */
59
59
  onChange?: (event: CustomEvent<SelectChangeEventDetail>) => void;
60
60
  /**
61
- * Emitted when the dropdown is toggled.
61
+ * Emitted when the dropdown list opens or closes, carrying the new `isOpen` state in the event detail.
62
62
  */
63
63
  onToggle?: (event: CustomEvent<SelectToggleEventDetail>) => void;
64
64
  /**
65
- * Requires an option with a non-empty string value to be selected.
65
+ * Marks the select as required so the form cannot be submitted unless a non-empty option is selected.
66
66
  * @default false
67
67
  */
68
68
  required?: boolean;
69
69
  /**
70
- * The validation state.
70
+ * Sets the validation state of the select, which controls its visual appearance and feedback message style (`none`, `success`, `error`).
71
71
  * @default 'none'
72
72
  */
73
73
  state?: SelectState;
@@ -78,72 +78,72 @@ export type PSelectProps = BaseProps & {
78
78
  };
79
79
  export declare const PSelect: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
80
80
  /**
81
- * Displays the select in compact mode.
81
+ * Reduces the control height and padding for use in dense layouts where vertical space is limited.
82
82
  * @default false
83
83
  */
84
84
  compact?: boolean;
85
85
  /**
86
- * Supplementary text providing more context or explanation for the select.
86
+ * Sets a supplementary description displayed below the label to give users additional guidance about the select.
87
87
  * @default ''
88
88
  */
89
89
  description?: string;
90
90
  /**
91
- * Disables the select.
91
+ * Prevents user interaction with the select and excludes its value from form submissions.
92
92
  * @default false
93
93
  */
94
94
  disabled?: boolean;
95
95
  /**
96
- * Changes the direction to which the dropdown list appears.
96
+ * Controls whether the dropdown list opens upward (`up`) or downward (`down`), or determines the direction automatically (`auto`).
97
97
  * @default 'auto'
98
98
  */
99
99
  dropdownDirection?: SelectDropdownDirection;
100
100
  /**
101
- * Shows an input in the dropdown allowing options to be filtered. Will be ignored if the `filter` slot is used.
101
+ * Shows a text input inside the dropdown that filters the visible options as the user types. Ignored when the `filter` slot is used.
102
102
  * @default false
103
103
  */
104
104
  filter?: boolean;
105
105
  /**
106
- * The id of a form element the select should be associated with.
106
+ * Associates the select with a form element by its ID when it is not a direct descendant of that form.
107
107
  */
108
108
  form?: string;
109
109
  /**
110
- * Shows or hides the label. For better accessibility, it is recommended to show the label.
110
+ * Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
111
111
  * @default false
112
112
  */
113
113
  hideLabel?: BreakpointCustomizable<boolean>;
114
114
  /**
115
- * Text content for a user-facing label.
115
+ * Sets the visible label text displayed above the select control to identify its purpose.
116
116
  * @default ''
117
117
  */
118
118
  label?: string;
119
119
  /**
120
- * The message styled depending on validation state.
120
+ * Sets the validation feedback message displayed below the select when `state` is `success` or `error`.
121
121
  * @default ''
122
122
  */
123
123
  message?: string;
124
124
  /**
125
- * The name of the control.
125
+ * Sets the name of the control submitted with the form data, identifying the selected value on the server.
126
126
  */
127
127
  name: string;
128
128
  /**
129
- * Emitted when the select has lost focus.
129
+ * Emitted when the select component loses focus, useful for triggering validation on blur.
130
130
  */
131
131
  onBlur?: (event: CustomEvent<void>) => void;
132
132
  /**
133
- * Emitted when the selection is changed.
133
+ * Emitted when the user selects a different option, carrying the new value in the event detail.
134
134
  */
135
135
  onChange?: (event: CustomEvent<SelectChangeEventDetail>) => void;
136
136
  /**
137
- * Emitted when the dropdown is toggled.
137
+ * Emitted when the dropdown list opens or closes, carrying the new `isOpen` state in the event detail.
138
138
  */
139
139
  onToggle?: (event: CustomEvent<SelectToggleEventDetail>) => void;
140
140
  /**
141
- * Requires an option with a non-empty string value to be selected.
141
+ * Marks the select as required so the form cannot be submitted unless a non-empty option is selected.
142
142
  * @default false
143
143
  */
144
144
  required?: boolean;
145
145
  /**
146
- * The validation state.
146
+ * Sets the validation state of the select, which controls its visual appearance and feedback message style (`none`, `success`, `error`).
147
147
  * @default 'none'
148
148
  */
149
149
  state?: SelectState;
@@ -2,76 +2,76 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { SelectedAriaAttributes, SheetAriaAttribute, SheetBackground, SheetMotionHiddenEndEventDetail, SheetMotionVisibleEndEventDetail } from '../types';
3
3
  export type PSheetProps = BaseProps & {
4
4
  /**
5
- * Sets ARIA attributes.
5
+ * Sets ARIA attributes on the sheet dialog element for improved accessibility when the default `aria-label` is insufficient.
6
6
  */
7
7
  aria?: SelectedAriaAttributes<SheetAriaAttribute>;
8
8
  /**
9
- * Defines the background color
9
+ * Sets the background color of the sheet panel (`canvas` or `surface`).
10
10
  * @default 'canvas'
11
11
  */
12
12
  background?: SheetBackground;
13
13
  /**
14
- * If true, the sheet will not be closable via backdrop click.
14
+ * When enabled, clicking the backdrop will not close the sheet.
15
15
  * @default false
16
16
  */
17
17
  disableBackdropClick?: boolean;
18
18
  /**
19
- * If false, the sheet will not have a dismiss button.
19
+ * Shows a dismiss button in the sheet header so users can manually close it.
20
20
  * @default true
21
21
  */
22
22
  dismissButton?: boolean;
23
23
  /**
24
- * Emitted when the component requests to be dismissed.
24
+ * Emitted when the user dismisses the sheet via the close button, backdrop click, or Escape key.
25
25
  */
26
26
  onDismiss?: (event: CustomEvent<void>) => void;
27
27
  /**
28
- * Emitted when the sheet is closed and the transition is finished.
28
+ * Emitted after the sheet's close transition has fully completed and the panel is hidden.
29
29
  */
30
30
  onMotionHiddenEnd?: (event: CustomEvent<SheetMotionHiddenEndEventDetail>) => void;
31
31
  /**
32
- * Emitted when the sheet is opened and the transition is finished.
32
+ * Emitted after the sheet's open transition has fully completed and the panel is visible.
33
33
  */
34
34
  onMotionVisibleEnd?: (event: CustomEvent<SheetMotionVisibleEndEventDetail>) => void;
35
35
  /**
36
- * If true, the sheet is open.
36
+ * Controls whether the sheet panel slides in from the bottom and is visible to the user.
37
37
  * @default false
38
38
  */
39
39
  open: boolean;
40
40
  };
41
41
  export declare const PSheet: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
42
42
  /**
43
- * Sets ARIA attributes.
43
+ * Sets ARIA attributes on the sheet dialog element for improved accessibility when the default `aria-label` is insufficient.
44
44
  */
45
45
  aria?: SelectedAriaAttributes<SheetAriaAttribute>;
46
46
  /**
47
- * Defines the background color
47
+ * Sets the background color of the sheet panel (`canvas` or `surface`).
48
48
  * @default 'canvas'
49
49
  */
50
50
  background?: SheetBackground;
51
51
  /**
52
- * If true, the sheet will not be closable via backdrop click.
52
+ * When enabled, clicking the backdrop will not close the sheet.
53
53
  * @default false
54
54
  */
55
55
  disableBackdropClick?: boolean;
56
56
  /**
57
- * If false, the sheet will not have a dismiss button.
57
+ * Shows a dismiss button in the sheet header so users can manually close it.
58
58
  * @default true
59
59
  */
60
60
  dismissButton?: boolean;
61
61
  /**
62
- * Emitted when the component requests to be dismissed.
62
+ * Emitted when the user dismisses the sheet via the close button, backdrop click, or Escape key.
63
63
  */
64
64
  onDismiss?: (event: CustomEvent<void>) => void;
65
65
  /**
66
- * Emitted when the sheet is closed and the transition is finished.
66
+ * Emitted after the sheet's close transition has fully completed and the panel is hidden.
67
67
  */
68
68
  onMotionHiddenEnd?: (event: CustomEvent<SheetMotionHiddenEndEventDetail>) => void;
69
69
  /**
70
- * Emitted when the sheet is opened and the transition is finished.
70
+ * Emitted after the sheet's open transition has fully completed and the panel is visible.
71
71
  */
72
72
  onMotionVisibleEnd?: (event: CustomEvent<SheetMotionVisibleEndEventDetail>) => void;
73
73
  /**
74
- * If true, the sheet is open.
74
+ * Controls whether the sheet panel slides in from the bottom and is visible to the user.
75
75
  * @default false
76
76
  */
77
77
  open: boolean;
@@ -2,32 +2,32 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { SelectedAriaAttributes, SpinnerAriaAttribute, SpinnerColor, BreakpointCustomizable, SpinnerSize } from '../types';
3
3
  export type PSpinnerProps = BaseProps & {
4
4
  /**
5
- * Sets ARIA attributes.
5
+ * Sets ARIA attributes on the spinner's live region element; use `aria-label` to provide a descriptive loading message for screen readers.
6
6
  */
7
7
  aria?: SelectedAriaAttributes<SpinnerAriaAttribute>;
8
8
  /**
9
- * Basic color variations.
9
+ * Sets the color of the spinning indicator using PDS semantic color tokens (e.g. `primary`, `contrast-high`, `inherit`).
10
10
  * @default 'primary'
11
11
  */
12
12
  color?: SpinnerColor;
13
13
  /**
14
- * Defines the size of the spinner, aligned with the typographic scale used by components such as p-icon, p-flag, p-text, and p-heading. When set to `inherit`, the size is derived from a custom font-size defined on a parent element, calculated against the global line-height (based on `ex`-unit) to remain visually consistent with other typographic-scale-based components.
14
+ * Sets the size of the spinner using the PDS typographic scale. Use `inherit` to derive the size from the parent element's font-size. Supports responsive breakpoint values.
15
15
  * @default 'sm'
16
16
  */
17
17
  size?: BreakpointCustomizable<SpinnerSize>;
18
18
  };
19
19
  export declare const PSpinner: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
20
20
  /**
21
- * Sets ARIA attributes.
21
+ * Sets ARIA attributes on the spinner's live region element; use `aria-label` to provide a descriptive loading message for screen readers.
22
22
  */
23
23
  aria?: SelectedAriaAttributes<SpinnerAriaAttribute>;
24
24
  /**
25
- * Basic color variations.
25
+ * Sets the color of the spinning indicator using PDS semantic color tokens (e.g. `primary`, `contrast-high`, `inherit`).
26
26
  * @default 'primary'
27
27
  */
28
28
  color?: SpinnerColor;
29
29
  /**
30
- * Defines the size of the spinner, aligned with the typographic scale used by components such as p-icon, p-flag, p-text, and p-heading. When set to `inherit`, the size is derived from a custom font-size defined on a parent element, calculated against the global line-height (based on `ex`-unit) to remain visually consistent with other typographic-scale-based components.
30
+ * Sets the size of the spinner using the PDS typographic scale. Use `inherit` to derive the size from the parent element's font-size. Supports responsive breakpoint values.
31
31
  * @default 'sm'
32
32
  */
33
33
  size?: BreakpointCustomizable<SpinnerSize>;
@@ -7,7 +7,7 @@ export type PStepperHorizontalItemProps = BaseProps & {
7
7
  */
8
8
  disabled?: boolean;
9
9
  /**
10
- * The validation state.
10
+ * The current progression state of the step. Use `current` for the active step, `complete` for finished steps, `warning` for steps with issues. Leave unset for future steps.
11
11
  */
12
12
  state?: StepperHorizontalItemState;
13
13
  };
@@ -18,7 +18,7 @@ export declare const PStepperHorizontalItem: import("react").ForwardRefExoticCom
18
18
  */
19
19
  disabled?: boolean;
20
20
  /**
21
- * The validation state.
21
+ * The current progression state of the step. Use `current` for the active step, `complete` for finished steps, `warning` for steps with issues. Leave unset for future steps.
22
22
  */
23
23
  state?: StepperHorizontalItemState;
24
24
  } & {
@@ -6,7 +6,7 @@ export type PStepperHorizontalProps = BaseProps & {
6
6
  */
7
7
  onUpdate?: (event: CustomEvent<StepperHorizontalUpdateEventDetail>) => void;
8
8
  /**
9
- * The text size.
9
+ * The font size of the step labels.
10
10
  * @default 'small'
11
11
  */
12
12
  size?: BreakpointCustomizable<StepperHorizontalSize>;
@@ -17,7 +17,7 @@ export declare const PStepperHorizontal: import("react").ForwardRefExoticCompone
17
17
  */
18
18
  onUpdate?: (event: CustomEvent<StepperHorizontalUpdateEventDetail>) => void;
19
19
  /**
20
- * The text size.
20
+ * The font size of the step labels.
21
21
  * @default 'small'
22
22
  */
23
23
  size?: BreakpointCustomizable<StepperHorizontalSize>;
@@ -2,82 +2,82 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { BreakpointCustomizable, SwitchAlignLabel, SwitchUpdateEventDetail } from '../types';
3
3
  export type PSwitchProps = BaseProps & {
4
4
  /**
5
- * Aligns the label.
5
+ * Sets the position of the slotted label relative to the switch toggle, either before (`start`) or after (`end`) it. Supports responsive breakpoint values.
6
6
  * @default 'end'
7
7
  */
8
8
  alignLabel?: BreakpointCustomizable<SwitchAlignLabel>;
9
9
  /**
10
- * Visualize the switch with on/off status.
10
+ * Reflects the switch's current on/off state and allows setting the initial checked value when the component first renders.
11
11
  * @default false
12
12
  */
13
13
  checked?: boolean;
14
14
  /**
15
- * Displays the switch in compact mode.
15
+ * Reduces the switch size and spacing for use in dense layouts where vertical space is limited.
16
16
  * @default false
17
17
  */
18
18
  compact?: boolean;
19
19
  /**
20
- * Disables the switch. No events will be triggered while disabled state is active.
20
+ * Prevents user interaction with the switch and blocks all click and keyboard events while it is disabled.
21
21
  * @default false
22
22
  */
23
23
  disabled?: boolean;
24
24
  /**
25
- * Shows or hides the label. For better accessibility, it is recommended to show the label.
25
+ * Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
26
26
  * @default false
27
27
  */
28
28
  hideLabel?: BreakpointCustomizable<boolean>;
29
29
  /**
30
- * Disables the switch and shows a loading indicator. No events will be triggered while loading state is active.
30
+ * Disables the switch and shows a loading spinner to indicate an ongoing asynchronous toggle operation.
31
31
  * @default false
32
32
  */
33
33
  loading?: boolean;
34
34
  /**
35
- * Emitted when the checked state changes.
35
+ * Emitted when the user toggles the switch, carrying the new `checked` state in the event detail.
36
36
  */
37
37
  onUpdate?: (event: CustomEvent<SwitchUpdateEventDetail>) => void;
38
38
  /**
39
- * Stretches the contents to max available space.
39
+ * Expands the space between the switch toggle and its label to fill the full available width of the container. Supports responsive breakpoint values.
40
40
  * @default false
41
41
  */
42
42
  stretch?: BreakpointCustomizable<boolean>;
43
43
  };
44
44
  export declare const PSwitch: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
45
45
  /**
46
- * Aligns the label.
46
+ * Sets the position of the slotted label relative to the switch toggle, either before (`start`) or after (`end`) it. Supports responsive breakpoint values.
47
47
  * @default 'end'
48
48
  */
49
49
  alignLabel?: BreakpointCustomizable<SwitchAlignLabel>;
50
50
  /**
51
- * Visualize the switch with on/off status.
51
+ * Reflects the switch's current on/off state and allows setting the initial checked value when the component first renders.
52
52
  * @default false
53
53
  */
54
54
  checked?: boolean;
55
55
  /**
56
- * Displays the switch in compact mode.
56
+ * Reduces the switch size and spacing for use in dense layouts where vertical space is limited.
57
57
  * @default false
58
58
  */
59
59
  compact?: boolean;
60
60
  /**
61
- * Disables the switch. No events will be triggered while disabled state is active.
61
+ * Prevents user interaction with the switch and blocks all click and keyboard events while it is disabled.
62
62
  * @default false
63
63
  */
64
64
  disabled?: boolean;
65
65
  /**
66
- * Shows or hides the label. For better accessibility, it is recommended to show the label.
66
+ * Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
67
67
  * @default false
68
68
  */
69
69
  hideLabel?: BreakpointCustomizable<boolean>;
70
70
  /**
71
- * Disables the switch and shows a loading indicator. No events will be triggered while loading state is active.
71
+ * Disables the switch and shows a loading spinner to indicate an ongoing asynchronous toggle operation.
72
72
  * @default false
73
73
  */
74
74
  loading?: boolean;
75
75
  /**
76
- * Emitted when the checked state changes.
76
+ * Emitted when the user toggles the switch, carrying the new `checked` state in the event detail.
77
77
  */
78
78
  onUpdate?: (event: CustomEvent<SwitchUpdateEventDetail>) => void;
79
79
  /**
80
- * Stretches the contents to max available space.
80
+ * Expands the space between the switch toggle and its label to fill the full available width of the container. Supports responsive breakpoint values.
81
81
  * @default false
82
82
  */
83
83
  stretch?: BreakpointCustomizable<boolean>;
@@ -2,33 +2,33 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { TableHeadCellSort } from '../types';
3
3
  export type PTableHeadCellProps = BaseProps & {
4
4
  /**
5
- * Hides the label but keeps it accessible for screen readers. This property only takes effect when the `sort` prop is not set.
5
+ * Hides the visible column label while keeping it accessible to screen readers. Only applies when `sort` is not set.
6
6
  * @default false
7
7
  */
8
8
  hideLabel?: boolean;
9
9
  /**
10
- * Allows slotted text to wrap onto multiple lines instead of being forced onto a single line.
10
+ * Allows the column header text to wrap onto multiple lines instead of being truncated to a single line.
11
11
  * @default false
12
12
  */
13
13
  multiline?: boolean;
14
14
  /**
15
- * Defines sortability properties.
15
+ * Configures sorting behavior for this column by providing an `id`, `active` state, and current `direction` (`asc` or `desc`).
16
16
  */
17
17
  sort?: TableHeadCellSort;
18
18
  };
19
19
  export declare const PTableHeadCell: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
20
20
  /**
21
- * Hides the label but keeps it accessible for screen readers. This property only takes effect when the `sort` prop is not set.
21
+ * Hides the visible column label while keeping it accessible to screen readers. Only applies when `sort` is not set.
22
22
  * @default false
23
23
  */
24
24
  hideLabel?: boolean;
25
25
  /**
26
- * Allows slotted text to wrap onto multiple lines instead of being forced onto a single line.
26
+ * Allows the column header text to wrap onto multiple lines instead of being truncated to a single line.
27
27
  * @default false
28
28
  */
29
29
  multiline?: boolean;
30
30
  /**
31
- * Defines sortability properties.
31
+ * Configures sorting behavior for this column by providing an `id`, `active` state, and current `direction` (`asc` or `desc`).
32
32
  */
33
33
  sort?: TableHeadCellSort;
34
34
  } & {
@@ -2,50 +2,50 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { TableLayout, TableUpdateEventDetail } from '../types';
3
3
  export type PTableProps = BaseProps & {
4
4
  /**
5
- * A caption describing the contents of the table for accessibility only. This won't be visible in the browser. Use an element with an attribute of `slot="caption"` for a visible caption.
5
+ * Sets a screen-reader-only accessible caption that describes the table's content; it is not visible in the browser. Use an element with `slot="caption"` for a visible caption instead.
6
6
  */
7
7
  caption?: string;
8
8
  /**
9
- * Displays with reduced spacing and smaller padding for a more condensed layout.
9
+ * Reduces the cell padding and spacing for a more condensed table layout in data-dense UIs.
10
10
  * @default false
11
11
  */
12
12
  compact?: boolean;
13
13
  /**
14
- * Controls the layout behavior of the table.
14
+ * Controls the CSS `table-layout` algorithm: `auto` sizes columns to fit their content, `fixed` distributes width equally.
15
15
  * @default 'auto'
16
16
  */
17
17
  layout?: TableLayout;
18
18
  /**
19
- * Emitted when sorting is changed.
19
+ * Emitted when the user clicks a sortable column header, carrying the new sort configuration in the event detail.
20
20
  */
21
21
  onUpdate?: (event: CustomEvent<TableUpdateEventDetail>) => void;
22
22
  /**
23
- * @experimental Makes the scroll indicator sticky at the top or bottom while scrolling depending on the scroll direction.
23
+ * @experimental Makes the scroll position indicator sticky at the viewport edge while scrolling, indicating overflow in the table.
24
24
  * @default false
25
25
  */
26
26
  sticky?: boolean;
27
27
  };
28
28
  export declare const PTable: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
29
29
  /**
30
- * A caption describing the contents of the table for accessibility only. This won't be visible in the browser. Use an element with an attribute of `slot="caption"` for a visible caption.
30
+ * Sets a screen-reader-only accessible caption that describes the table's content; it is not visible in the browser. Use an element with `slot="caption"` for a visible caption instead.
31
31
  */
32
32
  caption?: string;
33
33
  /**
34
- * Displays with reduced spacing and smaller padding for a more condensed layout.
34
+ * Reduces the cell padding and spacing for a more condensed table layout in data-dense UIs.
35
35
  * @default false
36
36
  */
37
37
  compact?: boolean;
38
38
  /**
39
- * Controls the layout behavior of the table.
39
+ * Controls the CSS `table-layout` algorithm: `auto` sizes columns to fit their content, `fixed` distributes width equally.
40
40
  * @default 'auto'
41
41
  */
42
42
  layout?: TableLayout;
43
43
  /**
44
- * Emitted when sorting is changed.
44
+ * Emitted when the user clicks a sortable column header, carrying the new sort configuration in the event detail.
45
45
  */
46
46
  onUpdate?: (event: CustomEvent<TableUpdateEventDetail>) => void;
47
47
  /**
48
- * @experimental Makes the scroll indicator sticky at the top or bottom while scrolling depending on the scroll direction.
48
+ * @experimental Makes the scroll position indicator sticky at the viewport edge while scrolling, indicating overflow in the table.
49
49
  * @default false
50
50
  */
51
51
  sticky?: boolean;
@@ -2,24 +2,24 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { TabsBarBackground, TabsBarUpdateEventDetail, BreakpointCustomizable, TabsBarSize, TabsBarWeight } from '../types';
3
3
  export type PTabsBarProps = BaseProps & {
4
4
  /**
5
- * Defines which tab is shown as selected (zero-based numbering), or `undefined` if none should be selected.
5
+ * Sets the zero-based index of the currently active tab. Pass `undefined` to render all tabs in an unselected state.
6
6
  */
7
7
  activeTabIndex?: number | undefined;
8
8
  /**
9
- * Defines the background color. Use `frosted` only on images, videos or gradients.
9
+ * Sets the background color of the tabs bar. Use `frosted` only when placed on top of images, videos, or gradients.
10
10
  * @default 'none'
11
11
  */
12
12
  background?: TabsBarBackground;
13
13
  /**
14
- * Displays with reduced spacing and smaller padding for a more condensed layout.
14
+ * Reduces the tab height and padding for use in dense layouts where vertical space is limited.
15
15
  */
16
16
  compact?: boolean;
17
17
  /**
18
- * Emitted when active tab is changed.
18
+ * Emitted when the user clicks a different tab, carrying the new `activeTabIndex` in the event detail.
19
19
  */
20
20
  onUpdate?: (event: CustomEvent<TabsBarUpdateEventDetail>) => void;
21
21
  /**
22
- * The text size.
22
+ * Sets the font size of the tab labels using the PDS typographic scale. Supports responsive breakpoint values.
23
23
  * @default 'small'
24
24
  */
25
25
  size?: BreakpointCustomizable<TabsBarSize>;
@@ -31,24 +31,24 @@ export type PTabsBarProps = BaseProps & {
31
31
  };
32
32
  export declare const PTabsBar: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
33
33
  /**
34
- * Defines which tab is shown as selected (zero-based numbering), or `undefined` if none should be selected.
34
+ * Sets the zero-based index of the currently active tab. Pass `undefined` to render all tabs in an unselected state.
35
35
  */
36
36
  activeTabIndex?: number | undefined;
37
37
  /**
38
- * Defines the background color. Use `frosted` only on images, videos or gradients.
38
+ * Sets the background color of the tabs bar. Use `frosted` only when placed on top of images, videos, or gradients.
39
39
  * @default 'none'
40
40
  */
41
41
  background?: TabsBarBackground;
42
42
  /**
43
- * Displays with reduced spacing and smaller padding for a more condensed layout.
43
+ * Reduces the tab height and padding for use in dense layouts where vertical space is limited.
44
44
  */
45
45
  compact?: boolean;
46
46
  /**
47
- * Emitted when active tab is changed.
47
+ * Emitted when the user clicks a different tab, carrying the new `activeTabIndex` in the event detail.
48
48
  */
49
49
  onUpdate?: (event: CustomEvent<TabsBarUpdateEventDetail>) => void;
50
50
  /**
51
- * The text size.
51
+ * Sets the font size of the tab labels using the PDS typographic scale. Supports responsive breakpoint values.
52
52
  * @default 'small'
53
53
  */
54
54
  size?: BreakpointCustomizable<TabsBarSize>;