Interface DatePickerProps

Public

interface DatePickerProps {
    additionalDateTemplates?: DatePickerDateTemplate[];
    allowClear?: boolean;
    autoFocus?: boolean;
    className?: string;
    dateFullCellRender?: ((date: Universe.Vendor.Moment.Moment) => ReactNode);
    defaultValue?: string;
    disabledDate?: ((date: Universe.Vendor.Moment.Moment, granularity?: StartOf) => boolean);
    errorDateMessage: string;
    errorMessage?: ReactNode;
    errorTimeMessage: string;
    forwardRef?: RefObject<HTMLInputElement>;
    hasError?: boolean;
    headerRender?: ((prop: CalendarHeaderRenderProp) => ReactNode);
    i18nLocale: string;
    isDefaultOpen?: boolean;
    isDisabled?: boolean;
    isHighlighted?: boolean;
    isOpen?: boolean;
    isReadOnly?: boolean;
    isUtc?: boolean;
    locale?: CalendarLocale;
    mode?: "year" | "month";
    onBlur?: (() => void);
    onChange?: ((date: string) => void);
    onClose?: (() => void);
    onPanelChange?: ((date: Universe.Vendor.Moment.Moment, mode: CalendarMode) => void);
    onVisibleChange?: ((visible: boolean) => void);
    pickerType: "date" | "dateTime";
    placeholder?: string;
    placeholderInvalidDate?: string;
    showSuffix?: boolean;
    timePlaceholder?: string;
    validRange?: [Universe.Vendor.Moment.Moment, Universe.Vendor.Moment.Moment];
    value?: null | string;
    valueFormat: string;
    viewFormat: string;
}

Hierarchy

  • Omit<CalendarProps,
        | "value"
        | "fullscreen"
        | "onSelect"
        | "onChange"
        | "mode"
        | "defaultValue">
    • DatePickerProps

Properties

additionalDateTemplates? allowClear? autoFocus? className? dateFullCellRender? defaultValue? disabledDate? errorDateMessage errorMessage? errorTimeMessage forwardRef? hasError? headerRender? i18nLocale isDefaultOpen? isDisabled? isHighlighted? isOpen? isReadOnly? isUtc? locale? mode? onBlur? onChange? onClose? onPanelChange? onVisibleChange? pickerType placeholder? placeholderInvalidDate? showSuffix? timePlaceholder? validRange? value? valueFormat viewFormat

Properties

OptionaladditionalDateTemplates

additionalDateTemplates?: DatePickerDateTemplate[]

OptionalallowClear

allowClear?: boolean

OptionalautoFocus

autoFocus?: boolean

OptionalclassName

className?: string

OptionaldateFullCellRender

dateFullCellRender?: ((date: Universe.Vendor.Moment.Moment) => ReactNode)

OptionaldefaultValue

defaultValue?: string

OptionaldisabledDate

disabledDate?: ((date: Universe.Vendor.Moment.Moment, granularity?: StartOf) => boolean)

errorDateMessage

errorDateMessage: string

OptionalerrorMessage

errorMessage?: ReactNode

errorTimeMessage

errorTimeMessage: string

OptionalforwardRef

forwardRef?: RefObject<HTMLInputElement>

OptionalhasError

hasError?: boolean

OptionalheaderRender

headerRender?: ((prop: CalendarHeaderRenderProp) => ReactNode)

i18nLocale

i18nLocale: string

OptionalisDefaultOpen

isDefaultOpen?: boolean

OptionalisDisabled

isDisabled?: boolean

OptionalisHighlighted

isHighlighted?: boolean

OptionalisOpen

isOpen?: boolean

OptionalisReadOnly

isReadOnly?: boolean

OptionalisUtc

isUtc?: boolean

Optionallocale

locale?: CalendarLocale

Optionalmode

mode?: "year" | "month"

OptionalonBlur

onBlur?: (() => void)

OptionalonChange

onChange?: ((date: string) => void)

OptionalonClose

onClose?: (() => void)

OptionalonPanelChange

onPanelChange?: ((date: Universe.Vendor.Moment.Moment, mode: CalendarMode) => void)

OptionalonVisibleChange

onVisibleChange?: ((visible: boolean) => void)

pickerType

pickerType: "date" | "dateTime"

Optionalplaceholder

placeholder?: string

OptionalplaceholderInvalidDate

placeholderInvalidDate?: string

OptionalshowSuffix

showSuffix?: boolean

OptionaltimePlaceholder

timePlaceholder?: string

OptionalvalidRange

validRange?: [Universe.Vendor.Moment.Moment, Universe.Vendor.Moment.Moment]

Optionalvalue

value?: null | string

valueFormat

valueFormat: string

viewFormat

viewFormat: string

On This Page

Properties