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

package/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/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/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/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/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;
 } & {

package/esm/lib/components/model-signature.wrapper.d.ts

@@ -3,52 +3,64 @@ import type { ModelSignatureColor, ModelSignatureFetchPriority, ModelSignatureMo
 export type PModelSignatureProps = BaseProps & {
     /**
      * Adapts the color of the component.
+     * @default 'primary'
      */
     color?: ModelSignatureColor;
     /**
      * Sets the browser's fetch priority hint for the model signature asset.
+     * @default 'auto'
      */
     fetchPriority?: ModelSignatureFetchPriority;
     /**
      * Defines whether the model signature is always loaded or only loaded when it is in the viewport (this feature may not work reliably).
+     * @default false
      */
     lazy?: boolean;
     /**
      * Adapts the model of the component.
+     * @default '911'
      */
     model?: ModelSignatureModel;
     /**
      * When set to `true`, then all model signatures are visually aligned with each other. When set to `false` the model signature comes without any safe zone.
+     * @default true
      */
     safeZone?: boolean;
     /**
      * Adapts the size of the component. When set to `inherit` a CSS `width` or `height` needs to be defined on the host but not both.
+     * @default 'small'
      */
     size?: ModelSignatureSize;
 };
 export declare const PModelSignature: 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"> & {
     /**
      * Adapts the color of the component.
+     * @default 'primary'
      */
     color?: ModelSignatureColor;
     /**
      * Sets the browser's fetch priority hint for the model signature asset.
+     * @default 'auto'
      */
     fetchPriority?: ModelSignatureFetchPriority;
     /**
      * Defines whether the model signature is always loaded or only loaded when it is in the viewport (this feature may not work reliably).
+     * @default false
      */
     lazy?: boolean;
     /**
      * Adapts the model of the component.
+     * @default '911'
      */
     model?: ModelSignatureModel;
     /**
      * When set to `true`, then all model signatures are visually aligned with each other. When set to `false` the model signature comes without any safe zone.
+     * @default true
      */
     safeZone?: boolean;
     /**
      * Adapts the size of the component. When set to `inherit` a CSS `width` or `height` needs to be defined on the host but not both.
+     * @default 'small'
      */
     size?: ModelSignatureSize;
 } & {

package/esm/lib/components/multi-select-option.wrapper.d.ts

@@ -2,6 +2,7 @@ import type { BaseProps } from '../../BaseProps';
 export type PMultiSelectOptionProps = BaseProps & {
     /**
      * Disables the option.
+     * @default false
      */
     disabled?: boolean;
     /**
@@ -12,6 +13,7 @@ export type PMultiSelectOptionProps = BaseProps & {
 export declare const PMultiSelectOption: 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 option.
+     * @default false
      */
     disabled?: boolean;
     /**

package/esm/lib/components/multi-select.wrapper.d.ts

@@ -3,18 +3,22 @@ import type { MultiSelectDropdownDirection, BreakpointCustomizable, MultiSelectC
 export type PMultiSelectProps = BaseProps & {
     /**
      * Displays the multi-select in compact mode.
+     * @default false
      */
     compact?: boolean;
     /**
      * Supplementary text providing more context or explanation for the multi-select.
+     * @default ''
      */
     description?: string;
     /**
      * Disables the multi-select
+     * @default false
      */
     disabled?: boolean;
     /**
      * Changes the direction to which the dropdown list appears.
+     * @default 'auto'
      */
     dropdownDirection?: MultiSelectDropdownDirection;
     /**
@@ -23,14 +27,17 @@ export type PMultiSelectProps = 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;
     /**
      * The message styled depending on validation state.
+     * @default ''
      */
     message?: string;
     /**
@@ -51,32 +58,39 @@ export type PMultiSelectProps = BaseProps & {
     onToggle?: (event: CustomEvent<MultiSelectToggleEventDetail>) => void;
     /**
      * Requires an option with a non-empty string value to be selected.
+     * @default false
      */
     required?: boolean;
     /**
      * The validation state.
+     * @default 'none'
      */
     state?: MultiSelectState;
     /**
      * The selected values.
+     * @default []
      */
     value?: string[];
 };
 export declare const PMultiSelect: 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 multi-select in compact mode.
+     * @default false
      */
     compact?: boolean;
     /**
      * Supplementary text providing more context or explanation for the multi-select.
+     * @default ''
      */
     description?: string;
     /**
      * Disables the multi-select
+     * @default false
      */
     disabled?: boolean;
     /**
      * Changes the direction to which the dropdown list appears.
+     * @default 'auto'
      */
     dropdownDirection?: MultiSelectDropdownDirection;
     /**
@@ -85,14 +99,17 @@ export declare const PMultiSelect: import("react").ForwardRefExoticComponent<Omi
     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;
     /**
      * The message styled depending on validation state.
+     * @default ''
      */
     message?: string;
     /**
@@ -113,14 +130,17 @@ export declare const PMultiSelect: import("react").ForwardRefExoticComponent<Omi
     onToggle?: (event: CustomEvent<MultiSelectToggleEventDetail>) => void;
     /**
      * Requires an option with a non-empty string value to be selected.
+     * @default false
      */
     required?: boolean;
     /**
      * The validation state.
+     * @default 'none'
      */
     state?: MultiSelectState;
     /**
      * The selected values.
+     * @default []
      */
     value?: string[];
 } & {

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

@@ -2,6 +2,7 @@ import type { BaseProps } from '../../BaseProps';
 export type POptgroupProps = BaseProps & {
     /**
      * Disables the optgroup.
+     * @default false
      */
     disabled?: boolean;
     /**
@@ -12,6 +13,7 @@ export type POptgroupProps = BaseProps & {
 export declare const POptgroup: 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 optgroup.
+     * @default false
      */
     disabled?: boolean;
     /**

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

@@ -3,14 +3,17 @@ import type { PaginationInternationalization, PaginationUpdateEventDetail } from
 export type PPaginationProps = BaseProps & {
     /**
      * Index of the currently active page.
+     * @default 1
      */
     activePage: number;
     /**
      * Override the default wordings that are used for aria-labels on the next/prev and page buttons.
+     * @default {   root: 'Pagination',   prev: 'Previous page',   next: 'Next page',   page: 'Page',   }
      */
     intl?: PaginationInternationalization;
     /**
      * The total count of items which should be shown per page.
+     * @default 1
      */
     itemsPerPage?: number;
     /**
@@ -19,24 +22,29 @@ export type PPaginationProps = BaseProps & {
     onUpdate?: (event: CustomEvent<PaginationUpdateEventDetail>) => void;
     /**
      * Show or hide the button to jump to the last page.
+     * @default true
      */
     showLastPage?: boolean;
     /**
      * The total count of items.
+     * @default 1
      */
     totalItemsCount: number;
 };
 export declare const PPagination: 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"> & {
     /**
      * Index of the currently active page.
+     * @default 1
      */
     activePage: number;
     /**
      * Override the default wordings that are used for aria-labels on the next/prev and page buttons.
+     * @default {   root: 'Pagination',   prev: 'Previous page',   next: 'Next page',   page: 'Page',   }
      */
     intl?: PaginationInternationalization;
     /**
      * The total count of items which should be shown per page.
+     * @default 1
      */
     itemsPerPage?: number;
     /**
@@ -45,10 +53,12 @@ export declare const PPagination: import("react").ForwardRefExoticComponent<Omit
     onUpdate?: (event: CustomEvent<PaginationUpdateEventDetail>) => void;
     /**
      * Show or hide the button to jump to the last page.
+     * @default true
      */
     showLastPage?: boolean;
     /**
      * The total count of items.
+     * @default 1
      */
     totalItemsCount: number;
 } & import("react").RefAttributes<HTMLElement>>;