ant-design-vue/types/date-picker/date-picker.d.ts

97 lines
2.3 KiB
TypeScript

// Project: https://github.com/vueComponent/ant-design-vue
// Definitions by: akki-jat <https://github.com/akki-jat>
// Definitions: https://github.com/vueComponent/ant-design-vue/types
import { DatepickerProps, DatepickerMethod } from './common';
import { Moment } from 'moment';
import { RangePicker } from './range-picker';
import { MonthPicker } from './month-picker';
import { WeekPicker } from './week-picker';
import { VNodeChild } from 'vue';
declare class DatePickerProps extends DatepickerProps {
/**
* Defualt Value
* @description to set default date
* @default undefined
* @type Moment
*/
defaultValue?: Moment | string;
/**
* Default Picker Value
* @description to set default picker date
* @default undefined
* @type Moment
*/
defaultPickerValue?: Moment | string;
/**
* Disabled Time
* @description to specify the time that cannot be selected
* @default undefined
* @type Function (function(date))
*/
disabledTime?: Function;
/**
* Format
* @description to set the date format, refer to moment.js http://momentjs.com
* @default 'YYYY-MM-DD'
* @type string
*/
format?: string;
/**
* Render Extra Footer
* @description render extra footer in panel by setting a scoped slot
* @default undefined
* @type any (slot="renderExtraFooter")
*/
renderExtraFooter?: VNodeChild | JSX.Element;
/**
* Show Time
* @description to provide an additional time selection
* showTime.defaultValue to set default time of selected date - type Moment
* --
* @default TimePicker Options
* @type object | boolean
*/
showTime?: object | boolean;
/**
* Show Today
* @description whether to show "Today" button
* @default true
* @type boolean
*/
showToday?: boolean;
/**
* Value
* @description to set date
* @default undefined
* @type Moment
*/
value?: Moment | string;
/**
* a callback function, can be executed when the selected time is changing
*/
onChange?: (date?: Moment | string, dateString?: string) => void;
/**
* callback when click ok button
*/
onOk?: () => void;
}
export declare class DatePicker extends DatepickerMethod {
static RangePicker: typeof RangePicker;
static MonthPicker: typeof MonthPicker;
static WeekPicker: typeof WeekPicker;
$props: DatePickerProps;
}