@porsche-design-system/components-react 4.0.0-rc.0 → 4.0.0-rc.2

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

@@ -7,14 +7,17 @@ export type PSheetProps = BaseProps & {
     aria?: SelectedAriaAttributes<SheetAriaAttribute>;
     /**
      * Defines the background color
+     * @default 'canvas'
      */
     background?: SheetBackground;
     /**
      * If true, the sheet will not be closable via backdrop click.
+     * @default false
      */
     disableBackdropClick?: boolean;
     /**
      * If false, the sheet will not have a dismiss button.
+     * @default true
      */
     dismissButton?: boolean;
     /**
@@ -31,6 +34,7 @@ export type PSheetProps = BaseProps & {
     onMotionVisibleEnd?: (event: CustomEvent<SheetMotionVisibleEndEventDetail>) => void;
     /**
      * If true, the sheet is open.
+     * @default false
      */
     open: boolean;
 };
@@ -41,14 +45,17 @@ export declare const PSheet: import("react").ForwardRefExoticComponent<Omit<impo
     aria?: SelectedAriaAttributes<SheetAriaAttribute>;
     /**
      * Defines the background color
+     * @default 'canvas'
      */
     background?: SheetBackground;
     /**
      * If true, the sheet will not be closable via backdrop click.
+     * @default false
      */
     disableBackdropClick?: boolean;
     /**
      * If false, the sheet will not have a dismiss button.
+     * @default true
      */
     dismissButton?: boolean;
     /**
@@ -65,6 +72,7 @@ export declare const PSheet: import("react").ForwardRefExoticComponent<Omit<impo
     onMotionVisibleEnd?: (event: CustomEvent<SheetMotionVisibleEndEventDetail>) => void;
     /**
      * If true, the sheet is open.
+     * @default false
      */
     open: boolean;
 } & {

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

@@ -7,10 +7,12 @@ export type PSpinnerProps = BaseProps & {
     aria?: SelectedAriaAttributes<SpinnerAriaAttribute>;
     /**
      * Basic color variations.
+     * @default 'primary'
      */
     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.
+     * @default 'sm'
      */
     size?: BreakpointCustomizable<SpinnerSize>;
 };
@@ -21,10 +23,12 @@ export declare const PSpinner: import("react").ForwardRefExoticComponent<Omit<im
     aria?: SelectedAriaAttributes<SpinnerAriaAttribute>;
     /**
      * Basic color variations.
+     * @default 'primary'
      */
     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.
+     * @default 'sm'
      */
     size?: BreakpointCustomizable<SpinnerSize>;
 } & import("react").RefAttributes<HTMLElement>>;

package/esm/lib/components/stepper-horizontal-item.wrapper.d.ts

@@ -3,6 +3,7 @@ import type { StepperHorizontalItemState } from '../types';
 export type PStepperHorizontalItemProps = BaseProps & {
     /**
      * Disables the stepper-horizontal-item. No events will be triggered while disabled state is active.
+     * @default false
      */
     disabled?: boolean;
     /**
@@ -13,6 +14,7 @@ export type PStepperHorizontalItemProps = BaseProps & {
 export declare const PStepperHorizontalItem: 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"> & {
     /**
      * Disables the stepper-horizontal-item. No events will be triggered while disabled state is active.
+     * @default false
      */
     disabled?: boolean;
     /**

package/esm/lib/components/stepper-horizontal.wrapper.d.ts

@@ -7,6 +7,7 @@ export type PStepperHorizontalProps = BaseProps & {
     onUpdate?: (event: CustomEvent<StepperHorizontalUpdateEventDetail>) => void;
     /**
      * The text size.
+     * @default 'small'
      */
     size?: BreakpointCustomizable<StepperHorizontalSize>;
 };
@@ -17,6 +18,7 @@ export declare const PStepperHorizontal: import("react").ForwardRefExoticCompone
     onUpdate?: (event: CustomEvent<StepperHorizontalUpdateEventDetail>) => void;
     /**
      * The text size.
+     * @default 'small'
      */
     size?: BreakpointCustomizable<StepperHorizontalSize>;
 } & {

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

@@ -3,26 +3,32 @@ import type { BreakpointCustomizable, SwitchAlignLabel, SwitchUpdateEventDetail
 export type PSwitchProps = BaseProps & {
     /**
      * Aligns the label.
+     * @default 'end'
      */
     alignLabel?: BreakpointCustomizable<SwitchAlignLabel>;
     /**
      * Visualize the switch with on/off status.
+     * @default false
      */
     checked?: boolean;
     /**
      * Displays the switch in compact mode.
+     * @default false
      */
     compact?: boolean;
     /**
      * Disables the switch. No events will be triggered while disabled state is active.
+     * @default false
      */
     disabled?: boolean;
     /**
      * Shows or hides the label. For better accessibility, it is recommended to show the label.
+     * @default false
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
      * Disables the switch and shows a loading indicator. No events will be triggered while loading state is active.
+     * @default false
      */
     loading?: boolean;
     /**
@@ -31,32 +37,39 @@ export type PSwitchProps = BaseProps & {
     onUpdate?: (event: CustomEvent<SwitchUpdateEventDetail>) => void;
     /**
      * Stretches the contents to max available space.
+     * @default false
      */
     stretch?: BreakpointCustomizable<boolean>;
 };
 export declare const PSwitch: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
     /**
      * Aligns the label.
+     * @default 'end'
      */
     alignLabel?: BreakpointCustomizable<SwitchAlignLabel>;
     /**
      * Visualize the switch with on/off status.
+     * @default false
      */
     checked?: boolean;
     /**
      * Displays the switch in compact mode.
+     * @default false
      */
     compact?: boolean;
     /**
      * Disables the switch. No events will be triggered while disabled state is active.
+     * @default false
      */
     disabled?: boolean;
     /**
      * Shows or hides the label. For better accessibility, it is recommended to show the label.
+     * @default false
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
      * Disables the switch and shows a loading indicator. No events will be triggered while loading state is active.
+     * @default false
      */
     loading?: boolean;
     /**
@@ -65,6 +78,7 @@ export declare const PSwitch: import("react").ForwardRefExoticComponent<Omit<imp
     onUpdate?: (event: CustomEvent<SwitchUpdateEventDetail>) => void;
     /**
      * Stretches the contents to max available space.
+     * @default false
      */
     stretch?: BreakpointCustomizable<boolean>;
 } & {

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

@@ -2,12 +2,14 @@ import type { BaseProps } from '../../BaseProps';
 export type PTableCellProps = BaseProps & {
     /**
      * Allows slotted text to wrap onto multiple lines instead of being forced onto a single line.
+     * @default false
      */
     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"> & {
     /**
      * Allows slotted text to wrap onto multiple lines instead of being forced onto a single line.
+     * @default false
      */
     multiline?: boolean;
 } & {

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

@@ -3,10 +3,12 @@ import type { TableHeadCellSort } from '../types';
 export type PTableHeadCellProps = BaseProps & {
     /**
      * Hides the label but keeps it accessible for screen readers. This property only takes effect when the `sort` prop is not set.
+     * @default false
      */
     hideLabel?: boolean;
     /**
      * Allows slotted text to wrap onto multiple lines instead of being forced onto a single line.
+     * @default false
      */
     multiline?: boolean;
     /**
@@ -17,10 +19,12 @@ 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 keeps it accessible for screen readers. This property only takes effect when the `sort` prop is not set.
+     * @default false
      */
     hideLabel?: boolean;
     /**
      * Allows slotted text to wrap onto multiple lines instead of being forced onto a single line.
+     * @default false
      */
     multiline?: boolean;
     /**

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

@@ -7,10 +7,12 @@ export type PTableProps = BaseProps & {
     caption?: string;
     /**
      * Displays with reduced spacing and smaller padding for a more condensed layout.
+     * @default false
      */
     compact?: boolean;
     /**
      * Controls the layout behavior of the table.
+     * @default 'auto'
      */
     layout?: TableLayout;
     /**
@@ -19,6 +21,7 @@ export type PTableProps = BaseProps & {
     onUpdate?: (event: CustomEvent<TableUpdateEventDetail>) => void;
     /**
      * @experimental Makes the scroll indicator sticky at the top or bottom while scrolling depending on the scroll direction.
+     * @default false
      */
     sticky?: boolean;
 };
@@ -29,10 +32,12 @@ export declare const PTable: import("react").ForwardRefExoticComponent<Omit<impo
     caption?: string;
     /**
      * Displays with reduced spacing and smaller padding for a more condensed layout.
+     * @default false
      */
     compact?: boolean;
     /**
      * Controls the layout behavior of the table.
+     * @default 'auto'
      */
     layout?: TableLayout;
     /**
@@ -41,6 +46,7 @@ export declare const PTable: import("react").ForwardRefExoticComponent<Omit<impo
     onUpdate?: (event: CustomEvent<TableUpdateEventDetail>) => void;
     /**
      * @experimental Makes the scroll indicator sticky at the top or bottom while scrolling depending on the scroll direction.
+     * @default false
      */
     sticky?: boolean;
 } & {

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

@@ -7,6 +7,7 @@ export type PTabsBarProps = BaseProps & {
     activeTabIndex?: number | undefined;
     /**
      * Defines the background color. Use `frosted` only on images, videos or gradients.
+     * @default 'none'
      */
     background?: TabsBarBackground;
     /**
@@ -19,10 +20,12 @@ export type PTabsBarProps = BaseProps & {
     onUpdate?: (event: CustomEvent<TabsBarUpdateEventDetail>) => void;
     /**
      * The text size.
+     * @default 'small'
      */
     size?: BreakpointCustomizable<TabsBarSize>;
     /**
      * @deprecated Will be removed in the next major release. Has no effect anymore.
+     * @default 'regular'
      */
     weight?: TabsBarWeight;
 };
@@ -33,6 +36,7 @@ export declare const PTabsBar: import("react").ForwardRefExoticComponent<Omit<im
     activeTabIndex?: number | undefined;
     /**
      * Defines the background color. Use `frosted` only on images, videos or gradients.
+     * @default 'none'
      */
     background?: TabsBarBackground;
     /**
@@ -45,10 +49,12 @@ export declare const PTabsBar: import("react").ForwardRefExoticComponent<Omit<im
     onUpdate?: (event: CustomEvent<TabsBarUpdateEventDetail>) => void;
     /**
      * The text size.
+     * @default 'small'
      */
     size?: BreakpointCustomizable<TabsBarSize>;
     /**
      * @deprecated Will be removed in the next major release. Has no effect anymore.
+     * @default 'regular'
      */
     weight?: TabsBarWeight;
 } & {

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

@@ -3,10 +3,12 @@ import type { TabsBackground, TabsUpdateEventDetail, BreakpointCustomizable, Tab
 export type PTabsProps = BaseProps & {
     /**
      * Defines which tab is shown as selected (zero-based numbering).
+     * @default 0
      */
     activeTabIndex?: number;
     /**
      * Defines the background color. Use `frosted` only on images, videos or gradients.
+     * @default 'none'
      */
     background?: TabsBackground;
     /**
@@ -19,20 +21,24 @@ export type PTabsProps = BaseProps & {
     onUpdate?: (event: CustomEvent<TabsUpdateEventDetail>) => void;
     /**
      * The text size.
+     * @default 'small'
      */
     size?: BreakpointCustomizable<TabsSize>;
     /**
      * @deprecated Will be removed in the next major release. Has no effect anymore.
+     * @default 'regular'
      */
     weight?: TabsWeight;
 };
 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 is shown as selected (zero-based numbering).
+     * @default 0
      */
     activeTabIndex?: number;
     /**
      * Defines the background color. Use `frosted` only on images, videos or gradients.
+     * @default 'none'
      */
     background?: TabsBackground;
     /**
@@ -45,10 +51,12 @@ export declare const PTabs: import("react").ForwardRefExoticComponent<Omit<impor
     onUpdate?: (event: CustomEvent<TabsUpdateEventDetail>) => void;
     /**
      * The text size.
+     * @default 'small'
      */
     size?: BreakpointCustomizable<TabsSize>;
     /**
      * @deprecated Will be removed in the next major release. Has no effect anymore.
+     * @default 'regular'
      */
     weight?: TabsWeight;
 } & {

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

@@ -7,6 +7,7 @@ export type PTagDismissibleProps = BaseProps & {
     aria?: SelectedAriaAttributes<TagDismissibleAriaAttribute>;
     /**
      * Displays the dismissible tag in compact mode.
+     * @default false
      */
     compact?: boolean;
     /**
@@ -21,6 +22,7 @@ export declare const PTagDismissible: import("react").ForwardRefExoticComponent<
     aria?: SelectedAriaAttributes<TagDismissibleAriaAttribute>;
     /**
      * Displays the dismissible tag in compact mode.
+     * @default false
      */
     compact?: boolean;
     /**

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

@@ -3,10 +3,12 @@ import type { TagIcon, TagVariant } from '../types';
 export type PTagProps = BaseProps & {
     /**
      * Displays the tag in compact mode.
+     * @default false
      */
     compact?: boolean;
     /**
      * The icon shown.
+     * @default 'none'
      */
     icon?: TagIcon;
     /**
@@ -15,16 +17,19 @@ export type PTagProps = BaseProps & {
     iconSource?: string;
     /**
      * Background color variations.
+     * @default 'secondary'
      */
     variant?: TagVariant;
 };
 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 the tag in compact mode.
+     * @default false
      */
     compact?: boolean;
     /**
      * The icon shown.
+     * @default 'none'
      */
     icon?: TagIcon;
     /**
@@ -33,6 +38,7 @@ export declare const PTag: import("react").ForwardRefExoticComponent<Omit<import
     iconSource?: string;
     /**
      * Background color variations.
+     * @default 'secondary'
      */
     variant?: TagVariant;
 } & {

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

@@ -3,12 +3,14 @@ import type { TextListType } from '../types';
 export type PTextListProps = BaseProps & {
     /**
      * The list style type.
+     * @default 'unordered'
      */
     type?: TextListType;
 };
 export declare const PTextList: 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"> & {
     /**
      * The list style type.
+     * @default 'unordered'
      */
     type?: TextListType;
 } & {

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

@@ -3,60 +3,74 @@ import type { TextAlign, TextColor, TextHyphens, BreakpointCustomizable, TextSiz
 export type PTextProps = BaseProps & {
     /**
      * 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.
+     * @default 'start'
      */
     align?: TextAlign;
     /**
      * 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.
+     * @default 'primary'
      */
     color?: TextColor;
     /**
      * 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.
+     * @default false
      */
     ellipsis?: boolean;
     /**
      * 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.
+     * @default 'inherit'
      */
     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.
+     * @default 'sm'
      */
     size?: BreakpointCustomizable<TextSize>;
     /**
      * Sets the HTML tag of the rendered element to ensure correct semantic meaning (e.g. 'p' for paragraphs, 'blockquote' for quotes, 'time' for dates).
+     * @default 'p'
      */
     tag?: TextTag;
     /**
      * The font weight of the text. Use 'normal' for regular body text, 'semibold' for slightly emphasized text, or 'bold' for strong emphasis.
+     * @default 'normal'
      */
     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 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.
+     * @default 'start'
      */
     align?: TextAlign;
     /**
      * 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.
+     * @default 'primary'
      */
     color?: TextColor;
     /**
      * 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.
+     * @default false
      */
     ellipsis?: boolean;
     /**
      * 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.
+     * @default 'inherit'
      */
     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.
+     * @default 'sm'
      */
     size?: BreakpointCustomizable<TextSize>;
     /**
      * Sets the HTML tag of the rendered element to ensure correct semantic meaning (e.g. 'p' for paragraphs, 'blockquote' for quotes, 'time' for dates).
+     * @default 'p'
      */
     tag?: TextTag;
     /**
      * The font weight of the text. Use 'normal' for regular body text, 'semibold' for slightly emphasized text, or 'bold' for strong emphasis.
+     * @default 'normal'
      */
     weight?: TextWeight;
 } & {