@porsche-design-system/components-react 4.0.0-beta.2 → 4.0.0-beta.3

package/esm/lib/components/input-email.wrapper.d.ts

@@ -6,7 +6,7 @@ export type PInputEmailProps = BaseProps & {
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the input field as a compact version.
+     * Displays the input field in compact mode.
      */
     compact?: boolean;
     /**
@@ -14,7 +14,7 @@ export type PInputEmailProps = BaseProps & {
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the input field unusable and unclickable. The value will not be submitted with the form.
+     * Disables the input field. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -22,7 +22,7 @@ export type PInputEmailProps = BaseProps & {
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -50,7 +50,7 @@ export type PInputEmailProps = BaseProps & {
      */
     minLength?: number;
     /**
-     * A boolean value that, if present, it allows the user to enter a list of multiple email addresses, separated by commas (and optional whitespace). The browser will validate each email address in the list.
+     * Allows the user to enter a list of email addresses separated by commas (and optional whitespace). The browser validates each email address in the list.
      */
     multiple?: boolean;
     /**
@@ -100,7 +100,7 @@ export declare const PInputEmail: import("react").ForwardRefExoticComponent<Omit
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the input field as a compact version.
+     * Displays the input field in compact mode.
      */
     compact?: boolean;
     /**
@@ -108,7 +108,7 @@ export declare const PInputEmail: import("react").ForwardRefExoticComponent<Omit
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the input field unusable and unclickable. The value will not be submitted with the form.
+     * Disables the input field. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -116,7 +116,7 @@ export declare const PInputEmail: import("react").ForwardRefExoticComponent<Omit
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -144,7 +144,7 @@ export declare const PInputEmail: import("react").ForwardRefExoticComponent<Omit
      */
     minLength?: number;
     /**
-     * A boolean value that, if present, it allows the user to enter a list of multiple email addresses, separated by commas (and optional whitespace). The browser will validate each email address in the list.
+     * Allows the user to enter a list of email addresses separated by commas (and optional whitespace). The browser validates each email address in the list.
      */
     multiple?: boolean;
     /**

package/esm/lib/components/input-month.wrapper.d.ts

@@ -6,7 +6,7 @@ export type PInputMonthProps = BaseProps & {
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the input field as a compact version.
+     * Displays the input field in compact mode.
      */
     compact?: boolean;
     /**
@@ -14,7 +14,7 @@ export type PInputMonthProps = BaseProps & {
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the input field unusable and unclickable. The value will not be submitted with the form.
+     * Disables the input field. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -22,7 +22,7 @@ export type PInputMonthProps = BaseProps & {
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -34,7 +34,7 @@ export type PInputMonthProps = BaseProps & {
      */
     loading?: boolean;
     /**
-     * Specifies the latest month that can be selected. The value must be a month string in YYYY-MM format(e.g., max='2024-12').
+     * Specifies the latest month that can be selected. The value must be a month string in YYYY-MM format (e.g., max='2024-12').
      */
     max?: string;
     /**
@@ -50,11 +50,11 @@ export type PInputMonthProps = BaseProps & {
      */
     name: string;
     /**
-     * Emitted when the number input has lost focus.
+     * Emitted when the month input has lost focus.
      */
     onBlur?: (event: CustomEvent<InputMonthBlurEventDetail>) => void;
     /**
-     * Emitted when the number input loses focus after its value was changed.
+     * Emitted when the month input loses focus after its value was changed.
      */
     onChange?: (event: CustomEvent<InputMonthChangeEventDetail>) => void;
     /**
@@ -88,7 +88,7 @@ export declare const PInputMonth: import("react").ForwardRefExoticComponent<Omit
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the input field as a compact version.
+     * Displays the input field in compact mode.
      */
     compact?: boolean;
     /**
@@ -96,7 +96,7 @@ export declare const PInputMonth: import("react").ForwardRefExoticComponent<Omit
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the input field unusable and unclickable. The value will not be submitted with the form.
+     * Disables the input field. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -104,7 +104,7 @@ export declare const PInputMonth: import("react").ForwardRefExoticComponent<Omit
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -116,7 +116,7 @@ export declare const PInputMonth: import("react").ForwardRefExoticComponent<Omit
      */
     loading?: boolean;
     /**
-     * Specifies the latest month that can be selected. The value must be a month string in YYYY-MM format(e.g., max='2024-12').
+     * Specifies the latest month that can be selected. The value must be a month string in YYYY-MM format (e.g., max='2024-12').
      */
     max?: string;
     /**
@@ -132,11 +132,11 @@ export declare const PInputMonth: import("react").ForwardRefExoticComponent<Omit
      */
     name: string;
     /**
-     * Emitted when the number input has lost focus.
+     * Emitted when the month input has lost focus.
      */
     onBlur?: (event: CustomEvent<InputMonthBlurEventDetail>) => void;
     /**
-     * Emitted when the number input loses focus after its value was changed.
+     * Emitted when the month input loses focus after its value was changed.
      */
     onChange?: (event: CustomEvent<InputMonthChangeEventDetail>) => void;
     /**

package/esm/lib/components/input-number.wrapper.d.ts

@@ -6,7 +6,7 @@ export type PInputNumberProps = BaseProps & {
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the input field as a compact version.
+     * Displays the input field in compact mode.
      */
     compact?: boolean;
     /**
@@ -18,7 +18,7 @@ export type PInputNumberProps = BaseProps & {
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the input field unusable and unclickable. The value will not be submitted with the form.
+     * Disables the input field. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -26,7 +26,7 @@ export type PInputNumberProps = BaseProps & {
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -86,7 +86,7 @@ export type PInputNumberProps = BaseProps & {
      */
     step?: number;
     /**
-     * The number input value.
+     * The value of the number input.
      */
     value?: string;
 };
@@ -96,7 +96,7 @@ export declare const PInputNumber: import("react").ForwardRefExoticComponent<Omi
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the input field as a compact version.
+     * Displays the input field in compact mode.
      */
     compact?: boolean;
     /**
@@ -108,7 +108,7 @@ export declare const PInputNumber: import("react").ForwardRefExoticComponent<Omi
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the input field unusable and unclickable. The value will not be submitted with the form.
+     * Disables the input field. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -116,7 +116,7 @@ export declare const PInputNumber: import("react").ForwardRefExoticComponent<Omi
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -176,7 +176,7 @@ export declare const PInputNumber: import("react").ForwardRefExoticComponent<Omi
      */
     step?: number;
     /**
-     * The number input value.
+     * The value of the number input.
      */
     value?: string;
 } & {

package/esm/lib/components/input-password.wrapper.d.ts

@@ -6,7 +6,7 @@ export type PInputPasswordProps = BaseProps & {
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the input field as a compact version.
+     * Displays the input field in compact mode.
      */
     compact?: boolean;
     /**
@@ -14,7 +14,7 @@ export type PInputPasswordProps = BaseProps & {
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the input field unusable and unclickable. The value will not be submitted with the form.
+     * Disables the input field. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -22,7 +22,7 @@ export type PInputPasswordProps = BaseProps & {
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -92,7 +92,7 @@ export declare const PInputPassword: import("react").ForwardRefExoticComponent<O
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the input field as a compact version.
+     * Displays the input field in compact mode.
      */
     compact?: boolean;
     /**
@@ -100,7 +100,7 @@ export declare const PInputPassword: import("react").ForwardRefExoticComponent<O
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the input field unusable and unclickable. The value will not be submitted with the form.
+     * Disables the input field. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -108,7 +108,7 @@ export declare const PInputPassword: import("react").ForwardRefExoticComponent<O
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**

package/esm/lib/components/input-search.wrapper.d.ts

@@ -10,7 +10,7 @@ export type PInputSearchProps = BaseProps & {
      */
     clear?: boolean;
     /**
-     * A boolean value that, if present, renders the input field as a compact version.
+     * Displays the input field in compact mode.
      */
     compact?: boolean;
     /**
@@ -18,7 +18,7 @@ export type PInputSearchProps = BaseProps & {
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the input field unusable and unclickable. The value will not be submitted with the form.
+     * Disables the input field. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -26,7 +26,7 @@ export type PInputSearchProps = BaseProps & {
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -100,7 +100,7 @@ export declare const PInputSearch: import("react").ForwardRefExoticComponent<Omi
      */
     clear?: boolean;
     /**
-     * A boolean value that, if present, renders the input field as a compact version.
+     * Displays the input field in compact mode.
      */
     compact?: boolean;
     /**
@@ -108,7 +108,7 @@ export declare const PInputSearch: import("react").ForwardRefExoticComponent<Omi
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the input field unusable and unclickable. The value will not be submitted with the form.
+     * Disables the input field. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -116,7 +116,7 @@ export declare const PInputSearch: import("react").ForwardRefExoticComponent<Omi
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**

package/esm/lib/components/input-tel.wrapper.d.ts

@@ -6,7 +6,7 @@ export type PInputTelProps = BaseProps & {
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the input field as a compact version.
+     * Displays the input field in compact mode.
      */
     compact?: boolean;
     /**
@@ -14,7 +14,7 @@ export type PInputTelProps = BaseProps & {
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the input field unusable and unclickable. The value will not be submitted with the form.
+     * Disables the input field. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -22,7 +22,7 @@ export type PInputTelProps = BaseProps & {
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -96,7 +96,7 @@ export declare const PInputTel: import("react").ForwardRefExoticComponent<Omit<i
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the input field as a compact version.
+     * Displays the input field in compact mode.
      */
     compact?: boolean;
     /**
@@ -104,7 +104,7 @@ export declare const PInputTel: import("react").ForwardRefExoticComponent<Omit<i
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the input field unusable and unclickable. The value will not be submitted with the form.
+     * Disables the input field. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -112,7 +112,7 @@ export declare const PInputTel: import("react").ForwardRefExoticComponent<Omit<i
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**

package/esm/lib/components/input-text.wrapper.d.ts

@@ -6,7 +6,7 @@ export type PInputTextProps = BaseProps & {
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the input field as a compact version.
+     * Displays the input field in compact mode.
      */
     compact?: boolean;
     /**
@@ -18,7 +18,7 @@ export type PInputTextProps = BaseProps & {
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the input field unusable and unclickable. The value will not be submitted with the form.
+     * Disables the input field. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -26,7 +26,7 @@ export type PInputTextProps = BaseProps & {
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -96,7 +96,7 @@ export declare const PInputText: import("react").ForwardRefExoticComponent<Omit<
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the input field as a compact version.
+     * Displays the input field in compact mode.
      */
     compact?: boolean;
     /**
@@ -108,7 +108,7 @@ export declare const PInputText: import("react").ForwardRefExoticComponent<Omit<
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the input field unusable and unclickable. The value will not be submitted with the form.
+     * Disables the input field. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -116,7 +116,7 @@ export declare const PInputText: import("react").ForwardRefExoticComponent<Omit<
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**

package/esm/lib/components/input-time.wrapper.d.ts

@@ -2,11 +2,11 @@ import type { BaseProps } from '../../BaseProps';
 import type { BreakpointCustomizable, InputTimeBlurEventDetail, InputTimeChangeEventDetail, InputTimeInputEventDetail, InputTimeState } from '../types';
 export type PInputTimeProps = BaseProps & {
     /**
-     * Provides a hint to the browser about what type of data the field expects, which can assist with autofill features (e.g., auto-complete='on').
+     * Provides a hint to the browser about what type of data the field expects, which can assist with autofill features (e.g., autocomplete='on').
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the input field as a compact version.
+     * Displays the input field in compact mode.
      */
     compact?: boolean;
     /**
@@ -14,7 +14,7 @@ export type PInputTimeProps = BaseProps & {
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the input field unusable and unclickable. The value will not be submitted with the form.
+     * Disables the input field. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -22,7 +22,7 @@ export type PInputTimeProps = BaseProps & {
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -50,11 +50,11 @@ export type PInputTimeProps = BaseProps & {
      */
     name: string;
     /**
-     * Emitted when the number input has lost focus.
+     * Emitted when the time input has lost focus.
      */
     onBlur?: (event: CustomEvent<InputTimeBlurEventDetail>) => void;
     /**
-     * Emitted when the number input loses focus after its value was changed.
+     * Emitted when the time input loses focus after its value was changed.
      */
     onChange?: (event: CustomEvent<InputTimeChangeEventDetail>) => void;
     /**
@@ -74,7 +74,7 @@ export type PInputTimeProps = BaseProps & {
      */
     state?: InputTimeState;
     /**
-     * efines the granularity of the time input. The step value is given in seconds. The default is 60 (one minute). You can also specify smaller increments (e.g., step='1' for seconds, step='0.001' for milliseconds).
+     * Defines the granularity of the time input. The step value is given in seconds. The default is 60 (one minute). You can also specify smaller increments (e.g., step='1' for seconds, step='0.001' for milliseconds).
      */
     step?: number;
     /**
@@ -84,11 +84,11 @@ export type PInputTimeProps = BaseProps & {
 };
 export declare const PInputTime: 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"> & {
     /**
-     * Provides a hint to the browser about what type of data the field expects, which can assist with autofill features (e.g., auto-complete='on').
+     * Provides a hint to the browser about what type of data the field expects, which can assist with autofill features (e.g., autocomplete='on').
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the input field as a compact version.
+     * Displays the input field in compact mode.
      */
     compact?: boolean;
     /**
@@ -96,7 +96,7 @@ export declare const PInputTime: import("react").ForwardRefExoticComponent<Omit<
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the input field unusable and unclickable. The value will not be submitted with the form.
+     * Disables the input field. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -104,7 +104,7 @@ export declare const PInputTime: import("react").ForwardRefExoticComponent<Omit<
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -132,11 +132,11 @@ export declare const PInputTime: import("react").ForwardRefExoticComponent<Omit<
      */
     name: string;
     /**
-     * Emitted when the number input has lost focus.
+     * Emitted when the time input has lost focus.
      */
     onBlur?: (event: CustomEvent<InputTimeBlurEventDetail>) => void;
     /**
-     * Emitted when the number input loses focus after its value was changed.
+     * Emitted when the time input loses focus after its value was changed.
      */
     onChange?: (event: CustomEvent<InputTimeChangeEventDetail>) => void;
     /**
@@ -156,7 +156,7 @@ export declare const PInputTime: import("react").ForwardRefExoticComponent<Omit<
      */
     state?: InputTimeState;
     /**
-     * efines the granularity of the time input. The step value is given in seconds. The default is 60 (one minute). You can also specify smaller increments (e.g., step='1' for seconds, step='0.001' for milliseconds).
+     * Defines the granularity of the time input. The step value is given in seconds. The default is 60 (one minute). You can also specify smaller increments (e.g., step='1' for seconds, step='0.001' for milliseconds).
      */
     step?: number;
     /**