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

package/ssr/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/ssr/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/ssr/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/ssr/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/ssr/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>>;

package/ssr/esm/lib/components/pin-code.wrapper.d.ts

@@ -3,14 +3,17 @@ import type { BreakpointCustomizable, PinCodeLength, PinCodeChangeEventDetail, P
 export type PPinCodeProps = BaseProps & {
     /**
      * Displays the pin code in compact mode.
+     * @default false
      */
     compact?: boolean;
     /**
      * Supplementary text providing more context or explanation for the pin code.
+     * @default ''
      */
     description?: string;
     /**
      * Disables the Pin Code. No events will be triggered while disabled state is active.
+     * @default false
      */
     disabled?: boolean;
     /**
@@ -19,22 +22,27 @@ export type PPinCodeProps = BaseProps & {
     form?: string;
     /**
      * Shows or hides the label and description. 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;
     /**
      * Number of characters of the Pin Code.
+     * @default 4
      */
     length?: PinCodeLength;
     /**
      * Disables the Pin Code and shows a loading indicator. No events will be triggered while loading state is active.
+     * @default false
      */
     loading?: boolean;
     /**
      * The message styled depending on validation state.
+     * @default ''
      */
     message?: string;
     /**
@@ -51,32 +59,39 @@ export type PPinCodeProps = BaseProps & {
     onChange?: (event: CustomEvent<PinCodeChangeEventDetail>) => void;
     /**
      * Marks the Pin Code as required.
+     * @default false
      */
     required?: boolean;
     /**
      * The validation state.
+     * @default 'none'
      */
     state?: PinCodeState;
     /**
      * Pin Code type.
+     * @default 'number'
      */
     type?: PinCodeType;
     /**
      * Sets the initial value of the Pin Code.
+     * @default ''
      */
     value?: string;
 };
 export declare const PPinCode: 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 pin code in compact mode.
+     * @default false
      */
     compact?: boolean;
     /**
      * Supplementary text providing more context or explanation for the pin code.
+     * @default ''
      */
     description?: string;
     /**
      * Disables the Pin Code. No events will be triggered while disabled state is active.
+     * @default false
      */
     disabled?: boolean;
     /**
@@ -85,22 +100,27 @@ export declare const PPinCode: import("react").ForwardRefExoticComponent<Omit<im
     form?: string;
     /**
      * Shows or hides the label and description. 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;
     /**
      * Number of characters of the Pin Code.
+     * @default 4
      */
     length?: PinCodeLength;
     /**
      * Disables the Pin Code and shows a loading indicator. No events will be triggered while loading state is active.
+     * @default false
      */
     loading?: boolean;
     /**
      * The message styled depending on validation state.
+     * @default ''
      */
     message?: string;
     /**
@@ -117,18 +137,22 @@ export declare const PPinCode: import("react").ForwardRefExoticComponent<Omit<im
     onChange?: (event: CustomEvent<PinCodeChangeEventDetail>) => void;
     /**
      * Marks the Pin Code as required.
+     * @default false
      */
     required?: boolean;
     /**
      * The validation state.
+     * @default 'none'
      */
     state?: PinCodeState;
     /**
      * Pin Code type.
+     * @default 'number'
      */
     type?: PinCodeType;
     /**
      * Sets the initial value of the Pin Code.
+     * @default ''
      */
     value?: string;
 } & {

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

@@ -11,6 +11,7 @@ export type PPopoverProps = BaseProps & {
     description?: string;
     /**
      * Preferred direction in which the popover should open when there is enough space in the viewport. Otherwise, it opens in the direction with the most available space.
+     * @default 'bottom'
      */
     direction?: PopoverDirection;
 };
@@ -25,6 +26,7 @@ export declare const PPopover: import("react").ForwardRefExoticComponent<Omit<im
     description?: string;
     /**
      * Preferred direction in which the popover should open when there is enough space in the viewport. Otherwise, it opens in the direction with the most available space.
+     * @default 'bottom'
      */
     direction?: PopoverDirection;
 } & {

package/ssr/esm/lib/components/radio-group-option.wrapper.d.ts

@@ -2,6 +2,7 @@ import type { BaseProps } from '../../BaseProps';
 export type PRadioGroupOptionProps = BaseProps & {
     /**
      * Disables the radio group option. The value will not be submitted with the form.
+     * @default false
      */
     disabled?: boolean;
     /**
@@ -10,6 +11,7 @@ export type PRadioGroupOptionProps = BaseProps & {
     label?: string;
     /**
      * @experimental Shows a loading indicator.
+     * @default false
      */
     loading?: boolean;
     /**
@@ -20,6 +22,7 @@ export type PRadioGroupOptionProps = BaseProps & {
 export declare const PRadioGroupOption: 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 radio group option. The value will not be submitted with the form.
+     * @default false
      */
     disabled?: boolean;
     /**
@@ -28,6 +31,7 @@ export declare const PRadioGroupOption: import("react").ForwardRefExoticComponen
     label?: string;
     /**
      * @experimental Shows a loading indicator.
+     * @default false
      */
     loading?: boolean;
     /**

package/ssr/esm/lib/components/radio-group.wrapper.d.ts

@@ -3,18 +3,22 @@ import type { BreakpointCustomizable, RadioGroupDirection, RadioGroupChangeEvent
 export type PRadioGroupProps = BaseProps & {
     /**
      * Displays the radio group in compact mode.
+     * @default false
      */
     compact?: boolean;
     /**
      * Supplementary text providing more context or explanation for the radio group.
+     * @default ''
      */
     description?: string;
     /**
      * Defines the direction of the main and cross-axis. The default is `column`, which stacks the options vertically. You always need to provide a base value when using breakpoints.
+     * @default 'column'
      */
     direction?: BreakpointCustomizable<RadioGroupDirection>;
     /**
      * Disables the radio group. The value will not be submitted with the form.
+     * @default false
      */
     disabled?: boolean;
     /**
@@ -23,18 +27,22 @@ export type PRadioGroupProps = 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;
     /**
      * Dynamic feedback text for validation or status.
+     * @default ''
      */
     message?: string;
     /**
@@ -51,32 +59,39 @@ export type PRadioGroupProps = BaseProps & {
     onChange?: (event: CustomEvent<RadioGroupChangeEventDetail>) => void;
     /**
      * A boolean value that specifies a selection must be made from the group before the form can be submitted.
+     * @default false
      */
     required?: boolean;
     /**
      * Indicates the validation or overall status of the radio group component.
+     * @default 'none'
      */
     state?: RadioGroupState;
     /**
      * The default value for the radio-group.
+     * @default ''
      */
     value?: string;
 };
 export declare const PRadioGroup: 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 radio group in compact mode.
+     * @default false
      */
     compact?: boolean;
     /**
      * Supplementary text providing more context or explanation for the radio group.
+     * @default ''
      */
     description?: string;
     /**
      * Defines the direction of the main and cross-axis. The default is `column`, which stacks the options vertically. You always need to provide a base value when using breakpoints.
+     * @default 'column'
      */
     direction?: BreakpointCustomizable<RadioGroupDirection>;
     /**
      * Disables the radio group. The value will not be submitted with the form.
+     * @default false
      */
     disabled?: boolean;
     /**
@@ -85,18 +100,22 @@ export declare const PRadioGroup: 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;
     /**
      * Dynamic feedback text for validation or status.
+     * @default ''
      */
     message?: string;
     /**
@@ -113,14 +132,17 @@ export declare const PRadioGroup: import("react").ForwardRefExoticComponent<Omit
     onChange?: (event: CustomEvent<RadioGroupChangeEventDetail>) => void;
     /**
      * A boolean value that specifies a selection must be made from the group before the form can be submitted.
+     * @default false
      */
     required?: boolean;
     /**
      * Indicates the validation or overall status of the radio group component.
+     * @default 'none'
      */
     state?: RadioGroupState;
     /**
      * The default value for the radio-group.
+     * @default ''
      */
     value?: string;
 } & {

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

@@ -3,6 +3,7 @@ import type { ScrollerAlignScrollIndicator, SelectedAriaAttributes, ScrollerAria
 export type PScrollerProps = BaseProps & {
     /**
      * @deprecated since v4.0.0, will be removed with next major release, has no effect anymore.
+     * @default 'center'
      */
     alignScrollIndicator?: ScrollerAlignScrollIndicator;
     /**
@@ -19,16 +20,19 @@ export type PScrollerProps = BaseProps & {
     scrollToPosition?: ScrollerScrollToPosition;
     /**
      * Specifies if scrollbar should be shown.
+     * @default false
      */
     scrollbar?: boolean;
     /**
      * @experimental Makes the indicator sticky at the top or bottom while scrolling depending on the scroll direction.
+     * @default false
      */
     sticky?: boolean;
 };
 export declare const PScroller: 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"> & {
     /**
      * @deprecated since v4.0.0, will be removed with next major release, has no effect anymore.
+     * @default 'center'
      */
     alignScrollIndicator?: ScrollerAlignScrollIndicator;
     /**
@@ -45,10 +49,12 @@ export declare const PScroller: import("react").ForwardRefExoticComponent<Omit<i
     scrollToPosition?: ScrollerScrollToPosition;
     /**
      * Specifies if scrollbar should be shown.
+     * @default false
      */
     scrollbar?: boolean;
     /**
      * @experimental Makes the indicator sticky at the top or bottom while scrolling depending on the scroll direction.
+     * @default false
      */
     sticky?: boolean;
 } & {

package/ssr/esm/lib/components/segmented-control-item.wrapper.d.ts

@@ -7,6 +7,7 @@ export type PSegmentedControlItemProps = BaseProps & {
     aria?: SelectedAriaAttributes<SegmentedControlItemAriaAttribute>;
     /**
      * Disables the button. No events will be triggered while disabled state is active.
+     * @default false
      */
     disabled?: boolean;
     /**
@@ -33,6 +34,7 @@ export declare const PSegmentedControlItem: import("react").ForwardRefExoticComp
     aria?: SelectedAriaAttributes<SegmentedControlItemAriaAttribute>;
     /**
      * Disables the button. No events will be triggered while disabled state is active.
+     * @default false
      */
     disabled?: boolean;
     /**