@porsche-design-system/components-react/esm/lib/components/input-time.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, InputTimeBlurEventDetail, InputTimeChangeEventDetail, InputTimeInputEventDetail, InputTimeState } from '../types';
export type PInputTimeProps = BaseProps & {
    /**
     * Provides the browser with a time autofill hint.
     */
    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 time 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 time in `hh:mm` or `hh:mm:ss` format. Times 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 time in `hh:mm` or `hh:mm:ss` format. Times 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<InputTimeBlurEventDetail>) => void;
    /**
     * Emitted when the input loses focus after its value was changed.
     */
    onChange?: (event: CustomEvent<InputTimeChangeEventDetail>) => void;
    /**
     * Emitted on every value change as the user interacts with the time picker.
     */
    onInput?: (event: CustomEvent<InputTimeInputEventDetail>) => void;
    /**
     * Makes the field read-only — the value 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 time 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?: InputTimeState;
    /**
     * Sets the stepping interval in seconds. Use `60` for minute-level selection, `1` to also expose seconds.
     * @default 60
     */
    step?: number;
    /**
     * Sets the current time value in `hh:mm` or `hh:mm:ss` format (e.g. `14:00`).
     * @default ''
     */
    value?: string | null;
};
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" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
    /**
     * Provides the browser with a time autofill hint.
     */
    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 time 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 time in `hh:mm` or `hh:mm:ss` format. Times 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 time in `hh:mm` or `hh:mm:ss` format. Times 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<InputTimeBlurEventDetail>) => void;
    /**
     * Emitted when the input loses focus after its value was changed.
     */
    onChange?: (event: CustomEvent<InputTimeChangeEventDetail>) => void;
    /**
     * Emitted on every value change as the user interacts with the time picker.
     */
    onInput?: (event: CustomEvent<InputTimeInputEventDetail>) => void;
    /**
     * Makes the field read-only — the value 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 time 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?: InputTimeState;
    /**
     * Sets the stepping interval in seconds. Use `60` for minute-level selection, `1` to also expose seconds.
     * @default 60
     */
    step?: number;
    /**
     * Sets the current time value in `hh:mm` or `hh:mm:ss` format (e.g. `14:00`).
     * @default ''
     */
    value?: string | null;
} & {
    children?: import("react").ReactNode | undefined;
} & import("react").RefAttributes<HTMLElement>>;