vant 3.5.0 → 3.5.1

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.
@@ -83,6 +83,86 @@
83
83
  "type": "boolean",
84
84
  "description": "If true, the navigation will not leave a history record, Default: `false`"
85
85
  },
86
+ "van-action-sheet/v-model:show": {
87
+ "type": "boolean",
88
+ "description": "Whether to show ActionSheet, Default: `false`"
89
+ },
90
+ "van-action-sheet/actions": {
91
+ "type": "ActionSheetAction[]",
92
+ "description": "Options, Default: `[]`"
93
+ },
94
+ "van-action-sheet/title": {
95
+ "type": "string",
96
+ "description": "Title, Default: -"
97
+ },
98
+ "van-action-sheet/cancel-text": {
99
+ "type": "string",
100
+ "description": "Text of cancel button, Default: -"
101
+ },
102
+ "van-action-sheet/description": {
103
+ "type": "string",
104
+ "description": "Description above the options, Default: -"
105
+ },
106
+ "van-action-sheet/closeable": {
107
+ "type": "boolean",
108
+ "description": "Whether to show close icon, Default: `true`"
109
+ },
110
+ "van-action-sheet/close-icon": {
111
+ "type": "string",
112
+ "description": "Close icon name, Default: `cross`"
113
+ },
114
+ "van-action-sheet/duration": {
115
+ "type": "number | string",
116
+ "description": "Transition duration, unit second, Default: `0.3`"
117
+ },
118
+ "van-action-sheet/round": {
119
+ "type": "boolean",
120
+ "description": "Whether to show round corner, Default: `true`"
121
+ },
122
+ "van-action-sheet/overlay": {
123
+ "type": "boolean",
124
+ "description": "Whether to show overlay, Default: `true`"
125
+ },
126
+ "van-action-sheet/overlay-class": {
127
+ "type": "string | Array | object",
128
+ "description": "Custom overlay class, Default: -"
129
+ },
130
+ "van-action-sheet/overlay-style": {
131
+ "type": "object",
132
+ "description": "Custom overlay style, Default: -"
133
+ },
134
+ "van-action-sheet/lock-scroll": {
135
+ "type": "boolean",
136
+ "description": "Whether to lock background scroll, Default: `true`"
137
+ },
138
+ "van-action-sheet/lazy-render": {
139
+ "type": "boolean",
140
+ "description": "Whether to lazy render util appeared, Default: `true`"
141
+ },
142
+ "van-action-sheet/close-on-popstate": {
143
+ "type": "boolean",
144
+ "description": "Whether to close when popstate, Default: `true`"
145
+ },
146
+ "van-action-sheet/close-on-click-action": {
147
+ "type": "boolean",
148
+ "description": "Whether to close when an action is clicked, Default: `false`"
149
+ },
150
+ "van-action-sheet/close-on-click-overlay": {
151
+ "type": "boolean",
152
+ "description": "Whether to close when overlay is clicked, Default: `true`"
153
+ },
154
+ "van-action-sheet/safe-area-inset-bottom": {
155
+ "type": "boolean",
156
+ "description": "Whether to enable bottom safe area adaptation, Default: `true`"
157
+ },
158
+ "van-action-sheet/teleport": {
159
+ "type": "string | Element",
160
+ "description": "Specifies a target element where ActionSheet will be mounted, Default: -"
161
+ },
162
+ "van-action-sheet/before-close": {
163
+ "type": "(action: string) => boolean | Promise\\<boolean\\>",
164
+ "description": "Callback function before close, Default: -"
165
+ },
86
166
  "van-address-edit/area-list": {
87
167
  "type": "object",
88
168
  "description": "Area List, Default: -"
@@ -171,85 +251,61 @@
171
251
  "type": "(key, val) => string",
172
252
  "description": "Custom validator, Default: -"
173
253
  },
174
- "van-action-sheet/v-model:show": {
175
- "type": "boolean",
176
- "description": "Whether to show ActionSheet, Default: `false`"
177
- },
178
- "van-action-sheet/actions": {
179
- "type": "ActionSheetAction[]",
180
- "description": "Options, Default: `[]`"
181
- },
182
- "van-action-sheet/title": {
183
- "type": "string",
184
- "description": "Title, Default: -"
185
- },
186
- "van-action-sheet/cancel-text": {
187
- "type": "string",
188
- "description": "Text of cancel button, Default: -"
254
+ "van-badge/content": {
255
+ "type": "number | string",
256
+ "description": "Badge content, Default: -"
189
257
  },
190
- "van-action-sheet/description": {
258
+ "van-badge/color": {
191
259
  "type": "string",
192
- "description": "Description above the options, Default: -"
260
+ "description": "Background color, Default: `#ee0a24`"
193
261
  },
194
- "van-action-sheet/closeable": {
262
+ "van-badge/dot": {
195
263
  "type": "boolean",
196
- "description": "Whether to show close icon, Default: `true`"
197
- },
198
- "van-action-sheet/close-icon": {
199
- "type": "string",
200
- "description": "Close icon name, Default: `cross`"
264
+ "description": "Whether to show dot, Default: `false`"
201
265
  },
202
- "van-action-sheet/duration": {
266
+ "van-badge/max": {
203
267
  "type": "number | string",
204
- "description": "Transition duration, unit second, Default: `0.3`"
268
+ "description": "Max value, show `{max}+` when exceed, only works when content is number, Default: -"
205
269
  },
206
- "van-action-sheet/round": {
207
- "type": "boolean",
208
- "description": "Whether to show round corner, Default: `true`"
270
+ "van-badge/offset": {
271
+ "type": "[number | string, number | string]",
272
+ "description": "Offset of badge dot, Default: -"
209
273
  },
210
- "van-action-sheet/overlay": {
274
+ "van-badge/show-zero": {
211
275
  "type": "boolean",
212
- "description": "Whether to show overlay, Default: `true`"
213
- },
214
- "van-action-sheet/overlay-class": {
215
- "type": "string | Array | object",
216
- "description": "Custom overlay class, Default: -"
217
- },
218
- "van-action-sheet/overlay-style": {
219
- "type": "object",
220
- "description": "Custom overlay style, Default: -"
276
+ "description": "Whether to show badge when content is zero, Default: `true`"
221
277
  },
222
- "van-action-sheet/lock-scroll": {
223
- "type": "boolean",
224
- "description": "Whether to lock background scroll, Default: `true`"
278
+ "van-badge/position": {
279
+ "type": "string",
280
+ "description": "Badge position, can be set to `top-left` `bottom-left` `bottom-right`, Default: `top-right`"
225
281
  },
226
- "van-action-sheet/lazy-render": {
227
- "type": "boolean",
228
- "description": "Whether to lazy render util appeared, Default: `true`"
282
+ "van-address-list/v-model": {
283
+ "type": "string",
284
+ "description": "Id of chosen address, Default: -"
229
285
  },
230
- "van-action-sheet/close-on-popstate": {
231
- "type": "boolean",
232
- "description": "Whether to close when popstate, Default: `true`"
286
+ "van-address-list/list": {
287
+ "type": "Address[]",
288
+ "description": "Address list, Default: `[]`"
233
289
  },
234
- "van-action-sheet/close-on-click-action": {
235
- "type": "boolean",
236
- "description": "Whether to close when an action is clicked, Default: `false`"
290
+ "van-address-list/disabled-list": {
291
+ "type": "Address[]",
292
+ "description": "Disabled address list, Default: `[]`"
237
293
  },
238
- "van-action-sheet/close-on-click-overlay": {
239
- "type": "boolean",
240
- "description": "Whether to close when overlay is clicked, Default: `true`"
294
+ "van-address-list/disabled-text": {
295
+ "type": "string",
296
+ "description": "Disabled text, Default: -"
241
297
  },
242
- "van-action-sheet/safe-area-inset-bottom": {
298
+ "van-address-list/switchable": {
243
299
  "type": "boolean",
244
- "description": "Whether to enable bottom safe area adaptation, Default: `true`"
300
+ "description": "Whether to allow switch address, Default: `true`"
245
301
  },
246
- "van-action-sheet/teleport": {
247
- "type": "string | Element",
248
- "description": "Specifies a target element where ActionSheet will be mounted, Default: -"
302
+ "van-address-list/add-button-text": {
303
+ "type": "string",
304
+ "description": "Add button text, Default: `Add new address`"
249
305
  },
250
- "van-action-sheet/before-close": {
251
- "type": "(action: string) => boolean | Promise\\<boolean\\>",
252
- "description": "Callback function before close, Default: -"
306
+ "van-address-list/default-tag-text": {
307
+ "type": "string",
308
+ "description": "Default tag text, Default: -"
253
309
  },
254
310
  "van-area/value": {
255
311
  "type": "string",
@@ -303,62 +359,6 @@
303
359
  "type": "() => boolean",
304
360
  "description": "The method to validate oversea code, Default: -"
305
361
  },
306
- "van-address-list/v-model": {
307
- "type": "string",
308
- "description": "Id of chosen address, Default: -"
309
- },
310
- "van-address-list/list": {
311
- "type": "Address[]",
312
- "description": "Address list, Default: `[]`"
313
- },
314
- "van-address-list/disabled-list": {
315
- "type": "Address[]",
316
- "description": "Disabled address list, Default: `[]`"
317
- },
318
- "van-address-list/disabled-text": {
319
- "type": "string",
320
- "description": "Disabled text, Default: -"
321
- },
322
- "van-address-list/switchable": {
323
- "type": "boolean",
324
- "description": "Whether to allow switch address, Default: `true`"
325
- },
326
- "van-address-list/add-button-text": {
327
- "type": "string",
328
- "description": "Add button text, Default: `Add new address`"
329
- },
330
- "van-address-list/default-tag-text": {
331
- "type": "string",
332
- "description": "Default tag text, Default: -"
333
- },
334
- "van-badge/content": {
335
- "type": "number | string",
336
- "description": "Badge content, Default: -"
337
- },
338
- "van-badge/color": {
339
- "type": "string",
340
- "description": "Background color, Default: `#ee0a24`"
341
- },
342
- "van-badge/dot": {
343
- "type": "boolean",
344
- "description": "Whether to show dot, Default: `false`"
345
- },
346
- "van-badge/max": {
347
- "type": "number | string",
348
- "description": "Max value, show `{max}+` when exceed, only works when content is number, Default: -"
349
- },
350
- "van-badge/offset": {
351
- "type": "[number | string, number | string]",
352
- "description": "Offset of badge dot, Default: -"
353
- },
354
- "van-badge/show-zero": {
355
- "type": "boolean",
356
- "description": "Whether to show badge when content is zero, Default: `true`"
357
- },
358
- "van-badge/position": {
359
- "type": "string",
360
- "description": "Badge position, can be set to `top-left` `bottom-left` `bottom-right`, Default: `top-right`"
361
- },
362
362
  "van-button/type": {
363
363
  "type": "string",
364
364
  "description": "Can be set to `primary` `success` `warning` `danger`, Default: `default`"
@@ -843,59 +843,27 @@
843
843
  "type": "CircleStartPosition",
844
844
  "description": "Progress start position, can be set to `left`、`right`、`bottom`, Default: `top`"
845
845
  },
846
- "van-row/gutter": {
846
+ "van-collapse/v-model": {
847
+ "type": "accordion mode: _number | string_<br>non-accordion mode: _(number | string)[]",
848
+ "description": "Names of current active panels, Default: -"
849
+ },
850
+ "van-collapse/accordion": {
851
+ "type": "boolean",
852
+ "description": "Whether to be accordion mode, Default: `false`"
853
+ },
854
+ "van-collapse/border": {
855
+ "type": "boolean",
856
+ "description": "Whether to show outer border, Default: `true`"
857
+ },
858
+ "van-collapse-item/name": {
847
859
  "type": "number | string",
848
- "description": "Grid spacing(px), Default: -"
860
+ "description": "Name, Default: `index`"
849
861
  },
850
- "van-row/tag": {
862
+ "van-collapse-item/icon": {
851
863
  "type": "string",
852
- "description": "Custom element tag, Default: `div`"
864
+ "description": "Left Icon, Default: -"
853
865
  },
854
- "van-row/justify": {
855
- "type": "string",
856
- "description": "Flex main axis, can be set to end/center/space-around/space-between, Default: `start`"
857
- },
858
- "van-row/align": {
859
- "type": "string",
860
- "description": "Flex cross axis, be set to center/bottom, Default: `top`"
861
- },
862
- "van-row/wrap": {
863
- "type": "boolean",
864
- "description": "Whether to wrap, Default: `true`"
865
- },
866
- "van-col/span": {
867
- "type": "number | string",
868
- "description": "number of column the grid spans, Default: -"
869
- },
870
- "van-col/offset": {
871
- "type": "number | string",
872
- "description": "number of spacing on the left side of the grid, Default: -"
873
- },
874
- "van-col/tag": {
875
- "type": "string",
876
- "description": "Custom element tag, Default: `div`"
877
- },
878
- "van-collapse/v-model": {
879
- "type": "accordion mode: _number | string_<br>non-accordion mode: _(number | string)[]",
880
- "description": "Names of current active panels, Default: -"
881
- },
882
- "van-collapse/accordion": {
883
- "type": "boolean",
884
- "description": "Whether to be accordion mode, Default: `false`"
885
- },
886
- "van-collapse/border": {
887
- "type": "boolean",
888
- "description": "Whether to show outer border, Default: `true`"
889
- },
890
- "van-collapse-item/name": {
891
- "type": "number | string",
892
- "description": "Name, Default: `index`"
893
- },
894
- "van-collapse-item/icon": {
895
- "type": "string",
896
- "description": "Left Icon, Default: -"
897
- },
898
- "van-collapse-item/size": {
866
+ "van-collapse-item/size": {
899
867
  "type": "string",
900
868
  "description": "Title size, can be set to `large`, Default: -"
901
869
  },
@@ -943,6 +911,38 @@
943
911
  "type": "string",
944
912
  "description": "Label className, Default: -"
945
913
  },
914
+ "van-row/gutter": {
915
+ "type": "number | string",
916
+ "description": "Grid spacing(px), Default: -"
917
+ },
918
+ "van-row/tag": {
919
+ "type": "string",
920
+ "description": "Custom element tag, Default: `div`"
921
+ },
922
+ "van-row/justify": {
923
+ "type": "string",
924
+ "description": "Flex main axis, can be set to end/center/space-around/space-between, Default: `start`"
925
+ },
926
+ "van-row/align": {
927
+ "type": "string",
928
+ "description": "Flex cross axis, be set to center/bottom, Default: `top`"
929
+ },
930
+ "van-row/wrap": {
931
+ "type": "boolean",
932
+ "description": "Whether to wrap, Default: `true`"
933
+ },
934
+ "van-col/span": {
935
+ "type": "number | string",
936
+ "description": "number of column the grid spans, Default: -"
937
+ },
938
+ "van-col/offset": {
939
+ "type": "number | string",
940
+ "description": "number of spacing on the left side of the grid, Default: -"
941
+ },
942
+ "van-col/tag": {
943
+ "type": "string",
944
+ "description": "Custom element tag, Default: `div`"
945
+ },
946
946
  "van-config-provider/theme-vars": {
947
947
  "type": "object",
948
948
  "description": "Theme variables, Default: -"
@@ -1035,6 +1035,82 @@
1035
1035
  "type": "boolean",
1036
1036
  "description": "Whether to enable millisecond render, Default: `false`"
1037
1037
  },
1038
+ "van-datetime-picker/type": {
1039
+ "type": "string",
1040
+ "description": "Can be set to `date` `time`<br> `year-month` `month-day` `datehour`, Default: `datetime`"
1041
+ },
1042
+ "van-datetime-picker/title": {
1043
+ "type": "string",
1044
+ "description": "Toolbar title, Default: `''`"
1045
+ },
1046
+ "van-datetime-picker/confirm-button-text": {
1047
+ "type": "string",
1048
+ "description": "Text of confirm button, Default: `Confirm`"
1049
+ },
1050
+ "van-datetime-picker/cancel-button-text": {
1051
+ "type": "string",
1052
+ "description": "Text of cancel button, Default: `Cancel`"
1053
+ },
1054
+ "van-datetime-picker/show-toolbar": {
1055
+ "type": "boolean",
1056
+ "description": "Whether to show toolbar, Default: `true`"
1057
+ },
1058
+ "van-datetime-picker/loading": {
1059
+ "type": "boolean",
1060
+ "description": "Whether to show loading prompt, Default: `false`"
1061
+ },
1062
+ "van-datetime-picker/readonly": {
1063
+ "type": "boolean",
1064
+ "description": "Whether to be readonly, Default: `false`"
1065
+ },
1066
+ "van-datetime-picker/filter": {
1067
+ "type": "(type: string, values: string[]) => string[]",
1068
+ "description": "Option filter, Default: -"
1069
+ },
1070
+ "van-datetime-picker/formatter": {
1071
+ "type": "(type: string, value: string) => string",
1072
+ "description": "Option text formatter, Default: -"
1073
+ },
1074
+ "van-datetime-picker/columns-order": {
1075
+ "type": "string[]",
1076
+ "description": "Array for ordering columns, where item can be set to<br> `year`, `month`, `day`, `hour` and `minute`, Default: -"
1077
+ },
1078
+ "van-datetime-picker/item-height": {
1079
+ "type": "number | string",
1080
+ "description": "Option height, supports `px` `vw` `vh` `rem` unit, default `px`, Default: `44`"
1081
+ },
1082
+ "van-datetime-picker/visible-item-count": {
1083
+ "type": "number | string",
1084
+ "description": "Count of visible columns, Default: `6`"
1085
+ },
1086
+ "van-datetime-picker/swipe-duration": {
1087
+ "type": "number | string",
1088
+ "description": "Duration of the momentum animation, unit `ms`, Default: `1000`"
1089
+ },
1090
+ "van-date-picker/min-date": {
1091
+ "type": "Date",
1092
+ "description": "Min date, Default: Ten years ago on January 1"
1093
+ },
1094
+ "van-date-picker/max-date": {
1095
+ "type": "Date",
1096
+ "description": "Max date, Default: Ten years later on December 31"
1097
+ },
1098
+ "van-time-picker/min-hour": {
1099
+ "type": "number | string",
1100
+ "description": "Min hour for `time` type, Default: `0`"
1101
+ },
1102
+ "van-time-picker/max-hour": {
1103
+ "type": "number | string",
1104
+ "description": "Max hour for `time` type, Default: `23`"
1105
+ },
1106
+ "van-time-picker/min-minute": {
1107
+ "type": "number | string",
1108
+ "description": "Max minute for `time` type, Default: `0`"
1109
+ },
1110
+ "van-time-picker/max-minute": {
1111
+ "type": "number | string",
1112
+ "description": "Max minute for `time` type, Default: `59`"
1113
+ },
1038
1114
  "van-coupon-cell/title": {
1039
1115
  "type": "string",
1040
1116
  "description": "Cell title, Default: `Coupon`"
@@ -1123,82 +1199,6 @@
1123
1199
  "type": "boolean",
1124
1200
  "description": "Whether to show coupon count in tab title, Default: `true`"
1125
1201
  },
1126
- "van-datetime-picker/type": {
1127
- "type": "string",
1128
- "description": "Can be set to `date` `time`<br> `year-month` `month-day` `datehour`, Default: `datetime`"
1129
- },
1130
- "van-datetime-picker/title": {
1131
- "type": "string",
1132
- "description": "Toolbar title, Default: `''`"
1133
- },
1134
- "van-datetime-picker/confirm-button-text": {
1135
- "type": "string",
1136
- "description": "Text of confirm button, Default: `Confirm`"
1137
- },
1138
- "van-datetime-picker/cancel-button-text": {
1139
- "type": "string",
1140
- "description": "Text of cancel button, Default: `Cancel`"
1141
- },
1142
- "van-datetime-picker/show-toolbar": {
1143
- "type": "boolean",
1144
- "description": "Whether to show toolbar, Default: `true`"
1145
- },
1146
- "van-datetime-picker/loading": {
1147
- "type": "boolean",
1148
- "description": "Whether to show loading prompt, Default: `false`"
1149
- },
1150
- "van-datetime-picker/readonly": {
1151
- "type": "boolean",
1152
- "description": "Whether to be readonly, Default: `false`"
1153
- },
1154
- "van-datetime-picker/filter": {
1155
- "type": "(type: string, values: string[]) => string[]",
1156
- "description": "Option filter, Default: -"
1157
- },
1158
- "van-datetime-picker/formatter": {
1159
- "type": "(type: string, value: string) => string",
1160
- "description": "Option text formatter, Default: -"
1161
- },
1162
- "van-datetime-picker/columns-order": {
1163
- "type": "string[]",
1164
- "description": "Array for ordering columns, where item can be set to<br> `year`, `month`, `day`, `hour` and `minute`, Default: -"
1165
- },
1166
- "van-datetime-picker/item-height": {
1167
- "type": "number | string",
1168
- "description": "Option height, supports `px` `vw` `vh` `rem` unit, default `px`, Default: `44`"
1169
- },
1170
- "van-datetime-picker/visible-item-count": {
1171
- "type": "number | string",
1172
- "description": "Count of visible columns, Default: `6`"
1173
- },
1174
- "van-datetime-picker/swipe-duration": {
1175
- "type": "number | string",
1176
- "description": "Duration of the momentum animation, unit `ms`, Default: `1000`"
1177
- },
1178
- "van-date-picker/min-date": {
1179
- "type": "Date",
1180
- "description": "Min date, Default: Ten years ago on January 1"
1181
- },
1182
- "van-date-picker/max-date": {
1183
- "type": "Date",
1184
- "description": "Max date, Default: Ten years later on December 31"
1185
- },
1186
- "van-time-picker/min-hour": {
1187
- "type": "number | string",
1188
- "description": "Min hour for `time` type, Default: `0`"
1189
- },
1190
- "van-time-picker/max-hour": {
1191
- "type": "number | string",
1192
- "description": "Max hour for `time` type, Default: `23`"
1193
- },
1194
- "van-time-picker/min-minute": {
1195
- "type": "number | string",
1196
- "description": "Max minute for `time` type, Default: `0`"
1197
- },
1198
- "van-time-picker/max-minute": {
1199
- "type": "number | string",
1200
- "description": "Max minute for `time` type, Default: `59`"
1201
- },
1202
1202
  "van-dialog/v-model:show": {
1203
1203
  "type": "boolean",
1204
1204
  "description": "Whether to show dialog, Default: -"
@@ -1519,69 +1519,17 @@
1519
1519
  "type": "string",
1520
1520
  "description": "Icon className prefix, Default: `van-icon`"
1521
1521
  },
1522
- "van-field/rules": {
1523
- "type": "FieldRule[]",
1524
- "description": "Form validation rules, Default: -"
1525
- },
1526
- "van-field/autocomplete": {
1527
- "type": "string",
1528
- "description": "HTML native attribute, see [MDN - autocomplete](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete), Default: -"
1529
- },
1530
- "van-field/enterkeyhint": {
1531
- "type": "string",
1532
- "description": "HTML native attribute, see [MDN - enterkeyhint](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint)<br>, Default: -"
1533
- },
1534
- "van-form/label-width": {
1535
- "type": "number | string",
1536
- "description": "Field label width, Default: `6.2em`"
1537
- },
1538
- "van-form/label-align": {
1539
- "type": "string",
1540
- "description": "Field label align, can be set to `center` `right`, Default: `left`"
1541
- },
1542
- "van-form/input-align": {
1543
- "type": "string",
1544
- "description": "Field input align, can be set to `center` `right`, Default: `left`"
1545
- },
1546
- "van-form/error-message-align": {
1547
- "type": "string",
1548
- "description": "Error message align, can be set to `center` `right`, Default: `left`"
1549
- },
1550
- "van-form/validate-trigger": {
1551
- "type": "string | string[]",
1552
- "description": "When to validate the form, can be set to `onChange`、`onSubmit`, supports using array to set multiple values, Default: `onBlur`"
1553
- },
1554
- "van-form/colon": {
1555
- "type": "boolean",
1556
- "description": "Whether to display colon after label, Default: `false`"
1557
- },
1558
- "van-form/disabled": {
1559
- "type": "boolean",
1560
- "description": "Whether to disable form, Default: `false`"
1561
- },
1562
- "van-form/readonly": {
1563
- "type": "boolean",
1564
- "description": "Whether to be readonly, Default: `false`"
1565
- },
1566
- "van-form/validate-first": {
1567
- "type": "boolean",
1568
- "description": "Whether to stop the validation when a rule fails, Default: `false`"
1569
- },
1570
- "van-form/scroll-to-error": {
1571
- "type": "boolean",
1572
- "description": "Whether to scroll to the error field when validation failed, Default: `false`"
1573
- },
1574
- "van-form/show-error": {
1575
- "type": "boolean",
1576
- "description": "Whether to highlight input when validation failed, Default: `false`"
1577
- },
1578
- "van-form/show-error-message": {
1579
- "type": "boolean",
1580
- "description": "Whether to show error message when validation failed, Default: `true`"
1522
+ "van-field/rules": {
1523
+ "type": "FieldRule[]",
1524
+ "description": "Form validation rules, Default: -"
1581
1525
  },
1582
- "van-form/submit-on-enter": {
1583
- "type": "boolean",
1584
- "description": "Whether to submit form on enter, Default: `true`"
1526
+ "van-field/autocomplete": {
1527
+ "type": "string",
1528
+ "description": "HTML native attribute, see [MDN - autocomplete](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete), Default: -"
1529
+ },
1530
+ "van-field/enterkeyhint": {
1531
+ "type": "string",
1532
+ "description": "HTML native attribute, see [MDN - enterkeyhint](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint)<br>, Default: -"
1585
1533
  },
1586
1534
  "van-grid/column-num": {
1587
1535
  "type": "number | string",
@@ -1659,6 +1607,58 @@
1659
1607
  "type": "boolean",
1660
1608
  "description": "If true, the navigation will not leave a history record, Default: `false`"
1661
1609
  },
1610
+ "van-form/label-width": {
1611
+ "type": "number | string",
1612
+ "description": "Field label width, Default: `6.2em`"
1613
+ },
1614
+ "van-form/label-align": {
1615
+ "type": "string",
1616
+ "description": "Field label align, can be set to `center` `right`, Default: `left`"
1617
+ },
1618
+ "van-form/input-align": {
1619
+ "type": "string",
1620
+ "description": "Field input align, can be set to `center` `right`, Default: `left`"
1621
+ },
1622
+ "van-form/error-message-align": {
1623
+ "type": "string",
1624
+ "description": "Error message align, can be set to `center` `right`, Default: `left`"
1625
+ },
1626
+ "van-form/validate-trigger": {
1627
+ "type": "string | string[]",
1628
+ "description": "When to validate the form, can be set to `onChange`、`onSubmit`, supports using array to set multiple values, Default: `onBlur`"
1629
+ },
1630
+ "van-form/colon": {
1631
+ "type": "boolean",
1632
+ "description": "Whether to display colon after label, Default: `false`"
1633
+ },
1634
+ "van-form/disabled": {
1635
+ "type": "boolean",
1636
+ "description": "Whether to disable form, Default: `false`"
1637
+ },
1638
+ "van-form/readonly": {
1639
+ "type": "boolean",
1640
+ "description": "Whether to be readonly, Default: `false`"
1641
+ },
1642
+ "van-form/validate-first": {
1643
+ "type": "boolean",
1644
+ "description": "Whether to stop the validation when a rule fails, Default: `false`"
1645
+ },
1646
+ "van-form/scroll-to-error": {
1647
+ "type": "boolean",
1648
+ "description": "Whether to scroll to the error field when validation failed, Default: `false`"
1649
+ },
1650
+ "van-form/show-error": {
1651
+ "type": "boolean",
1652
+ "description": "Whether to highlight input when validation failed, Default: `false`"
1653
+ },
1654
+ "van-form/show-error-message": {
1655
+ "type": "boolean",
1656
+ "description": "Whether to show error message when validation failed, Default: `true`"
1657
+ },
1658
+ "van-form/submit-on-enter": {
1659
+ "type": "boolean",
1660
+ "description": "Whether to submit form on enter, Default: `true`"
1661
+ },
1662
1662
  "van-icon/name": {
1663
1663
  "type": "string",
1664
1664
  "description": "Icon name or URL, Default: `''`"
@@ -2055,6 +2055,34 @@
2055
2055
  "type": "boolean",
2056
2056
  "description": "Whether to shuffle the order of keys, Default: `false`"
2057
2057
  },
2058
+ "van-overlay/show": {
2059
+ "type": "boolean",
2060
+ "description": "Whether to show overlay, Default: `false`"
2061
+ },
2062
+ "van-overlay/z-index": {
2063
+ "type": "number | string",
2064
+ "description": "z-index, Default: `1`"
2065
+ },
2066
+ "van-overlay/duration": {
2067
+ "type": "number | string",
2068
+ "description": "Animation duration, Default: `0.3`"
2069
+ },
2070
+ "van-overlay/class-name": {
2071
+ "type": "string",
2072
+ "description": "ClassName, Default: -"
2073
+ },
2074
+ "van-overlay/custom-class": {
2075
+ "type": "object",
2076
+ "description": "Custom style, Default: -"
2077
+ },
2078
+ "van-overlay/lock-scroll": {
2079
+ "type": "boolean",
2080
+ "description": "Whether to lock background scroll, Default: `true`"
2081
+ },
2082
+ "van-overlay/lazy-render": {
2083
+ "type": "boolean",
2084
+ "description": "Whether to lazy render util appeared, Default: `true`"
2085
+ },
2058
2086
  "van-pagination/v-model": {
2059
2087
  "type": "number",
2060
2088
  "description": "Current page number, Default: -"
@@ -2091,34 +2119,6 @@
2091
2119
  "type": "boolean",
2092
2120
  "description": "Whether to show ellipses, Default: `false`"
2093
2121
  },
2094
- "van-overlay/show": {
2095
- "type": "boolean",
2096
- "description": "Whether to show overlay, Default: `false`"
2097
- },
2098
- "van-overlay/z-index": {
2099
- "type": "number | string",
2100
- "description": "z-index, Default: `1`"
2101
- },
2102
- "van-overlay/duration": {
2103
- "type": "number | string",
2104
- "description": "Animation duration, Default: `0.3`"
2105
- },
2106
- "van-overlay/class-name": {
2107
- "type": "string",
2108
- "description": "ClassName, Default: -"
2109
- },
2110
- "van-overlay/custom-class": {
2111
- "type": "object",
2112
- "description": "Custom style, Default: -"
2113
- },
2114
- "van-overlay/lock-scroll": {
2115
- "type": "boolean",
2116
- "description": "Whether to lock background scroll, Default: `true`"
2117
- },
2118
- "van-overlay/lazy-render": {
2119
- "type": "boolean",
2120
- "description": "Whether to lazy render util appeared, Default: `true`"
2121
- },
2122
2122
  "van-password-input/value": {
2123
2123
  "type": "string",
2124
2124
  "description": "Password value, Default: `''`"
@@ -2235,153 +2235,33 @@
2235
2235
  "type": "string | Array | object",
2236
2236
  "description": "Custom overlay class, Default: -"
2237
2237
  },
2238
- "van-popover/overlay-style": {
2239
- "type": "object",
2240
- "description": "Custom overlay style, Default: -"
2241
- },
2242
- "van-popover/show-arrow": {
2243
- "type": "boolean",
2244
- "description": "Whether to show arrow, Default: `true`"
2245
- },
2246
- "van-popover/close-on-click-action": {
2247
- "type": "boolean",
2248
- "description": "Whether to close when clicking action, Default: `true`"
2249
- },
2250
- "van-popover/close-on-click-outside": {
2251
- "type": "boolean",
2252
- "description": "Whether to close when clicking outside, Default: `true`"
2253
- },
2254
- "van-popover/close-on-click-overlay": {
2255
- "type": "boolean",
2256
- "description": "Whether to close when clicking overlay, Default: `true`"
2257
- },
2258
- "van-popover/teleport": {
2259
- "type": "string | Element",
2260
- "description": "Specifies a target element where Popover will be mounted, Default: `body`"
2261
- },
2262
- "van-popover/icon-prefix": {
2263
- "type": "string",
2264
- "description": "Icon className prefix, Default: `van-icon`"
2265
- },
2266
- "van-popup/v-model:show": {
2267
- "type": "boolean",
2268
- "description": "Whether to show popup, Default: `false`"
2269
- },
2270
- "van-popup/overlay": {
2271
- "type": "boolean",
2272
- "description": "Whether to show overlay, Default: `true`"
2273
- },
2274
- "van-popup/position": {
2275
- "type": "string",
2276
- "description": "Can be set to `top` `bottom` `right` `left`, Default: `center`"
2277
- },
2278
- "van-popup/overlay-class": {
2279
- "type": "string | Array | object",
2280
- "description": "Custom overlay class, Default: -"
2281
- },
2282
- "van-popup/overlay-style": {
2283
- "type": "object",
2284
- "description": "Custom overlay style, Default: -"
2285
- },
2286
- "van-popup/duration": {
2287
- "type": "number | string",
2288
- "description": "Transition duration, unit second, Default: `0.3`"
2289
- },
2290
- "van-popup/round": {
2291
- "type": "boolean",
2292
- "description": "Whether to show round corner, Default: `false`"
2293
- },
2294
- "van-popup/lock-scroll": {
2295
- "type": "boolean",
2296
- "description": "Whether to lock background scroll, Default: `true`"
2297
- },
2298
- "van-popup/lazy-render": {
2299
- "type": "boolean",
2300
- "description": "Whether to lazy render util appeared, Default: `true`"
2301
- },
2302
- "van-popup/close-on-popstate": {
2303
- "type": "boolean",
2304
- "description": "Whether to close when popstate, Default: `false`"
2305
- },
2306
- "van-popup/close-on-click-overlay": {
2307
- "type": "boolean",
2308
- "description": "Whether to close when overlay is clicked, Default: `true`"
2309
- },
2310
- "van-popup/closeable": {
2311
- "type": "boolean",
2312
- "description": "Whether to show close icon, Default: `false`"
2313
- },
2314
- "van-popup/close-icon": {
2315
- "type": "string",
2316
- "description": "Close icon name, Default: `cross`"
2317
- },
2318
- "van-popup/close-icon-position": {
2319
- "type": "string",
2320
- "description": "Close Icon Position, can be set to `top-left` `bottom-left` `bottom-right`, Default: `top-right`"
2321
- },
2322
- "van-popup/before-close": {
2323
- "type": "(action: string) => boolean | Promise\\<boolean\\>",
2324
- "description": "Callback function before close, Default: -"
2325
- },
2326
- "van-popup/icon-prefix": {
2327
- "type": "string",
2328
- "description": "Icon className prefix, Default: `van-icon`"
2329
- },
2330
- "van-popup/transition": {
2331
- "type": "string",
2332
- "description": "Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition), Default: -"
2333
- },
2334
- "van-popup/transition-appear": {
2335
- "type": "boolean",
2336
- "description": "Whether to apply transition on initial render, Default: `false`"
2337
- },
2338
- "van-popup/teleport": {
2339
- "type": "string | Element",
2340
- "description": "Specifies a target element where Popup will be mounted, Default: -"
2341
- },
2342
- "van-popup/safe-area-inset-top": {
2343
- "type": "boolean",
2344
- "description": "Whether to enable top safe area adaptation, Default: `false`"
2345
- },
2346
- "van-popup/safe-area-inset-bottom": {
2347
- "type": "boolean",
2348
- "description": "Whether to enable bottom safe area adaptation, Default: `false`"
2349
- },
2350
- "van-progress/percentage": {
2351
- "type": "number | string",
2352
- "description": "Percentage, Default: `0`"
2353
- },
2354
- "van-progress/stroke-width": {
2355
- "type": "number | string",
2356
- "description": "Stroke width, Default: `4px`"
2357
- },
2358
- "van-progress/color": {
2359
- "type": "string",
2360
- "description": "Color, Default: `#1989fa`"
2361
- },
2362
- "van-progress/track-color": {
2363
- "type": "string",
2364
- "description": "Track color, Default: `#e5e5e5`"
2365
- },
2366
- "van-progress/pivot-text": {
2367
- "type": "string",
2368
- "description": "Pivot text, Default: percentage"
2369
- },
2370
- "van-progress/pivot-color": {
2371
- "type": "string",
2372
- "description": "Pivot text background color, Default: inherit progress color"
2238
+ "van-popover/overlay-style": {
2239
+ "type": "object",
2240
+ "description": "Custom overlay style, Default: -"
2373
2241
  },
2374
- "van-progress/text-color": {
2375
- "type": "string",
2376
- "description": "Pivot text color, Default: `white`"
2242
+ "van-popover/show-arrow": {
2243
+ "type": "boolean",
2244
+ "description": "Whether to show arrow, Default: `true`"
2377
2245
  },
2378
- "van-progress/inactive": {
2246
+ "van-popover/close-on-click-action": {
2379
2247
  "type": "boolean",
2380
- "description": "Whether to be gray, Default: `false`"
2248
+ "description": "Whether to close when clicking action, Default: `true`"
2381
2249
  },
2382
- "van-progress/show-pivot": {
2250
+ "van-popover/close-on-click-outside": {
2383
2251
  "type": "boolean",
2384
- "description": "Whether to show text, Default: `true`"
2252
+ "description": "Whether to close when clicking outside, Default: `true`"
2253
+ },
2254
+ "van-popover/close-on-click-overlay": {
2255
+ "type": "boolean",
2256
+ "description": "Whether to close when clicking overlay, Default: `true`"
2257
+ },
2258
+ "van-popover/teleport": {
2259
+ "type": "string | Element",
2260
+ "description": "Specifies a target element where Popover will be mounted, Default: `body`"
2261
+ },
2262
+ "van-popover/icon-prefix": {
2263
+ "type": "string",
2264
+ "description": "Icon className prefix, Default: `van-icon`"
2385
2265
  },
2386
2266
  "van-pull-refresh/v-model": {
2387
2267
  "type": "boolean",
@@ -2471,6 +2351,126 @@
2471
2351
  "type": "string",
2472
2352
  "description": "Checked color of all radios, Default: `#1989fa`"
2473
2353
  },
2354
+ "van-progress/percentage": {
2355
+ "type": "number | string",
2356
+ "description": "Percentage, Default: `0`"
2357
+ },
2358
+ "van-progress/stroke-width": {
2359
+ "type": "number | string",
2360
+ "description": "Stroke width, Default: `4px`"
2361
+ },
2362
+ "van-progress/color": {
2363
+ "type": "string",
2364
+ "description": "Color, Default: `#1989fa`"
2365
+ },
2366
+ "van-progress/track-color": {
2367
+ "type": "string",
2368
+ "description": "Track color, Default: `#e5e5e5`"
2369
+ },
2370
+ "van-progress/pivot-text": {
2371
+ "type": "string",
2372
+ "description": "Pivot text, Default: percentage"
2373
+ },
2374
+ "van-progress/pivot-color": {
2375
+ "type": "string",
2376
+ "description": "Pivot text background color, Default: inherit progress color"
2377
+ },
2378
+ "van-progress/text-color": {
2379
+ "type": "string",
2380
+ "description": "Pivot text color, Default: `white`"
2381
+ },
2382
+ "van-progress/inactive": {
2383
+ "type": "boolean",
2384
+ "description": "Whether to be gray, Default: `false`"
2385
+ },
2386
+ "van-progress/show-pivot": {
2387
+ "type": "boolean",
2388
+ "description": "Whether to show text, Default: `true`"
2389
+ },
2390
+ "van-popup/v-model:show": {
2391
+ "type": "boolean",
2392
+ "description": "Whether to show popup, Default: `false`"
2393
+ },
2394
+ "van-popup/overlay": {
2395
+ "type": "boolean",
2396
+ "description": "Whether to show overlay, Default: `true`"
2397
+ },
2398
+ "van-popup/position": {
2399
+ "type": "string",
2400
+ "description": "Can be set to `top` `bottom` `right` `left`, Default: `center`"
2401
+ },
2402
+ "van-popup/overlay-class": {
2403
+ "type": "string | Array | object",
2404
+ "description": "Custom overlay class, Default: -"
2405
+ },
2406
+ "van-popup/overlay-style": {
2407
+ "type": "object",
2408
+ "description": "Custom overlay style, Default: -"
2409
+ },
2410
+ "van-popup/duration": {
2411
+ "type": "number | string",
2412
+ "description": "Transition duration, unit second, Default: `0.3`"
2413
+ },
2414
+ "van-popup/round": {
2415
+ "type": "boolean",
2416
+ "description": "Whether to show round corner, Default: `false`"
2417
+ },
2418
+ "van-popup/lock-scroll": {
2419
+ "type": "boolean",
2420
+ "description": "Whether to lock background scroll, Default: `true`"
2421
+ },
2422
+ "van-popup/lazy-render": {
2423
+ "type": "boolean",
2424
+ "description": "Whether to lazy render util appeared, Default: `true`"
2425
+ },
2426
+ "van-popup/close-on-popstate": {
2427
+ "type": "boolean",
2428
+ "description": "Whether to close when popstate, Default: `false`"
2429
+ },
2430
+ "van-popup/close-on-click-overlay": {
2431
+ "type": "boolean",
2432
+ "description": "Whether to close when overlay is clicked, Default: `true`"
2433
+ },
2434
+ "van-popup/closeable": {
2435
+ "type": "boolean",
2436
+ "description": "Whether to show close icon, Default: `false`"
2437
+ },
2438
+ "van-popup/close-icon": {
2439
+ "type": "string",
2440
+ "description": "Close icon name, Default: `cross`"
2441
+ },
2442
+ "van-popup/close-icon-position": {
2443
+ "type": "string",
2444
+ "description": "Close Icon Position, can be set to `top-left` `bottom-left` `bottom-right`, Default: `top-right`"
2445
+ },
2446
+ "van-popup/before-close": {
2447
+ "type": "(action: string) => boolean | Promise\\<boolean\\>",
2448
+ "description": "Callback function before close, Default: -"
2449
+ },
2450
+ "van-popup/icon-prefix": {
2451
+ "type": "string",
2452
+ "description": "Icon className prefix, Default: `van-icon`"
2453
+ },
2454
+ "van-popup/transition": {
2455
+ "type": "string",
2456
+ "description": "Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition), Default: -"
2457
+ },
2458
+ "van-popup/transition-appear": {
2459
+ "type": "boolean",
2460
+ "description": "Whether to apply transition on initial render, Default: `false`"
2461
+ },
2462
+ "van-popup/teleport": {
2463
+ "type": "string | Element",
2464
+ "description": "Specifies a target element where Popup will be mounted, Default: -"
2465
+ },
2466
+ "van-popup/safe-area-inset-top": {
2467
+ "type": "boolean",
2468
+ "description": "Whether to enable top safe area adaptation, Default: `false`"
2469
+ },
2470
+ "van-popup/safe-area-inset-bottom": {
2471
+ "type": "boolean",
2472
+ "description": "Whether to enable bottom safe area adaptation, Default: `false`"
2473
+ },
2474
2474
  "van-rate/v-model": {
2475
2475
  "type": "number",
2476
2476
  "description": "Current rate, Default: -"
@@ -2819,6 +2819,26 @@
2819
2819
  "type": "boolean",
2820
2820
  "description": "Whether to display slider vertically, Default: `false`"
2821
2821
  },
2822
+ "van-sticky/position": {
2823
+ "type": "string",
2824
+ "description": "Offset position, can be set to `bottom`, Default: `top`"
2825
+ },
2826
+ "van-sticky/offset-top": {
2827
+ "type": "number | string",
2828
+ "description": "Offset top, supports `px` `vw` `vh` `rem` unit, default `px`, Default: `0`"
2829
+ },
2830
+ "van-sticky/offset-bottom": {
2831
+ "type": "number | string",
2832
+ "description": "Offset bottom, supports `px` `vw` `vh` `rem` unit, default `px`, Default: `0`"
2833
+ },
2834
+ "van-sticky/z-index": {
2835
+ "type": "number | string",
2836
+ "description": "z-index when sticky, Default: `99`"
2837
+ },
2838
+ "van-sticky/container": {
2839
+ "type": "Element",
2840
+ "description": "Container DOM, Default: -"
2841
+ },
2822
2842
  "van-stepper/v-model": {
2823
2843
  "type": "number | string",
2824
2844
  "description": "Current value, Default: -"
@@ -2939,26 +2959,6 @@
2939
2959
  "type": "string",
2940
2960
  "description": "Icon className prefix, Default: `van-icon`"
2941
2961
  },
2942
- "van-sticky/position": {
2943
- "type": "string",
2944
- "description": "Offset position, can be set to `bottom`, Default: `top`"
2945
- },
2946
- "van-sticky/offset-top": {
2947
- "type": "number | string",
2948
- "description": "Offset top, supports `px` `vw` `vh` `rem` unit, default `px`, Default: `0`"
2949
- },
2950
- "van-sticky/offset-bottom": {
2951
- "type": "number | string",
2952
- "description": "Offset bottom, supports `px` `vw` `vh` `rem` unit, default `px`, Default: `0`"
2953
- },
2954
- "van-sticky/z-index": {
2955
- "type": "number | string",
2956
- "description": "z-index when sticky, Default: `99`"
2957
- },
2958
- "van-sticky/container": {
2959
- "type": "Element",
2960
- "description": "Container DOM, Default: -"
2961
- },
2962
2962
  "van-submit-bar/price": {
2963
2963
  "type": "number",
2964
2964
  "description": "Price, Default: -"
@@ -3087,6 +3087,38 @@
3087
3087
  "type": "boolean",
3088
3088
  "description": "Whether to stop touchmove event propagation, Default: `false`"
3089
3089
  },
3090
+ "van-switch/v-model": {
3091
+ "type": "ActiveValue | InactiveValue",
3092
+ "description": "Check status of Switch, Default: `false`"
3093
+ },
3094
+ "van-switch/loading": {
3095
+ "type": "boolean",
3096
+ "description": "Whether to show loading icon, Default: `false`"
3097
+ },
3098
+ "van-switch/disabled": {
3099
+ "type": "boolean",
3100
+ "description": "Whether to disable switch, Default: `false`"
3101
+ },
3102
+ "van-switch/size": {
3103
+ "type": "number | string",
3104
+ "description": "Size of switch, Default: `30px`"
3105
+ },
3106
+ "van-switch/active-color": {
3107
+ "type": "string",
3108
+ "description": "Background color when active, Default: `#1989fa`"
3109
+ },
3110
+ "van-switch/inactive-color": {
3111
+ "type": "string",
3112
+ "description": "Background color when inactive, Default: `white`"
3113
+ },
3114
+ "van-switch/active-value": {
3115
+ "type": "any",
3116
+ "description": "Value when active, Default: `true`"
3117
+ },
3118
+ "van-switch/inactive-value": {
3119
+ "type": "any",
3120
+ "description": "Value when inactive, Default: `false`"
3121
+ },
3090
3122
  "van-tabs/v-model:active": {
3091
3123
  "type": "number | string",
3092
3124
  "description": "Index of active tab, Default: `0`"
@@ -3211,38 +3243,6 @@
3211
3243
  "type": "boolean",
3212
3244
  "description": "Whether to show badge when the value is zero, Default: `true`"
3213
3245
  },
3214
- "van-switch/v-model": {
3215
- "type": "ActiveValue | InactiveValue",
3216
- "description": "Check status of Switch, Default: `false`"
3217
- },
3218
- "van-switch/loading": {
3219
- "type": "boolean",
3220
- "description": "Whether to show loading icon, Default: `false`"
3221
- },
3222
- "van-switch/disabled": {
3223
- "type": "boolean",
3224
- "description": "Whether to disable switch, Default: `false`"
3225
- },
3226
- "van-switch/size": {
3227
- "type": "number | string",
3228
- "description": "Size of switch, Default: `30px`"
3229
- },
3230
- "van-switch/active-color": {
3231
- "type": "string",
3232
- "description": "Background color when active, Default: `#1989fa`"
3233
- },
3234
- "van-switch/inactive-color": {
3235
- "type": "string",
3236
- "description": "Background color when inactive, Default: `white`"
3237
- },
3238
- "van-switch/active-value": {
3239
- "type": "any",
3240
- "description": "Value when active, Default: `true`"
3241
- },
3242
- "van-switch/inactive-value": {
3243
- "type": "any",
3244
- "description": "Value when inactive, Default: `false`"
3245
- },
3246
3246
  "van-tabbar/v-model": {
3247
3247
  "type": "number | string",
3248
3248
  "description": "Identifier of current tab, Default: `0`"