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

package/esm/lib/components/sheet.wrapper.d.ts

@@ -2,7 +2,7 @@ import type { BaseProps } from '../../BaseProps';
 import type { SelectedAriaAttributes, SheetAriaAttribute, SheetBackground, SheetMotionHiddenEndEventDetail, SheetMotionVisibleEndEventDetail } from '../types';
 export type PSheetProps = BaseProps & {
     /**
-     * Add ARIA attributes.
+     * Sets ARIA attributes.
      */
     aria?: SelectedAriaAttributes<SheetAriaAttribute>;
     /**
@@ -36,7 +36,7 @@ export type PSheetProps = BaseProps & {
 };
 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" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
     /**
-     * Add ARIA attributes.
+     * Sets ARIA attributes.
      */
     aria?: SelectedAriaAttributes<SheetAriaAttribute>;
     /**

package/esm/lib/components/spinner.wrapper.d.ts

@@ -1,22 +1,30 @@
 import type { BaseProps } from '../../BaseProps';
-import type { SelectedAriaAttributes, SpinnerAriaAttribute, BreakpointCustomizable, SpinnerSize } from '../types';
+import type { SelectedAriaAttributes, SpinnerAriaAttribute, SpinnerColor, BreakpointCustomizable, SpinnerSize } from '../types';
 export type PSpinnerProps = BaseProps & {
     /**
-     * Add ARIA attributes.
+     * Sets ARIA attributes.
      */
     aria?: SelectedAriaAttributes<SpinnerAriaAttribute>;
     /**
-     * Size of the spinner.
+     * Basic color variations.
+     */
+    color?: SpinnerColor;
+    /**
+     * 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.
      */
     size?: BreakpointCustomizable<SpinnerSize>;
 };
 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" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
     /**
-     * Add ARIA attributes.
+     * Sets ARIA attributes.
      */
     aria?: SelectedAriaAttributes<SpinnerAriaAttribute>;
     /**
-     * Size of the spinner.
+     * Basic color variations.
+     */
+    color?: SpinnerColor;
+    /**
+     * 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.
      */
     size?: BreakpointCustomizable<SpinnerSize>;
 } & import("react").RefAttributes<HTMLElement>>;

package/esm/lib/components/spinner.wrapper.mjs

@@ -4,13 +4,13 @@ import { forwardRef, useRef } from 'react';
 import { usePrefix, useBrowserLayoutEffect, useMergedClass } from '../../hooks.mjs';
 import { syncRef } from '../../utils.mjs';
 
-const PSpinner = /*#__PURE__*/ forwardRef(({ aria, size = 'small', className, ...rest }, ref) => {
+const PSpinner = /*#__PURE__*/ forwardRef(({ aria, color = 'primary', size = 'sm', className, ...rest }, ref) => {
     const elementRef = useRef(undefined);
     const WebComponentTag = usePrefix('p-spinner');
-    const propsToSync = [aria, size];
+    const propsToSync = [aria, color, size];
     useBrowserLayoutEffect(() => {
         const { current } = elementRef;
-        ['aria', 'size'].forEach((propName, i) => (current[propName] = propsToSync[i]));
+        ['aria', 'color', 'size'].forEach((propName, i) => (current[propName] = propsToSync[i]));
     }, propsToSync);
     const props = {
         ...rest,

package/esm/lib/components/switch.wrapper.d.ts

@@ -10,7 +10,7 @@ export type PSwitchProps = BaseProps & {
      */
     checked?: boolean;
     /**
-     * Displays as compact version.
+     * Displays the switch in compact mode.
      */
     compact?: boolean;
     /**
@@ -18,7 +18,7 @@ export type PSwitchProps = BaseProps & {
      */
     disabled?: boolean;
     /**
-     * Show or hide label. For better accessibility it's recommended to show the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -26,7 +26,7 @@ export type PSwitchProps = BaseProps & {
      */
     loading?: boolean;
     /**
-     * Emitted when checked status is changed.
+     * Emitted when the checked state changes.
      */
     onUpdate?: (event: CustomEvent<SwitchUpdateEventDetail>) => void;
     /**
@@ -44,7 +44,7 @@ export declare const PSwitch: import("react").ForwardRefExoticComponent<Omit<imp
      */
     checked?: boolean;
     /**
-     * Displays as compact version.
+     * Displays the switch in compact mode.
      */
     compact?: boolean;
     /**
@@ -52,7 +52,7 @@ export declare const PSwitch: import("react").ForwardRefExoticComponent<Omit<imp
      */
     disabled?: boolean;
     /**
-     * Show or hide label. For better accessibility it's recommended to show the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -60,7 +60,7 @@ export declare const PSwitch: import("react").ForwardRefExoticComponent<Omit<imp
      */
     loading?: boolean;
     /**
-     * Emitted when checked status is changed.
+     * Emitted when the checked state changes.
      */
     onUpdate?: (event: CustomEvent<SwitchUpdateEventDetail>) => void;
     /**

package/esm/lib/components/table-cell.wrapper.d.ts

@@ -1,13 +1,13 @@
 import type { BaseProps } from '../../BaseProps';
 export type PTableCellProps = BaseProps & {
     /**
-     * Displays slotted text multiline or forced into a single line.
+     * Allows slotted text to wrap onto multiple lines instead of being forced onto a single line.
      */
     multiline?: boolean;
 };
 export declare const PTableCell: 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"> & {
     /**
-     * Displays slotted text multiline or forced into a single line.
+     * Allows slotted text to wrap onto multiple lines instead of being forced onto a single line.
      */
     multiline?: boolean;
 } & {

package/esm/lib/components/table-head-cell.wrapper.d.ts

@@ -2,11 +2,11 @@ import type { BaseProps } from '../../BaseProps';
 import type { TableHeadCellSort } from '../types';
 export type PTableHeadCellProps = BaseProps & {
     /**
-     * Hides the label but stays accessible for screen readers. This property only takes effect when sort property is not defined.
+     * Hides the label but keeps it accessible for screen readers. This property only takes effect when the `sort` prop is not set.
      */
     hideLabel?: boolean;
     /**
-     * Displays slotted text multiline or forced into a single line.
+     * Allows slotted text to wrap onto multiple lines instead of being forced onto a single line.
      */
     multiline?: boolean;
     /**
@@ -16,11 +16,11 @@ export type PTableHeadCellProps = BaseProps & {
 };
 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" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
     /**
-     * Hides the label but stays accessible for screen readers. This property only takes effect when sort property is not defined.
+     * Hides the label but keeps it accessible for screen readers. This property only takes effect when the `sort` prop is not set.
      */
     hideLabel?: boolean;
     /**
-     * Displays slotted text multiline or forced into a single line.
+     * Allows slotted text to wrap onto multiple lines instead of being forced onto a single line.
      */
     multiline?: boolean;
     /**

package/esm/lib/components/tabs-bar.wrapper.d.ts

@@ -2,7 +2,7 @@ import type { BaseProps } from '../../BaseProps';
 import type { TabsBarBackground, TabsBarUpdateEventDetail, BreakpointCustomizable, TabsBarSize, TabsBarWeight } from '../types';
 export type PTabsBarProps = BaseProps & {
     /**
-     * Defines which tab to be visualized as selected (zero-based numbering), undefined if none should be selected.
+     * Defines which tab is shown as selected (zero-based numbering), or `undefined` if none should be selected.
      */
     activeTabIndex?: number | undefined;
     /**
@@ -28,7 +28,7 @@ export type PTabsBarProps = BaseProps & {
 };
 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" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
     /**
-     * Defines which tab to be visualized as selected (zero-based numbering), undefined if none should be selected.
+     * Defines which tab is shown as selected (zero-based numbering), or `undefined` if none should be selected.
      */
     activeTabIndex?: number | undefined;
     /**

package/esm/lib/components/tabs.wrapper.d.ts

@@ -2,7 +2,7 @@ import type { BaseProps } from '../../BaseProps';
 import type { TabsBackground, TabsUpdateEventDetail, BreakpointCustomizable, TabsSize, TabsWeight } from '../types';
 export type PTabsProps = BaseProps & {
     /**
-     * Defines which tab to be visualized as selected (zero-based numbering).
+     * Defines which tab is shown as selected (zero-based numbering).
      */
     activeTabIndex?: number;
     /**
@@ -28,7 +28,7 @@ export type PTabsProps = BaseProps & {
 };
 export declare const PTabs: 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"> & {
     /**
-     * Defines which tab to be visualized as selected (zero-based numbering).
+     * Defines which tab is shown as selected (zero-based numbering).
      */
     activeTabIndex?: number;
     /**

package/esm/lib/components/tag-dismissible.wrapper.d.ts

@@ -2,29 +2,29 @@ import type { BaseProps } from '../../BaseProps';
 import type { SelectedAriaAttributes, TagDismissibleAriaAttribute } from '../types';
 export type PTagDismissibleProps = BaseProps & {
     /**
-     * Add ARIA attributes.
+     * Sets ARIA attributes.
      */
     aria?: SelectedAriaAttributes<TagDismissibleAriaAttribute>;
     /**
-     * A boolean value that, if present, renders the tag dismissible as a compact version.
+     * Displays the dismissible tag in compact mode.
      */
     compact?: boolean;
     /**
-     * The label text.
+     * Text content for a user-facing label.
      */
     label?: string;
 };
 export declare const PTagDismissible: 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"> & {
     /**
-     * Add ARIA attributes.
+     * Sets ARIA attributes.
      */
     aria?: SelectedAriaAttributes<TagDismissibleAriaAttribute>;
     /**
-     * A boolean value that, if present, renders the tag dismissible as a compact version.
+     * Displays the dismissible tag in compact mode.
      */
     compact?: boolean;
     /**
-     * The label text.
+     * Text content for a user-facing label.
      */
     label?: string;
 } & {

package/esm/lib/components/tag.wrapper.d.ts

@@ -2,7 +2,7 @@ import type { BaseProps } from '../../BaseProps';
 import type { TagIcon, TagVariant } from '../types';
 export type PTagProps = BaseProps & {
     /**
-     * Displays as compact version.
+     * Displays the tag in compact mode.
      */
     compact?: boolean;
     /**
@@ -20,7 +20,7 @@ export type PTagProps = BaseProps & {
 };
 export declare const PTag: 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"> & {
     /**
-     * Displays as compact version.
+     * Displays the tag in compact mode.
      */
     compact?: boolean;
     /**

package/esm/lib/components/text.wrapper.d.ts

@@ -1,54 +1,62 @@
 import type { BaseProps } from '../../BaseProps';
-import type { TextAlign, TextColor, BreakpointCustomizable, TextSize, TextTag, TextWeight } from '../types';
+import type { TextAlign, TextColor, TextHyphens, BreakpointCustomizable, TextSize, TextTag, TextWeight } from '../types';
 export type PTextProps = BaseProps & {
     /**
-     * Text alignment of the component.
+     * Text alignment of the text. 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.
      */
     align?: TextAlign;
     /**
-     * Basic text color variations.
+     * Text color of the text. Use 'primary' for default, 'contrast-higher' / 'contrast-high' / 'contrast-medium' for alternative emphasis levels, 'success' / 'warning' / 'error' / 'info' for status messages, or 'inherit' to adopt the parent's color.
      */
     color?: TextColor;
     /**
-     * Adds an ellipsis to a single line of text if it overflows.
+     * 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.
      */
     ellipsis?: boolean;
     /**
-     * Size of the text. Also defines the size for specific breakpoints, like {base: "small", l: "medium"}. You always need to provide a base value when doing this.
+     * Controls the hyphenation behavior of the text. Use 'auto' to let the browser automatically hyphenate words at appropriate points, 'manual' to only hyphenate at manually inserted hyphenation points (e.g. `­`), 'none' to disable hyphenation entirely, or 'inherit' to adopt the parent's hyphenation setting.
+     */
+    hyphens?: TextHyphens;
+    /**
+     * Size of the text. Also defines the size for specific breakpoints, like {base: "sm", l: "md"}. You always need to provide a base value when doing this. Use 'inherit' to adopt the parent's font size.
      */
     size?: BreakpointCustomizable<TextSize>;
     /**
-     * Sets a custom HTML tag depending on the usage of the text component.
+     * Sets the HTML tag of the rendered element to ensure correct semantic meaning (e.g. 'p' for paragraphs, 'blockquote' for quotes, 'time' for dates).
      */
     tag?: TextTag;
     /**
-     * The weight of the text.
+     * The font weight of the text. Use 'normal' for regular body text, 'semibold' for slightly emphasized text, or 'bold' for strong emphasis.
      */
     weight?: TextWeight;
 };
 export declare const PText: 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"> & {
     /**
-     * Text alignment of the component.
+     * Text alignment of the text. 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.
      */
     align?: TextAlign;
     /**
-     * Basic text color variations.
+     * Text color of the text. Use 'primary' for default, 'contrast-higher' / 'contrast-high' / 'contrast-medium' for alternative emphasis levels, 'success' / 'warning' / 'error' / 'info' for status messages, or 'inherit' to adopt the parent's color.
      */
     color?: TextColor;
     /**
-     * Adds an ellipsis to a single line of text if it overflows.
+     * 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.
      */
     ellipsis?: boolean;
     /**
-     * Size of the text. Also defines the size for specific breakpoints, like {base: "small", l: "medium"}. You always need to provide a base value when doing this.
+     * Controls the hyphenation behavior of the text. 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.
+     */
+    hyphens?: TextHyphens;
+    /**
+     * Size of the text. Also defines the size for specific breakpoints, like {base: "sm", l: "md"}. You always need to provide a base value when doing this. Use 'inherit' to adopt the parent's font size.
      */
     size?: BreakpointCustomizable<TextSize>;
     /**
-     * Sets a custom HTML tag depending on the usage of the text component.
+     * Sets the HTML tag of the rendered element to ensure correct semantic meaning (e.g. 'p' for paragraphs, 'blockquote' for quotes, 'time' for dates).
      */
     tag?: TextTag;
     /**
-     * The weight of the text.
+     * The font weight of the text. Use 'normal' for regular body text, 'semibold' for slightly emphasized text, or 'bold' for strong emphasis.
      */
     weight?: TextWeight;
 } & {

package/esm/lib/components/text.wrapper.mjs

@@ -4,13 +4,13 @@ import { forwardRef, useRef } from 'react';
 import { usePrefix, useBrowserLayoutEffect, useMergedClass } from '../../hooks.mjs';
 import { syncRef } from '../../utils.mjs';
 
-const PText = /*#__PURE__*/ forwardRef(({ align = 'start', color = 'primary', ellipsis = false, size = 'small', tag = 'p', weight = 'regular', className, ...rest }, ref) => {
+const PText = /*#__PURE__*/ forwardRef(({ align = 'start', color = 'primary', ellipsis = false, hyphens = 'inherit', size = 'sm', tag = 'p', weight = 'normal', className, ...rest }, ref) => {
     const elementRef = useRef(undefined);
     const WebComponentTag = usePrefix('p-text');
-    const propsToSync = [align, color, ellipsis, size, tag, weight];
+    const propsToSync = [align, color, ellipsis, hyphens, size, tag, weight];
     useBrowserLayoutEffect(() => {
         const { current } = elementRef;
-        ['align', 'color', 'ellipsis', 'size', 'tag', 'weight'].forEach((propName, i) => (current[propName] = propsToSync[i]));
+        ['align', 'color', 'ellipsis', 'hyphens', 'size', 'tag', 'weight'].forEach((propName, i) => (current[propName] = propsToSync[i]));
     }, propsToSync);
     const props = {
         ...rest,

package/esm/lib/components/textarea.wrapper.d.ts

@@ -6,7 +6,7 @@ export type PTextareaProps = BaseProps & {
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the textarea as a compact version.
+     * Displays the textarea in compact mode.
      */
     compact?: boolean;
     /**
@@ -18,7 +18,7 @@ export type PTextareaProps = BaseProps & {
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the textarea unusable and unclickable. The value will not be submitted with the form.
+     * Disables the textarea. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -26,7 +26,7 @@ export type PTextareaProps = BaseProps & {
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -104,7 +104,7 @@ export declare const PTextarea: import("react").ForwardRefExoticComponent<Omit<i
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the textarea as a compact version.
+     * Displays the textarea in compact mode.
      */
     compact?: boolean;
     /**
@@ -116,7 +116,7 @@ export declare const PTextarea: import("react").ForwardRefExoticComponent<Omit<i
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the textarea unusable and unclickable. The value will not be submitted with the form.
+     * Disables the textarea. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -124,7 +124,7 @@ export declare const PTextarea: import("react").ForwardRefExoticComponent<Omit<i
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**

package/esm/lib/components/wordmark.wrapper.d.ts

@@ -2,37 +2,37 @@ import type { BaseProps } from '../../BaseProps';
 import type { SelectedAriaAttributes, WordmarkAriaAttribute, WordmarkSize, WordmarkTarget } from '../types';
 export type PWordmarkProps = BaseProps & {
     /**
-     * Add ARIA attributes.
+     * Sets ARIA attributes.
      */
     aria?: SelectedAriaAttributes<WordmarkAriaAttribute>;
     /**
-     * When providing an url then the component will be rendered as `<a>`.
+     * When `href` is provided, the component renders as an `<a>` element.
      */
     href?: string;
     /**
-     * Adapts sizing of wordmark.
+     * Controls the size of the wordmark.
      */
     size?: WordmarkSize;
     /**
-     * Target attribute where the link should be opened.
+     * Specifies where to open the linked document.
      */
     target?: WordmarkTarget;
 };
 export declare const PWordmark: 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"> & {
     /**
-     * Add ARIA attributes.
+     * Sets ARIA attributes.
      */
     aria?: SelectedAriaAttributes<WordmarkAriaAttribute>;
     /**
-     * When providing an url then the component will be rendered as `<a>`.
+     * When `href` is provided, the component renders as an `<a>` element.
      */
     href?: string;
     /**
-     * Adapts sizing of wordmark.
+     * Controls the size of the wordmark.
      */
     size?: WordmarkSize;
     /**
-     * Target attribute where the link should be opened.
+     * Specifies where to open the linked document.
      */
     target?: WordmarkTarget;
 } & import("react").RefAttributes<HTMLElement>>;