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

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

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

@@ -2,146 +2,146 @@ import type { BaseProps } from '../../BaseProps';
 import type { BreakpointCustomizable, RadioGroupDirection, RadioGroupChangeEventDetail, RadioGroupState } from '../types';
 export type PRadioGroupProps = BaseProps & {
     /**
-     * Displays the radio group in compact mode.
+     * Reduces the spacing between radio options for use in dense layouts where vertical space is limited.
      * @default false
      */
     compact?: boolean;
     /**
-     * Supplementary text providing more context or explanation for the radio group.
+     * Sets a supplementary description displayed below the label to give users additional guidance about 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.
+     * Sets the layout direction of the radio options. Use `column` to stack them vertically or `row` to arrange them horizontally. Supports responsive breakpoint values.
      * @default 'column'
      */
     direction?: BreakpointCustomizable<RadioGroupDirection>;
     /**
-     * Disables the radio group. The value will not be submitted with the form.
+     * Disables all radio options in the group, preventing selection and excluding the value from form submissions.
      * @default false
      */
     disabled?: boolean;
     /**
-     * Specifies the id of the <form> element that the radio group belongs to (useful if the radio group is not a direct descendant of the form).
+     * Associates the radio group with a form element by its ID when the group is not a direct descendant of that form.
      */
     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 radio group to identify the group's purpose.
      * @default ''
      */
     label?: string;
     /**
-     * @experimental Shows a loading indicator.
+     * @experimental Disables all radio options and shows a spinner to indicate a background loading operation.
      * @default false
      */
     loading?: boolean;
     /**
-     * Dynamic feedback text for validation or status.
+     * Sets the validation feedback message displayed below the radio group when `state` is `success` or `error`.
      * @default ''
      */
     message?: string;
     /**
-     * The name of the group of radio buttons, used when submitting the form data.
+     * Sets the shared name attribute for all radio buttons in the group, grouping them for mutually exclusive selection.
      */
     name: string;
     /**
-     * Emitted when the radio-group has lost focus.
+     * Emitted when the radio group loses focus after the user interacts with it, useful for triggering validation on blur.
      */
     onBlur?: (event: CustomEvent<void>) => void;
     /**
-     * Emitted when the selected option is changed.
+     * Emitted when the user selects a different option, carrying the new value and the native event in the event detail.
      */
     onChange?: (event: CustomEvent<RadioGroupChangeEventDetail>) => void;
     /**
-     * A boolean value that specifies a selection must be made from the group before the form can be submitted.
+     * Marks the radio group as required so the form cannot be submitted until one option is selected.
      * @default false
      */
     required?: boolean;
     /**
-     * Indicates the validation or overall status of the radio group component.
+     * Sets the validation state of the radio group, controlling its visual appearance and feedback message style (`none`, `success`, `error`).
      * @default 'none'
      */
     state?: RadioGroupState;
     /**
-     * The default value for the radio-group.
+     * Sets the currently selected value that pre-selects the matching radio option and reflects user changes.
      * @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" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
     /**
-     * Displays the radio group in compact mode.
+     * Reduces the spacing between radio options for use in dense layouts where vertical space is limited.
      * @default false
      */
     compact?: boolean;
     /**
-     * Supplementary text providing more context or explanation for the radio group.
+     * Sets a supplementary description displayed below the label to give users additional guidance about 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.
+     * Sets the layout direction of the radio options. Use `column` to stack them vertically or `row` to arrange them horizontally. Supports responsive breakpoint values.
      * @default 'column'
      */
     direction?: BreakpointCustomizable<RadioGroupDirection>;
     /**
-     * Disables the radio group. The value will not be submitted with the form.
+     * Disables all radio options in the group, preventing selection and excluding the value from form submissions.
      * @default false
      */
     disabled?: boolean;
     /**
-     * Specifies the id of the <form> element that the radio group belongs to (useful if the radio group is not a direct descendant of the form).
+     * Associates the radio group with a form element by its ID when the group is not a direct descendant of that form.
      */
     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 radio group to identify the group's purpose.
      * @default ''
      */
     label?: string;
     /**
-     * @experimental Shows a loading indicator.
+     * @experimental Disables all radio options and shows a spinner to indicate a background loading operation.
      * @default false
      */
     loading?: boolean;
     /**
-     * Dynamic feedback text for validation or status.
+     * Sets the validation feedback message displayed below the radio group when `state` is `success` or `error`.
      * @default ''
      */
     message?: string;
     /**
-     * The name of the group of radio buttons, used when submitting the form data.
+     * Sets the shared name attribute for all radio buttons in the group, grouping them for mutually exclusive selection.
      */
     name: string;
     /**
-     * Emitted when the radio-group has lost focus.
+     * Emitted when the radio group loses focus after the user interacts with it, useful for triggering validation on blur.
      */
     onBlur?: (event: CustomEvent<void>) => void;
     /**
-     * Emitted when the selected option is changed.
+     * Emitted when the user selects a different option, carrying the new value and the native event in the event detail.
      */
     onChange?: (event: CustomEvent<RadioGroupChangeEventDetail>) => void;
     /**
-     * A boolean value that specifies a selection must be made from the group before the form can be submitted.
+     * Marks the radio group as required so the form cannot be submitted until one option is selected.
      * @default false
      */
     required?: boolean;
     /**
-     * Indicates the validation or overall status of the radio group component.
+     * Sets the validation state of the radio group, controlling its visual appearance and feedback message style (`none`, `success`, `error`).
      * @default 'none'
      */
     state?: RadioGroupState;
     /**
-     * The default value for the radio-group.
+     * Sets the currently selected value that pre-selects the matching radio option and reflects user changes.
      * @default ''
      */
     value?: string;

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

@@ -7,11 +7,11 @@ export type PScrollerProps = BaseProps & {
      */
     alignScrollIndicator?: ScrollerAlignScrollIndicator;
     /**
-     * Add ARIA role.
+     * Sets the ARIA `role` attribute on the scroller's scroll container, useful for list-based navigation patterns.
      */
     aria?: SelectedAriaAttributes<ScrollerAriaAttribute>;
     /**
-     * Displays with reduced spacing and smaller padding for a more condensed layout.
+     * Reduces the scroller's padding and the gap between slotted items for use in dense layouts.
      */
     compact?: boolean;
     /**
@@ -19,7 +19,7 @@ export type PScrollerProps = BaseProps & {
      */
     scrollToPosition?: ScrollerScrollToPosition;
     /**
-     * Specifies if scrollbar should be shown.
+     * Shows the browser's native scrollbar inside the scroller, in addition to the scroll indicator arrows.
      * @default false
      */
     scrollbar?: boolean;
@@ -36,11 +36,11 @@ export declare const PScroller: import("react").ForwardRefExoticComponent<Omit<i
      */
     alignScrollIndicator?: ScrollerAlignScrollIndicator;
     /**
-     * Add ARIA role.
+     * Sets the ARIA `role` attribute on the scroller's scroll container, useful for list-based navigation patterns.
      */
     aria?: SelectedAriaAttributes<ScrollerAriaAttribute>;
     /**
-     * Displays with reduced spacing and smaller padding for a more condensed layout.
+     * Reduces the scroller's padding and the gap between slotted items for use in dense layouts.
      */
     compact?: boolean;
     /**
@@ -48,7 +48,7 @@ export declare const PScroller: import("react").ForwardRefExoticComponent<Omit<i
      */
     scrollToPosition?: ScrollerScrollToPosition;
     /**
-     * Specifies if scrollbar should be shown.
+     * Shows the browser's native scrollbar inside the scroller, in addition to the scroll indicator arrows.
      * @default false
      */
     scrollbar?: boolean;

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

@@ -2,55 +2,55 @@ import type { BaseProps } from '../../BaseProps';
 import type { SelectedAriaAttributes, SegmentedControlItemAriaAttribute, SegmentedControlItemIcon } from '../types';
 export type PSegmentedControlItemProps = BaseProps & {
     /**
-     * Sets ARIA attributes.
+     * Sets ARIA attributes on the item's button element to improve accessibility for screen readers.
      */
     aria?: SelectedAriaAttributes<SegmentedControlItemAriaAttribute>;
     /**
-     * Disables the button. No events will be triggered while disabled state is active.
+     * Prevents this item from being selected and visually dims it; the parent's value will not change to this item's value.
      * @default false
      */
     disabled?: boolean;
     /**
-     * The icon shown.
+     * Sets an icon rendered inside the item button using an icon name from the PDS icon library.
      */
     icon?: SegmentedControlItemIcon;
     /**
-     * A URL path to a custom icon.
+     * Sets a URL to a custom SVG icon for the item button, overriding the built-in icon set.
      */
     iconSource?: string;
     /**
-     * Text content for a user-facing label.
+     * Sets a visible text label rendered inside the item button, used when no slotted content is provided.
      */
     label?: string;
     /**
-     * The value of this item which is emitted by the parent element if it becomes selected. This property is **required**.
+     * Sets the value emitted by the parent `p-segmented-control` when this item is selected. This property is **required**.
      */
     value: string | number;
 };
 export declare const PSegmentedControlItem: 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 item's button element to improve accessibility for screen readers.
      */
     aria?: SelectedAriaAttributes<SegmentedControlItemAriaAttribute>;
     /**
-     * Disables the button. No events will be triggered while disabled state is active.
+     * Prevents this item from being selected and visually dims it; the parent's value will not change to this item's value.
      * @default false
      */
     disabled?: boolean;
     /**
-     * The icon shown.
+     * Sets an icon rendered inside the item button using an icon name from the PDS icon library.
      */
     icon?: SegmentedControlItemIcon;
     /**
-     * A URL path to a custom icon.
+     * Sets a URL to a custom SVG icon for the item button, overriding the built-in icon set.
      */
     iconSource?: string;
     /**
-     * Text content for a user-facing label.
+     * Sets a visible text label rendered inside the item button, used when no slotted content is provided.
      */
     label?: string;
     /**
-     * The value of this item which is emitted by the parent element if it becomes selected. This property is **required**.
+     * Sets the value emitted by the parent `p-segmented-control` when this item is selected. This property is **required**.
      */
     value: string | number;
 } & {