Interface DateRangePickerProps

Public

interface DateRangePickerProps {
    additionalDateTemplates?: DateRangePickerDateRangeTemplate[];
    allowClear?: boolean;
    autoFocus?: boolean;
    className?: string;
    dateFullCellRender?: ((date: Universe.Vendor.Moment.Moment) => ReactNode);
    defaultValue?: [string, string];
    disabledDate?: ((date: Universe.Vendor.Moment.Moment, granularity?: StartOf) => boolean);
    errorMessage?: ReactNode;
    errorTimeMessage: string;
    forwardRef?: RefObject<HTMLInputElement>;
    hasError?: boolean;
    headerRender?: ((prop: CalendarHeaderRenderProp) => ReactNode);
    i18nLocale: string;
    isDefaultOpen?: boolean;
    isDisabled?: boolean;
    isHighlighted?: boolean;
    isInline?: boolean;
    isOpen?: boolean;
    isReadOnly?: boolean;
    isUtc?: boolean;
    locale?: CalendarLocale;
    mode?:
        | "year"
        | "month"
        | "date"
        | "decade";
    onBlur?: (() => void);
    onChange?: ((dateArray: [string, string]) => void);
    onClear?: (() => void);
    onClose?: (() => void);
    onPanelChange?: ((date: Universe.Vendor.Moment.Moment, mode: CalendarMode) => void);
    onVisibleChange?: ((isOpen: boolean) => void);
    pickerType?: "dateRange" | "dateTimeRange";
    placeholder?: [string, string];
    validRange?: [Universe.Vendor.Moment.Moment, Universe.Vendor.Moment.Moment];
    value?: [string, string];
    valueFormat: string;
    viewFormat: string;
}

Hierarchy

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

Properties

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

Properties

OptionaladditionalDateTemplates

additionalDateTemplates?: DateRangePickerDateRangeTemplate[]

OptionalallowClear

allowClear?: boolean

OptionalautoFocus

autoFocus?: boolean

OptionalclassName

className?: string

OptionaldateFullCellRender

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

OptionaldefaultValue

defaultValue?: [string, string]

OptionaldisabledDate

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

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

OptionalisInline

isInline?: boolean

OptionalisOpen

isOpen?: boolean

OptionalisReadOnly

isReadOnly?: boolean

OptionalisUtc

isUtc?: boolean

Optionallocale

locale?: CalendarLocale

Optionalmode

mode?:
    | "year"
    | "month"
    | "date"
    | "decade"

OptionalonBlur

onBlur?: (() => void)

OptionalonChange

onChange?: ((dateArray: [string, string]) => void)

OptionalonClear

onClear?: (() => void)

OptionalonClose

onClose?: (() => void)

OptionalonPanelChange

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

OptionalonVisibleChange

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

OptionalpickerType

pickerType?: "dateRange" | "dateTimeRange"

Optionalplaceholder

placeholder?: [string, string]

OptionalvalidRange

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

Optionalvalue

value?: [string, string]

valueFormat

valueFormat: string

viewFormat

viewFormat: string

On This Page

Properties