props.d.ts 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411
  1. import type { FocusEventHandler, MouseEventHandler } from '../../_util/EventInterface';
  2. import type { CSSProperties } from 'vue';
  3. import type { PickerLocale } from '.';
  4. import type { SizeType } from '../../config-provider';
  5. import type { PresetDate, CustomFormat, DisabledTime, DisabledTimes, EventValue, PanelMode, PickerMode, RangeValue } from '../../vc-picker/interface';
  6. import type { DateRender } from '../../vc-picker/panels/DatePanel/DateBody';
  7. import type { MonthCellRender } from '../../vc-picker/panels/MonthPanel/MonthBody';
  8. import type { SharedTimeProps } from '../../vc-picker/panels/TimePanel';
  9. import type { RangeDateRender, RangeInfo, RangeType } from '../../vc-picker/RangePicker';
  10. import type { VueNode } from '../../_util/type';
  11. import type { InputStatus } from '../../_util/statusUtils';
  12. declare const DataPickerPlacements: readonly ["bottomLeft", "bottomRight", "topLeft", "topRight"];
  13. type DataPickerPlacement = (typeof DataPickerPlacements)[number];
  14. type RangeShowTimeObject<DateType> = Omit<SharedTimeProps<DateType>, 'defaultValue'> & {
  15. defaultValue?: DateType[];
  16. };
  17. declare function commonProps<DateType = any>(): {
  18. id: StringConstructor;
  19. /**
  20. * @deprecated `dropdownClassName` is deprecated which will be removed in next major
  21. * version.Please use `popupClassName` instead.
  22. */
  23. dropdownClassName: StringConstructor;
  24. popupClassName: StringConstructor;
  25. popupStyle: {
  26. type: import("vue").PropType<CSSProperties>;
  27. default: CSSProperties;
  28. };
  29. transitionName: StringConstructor;
  30. placeholder: StringConstructor;
  31. allowClear: {
  32. type: BooleanConstructor;
  33. default: boolean;
  34. };
  35. autofocus: {
  36. type: BooleanConstructor;
  37. default: boolean;
  38. };
  39. disabled: {
  40. type: BooleanConstructor;
  41. default: boolean;
  42. };
  43. tabindex: NumberConstructor;
  44. open: {
  45. type: BooleanConstructor;
  46. default: boolean;
  47. };
  48. defaultOpen: {
  49. type: BooleanConstructor;
  50. default: boolean;
  51. };
  52. /** Make input readOnly to avoid popup keyboard in mobile */
  53. inputReadOnly: {
  54. type: BooleanConstructor;
  55. default: boolean;
  56. };
  57. format: {
  58. type: import("vue").PropType<string | CustomFormat<DateType> | (string | CustomFormat<DateType>)[]>;
  59. default: string | CustomFormat<DateType> | (string | CustomFormat<DateType>)[];
  60. };
  61. getPopupContainer: {
  62. type: import("vue").PropType<(node: HTMLElement) => HTMLElement>;
  63. default: (node: HTMLElement) => HTMLElement;
  64. };
  65. panelRender: {
  66. type: import("vue").PropType<(originPanel: VueNode) => VueNode>;
  67. default: (originPanel: VueNode) => VueNode;
  68. };
  69. onChange: {
  70. type: import("vue").PropType<(value: DateType | string | null, dateString: string) => void>;
  71. default: (value: DateType | string | null, dateString: string) => void;
  72. };
  73. 'onUpdate:value': {
  74. type: import("vue").PropType<(value: DateType | string | null) => void>;
  75. default: (value: DateType | string | null) => void;
  76. };
  77. onOk: {
  78. type: import("vue").PropType<(value: DateType | string | null) => void>;
  79. default: (value: DateType | string | null) => void;
  80. };
  81. onOpenChange: {
  82. type: import("vue").PropType<(open: boolean) => void>;
  83. default: (open: boolean) => void;
  84. };
  85. 'onUpdate:open': {
  86. type: import("vue").PropType<(open: boolean) => void>;
  87. default: (open: boolean) => void;
  88. };
  89. onFocus: {
  90. type: import("vue").PropType<FocusEventHandler>;
  91. default: FocusEventHandler;
  92. };
  93. onBlur: {
  94. type: import("vue").PropType<FocusEventHandler>;
  95. default: FocusEventHandler;
  96. };
  97. onMousedown: {
  98. type: import("vue").PropType<MouseEventHandler>;
  99. default: MouseEventHandler;
  100. };
  101. onMouseup: {
  102. type: import("vue").PropType<MouseEventHandler>;
  103. default: MouseEventHandler;
  104. };
  105. onMouseenter: {
  106. type: import("vue").PropType<MouseEventHandler>;
  107. default: MouseEventHandler;
  108. };
  109. onMouseleave: {
  110. type: import("vue").PropType<MouseEventHandler>;
  111. default: MouseEventHandler;
  112. };
  113. onClick: {
  114. type: import("vue").PropType<MouseEventHandler>;
  115. default: MouseEventHandler;
  116. };
  117. onContextmenu: {
  118. type: import("vue").PropType<MouseEventHandler>;
  119. default: MouseEventHandler;
  120. };
  121. onKeydown: {
  122. type: import("vue").PropType<(event: KeyboardEvent, preventDefault: () => void) => void>;
  123. default: (event: KeyboardEvent, preventDefault: () => void) => void;
  124. };
  125. role: StringConstructor;
  126. name: StringConstructor;
  127. autocomplete: StringConstructor;
  128. direction: {
  129. type: import("vue").PropType<"rtl" | "ltr">;
  130. default: "rtl" | "ltr";
  131. };
  132. showToday: {
  133. type: BooleanConstructor;
  134. default: boolean;
  135. };
  136. showTime: {
  137. type: import("vue").PropType<boolean | SharedTimeProps<DateType>>;
  138. default: boolean | SharedTimeProps<DateType>;
  139. };
  140. locale: {
  141. type: import("vue").PropType<PickerLocale>;
  142. default: PickerLocale;
  143. };
  144. size: {
  145. type: import("vue").PropType<SizeType>;
  146. default: SizeType;
  147. };
  148. bordered: {
  149. type: BooleanConstructor;
  150. default: boolean;
  151. };
  152. dateRender: {
  153. type: import("vue").PropType<DateRender<DateType>>;
  154. default: DateRender<DateType>;
  155. };
  156. disabledDate: {
  157. type: import("vue").PropType<(date: DateType) => boolean>;
  158. default: (date: DateType) => boolean;
  159. };
  160. mode: {
  161. type: import("vue").PropType<PanelMode>;
  162. default: PanelMode;
  163. };
  164. picker: {
  165. type: import("vue").PropType<PickerMode>;
  166. default: PickerMode;
  167. };
  168. valueFormat: StringConstructor;
  169. placement: {
  170. type: import("vue").PropType<"bottomLeft" | "bottomRight" | "topLeft" | "topRight">;
  171. default: "bottomLeft" | "bottomRight" | "topLeft" | "topRight";
  172. };
  173. status: {
  174. type: import("vue").PropType<"" | "error" | "warning">;
  175. default: "" | "error" | "warning";
  176. };
  177. /** @deprecated Please use `disabledTime` instead. */
  178. disabledHours: {
  179. type: import("vue").PropType<() => number[]>;
  180. default: () => number[];
  181. };
  182. /** @deprecated Please use `disabledTime` instead. */
  183. disabledMinutes: {
  184. type: import("vue").PropType<(hour: number) => number[]>;
  185. default: (hour: number) => number[];
  186. };
  187. /** @deprecated Please use `disabledTime` instead. */
  188. disabledSeconds: {
  189. type: import("vue").PropType<(hour: number, minute: number) => number[]>;
  190. default: (hour: number, minute: number) => number[];
  191. };
  192. };
  193. export interface CommonProps<DateType> {
  194. id?: string;
  195. prefixCls?: string;
  196. /**
  197. * @deprecated `dropdownClassName` is deprecated which will be removed in next major
  198. * version.Please use `popupClassName` instead.
  199. */
  200. dropdownClassName?: string;
  201. popupClassName?: string;
  202. popupStyle?: CSSProperties;
  203. transitionName?: string;
  204. placeholder?: string;
  205. allowClear?: boolean;
  206. autofocus?: boolean;
  207. disabled?: boolean;
  208. tabindex?: number;
  209. open?: boolean;
  210. defaultOpen?: boolean;
  211. inputReadOnly?: boolean;
  212. format?: string | CustomFormat<DateType> | (string | CustomFormat<DateType>)[];
  213. suffixIcon?: VueNode;
  214. clearIcon?: VueNode;
  215. prevIcon?: VueNode;
  216. nextIcon?: VueNode;
  217. superPrevIcon?: VueNode;
  218. superNextIcon?: VueNode;
  219. getPopupContainer?: (triggerNode: HTMLElement) => HTMLElement;
  220. panelRender?: (originPanel: VueNode) => VueNode;
  221. onChange?: (value: DateType | string | null, dateString: string) => void;
  222. 'onUpdate:value'?: (value: DateType | string | null) => void;
  223. onOk?: (value: DateType | string | null) => void;
  224. onOpenChange?: (open: boolean) => void;
  225. 'onUpdate:open'?: (open: boolean) => void;
  226. onFocus?: FocusEventHandler;
  227. onBlur?: FocusEventHandler;
  228. onMousedown?: MouseEventHandler;
  229. onMouseup?: MouseEventHandler;
  230. onMouseenter?: MouseEventHandler;
  231. onMouseleave?: MouseEventHandler;
  232. onClick?: MouseEventHandler;
  233. onContextmenu?: MouseEventHandler;
  234. onKeydown?: (event: KeyboardEvent, preventDefault: () => void) => void;
  235. role?: string;
  236. name?: string;
  237. autocomplete?: string;
  238. direction?: 'ltr' | 'rtl';
  239. showToday?: boolean;
  240. showTime?: boolean | SharedTimeProps<DateType>;
  241. locale?: PickerLocale;
  242. size?: SizeType;
  243. bordered?: boolean;
  244. dateRender?: DateRender<DateType>;
  245. disabledDate?: (date: DateType) => boolean;
  246. mode?: PanelMode;
  247. picker?: PickerMode;
  248. valueFormat?: string;
  249. placement?: DataPickerPlacement;
  250. status?: InputStatus;
  251. }
  252. declare function datePickerProps<DateType = any>(): {
  253. defaultPickerValue: {
  254. type: import("vue").PropType<string | DateType>;
  255. default: string | DateType;
  256. };
  257. defaultValue: {
  258. type: import("vue").PropType<string | DateType>;
  259. default: string | DateType;
  260. };
  261. value: {
  262. type: import("vue").PropType<string | DateType>;
  263. default: string | DateType;
  264. };
  265. presets: {
  266. type: import("vue").PropType<PresetDate<DateType>[]>;
  267. default: PresetDate<DateType>[];
  268. };
  269. disabledTime: {
  270. type: import("vue").PropType<DisabledTime<DateType>>;
  271. default: DisabledTime<DateType>;
  272. };
  273. renderExtraFooter: {
  274. type: import("vue").PropType<(mode: PanelMode) => VueNode>;
  275. default: (mode: PanelMode) => VueNode;
  276. };
  277. showNow: {
  278. type: BooleanConstructor;
  279. default: boolean;
  280. };
  281. monthCellRender: {
  282. type: import("vue").PropType<MonthCellRender<DateType>>;
  283. default: MonthCellRender<DateType>;
  284. };
  285. monthCellContentRender: {
  286. type: import("vue").PropType<MonthCellRender<DateType>>;
  287. default: MonthCellRender<DateType>;
  288. };
  289. };
  290. export interface DatePickerProps<DateType> {
  291. defaultPickerValue?: DateType | string;
  292. defaultValue?: DateType | string;
  293. value?: DateType | string;
  294. presets?: PresetDate<DateType>[];
  295. disabledTime?: DisabledTime<DateType>;
  296. renderExtraFooter?: (mode: PanelMode) => VueNode;
  297. showNow?: boolean;
  298. monthCellRender?: MonthCellRender<DateType>;
  299. monthCellContentRender?: MonthCellRender<DateType>;
  300. }
  301. declare function rangePickerProps<DateType>(): {
  302. allowEmpty: {
  303. type: import("vue").PropType<[boolean, boolean]>;
  304. default: [boolean, boolean];
  305. };
  306. dateRender: {
  307. type: import("vue").PropType<RangeDateRender<DateType>>;
  308. default: RangeDateRender<DateType>;
  309. };
  310. defaultPickerValue: {
  311. type: import("vue").PropType<[DateType, DateType] | [string, string]>;
  312. default: [DateType, DateType] | [string, string];
  313. };
  314. defaultValue: {
  315. type: import("vue").PropType<[DateType, DateType] | [string, string]>;
  316. default: [DateType, DateType] | [string, string];
  317. };
  318. value: {
  319. type: import("vue").PropType<[DateType, DateType] | [string, string]>;
  320. default: [DateType, DateType] | [string, string];
  321. };
  322. presets: {
  323. type: import("vue").PropType<PresetDate<DateType[]>[]>;
  324. default: PresetDate<DateType[]>[];
  325. };
  326. disabledTime: {
  327. type: import("vue").PropType<(date: EventValue<DateType>, type: RangeType) => DisabledTimes>;
  328. default: (date: EventValue<DateType>, type: RangeType) => DisabledTimes;
  329. };
  330. disabled: {
  331. type: import("vue").PropType<boolean | [boolean, boolean]>;
  332. default: boolean | [boolean, boolean];
  333. };
  334. renderExtraFooter: {
  335. type: import("vue").PropType<() => VueNode>;
  336. default: () => VueNode;
  337. };
  338. separator: {
  339. type: StringConstructor;
  340. };
  341. showTime: {
  342. type: import("vue").PropType<boolean | RangeShowTimeObject<DateType>>;
  343. default: boolean | RangeShowTimeObject<DateType>;
  344. };
  345. ranges: {
  346. type: import("vue").PropType<Record<string, [DateType, DateType] | (() => Exclude<RangeValue<DateType>, null>)>>;
  347. default: Record<string, [DateType, DateType] | (() => Exclude<RangeValue<DateType>, null>)>;
  348. };
  349. placeholder: {
  350. type: import("vue").PropType<string[]>;
  351. default: string[];
  352. };
  353. mode: {
  354. type: import("vue").PropType<[PanelMode, PanelMode]>;
  355. default: [PanelMode, PanelMode];
  356. };
  357. onChange: {
  358. type: import("vue").PropType<(value: RangeValue<DateType> | RangeValue<string> | null, dateString: [string, string]) => void>;
  359. default: (value: RangeValue<DateType> | RangeValue<string> | null, dateString: [string, string]) => void;
  360. };
  361. 'onUpdate:value': {
  362. type: import("vue").PropType<(value: RangeValue<DateType> | RangeValue<string> | null) => void>;
  363. default: (value: RangeValue<DateType> | RangeValue<string> | null) => void;
  364. };
  365. onCalendarChange: {
  366. type: import("vue").PropType<(values: RangeValue<DateType> | RangeValue<string>, formatString: [string, string], info: RangeInfo) => void>;
  367. default: (values: RangeValue<DateType> | RangeValue<string>, formatString: [string, string], info: RangeInfo) => void;
  368. };
  369. onPanelChange: {
  370. type: import("vue").PropType<(values: RangeValue<DateType> | RangeValue<string>, modes: [PanelMode, PanelMode]) => void>;
  371. default: (values: RangeValue<DateType> | RangeValue<string>, modes: [PanelMode, PanelMode]) => void;
  372. };
  373. onOk: {
  374. type: import("vue").PropType<(dates: RangeValue<DateType> | RangeValue<string>) => void>;
  375. default: (dates: RangeValue<DateType> | RangeValue<string>) => void;
  376. };
  377. };
  378. export interface RangePickerProps<DateType> {
  379. allowEmpty?: [boolean, boolean];
  380. dateRender?: RangeDateRender<DateType>;
  381. defaultPickerValue?: RangeValue<DateType> | RangeValue<string>;
  382. defaultValue?: RangeValue<DateType> | RangeValue<string>;
  383. value?: RangeValue<DateType> | RangeValue<string>;
  384. presets?: PresetDate<RangeValue<DateType>>[];
  385. disabledTime?: (date: EventValue<DateType>, type: RangeType) => DisabledTimes;
  386. disabled?: [boolean, boolean];
  387. renderExtraFooter?: () => VueNode;
  388. separator?: string;
  389. showTime?: boolean | RangeShowTimeObject<DateType>;
  390. ranges?: Record<string, Exclude<RangeValue<DateType>, null> | (() => Exclude<RangeValue<DateType>, null>)>;
  391. placeholder?: [string, string];
  392. mode?: [PanelMode, PanelMode];
  393. onChange?: (value: RangeValue<DateType> | RangeValue<string> | null, dateString: [string, string]) => void;
  394. 'onUpdate:value'?: (value: RangeValue<DateType> | RangeValue<string> | null) => void;
  395. onCalendarChange?: (values: RangeValue<DateType> | RangeValue<string>, formatString: [string, string], info: RangeInfo) => void;
  396. onPanelChange?: (values: RangeValue<DateType> | RangeValue<string>, modes: [PanelMode, PanelMode]) => void;
  397. onOk?: (dates: RangeValue<DateType> | RangeValue<string>) => void;
  398. }
  399. export type ExtraDatePickerProps<DateType> = {
  400. valueFormat?: string;
  401. defaultPickerValue?: DateType | string;
  402. defaultValue?: DateType | string;
  403. value?: DateType | string;
  404. };
  405. export type ExtraRangePickerProps<DateType> = {
  406. valueFormat?: string;
  407. defaultPickerValue?: RangeValue<DateType> | RangeValue<string>;
  408. defaultValue?: RangeValue<DateType> | RangeValue<string>;
  409. value?: RangeValue<DateType> | RangeValue<string>;
  410. };
  411. export { commonProps, datePickerProps, rangePickerProps };