@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,162 +2,162 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { CarouselAlignControls, CarouselAlignHeader, SelectedAriaAttributes, CarouselAriaAttribute, CarouselHeadingSize, CarouselInternationalization, CarouselUpdateEventDetail, BreakpointCustomizable, CarouselSlidesPerPage, CarouselWidth } from '../types';
3
3
  export type PCarouselProps = BaseProps & {
4
4
  /**
5
- * Defines which slide is active (zero-based numbering).
5
+ * Sets the zero-based index of the currently visible slide. Update this to navigate programmatically.
6
6
  * @default 0
7
7
  */
8
8
  activeSlideIndex?: number;
9
9
  /**
10
- * Aligns the slotted controls.
10
+ * Controls the alignment of custom slotted controls within the header area.
11
11
  * @default 'auto'
12
12
  */
13
13
  alignControls?: CarouselAlignControls;
14
14
  /**
15
- * Aligns the heading and description.
15
+ * Controls the horizontal alignment of the heading and description.
16
16
  * @default 'start'
17
17
  */
18
18
  alignHeader?: CarouselAlignHeader;
19
19
  /**
20
- * Sets ARIA attributes.
20
+ * Sets ARIA attributes on the carousel region element for improved accessibility.
21
21
  */
22
22
  aria?: SelectedAriaAttributes<CarouselAriaAttribute>;
23
23
  /**
24
- * Defines the description used in the carousel.
24
+ * Sets the description text displayed below the heading for additional context.
25
25
  */
26
26
  description?: string;
27
27
  /**
28
- * Indicates whether focus should be set on the center slide. If true, the carousel loops by individual slide; otherwise, it loops by page.
28
+ * When enabled, each slide is individually focusable and the carousel navigates one slide at a time instead of one page.
29
29
  * @default false
30
30
  */
31
31
  focusOnCenterSlide?: boolean;
32
32
  /**
33
- * Fades the slides out.
33
+ * Shows a gradient fade at the start and end edges to visually indicate more slides beyond the viewport.
34
34
  * @default false
35
35
  */
36
36
  gradient?: boolean;
37
37
  /**
38
- * Defines the heading used in the carousel.
38
+ * Sets the heading text displayed above the carousel. Also used as the accessible label when no `aria` prop is set.
39
39
  */
40
40
  heading?: string;
41
41
  /**
42
- * Defines the heading size used in the carousel.
42
+ * Sets the font size of the carousel heading.
43
43
  * @default 'x-large'
44
44
  */
45
45
  headingSize?: CarouselHeadingSize;
46
46
  /**
47
- * Override the default wordings that are used for aria-labels on the next/prev buttons and pagination.
47
+ * Overrides the default label strings used for the previous, next, and page indicators — useful for localization.
48
48
  */
49
49
  intl?: CarouselInternationalization;
50
50
  /**
51
- * Emitted when carousel's content slides.
51
+ * Emitted when the carousel navigates to a new slide, with the active and previous slide indexes in the event detail.
52
52
  */
53
53
  onUpdate?: (event: CustomEvent<CarouselUpdateEventDetail>) => void;
54
54
  /**
55
- * If false, the carousel will not show pagination bullets at the bottom.
55
+ * Shows pagination dot indicators below the carousel. Supports responsive breakpoint values.
56
56
  * @default false
57
57
  */
58
58
  pagination?: BreakpointCustomizable<boolean>;
59
59
  /**
60
- * Whether the slides should rewind from last to first slide and vice versa.
60
+ * Enables infinite looping navigating past the last slide wraps back to the first, and vice versa.
61
61
  * @default false
62
62
  */
63
63
  rewind?: boolean;
64
64
  /**
65
- * Defines the skip link target used to skip carousel entries.
65
+ * Sets the `href` of an in-page skip link that lets keyboard users jump past the carousel slides.
66
66
  */
67
67
  skipLinkTarget?: string;
68
68
  /**
69
- * Sets the amount of slides visible at the same time. Can be set to `auto` if you want to define different widths per slide via CSS.
69
+ * Sets how many slides are visible at once. Use `auto` to control each slide's width via CSS. Supports responsive breakpoint values.
70
70
  * @default 1
71
71
  */
72
72
  slidesPerPage?: BreakpointCustomizable<CarouselSlidesPerPage>;
73
73
  /**
74
- * Determines whether to trim spaces before/after the carousel if `focusOnCenterSlide` option is true.
74
+ * Removes whitespace before the first and after the last slide when `focusOnCenterSlide` is enabled.
75
75
  * @default false
76
76
  */
77
77
  trimSpace?: boolean;
78
78
  /**
79
- * Defines the outer spacings between the carousel and the left and right screen sides.
79
+ * Sets the maximum width and outer spacing of the carousel, aligned to PDS grid widths.
80
80
  * @default 'basic'
81
81
  */
82
82
  width?: CarouselWidth;
83
83
  };
84
84
  export declare const PCarousel: 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"> & {
85
85
  /**
86
- * Defines which slide is active (zero-based numbering).
86
+ * Sets the zero-based index of the currently visible slide. Update this to navigate programmatically.
87
87
  * @default 0
88
88
  */
89
89
  activeSlideIndex?: number;
90
90
  /**
91
- * Aligns the slotted controls.
91
+ * Controls the alignment of custom slotted controls within the header area.
92
92
  * @default 'auto'
93
93
  */
94
94
  alignControls?: CarouselAlignControls;
95
95
  /**
96
- * Aligns the heading and description.
96
+ * Controls the horizontal alignment of the heading and description.
97
97
  * @default 'start'
98
98
  */
99
99
  alignHeader?: CarouselAlignHeader;
100
100
  /**
101
- * Sets ARIA attributes.
101
+ * Sets ARIA attributes on the carousel region element for improved accessibility.
102
102
  */
103
103
  aria?: SelectedAriaAttributes<CarouselAriaAttribute>;
104
104
  /**
105
- * Defines the description used in the carousel.
105
+ * Sets the description text displayed below the heading for additional context.
106
106
  */
107
107
  description?: string;
108
108
  /**
109
- * Indicates whether focus should be set on the center slide. If true, the carousel loops by individual slide; otherwise, it loops by page.
109
+ * When enabled, each slide is individually focusable and the carousel navigates one slide at a time instead of one page.
110
110
  * @default false
111
111
  */
112
112
  focusOnCenterSlide?: boolean;
113
113
  /**
114
- * Fades the slides out.
114
+ * Shows a gradient fade at the start and end edges to visually indicate more slides beyond the viewport.
115
115
  * @default false
116
116
  */
117
117
  gradient?: boolean;
118
118
  /**
119
- * Defines the heading used in the carousel.
119
+ * Sets the heading text displayed above the carousel. Also used as the accessible label when no `aria` prop is set.
120
120
  */
121
121
  heading?: string;
122
122
  /**
123
- * Defines the heading size used in the carousel.
123
+ * Sets the font size of the carousel heading.
124
124
  * @default 'x-large'
125
125
  */
126
126
  headingSize?: CarouselHeadingSize;
127
127
  /**
128
- * Override the default wordings that are used for aria-labels on the next/prev buttons and pagination.
128
+ * Overrides the default label strings used for the previous, next, and page indicators — useful for localization.
129
129
  */
130
130
  intl?: CarouselInternationalization;
131
131
  /**
132
- * Emitted when carousel's content slides.
132
+ * Emitted when the carousel navigates to a new slide, with the active and previous slide indexes in the event detail.
133
133
  */
134
134
  onUpdate?: (event: CustomEvent<CarouselUpdateEventDetail>) => void;
135
135
  /**
136
- * If false, the carousel will not show pagination bullets at the bottom.
136
+ * Shows pagination dot indicators below the carousel. Supports responsive breakpoint values.
137
137
  * @default false
138
138
  */
139
139
  pagination?: BreakpointCustomizable<boolean>;
140
140
  /**
141
- * Whether the slides should rewind from last to first slide and vice versa.
141
+ * Enables infinite looping navigating past the last slide wraps back to the first, and vice versa.
142
142
  * @default false
143
143
  */
144
144
  rewind?: boolean;
145
145
  /**
146
- * Defines the skip link target used to skip carousel entries.
146
+ * Sets the `href` of an in-page skip link that lets keyboard users jump past the carousel slides.
147
147
  */
148
148
  skipLinkTarget?: string;
149
149
  /**
150
- * Sets the amount of slides visible at the same time. Can be set to `auto` if you want to define different widths per slide via CSS.
150
+ * Sets how many slides are visible at once. Use `auto` to control each slide's width via CSS. Supports responsive breakpoint values.
151
151
  * @default 1
152
152
  */
153
153
  slidesPerPage?: BreakpointCustomizable<CarouselSlidesPerPage>;
154
154
  /**
155
- * Determines whether to trim spaces before/after the carousel if `focusOnCenterSlide` option is true.
155
+ * Removes whitespace before the first and after the last slide when `focusOnCenterSlide` is enabled.
156
156
  * @default false
157
157
  */
158
158
  trimSpace?: boolean;
159
159
  /**
160
- * Defines the outer spacings between the carousel and the left and right screen sides.
160
+ * Sets the maximum width and outer spacing of the carousel, aligned to PDS grid widths.
161
161
  * @default 'basic'
162
162
  */
163
163
  width?: CarouselWidth;
@@ -2,148 +2,148 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { BreakpointCustomizable, CheckboxBlurEventDetail, CheckboxChangeEventDetail, CheckboxState } from '../types';
3
3
  export type PCheckboxProps = BaseProps & {
4
4
  /**
5
- * Reflects the checkbox current checked state and allows setting the initial checked state.
5
+ * Reflects the checkbox's current checked state and allows setting the initial checked value on load.
6
6
  * @default false
7
7
  */
8
8
  checked?: boolean;
9
9
  /**
10
- * Displays the checkbox in compact mode.
10
+ * Reduces the checkbox size and spacing for a more compact layout.
11
11
  * @default false
12
12
  */
13
13
  compact?: boolean;
14
14
  /**
15
- * Marks the checkbox as disabled.
15
+ * Disables the checkbox, preventing all interaction. The value is not submitted with the form.
16
16
  * @default false
17
17
  */
18
18
  disabled?: boolean;
19
19
  /**
20
- * The id of a form element the checkbox should be associated with.
20
+ * Associates the checkbox with a form element by its ID when not directly nested inside it.
21
21
  */
22
22
  form?: string;
23
23
  /**
24
- * Shows or hides the label. For better accessibility, it is recommended to show the label.
24
+ * Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
25
25
  * @default false
26
26
  */
27
27
  hideLabel?: BreakpointCustomizable<boolean>;
28
28
  /**
29
- * Marks the checkbox as indeterminate.
29
+ * Puts the checkbox into an indeterminate state, indicating that a group of child items is only partially selected.
30
30
  * @default false
31
31
  */
32
32
  indeterminate?: boolean;
33
33
  /**
34
- * Text content for a user-facing label.
34
+ * Sets the visible label text displayed next to the checkbox.
35
35
  * @default ''
36
36
  */
37
37
  label?: string;
38
38
  /**
39
- * @experimental Disables the checkbox and shows a loading indicator.
39
+ * @experimental Disables the checkbox and displays a loading spinner to indicate an ongoing operation.
40
40
  * @default false
41
41
  */
42
42
  loading?: boolean;
43
43
  /**
44
- * The message styled depending on validation state.
44
+ * Sets the validation feedback message displayed below the checkbox when `state` is `success` or `error`.
45
45
  * @default ''
46
46
  */
47
47
  message?: string;
48
48
  /**
49
- * The name of the checkbox.
49
+ * Sets the name submitted with the form data to identify this checkbox's value on the server.
50
50
  * @default ''
51
51
  */
52
52
  name?: string;
53
53
  /**
54
- * Emitted when the checkbox has lost focus.
54
+ * Emitted when the checkbox loses focus.
55
55
  */
56
56
  onBlur?: (event: CustomEvent<CheckboxBlurEventDetail>) => void;
57
57
  /**
58
- * Emitted when checkbox checked property is changed.
58
+ * Emitted when the user changes the checked state of the checkbox.
59
59
  */
60
60
  onChange?: (event: CustomEvent<CheckboxChangeEventDetail>) => void;
61
61
  /**
62
- * Marks the checkbox as required.
62
+ * Marks the checkbox as required — form submission is blocked unless the checkbox is checked.
63
63
  * @default false
64
64
  */
65
65
  required?: boolean;
66
66
  /**
67
- * The validation state.
67
+ * Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
68
68
  * @default 'none'
69
69
  */
70
70
  state?: CheckboxState;
71
71
  /**
72
- * The checkbox value. When a form is submitted, only a checkbox which is currently checked is included in the submission.
72
+ * Sets the value submitted with the form data when the checkbox is checked. Unchecked checkboxes are excluded from form submissions.
73
73
  * @default 'on'
74
74
  */
75
75
  value?: string;
76
76
  };
77
77
  export declare const PCheckbox: 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"> & {
78
78
  /**
79
- * Reflects the checkbox current checked state and allows setting the initial checked state.
79
+ * Reflects the checkbox's current checked state and allows setting the initial checked value on load.
80
80
  * @default false
81
81
  */
82
82
  checked?: boolean;
83
83
  /**
84
- * Displays the checkbox in compact mode.
84
+ * Reduces the checkbox size and spacing for a more compact layout.
85
85
  * @default false
86
86
  */
87
87
  compact?: boolean;
88
88
  /**
89
- * Marks the checkbox as disabled.
89
+ * Disables the checkbox, preventing all interaction. The value is not submitted with the form.
90
90
  * @default false
91
91
  */
92
92
  disabled?: boolean;
93
93
  /**
94
- * The id of a form element the checkbox should be associated with.
94
+ * Associates the checkbox with a form element by its ID when not directly nested inside it.
95
95
  */
96
96
  form?: string;
97
97
  /**
98
- * Shows or hides the label. For better accessibility, it is recommended to show the label.
98
+ * Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
99
99
  * @default false
100
100
  */
101
101
  hideLabel?: BreakpointCustomizable<boolean>;
102
102
  /**
103
- * Marks the checkbox as indeterminate.
103
+ * Puts the checkbox into an indeterminate state, indicating that a group of child items is only partially selected.
104
104
  * @default false
105
105
  */
106
106
  indeterminate?: boolean;
107
107
  /**
108
- * Text content for a user-facing label.
108
+ * Sets the visible label text displayed next to the checkbox.
109
109
  * @default ''
110
110
  */
111
111
  label?: string;
112
112
  /**
113
- * @experimental Disables the checkbox and shows a loading indicator.
113
+ * @experimental Disables the checkbox and displays a loading spinner to indicate an ongoing operation.
114
114
  * @default false
115
115
  */
116
116
  loading?: boolean;
117
117
  /**
118
- * The message styled depending on validation state.
118
+ * Sets the validation feedback message displayed below the checkbox when `state` is `success` or `error`.
119
119
  * @default ''
120
120
  */
121
121
  message?: string;
122
122
  /**
123
- * The name of the checkbox.
123
+ * Sets the name submitted with the form data to identify this checkbox's value on the server.
124
124
  * @default ''
125
125
  */
126
126
  name?: string;
127
127
  /**
128
- * Emitted when the checkbox has lost focus.
128
+ * Emitted when the checkbox loses focus.
129
129
  */
130
130
  onBlur?: (event: CustomEvent<CheckboxBlurEventDetail>) => void;
131
131
  /**
132
- * Emitted when checkbox checked property is changed.
132
+ * Emitted when the user changes the checked state of the checkbox.
133
133
  */
134
134
  onChange?: (event: CustomEvent<CheckboxChangeEventDetail>) => void;
135
135
  /**
136
- * Marks the checkbox as required.
136
+ * Marks the checkbox as required — form submission is blocked unless the checkbox is checked.
137
137
  * @default false
138
138
  */
139
139
  required?: boolean;
140
140
  /**
141
- * The validation state.
141
+ * Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
142
142
  * @default 'none'
143
143
  */
144
144
  state?: CheckboxState;
145
145
  /**
146
- * The checkbox value. When a form is submitted, only a checkbox which is currently checked is included in the submission.
146
+ * Sets the value submitted with the form data when the checkbox is checked. Unchecked checkboxes are excluded from form submissions.
147
147
  * @default 'on'
148
148
  */
149
149
  value?: string;
@@ -2,30 +2,30 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { SelectedAriaAttributes, CrestAriaAttribute, CrestTarget } from '../types';
3
3
  export type PCrestProps = BaseProps & {
4
4
  /**
5
- * Sets ARIA attributes.
5
+ * Sets ARIA attributes on the anchor element to improve accessibility when the crest is used as a link.
6
6
  */
7
7
  aria?: SelectedAriaAttributes<CrestAriaAttribute>;
8
8
  /**
9
- * When `href` is provided, the component renders as an `<a>` element.
9
+ * When set, renders the crest as an anchor element navigating to this URL when clicked.
10
10
  */
11
11
  href?: string;
12
12
  /**
13
- * Specifies where to open the linked document.
13
+ * Specifies where to open the linked URL (e.g. `_self`, `_blank`). Only applies when `href` is set.
14
14
  * @default '_self'
15
15
  */
16
16
  target?: CrestTarget;
17
17
  };
18
18
  export declare const PCrest: 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"> & {
19
19
  /**
20
- * Sets ARIA attributes.
20
+ * Sets ARIA attributes on the anchor element to improve accessibility when the crest is used as a link.
21
21
  */
22
22
  aria?: SelectedAriaAttributes<CrestAriaAttribute>;
23
23
  /**
24
- * When `href` is provided, the component renders as an `<a>` element.
24
+ * When set, renders the crest as an anchor element navigating to this URL when clicked.
25
25
  */
26
26
  href?: string;
27
27
  /**
28
- * Specifies where to open the linked document.
28
+ * Specifies where to open the linked URL (e.g. `_self`, `_blank`). Only applies when `href` is set.
29
29
  * @default '_self'
30
30
  */
31
31
  target?: CrestTarget;
@@ -2,54 +2,54 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { DisplayAlign, DisplayColor, BreakpointCustomizable, DisplaySize, DisplayTag } from '../types';
3
3
  export type PDisplayProps = BaseProps & {
4
4
  /**
5
- * Text alignment of the component.
5
+ * Sets the horizontal text alignment (`start`, `center`, `end`, or `inherit`).
6
6
  * @default 'start'
7
7
  */
8
8
  align?: DisplayAlign;
9
9
  /**
10
- * Basic text color variations.
10
+ * Sets the text color using PDS color tokens.
11
11
  * @default 'primary'
12
12
  */
13
13
  color?: DisplayColor;
14
14
  /**
15
- * Adds an ellipsis to a single line of text if it overflows.
15
+ * Truncates the text with an ellipsis when it overflows the container on a single line.
16
16
  * @default false
17
17
  */
18
18
  ellipsis?: boolean;
19
19
  /**
20
- * Size of the component. Also defines the size for specific breakpoints, like {base: "medium", l: "large"}. You always need to provide a base value when doing this.
20
+ * Sets the visual text size. Supports responsive breakpoint values.
21
21
  * @default 'large'
22
22
  */
23
23
  size?: BreakpointCustomizable<DisplaySize>;
24
24
  /**
25
- * Sets a heading tag, so it fits correctly within the outline of the page.
25
+ * Sets the HTML heading tag (h1–h6) for correct document outline placement. When omitted, the tag is inferred from `size`.
26
26
  */
27
27
  tag?: DisplayTag;
28
28
  };
29
29
  /** @deprecated since v4.0.0, will be removed with next major release. Please use `p-heading` instead. */
30
30
  export declare const PDisplay: 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"> & {
31
31
  /**
32
- * Text alignment of the component.
32
+ * Sets the horizontal text alignment (`start`, `center`, `end`, or `inherit`).
33
33
  * @default 'start'
34
34
  */
35
35
  align?: DisplayAlign;
36
36
  /**
37
- * Basic text color variations.
37
+ * Sets the text color using PDS color tokens.
38
38
  * @default 'primary'
39
39
  */
40
40
  color?: DisplayColor;
41
41
  /**
42
- * Adds an ellipsis to a single line of text if it overflows.
42
+ * Truncates the text with an ellipsis when it overflows the container on a single line.
43
43
  * @default false
44
44
  */
45
45
  ellipsis?: boolean;
46
46
  /**
47
- * Size of the component. Also defines the size for specific breakpoints, like {base: "medium", l: "large"}. You always need to provide a base value when doing this.
47
+ * Sets the visual text size. Supports responsive breakpoint values.
48
48
  * @default 'large'
49
49
  */
50
50
  size?: BreakpointCustomizable<DisplaySize>;
51
51
  /**
52
- * Sets a heading tag, so it fits correctly within the outline of the page.
52
+ * Sets the HTML heading tag (h1–h6) for correct document outline placement. When omitted, the tag is inferred from `size`.
53
53
  */
54
54
  tag?: DisplayTag;
55
55
  } & {
@@ -2,24 +2,24 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { DividerColor, BreakpointCustomizable, DividerDirection } from '../types';
3
3
  export type PDividerProps = BaseProps & {
4
4
  /**
5
- * Defines color.
5
+ * Sets the color of the divider line using PDS contrast tokens.
6
6
  * @default 'contrast-lower'
7
7
  */
8
8
  color?: DividerColor;
9
9
  /**
10
- * Defines direction.
10
+ * Sets the orientation of the divider to `horizontal` or `vertical`. Supports responsive breakpoint values.
11
11
  * @default 'horizontal'
12
12
  */
13
13
  direction?: BreakpointCustomizable<DividerDirection>;
14
14
  };
15
15
  export declare const PDivider: 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"> & {
16
16
  /**
17
- * Defines color.
17
+ * Sets the color of the divider line using PDS contrast tokens.
18
18
  * @default 'contrast-lower'
19
19
  */
20
20
  color?: DividerColor;
21
21
  /**
22
- * Defines direction.
22
+ * Sets the orientation of the divider to `horizontal` or `vertical`. Supports responsive breakpoint values.
23
23
  * @default 'horizontal'
24
24
  */
25
25
  direction?: BreakpointCustomizable<DividerDirection>;
@@ -6,11 +6,11 @@ export type PDrilldownItemProps = BaseProps & {
6
6
  */
7
7
  cascade?: boolean;
8
8
  /**
9
- * Unique identifier which controls if this item should be shown when the active-identifier on the drilldown is set to this value.
9
+ * Sets the unique identifier matched against the drilldown's `activeIdentifier` to determine if this item is shown.
10
10
  */
11
11
  identifier: string;
12
12
  /**
13
- * Renders back button, header section on mobile view and cascade button to reach a deeper level of the navigation structure.
13
+ * Sets the text used for the back button, sticky header, and cascade button that navigates into this navigation level.
14
14
  */
15
15
  label?: string;
16
16
  /**
@@ -31,11 +31,11 @@ export declare const PDrilldownItem: import("react").ForwardRefExoticComponent<O
31
31
  */
32
32
  cascade?: boolean;
33
33
  /**
34
- * Unique identifier which controls if this item should be shown when the active-identifier on the drilldown is set to this value.
34
+ * Sets the unique identifier matched against the drilldown's `activeIdentifier` to determine if this item is shown.
35
35
  */
36
36
  identifier: string;
37
37
  /**
38
- * Renders back button, header section on mobile view and cascade button to reach a deeper level of the navigation structure.
38
+ * Sets the text used for the back button, sticky header, and cascade button that navigates into this navigation level.
39
39
  */
40
40
  label?: string;
41
41
  /**
@@ -2,56 +2,56 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { SelectedAriaAttributes, DrilldownLinkAriaAttribute, DrilldownLinkTarget } from '../types';
3
3
  export type PDrilldownLinkProps = BaseProps & {
4
4
  /**
5
- * Displays the link in its active state.
5
+ * Visually marks the link as the currently active navigation item, e.g. the current page.
6
6
  * @default false
7
7
  */
8
8
  active?: boolean;
9
9
  /**
10
- * Add ARIA attributes (only has effect when `href` is defined and no slotted anchor is used).
10
+ * Sets ARIA attributes on the link for improved accessibility. Only applies when `href` is set.
11
11
  */
12
12
  aria?: SelectedAriaAttributes<DrilldownLinkAriaAttribute>;
13
13
  /**
14
- * Sets the native `download` attribute when the target URL points to a downloadable file (only has effect when `href` is defined and no slotted anchor is used).
14
+ * Sets the native `download` attribute to trigger a file download. Only applies when `href` is set.
15
15
  */
16
16
  download?: string;
17
17
  /**
18
- * When `href` is provided, the component renders as an `<a>` element. Otherwise, provide a slotted anchor element.
18
+ * When set, the component renders as an anchor navigating to this URL. Otherwise, provide a slotted anchor element.
19
19
  */
20
20
  href?: string;
21
21
  /**
22
- * Sets the `rel` attribute on the link (only has effect when `href` is defined and no slotted anchor is used).
22
+ * Sets the `rel` attribute on the link element (e.g. `noopener`). Only applies when `href` is set.
23
23
  */
24
24
  rel?: string;
25
25
  /**
26
- * Target attribute where the link should be opened (only has effect when `href` is defined and no slotted anchor is used).
26
+ * Specifies where to open the linked URL (e.g. `_self`, `_blank`). Only applies when `href` is set.
27
27
  * @default '_self'
28
28
  */
29
29
  target?: DrilldownLinkTarget;
30
30
  };
31
31
  export declare const PDrilldownLink: 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"> & {
32
32
  /**
33
- * Displays the link in its active state.
33
+ * Visually marks the link as the currently active navigation item, e.g. the current page.
34
34
  * @default false
35
35
  */
36
36
  active?: boolean;
37
37
  /**
38
- * Add ARIA attributes (only has effect when `href` is defined and no slotted anchor is used).
38
+ * Sets ARIA attributes on the link for improved accessibility. Only applies when `href` is set.
39
39
  */
40
40
  aria?: SelectedAriaAttributes<DrilldownLinkAriaAttribute>;
41
41
  /**
42
- * Sets the native `download` attribute when the target URL points to a downloadable file (only has effect when `href` is defined and no slotted anchor is used).
42
+ * Sets the native `download` attribute to trigger a file download. Only applies when `href` is set.
43
43
  */
44
44
  download?: string;
45
45
  /**
46
- * When `href` is provided, the component renders as an `<a>` element. Otherwise, provide a slotted anchor element.
46
+ * When set, the component renders as an anchor navigating to this URL. Otherwise, provide a slotted anchor element.
47
47
  */
48
48
  href?: string;
49
49
  /**
50
- * Sets the `rel` attribute on the link (only has effect when `href` is defined and no slotted anchor is used).
50
+ * Sets the `rel` attribute on the link element (e.g. `noopener`). Only applies when `href` is set.
51
51
  */
52
52
  rel?: string;
53
53
  /**
54
- * Target attribute where the link should be opened (only has effect when `href` is defined and no slotted anchor is used).
54
+ * Specifies where to open the linked URL (e.g. `_self`, `_blank`). Only applies when `href` is set.
55
55
  * @default '_self'
56
56
  */
57
57
  target?: DrilldownLinkTarget;