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

package/ssr/esm/lib/components/input-url.wrapper.d.ts

@@ -7,14 +7,17 @@ export type PInputUrlProps = BaseProps & {
     autoComplete?: string;
     /**
      * Displays the input field in compact mode.
+     * @default false
      */
     compact?: boolean;
     /**
      * Supplementary text providing more context or explanation for the input.
+     * @default ''
      */
     description?: string;
     /**
      * Disables the input field. The value will not be submitted with the form.
+     * @default false
      */
     disabled?: boolean;
     /**
@@ -23,18 +26,22 @@ export type PInputUrlProps = BaseProps & {
     form?: string;
     /**
      * Shows or hides the label. For better accessibility, it is recommended to show the label.
+     * @default false
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
      * Controls the visibility of the URL icon.
+     * @default false
      */
     indicator?: boolean;
     /**
      * Text content for a user-facing label.
+     * @default ''
      */
     label?: string;
     /**
      * @experimental Shows a loading indicator.
+     * @default false
      */
     loading?: boolean;
     /**
@@ -43,6 +50,7 @@ export type PInputUrlProps = BaseProps & {
     maxLength?: number;
     /**
      * Dynamic feedback text for validation or status.
+     * @default ''
      */
     message?: string;
     /**
@@ -71,22 +79,27 @@ export type PInputUrlProps = BaseProps & {
     pattern?: string;
     /**
      * A string that provides a brief hint to the user about what kind of information is expected in the field (e.g., placeholder='https://porsche.com/')
+     * @default ''
      */
     placeholder?: string;
     /**
      * A boolean value that, if present, makes the input field uneditable by the user, but its value will still be submitted with the form.
+     * @default false
      */
     readOnly?: boolean;
     /**
      * A boolean value that, if present, indicates that the input field must be filled out before the form can be submitted.
+     * @default false
      */
     required?: boolean;
     /**
      * Indicates the validation or overall status of the input component.
+     * @default 'none'
      */
     state?: InputUrlState;
     /**
      * The URL input value.
+     * @default ''
      */
     value?: string;
 };
@@ -97,14 +110,17 @@ export declare const PInputUrl: import("react").ForwardRefExoticComponent<Omit<i
     autoComplete?: string;
     /**
      * Displays the input field in compact mode.
+     * @default false
      */
     compact?: boolean;
     /**
      * Supplementary text providing more context or explanation for the input.
+     * @default ''
      */
     description?: string;
     /**
      * Disables the input field. The value will not be submitted with the form.
+     * @default false
      */
     disabled?: boolean;
     /**
@@ -113,18 +129,22 @@ export declare const PInputUrl: import("react").ForwardRefExoticComponent<Omit<i
     form?: string;
     /**
      * Shows or hides the label. For better accessibility, it is recommended to show the label.
+     * @default false
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
      * Controls the visibility of the URL icon.
+     * @default false
      */
     indicator?: boolean;
     /**
      * Text content for a user-facing label.
+     * @default ''
      */
     label?: string;
     /**
      * @experimental Shows a loading indicator.
+     * @default false
      */
     loading?: boolean;
     /**
@@ -133,6 +153,7 @@ export declare const PInputUrl: import("react").ForwardRefExoticComponent<Omit<i
     maxLength?: number;
     /**
      * Dynamic feedback text for validation or status.
+     * @default ''
      */
     message?: string;
     /**
@@ -161,22 +182,27 @@ export declare const PInputUrl: import("react").ForwardRefExoticComponent<Omit<i
     pattern?: string;
     /**
      * A string that provides a brief hint to the user about what kind of information is expected in the field (e.g., placeholder='https://porsche.com/')
+     * @default ''
      */
     placeholder?: string;
     /**
      * A boolean value that, if present, makes the input field uneditable by the user, but its value will still be submitted with the form.
+     * @default false
      */
     readOnly?: boolean;
     /**
      * A boolean value that, if present, indicates that the input field must be filled out before the form can be submitted.
+     * @default false
      */
     required?: boolean;
     /**
      * Indicates the validation or overall status of the input component.
+     * @default 'none'
      */
     state?: InputUrlState;
     /**
      * The URL input value.
+     * @default ''
      */
     value?: string;
 } & {

package/ssr/esm/lib/components/input-week.wrapper.d.ts

@@ -7,14 +7,17 @@ export type PInputWeekProps = BaseProps & {
     autoComplete?: string;
     /**
      * Displays the input field in compact mode.
+     * @default false
      */
     compact?: boolean;
     /**
      * Supplementary text providing more context or explanation for the input.
+     * @default ''
      */
     description?: string;
     /**
      * Disables the input field. The value will not be submitted with the form.
+     * @default false
      */
     disabled?: boolean;
     /**
@@ -23,14 +26,17 @@ export type PInputWeekProps = BaseProps & {
     form?: string;
     /**
      * Shows or hides the label. For better accessibility, it is recommended to show the label.
+     * @default false
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
      * Text content for a user-facing label.
+     * @default ''
      */
     label?: string;
     /**
      * @experimental Shows a loading indicator.
+     * @default false
      */
     loading?: boolean;
     /**
@@ -39,6 +45,7 @@ export type PInputWeekProps = BaseProps & {
     max?: string;
     /**
      * Dynamic feedback text for validation or status.
+     * @default ''
      */
     message?: string;
     /**
@@ -63,22 +70,27 @@ export type PInputWeekProps = BaseProps & {
     onInput?: (event: CustomEvent<InputWeekInputEventDetail>) => void;
     /**
      * A boolean value that, if present, makes the input field uneditable by the user, but its value will still be submitted with the form.
+     * @default false
      */
     readOnly?: boolean;
     /**
      * A boolean value that, if present, indicates that the input field must be filled out before the form can be submitted.
+     * @default false
      */
     required?: boolean;
     /**
      * Indicates the validation or overall status of the input component.
+     * @default 'none'
      */
     state?: InputWeekState;
     /**
      * Defines the stepping interval in weeks. For example, step="1" increments by 1 week. The default is 1 week.
+     * @default 1
      */
     step?: number;
     /**
      * The default week value for the input, in YYYY-Www format (e.g., value='2025-W27').
+     * @default ''
      */
     value?: string;
 };
@@ -89,14 +101,17 @@ export declare const PInputWeek: import("react").ForwardRefExoticComponent<Omit<
     autoComplete?: string;
     /**
      * Displays the input field in compact mode.
+     * @default false
      */
     compact?: boolean;
     /**
      * Supplementary text providing more context or explanation for the input.
+     * @default ''
      */
     description?: string;
     /**
      * Disables the input field. The value will not be submitted with the form.
+     * @default false
      */
     disabled?: boolean;
     /**
@@ -105,14 +120,17 @@ export declare const PInputWeek: import("react").ForwardRefExoticComponent<Omit<
     form?: string;
     /**
      * Shows or hides the label. For better accessibility, it is recommended to show the label.
+     * @default false
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
      * Text content for a user-facing label.
+     * @default ''
      */
     label?: string;
     /**
      * @experimental Shows a loading indicator.
+     * @default false
      */
     loading?: boolean;
     /**
@@ -121,6 +139,7 @@ export declare const PInputWeek: import("react").ForwardRefExoticComponent<Omit<
     max?: string;
     /**
      * Dynamic feedback text for validation or status.
+     * @default ''
      */
     message?: string;
     /**
@@ -145,22 +164,27 @@ export declare const PInputWeek: import("react").ForwardRefExoticComponent<Omit<
     onInput?: (event: CustomEvent<InputWeekInputEventDetail>) => void;
     /**
      * A boolean value that, if present, makes the input field uneditable by the user, but its value will still be submitted with the form.
+     * @default false
      */
     readOnly?: boolean;
     /**
      * A boolean value that, if present, indicates that the input field must be filled out before the form can be submitted.
+     * @default false
      */
     required?: boolean;
     /**
      * Indicates the validation or overall status of the input component.
+     * @default 'none'
      */
     state?: InputWeekState;
     /**
      * Defines the stepping interval in weeks. For example, step="1" increments by 1 week. The default is 1 week.
+     * @default 1
      */
     step?: number;
     /**
      * The default week value for the input, in YYYY-Www format (e.g., value='2025-W27').
+     * @default ''
      */
     value?: string;
 } & {

package/ssr/esm/lib/components/link-pure.wrapper.d.ts

@@ -3,10 +3,12 @@ import type { BreakpointCustomizable, LinkPureAlignLabel, SelectedAriaAttributes
 export type PLinkPureProps = BaseProps & {
     /**
      * Displays the link in its active state.
+     * @default false
      */
     active?: boolean;
     /**
      * Aligns the label.
+     * @default 'end'
      */
     alignLabel?: BreakpointCustomizable<LinkPureAlignLabel>;
     /**
@@ -15,6 +17,7 @@ export type PLinkPureProps = BaseProps & {
     aria?: SelectedAriaAttributes<LinkPureAriaAttribute>;
     /**
      * The color.
+     * @default 'primary'
      */
     color?: LinkPureColor;
     /**
@@ -23,6 +26,7 @@ export type PLinkPureProps = BaseProps & {
     download?: string;
     /**
      * Shows or hides the label. For better accessibility, it is recommended to show the label.
+     * @default false
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -31,6 +35,7 @@ export type PLinkPureProps = BaseProps & {
     href?: string;
     /**
      * The icon shown. By choosing 'none', no icon is displayed
+     * @default 'arrow-right'
      */
     icon?: LinkPureIcon;
     /**
@@ -43,28 +48,34 @@ export type PLinkPureProps = BaseProps & {
     rel?: string;
     /**
      * Size of the link.
+     * @default 'sm'
      */
     size?: BreakpointCustomizable<LinkPureSize>;
     /**
      * Stretches the area between icon and label to max available space.
+     * @default false
      */
     stretch?: BreakpointCustomizable<boolean>;
     /**
      * Specifies where to open the linked document.
+     * @default '_self'
      */
     target?: LinkPureTarget;
     /**
      * Shows an underline under the label.
+     * @default false
      */
     underline?: boolean;
 };
 export declare const PLinkPure: 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 link in its active state.
+     * @default false
      */
     active?: boolean;
     /**
      * Aligns the label.
+     * @default 'end'
      */
     alignLabel?: BreakpointCustomizable<LinkPureAlignLabel>;
     /**
@@ -73,6 +84,7 @@ export declare const PLinkPure: import("react").ForwardRefExoticComponent<Omit<i
     aria?: SelectedAriaAttributes<LinkPureAriaAttribute>;
     /**
      * The color.
+     * @default 'primary'
      */
     color?: LinkPureColor;
     /**
@@ -81,6 +93,7 @@ export declare const PLinkPure: import("react").ForwardRefExoticComponent<Omit<i
     download?: string;
     /**
      * Shows or hides the label. For better accessibility, it is recommended to show the label.
+     * @default false
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -89,6 +102,7 @@ export declare const PLinkPure: import("react").ForwardRefExoticComponent<Omit<i
     href?: string;
     /**
      * The icon shown. By choosing 'none', no icon is displayed
+     * @default 'arrow-right'
      */
     icon?: LinkPureIcon;
     /**
@@ -101,18 +115,22 @@ export declare const PLinkPure: import("react").ForwardRefExoticComponent<Omit<i
     rel?: string;
     /**
      * Size of the link.
+     * @default 'sm'
      */
     size?: BreakpointCustomizable<LinkPureSize>;
     /**
      * Stretches the area between icon and label to max available space.
+     * @default false
      */
     stretch?: BreakpointCustomizable<boolean>;
     /**
      * Specifies where to open the linked document.
+     * @default '_self'
      */
     target?: LinkPureTarget;
     /**
      * Shows an underline under the label.
+     * @default false
      */
     underline?: boolean;
 } & {

package/ssr/esm/lib/components/link-tile-product.wrapper.d.ts

@@ -3,6 +3,7 @@ import type { BreakpointCustomizable, LinkTileProductAspectRatio, LinkTileProduc
 export type PLinkTileProductProps = BaseProps & {
     /**
      * Aspect ratio of the link-tile-product.
+     * @default '3/4'
      */
     aspectRatio?: BreakpointCustomizable<LinkTileProductAspectRatio>;
     /**
@@ -19,10 +20,12 @@ export type PLinkTileProductProps = BaseProps & {
     href?: string;
     /**
      * Shows a like button.
+     * @default true
      */
     likeButton?: boolean;
     /**
      * Indicates whether the product is liked.
+     * @default false
      */
     liked?: boolean;
     /**
@@ -43,12 +46,14 @@ export type PLinkTileProductProps = BaseProps & {
     rel?: string;
     /**
      * Specifies where to open the linked document.
+     * @default '_self'
      */
     target?: LinkTileProductTarget;
 };
 export declare const PLinkTileProduct: 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"> & {
     /**
      * Aspect ratio of the link-tile-product.
+     * @default '3/4'
      */
     aspectRatio?: BreakpointCustomizable<LinkTileProductAspectRatio>;
     /**
@@ -65,10 +70,12 @@ export declare const PLinkTileProduct: import("react").ForwardRefExoticComponent
     href?: string;
     /**
      * Shows a like button.
+     * @default true
      */
     likeButton?: boolean;
     /**
      * Indicates whether the product is liked.
+     * @default false
      */
     liked?: boolean;
     /**
@@ -89,6 +96,7 @@ export declare const PLinkTileProduct: import("react").ForwardRefExoticComponent
     rel?: string;
     /**
      * Specifies where to open the linked document.
+     * @default '_self'
      */
     target?: LinkTileProductTarget;
 } & {

package/ssr/esm/lib/components/link-tile.wrapper.d.ts

@@ -3,6 +3,7 @@ import type { LinkTileAlign, SelectedAriaAttributes, LinkTileAriaAttribute, Brea
 export type PLinkTileProps = BaseProps & {
     /**
      * Alignment of link and description.
+     * @default 'bottom'
      */
     align?: LinkTileAlign;
     /**
@@ -11,10 +12,12 @@ export type PLinkTileProps = BaseProps & {
     aria?: SelectedAriaAttributes<LinkTileAriaAttribute>;
     /**
      * Aspect ratio of the link-tile.
+     * @default '4/3'
      */
     aspectRatio?: BreakpointCustomizable<LinkTileAspectRatio>;
     /**
      * Displays the link-tile as compact version with description and link icon only.
+     * @default false
      */
     compact?: BreakpointCustomizable<boolean>;
     /**
@@ -27,6 +30,7 @@ export type PLinkTileProps = BaseProps & {
     download?: string;
     /**
      * Show gradient.
+     * @default false
      */
     gradient?: boolean;
     /**
@@ -43,20 +47,24 @@ export type PLinkTileProps = BaseProps & {
     rel?: string;
     /**
      * Font size of the description.
+     * @default 'medium'
      */
     size?: BreakpointCustomizable<LinkTileSize>;
     /**
      * Specifies where to open the linked document.
+     * @default '_self'
      */
     target?: LinkTileTarget;
     /**
      * Font weight of the description.
+     * @default 'semi-bold'
      */
     weight?: BreakpointCustomizable<LinkTileWeight>;
 };
 export declare const PLinkTile: 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"> & {
     /**
      * Alignment of link and description.
+     * @default 'bottom'
      */
     align?: LinkTileAlign;
     /**
@@ -65,10 +73,12 @@ export declare const PLinkTile: import("react").ForwardRefExoticComponent<Omit<i
     aria?: SelectedAriaAttributes<LinkTileAriaAttribute>;
     /**
      * Aspect ratio of the link-tile.
+     * @default '4/3'
      */
     aspectRatio?: BreakpointCustomizable<LinkTileAspectRatio>;
     /**
      * Displays the link-tile as compact version with description and link icon only.
+     * @default false
      */
     compact?: BreakpointCustomizable<boolean>;
     /**
@@ -81,6 +91,7 @@ export declare const PLinkTile: import("react").ForwardRefExoticComponent<Omit<i
     download?: string;
     /**
      * Show gradient.
+     * @default false
      */
     gradient?: boolean;
     /**
@@ -97,14 +108,17 @@ export declare const PLinkTile: import("react").ForwardRefExoticComponent<Omit<i
     rel?: string;
     /**
      * Font size of the description.
+     * @default 'medium'
      */
     size?: BreakpointCustomizable<LinkTileSize>;
     /**
      * Specifies where to open the linked document.
+     * @default '_self'
      */
     target?: LinkTileTarget;
     /**
      * Font weight of the description.
+     * @default 'semi-bold'
      */
     weight?: BreakpointCustomizable<LinkTileWeight>;
 } & {

package/ssr/esm/lib/components/link.wrapper.d.ts

@@ -7,6 +7,7 @@ export type PLinkProps = BaseProps & {
     aria?: SelectedAriaAttributes<LinkAriaAttribute>;
     /**
      * Displays the link in compact mode.
+     * @default false
      */
     compact?: BreakpointCustomizable<boolean>;
     /**
@@ -15,6 +16,7 @@ export type PLinkProps = BaseProps & {
     download?: string;
     /**
      * Shows or hides the label. For better accessibility, it is recommended to show the label.
+     * @default false
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -23,6 +25,7 @@ export type PLinkProps = BaseProps & {
     href?: string;
     /**
      * The icon shown. By choosing 'none', no icon is displayed.
+     * @default 'none'
      */
     icon?: LinkIcon;
     /**
@@ -35,10 +38,12 @@ export type PLinkProps = BaseProps & {
     rel?: string;
     /**
      * Specifies where to open the linked document.
+     * @default '_self'
      */
     target?: LinkTarget;
     /**
      * The style variant of the link.
+     * @default 'primary'
      */
     variant?: LinkVariant;
 };
@@ -49,6 +54,7 @@ export declare const PLink: import("react").ForwardRefExoticComponent<Omit<impor
     aria?: SelectedAriaAttributes<LinkAriaAttribute>;
     /**
      * Displays the link in compact mode.
+     * @default false
      */
     compact?: BreakpointCustomizable<boolean>;
     /**
@@ -57,6 +63,7 @@ export declare const PLink: import("react").ForwardRefExoticComponent<Omit<impor
     download?: string;
     /**
      * Shows or hides the label. For better accessibility, it is recommended to show the label.
+     * @default false
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -65,6 +72,7 @@ export declare const PLink: import("react").ForwardRefExoticComponent<Omit<impor
     href?: string;
     /**
      * The icon shown. By choosing 'none', no icon is displayed.
+     * @default 'none'
      */
     icon?: LinkIcon;
     /**
@@ -77,10 +85,12 @@ export declare const PLink: import("react").ForwardRefExoticComponent<Omit<impor
     rel?: string;
     /**
      * Specifies where to open the linked document.
+     * @default '_self'
      */
     target?: LinkTarget;
     /**
      * The style variant of the link.
+     * @default 'primary'
      */
     variant?: LinkVariant;
 } & {

package/ssr/esm/lib/components/modal.wrapper.d.ts

@@ -7,22 +7,27 @@ export type PModalProps = BaseProps & {
     aria?: SelectedAriaAttributes<ModalAriaAttribute>;
     /**
      * Defines the backdrop, 'blur' (should be used when Modal is opened by user interaction, e.g. after a click on a button) and 'shading' (should be used when Modal gets opened automatically, e.g. Cookie Consent).
+     * @default 'blur'
      */
     backdrop?: ModalBackdrop;
     /**
      * Defines the background color
+     * @default 'canvas'
      */
     background?: ModalBackground;
     /**
      * If true, the modal will not be closable via backdrop click.
+     * @default false
      */
     disableBackdropClick?: boolean;
     /**
      * If false, the modal will not have a dismiss button.
+     * @default true
      */
     dismissButton?: boolean;
     /**
      * If true the modal uses max viewport height and width. Should only be used for mobile.
+     * @default false
      */
     fullscreen?: BreakpointCustomizable<boolean>;
     /**
@@ -39,6 +44,7 @@ export type PModalProps = BaseProps & {
     onMotionVisibleEnd?: (event: CustomEvent<ModalMotionVisibleEndEventDetail>) => void;
     /**
      * If true, the modal is open.
+     * @default false
      */
     open: boolean;
 };
@@ -49,22 +55,27 @@ export declare const PModal: import("react").ForwardRefExoticComponent<Omit<impo
     aria?: SelectedAriaAttributes<ModalAriaAttribute>;
     /**
      * Defines the backdrop, 'blur' (should be used when Modal is opened by user interaction, e.g. after a click on a button) and 'shading' (should be used when Modal gets opened automatically, e.g. Cookie Consent).
+     * @default 'blur'
      */
     backdrop?: ModalBackdrop;
     /**
      * Defines the background color
+     * @default 'canvas'
      */
     background?: ModalBackground;
     /**
      * If true, the modal will not be closable via backdrop click.
+     * @default false
      */
     disableBackdropClick?: boolean;
     /**
      * If false, the modal will not have a dismiss button.
+     * @default true
      */
     dismissButton?: boolean;
     /**
      * If true the modal uses max viewport height and width. Should only be used for mobile.
+     * @default false
      */
     fullscreen?: BreakpointCustomizable<boolean>;
     /**
@@ -81,6 +92,7 @@ export declare const PModal: import("react").ForwardRefExoticComponent<Omit<impo
     onMotionVisibleEnd?: (event: CustomEvent<ModalMotionVisibleEndEventDetail>) => void;
     /**
      * If true, the modal is open.
+     * @default false
      */
     open: boolean;
 } & {