@porsche-design-system/components-react 4.0.0-beta.2 → 4.0.0-beta.4

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 (184) hide show
  1. package/CHANGELOG.md +334 -1
  2. package/OSS_NOTICE +1649 -5178
  3. package/cjs/lib/components/button-pure.wrapper.cjs +3 -3
  4. package/cjs/lib/components/display.wrapper.cjs +1 -0
  5. package/cjs/lib/components/flag.wrapper.cjs +1 -1
  6. package/cjs/lib/components/heading.wrapper.cjs +3 -3
  7. package/cjs/lib/components/icon.wrapper.cjs +1 -1
  8. package/cjs/lib/components/link-pure.wrapper.cjs +3 -3
  9. package/cjs/lib/components/spinner.wrapper.cjs +3 -3
  10. package/cjs/lib/components/text.wrapper.cjs +3 -3
  11. package/esm/lib/components/accordion.wrapper.d.ts +8 -8
  12. package/esm/lib/components/button-pure.wrapper.d.ts +15 -7
  13. package/esm/lib/components/button-pure.wrapper.mjs +3 -3
  14. package/esm/lib/components/button-tile.wrapper.d.ts +2 -2
  15. package/esm/lib/components/button.wrapper.d.ts +6 -6
  16. package/esm/lib/components/carousel.wrapper.d.ts +10 -10
  17. package/esm/lib/components/checkbox.wrapper.d.ts +6 -6
  18. package/esm/lib/components/crest.wrapper.d.ts +6 -6
  19. package/esm/lib/components/display.wrapper.d.ts +1 -0
  20. package/esm/lib/components/display.wrapper.mjs +1 -0
  21. package/esm/lib/components/drilldown-link.wrapper.d.ts +8 -8
  22. package/esm/lib/components/drilldown.wrapper.d.ts +8 -8
  23. package/esm/lib/components/fieldset.wrapper.d.ts +6 -6
  24. package/esm/lib/components/flag.wrapper.d.ts +5 -5
  25. package/esm/lib/components/flag.wrapper.mjs +1 -1
  26. package/esm/lib/components/flyout.wrapper.d.ts +2 -2
  27. package/esm/lib/components/heading.wrapper.d.ts +27 -11
  28. package/esm/lib/components/heading.wrapper.mjs +3 -3
  29. package/esm/lib/components/icon.wrapper.d.ts +7 -7
  30. package/esm/lib/components/icon.wrapper.mjs +1 -1
  31. package/esm/lib/components/input-date.wrapper.d.ts +12 -12
  32. package/esm/lib/components/input-email.wrapper.d.ts +8 -8
  33. package/esm/lib/components/input-month.wrapper.d.ts +12 -12
  34. package/esm/lib/components/input-number.wrapper.d.ts +8 -8
  35. package/esm/lib/components/input-password.wrapper.d.ts +6 -6
  36. package/esm/lib/components/input-search.wrapper.d.ts +6 -6
  37. package/esm/lib/components/input-tel.wrapper.d.ts +6 -6
  38. package/esm/lib/components/input-text.wrapper.d.ts +6 -6
  39. package/esm/lib/components/input-time.wrapper.d.ts +14 -14
  40. package/esm/lib/components/input-url.wrapper.d.ts +16 -16
  41. package/esm/lib/components/input-week.wrapper.d.ts +14 -14
  42. package/esm/lib/components/link-pure.wrapper.d.ts +23 -15
  43. package/esm/lib/components/link-pure.wrapper.mjs +3 -3
  44. package/esm/lib/components/link-tile-product.wrapper.d.ts +8 -8
  45. package/esm/lib/components/link-tile.wrapper.d.ts +8 -8
  46. package/esm/lib/components/link.wrapper.d.ts +14 -14
  47. package/esm/lib/components/modal.wrapper.d.ts +2 -2
  48. package/esm/lib/components/model-signature.wrapper.d.ts +2 -2
  49. package/esm/lib/components/multi-select.wrapper.d.ts +10 -10
  50. package/esm/lib/components/pin-code.wrapper.d.ts +8 -8
  51. package/esm/lib/components/popover.wrapper.d.ts +6 -6
  52. package/esm/lib/components/radio-group-option.wrapper.d.ts +2 -2
  53. package/esm/lib/components/radio-group.wrapper.d.ts +8 -8
  54. package/esm/lib/components/segmented-control-item.wrapper.d.ts +4 -4
  55. package/esm/lib/components/segmented-control.wrapper.d.ts +4 -4
  56. package/esm/lib/components/select.wrapper.d.ts +10 -10
  57. package/esm/lib/components/sheet.wrapper.d.ts +2 -2
  58. package/esm/lib/components/spinner.wrapper.d.ts +13 -5
  59. package/esm/lib/components/spinner.wrapper.mjs +3 -3
  60. package/esm/lib/components/switch.wrapper.d.ts +6 -6
  61. package/esm/lib/components/table-cell.wrapper.d.ts +2 -2
  62. package/esm/lib/components/table-head-cell.wrapper.d.ts +4 -4
  63. package/esm/lib/components/tabs-bar.wrapper.d.ts +2 -2
  64. package/esm/lib/components/tabs.wrapper.d.ts +2 -2
  65. package/esm/lib/components/tag-dismissible.wrapper.d.ts +6 -6
  66. package/esm/lib/components/tag.wrapper.d.ts +2 -2
  67. package/esm/lib/components/text.wrapper.d.ts +21 -13
  68. package/esm/lib/components/text.wrapper.mjs +3 -3
  69. package/esm/lib/components/textarea.wrapper.d.ts +6 -6
  70. package/esm/lib/components/wordmark.wrapper.d.ts +8 -8
  71. package/esm/lib/types.d.ts +341 -141
  72. package/global-styles/cn/index.css +157 -159
  73. package/global-styles/color-scheme.css +95 -95
  74. package/global-styles/index.css +157 -159
  75. package/global-styles/variables.css +62 -64
  76. package/package.json +6 -2
  77. package/ssr/cjs/components/dist/styles/esm/styles-entry.cjs +413 -512
  78. package/ssr/cjs/components/dist/utils/esm/utils-entry.cjs +20 -18
  79. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/components/button-pure.wrapper.cjs +4 -4
  80. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/components/display.wrapper.cjs +1 -0
  81. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/components/flag.wrapper.cjs +1 -1
  82. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/components/heading.wrapper.cjs +4 -4
  83. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/components/icon.wrapper.cjs +1 -1
  84. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/components/link-pure.wrapper.cjs +4 -4
  85. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/components/spinner.wrapper.cjs +4 -4
  86. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/components/text.wrapper.cjs +4 -4
  87. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/accordion.cjs +1 -1
  88. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/button-pure.cjs +3 -2
  89. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/carousel.cjs +2 -2
  90. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/checkbox.cjs +1 -1
  91. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/display.cjs +2 -0
  92. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/drilldown-item.cjs +2 -2
  93. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/flyout.cjs +1 -1
  94. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/heading.cjs +1 -1
  95. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/input-base.cjs +1 -1
  96. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/link-pure.cjs +1 -1
  97. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/radio-group-option.cjs +1 -1
  98. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/radio-group.cjs +1 -1
  99. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/spinner.cjs +2 -2
  100. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/switch.cjs +1 -1
  101. package/ssr/cjs/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/text.cjs +1 -1
  102. package/ssr/esm/components/dist/styles/esm/styles-entry.mjs +413 -512
  103. package/ssr/esm/components/dist/utils/esm/utils-entry.mjs +20 -18
  104. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/components/button-pure.wrapper.mjs +4 -4
  105. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/components/display.wrapper.mjs +1 -0
  106. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/components/flag.wrapper.mjs +1 -1
  107. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/components/heading.wrapper.mjs +4 -4
  108. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/components/icon.wrapper.mjs +1 -1
  109. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/components/link-pure.wrapper.mjs +4 -4
  110. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/components/spinner.wrapper.mjs +4 -4
  111. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/components/text.wrapper.mjs +4 -4
  112. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/accordion.mjs +1 -1
  113. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/button-pure.mjs +3 -2
  114. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/carousel.mjs +2 -2
  115. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/checkbox.mjs +1 -1
  116. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/display.mjs +2 -0
  117. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/drilldown-item.mjs +2 -2
  118. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/flyout.mjs +1 -1
  119. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/heading.mjs +1 -1
  120. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/input-base.mjs +1 -1
  121. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/link-pure.mjs +1 -1
  122. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/radio-group-option.mjs +1 -1
  123. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/radio-group.mjs +1 -1
  124. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/spinner.mjs +2 -2
  125. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/switch.mjs +1 -1
  126. package/ssr/esm/components-react/projects/react-ssr-wrapper/src/lib/dsr-components/text.mjs +1 -1
  127. package/ssr/esm/lib/components/accordion.wrapper.d.ts +8 -8
  128. package/ssr/esm/lib/components/button-pure.wrapper.d.ts +15 -7
  129. package/ssr/esm/lib/components/button-tile.wrapper.d.ts +2 -2
  130. package/ssr/esm/lib/components/button.wrapper.d.ts +6 -6
  131. package/ssr/esm/lib/components/carousel.wrapper.d.ts +10 -10
  132. package/ssr/esm/lib/components/checkbox.wrapper.d.ts +6 -6
  133. package/ssr/esm/lib/components/crest.wrapper.d.ts +6 -6
  134. package/ssr/esm/lib/components/display.wrapper.d.ts +1 -0
  135. package/ssr/esm/lib/components/drilldown-link.wrapper.d.ts +8 -8
  136. package/ssr/esm/lib/components/drilldown.wrapper.d.ts +8 -8
  137. package/ssr/esm/lib/components/fieldset.wrapper.d.ts +6 -6
  138. package/ssr/esm/lib/components/flag.wrapper.d.ts +5 -5
  139. package/ssr/esm/lib/components/flyout.wrapper.d.ts +2 -2
  140. package/ssr/esm/lib/components/heading.wrapper.d.ts +27 -11
  141. package/ssr/esm/lib/components/icon.wrapper.d.ts +7 -7
  142. package/ssr/esm/lib/components/input-date.wrapper.d.ts +12 -12
  143. package/ssr/esm/lib/components/input-email.wrapper.d.ts +8 -8
  144. package/ssr/esm/lib/components/input-month.wrapper.d.ts +12 -12
  145. package/ssr/esm/lib/components/input-number.wrapper.d.ts +8 -8
  146. package/ssr/esm/lib/components/input-password.wrapper.d.ts +6 -6
  147. package/ssr/esm/lib/components/input-search.wrapper.d.ts +6 -6
  148. package/ssr/esm/lib/components/input-tel.wrapper.d.ts +6 -6
  149. package/ssr/esm/lib/components/input-text.wrapper.d.ts +6 -6
  150. package/ssr/esm/lib/components/input-time.wrapper.d.ts +14 -14
  151. package/ssr/esm/lib/components/input-url.wrapper.d.ts +16 -16
  152. package/ssr/esm/lib/components/input-week.wrapper.d.ts +14 -14
  153. package/ssr/esm/lib/components/link-pure.wrapper.d.ts +23 -15
  154. package/ssr/esm/lib/components/link-tile-product.wrapper.d.ts +8 -8
  155. package/ssr/esm/lib/components/link-tile.wrapper.d.ts +8 -8
  156. package/ssr/esm/lib/components/link.wrapper.d.ts +14 -14
  157. package/ssr/esm/lib/components/modal.wrapper.d.ts +2 -2
  158. package/ssr/esm/lib/components/model-signature.wrapper.d.ts +2 -2
  159. package/ssr/esm/lib/components/multi-select.wrapper.d.ts +10 -10
  160. package/ssr/esm/lib/components/pin-code.wrapper.d.ts +8 -8
  161. package/ssr/esm/lib/components/popover.wrapper.d.ts +6 -6
  162. package/ssr/esm/lib/components/radio-group-option.wrapper.d.ts +2 -2
  163. package/ssr/esm/lib/components/radio-group.wrapper.d.ts +8 -8
  164. package/ssr/esm/lib/components/segmented-control-item.wrapper.d.ts +4 -4
  165. package/ssr/esm/lib/components/segmented-control.wrapper.d.ts +4 -4
  166. package/ssr/esm/lib/components/select.wrapper.d.ts +10 -10
  167. package/ssr/esm/lib/components/sheet.wrapper.d.ts +2 -2
  168. package/ssr/esm/lib/components/spinner.wrapper.d.ts +13 -5
  169. package/ssr/esm/lib/components/switch.wrapper.d.ts +6 -6
  170. package/ssr/esm/lib/components/table-cell.wrapper.d.ts +2 -2
  171. package/ssr/esm/lib/components/table-head-cell.wrapper.d.ts +4 -4
  172. package/ssr/esm/lib/components/tabs-bar.wrapper.d.ts +2 -2
  173. package/ssr/esm/lib/components/tabs.wrapper.d.ts +2 -2
  174. package/ssr/esm/lib/components/tag-dismissible.wrapper.d.ts +6 -6
  175. package/ssr/esm/lib/components/tag.wrapper.d.ts +2 -2
  176. package/ssr/esm/lib/components/text.wrapper.d.ts +21 -13
  177. package/ssr/esm/lib/components/textarea.wrapper.d.ts +6 -6
  178. package/ssr/esm/lib/components/wordmark.wrapper.d.ts +8 -8
  179. package/ssr/esm/lib/dsr-components/carousel.d.ts +2 -2
  180. package/ssr/esm/lib/dsr-components/display.d.ts +2 -0
  181. package/ssr/esm/lib/dsr-components/drilldown-item.d.ts +2 -2
  182. package/ssr/esm/lib/dsr-components/flyout.d.ts +1 -1
  183. package/ssr/esm/lib/types.d.ts +341 -141
  184. package/tailwindcss/index.css +170 -158
@@ -1,8 +1,8 @@
1
1
  import type { BaseProps } from '../../BaseProps';
2
- import type { BreakpointCustomizable, ButtonPureAlignLabel, SelectedAriaAttributes, ButtonPureAriaAttribute, ButtonPureIcon, ButtonPureSize, ButtonPureType } from '../types';
2
+ import type { BreakpointCustomizable, ButtonPureAlignLabel, SelectedAriaAttributes, ButtonPureAriaAttribute, ButtonPureColor, ButtonPureIcon, ButtonPureSize, ButtonPureType } from '../types';
3
3
  export type PButtonPureProps = BaseProps & {
4
4
  /**
5
- * Display button in active state.
5
+ * Displays the button in its active state.
6
6
  */
7
7
  active?: boolean;
8
8
  /**
@@ -10,9 +10,13 @@ export type PButtonPureProps = BaseProps & {
10
10
  */
11
11
  alignLabel?: BreakpointCustomizable<ButtonPureAlignLabel>;
12
12
  /**
13
- * Add ARIA attributes.
13
+ * Sets ARIA attributes.
14
14
  */
15
15
  aria?: SelectedAriaAttributes<ButtonPureAriaAttribute>;
16
+ /**
17
+ * The color.
18
+ */
19
+ color?: ButtonPureColor;
16
20
  /**
17
21
  * Disables the button. No events will be triggered while disabled state is active.
18
22
  */
@@ -22,7 +26,7 @@ export type PButtonPureProps = BaseProps & {
22
26
  */
23
27
  form?: string;
24
28
  /**
25
- * Show or hide label. For better accessibility it is recommended to show the label.
29
+ * Shows or hides the label. For better accessibility, it is recommended to show the label.
26
30
  */
27
31
  hideLabel?: BreakpointCustomizable<boolean>;
28
32
  /**
@@ -64,7 +68,7 @@ export type PButtonPureProps = BaseProps & {
64
68
  };
65
69
  export declare const PButtonPure: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
66
70
  /**
67
- * Display button in active state.
71
+ * Displays the button in its active state.
68
72
  */
69
73
  active?: boolean;
70
74
  /**
@@ -72,9 +76,13 @@ export declare const PButtonPure: import("react").ForwardRefExoticComponent<Omit
72
76
  */
73
77
  alignLabel?: BreakpointCustomizable<ButtonPureAlignLabel>;
74
78
  /**
75
- * Add ARIA attributes.
79
+ * Sets ARIA attributes.
76
80
  */
77
81
  aria?: SelectedAriaAttributes<ButtonPureAriaAttribute>;
82
+ /**
83
+ * The color.
84
+ */
85
+ color?: ButtonPureColor;
78
86
  /**
79
87
  * Disables the button. No events will be triggered while disabled state is active.
80
88
  */
@@ -84,7 +92,7 @@ export declare const PButtonPure: import("react").ForwardRefExoticComponent<Omit
84
92
  */
85
93
  form?: string;
86
94
  /**
87
- * Show or hide label. For better accessibility it is recommended to show the label.
95
+ * Shows or hides the label. For better accessibility, it is recommended to show the label.
88
96
  */
89
97
  hideLabel?: BreakpointCustomizable<boolean>;
90
98
  /**
@@ -6,7 +6,7 @@ export type PButtonTileProps = BaseProps & {
6
6
  */
7
7
  align?: ButtonTileAlign;
8
8
  /**
9
- * Add ARIA attributes.
9
+ * Sets ARIA attributes.
10
10
  */
11
11
  aria?: SelectedAriaAttributes<ButtonTileAriaAttribute>;
12
12
  /**
@@ -64,7 +64,7 @@ export declare const PButtonTile: import("react").ForwardRefExoticComponent<Omit
64
64
  */
65
65
  align?: ButtonTileAlign;
66
66
  /**
67
- * Add ARIA attributes.
67
+ * Sets ARIA attributes.
68
68
  */
69
69
  aria?: SelectedAriaAttributes<ButtonTileAriaAttribute>;
70
70
  /**
@@ -2,11 +2,11 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { SelectedAriaAttributes, ButtonAriaAttribute, BreakpointCustomizable, ButtonIcon, ButtonType, ButtonVariant } from '../types';
3
3
  export type PButtonProps = BaseProps & {
4
4
  /**
5
- * Add ARIA attributes.
5
+ * Sets ARIA attributes.
6
6
  */
7
7
  aria?: SelectedAriaAttributes<ButtonAriaAttribute>;
8
8
  /**
9
- * Displays as compact version.
9
+ * Displays the button in compact mode.
10
10
  */
11
11
  compact?: BreakpointCustomizable<boolean>;
12
12
  /**
@@ -18,7 +18,7 @@ export type PButtonProps = BaseProps & {
18
18
  */
19
19
  form?: string;
20
20
  /**
21
- * Show or hide label. For better accessibility it is recommended to show the label.
21
+ * Shows or hides the label. For better accessibility, it is recommended to show the label.
22
22
  */
23
23
  hideLabel?: BreakpointCustomizable<boolean>;
24
24
  /**
@@ -52,11 +52,11 @@ export type PButtonProps = BaseProps & {
52
52
  };
53
53
  export declare const PButton: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
54
54
  /**
55
- * Add ARIA attributes.
55
+ * Sets ARIA attributes.
56
56
  */
57
57
  aria?: SelectedAriaAttributes<ButtonAriaAttribute>;
58
58
  /**
59
- * Displays as compact version.
59
+ * Displays the button in compact mode.
60
60
  */
61
61
  compact?: BreakpointCustomizable<boolean>;
62
62
  /**
@@ -68,7 +68,7 @@ export declare const PButton: import("react").ForwardRefExoticComponent<Omit<imp
68
68
  */
69
69
  form?: string;
70
70
  /**
71
- * Show or hide label. For better accessibility it is recommended to show the label.
71
+ * Shows or hides the label. For better accessibility, it is recommended to show the label.
72
72
  */
73
73
  hideLabel?: BreakpointCustomizable<boolean>;
74
74
  /**
@@ -2,19 +2,19 @@ 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 to be active (zero-based numbering).
5
+ * Defines which slide is active (zero-based numbering).
6
6
  */
7
7
  activeSlideIndex?: number;
8
8
  /**
9
- * Alignment of slotted controls
9
+ * Aligns the slotted controls.
10
10
  */
11
11
  alignControls?: CarouselAlignControls;
12
12
  /**
13
- * Alignment of heading and description
13
+ * Aligns the heading and description.
14
14
  */
15
15
  alignHeader?: CarouselAlignHeader;
16
16
  /**
17
- * Add ARIA attributes.
17
+ * Sets ARIA attributes.
18
18
  */
19
19
  aria?: SelectedAriaAttributes<CarouselAriaAttribute>;
20
20
  /**
@@ -54,7 +54,7 @@ export type PCarouselProps = BaseProps & {
54
54
  */
55
55
  rewind?: boolean;
56
56
  /**
57
- * Defines target of skip link (to skip carousel entries).
57
+ * Defines the skip link target used to skip carousel entries.
58
58
  */
59
59
  skipLinkTarget?: string;
60
60
  /**
@@ -72,19 +72,19 @@ export type PCarouselProps = BaseProps & {
72
72
  };
73
73
  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" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
74
74
  /**
75
- * Defines which slide to be active (zero-based numbering).
75
+ * Defines which slide is active (zero-based numbering).
76
76
  */
77
77
  activeSlideIndex?: number;
78
78
  /**
79
- * Alignment of slotted controls
79
+ * Aligns the slotted controls.
80
80
  */
81
81
  alignControls?: CarouselAlignControls;
82
82
  /**
83
- * Alignment of heading and description
83
+ * Aligns the heading and description.
84
84
  */
85
85
  alignHeader?: CarouselAlignHeader;
86
86
  /**
87
- * Add ARIA attributes.
87
+ * Sets ARIA attributes.
88
88
  */
89
89
  aria?: SelectedAriaAttributes<CarouselAriaAttribute>;
90
90
  /**
@@ -124,7 +124,7 @@ export declare const PCarousel: import("react").ForwardRefExoticComponent<Omit<i
124
124
  */
125
125
  rewind?: boolean;
126
126
  /**
127
- * Defines target of skip link (to skip carousel entries).
127
+ * Defines the skip link target used to skip carousel entries.
128
128
  */
129
129
  skipLinkTarget?: string;
130
130
  /**
@@ -6,7 +6,7 @@ export type PCheckboxProps = BaseProps & {
6
6
  */
7
7
  checked?: boolean;
8
8
  /**
9
- * Displays as a compact version.
9
+ * Displays the checkbox in compact mode.
10
10
  */
11
11
  compact?: boolean;
12
12
  /**
@@ -18,7 +18,7 @@ export type PCheckboxProps = BaseProps & {
18
18
  */
19
19
  form?: string;
20
20
  /**
21
- * Show or hide label. For better accessibility, it's recommended to show the label.
21
+ * Shows or hides the label. For better accessibility, it is recommended to show the label.
22
22
  */
23
23
  hideLabel?: BreakpointCustomizable<boolean>;
24
24
  /**
@@ -26,7 +26,7 @@ export type PCheckboxProps = BaseProps & {
26
26
  */
27
27
  indeterminate?: boolean;
28
28
  /**
29
- * The label text.
29
+ * Text content for a user-facing label.
30
30
  */
31
31
  label?: string;
32
32
  /**
@@ -68,7 +68,7 @@ export declare const PCheckbox: import("react").ForwardRefExoticComponent<Omit<i
68
68
  */
69
69
  checked?: boolean;
70
70
  /**
71
- * Displays as a compact version.
71
+ * Displays the checkbox in compact mode.
72
72
  */
73
73
  compact?: boolean;
74
74
  /**
@@ -80,7 +80,7 @@ export declare const PCheckbox: import("react").ForwardRefExoticComponent<Omit<i
80
80
  */
81
81
  form?: string;
82
82
  /**
83
- * Show or hide label. For better accessibility, it's recommended to show the label.
83
+ * Shows or hides the label. For better accessibility, it is recommended to show the label.
84
84
  */
85
85
  hideLabel?: BreakpointCustomizable<boolean>;
86
86
  /**
@@ -88,7 +88,7 @@ export declare const PCheckbox: import("react").ForwardRefExoticComponent<Omit<i
88
88
  */
89
89
  indeterminate?: boolean;
90
90
  /**
91
- * The label text.
91
+ * Text content for a user-facing label.
92
92
  */
93
93
  label?: string;
94
94
  /**
@@ -2,29 +2,29 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { SelectedAriaAttributes, CrestAriaAttribute, CrestTarget } from '../types';
3
3
  export type PCrestProps = BaseProps & {
4
4
  /**
5
- * Add ARIA attributes.
5
+ * Sets ARIA attributes.
6
6
  */
7
7
  aria?: SelectedAriaAttributes<CrestAriaAttribute>;
8
8
  /**
9
- * When providing an url then the component will be rendered as `<a>`.
9
+ * When `href` is provided, the component renders as an `<a>` element.
10
10
  */
11
11
  href?: string;
12
12
  /**
13
- * Target attribute where the link should be opened.
13
+ * Specifies where to open the linked document.
14
14
  */
15
15
  target?: CrestTarget;
16
16
  };
17
17
  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" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
18
18
  /**
19
- * Add ARIA attributes.
19
+ * Sets ARIA attributes.
20
20
  */
21
21
  aria?: SelectedAriaAttributes<CrestAriaAttribute>;
22
22
  /**
23
- * When providing an url then the component will be rendered as `<a>`.
23
+ * When `href` is provided, the component renders as an `<a>` element.
24
24
  */
25
25
  href?: string;
26
26
  /**
27
- * Target attribute where the link should be opened.
27
+ * Specifies where to open the linked document.
28
28
  */
29
29
  target?: CrestTarget;
30
30
  } & import("react").RefAttributes<HTMLElement>>;
@@ -22,6 +22,7 @@ export type PDisplayProps = BaseProps & {
22
22
  */
23
23
  tag?: DisplayTag;
24
24
  };
25
+ /** @deprecated since v4.0.0, will be removed with next major release. Please use `p-heading` instead. */
25
26
  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" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
26
27
  /**
27
28
  * Text alignment of the component.
@@ -2,7 +2,7 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { SelectedAriaAttributes, DrilldownLinkAriaAttribute, DrilldownLinkTarget } from '../types';
3
3
  export type PDrilldownLinkProps = BaseProps & {
4
4
  /**
5
- * Display link in active state.
5
+ * Displays the link in its active state.
6
6
  */
7
7
  active?: boolean;
8
8
  /**
@@ -10,15 +10,15 @@ export type PDrilldownLinkProps = BaseProps & {
10
10
  */
11
11
  aria?: SelectedAriaAttributes<DrilldownLinkAriaAttribute>;
12
12
  /**
13
- * Special download attribute to open native browser download dialog if target url points to a downloadable file (only has effect when `href` is defined and no slotted anchor is used).
13
+ * 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
14
  */
15
15
  download?: string;
16
16
  /**
17
- * When providing an url then the component will be rendered as `<a>` otherwise the component expects a slotted anchor.
17
+ * When `href` is provided, the component renders as an `<a>` element. Otherwise, provide a slotted anchor element.
18
18
  */
19
19
  href?: string;
20
20
  /**
21
- * Specifies the relationship of the target object to the link object (only has effect when `href` is defined and no slotted anchor is used).
21
+ * Sets the `rel` attribute on the link (only has effect when `href` is defined and no slotted anchor is used).
22
22
  */
23
23
  rel?: string;
24
24
  /**
@@ -28,7 +28,7 @@ export type PDrilldownLinkProps = BaseProps & {
28
28
  };
29
29
  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" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
30
30
  /**
31
- * Display link in active state.
31
+ * Displays the link in its active state.
32
32
  */
33
33
  active?: boolean;
34
34
  /**
@@ -36,15 +36,15 @@ export declare const PDrilldownLink: import("react").ForwardRefExoticComponent<O
36
36
  */
37
37
  aria?: SelectedAriaAttributes<DrilldownLinkAriaAttribute>;
38
38
  /**
39
- * Special download attribute to open native browser download dialog if target url points to a downloadable file (only has effect when `href` is defined and no slotted anchor is used).
39
+ * 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).
40
40
  */
41
41
  download?: string;
42
42
  /**
43
- * When providing an url then the component will be rendered as `<a>` otherwise the component expects a slotted anchor.
43
+ * When `href` is provided, the component renders as an `<a>` element. Otherwise, provide a slotted anchor element.
44
44
  */
45
45
  href?: string;
46
46
  /**
47
- * Specifies the relationship of the target object to the link object (only has effect when `href` is defined and no slotted anchor is used).
47
+ * Sets the `rel` attribute on the link (only has effect when `href` is defined and no slotted anchor is used).
48
48
  */
49
49
  rel?: string;
50
50
  /**
@@ -2,11 +2,11 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { SelectedAriaAttributes, DrilldownAriaAttribute, DrilldownUpdateEventDetail } from '../types';
3
3
  export type PDrilldownProps = BaseProps & {
4
4
  /**
5
- * Defines which drilldown-item to be visualized as opened.
5
+ * Defines which `p-drilldown-item` is shown as open.
6
6
  */
7
7
  activeIdentifier?: string | undefined;
8
8
  /**
9
- * Add ARIA attributes.
9
+ * Sets ARIA attributes.
10
10
  */
11
11
  aria?: SelectedAriaAttributes<DrilldownAriaAttribute>;
12
12
  /**
@@ -14,21 +14,21 @@ export type PDrilldownProps = BaseProps & {
14
14
  */
15
15
  onDismiss?: (event: CustomEvent<void>) => void;
16
16
  /**
17
- * Emitted when activeIdentifier is changed.
17
+ * Emitted when `activeIdentifier` changes.
18
18
  */
19
19
  onUpdate?: (event: CustomEvent<DrilldownUpdateEventDetail>) => void;
20
20
  /**
21
- * If true, the drilldown is visualized as opened.
21
+ * If `true`, the drilldown is shown as open.
22
22
  */
23
23
  open?: boolean;
24
24
  };
25
25
  export declare const PDrilldown: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
26
26
  /**
27
- * Defines which drilldown-item to be visualized as opened.
27
+ * Defines which `p-drilldown-item` is shown as open.
28
28
  */
29
29
  activeIdentifier?: string | undefined;
30
30
  /**
31
- * Add ARIA attributes.
31
+ * Sets ARIA attributes.
32
32
  */
33
33
  aria?: SelectedAriaAttributes<DrilldownAriaAttribute>;
34
34
  /**
@@ -36,11 +36,11 @@ export declare const PDrilldown: import("react").ForwardRefExoticComponent<Omit<
36
36
  */
37
37
  onDismiss?: (event: CustomEvent<void>) => void;
38
38
  /**
39
- * Emitted when activeIdentifier is changed.
39
+ * Emitted when `activeIdentifier` changes.
40
40
  */
41
41
  onUpdate?: (event: CustomEvent<DrilldownUpdateEventDetail>) => void;
42
42
  /**
43
- * If true, the drilldown is visualized as opened.
43
+ * If `true`, the drilldown is shown as open.
44
44
  */
45
45
  open?: boolean;
46
46
  } & {
@@ -2,15 +2,15 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { SelectedAriaRole, FieldsetLabelSize, FieldsetState } from '../types';
3
3
  export type PFieldsetProps = BaseProps & {
4
4
  /**
5
- * Add ARIA attributes.
5
+ * Sets ARIA attributes.
6
6
  */
7
7
  aria?: SelectedAriaRole<"radiogroup">;
8
8
  /**
9
- * The label text.
9
+ * Text content for a user-facing label.
10
10
  */
11
11
  label?: string;
12
12
  /**
13
- * The size of the label text.
13
+ * Controls the size of the label text.
14
14
  */
15
15
  labelSize?: FieldsetLabelSize;
16
16
  /**
@@ -28,15 +28,15 @@ export type PFieldsetProps = BaseProps & {
28
28
  };
29
29
  export declare const PFieldset: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
30
30
  /**
31
- * Add ARIA attributes.
31
+ * Sets ARIA attributes.
32
32
  */
33
33
  aria?: SelectedAriaRole<"radiogroup">;
34
34
  /**
35
- * The label text.
35
+ * Text content for a user-facing label.
36
36
  */
37
37
  label?: string;
38
38
  /**
39
- * The size of the label text.
39
+ * Controls the size of the label text.
40
40
  */
41
41
  labelSize?: FieldsetLabelSize;
42
42
  /**
@@ -1,5 +1,5 @@
1
1
  import type { BaseProps } from '../../BaseProps';
2
- import type { SelectedAriaAttributes, FlagAriaAttribute, FlagName, FlagSize } from '../types';
2
+ import type { SelectedAriaAttributes, FlagAriaAttribute, FlagName, BreakpointCustomizable, FlagSize } from '../types';
3
3
  export type PFlagProps = BaseProps & {
4
4
  /**
5
5
  * A map of ARIA attributes to enhance the flag's accessibility. For example, use `{ 'aria-label': 'German flag' }` to provide a descriptive label for screen readers.
@@ -10,9 +10,9 @@ export type PFlagProps = BaseProps & {
10
10
  */
11
11
  name?: FlagName;
12
12
  /**
13
- * The size of the flag. Pre-defined sizes are aligned with the Porsche Next typescale. Available values are `small`, `medium`, `large`, etc.
13
+ * Defines the size of the flag, aligned with the typographic scale used by components such as p-icon, p-spinner, 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
14
  */
15
- size?: FlagSize;
15
+ size?: BreakpointCustomizable<FlagSize>;
16
16
  };
17
17
  export declare const PFlag: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
18
18
  /**
@@ -24,7 +24,7 @@ export declare const PFlag: import("react").ForwardRefExoticComponent<Omit<impor
24
24
  */
25
25
  name?: FlagName;
26
26
  /**
27
- * The size of the flag. Pre-defined sizes are aligned with the Porsche Next typescale. Available values are `small`, `medium`, `large`, etc.
27
+ * Defines the size of the flag, aligned with the typographic scale used by components such as p-icon, p-spinner, 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.
28
28
  */
29
- size?: FlagSize;
29
+ size?: BreakpointCustomizable<FlagSize>;
30
30
  } & import("react").RefAttributes<HTMLElement>>;
@@ -2,7 +2,7 @@ import type { BaseProps } from '../../BaseProps';
2
2
  import type { SelectedAriaAttributes, FlyoutAriaAttribute, FlyoutBackdrop, FlyoutBackground, FlyoutFooterBehavior, FlyoutMotionHiddenEndEventDetail, FlyoutMotionVisibleEndEventDetail, FlyoutPosition } from '../types';
3
3
  export type PFlyoutProps = BaseProps & {
4
4
  /**
5
- * Add ARIA attributes.
5
+ * Sets ARIA attributes.
6
6
  */
7
7
  aria?: SelectedAriaAttributes<FlyoutAriaAttribute>;
8
8
  /**
@@ -44,7 +44,7 @@ export type PFlyoutProps = BaseProps & {
44
44
  };
45
45
  export declare const PFlyout: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
46
46
  /**
47
- * Add ARIA attributes.
47
+ * Sets ARIA attributes.
48
48
  */
49
49
  aria?: SelectedAriaAttributes<FlyoutAriaAttribute>;
50
50
  /**
@@ -1,48 +1,64 @@
1
1
  import type { BaseProps } from '../../BaseProps';
2
- import type { HeadingAlign, HeadingColor, BreakpointCustomizable, HeadingSize, HeadingTag } from '../types';
2
+ import type { HeadingAlign, HeadingColor, HeadingHyphens, BreakpointCustomizable, HeadingSize, HeadingTag, HeadingWeight } from '../types';
3
3
  export type PHeadingProps = BaseProps & {
4
4
  /**
5
- * Text alignment of the component.
5
+ * Text alignment of the heading. Use 'start' for left-aligned text (in LTR), 'center' for centered, 'end' for right-aligned (in LTR), or 'inherit' to adopt the parent's alignment.
6
6
  */
7
7
  align?: HeadingAlign;
8
8
  /**
9
- * Basic text color variations.
9
+ * Text color of the heading. Use 'primary' for default, 'contrast-higher' / 'contrast-high' / 'contrast-medium' for alternative emphasis levels, or 'inherit' to adopt the parent's color.
10
10
  */
11
11
  color?: HeadingColor;
12
12
  /**
13
- * Adds an ellipsis to a single line of text if it overflows.
13
+ * Adds an ellipsis to a single line of text if it overflows the container width. When enabled, the text is truncated to a single line with `text-overflow: ellipsis`. Cannot be combined with multi-line content.
14
14
  */
15
15
  ellipsis?: boolean;
16
16
  /**
17
- * Size of the component. Also defines the size for specific breakpoints, like {base: "small", l: "medium"}. You always need to provide a base value when doing this.
17
+ * Controls the hyphenation behavior of the heading. Use 'auto' to let the browser automatically hyphenate words at appropriate points, 'manual' to only hyphenate at manually inserted hyphenation points (e.g. `&shy;`), 'none' to disable hyphenation entirely, or 'inherit' to adopt the parent's hyphenation setting.
18
+ */
19
+ hyphens?: HeadingHyphens;
20
+ /**
21
+ * Size of the heading. Also defines the size for specific breakpoints, like {base: "md", l: "2xl"}. You always need to provide a base value when doing this. Use 'inherit' to adopt the parent's font size.
18
22
  */
19
23
  size?: BreakpointCustomizable<HeadingSize>;
20
24
  /**
21
- * Sets a heading tag, so it fits correctly within the outline of the page.
25
+ * Sets the HTML heading tag (h1 - h6) to ensure the correct document outline and semantic hierarchy. If not set, the tag is automatically inferred from the `size` property (e.g. '2xl' maps to 'h2', 'md' to 'h5', 'sm' to 'h6').
22
26
  */
23
27
  tag?: HeadingTag;
28
+ /**
29
+ * The font weight of the heading. Use 'normal' for regular weight, 'semibold' for slightly emphasized text, or 'bold' for strong emphasis. For `size` values of 'sm' or smaller, it's recommended to use 'semibold' for better readability.
30
+ */
31
+ weight?: HeadingWeight;
24
32
  };
25
33
  export declare const PHeading: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
26
34
  /**
27
- * Text alignment of the component.
35
+ * Text alignment of the heading. Use 'start' for left-aligned text (in LTR), 'center' for centered, 'end' for right-aligned (in LTR), or 'inherit' to adopt the parent's alignment.
28
36
  */
29
37
  align?: HeadingAlign;
30
38
  /**
31
- * Basic text color variations.
39
+ * Text color of the heading. Use 'primary' for default, 'contrast-higher' / 'contrast-high' / 'contrast-medium' for alternative emphasis levels, or 'inherit' to adopt the parent's color.
32
40
  */
33
41
  color?: HeadingColor;
34
42
  /**
35
- * Adds an ellipsis to a single line of text if it overflows.
43
+ * Adds an ellipsis to a single line of text if it overflows the container width. When enabled, the text is truncated to a single line with `text-overflow: ellipsis`. Cannot be combined with multi-line content.
36
44
  */
37
45
  ellipsis?: boolean;
38
46
  /**
39
- * Size of the component. Also defines the size for specific breakpoints, like {base: "small", l: "medium"}. You always need to provide a base value when doing this.
47
+ * Controls the hyphenation behavior of the heading. Use 'auto' to let the browser automatically hyphenate words at appropriate points, 'manual' to only hyphenate at manually inserted hyphenation points (e.g. `&shy;`), 'none' to disable hyphenation entirely, or 'inherit' to adopt the parent's hyphenation setting.
48
+ */
49
+ hyphens?: HeadingHyphens;
50
+ /**
51
+ * Size of the heading. Also defines the size for specific breakpoints, like {base: "md", l: "2xl"}. You always need to provide a base value when doing this. Use 'inherit' to adopt the parent's font size.
40
52
  */
41
53
  size?: BreakpointCustomizable<HeadingSize>;
42
54
  /**
43
- * Sets a heading tag, so it fits correctly within the outline of the page.
55
+ * Sets the HTML heading tag (h1 - h6) to ensure the correct document outline and semantic hierarchy. If not set, the tag is automatically inferred from the `size` property (e.g. '2xl' maps to 'h2', 'md' to 'h5', 'sm' to 'h6').
44
56
  */
45
57
  tag?: HeadingTag;
58
+ /**
59
+ * The font weight of the heading. Use 'normal' for regular weight, 'semibold' for slightly emphasized text, or 'bold' for strong emphasis. For `size` values of 'sm' or smaller, it's recommended to use 'semibold' for better readability.
60
+ */
61
+ weight?: HeadingWeight;
46
62
  } & {
47
63
  children?: import("react").ReactNode | undefined;
48
64
  } & import("react").RefAttributes<HTMLElement>>;
@@ -1,8 +1,8 @@
1
1
  import type { BaseProps } from '../../BaseProps';
2
- import type { SelectedAriaAttributes, IconAriaAttribute, IconColor, IconName, IconSize } from '../types';
2
+ import type { SelectedAriaAttributes, IconAriaAttribute, IconColor, IconName, BreakpointCustomizable, IconSize } from '../types';
3
3
  export type PIconProps = BaseProps & {
4
4
  /**
5
- * Add ARIA attributes.
5
+ * Sets ARIA attributes.
6
6
  */
7
7
  aria?: SelectedAriaAttributes<IconAriaAttribute>;
8
8
  /**
@@ -14,9 +14,9 @@ export type PIconProps = BaseProps & {
14
14
  */
15
15
  name?: IconName;
16
16
  /**
17
- * The size of the icon.
17
+ * Defines the size of the icon, aligned with the typographic scale used by components such as p-spinner, 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.
18
18
  */
19
- size?: IconSize;
19
+ size?: BreakpointCustomizable<IconSize>;
20
20
  /**
21
21
  * Specifies a whole icon path which can be used for custom icons.
22
22
  */
@@ -24,7 +24,7 @@ export type PIconProps = BaseProps & {
24
24
  };
25
25
  export declare const PIcon: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
26
26
  /**
27
- * Add ARIA attributes.
27
+ * Sets ARIA attributes.
28
28
  */
29
29
  aria?: SelectedAriaAttributes<IconAriaAttribute>;
30
30
  /**
@@ -36,9 +36,9 @@ export declare const PIcon: import("react").ForwardRefExoticComponent<Omit<impor
36
36
  */
37
37
  name?: IconName;
38
38
  /**
39
- * The size of the icon.
39
+ * Defines the size of the icon, aligned with the typographic scale used by components such as p-spinner, 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.
40
40
  */
41
- size?: IconSize;
41
+ size?: BreakpointCustomizable<IconSize>;
42
42
  /**
43
43
  * Specifies a whole icon path which can be used for custom icons.
44
44
  */