@porsche-design-system/components-react 4.2.0-rc.4 → 4.2.0

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

@@ -2,67 +2,67 @@ import type { BaseProps } from '../../BaseProps';
 import type { MultiSelectDropdownDirection, BreakpointCustomizable, MultiSelectChangeEventDetail, MultiSelectToggleEventDetail, MultiSelectState } from '../types';
 export type PMultiSelectProps = BaseProps & {
     /**
-     * Displays the multi-select in compact mode.
+     * Reduces the control height and padding for a more compact layout.
      * @default false
      */
     compact?: boolean;
     /**
-     * Supplementary text providing more context or explanation for the multi-select.
+     * Sets a supplementary description displayed below the label to provide additional context.
      * @default ''
      */
     description?: string;
     /**
-     * Disables the multi-select
+     * Disables the multi-select, preventing all interaction. Selected values are not submitted with the form.
      * @default false
      */
     disabled?: boolean;
     /**
-     * Changes the direction to which the dropdown list appears.
+     * Controls whether the dropdown opens upward (`up`) or downward (`down`), or decides automatically (`auto`).
      * @default 'auto'
      */
     dropdownDirection?: MultiSelectDropdownDirection;
     /**
-     * The id of a form element the multi-select should be associated with.
+     * Associates the multi-select with a form element by its ID when not directly nested inside it.
      */
     form?: string;
     /**
-     * Shows or hides the label. For better accessibility, it is recommended to show the label.
+     * Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
      * @default false
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
-     * Text content for a user-facing label.
+     * Sets the visible label text displayed above the multi-select control.
      * @default ''
      */
     label?: string;
     /**
-     * The message styled depending on validation state.
+     * Sets the validation feedback message displayed below the control when `state` is `success` or `error`.
      * @default ''
      */
     message?: string;
     /**
-     * The name of the control.
+     * Sets the name submitted with the form data to identify the selected values on the server.
      */
     name: string;
     /**
-     * Emitted when the multi-select has lost focus.
+     * Emitted when the multi-select loses focus.
      */
     onBlur?: (event: CustomEvent<void>) => void;
     /**
-     * Emitted when the selection is changed.
+     * Emitted when the user selects or deselects an option, with the updated array of values in the event detail.
      */
     onChange?: (event: CustomEvent<MultiSelectChangeEventDetail>) => void;
     /**
-     * Emitted when the dropdown is toggled.
+     * Emitted when the dropdown opens or closes, with the new open state in the event detail.
      */
     onToggle?: (event: CustomEvent<MultiSelectToggleEventDetail>) => void;
     /**
-     * Requires an option with a non-empty string value to be selected.
+     * Marks the multi-select as required — form submission is blocked unless at least one option is selected.
      * @default false
      */
     required?: boolean;
     /**
-     * The validation state.
+     * Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
      * @default 'none'
      */
     state?: MultiSelectState;
@@ -74,67 +74,67 @@ export type PMultiSelectProps = BaseProps & {
 };
 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" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
     /**
-     * Displays the multi-select in compact mode.
+     * Reduces the control height and padding for a more compact layout.
      * @default false
      */
     compact?: boolean;
     /**
-     * Supplementary text providing more context or explanation for the multi-select.
+     * Sets a supplementary description displayed below the label to provide additional context.
      * @default ''
      */
     description?: string;
     /**
-     * Disables the multi-select
+     * Disables the multi-select, preventing all interaction. Selected values are not submitted with the form.
      * @default false
      */
     disabled?: boolean;
     /**
-     * Changes the direction to which the dropdown list appears.
+     * Controls whether the dropdown opens upward (`up`) or downward (`down`), or decides automatically (`auto`).
      * @default 'auto'
      */
     dropdownDirection?: MultiSelectDropdownDirection;
     /**
-     * The id of a form element the multi-select should be associated with.
+     * Associates the multi-select with a form element by its ID when not directly nested inside it.
      */
     form?: string;
     /**
-     * Shows or hides the label. For better accessibility, it is recommended to show the label.
+     * Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
      * @default false
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
-     * Text content for a user-facing label.
+     * Sets the visible label text displayed above the multi-select control.
      * @default ''
      */
     label?: string;
     /**
-     * The message styled depending on validation state.
+     * Sets the validation feedback message displayed below the control when `state` is `success` or `error`.
      * @default ''
      */
     message?: string;
     /**
-     * The name of the control.
+     * Sets the name submitted with the form data to identify the selected values on the server.
      */
     name: string;
     /**
-     * Emitted when the multi-select has lost focus.
+     * Emitted when the multi-select loses focus.
      */
     onBlur?: (event: CustomEvent<void>) => void;
     /**
-     * Emitted when the selection is changed.
+     * Emitted when the user selects or deselects an option, with the updated array of values in the event detail.
      */
     onChange?: (event: CustomEvent<MultiSelectChangeEventDetail>) => void;
     /**
-     * Emitted when the dropdown is toggled.
+     * Emitted when the dropdown opens or closes, with the new open state in the event detail.
      */
     onToggle?: (event: CustomEvent<MultiSelectToggleEventDetail>) => void;
     /**
-     * Requires an option with a non-empty string value to be selected.
+     * Marks the multi-select as required — form submission is blocked unless at least one option is selected.
      * @default false
      */
     required?: boolean;
     /**
-     * The validation state.
+     * Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
      * @default 'none'
      */
     state?: MultiSelectState;

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

@@ -1,23 +1,23 @@
 import type { BaseProps } from '../../BaseProps';
 export type POptgroupProps = BaseProps & {
     /**
-     * Disables the optgroup.
+     * Disables all options in the group, preventing any of them from being selected.
      * @default false
      */
     disabled?: boolean;
     /**
-     * The optgroup label.
+     * Sets the visible group heading displayed above the grouped options.
      */
     label?: string;
 };
 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" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
     /**
-     * Disables the optgroup.
+     * Disables all options in the group, preventing any of them from being selected.
      * @default false
      */
     disabled?: boolean;
     /**
-     * The optgroup label.
+     * Sets the visible group heading displayed above the grouped options.
      */
     label?: string;
 } & {

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

@@ -2,62 +2,62 @@ import type { BaseProps } from '../../BaseProps';
 import type { PaginationInternationalization, PaginationUpdateEventDetail } from '../types';
 export type PPaginationProps = BaseProps & {
     /**
-     * Index of the currently active page.
+     * Sets the one-based index of the currently active page; update this prop to navigate programmatically.
      * @default 1
      */
     activePage: number;
     /**
-     * Override the default wordings that are used for aria-labels on the next/prev and page buttons.
+     * Overrides the default ARIA label strings used for the previous, next, and page number buttons to support localisation.
      * @default {   root: 'Pagination',   prev: 'Previous page',   next: 'Next page',   page: 'Page',   }
      */
     intl?: PaginationInternationalization;
     /**
-     * The total count of items which should be shown per page.
+     * Sets the number of items displayed per page, used together with `totalItemsCount` to compute the page count.
      * @default 1
      */
     itemsPerPage?: number;
     /**
-     * Emitted when the page changes.
+     * Emitted when the user navigates to a different page, carrying the new `activePage` index in the event detail.
      */
     onUpdate?: (event: CustomEvent<PaginationUpdateEventDetail>) => void;
     /**
-     * Show or hide the button to jump to the last page.
+     * Shows or hides the button that jumps directly to the last page of the pagination.
      * @default true
      */
     showLastPage?: boolean;
     /**
-     * The total count of items.
+     * Sets the total number of items in the dataset, used to calculate the number of pages.
      * @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" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
     /**
-     * Index of the currently active page.
+     * Sets the one-based index of the currently active page; update this prop to navigate programmatically.
      * @default 1
      */
     activePage: number;
     /**
-     * Override the default wordings that are used for aria-labels on the next/prev and page buttons.
+     * Overrides the default ARIA label strings used for the previous, next, and page number buttons to support localisation.
      * @default {   root: 'Pagination',   prev: 'Previous page',   next: 'Next page',   page: 'Page',   }
      */
     intl?: PaginationInternationalization;
     /**
-     * The total count of items which should be shown per page.
+     * Sets the number of items displayed per page, used together with `totalItemsCount` to compute the page count.
      * @default 1
      */
     itemsPerPage?: number;
     /**
-     * Emitted when the page changes.
+     * Emitted when the user navigates to a different page, carrying the new `activePage` index in the event detail.
      */
     onUpdate?: (event: CustomEvent<PaginationUpdateEventDetail>) => void;
     /**
-     * Show or hide the button to jump to the last page.
+     * Shows or hides the button that jumps directly to the last page of the pagination.
      * @default true
      */
     showLastPage?: boolean;
     /**
-     * The total count of items.
+     * Sets the total number of items in the dataset, used to calculate the number of pages.
      * @default 1
      */
     totalItemsCount: number;

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

@@ -2,156 +2,156 @@ import type { BaseProps } from '../../BaseProps';
 import type { BreakpointCustomizable, PinCodeLength, PinCodeChangeEventDetail, PinCodeState, PinCodeType } from '../types';
 export type PPinCodeProps = BaseProps & {
     /**
-     * Displays the pin code in compact mode.
+     * Reduces the pin code field height and spacing for use in dense layouts where vertical space is limited.
      * @default false
      */
     compact?: boolean;
     /**
-     * Supplementary text providing more context or explanation for the pin code.
+     * Sets a supplementary description displayed below the label to give users additional guidance about the pin code.
      * @default ''
      */
     description?: string;
     /**
-     * Disables the Pin Code. No events will be triggered while disabled state is active.
+     * Prevents user interaction with all pin code fields and blocks events while the component is disabled.
      * @default false
      */
     disabled?: boolean;
     /**
-     * The id of a form element the pin-code should be associated with.
+     * Associates the pin code with a form element by its ID when it is not a direct descendant of that form.
      */
     form?: string;
     /**
-     * Shows or hides the label and description. For better accessibility, it is recommended to show the label.
+     * Hides the visible label and description while keeping them accessible to screen readers. Supports responsive breakpoint values.
      * @default false
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
-     * Text content for a user-facing label.
+     * Sets the visible label text displayed above the pin code fields to identify their purpose.
      * @default ''
      */
     label?: string;
     /**
-     * Number of characters of the Pin Code.
+     * Sets the number of individual input fields rendered, determining how many characters the pin code consists of.
      * @default 4
      */
     length?: PinCodeLength;
     /**
-     * Disables the Pin Code and shows a loading indicator. No events will be triggered while loading state is active.
+     * Disables the pin code fields and shows a loading spinner to indicate an ongoing background operation.
      * @default false
      */
     loading?: boolean;
     /**
-     * The message styled depending on validation state.
+     * Sets the validation feedback message displayed below the pin code when `state` is `success` or `error`.
      * @default ''
      */
     message?: string;
     /**
-     * Name of the control.
+     * Sets the name of the control submitted with the form data to identify the pin code value on the server.
      */
     name?: string;
     /**
-     * Emitted when the pin-code has lost focus.
+     * Emitted when the pin code component loses focus after the user finishes entering characters.
      */
     onBlur?: (event: CustomEvent<void>) => void;
     /**
-     * Emitted when the input is changed.
+     * Emitted when the pin code value changes as the user types, carrying the new concatenated value in the event detail.
      */
     onChange?: (event: CustomEvent<PinCodeChangeEventDetail>) => void;
     /**
-     * Marks the Pin Code as required.
+     * Marks the pin code as required so the form cannot be submitted until all fields are filled.
      * @default false
      */
     required?: boolean;
     /**
-     * The validation state.
+     * Sets the validation state of the pin code, which controls its visual appearance and feedback message style (`none`, `success`, `error`).
      * @default 'none'
      */
     state?: PinCodeState;
     /**
-     * Pin Code type.
+     * Controls whether the individual input fields mask their content as password dots (`password`) or show digits (`number`).
      * @default 'number'
      */
     type?: PinCodeType;
     /**
-     * Sets the initial value of the Pin Code.
+     * Sets the current concatenated value of all pin code fields and allows setting the initial value.
      * @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" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
     /**
-     * Displays the pin code in compact mode.
+     * Reduces the pin code field height and spacing for use in dense layouts where vertical space is limited.
      * @default false
      */
     compact?: boolean;
     /**
-     * Supplementary text providing more context or explanation for the pin code.
+     * Sets a supplementary description displayed below the label to give users additional guidance about the pin code.
      * @default ''
      */
     description?: string;
     /**
-     * Disables the Pin Code. No events will be triggered while disabled state is active.
+     * Prevents user interaction with all pin code fields and blocks events while the component is disabled.
      * @default false
      */
     disabled?: boolean;
     /**
-     * The id of a form element the pin-code should be associated with.
+     * Associates the pin code with a form element by its ID when it is not a direct descendant of that form.
      */
     form?: string;
     /**
-     * Shows or hides the label and description. For better accessibility, it is recommended to show the label.
+     * Hides the visible label and description while keeping them accessible to screen readers. Supports responsive breakpoint values.
      * @default false
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
-     * Text content for a user-facing label.
+     * Sets the visible label text displayed above the pin code fields to identify their purpose.
      * @default ''
      */
     label?: string;
     /**
-     * Number of characters of the Pin Code.
+     * Sets the number of individual input fields rendered, determining how many characters the pin code consists of.
      * @default 4
      */
     length?: PinCodeLength;
     /**
-     * Disables the Pin Code and shows a loading indicator. No events will be triggered while loading state is active.
+     * Disables the pin code fields and shows a loading spinner to indicate an ongoing background operation.
      * @default false
      */
     loading?: boolean;
     /**
-     * The message styled depending on validation state.
+     * Sets the validation feedback message displayed below the pin code when `state` is `success` or `error`.
      * @default ''
      */
     message?: string;
     /**
-     * Name of the control.
+     * Sets the name of the control submitted with the form data to identify the pin code value on the server.
      */
     name?: string;
     /**
-     * Emitted when the pin-code has lost focus.
+     * Emitted when the pin code component loses focus after the user finishes entering characters.
      */
     onBlur?: (event: CustomEvent<void>) => void;
     /**
-     * Emitted when the input is changed.
+     * Emitted when the pin code value changes as the user types, carrying the new concatenated value in the event detail.
      */
     onChange?: (event: CustomEvent<PinCodeChangeEventDetail>) => void;
     /**
-     * Marks the Pin Code as required.
+     * Marks the pin code as required so the form cannot be submitted until all fields are filled.
      * @default false
      */
     required?: boolean;
     /**
-     * The validation state.
+     * Sets the validation state of the pin code, which controls its visual appearance and feedback message style (`none`, `success`, `error`).
      * @default 'none'
      */
     state?: PinCodeState;
     /**
-     * Pin Code type.
+     * Controls whether the individual input fields mask their content as password dots (`password`) or show digits (`number`).
      * @default 'number'
      */
     type?: PinCodeType;
     /**
-     * Sets the initial value of the Pin Code.
+     * Sets the current concatenated value of all pin code fields and allows setting the initial value.
      * @default ''
      */
     value?: string;

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

@@ -2,30 +2,30 @@ import type { BaseProps } from '../../BaseProps';
 import type { SelectedAriaAttributes, PopoverAriaAttribute, PopoverDirection } from '../types';
 export type PPopoverProps = BaseProps & {
     /**
-     * Sets ARIA attributes.
+     * Sets ARIA attributes on the popover panel to improve accessibility for screen readers.
      */
     aria?: SelectedAriaAttributes<PopoverAriaAttribute>;
     /**
-     * Descriptive text shown when the popover is open.
+     * Sets the text content displayed inside the popover panel when it is open, providing contextual help or information.
      */
     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.
+     * Sets the preferred direction for the popover to open relative to its trigger button. Falls back to the direction with the most available viewport space.
      * @default 'bottom'
      */
     direction?: PopoverDirection;
 };
 export declare const PPopover: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
     /**
-     * Sets ARIA attributes.
+     * Sets ARIA attributes on the popover panel to improve accessibility for screen readers.
      */
     aria?: SelectedAriaAttributes<PopoverAriaAttribute>;
     /**
-     * Descriptive text shown when the popover is open.
+     * Sets the text content displayed inside the popover panel when it is open, providing contextual help or information.
      */
     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.
+     * Sets the preferred direction for the popover to open relative to its trigger button. Falls back to the direction with the most available viewport space.
      * @default 'bottom'
      */
     direction?: PopoverDirection;

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

@@ -1,41 +1,41 @@
 import type { BaseProps } from '../../BaseProps';
 export type PRadioGroupOptionProps = BaseProps & {
     /**
-     * Disables the radio group option. The value will not be submitted with the form.
+     * Prevents this option from being selected and excludes its value from form submissions while it is disabled.
      * @default false
      */
     disabled?: boolean;
     /**
-     * Text content for a user-facing label.
+     * Sets the visible label text displayed next to the radio button that the user reads to identify the option.
      */
     label?: string;
     /**
-     * @experimental Shows a loading indicator.
+     * @experimental Disables this option and shows a spinner to indicate that this particular option is in a loading state.
      * @default false
      */
     loading?: boolean;
     /**
-     * The value for the input.
+     * Sets the value submitted with the form data when this radio option is selected within its parent group.
      */
     value?: string;
 };
 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" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
     /**
-     * Disables the radio group option. The value will not be submitted with the form.
+     * Prevents this option from being selected and excludes its value from form submissions while it is disabled.
      * @default false
      */
     disabled?: boolean;
     /**
-     * Text content for a user-facing label.
+     * Sets the visible label text displayed next to the radio button that the user reads to identify the option.
      */
     label?: string;
     /**
-     * @experimental Shows a loading indicator.
+     * @experimental Disables this option and shows a spinner to indicate that this particular option is in a loading state.
      * @default false
      */
     loading?: boolean;
     /**
-     * The value for the input.
+     * Sets the value submitted with the form data when this radio option is selected within its parent group.
      */
     value?: string;
 } & {