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

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

package/ssr/esm/lib/components/input-url.wrapper.d.ts

@@ -6,7 +6,7 @@ export type PInputUrlProps = 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 PInputUrlProps = 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,11 +22,11 @@ export type PInputUrlProps = 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>;
     /**
-     * Controls the visibility of the url icon.
+     * Controls the visibility of the URL icon.
      */
     indicator?: boolean;
     /**
@@ -54,11 +54,11 @@ export type PInputUrlProps = BaseProps & {
      */
     name: string;
     /**
-     * Emitted when the url input has lost focus.
+     * Emitted when the URL input has lost focus.
      */
     onBlur?: (event: CustomEvent<InputUrlBlurEventDetail>) => void;
     /**
-     * Emitted when the url input loses focus after its value was changed.
+     * Emitted when the URL input loses focus after its value was changed.
      */
     onChange?: (event: CustomEvent<InputUrlChangeEventDetail>) => void;
     /**
@@ -66,7 +66,7 @@ export type PInputUrlProps = BaseProps & {
      */
     onInput?: (event: CustomEvent<InputUrlInputEventDetail>) => void;
     /**
-     * Specifies a regular expression that the input's value must match for the value to pass constraint validation. This allows for more specific url validation rules than the browser's default. If provided, it overrides the browser's default tel validation.
+     * Specifies a regular expression that the input's value must match to pass constraint validation. This allows for more specific URL validation rules than the browser's default. If provided, it overrides the browser's default URL validation.
      */
     pattern?: string;
     /**
@@ -86,7 +86,7 @@ export type PInputUrlProps = BaseProps & {
      */
     state?: InputUrlState;
     /**
-     * The url input value.
+     * The URL input value.
      */
     value?: string;
 };
@@ -96,7 +96,7 @@ export declare const PInputUrl: 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 PInputUrl: 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,11 +112,11 @@ export declare const PInputUrl: 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>;
     /**
-     * Controls the visibility of the url icon.
+     * Controls the visibility of the URL icon.
      */
     indicator?: boolean;
     /**
@@ -144,11 +144,11 @@ export declare const PInputUrl: import("react").ForwardRefExoticComponent<Omit<i
      */
     name: string;
     /**
-     * Emitted when the url input has lost focus.
+     * Emitted when the URL input has lost focus.
      */
     onBlur?: (event: CustomEvent<InputUrlBlurEventDetail>) => void;
     /**
-     * Emitted when the url input loses focus after its value was changed.
+     * Emitted when the URL input loses focus after its value was changed.
      */
     onChange?: (event: CustomEvent<InputUrlChangeEventDetail>) => void;
     /**
@@ -156,7 +156,7 @@ export declare const PInputUrl: import("react").ForwardRefExoticComponent<Omit<i
      */
     onInput?: (event: CustomEvent<InputUrlInputEventDetail>) => void;
     /**
-     * Specifies a regular expression that the input's value must match for the value to pass constraint validation. This allows for more specific url validation rules than the browser's default. If provided, it overrides the browser's default tel validation.
+     * Specifies a regular expression that the input's value must match to pass constraint validation. This allows for more specific URL validation rules than the browser's default. If provided, it overrides the browser's default URL validation.
      */
     pattern?: string;
     /**
@@ -176,7 +176,7 @@ export declare const PInputUrl: import("react").ForwardRefExoticComponent<Omit<i
      */
     state?: InputUrlState;
     /**
-     * The url input value.
+     * The URL input value.
      */
     value?: string;
 } & {