@wangxinowo/vue-datepicker-next 1.0.5 → 1.0.7

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.
package/README.md CHANGED
@@ -1,510 +1,510 @@
1
- # Vue DatePicker Next
2
-
3
- [![npm version](https://img.shields.io/npm/v/@wangxinowo/vue-datepicker-next.svg)](https://www.npmjs.com/package/@wangxinowo/vue-datepicker-next)
4
- [![license](https://img.shields.io/npm/l/@wangxinowo/vue-datepicker-next.svg)](https://github.com/wangxinowo/vue-datepicker-next/blob/main/LICENSE)
5
-
6
- 一款功能强大的 Vue 2.x 日期选择器组件,基于 Ant Design Vue 设计风格,提供增强的功能特性。
7
-
8
- ## 特性
9
-
10
- - 📅 **多种选择器类型** - DatePicker、RangePicker、MonthPicker、WeekPicker
11
- - 🎯 **预设快捷选项** - 支持自定义预设范围,快速选择常用日期
12
- - 🔄 **双日期库支持** - 同时支持 moment.js 和 dayjs
13
- - 📆 **灵活的选择模式** - date / week / month / quarter / year
14
- - ✅ **表单状态集成** - 支持 error / warning / success 验证状态
15
- - 🎨 **可定制外观** - 无边框模式、自定义弹出位置
16
- - 🌍 **国际化** - 内置 50+ 种语言支持
17
- - 📝 **TypeScript** - 完整的类型定义文件
18
-
19
- ## 安装
20
-
21
- ```bash
22
- # 使用 npm
23
- npm install @wangxinowo/vue-datepicker-next moment
24
-
25
- # 使用 yarn
26
- yarn add @wangxinowo/vue-datepicker-next moment
27
-
28
- # 使用 pnpm
29
- pnpm add @wangxinowo/vue-datepicker-next moment
30
- ```
31
-
32
- ## 快速开始
33
-
34
- ### 全局注册
35
-
36
- ```javascript
37
- import Vue from 'vue';
38
- import moment from 'moment';
39
- import 'moment/locale/zh-cn'; // 导入中文语言包
40
- import VueDatepickerNext from '@wangxinowo/vue-datepicker-next';
41
- import '@wangxinowo/vue-datepicker-next/dist/vue-datepicker-next.min.css';
42
-
43
- // 设置 moment 全局语言为中文(必须,否则月份等会显示英文)
44
- moment.locale('zh-cn');
45
-
46
- Vue.use(VueDatepickerNext);
47
-
48
- // 组件将自动注册为:
49
- // <a-date-picker>
50
- // <a-range-picker>
51
- // <a-month-picker>
52
- // <a-week-picker>
53
- ```
54
-
55
- ### 局部注册
56
-
57
- ```javascript
58
- import { DatePicker, RangePicker, MonthPicker, WeekPicker } from '@wangxinowo/vue-datepicker-next';
59
- import '@wangxinowo/vue-datepicker-next/dist/vue-datepicker-next.min.css';
60
-
61
- export default {
62
- components: {
63
- ADatePicker: DatePicker,
64
- ARangePicker: RangePicker,
65
- AMonthPicker: MonthPicker,
66
- AWeekPicker: WeekPicker,
67
- },
68
- };
69
- ```
70
-
71
- ## 使用示例
72
-
73
- ### 基础 DatePicker
74
-
75
- ```html
76
- <template>
77
- <div>
78
- <a-date-picker
79
- v-model="date"
80
- placeholder="选择日期"
81
- @change="onChange"
82
- />
83
- <p>选中日期: {{ date ? date.format('YYYY-MM-DD') : '未选择' }}</p>
84
- </div>
85
- </template>
86
-
87
- <script>
88
- export default {
89
- data() {
90
- return {
91
- date: null,
92
- };
93
- },
94
- methods: {
95
- onChange(date, dateString) {
96
- console.log('选中日期:', date, dateString);
97
- },
98
- },
99
- };
100
- </script>
101
- ```
102
-
103
- ### RangePicker 日期范围选择
104
-
105
- ```html
106
- <template>
107
- <div>
108
- <a-range-picker
109
- v-model="dateRange"
110
- :placeholder="['开始日期', '结束日期']"
111
- @change="onRangeChange"
112
- />
113
- </div>
114
- </template>
115
-
116
- <script>
117
- export default {
118
- data() {
119
- return {
120
- dateRange: [],
121
- };
122
- },
123
- methods: {
124
- onRangeChange(dates, dateStrings) {
125
- console.log('日期范围:', dates, dateStrings);
126
- },
127
- },
128
- };
129
- </script>
130
- ```
131
-
132
- ### 预设快捷选项 (presets)
133
-
134
- ```html
135
- <template>
136
- <a-range-picker v-model="dateRange" :presets="presets" />
137
- </template>
138
-
139
- <script>
140
- import moment from 'moment';
141
-
142
- export default {
143
- data() {
144
- return {
145
- dateRange: [],
146
- presets: [
147
- { label: '今天', value: [moment(), moment()] },
148
- { label: '本周', value: [moment().startOf('week'), moment().endOf('week')] },
149
- { label: '本月', value: [moment().startOf('month'), moment().endOf('month')] },
150
- { label: '最近7天', value: () => [moment().subtract(7, 'days'), moment()] },
151
- { label: '最近30天', value: () => [moment().subtract(30, 'days'), moment()] },
152
- { label: '最近3个月', value: () => [moment().subtract(3, 'months'), moment()] },
153
- ],
154
- };
155
- },
156
- };
157
- </script>
158
- ```
159
-
160
- ### 不同选择器模式 (picker)
161
-
162
- 支持:`date` | `week` | `month` | `quarter` | `year`
163
-
164
- ```html
165
- <template>
166
- <div>
167
- <!-- 年份范围选择 -->
168
- <a-range-picker picker="year" placeholder="选择年份范围" />
169
-
170
- <!-- 月份范围选择 -->
171
- <a-range-picker picker="month" placeholder="选择月份范围" />
172
-
173
- <!-- 周范围选择 -->
174
- <a-range-picker picker="week" placeholder="选择周范围" />
175
-
176
- <!-- 季度范围选择 -->
177
- <a-range-picker picker="quarter" placeholder="选择季度范围" />
178
- </div>
179
- </template>
180
- ```
181
-
182
- ### 表单验证状态 (status)
183
-
184
- ```html
185
- <template>
186
- <div>
187
- <a-range-picker status="error" placeholder="错误状态" />
188
- <a-range-picker status="warning" placeholder="警告状态" />
189
- <a-range-picker status="success" placeholder="成功状态" />
190
- </div>
191
- </template>
192
- ```
193
-
194
- ### 弹出位置 (placement)
195
-
196
- 支持:`bottomLeft` | `bottomRight` | `topLeft` | `topRight`
197
-
198
- ```html
199
- <template>
200
- <div>
201
- <a-range-picker placement="topLeft" />
202
- <a-range-picker placement="topRight" />
203
- <a-range-picker placement="bottomRight" />
204
- </div>
205
- </template>
206
- ```
207
-
208
- ### 无边框模式
209
-
210
- ```html
211
- <template>
212
- <a-range-picker :bordered="false" />
213
- </template>
214
- ```
215
-
216
- ### MonthPicker 月份选择
217
-
218
- ```html
219
- <template>
220
- <div>
221
- <a-month-picker v-model="month" placeholder="选择月份" />
222
- <p>选中月份: {{ month ? month.format('YYYY-MM') : '未选择' }}</p>
223
- </div>
224
- </template>
225
-
226
- <script>
227
- export default {
228
- data() {
229
- return {
230
- month: null,
231
- };
232
- },
233
- };
234
- </script>
235
- ```
236
-
237
- ### WeekPicker 周选择
238
-
239
- ```html
240
- <template>
241
- <div>
242
- <a-week-picker v-model="week" placeholder="选择周" />
243
- <p>选中周: {{ week ? week.format('YYYY-wo') : '未选择' }}</p>
244
- </div>
245
- </template>
246
-
247
- <script>
248
- export default {
249
- data() {
250
- return {
251
- week: null,
252
- };
253
- },
254
- };
255
- </script>
256
- ```
257
-
258
- ### 带时间选择
259
-
260
- ```html
261
- <template>
262
- <a-date-picker
263
- v-model="datetime"
264
- :show-time="{ format: 'HH:mm:ss' }"
265
- format="YYYY-MM-DD HH:mm:ss"
266
- placeholder="选择日期时间"
267
- />
268
- </template>
269
-
270
- <script>
271
- export default {
272
- data() {
273
- return {
274
- datetime: null,
275
- };
276
- },
277
- };
278
- </script>
279
- ```
280
-
281
- ### 禁用日期
282
-
283
- ```html
284
- <template>
285
- <a-date-picker
286
- :disabled-date="disabledDate"
287
- placeholder="禁用今天之前的日期"
288
- />
289
- </template>
290
-
291
- <script>
292
- import moment from 'moment';
293
-
294
- export default {
295
- methods: {
296
- disabledDate(current) {
297
- // 禁用今天之前的所有日期
298
- return current && current < moment().startOf('day');
299
- },
300
- },
301
- };
302
- </script>
303
- ```
304
-
305
- ## API 文档
306
-
307
- ### 通用 Props
308
-
309
- 以下 props 适用于所有日期选择器组件:
310
-
311
- | 属性 | 说明 | 类型 | 默认值 |
312
- | --- | --- | --- | --- |
313
- | value / v-model | 绑定值 | Moment | - |
314
- | defaultValue | 默认日期 | Moment | - |
315
- | defaultPickerValue | 默认面板日期 | Moment | - |
316
- | format | 日期格式化 | string \| string[] \| function | `YYYY-MM-DD` |
317
- | disabled | 禁用 | boolean | false |
318
- | allowClear | 允许清除 | boolean | true |
319
- | placeholder | 输入框占位文本 | string | - |
320
- | size | 尺寸 | `large` \| `default` \| `small` | `default` |
321
- | suffixIcon | 后缀图标 | VNode \| slot | - |
322
- | locale | 国际化配置 | object | - |
323
- | open | 控制弹层显示 | boolean | - |
324
- | disabledDate | 禁用日期 | (currentDate: Moment) => boolean | - |
325
- | showToday | 显示今天按钮 | boolean | true |
326
- | inputReadOnly | 输入框只读 | boolean | false |
327
- | valueFormat | 绑定值的格式 | string | - |
328
- | getCalendarContainer | 浮层容器 | (trigger: HTMLElement) => HTMLElement | - |
329
-
330
- ### DatePicker Props
331
-
332
- | 属性 | 说明 | 类型 | 默认值 |
333
- | --- | --- | --- | --- |
334
- | showTime | 增加时间选择功能 | boolean \| object | false |
335
- | disabledTime | 不可选择的时间 | (date: Moment) => object | - |
336
- | mode | 日期面板的状态 | `time` \| `date` \| `month` \| `year` \| `decade` | `date` |
337
- | renderExtraFooter | 额外的页脚 | () => VNode \| slot | - |
338
-
339
- ### RangePicker Props
340
-
341
- | 属性 | 说明 | 类型 | 默认值 |
342
- | --- | --- | --- | --- |
343
- | value / v-model | 绑定值 | [Moment, Moment] | - |
344
- | placeholder | 输入框占位文本 | [string, string] | ['开始日期', '结束日期'] |
345
- | showTime | 增加时间选择功能 | boolean \| object | false |
346
- | disabledTime | 不可选择的时间 | (dates, partial) => object | - |
347
- | separator | 分隔符 | string \| VNode | `~` |
348
- | mode | 日期面板的状态 | string \| string[] | - |
349
- | renderExtraFooter | 额外的页脚 | () => VNode \| slot | - |
350
- | **presets** | 预设时间范围快捷选择 | Array<{ label: string \| VNode, value: [Moment, Moment] \| () => [Moment, Moment] }> | - |
351
- | **picker** | 选择器类型 | `date` \| `week` \| `month` \| `quarter` \| `year` | `date` |
352
- | **placement** | 弹出位置 | `bottomLeft` \| `bottomRight` \| `topLeft` \| `topRight` | `bottomLeft` |
353
- | **status** | 校验状态 | `error` \| `warning` \| `success` \| `validating` | - |
354
- | **bordered** | 是否显示边框 | boolean | true |
355
- | **allowEmpty** | 允许部分为空 | [boolean, boolean] | [false, false] |
356
- | ranges | 预设范围 (已废弃,请用 presets) | object | - |
357
-
358
- ### MonthPicker Props
359
-
360
- | 属性 | 说明 | 类型 | 默认值 |
361
- | --- | --- | --- | --- |
362
- | placeholder | 输入框占位文本 | string | '请选择月份' |
363
- | monthCellContentRender | 自定义月份单元格内容 | (date: Moment, locale: string) => VNode | - |
364
-
365
- ### WeekPicker Props
366
-
367
- | 属性 | 说明 | 类型 | 默认值 |
368
- | --- | --- | --- | --- |
369
- | placeholder | 输入框占位文本 | string | '请选择周' |
370
-
371
- ### 事件
372
-
373
- | 事件名 | 说明 | 回调参数 |
374
- | --- | --- | --- |
375
- | change | 日期变化时触发 | (date: Moment \| [Moment, Moment], dateString: string \| [string, string]) |
376
- | panelChange | 日期面板变化时触发 | (value: Moment \| [Moment, Moment], mode: string \| string[]) |
377
- | ok | 点击确定按钮时触发 (showTime 时有效) | (date: Moment \| [Moment, Moment]) |
378
- | openChange | 弹出/关闭日历时触发 | (open: boolean) |
379
- | focus | 获取焦点时触发 | (e: FocusEvent) |
380
- | blur | 失去焦点时触发 | (e: FocusEvent) |
381
- | calendarChange | RangePicker 专属:待选日期变化时触发 | (dates: [Moment, Moment], dateStrings: [string, string]) |
382
-
383
- ### 插槽
384
-
385
- | 插槽名 | 说明 |
386
- | --- | --- |
387
- | suffixIcon | 自定义后缀图标 |
388
- | renderExtraFooter | 自定义额外页脚 |
389
- | dateRender | 自定义日期单元格内容 |
390
-
391
- ## 使用 dayjs 替代 moment
392
-
393
- > **注意**:当前版本的日历核心组件仍依赖 moment.js,dayjs 适配器功能不完整。即使配置了 dayjs,月份、星期等名称仍需要 moment 的 locale 支持。建议直接使用 moment.js。
394
-
395
- 本组件默认使用 moment.js,但也提供了 dayjs 适配器(实验性):
396
-
397
- ```javascript
398
- import { setGenerateConfig, dayjsGenerateConfig } from '@wangxinowo/vue-datepicker-next';
399
-
400
- // 切换到 dayjs(注意:仍需配置 moment locale)
401
- setGenerateConfig(dayjsGenerateConfig);
402
- ```
403
-
404
- 使用 dayjs 时需要确保安装了必要的插件(组件会自动加载):
405
-
406
- ```bash
407
- npm install dayjs
408
- ```
409
-
410
- ## 国际化
411
-
412
- 组件内置了 50+ 种语言支持。
413
-
414
- > **重要提示**:组件内部依赖 moment.js 来显示月份、星期等名称。仅设置组件的 `locale` prop 是不够的,**必须同时设置 moment 的全局语言**,否则会出现中英文混杂的情况。
415
-
416
- | 语言 | 代码 | moment locale |
417
- | --- | --- | --- |
418
- | 简体中文 | zh_CN | zh-cn |
419
- | 繁体中文 | zh_TW | zh-tw |
420
- | 英语 (美国) | en_US | en |
421
- | 英语 (英国) | en_GB | en-gb |
422
- | 日语 | ja_JP | ja |
423
- | 韩语 | ko_KR | ko |
424
- | 法语 | fr_FR | fr |
425
- | 德语 | de_DE | de |
426
- | 西班牙语 | es_ES | es |
427
- | 俄语 | ru_RU | ru |
428
- | ... | ... | ... |
429
-
430
- ### 使用方法
431
-
432
- ```javascript
433
- // 1. 导入 moment 及对应语言包
434
- import moment from 'moment';
435
- import 'moment/locale/zh-cn';
436
-
437
- // 2. 设置 moment 全局语言(必须!)
438
- moment.locale('zh-cn');
439
-
440
- // 3. 导入组件 locale 配置
441
- import zhCN from '@wangxinowo/vue-datepicker-next/src/components/date-picker/locale/zh_CN';
442
-
443
- // 4. 在组件中使用
444
- <a-date-picker :locale="zhCN" />
445
- ```
446
-
447
- ### 全局配置
448
-
449
- ```javascript
450
- import Vue from 'vue';
451
- import moment from 'moment';
452
- import 'moment/locale/zh-cn';
453
- import VueDatepickerNext from '@wangxinowo/vue-datepicker-next';
454
- import zhCN from '@wangxinowo/vue-datepicker-next/src/components/date-picker/locale/zh_CN';
455
-
456
- // 必须:设置 moment 全局语言
457
- moment.locale('zh-cn');
458
-
459
- Vue.use(VueDatepickerNext, {
460
- locale: zhCN,
461
- });
462
- ```
463
-
464
- ## TypeScript 支持
465
-
466
- 本组件提供完整的 TypeScript 类型定义:
467
-
468
- ```typescript
469
- import { DatePicker, RangePicker, MonthPicker, WeekPicker } from '@wangxinowo/vue-datepicker-next';
470
- import type { DatePickerProps, RangePickerProps, MonthPickerProps, WeekPickerProps } from '@wangxinowo/vue-datepicker-next';
471
- import type { Moment } from 'moment';
472
-
473
- // 类型安全的使用
474
- const dateValue: Moment | null = null;
475
- const rangeValue: [Moment, Moment] | null = null;
476
- ```
477
-
478
- ## 更新日志
479
-
480
- ### 1.0.5 (最新)
481
- - 更新版本和文档增强
482
-
483
- ### 1.0.3
484
- - 年份和月份范围选择器添加选中范围背景效果
485
-
486
- ### 1.0.0
487
- - 新增 `presets` 属性,支持预设时间范围快捷选择
488
- - 新增 `picker` 属性,支持 date/week/month/quarter/year 模式
489
- - 新增 `placement` 属性,支持弹出位置配置
490
- - 新增 `status` 属性,支持表单验证状态
491
- - 新增 `bordered` 属性,支持无边框模式
492
- - 新增 `allowEmpty` 属性,允许部分为空
493
- - 优化 RangePicker 输入框样式
494
- - 默认本地化配置改为中文
495
-
496
- ## 浏览器兼容性
497
-
498
- | Chrome | Firefox | Safari | Edge | IE |
499
- | --- | --- | --- | --- | --- |
500
- | ✓ | ✓ | ✓ | ✓ | 11+ |
501
-
502
- ## 许可证
503
-
504
- [MIT](./LICENSE)
505
-
506
- ## 相关链接
507
-
508
- - [GitHub 仓库](https://github.com/wangxinowo/vue-datepicker-next)
509
- - [NPM 包](https://www.npmjs.com/package/@wangxinowo/vue-datepicker-next)
510
- - [Ant Design Vue](https://www.antdv.com/)
1
+ # Vue DatePicker Next
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@wangxinowo/vue-datepicker-next.svg)](https://www.npmjs.com/package/@wangxinowo/vue-datepicker-next)
4
+ [![license](https://img.shields.io/npm/l/@wangxinowo/vue-datepicker-next.svg)](https://github.com/wangxinowo/vue-datepicker-next/blob/main/LICENSE)
5
+
6
+ 一款功能强大的 Vue 2.x 日期选择器组件,基于 Ant Design Vue 设计风格,提供增强的功能特性。
7
+
8
+ ## 特性
9
+
10
+ - 📅 **多种选择器类型** - DatePicker、RangePicker、MonthPicker、WeekPicker
11
+ - 🎯 **预设快捷选项** - 支持自定义预设范围,快速选择常用日期
12
+ - 🔄 **双日期库支持** - 同时支持 moment.js 和 dayjs
13
+ - 📆 **灵活的选择模式** - date / week / month / quarter / year
14
+ - ✅ **表单状态集成** - 支持 error / warning / success 验证状态
15
+ - 🎨 **可定制外观** - 无边框模式、自定义弹出位置
16
+ - 🌍 **国际化** - 内置 50+ 种语言支持
17
+ - 📝 **TypeScript** - 完整的类型定义文件
18
+
19
+ ## 安装
20
+
21
+ ```bash
22
+ # 使用 npm
23
+ npm install @wangxinowo/vue-datepicker-next moment
24
+
25
+ # 使用 yarn
26
+ yarn add @wangxinowo/vue-datepicker-next moment
27
+
28
+ # 使用 pnpm
29
+ pnpm add @wangxinowo/vue-datepicker-next moment
30
+ ```
31
+
32
+ ## 快速开始
33
+
34
+ ### 全局注册
35
+
36
+ ```javascript
37
+ import Vue from 'vue';
38
+ import moment from 'moment';
39
+ import 'moment/locale/zh-cn'; // 导入中文语言包
40
+ import VueDatepickerNext from '@wangxinowo/vue-datepicker-next';
41
+ import '@wangxinowo/vue-datepicker-next/dist/vue-datepicker-next.min.css';
42
+
43
+ // 设置 moment 全局语言为中文(必须,否则月份等会显示英文)
44
+ moment.locale('zh-cn');
45
+
46
+ Vue.use(VueDatepickerNext);
47
+
48
+ // 组件将自动注册为:
49
+ // <a-date-picker>
50
+ // <a-range-picker>
51
+ // <a-month-picker>
52
+ // <a-week-picker>
53
+ ```
54
+
55
+ ### 局部注册
56
+
57
+ ```javascript
58
+ import { DatePicker, RangePicker, MonthPicker, WeekPicker } from '@wangxinowo/vue-datepicker-next';
59
+ import '@wangxinowo/vue-datepicker-next/dist/vue-datepicker-next.min.css';
60
+
61
+ export default {
62
+ components: {
63
+ ADatePicker: DatePicker,
64
+ ARangePicker: RangePicker,
65
+ AMonthPicker: MonthPicker,
66
+ AWeekPicker: WeekPicker,
67
+ },
68
+ };
69
+ ```
70
+
71
+ ## 使用示例
72
+
73
+ ### 基础 DatePicker
74
+
75
+ ```html
76
+ <template>
77
+ <div>
78
+ <a-date-picker
79
+ v-model="date"
80
+ placeholder="选择日期"
81
+ @change="onChange"
82
+ />
83
+ <p>选中日期: {{ date ? date.format('YYYY-MM-DD') : '未选择' }}</p>
84
+ </div>
85
+ </template>
86
+
87
+ <script>
88
+ export default {
89
+ data() {
90
+ return {
91
+ date: null,
92
+ };
93
+ },
94
+ methods: {
95
+ onChange(date, dateString) {
96
+ console.log('选中日期:', date, dateString);
97
+ },
98
+ },
99
+ };
100
+ </script>
101
+ ```
102
+
103
+ ### RangePicker 日期范围选择
104
+
105
+ ```html
106
+ <template>
107
+ <div>
108
+ <a-range-picker
109
+ v-model="dateRange"
110
+ :placeholder="['开始日期', '结束日期']"
111
+ @change="onRangeChange"
112
+ />
113
+ </div>
114
+ </template>
115
+
116
+ <script>
117
+ export default {
118
+ data() {
119
+ return {
120
+ dateRange: [],
121
+ };
122
+ },
123
+ methods: {
124
+ onRangeChange(dates, dateStrings) {
125
+ console.log('日期范围:', dates, dateStrings);
126
+ },
127
+ },
128
+ };
129
+ </script>
130
+ ```
131
+
132
+ ### 预设快捷选项 (presets)
133
+
134
+ ```html
135
+ <template>
136
+ <a-range-picker v-model="dateRange" :presets="presets" />
137
+ </template>
138
+
139
+ <script>
140
+ import moment from 'moment';
141
+
142
+ export default {
143
+ data() {
144
+ return {
145
+ dateRange: [],
146
+ presets: [
147
+ { label: '今天', value: [moment(), moment()] },
148
+ { label: '本周', value: [moment().startOf('week'), moment().endOf('week')] },
149
+ { label: '本月', value: [moment().startOf('month'), moment().endOf('month')] },
150
+ { label: '最近7天', value: () => [moment().subtract(7, 'days'), moment()] },
151
+ { label: '最近30天', value: () => [moment().subtract(30, 'days'), moment()] },
152
+ { label: '最近3个月', value: () => [moment().subtract(3, 'months'), moment()] },
153
+ ],
154
+ };
155
+ },
156
+ };
157
+ </script>
158
+ ```
159
+
160
+ ### 不同选择器模式 (picker)
161
+
162
+ 支持:`date` | `week` | `month` | `quarter` | `year`
163
+
164
+ ```html
165
+ <template>
166
+ <div>
167
+ <!-- 年份范围选择 -->
168
+ <a-range-picker picker="year" placeholder="选择年份范围" />
169
+
170
+ <!-- 月份范围选择 -->
171
+ <a-range-picker picker="month" placeholder="选择月份范围" />
172
+
173
+ <!-- 周范围选择 -->
174
+ <a-range-picker picker="week" placeholder="选择周范围" />
175
+
176
+ <!-- 季度范围选择 -->
177
+ <a-range-picker picker="quarter" placeholder="选择季度范围" />
178
+ </div>
179
+ </template>
180
+ ```
181
+
182
+ ### 表单验证状态 (status)
183
+
184
+ ```html
185
+ <template>
186
+ <div>
187
+ <a-range-picker status="error" placeholder="错误状态" />
188
+ <a-range-picker status="warning" placeholder="警告状态" />
189
+ <a-range-picker status="success" placeholder="成功状态" />
190
+ </div>
191
+ </template>
192
+ ```
193
+
194
+ ### 弹出位置 (placement)
195
+
196
+ 支持:`bottomLeft` | `bottomRight` | `topLeft` | `topRight`
197
+
198
+ ```html
199
+ <template>
200
+ <div>
201
+ <a-range-picker placement="topLeft" />
202
+ <a-range-picker placement="topRight" />
203
+ <a-range-picker placement="bottomRight" />
204
+ </div>
205
+ </template>
206
+ ```
207
+
208
+ ### 无边框模式
209
+
210
+ ```html
211
+ <template>
212
+ <a-range-picker :bordered="false" />
213
+ </template>
214
+ ```
215
+
216
+ ### MonthPicker 月份选择
217
+
218
+ ```html
219
+ <template>
220
+ <div>
221
+ <a-month-picker v-model="month" placeholder="选择月份" />
222
+ <p>选中月份: {{ month ? month.format('YYYY-MM') : '未选择' }}</p>
223
+ </div>
224
+ </template>
225
+
226
+ <script>
227
+ export default {
228
+ data() {
229
+ return {
230
+ month: null,
231
+ };
232
+ },
233
+ };
234
+ </script>
235
+ ```
236
+
237
+ ### WeekPicker 周选择
238
+
239
+ ```html
240
+ <template>
241
+ <div>
242
+ <a-week-picker v-model="week" placeholder="选择周" />
243
+ <p>选中周: {{ week ? week.format('YYYY-wo') : '未选择' }}</p>
244
+ </div>
245
+ </template>
246
+
247
+ <script>
248
+ export default {
249
+ data() {
250
+ return {
251
+ week: null,
252
+ };
253
+ },
254
+ };
255
+ </script>
256
+ ```
257
+
258
+ ### 带时间选择
259
+
260
+ ```html
261
+ <template>
262
+ <a-date-picker
263
+ v-model="datetime"
264
+ :show-time="{ format: 'HH:mm:ss' }"
265
+ format="YYYY-MM-DD HH:mm:ss"
266
+ placeholder="选择日期时间"
267
+ />
268
+ </template>
269
+
270
+ <script>
271
+ export default {
272
+ data() {
273
+ return {
274
+ datetime: null,
275
+ };
276
+ },
277
+ };
278
+ </script>
279
+ ```
280
+
281
+ ### 禁用日期
282
+
283
+ ```html
284
+ <template>
285
+ <a-date-picker
286
+ :disabled-date="disabledDate"
287
+ placeholder="禁用今天之前的日期"
288
+ />
289
+ </template>
290
+
291
+ <script>
292
+ import moment from 'moment';
293
+
294
+ export default {
295
+ methods: {
296
+ disabledDate(current) {
297
+ // 禁用今天之前的所有日期
298
+ return current && current < moment().startOf('day');
299
+ },
300
+ },
301
+ };
302
+ </script>
303
+ ```
304
+
305
+ ## API 文档
306
+
307
+ ### 通用 Props
308
+
309
+ 以下 props 适用于所有日期选择器组件:
310
+
311
+ | 属性 | 说明 | 类型 | 默认值 |
312
+ | --- | --- | --- | --- |
313
+ | value / v-model | 绑定值 | Moment | - |
314
+ | defaultValue | 默认日期 | Moment | - |
315
+ | defaultPickerValue | 默认面板日期 | Moment | - |
316
+ | format | 日期格式化 | string \| string[] \| function | `YYYY-MM-DD` |
317
+ | disabled | 禁用 | boolean | false |
318
+ | allowClear | 允许清除 | boolean | true |
319
+ | placeholder | 输入框占位文本 | string | - |
320
+ | size | 尺寸 | `large` \| `default` \| `small` | `default` |
321
+ | suffixIcon | 后缀图标 | VNode \| slot | - |
322
+ | locale | 国际化配置 | object | - |
323
+ | open | 控制弹层显示 | boolean | - |
324
+ | disabledDate | 禁用日期 | (currentDate: Moment) => boolean | - |
325
+ | showToday | 显示今天按钮 | boolean | true |
326
+ | inputReadOnly | 输入框只读 | boolean | false |
327
+ | valueFormat | 绑定值的格式 | string | - |
328
+ | getCalendarContainer | 浮层容器 | (trigger: HTMLElement) => HTMLElement | - |
329
+
330
+ ### DatePicker Props
331
+
332
+ | 属性 | 说明 | 类型 | 默认值 |
333
+ | --- | --- | --- | --- |
334
+ | showTime | 增加时间选择功能 | boolean \| object | false |
335
+ | disabledTime | 不可选择的时间 | (date: Moment) => object | - |
336
+ | mode | 日期面板的状态 | `time` \| `date` \| `month` \| `year` \| `decade` | `date` |
337
+ | renderExtraFooter | 额外的页脚 | () => VNode \| slot | - |
338
+
339
+ ### RangePicker Props
340
+
341
+ | 属性 | 说明 | 类型 | 默认值 |
342
+ | --- | --- | --- | --- |
343
+ | value / v-model | 绑定值 | [Moment, Moment] | - |
344
+ | placeholder | 输入框占位文本 | [string, string] | ['开始日期', '结束日期'] |
345
+ | showTime | 增加时间选择功能 | boolean \| object | false |
346
+ | disabledTime | 不可选择的时间 | (dates, partial) => object | - |
347
+ | separator | 分隔符 | string \| VNode | `~` |
348
+ | mode | 日期面板的状态 | string \| string[] | - |
349
+ | renderExtraFooter | 额外的页脚 | () => VNode \| slot | - |
350
+ | **presets** | 预设时间范围快捷选择 | Array<{ label: string \| VNode, value: [Moment, Moment] \| () => [Moment, Moment] }> | - |
351
+ | **picker** | 选择器类型 | `date` \| `week` \| `month` \| `quarter` \| `year` | `date` |
352
+ | **placement** | 弹出位置 | `bottomLeft` \| `bottomRight` \| `topLeft` \| `topRight` | `bottomLeft` |
353
+ | **status** | 校验状态 | `error` \| `warning` \| `success` \| `validating` | - |
354
+ | **bordered** | 是否显示边框 | boolean | true |
355
+ | **allowEmpty** | 允许部分为空 | [boolean, boolean] | [false, false] |
356
+ | ranges | 预设范围 (已废弃,请用 presets) | object | - |
357
+
358
+ ### MonthPicker Props
359
+
360
+ | 属性 | 说明 | 类型 | 默认值 |
361
+ | --- | --- | --- | --- |
362
+ | placeholder | 输入框占位文本 | string | '请选择月份' |
363
+ | monthCellContentRender | 自定义月份单元格内容 | (date: Moment, locale: string) => VNode | - |
364
+
365
+ ### WeekPicker Props
366
+
367
+ | 属性 | 说明 | 类型 | 默认值 |
368
+ | --- | --- | --- | --- |
369
+ | placeholder | 输入框占位文本 | string | '请选择周' |
370
+
371
+ ### 事件
372
+
373
+ | 事件名 | 说明 | 回调参数 |
374
+ | --- | --- | --- |
375
+ | change | 日期变化时触发 | (date: Moment \| [Moment, Moment], dateString: string \| [string, string]) |
376
+ | panelChange | 日期面板变化时触发 | (value: Moment \| [Moment, Moment], mode: string \| string[]) |
377
+ | ok | 点击确定按钮时触发 (showTime 时有效) | (date: Moment \| [Moment, Moment]) |
378
+ | openChange | 弹出/关闭日历时触发 | (open: boolean) |
379
+ | focus | 获取焦点时触发 | (e: FocusEvent) |
380
+ | blur | 失去焦点时触发 | (e: FocusEvent) |
381
+ | calendarChange | RangePicker 专属:待选日期变化时触发 | (dates: [Moment, Moment], dateStrings: [string, string]) |
382
+
383
+ ### 插槽
384
+
385
+ | 插槽名 | 说明 |
386
+ | --- | --- |
387
+ | suffixIcon | 自定义后缀图标 |
388
+ | renderExtraFooter | 自定义额外页脚 |
389
+ | dateRender | 自定义日期单元格内容 |
390
+
391
+ ## 使用 dayjs 替代 moment
392
+
393
+ > **注意**:当前版本的日历核心组件仍依赖 moment.js,dayjs 适配器功能不完整。即使配置了 dayjs,月份、星期等名称仍需要 moment 的 locale 支持。建议直接使用 moment.js。
394
+
395
+ 本组件默认使用 moment.js,但也提供了 dayjs 适配器(实验性):
396
+
397
+ ```javascript
398
+ import { setGenerateConfig, dayjsGenerateConfig } from '@wangxinowo/vue-datepicker-next';
399
+
400
+ // 切换到 dayjs(注意:仍需配置 moment locale)
401
+ setGenerateConfig(dayjsGenerateConfig);
402
+ ```
403
+
404
+ 使用 dayjs 时需要确保安装了必要的插件(组件会自动加载):
405
+
406
+ ```bash
407
+ npm install dayjs
408
+ ```
409
+
410
+ ## 国际化
411
+
412
+ 组件内置了 50+ 种语言支持。
413
+
414
+ > **重要提示**:组件内部依赖 moment.js 来显示月份、星期等名称。仅设置组件的 `locale` prop 是不够的,**必须同时设置 moment 的全局语言**,否则会出现中英文混杂的情况。
415
+
416
+ | 语言 | 代码 | moment locale |
417
+ | --- | --- | --- |
418
+ | 简体中文 | zh_CN | zh-cn |
419
+ | 繁体中文 | zh_TW | zh-tw |
420
+ | 英语 (美国) | en_US | en |
421
+ | 英语 (英国) | en_GB | en-gb |
422
+ | 日语 | ja_JP | ja |
423
+ | 韩语 | ko_KR | ko |
424
+ | 法语 | fr_FR | fr |
425
+ | 德语 | de_DE | de |
426
+ | 西班牙语 | es_ES | es |
427
+ | 俄语 | ru_RU | ru |
428
+ | ... | ... | ... |
429
+
430
+ ### 使用方法
431
+
432
+ ```javascript
433
+ // 1. 导入 moment 及对应语言包
434
+ import moment from 'moment';
435
+ import 'moment/locale/zh-cn';
436
+
437
+ // 2. 设置 moment 全局语言(必须!)
438
+ moment.locale('zh-cn');
439
+
440
+ // 3. 导入组件 locale 配置
441
+ import zhCN from '@wangxinowo/vue-datepicker-next/src/components/date-picker/locale/zh_CN';
442
+
443
+ // 4. 在组件中使用
444
+ <a-date-picker :locale="zhCN" />
445
+ ```
446
+
447
+ ### 全局配置
448
+
449
+ ```javascript
450
+ import Vue from 'vue';
451
+ import moment from 'moment';
452
+ import 'moment/locale/zh-cn';
453
+ import VueDatepickerNext from '@wangxinowo/vue-datepicker-next';
454
+ import zhCN from '@wangxinowo/vue-datepicker-next/src/components/date-picker/locale/zh_CN';
455
+
456
+ // 必须:设置 moment 全局语言
457
+ moment.locale('zh-cn');
458
+
459
+ Vue.use(VueDatepickerNext, {
460
+ locale: zhCN,
461
+ });
462
+ ```
463
+
464
+ ## TypeScript 支持
465
+
466
+ 本组件提供完整的 TypeScript 类型定义:
467
+
468
+ ```typescript
469
+ import { DatePicker, RangePicker, MonthPicker, WeekPicker } from '@wangxinowo/vue-datepicker-next';
470
+ import type { DatePickerProps, RangePickerProps, MonthPickerProps, WeekPickerProps } from '@wangxinowo/vue-datepicker-next';
471
+ import type { Moment } from 'moment';
472
+
473
+ // 类型安全的使用
474
+ const dateValue: Moment | null = null;
475
+ const rangeValue: [Moment, Moment] | null = null;
476
+ ```
477
+
478
+ ## 更新日志
479
+
480
+ ### 1.0.5 (最新)
481
+ - 更新版本和文档增强
482
+
483
+ ### 1.0.3
484
+ - 年份和月份范围选择器添加选中范围背景效果
485
+
486
+ ### 1.0.0
487
+ - 新增 `presets` 属性,支持预设时间范围快捷选择
488
+ - 新增 `picker` 属性,支持 date/week/month/quarter/year 模式
489
+ - 新增 `placement` 属性,支持弹出位置配置
490
+ - 新增 `status` 属性,支持表单验证状态
491
+ - 新增 `bordered` 属性,支持无边框模式
492
+ - 新增 `allowEmpty` 属性,允许部分为空
493
+ - 优化 RangePicker 输入框样式
494
+ - 默认本地化配置改为中文
495
+
496
+ ## 浏览器兼容性
497
+
498
+ | Chrome | Firefox | Safari | Edge | IE |
499
+ | --- | --- | --- | --- | --- |
500
+ | ✓ | ✓ | ✓ | ✓ | 11+ |
501
+
502
+ ## 许可证
503
+
504
+ [MIT](./LICENSE)
505
+
506
+ ## 相关链接
507
+
508
+ - [GitHub 仓库](https://github.com/wangxinowo/vue-datepicker-next)
509
+ - [NPM 包](https://www.npmjs.com/package/@wangxinowo/vue-datepicker-next)
510
+ - [Ant Design Vue](https://www.antdv.com/)