date-picker.d.ts
2.98 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
import { ElementUIComponent, ElementUIComponentSize, ElementUIHorizontalAlignment } from './component'
export type DatePickerType = 'year' | 'month' | 'date' | 'datetime' | 'week' | 'datetimerange' | 'daterange' | 'dates'
export type FirstDayOfWeek = 1 | 2 | 3 | 4 | 5 | 6 | 7
export interface DisabledDateChecker {
/**
* Determine if `date` will be disabled in the picker
*
* @param date The date to check
* @returns if `date` will be disabled in the picker
*/
(date: Date): boolean
}
// Picked date range
export interface DateRange {
minDate: Date,
maxDate: Date
}
export interface PickEventHandler {
/**
* Callback function that triggers when picks a date range
*
* @param dateRange The selected date range
*/
(dateRange: DateRange): void
}
export interface ShortcutClickEventHandler {
/**
* Callback function that triggers when clicking on a shortcut.
* You can change the picker value by emitting the pick event.
* Example: `vm.$emit('pick', new Date())`
*/
(vm: ElDatePicker): void
}
/** Shortcut options */
export interface Shortcut {
/** Title of the shortcut */
text: string,
/** Callback function that triggers when picks a date range */
onClick?: ShortcutClickEventHandler
}
/** Options of el-date-picker */
export interface DatePickerOptions {
/** An object array to set shortcut options */
shortcuts?: Shortcut[]
/** A function determining if a date is disabled. */
disabledDate?: DisabledDateChecker
/** First day of week */
firstDayOfWeek?: FirstDayOfWeek
/** A callback that triggers when the seleted date is changed. Only for daterange and datetimerange. */
onPick?: PickEventHandler
}
/** DatePicker Component */
export declare class ElDatePicker extends ElementUIComponent {
/** The value of the date picker */
value: Date | string | Date[] | string[]
/** Whether DatePicker is read only */
readonly: boolean
/** Whether DatePicker is disabled */
disabled: boolean
/** Size of Input */
size: ElementUIComponentSize
/** Whether the input is editable */
editable: boolean
/** Whether to show clear button */
clearable: boolean
/** Placeholder */
placeholder: string
/** Placeholder for the start date in range mode */
startPlaceholder: string
/** Placeholder for the end date in range mode */
endPlaceholder: string
/** Type of the picker */
type: DatePickerType
/** Format of the picker */
format: string
/** Alignment */
align: ElementUIHorizontalAlignment
/** Custom class name for DatePicker's dropdown */
popperClass: string
/** Additional options, check the table below */
pickerOptions: DatePickerOptions
/** Range separator */
rangeSeparator: string
/** Default date of the calendar */
defaultValue: Date | number | string
/** Format of binding value. If not specified, the binding value will be a Date object */
valueFormat: string
/** name for the inner native input */
name: string
/**
* Focus the Input component
*/
focus (): void
}