@fewangsit/wangsvue-fats 1.0.0-alpha.3 → 1.0.0-alpha.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. package/components/animation/Animation.vue.d.ts +6 -6
  2. package/components/approverinfo/ApproverInfo.vue.d.ts +36 -36
  3. package/components/assetinfo/AssetInfo.vue.d.ts +31 -0
  4. package/components/badge/Badge.vue.d.ts +46 -46
  5. package/components/badgegroup/BadgeGroup.vue.d.ts +38 -38
  6. package/components/basecomponent/index.d.ts +15 -15
  7. package/components/basetree/BaseTree.vue.d.ts +458 -458
  8. package/components/basetree/TreeNode.vue.d.ts +25 -25
  9. package/components/breadcrumb/Breadcrumb.vue.d.ts +7 -7
  10. package/components/button/Button.vue.d.ts +149 -141
  11. package/components/buttonbulkaction/ButtonBulkAction.vue.d.ts +73 -73
  12. package/components/buttoncopy/ButtonCopy.vue.d.ts +7 -7
  13. package/components/buttondownload/ButtonDownload.vue.d.ts +26 -26
  14. package/components/buttonfilter/ButtonFilter.vue.d.ts +4 -4
  15. package/components/buttonradio/ButtonRadio.vue.d.ts +189 -189
  16. package/components/buttonscan/ButtonScan.vue.d.ts +201 -0
  17. package/components/buttonscan/helpers/getErrorCode.helper.d.ts +3 -0
  18. package/components/buttonscan/helpers/index.d.ts +1 -0
  19. package/components/buttonscan/workers/scanner.worker.d.ts +1 -0
  20. package/components/buttonsearch/ButtonSearch.vue.d.ts +13 -13
  21. package/components/buttonselecttree/ButtonSelectTree.vue.d.ts +165 -163
  22. package/components/buttonsync/ButtonSync.vue.d.ts +22 -0
  23. package/components/buttontoggle/ButtonToggle.vue.d.ts +4 -4
  24. package/components/buttonviewlog/ButtonViewLog.vue.d.ts +17 -0
  25. package/components/calendar/BaseCalendar.vue.d.ts +106 -65
  26. package/components/calendar/Calendar.vue.d.ts +469 -469
  27. package/components/card/Card.vue.d.ts +82 -82
  28. package/components/checkbox/Checkbox.vue.d.ts +245 -245
  29. package/components/customcolumn/ColumnList.vue.d.ts +35 -15
  30. package/components/customcolumn/CustomColumn.vue.d.ts +21 -21
  31. package/components/customcolumn/helpers/setVisibilityColumn.helper.d.ts +5 -1
  32. package/components/datatable/DataTable.vue.d.ts +596 -596
  33. package/components/datatable/MultiRow.vue.d.ts +31 -11
  34. package/components/datatable/helpers/filter.helper.d.ts +12 -2
  35. package/components/datatable/helpers/index.d.ts +4 -1
  36. package/components/datatable/helpers/readConfig.helper.d.ts +4 -1
  37. package/components/datatable/store/dataTable.store.d.ts +4 -1
  38. package/components/dialog/Dialog.vue.d.ts +367 -367
  39. package/components/dialogconfirm/DialogConfirm.vue.d.ts +117 -117
  40. package/components/dialogform/DialogForm.vue.d.ts +288 -288
  41. package/components/dialogselecttree/DialogSelectTree.vue.d.ts +98 -98
  42. package/components/dropdown/Dropdown.vue.d.ts +231 -221
  43. package/components/editor/CodeSnippetAdapter.vue.d.ts +151 -91
  44. package/components/editor/Editor.vue.d.ts +156 -156
  45. package/components/editor/EditorButton.vue.d.ts +31 -11
  46. package/components/editor/MentionList.vue.d.ts +45 -31
  47. package/components/editor/MentionSection.vue.d.ts +151 -91
  48. package/components/fieldwrapper/FieldWrapper.vue.d.ts +48 -48
  49. package/components/fileupload/FileUpload.vue.d.ts +132 -132
  50. package/components/filtercontainer/FilterContainer.vue.d.ts +113 -113
  51. package/components/filtercontainer/helpers/applyFilter.helper.d.ts +11 -2
  52. package/components/filtercontainer/helpers/getOption.helper.d.ts +11 -2
  53. package/components/form/Form.vue.d.ts +258 -258
  54. package/components/icon/Icon.vue.d.ts +235 -235
  55. package/components/image/Image.vue.d.ts +306 -306
  56. package/components/imagecompressor/BackgroundImageCropper.vue.d.ts +47 -24
  57. package/components/imagecompressor/ImageCompressor.vue.d.ts +186 -180
  58. package/components/imagecompressor/ImageInputInfo.vue.d.ts +43 -18
  59. package/components/index.d.ts +58 -63
  60. package/components/inputbadge/InputBadge.vue.d.ts +90 -90
  61. package/components/inputcurrency/InputCurrency.vue.d.ts +126 -126
  62. package/components/inputcurrency/helpers/currency.helper.d.ts +5 -1
  63. package/components/inputnumber/InputNumber.vue.d.ts +245 -245
  64. package/components/inputpassword/InputPassword.vue.d.ts +19 -19
  65. package/components/inputphonenumber/InputPhoneNumber.vue.d.ts +68 -68
  66. package/components/inputrangenumber/InputRangeNumber.vue.d.ts +88 -88
  67. package/components/inputsearch/InputSearch.vue.d.ts +33 -0
  68. package/components/inputtext/InputText.vue.d.ts +281 -281
  69. package/components/inputurl/InputURL.vue.d.ts +6 -9
  70. package/components/invisiblefield/InvisibleField.vue.d.ts +30 -34
  71. package/components/litedropdown/LiteDropdown.vue.d.ts +64 -64
  72. package/components/loading/Loading.vue.d.ts +5 -5
  73. package/components/menu/Menu.vue.d.ts +282 -282
  74. package/components/menu/helpers/filterMenu.helper.d.ts +4 -1
  75. package/components/menuitem/MenuItem.vue +70 -0
  76. package/components/menuitem/MenuItem.vue.d.ts +33 -13
  77. package/components/menuitem/index.d.ts +84 -84
  78. package/components/multiselect/MultiSelect.vue.d.ts +162 -160
  79. package/components/overlaypanel/OverlayPanel.vue.d.ts +207 -207
  80. package/components/passthrough/index.d.ts +8 -8
  81. package/components/tabmenu/TabMenu.vue.d.ts +185 -185
  82. package/components/textarea/Textarea.vue.d.ts +131 -131
  83. package/components/timeline/Timeline.vue.d.ts +64 -58
  84. package/components/timeline/TimelineContentByType.vue.d.ts +60 -12
  85. package/components/toast/Toast.vue.d.ts +265 -265
  86. package/components/toggleswitch/ToggleSwitch.vue.d.ts +211 -211
  87. package/components/tree/Tree.vue.d.ts +116 -116
  88. package/components/tree/helpers/filterNodeKeys.helper.d.ts +8 -2
  89. package/components/tree/helpers/flattenTreeNodeChildren.helper.d.ts +3 -1
  90. package/components/ts-helpers.d.ts +43 -41
  91. package/components/username/UserName.vue.d.ts +71 -71
  92. package/components/userwithicon/UserWithIcon.vue.d.ts +20 -0
  93. package/config/defaultProps.d.ts +1 -1
  94. package/config/index.d.ts +1 -1
  95. package/config/locale.d.ts +1 -1
  96. package/event-bus/index.d.ts +3 -1
  97. package/event-bus/mitt.d.ts +25 -7
  98. package/main.d.ts +31 -2
  99. package/package.json +1 -1
  100. package/plugins/WangsVue.d.ts +184 -16
  101. package/plugins/formValidation.d.ts +11 -2
  102. package/plugins/i18n-extension.d.ts +4 -0
  103. package/plugins/i18n.d.ts +98 -0
  104. package/style.css +1 -1
  105. package/utils/addAttachment.util.d.ts +18 -2
  106. package/utils/date.util.d.ts +33 -4
  107. package/utils/filterOptions.util.d.ts +4 -2
  108. package/utils/genPlaceholder.util.d.ts +11 -6
  109. package/utils/getSeverityByAssetStatus.util.d.ts +3 -0
  110. package/utils/index.d.ts +14 -13
  111. package/utils/listenSidebarChanges.util.d.ts +16 -0
  112. package/utils/mergePropsWithDefaults.util.d.ts +4 -1
  113. package/utils/object.util.d.ts +14 -3
  114. package/utils/role.util.d.ts +5 -1
  115. package/utils/textFormatter.util.d.ts +15 -3
  116. package/wangsvue-fats.es.js +36988 -46002
  117. package/wangsvue-fats.system.js +169 -180
  118. package/assets/json/currencies.json.d.ts +0 -1068
  119. package/assets/json/supported-official-langs.json.d.ts +0 -530
  120. package/assets/lottie/admin/loading-page.lottie +0 -0
  121. package/assets/lottie/admin/loading-table.lottie +0 -0
  122. package/assets/lottie/admin/no-data.lottie +0 -0
  123. package/assets/lottie/supplyasset/loading-page.lottie +0 -0
  124. package/assets/lottie/supplyasset/loading-table.lottie +0 -0
  125. package/assets/lottie/supplyasset/no-data.lottie +0 -0
  126. package/assets/lottie/workspace/loading-page.lottie +0 -0
  127. package/assets/lottie/workspace/loading-plane.lottie +0 -0
  128. package/assets/lottie/workspace/loading-table.lottie +0 -0
  129. package/assets/lottie/workspace/no-data.lottie +0 -0
  130. package/build-entry.d.ts +0 -14
  131. package/components/buttonImportExcel/ButtonImportExcel.vue.d.ts +0 -35
  132. package/components/buttonsplit/ButtonSplit.d.ts +0 -350
  133. package/components/buttonsplit/ButtonSplit.vue.d.ts +0 -34
  134. package/components/codesnippet/CodeSnippet.vue.d.ts +0 -14
  135. package/components/gallerypreview/GalleryPreview.vue.d.ts +0 -31
  136. package/components/helpers/convertToArrayClass.helper.d.ts +0 -2
  137. package/components/helpers/index.d.ts +0 -2
  138. package/components/helpers/label.d.ts +0 -15
  139. package/components/inlinemessage/InlineMessage.vue.d.ts +0 -167
  140. package/components/inputgroup/InputGroup.vue.d.ts +0 -141
  141. package/components/languagedropdown/LanguageDropdown.vue.d.ts +0 -50
  142. package/components/languagedropdown/LanguageDropdownOption.vue.d.ts +0 -18
  143. package/components/languageswitcher/LanguageSwitcher.vue.d.ts +0 -15
  144. package/components/progressbar/ProgressBar.vue.d.ts +0 -72
  145. package/components/quickfilter/QuickFilter.vue.d.ts +0 -25
  146. package/components/tooltipspan/TooltipSpan.vue.d.ts +0 -20
  147. package/components/treesearchinput/TreeSearchInput.vue.d.ts +0 -16
  148. package/components/usergroup/UserGroup.vue.d.ts +0 -57
  149. package/components/validatormessage/ValidatorMessage.vue.d.ts +0 -12
  150. package/plugins/translation.d.ts +0 -84
  151. package/types/options.type.d.ts +0 -16
@@ -3,74 +3,74 @@ import { CustomValidation } from '../form/Form.vue.d';
3
3
  import { ClassComponent } from '../ts-helpers';
4
4
 
5
5
  export interface CalendarLocaleConfig {
6
- defaultPlaceholder: string;
7
-
8
- /**
9
- * Error message displayed when no selection has been made.
10
- *
11
- * This message can include placeholders:
12
- * - `{label}`: Replaced with the value of `props.label`.
13
- * - `{formattedLabel}`: Replaced with the value of `props.label` formatted with an appropriate article (a/an).
14
- *
15
- * @example
16
- * // If `props.label` is 'Date', the error message will be:
17
- * '{label} must be picked' - 'Date must be picked'
18
- *
19
- * @example
20
- * // If `props.label` is 'Audit Date', the error message will be:
21
- * 'You must pick {formattedLabel}' - 'You must pick an Audit date'
22
- */
23
- emptyInvalidText?: string;
24
-
25
- /**
26
- * The cancel button when props.showTime or showButton
27
- *
28
- * @default 'Cancel'
29
- */
30
- cancelFooterButtonLabel?: string;
31
-
32
- /**
33
- * The apply button when props.showTime or showButton
34
- *
35
- * @default 'Apply'
36
- */
37
- applyFooterButtonLabel?: string;
6
+ defaultPlaceholder: string;
7
+
8
+ /**
9
+ * Error message displayed when no selection has been made.
10
+ *
11
+ * This message can include placeholders:
12
+ * - `{label}`: Replaced with the value of `props.label`.
13
+ * - `{formattedLabel}`: Replaced with the value of `props.label` formatted with an appropriate article (a/an).
14
+ *
15
+ * @example
16
+ * // If `props.label` is 'Date', the error message will be:
17
+ * '{label} must be picked' - 'Date must be picked'
18
+ *
19
+ * @example
20
+ * // If `props.label` is 'Audit Date', the error message will be:
21
+ * 'You must pick {formattedLabel}' - 'You must pick an Audit date'
22
+ */
23
+ emptyInvalidText?: string;
24
+
25
+ /**
26
+ * The cancel button when props.showTime or showButton
27
+ *
28
+ * @default 'Cancel'
29
+ */
30
+ cancelFooterButtonLabel?: string;
31
+
32
+ /**
33
+ * The apply button when props.showTime or showButton
34
+ *
35
+ * @default 'Apply'
36
+ */
37
+ applyFooterButtonLabel?: string;
38
38
  }
39
39
 
40
40
  export type CalendarPresetOptionMethodType = (
41
- options: Partial<CalendarPresetMethodOptions>,
41
+ options: Partial<CalendarPresetMethodOptions>,
42
42
  ) => CalendarPresetAttributes;
43
43
 
44
44
  /**
45
45
  * Defines the possible transition types for Calendar.
46
46
  */
47
47
  export type CalendarPresetTransitionType =
48
- | {
49
- transition?: TransitionProps;
50
- }
51
- | ((options: CalendarPresetMethodOptions) => TransitionProps)
52
- | undefined;
48
+ | {
49
+ transition?: TransitionProps;
50
+ }
51
+ | ((options: CalendarPresetMethodOptions) => TransitionProps)
52
+ | undefined;
53
53
 
54
54
  /**
55
55
  * Options passed to methods for pass-through properties.
56
56
  */
57
57
  export interface CalendarPresetMethodOptions {
58
- instance: any;
59
- props: CalendarProps;
60
- state: CalendarState;
61
- context: Partial<CalendarContext>;
62
- attrs: any;
63
- parent: any;
64
- global: object | undefined;
58
+ instance: any;
59
+ props: CalendarProps;
60
+ state: CalendarState;
61
+ context: Partial<CalendarContext>;
62
+ attrs: any;
63
+ parent: any;
64
+ global: object | undefined;
65
65
  }
66
66
 
67
67
  /**
68
68
  * Attributes for Calendar pass-through customization.
69
69
  */
70
70
  export interface CalendarPresetAttributes {
71
- class?: any;
72
- style?: any;
73
- [key: string]: any;
71
+ class?: any;
72
+ style?: any;
73
+ [key: string]: any;
74
74
  }
75
75
 
76
76
  /**
@@ -78,432 +78,432 @@ export interface CalendarPresetAttributes {
78
78
  * Used in preset.
79
79
  */
80
80
  export interface CalendarPresetOptions {
81
- root?: CalendarPresetOptionMethodType;
82
- input?: CalendarPresetOptionMethodType;
83
- inputicon?: CalendarPresetAttributes;
84
- dropdownbutton?: {
85
- root?: CalendarPresetAttributes;
86
- };
87
- panel?: CalendarPresetOptionMethodType;
88
- datepickerMask?: CalendarPresetAttributes;
89
- header?: CalendarPresetOptionMethodType;
90
- previousbutton?: CalendarPresetOptionMethodType;
91
- title?: CalendarPresetOptionMethodType;
92
- monthTitle?: CalendarPresetAttributes;
93
- yearTitle?: CalendarPresetOptionMethodType;
94
- nextbutton?: CalendarPresetOptionMethodType;
95
- table?: CalendarPresetAttributes;
96
- tableheadercell?: CalendarPresetAttributes;
97
- tablebodyrow?: CalendarPresetAttributes;
98
- weekheader?: CalendarPresetAttributes;
99
- weeknumber?: CalendarPresetAttributes;
100
- weekday?: CalendarPresetAttributes;
101
- day?: CalendarPresetAttributes;
102
- weeklabelcontainer?: CalendarPresetOptionMethodType;
103
- daylabel?: CalendarPresetOptionMethodType;
104
- monthpicker?: CalendarPresetAttributes;
105
- month?: CalendarPresetOptionMethodType;
106
- yearpicker?: CalendarPresetAttributes;
107
- year?: CalendarPresetOptionMethodType;
108
- timepicker?: CalendarPresetAttributes;
109
- separatorcontainer?: CalendarPresetAttributes;
110
- separator?: CalendarPresetAttributes;
111
- hourpicker?: CalendarPresetAttributes;
112
- timepickerlabel?: CalendarPresetAttributes;
113
- minutepicker?: CalendarPresetAttributes;
114
- secondPicker?: CalendarPresetAttributes;
115
- incrementbutton?: CalendarPresetAttributes;
116
- incrementicon?: CalendarPresetAttributes;
117
- decrementbutton?: CalendarPresetAttributes;
118
- decrementicon?: CalendarPresetAttributes;
119
- container?: CalendarPresetAttributes;
120
- groupcontainer?: CalendarPresetAttributes;
121
- group?: CalendarPresetAttributes;
122
- buttonbar?: CalendarPresetAttributes;
123
- todaybutton?: {
124
- root?: CalendarPresetAttributes;
125
- };
126
- clearbutton?: {
127
- root?: CalendarPresetAttributes;
128
- };
129
- transition?: {
130
- enterFromClass?: string;
131
- enterActiveClass?: string;
132
- leaveActiveClass?: string;
133
- leaveToClass?: string;
134
- };
81
+ root?: CalendarPresetOptionMethodType;
82
+ input?: CalendarPresetOptionMethodType;
83
+ inputicon?: CalendarPresetAttributes;
84
+ dropdownbutton?: {
85
+ root?: CalendarPresetAttributes;
86
+ };
87
+ panel?: CalendarPresetOptionMethodType;
88
+ datepickerMask?: CalendarPresetAttributes;
89
+ header?: CalendarPresetOptionMethodType;
90
+ previousbutton?: CalendarPresetOptionMethodType;
91
+ title?: CalendarPresetOptionMethodType;
92
+ monthTitle?: CalendarPresetAttributes;
93
+ yearTitle?: CalendarPresetOptionMethodType;
94
+ nextbutton?: CalendarPresetOptionMethodType;
95
+ table?: CalendarPresetAttributes;
96
+ tableheadercell?: CalendarPresetAttributes;
97
+ tablebodyrow?: CalendarPresetAttributes;
98
+ weekheader?: CalendarPresetAttributes;
99
+ weeknumber?: CalendarPresetAttributes;
100
+ weekday?: CalendarPresetAttributes;
101
+ day?: CalendarPresetAttributes;
102
+ weeklabelcontainer?: CalendarPresetOptionMethodType;
103
+ daylabel?: CalendarPresetOptionMethodType;
104
+ monthpicker?: CalendarPresetAttributes;
105
+ month?: CalendarPresetOptionMethodType;
106
+ yearpicker?: CalendarPresetAttributes;
107
+ year?: CalendarPresetOptionMethodType;
108
+ timepicker?: CalendarPresetAttributes;
109
+ separatorcontainer?: CalendarPresetAttributes;
110
+ separator?: CalendarPresetAttributes;
111
+ hourpicker?: CalendarPresetAttributes;
112
+ timepickerlabel?: CalendarPresetAttributes;
113
+ minutepicker?: CalendarPresetAttributes;
114
+ secondPicker?: CalendarPresetAttributes;
115
+ incrementbutton?: CalendarPresetAttributes;
116
+ incrementicon?: CalendarPresetAttributes;
117
+ decrementbutton?: CalendarPresetAttributes;
118
+ decrementicon?: CalendarPresetAttributes;
119
+ container?: CalendarPresetAttributes;
120
+ groupcontainer?: CalendarPresetAttributes;
121
+ group?: CalendarPresetAttributes;
122
+ buttonbar?: CalendarPresetAttributes;
123
+ todaybutton?: {
124
+ root?: CalendarPresetAttributes;
125
+ };
126
+ clearbutton?: {
127
+ root?: CalendarPresetAttributes;
128
+ };
129
+ transition?: {
130
+ enterFromClass?: string;
131
+ enterActiveClass?: string;
132
+ leaveActiveClass?: string;
133
+ leaveToClass?: string;
134
+ };
135
135
  }
136
136
 
137
137
  /**
138
138
  * Represents the current state of the Calendar component.
139
139
  */
140
140
  export interface CalendarState {
141
- currentView: CalendarProps['view'];
141
+ currentView: CalendarProps['view'];
142
142
  }
143
143
 
144
144
  /**
145
145
  * Defines current month options.
146
146
  */
147
147
  export interface CalendarMonthOptions {
148
- /**
149
- * Month index.
150
- */
151
- value: number;
152
-
153
- /**
154
- * Selectable state of the month.
155
- */
156
- selectable: boolean;
148
+ /**
149
+ * Month index.
150
+ */
151
+ value: number;
152
+
153
+ /**
154
+ * Selectable state of the month.
155
+ */
156
+ selectable: boolean;
157
157
  }
158
158
 
159
159
  /**
160
160
  * Defines current year options.
161
161
  */
162
162
  export interface CalendarYearOptions {
163
- /**
164
- * Year value.
165
- */
166
- value: number;
167
-
168
- /**
169
- * Selectable state of the year.
170
- */
171
- selectable: boolean;
163
+ /**
164
+ * Year value.
165
+ */
166
+ value: number;
167
+
168
+ /**
169
+ * Selectable state of the year.
170
+ */
171
+ selectable: boolean;
172
172
  }
173
173
 
174
174
  export interface CalendarDate {
175
- /**
176
- * Current date.
177
- */
178
- day: number;
179
-
180
- /**
181
- * Current month state.
182
- */
183
- month: number;
184
-
185
- /**
186
- * Current year state.
187
- */
188
- year: number;
189
-
190
- /**
191
- * Current today state of the calendar's day.
192
- */
193
- today: boolean;
194
-
195
- /**
196
- * Selectable state of the day.
197
- */
198
- selectable: boolean;
199
-
200
- /**
201
- * Wether the day is on other month than currently shown
202
- */
203
- otherMonth: boolean;
175
+ /**
176
+ * Current date.
177
+ */
178
+ day: number;
179
+
180
+ /**
181
+ * Current month state.
182
+ */
183
+ month: number;
184
+
185
+ /**
186
+ * Current year state.
187
+ */
188
+ year: number;
189
+
190
+ /**
191
+ * Current today state of the calendar's day.
192
+ */
193
+ today: boolean;
194
+
195
+ /**
196
+ * Selectable state of the day.
197
+ */
198
+ selectable: boolean;
199
+
200
+ /**
201
+ * Wether the day is on other month than currently shown
202
+ */
203
+ otherMonth: boolean;
204
204
  }
205
205
 
206
206
  /**
207
207
  * Provides contextual information for the Calendar component.
208
208
  */
209
209
  export interface CalendarContext {
210
- /**
211
- * Current date.
212
- */
213
- date: CalendarDate;
214
-
215
- /**
216
- * Current today state of the calendar's day.
217
- * @defaultValue false
218
- */
219
- today: boolean;
220
-
221
- /**
222
- * Current other month state of the calendar's day.
223
- */
224
- otherMonth: boolean;
225
-
226
- /**
227
- * Current selected state of the calendar's day or month or year.
228
- * @defaultValue false
229
- */
230
- selected: boolean;
231
-
232
- /**
233
- * Current date is the first selected on range selection
234
- */
235
- firstSelected: boolean;
236
-
237
- /**
238
- * Current date is the last selected on range selection
239
- */
240
- lastSelected: boolean;
241
-
242
- /**
243
- * Current disabled state of the calendar's day or month or year.
244
- * @defaultValue false
245
- */
246
- disabled: boolean;
247
-
248
- /**
249
- * Current month state.
250
- */
251
- month: CalendarMonthOptions;
252
-
253
- /**
254
- * Current month index state.
255
- */
256
- monthIndex: number;
257
-
258
- /**
259
- * Current year state.
260
- */
261
- year: CalendarYearOptions;
210
+ /**
211
+ * Current date.
212
+ */
213
+ date: CalendarDate;
214
+
215
+ /**
216
+ * Current today state of the calendar's day.
217
+ * @defaultValue false
218
+ */
219
+ today: boolean;
220
+
221
+ /**
222
+ * Current other month state of the calendar's day.
223
+ */
224
+ otherMonth: boolean;
225
+
226
+ /**
227
+ * Current selected state of the calendar's day or month or year.
228
+ * @defaultValue false
229
+ */
230
+ selected: boolean;
231
+
232
+ /**
233
+ * Current date is the first selected on range selection
234
+ */
235
+ firstSelected: boolean;
236
+
237
+ /**
238
+ * Current date is the last selected on range selection
239
+ */
240
+ lastSelected: boolean;
241
+
242
+ /**
243
+ * Current disabled state of the calendar's day or month or year.
244
+ * @defaultValue false
245
+ */
246
+ disabled: boolean;
247
+
248
+ /**
249
+ * Current month state.
250
+ */
251
+ month: CalendarMonthOptions;
252
+
253
+ /**
254
+ * Current month index state.
255
+ */
256
+ monthIndex: number;
257
+
258
+ /**
259
+ * Current year state.
260
+ */
261
+ year: CalendarYearOptions;
262
262
  }
263
263
 
264
264
  /**
265
265
  * Calendar component props
266
266
  */
267
267
  export interface CalendarProps {
268
- /**
269
- * Bound value of the component.
270
- * Supports single or multiple date selection.
271
- *
272
- * Used with `v-model`.
273
- * It should not be used with useValidator. v-model should only be used when the Calendar not used in form
274
- * @defaultValue null
275
- */
276
- modelValue?: Date | Date[] | null;
277
-
278
- /**
279
- * Initial date value for pre-filling forms.
280
- * Typically used for editing existing records.
281
- *
282
- * Accepts epoch timestamps in milliseconds.
283
- *
284
- * It will only watch for changes once.
285
- */
286
- dateValue?: number | number[];
287
-
288
- /**
289
- * Epoch time in milliseconds representing the selected date(s).
290
- *
291
- * Can be used with `v-model:epochTimeMillis` for two way binding.
292
- */
293
- epochTimeMillis?: number | number[];
294
-
295
- /**
296
- * Defines the format in which the field value is handled.
297
- * - `'date'` returns a `Date` object.
298
- * - `'millis'` returns an epoch timestamp in milliseconds.
299
- *
300
- * @default millis
301
- */
302
- valueFormat?: 'date' | 'millis';
303
-
304
- /**
305
- * Display label on top of Date Input.
306
- */
307
- label?: string;
308
-
309
- /**
310
- * The input placeholder
311
- * @default - The value on locale config {@link CalendarLocaleConfig.defaultPlaceholder}
312
- */
313
- placeholder?: string;
314
- disabled?: boolean;
315
-
316
- /**
317
- * Make the calendar states readonly.
318
- * If true, calendar will not allow user interaction with it. But user can view currently selected date and time.
319
- *
320
- * @default false
321
- */
322
- readonly?: boolean;
323
-
324
- /**
325
- * Identifier of the underlying input element.
326
- */
327
- inputId?: string | undefined;
328
-
329
- /**
330
- * Identifier of the wrapper element.
331
- */
332
- id?: string | undefined;
333
-
334
- /**
335
- * Whether single date or date range model value.
336
- *
337
- * @default 'single'
338
- * @deprecated use selectionMode
339
- */
340
- mode?: 'range' | 'single';
341
-
342
- /**
343
- * Whether single date or date range model value.
344
- *
345
- * @default 'single'
346
- */
347
- selectionMode?: 'range' | 'single';
348
-
349
- /**
350
- * Whether to hide the overlay on date selection when showTime is enabled.
351
- * @defaultValue false
352
- */
353
- hideOnDateTimeSelect?: boolean | undefined;
354
-
355
- /**
356
- * Whether to hide the overlay on date selection is completed when selectionMode is range.
357
- * @defaultValue true - when showButtons and showTime false
358
- * @defaultValue false - when showButtons and showTime true
359
- */
360
- hideOnRangeSelection?: boolean | undefined;
361
-
362
- /**
363
- * Type of view to display.
364
- * @defaultValue date
365
- */
366
- view?: 'date' | 'month' | 'year' | undefined;
367
-
368
- /**
369
- * Wheter show year picker or not
370
- *
371
- * @default true
372
- */
373
- showYear?: boolean;
374
-
375
- /**
376
- * Show button Apply and cancel on footer.
377
- *
378
- * If shown, the modelValue will be updated on button Apply clicked.
379
- *
380
- * @default false;
381
- */
382
- showButtons?: boolean;
383
-
384
- /**
385
- * Enable Validator using vee-validate. Combine with Form component that handle form validation.
386
- */
387
- useValidator?: boolean;
388
-
389
- /**
390
- * When used as field in From Validation using Form component,
391
- * specify the unique field name, match with your needs for API request.
392
- */
393
- fieldName?: string;
394
-
395
- /**
396
- * Show information to user about the field.
397
- */
398
- fieldInfo?: string;
399
-
400
- /**
401
- * Whether this field should be filled or not.
402
- */
403
- mandatory?: boolean;
404
-
405
- /**
406
- * Show the text (opsional)
407
- *
408
- * @default true if mandatory true
409
- */
410
- showOptionalText?: boolean;
411
-
412
- /**
413
- * Sets the invalid state.
414
- */
415
- invalid?: boolean;
416
-
417
- /**
418
- * Set the custom validator message.
419
- * By default each field has preserved with its validator message, you don't need to worrying about the message.
420
- */
421
- validatorMessage?: string | CustomValidation<'empty'>;
422
-
423
- /**
424
- * Set custom validation message for certain condition
425
- *
426
- * @deprecated - use validatorMessage {@link validatorMessage}
427
- */
428
- customValidation?: CustomValidation;
429
-
430
- /**
431
- * Format of the date. Defaults to PrimeVue Locale configuration.
432
- */
433
- dateFormat?: string | undefined;
434
-
435
- /**
436
- * Specifies hour format.
437
- * @defaultValue 24
438
- */
439
- hourFormat?: '12' | '24' | undefined;
440
-
441
- /**
442
- * Defines the calendar to use hour picker.
443
- */
444
- showTime?: boolean;
445
-
446
- /**
447
- * Separator of time selector.
448
- * @defaultValue :
449
- */
450
- timeSeparator?: string | undefined;
451
-
452
- /**
453
- * Hours to change per step.
454
- * @defaultValue 1
455
- */
456
- stepHour?: number | undefined;
457
-
458
- /**
459
- * Minutes to change per step.
460
- * @defaultValue 1
461
- */
462
- stepMinute?: number | undefined;
463
-
464
- /**
465
- * Formats the hour picker to 12 hour format.
466
- * @default true
467
- *
468
- * @deprecated use {@link hourFormat}
469
- */
470
- useTimeFormat?: boolean;
471
-
472
- /**
473
- * The minimum selectable date.
474
- */
475
- minDate?: Date | undefined;
476
-
477
- /**
478
- * The maximum selectable date.
479
- */
480
- maxDate?: Date | undefined;
481
-
482
- /**
483
- * The maximum selectable year.
484
- *
485
- * The full year: 2020
486
- * @todo Support number, currently only support 'current'
487
- */
488
- maxYear?: 'current' | number | undefined;
489
-
490
- /**
491
- * The maximum selectable months.
492
- *
493
- * Number 0-11
494
- *
495
- * @todo Support number, currently only support 'current'
496
- */
497
- maxMonth?: 'current' | number | undefined;
498
- /**
499
- * When using range selection mode, selecting only the "start date" (without an "end date") will, by default, return a range ending 24 hours later.
500
- * Enabling this prop will instead return the exact dates selected, without adding an extra day.
501
- *
502
- * @example Selecting dates from the 1st to the 5th will return an array of epoch timestamps for each day: [1st, 2nd, 3rd, 4th, 5th].
503
- * @default false
504
- * @requires selectionMode = 'range'
505
- */
506
- exactSelection?: boolean;
268
+ /**
269
+ * Bound value of the component.
270
+ * Supports single or multiple date selection.
271
+ *
272
+ * Used with `v-model`.
273
+ * It should not be used with useValidator. v-model should only be used when the Calendar not used in form
274
+ * @defaultValue null
275
+ */
276
+ modelValue?: Date | Date[] | null;
277
+
278
+ /**
279
+ * Initial date value for pre-filling forms.
280
+ * Typically used for editing existing records.
281
+ *
282
+ * Accepts epoch timestamps in milliseconds.
283
+ *
284
+ * It will only watch for changes once.
285
+ */
286
+ dateValue?: number | number[];
287
+
288
+ /**
289
+ * Epoch time in milliseconds representing the selected date(s).
290
+ *
291
+ * Can be used with `v-model:epochTimeMillis` for two way binding.
292
+ */
293
+ epochTimeMillis?: number | number[];
294
+
295
+ /**
296
+ * Defines the format in which the field value is handled.
297
+ * - `'date'` returns a `Date` object.
298
+ * - `'millis'` returns an epoch timestamp in milliseconds.
299
+ *
300
+ * @default millis
301
+ */
302
+ valueFormat?: 'date' | 'millis';
303
+
304
+ /**
305
+ * Display label on top of Date Input.
306
+ */
307
+ label?: string;
308
+
309
+ /**
310
+ * The input placeholder
311
+ * @default - The value on locale config {@link CalendarLocaleConfig.defaultPlaceholder}
312
+ */
313
+ placeholder?: string;
314
+ disabled?: boolean;
315
+
316
+ /**
317
+ * Make the calendar states readonly.
318
+ * If true, calendar will not allow user interaction with it. But user can view currently selected date and time.
319
+ *
320
+ * @default false
321
+ */
322
+ readonly?: boolean;
323
+
324
+ /**
325
+ * Identifier of the underlying input element.
326
+ */
327
+ inputId?: string | undefined;
328
+
329
+ /**
330
+ * Identifier of the wrapper element.
331
+ */
332
+ id?: string | undefined;
333
+
334
+ /**
335
+ * Whether single date or date range model value.
336
+ *
337
+ * @default 'single'
338
+ * @deprecated use selectionMode
339
+ */
340
+ mode?: 'range' | 'single';
341
+
342
+ /**
343
+ * Whether single date or date range model value.
344
+ *
345
+ * @default 'single'
346
+ */
347
+ selectionMode?: 'range' | 'single';
348
+
349
+ /**
350
+ * Whether to hide the overlay on date selection when showTime is enabled.
351
+ * @defaultValue false
352
+ */
353
+ hideOnDateTimeSelect?: boolean | undefined;
354
+
355
+ /**
356
+ * Whether to hide the overlay on date selection is completed when selectionMode is range.
357
+ * @defaultValue true - when showButtons and showTime false
358
+ * @defaultValue false - when showButtons and showTime true
359
+ */
360
+ hideOnRangeSelection?: boolean | undefined;
361
+
362
+ /**
363
+ * Type of view to display.
364
+ * @defaultValue date
365
+ */
366
+ view?: 'date' | 'month' | 'year' | undefined;
367
+
368
+ /**
369
+ * Wheter show year picker or not
370
+ *
371
+ * @default true
372
+ */
373
+ showYear?: boolean;
374
+
375
+ /**
376
+ * Show button Apply and cancel on footer.
377
+ *
378
+ * If shown, the modelValue will be updated on button Apply clicked.
379
+ *
380
+ * @default false;
381
+ */
382
+ showButtons?: boolean;
383
+
384
+ /**
385
+ * Enable Validator using vee-validate. Combine with Form component that handle form validation.
386
+ */
387
+ useValidator?: boolean;
388
+
389
+ /**
390
+ * When used as field in From Validation using Form component,
391
+ * specify the unique field name, match with your needs for API request.
392
+ */
393
+ fieldName?: string;
394
+
395
+ /**
396
+ * Show information to user about the field.
397
+ */
398
+ fieldInfo?: string;
399
+
400
+ /**
401
+ * Whether this field should be filled or not.
402
+ */
403
+ mandatory?: boolean;
404
+
405
+ /**
406
+ * Show the text (opsional)
407
+ *
408
+ * @default true if mandatory true
409
+ */
410
+ showOptionalText?: boolean;
411
+
412
+ /**
413
+ * Sets the invalid state.
414
+ */
415
+ invalid?: boolean;
416
+
417
+ /**
418
+ * Set the custom validator message.
419
+ * By default each field has preserved with its validator message, you don't need to worrying about the message.
420
+ */
421
+ validatorMessage?: string | CustomValidation<'empty'>;
422
+
423
+ /**
424
+ * Set custom validation message for certain condition
425
+ *
426
+ * @deprecated - use validatorMessage {@link validatorMessage}
427
+ */
428
+ customValidation?: CustomValidation;
429
+
430
+ /**
431
+ * Format of the date. Defaults to PrimeVue Locale configuration.
432
+ */
433
+ dateFormat?: string | undefined;
434
+
435
+ /**
436
+ * Specifies hour format.
437
+ * @defaultValue 24
438
+ */
439
+ hourFormat?: '12' | '24' | undefined;
440
+
441
+ /**
442
+ * Defines the calendar to use hour picker.
443
+ */
444
+ showTime?: boolean;
445
+
446
+ /**
447
+ * Separator of time selector.
448
+ * @defaultValue :
449
+ */
450
+ timeSeparator?: string | undefined;
451
+
452
+ /**
453
+ * Hours to change per step.
454
+ * @defaultValue 1
455
+ */
456
+ stepHour?: number | undefined;
457
+
458
+ /**
459
+ * Minutes to change per step.
460
+ * @defaultValue 1
461
+ */
462
+ stepMinute?: number | undefined;
463
+
464
+ /**
465
+ * Formats the hour picker to 12 hour format.
466
+ * @default true
467
+ *
468
+ * @deprecated use {@link hourFormat}
469
+ */
470
+ useTimeFormat?: boolean;
471
+
472
+ /**
473
+ * The minimum selectable date.
474
+ */
475
+ minDate?: Date | undefined;
476
+
477
+ /**
478
+ * The maximum selectable date.
479
+ */
480
+ maxDate?: Date | undefined;
481
+
482
+ /**
483
+ * The maximum selectable year.
484
+ *
485
+ * The full year: 2020
486
+ * @todo Support number, currently only support 'current'
487
+ */
488
+ maxYear?: 'current' | number | undefined;
489
+
490
+ /**
491
+ * The maximum selectable months.
492
+ *
493
+ * Number 0-11
494
+ *
495
+ * @todo Support number, currently only support 'current'
496
+ */
497
+ maxMonth?: 'current' | number | undefined;
498
+ /**
499
+ * When using range selection mode, selecting only the "start date" (without an "end date") will, by default, return a range ending 24 hours later.
500
+ * Enabling this prop will instead return the exact dates selected, without adding an extra day.
501
+ *
502
+ * @example Selecting dates from the 1st to the 5th will return an array of epoch timestamps for each day: [1st, 2nd, 3rd, 4th, 5th].
503
+ * @default false
504
+ * @requires selectionMode = 'range'
505
+ */
506
+ exactSelection?: boolean;
507
507
  }
508
508
 
509
509
  /**
@@ -511,15 +511,15 @@ export interface CalendarProps {
511
511
  * @see {@link CalendarEmits.monthChange}
512
512
  */
513
513
  export interface CalendarMonthChangeEvent {
514
- /**
515
- * New month.
516
- */
517
- month: number;
518
-
519
- /**
520
- * New year.
521
- */
522
- year: number;
514
+ /**
515
+ * New month.
516
+ */
517
+ month: number;
518
+
519
+ /**
520
+ * New year.
521
+ */
522
+ year: number;
523
523
  }
524
524
 
525
525
  /**
@@ -527,28 +527,28 @@ export interface CalendarMonthChangeEvent {
527
527
  * @see {@link CalendarEmits.yearChange}
528
528
  */
529
529
  export interface CalendarYearChangeEvent {
530
- /**
531
- * New month.
532
- */
533
- month: number;
534
-
535
- /**
536
- * New year.
537
- */
538
- year: number;
530
+ /**
531
+ * New month.
532
+ */
533
+ month: number;
534
+
535
+ /**
536
+ * New year.
537
+ */
538
+ year: number;
539
539
  }
540
540
 
541
541
  /**
542
542
  * Calendar component emits
543
543
  */
544
544
  export type CalendarEmits = {
545
- 'update:modelValue': [
546
- date: Date | Array<Date> | Array<Date | null> | undefined | null,
547
- ];
548
- 'update:epochTimeMillis': [millis?: number | number[]];
549
- 'monthChange': [event: CalendarMonthChangeEvent];
550
- 'yearChange': [event: CalendarYearChangeEvent];
551
- 'dateSelect': [date: Date | Date[]];
545
+ 'update:modelValue': [
546
+ date: Date | Array<Date> | Array<Date | null> | undefined | null,
547
+ ];
548
+ 'update:epochTimeMillis': [millis?: number | number[]];
549
+ 'monthChange': [event: CalendarMonthChangeEvent];
550
+ 'yearChange': [event: CalendarYearChangeEvent];
551
+ 'dateSelect': [date: Date | Date[]];
552
552
  };
553
553
 
554
554
  /**
@@ -562,9 +562,9 @@ export type CalendarEmits = {
562
562
  * @group form
563
563
  */
564
564
  declare class Calendar extends ClassComponent<
565
- CalendarProps,
566
- unknown,
567
- CalendarEmits
565
+ CalendarProps,
566
+ unknown,
567
+ CalendarEmits
568
568
  > {}
569
569
 
570
570
  export default Calendar;