ant-design/components/date-picker/interface.tsx

115 lines
3.8 KiB
TypeScript
Raw Normal View History

2018-01-19 19:06:19 +08:00
import * as React from 'react';
import * as moment from 'moment';
import { TimePickerProps } from '../time-picker';
import { tuple } from '../_util/type';
2018-01-19 19:06:19 +08:00
export interface PickerProps {
id?: number | string;
2019-02-25 11:28:31 +08:00
name?: string;
2018-01-19 19:06:19 +08:00
prefixCls?: string;
inputPrefixCls?: string;
format?: string | string[];
2018-01-19 19:06:19 +08:00
disabled?: boolean;
allowClear?: boolean;
className?: string;
pickerClass?: string;
pickerInputClass?: string;
2018-09-16 19:39:43 +08:00
suffixIcon?: React.ReactNode;
2018-01-19 19:06:19 +08:00
style?: React.CSSProperties;
popupStyle?: React.CSSProperties;
dropdownClassName?: string;
2019-06-24 11:29:58 +08:00
locale?: any;
2018-01-19 19:06:19 +08:00
size?: 'large' | 'small' | 'default';
getCalendarContainer?: (triggerNode: Element) => HTMLElement;
open?: boolean;
onOpenChange?: (status: boolean) => void;
disabledDate?: (current: moment.Moment | undefined) => boolean;
2018-01-19 19:06:19 +08:00
dateRender?: (current: moment.Moment, today: moment.Moment) => React.ReactNode;
autoFocus?: boolean;
onFocus?: React.FocusEventHandler;
onBlur?: (e: React.SyntheticEvent) => void;
2018-01-19 19:06:19 +08:00
}
export interface SinglePickerProps {
value?: moment.Moment;
defaultValue?: moment.Moment;
defaultPickerValue?: moment.Moment;
placeholder?: string;
renderExtraFooter?: (mode: DatePickerMode) => React.ReactNode;
2019-07-29 21:58:38 +08:00
onChange?: (date: moment.Moment | null, dateString: string) => void;
2018-01-19 19:06:19 +08:00
}
const DatePickerModes = tuple('time', 'date', 'month', 'year', 'decade');
export type DatePickerMode = (typeof DatePickerModes)[number];
2018-01-19 19:06:19 +08:00
export interface DatePickerProps extends PickerProps, SinglePickerProps {
showTime?: TimePickerProps | boolean;
showToday?: boolean;
open?: boolean;
2018-12-07 16:17:45 +08:00
disabledTime?: (
current: moment.Moment | undefined,
2018-12-07 16:17:45 +08:00
) => {
disabledHours?: () => number[];
disabledMinutes?: () => number[];
disabledSeconds?: () => number[];
2018-01-19 19:06:19 +08:00
};
onOpenChange?: (status: boolean) => void;
onPanelChange?: (value: moment.Moment | undefined, mode: DatePickerMode) => void;
2019-01-31 13:06:43 +08:00
onOk?: (selectedTime: moment.Moment) => void;
mode?: DatePickerMode;
2018-01-19 19:06:19 +08:00
}
export interface MonthPickerProps extends PickerProps, SinglePickerProps {
monthCellContentRender?: (date: moment.Moment, locale: any) => React.ReactNode;
2018-01-19 19:06:19 +08:00
}
export type RangePickerValue =
2018-12-07 16:17:45 +08:00
| undefined[]
| [moment.Moment]
| [undefined, moment.Moment]
| [moment.Moment, undefined]
2018-12-07 16:17:45 +08:00
| [moment.Moment, moment.Moment];
export type RangePickerPresetRange = RangePickerValue | (() => RangePickerValue);
2018-01-19 19:06:19 +08:00
export interface RangePickerProps extends PickerProps {
className?: string;
tagPrefixCls?: string;
2018-01-19 19:06:19 +08:00
value?: RangePickerValue;
defaultValue?: RangePickerValue;
defaultPickerValue?: RangePickerValue;
timePicker?: React.ReactNode;
2018-01-19 19:06:19 +08:00
onChange?: (dates: RangePickerValue, dateStrings: [string, string]) => void;
onCalendarChange?: (dates: RangePickerValue, dateStrings: [string, string]) => void;
2019-01-31 13:06:43 +08:00
onOk?: (selectedTime: RangePickerPresetRange) => void;
2018-01-19 19:06:19 +08:00
showTime?: TimePickerProps | boolean;
showToday?: boolean;
2018-01-19 19:06:19 +08:00
ranges?: {
2018-12-07 16:17:45 +08:00
[range: string]: RangePickerPresetRange;
2018-01-19 19:06:19 +08:00
};
placeholder?: [string, string];
mode?: string | string[];
separator?: React.ReactNode;
2018-12-07 16:17:45 +08:00
disabledTime?: (
current: moment.Moment | undefined,
2018-12-07 16:17:45 +08:00
type: string,
) => {
disabledHours?: () => number[];
disabledMinutes?: () => number[];
disabledSeconds?: () => number[];
2018-01-19 19:06:19 +08:00
};
onPanelChange?: (value?: RangePickerValue, mode?: string | string[]) => void;
renderExtraFooter?: () => React.ReactNode;
onMouseEnter?: (e: React.MouseEvent<HTMLSpanElement, MouseEvent>) => void;
onMouseLeave?: (e: React.MouseEvent<HTMLSpanElement, MouseEvent>) => void;
2018-01-19 19:06:19 +08:00
}
export interface WeekPickerProps extends PickerProps, SinglePickerProps {
// - currently no own props -
2018-01-19 19:06:19 +08:00
}
export interface DatePickerDecorator extends React.ClassicComponentClass<DatePickerProps> {
RangePicker: React.ClassicComponentClass<RangePickerProps>;
MonthPicker: React.ClassicComponentClass<MonthPickerProps>;
WeekPicker: React.ClassicComponentClass<WeekPickerProps>;
2018-01-19 19:06:19 +08:00
}