forked from capacitor-community/date-picker
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdefinitions.ts
150 lines (147 loc) · 3.1 KB
/
definitions.ts
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
declare module "@capacitor/core" {
interface PluginRegistry {
DatePickerPlugin: DatePickerPluginInterface;
}
}
export type DatePickerMode = 'time' | 'date' | 'dateAndTime' | 'countDownTimer';
export type DatePickerTheme = 'light' | 'dark' | 'legacyLight' | 'legacyDark' | string;
export interface DatePickerOptions {
/**
* @type {string}
* @default "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"
*
* @description ISO String format
*/
format?: string;
/**
* @type {string}
* @default null
*
* @description If null, empty or undefined, use the device locale
*/
locale?: string;
/**
* @type {string}
* @default null
*
* @description If null, empty or undefined, will be current date
*/
date?: string;
/**
* @type {DatePickerMode}
* @default "dateAndTime"
*
* @description Datepicker modes
*/
mode?: DatePickerMode;
/**
* @type {DatePickerTheme}
* @default "light"
*
* @description Datepicker themes
*/
theme?: DatePickerTheme;
/**
* @type: string
* @default: null
*
* @description If null, empty or undefined, will be the device timezone
*/
timezone?: string;
/**
* @type {string}
* @default null
*
* @description If null, empty or undefined, will be none. use Date.toISOString()
*/
min?: string;
/**
* @type {string}
* @default null
*
* @description If null, empty or undefined, will be none. use Date.toISOString()
*/
max?: string;
/**
* @type {string}
* @default null
*
* @description If null, empty or undefined, will be "OK".
*/
doneText?: string;
/**
* @type {string}
* @default null
*
* @description If null, empty or undefined, will be "CANCEL".
*/
cancelText?: string;
/**
* @type {string}
* @default null
*
* @description If null, empty or undefined, will be "false".
*/
is24h?: boolean;
/**
* @type {string}
* @default null
*
* @description hex string for title font color
* @note Only IOS
*/
titleFontColor?: string;
/**
* @type {string}
* @default null
*
* @description hex string for title background color
* @note Only IOS
*/
titleBgColor?: string;
/**
* @type {string}
* @default null
*
* @description hex string for picker background color
* @note Only IOS
*/
bgColor?: string;
/**
* @type {string}
* @default null
*
* @description hex string for picker font color
* @note Only IOS
*/
fontColor?: string;
/**
* @type {string}
* @default null
*
* @description hex string for buttons background color
* @note Only IOS
*/
buttonBgColor?: string;
/**
* @type {string}
* @default null
*
* @description hex string for button font color
* @note Only IOS
*/
buttonFontColor?: string;
/**
* @type {boolean}
* @default null
*
* @description Format dateAndTime picker for ios
* @note Only IOS
*/
mergedDateAndTime?: boolean;
}
export interface DatePickerPluginInterface {
present(options: DatePickerOptions): Promise<{ value: string }>;
darkMode(): Promise<void>;
lightMode(): Promise<void>;
}