Hex Core JS
    Preparing search index...

    Type Alias DateTimeInputProps

    DateTimeInputProps: {
        autoFocus?: boolean;
        closeCalendarOnSelect?: boolean;
        disabled?: boolean;
        id?: string;
        inline?: boolean;
        inputClassName?: string;
        invalid?: boolean;
        max?: string | null;
        min?: string | null;
        name?: string;
        onBlur?: () => void;
        onFocus?: () => void;
        openCalendarOnFocus?: boolean;
        placeholder?: string;
        precision?: DateTimePrecision;
        setValue: SetStateFunction<DateTimeFieldValue>;
        sideEffect?: (v: DateTimeFieldValue) => void;
        value: DateTimeFieldValue;
        withPreview?: DateTimeInputWithPreviewOption;
    } & Pick<InputProps, "before" | "after" | "gap"> & Partial<
        ClassNameProps & StyleProps,
    >

    Type Declaration

    • OptionalautoFocus?: boolean

      Indicates if the input should be auto-focused.

    • OptionalcloseCalendarOnSelect?: boolean

      Indicates whether selecting a date from the calendar automatically closes the calendar.

    • Optionaldisabled?: boolean

      Indicates if the input is disabled.

    • Optionalid?: string

      The ID of the input.

    • Optionalinline?: boolean

      Indicates if the calendar should be rendered with block display (so that it takes up space instead of overlaying). Useful when there is interactive content near the input or when in a tooltip (e.g. QuickFilter).

    • OptionalinputClassName?: string

      CSS class for the input element.

    • Optionalinvalid?: boolean

      Indicates if the input is invalid.

    • Optionalmax?: string | null

      The latest date allowed to be selected in the calendar.

    • Optionalmin?: string | null

      The earliest date allowed to be selected in the calendar.

    • Optionalname?: string

      The name of the input.

    • OptionalonBlur?: () => void

      A callback function to call when focus is removed from the input.

    • OptionalonFocus?: () => void

      A callback function to call when the input becomes focused.

    • OptionalopenCalendarOnFocus?: boolean

      Indicates whether focusing the input automatically opens the calendar.

    • Optionalplaceholder?: string

      Placeholder text to display when the value is blank. The value "[locale]" will display a date format for the user's locale and the input's precision, e.g. "MM/DD/YYYY".

    • Optionalprecision?: DateTimePrecision

      The precision of the date input. Accepts "year", "month", "day", "hour", "minute", or "second".

    • setValue: SetStateFunction<DateTimeFieldValue>

      A callback function to update the input value when a change happens.

    • OptionalsideEffect?: (v: DateTimeFieldValue) => void

      A side effect function to call when the value changes as a result of user interaction with this input, and not external updates to the field value.

    • value: DateTimeFieldValue

      The value of the input.

    • OptionalwithPreview?: DateTimeInputWithPreviewOption

      Controls when the value (or invalid value) preview is shown and takes up space.

    Settings

    Member Visibility