@porsche-design-system/components-react/esm/lib/components/input-date.wrapper.d.ts

Porsche Design System is a component library designed to help developers create the best experience for software or services distributed by Dr. Ing. h.c. F. Porsche AG.

import type { BaseProps } from '../../BaseProps';
import type { BreakpointCustomizable, InputDateBlurEventDetail, InputDateChangeEventDetail, InputDateInputEventDetail, InputDateState } from '../types';
export type PInputDateProps = BaseProps & {
    /**
     * Provides the browser with a date autofill hint (e.g. `autocomplete='bday'` for a birthday field).
     */
    autoComplete?: string;
    /**
     * Reduces the input height and padding for a more compact layout.
     * @default false
     */
    compact?: boolean;
    /**
     * Sets a supplementary description displayed below the label to provide additional context.
     * @default ''
     */
    description?: string;
    /**
     * Disables the field, preventing date selection. The value is not submitted with the form.
     * @default false
     */
    disabled?: boolean;
    /**
     * Associates the field with a form element by its ID when the field is not nested directly inside it.
     */
    form?: string;
    /**
     * Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
     * @default false
     */
    hideLabel?: BreakpointCustomizable<boolean>;
    /**
     * Sets the visible label text displayed above the input field.
     * @default ''
     */
    label?: string;
    /**
     * @experimental Disables the field and displays a loading spinner to indicate an ongoing operation.
     * @default false
     */
    loading?: boolean;
    /**
     * Sets the latest selectable date in YYYY-MM-DD format. Dates after this are disabled in the picker.
     */
    max?: string;
    /**
     * Sets the validation feedback message displayed below the field when `state` is `success` or `error`.
     * @default ''
     */
    message?: string;
    /**
     * Sets the earliest selectable date in YYYY-MM-DD format. Dates before this are disabled in the picker.
     */
    min?: string;
    /**
     * Sets the name submitted with the form data to identify this field's value on the server.
     */
    name: string;
    /**
     * Emitted when the input loses focus, regardless of whether the value changed.
     */
    onBlur?: (event: CustomEvent<InputDateBlurEventDetail>) => void;
    /**
     * Emitted when the input loses focus after its value was changed.
     */
    onChange?: (event: CustomEvent<InputDateChangeEventDetail>) => void;
    /**
     * Emitted on every value change as the user interacts with the date picker.
     */
    onInput?: (event: CustomEvent<InputDateInputEventDetail>) => void;
    /**
     * Makes the field read-only — the date is displayed but cannot be changed. The value is still submitted with the form.
     * @default false
     */
    readOnly?: boolean;
    /**
     * Marks the field as required — form submission is blocked while no date is selected.
     * @default false
     */
    required?: boolean;
    /**
     * Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
     * @default 'none'
     */
    state?: InputDateState;
    /**
     * Sets the stepping interval in days. The selected date must align with the `min` date by a multiple of this value.
     * @default 1
     */
    step?: number;
    /**
     * Sets the current date value in YYYY-MM-DD format (e.g. `2025-07-02`).
     * @default ''
     */
    value?: string | null;
};
export declare const PInputDate: 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"> & {
    /**
     * Provides the browser with a date autofill hint (e.g. `autocomplete='bday'` for a birthday field).
     */
    autoComplete?: string;
    /**
     * Reduces the input height and padding for a more compact layout.
     * @default false
     */
    compact?: boolean;
    /**
     * Sets a supplementary description displayed below the label to provide additional context.
     * @default ''
     */
    description?: string;
    /**
     * Disables the field, preventing date selection. The value is not submitted with the form.
     * @default false
     */
    disabled?: boolean;
    /**
     * Associates the field with a form element by its ID when the field is not nested directly inside it.
     */
    form?: string;
    /**
     * Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
     * @default false
     */
    hideLabel?: BreakpointCustomizable<boolean>;
    /**
     * Sets the visible label text displayed above the input field.
     * @default ''
     */
    label?: string;
    /**
     * @experimental Disables the field and displays a loading spinner to indicate an ongoing operation.
     * @default false
     */
    loading?: boolean;
    /**
     * Sets the latest selectable date in YYYY-MM-DD format. Dates after this are disabled in the picker.
     */
    max?: string;
    /**
     * Sets the validation feedback message displayed below the field when `state` is `success` or `error`.
     * @default ''
     */
    message?: string;
    /**
     * Sets the earliest selectable date in YYYY-MM-DD format. Dates before this are disabled in the picker.
     */
    min?: string;
    /**
     * Sets the name submitted with the form data to identify this field's value on the server.
     */
    name: string;
    /**
     * Emitted when the input loses focus, regardless of whether the value changed.
     */
    onBlur?: (event: CustomEvent<InputDateBlurEventDetail>) => void;
    /**
     * Emitted when the input loses focus after its value was changed.
     */
    onChange?: (event: CustomEvent<InputDateChangeEventDetail>) => void;
    /**
     * Emitted on every value change as the user interacts with the date picker.
     */
    onInput?: (event: CustomEvent<InputDateInputEventDetail>) => void;
    /**
     * Makes the field read-only — the date is displayed but cannot be changed. The value is still submitted with the form.
     * @default false
     */
    readOnly?: boolean;
    /**
     * Marks the field as required — form submission is blocked while no date is selected.
     * @default false
     */
    required?: boolean;
    /**
     * Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
     * @default 'none'
     */
    state?: InputDateState;
    /**
     * Sets the stepping interval in days. The selected date must align with the `min` date by a multiple of this value.
     * @default 1
     */
    step?: number;
    /**
     * Sets the current date value in YYYY-MM-DD format (e.g. `2025-07-02`).
     * @default ''
     */
    value?: string | null;
} & {
    children?: import("react").ReactNode | undefined;
} & import("react").RefAttributes<HTMLElement>>;