乐趣区

关于前端:VHC-一款基于-vue3-的移动端日期时间选择插件-功能丰富-文档细致

jiezi

文档地址

https://www.hxkj.vip/calendar

效果图

仓库地址

  • github：https://github.com/TangSY/vue3-hash-calendar
  • 码云 gitee：https://gitee.com/HashTang/vue3-hash-calendar

其余版本

  • vue 2.x 版本：https://github.com/TangSY/vue-hash-calendar
  • react 版本：https://github.com/TangSY/react-hash-calendar

API

Props

属性 阐明 类型 默认 是否必传
visible 管制日历组件的显示或暗藏, 需应用 v-model:visible Boolean false 否
scroll-change-date 管制滑动的时候是否批改选中的日期 Boolean true 否
model 日历组件以哪种模式展现。inline：内联的形式。dialog：弹窗的形式 String inline 否
default-datetime 指定默认工夫。 Date 以后工夫 否
min-date 指定日历最小日期范畴，设置之后只能在该范畴内滑动日历。 Date — 否
max-date 指定日历最大日期范畴，设置之后只能在该范畴内滑动日历。 Date — 否
format 确认日期时，回调事件返回的日期格局。如“YY/MM/DD hh:mm”、“YY 年 MM 月第 DD 天，以后工夫 hh 时 mm 分”、“MM DD,YY at hh:mm F” String YY/MM/DD hh:mm 否
week-start 以星期几作为日历每一周的起始星期。可选 [‘sunday’, ‘monday’, ‘tuesday’, ‘wednesday’, ‘thursday’, ‘friday’, ‘saturday’] String sunday 否
picker-type 选择器类型 datetime：日期 + 工夫 date：日期 time：工夫 String datetime 否
show-today-button 是否显示返回今日按钮 Boolean true 否
show-week-view 是否以周视图展现组件 Boolean false 否
show-arrow 是否显示周月切换时的批示箭头（日历下方的小箭头），当 model 等于 inline 时失效 Boolean false 否
show-action 是否显示日历组件操作栏（标题栏） Boolean true 否
show-not-current-month-day 是否展现日历中的非本月日期（灰色局部日期） Boolean true 否
disabled-week-view 禁用周视图（设置为 true 后，无奈高低滑动进行周 / 月切换） Boolean false 否
disabled-date 设置日期的禁用状态，参数为以后日期，要求返回 Boolean（禁用该日期需返回 true） Function — 否
disabled-time 设置工夫的禁用状态，参数为以后日期，要求返回 Boolean（禁用该工夫需返回 true） Function — 否
disabled-scroll 设置日历的禁止滑动方向。可选 [‘left’, ‘right’, ‘up’, ‘down’, ‘horizontal’, ‘vertical’, true, false]。可取其一管制单个方向，其中 true 和 false 管制所有方向。 Boolean, String false 否
mark-date 须要被标记的日期，可按不同色彩不同标记类型分组标记（不分组默认蓝色）。如：[{color: ‘red’,date: [‘2019/02/25’]},{color: ‘blue’,type: ‘dot’,date: [‘2019/01/20′]},’2019/03/20’] Array [] 否
minute-step 间隔时间。（分钟的步长） Number 1 否
lang 抉择的语言版本。可选值:[‘CN’, ‘EN’] String CN 否
change-year-fast 是否反对点击操作栏（标题栏）的日期区域疾速切换年份 Boolean false 否
theme-color 用于批改日历主题色 {‘main-color’: string; ‘bg-color’: string; ‘main-font-color’: string; ‘vice-font-color’: string; ‘disabled-bg-color’: string; ‘disabled-font-color’: string;} — 否
disabled-class-name 日期被禁用时的 className。用于批改日期被禁用时的默认款式 String — 否
not-current-month-day-class-name 非以后展现月份日期的 className(例如日历后面几天与前面几天灰色局部)。用于批改非以后展现月份日期的默认款式 String — 否
checked-day-class-name 日期被选中时的 className。用于批改日期被选中时的默认款式 String — 否
today-class-name 当天日期的 className。用于批改当天日期的默认款式 String — 否
first-day-of-month-class-name 每月第一天的 className。用于批改每月第一天的默认款式 String — 否

事件 Event

事件名称 阐明 参数
change 日期扭转时，触发该事件。（返回的日期格局取决于 format 属性） (date: 日期扭转时，选中的日期)
confirm 点击确认按钮时，触发该事件，dialog 模式中才有该按钮。（返回的日期格局取决于 format 属性） (date: 点击确认按钮时，选中的日期)
click 点击日期时，触发该事件。（返回的日期格局取决于 format 属性） (date: 以后点击的日期)
touchstart 日历滑动 start 事件，同于原生该事件。 （event: touch 事件）
touchmove 日历滑动 move 事件，同于原生该事件。 （event: touch 事件）
touchend 日历滑动 end 事件，同于原生该事件。 （event: touch 事件）
slidechange 日历滑动的方向。返回值：right、left、up、down。 （direction: 滑动的方向）
calendarTypeChange 日历展现类型切换时触发。返回值：date、month、year、yearRange。 （type: 日历展现面板类型）

插槽 Slot

name 阐明
day 自定义日期内容。例如可用于增加农历之类的。配合自定义 className 应用，成果更佳！参数为 {date, extendAttr}，其中 extendAttr 参数蕴含 isMarked（该日期是否被标记）、isDisabledDate（该日期是否被禁用）、isToday（该日期是否为明天）、isChecked（该日期是否被选中）、isCurrentMonthDay（该日期是否为本月日期）、isFirstDayOfMonth（该日期是否为当月第一天），可用于一些非凡需要
week 自定义星期内容。例如可用于自定义星期款式等等。参数为 {week}
arrow 自定义周月切换时的批示箭头。参数为 {show}，show: 类型为 Boolen，示意以后是否为周视图
today 自定义 “ 明天 ” 按钮文字内容以及款式
confirm 自定义 “ 确定 ” 按钮文字内容以及款式
action 自定义操作栏（标题栏）内容以及款式

办法 Method

办法名称 阐明
lastMonth 切换日历到上一月
nextMonth 切换日历到下一月
lastWeek 切换日历到上一周
nextWeek 切换日历到下一周
today 返回今日。当今日被禁用时，不失效
退出移动版