mystterio / wx-calendar

calendar for wechat miniprogram

WX Calendar

借鉴了MIUI 12日历的部分设计，制作适合微信小程序的日历

· 周月视图切换
· 日期标记
· 农历信息

欢迎到issues面板提出建议和BUG

预览

使用

页面json配置：

{
    "usingComponents": {
        "calendar": "/components/wx-calendar/index"
    }
}

在页面wxml文件中：

<calendar id="calendar" bindload="handleLoad" />

注意 请在 bindload 事件后执行 selectComponent('#calendar') 操作。

注意 日历最大高度可达到屏幕高度80%，请注意布局

Props 属性

属性名	类型	说明	默认值
view	String	初始化为月视图或周视图	month [week]
_position	String	定位	relative [absolute, fixed]
_top	String | Number	绝对定位有效	--
_markers	Array	日期标记	--
_markerKey	String	标记标识字段，用于筛选	id
_vibrate	Boolean	点选日期是否震动	true
darkmode	Boolean	黑暗模式	false
_date	String|Number	选择初始日期	xxxx-xx-xx｜timestamp
checkedShow	Boolean	选中状态显示	true

关于 _markers

Events 事件

bindload 日历加载完成

e.detail = { date } 
# date为当前选择日期

binddatechange 日期选择变化

e.detail = { date } 
# date为当前选择日期

bindrangechange 日期范围变化

e.detail = { curr, range, view, visual, markerCommit } 
# curr: 当前选择日期
# range: 当前swiper日期范围
# visual: 可视区域日期范围
# view: 当前面板视图，月/周
# markerCommit(markers): 提交日期标记的方法，参数markers和属性_markers一致

bindviewchange 面板视图变化

e.detail = { view } 
# view: 当前面板视图，月/周

Slots 插槽

名称	说明
—	试一下就知道了，没啥可说的

Methods 方法

toDate void 跳转到日期

function(date|year, [month], [day])
# 接受1个或3个参数
# 只有1个参数时，可以为[Date|String]类型，当为String时形如 2021-4-10
# 3个参数时，则为具体的 年,月,日

toMonth void 跳转到月份

function(year, month)
# 参数为 年,月

prev void 向前一个月

next void 向后一个月

toggleView void 切换面板视图

function(view)
# 参数 view 为切换至 月month|周week

getDateInfo object 获取某个日期的信息

function(date|year, [month], [day])
# 参数同 toDate

setMarkers void 设置日期标记

function(markers)
# 参数 markers 同属性 _markers

addMarker void 新增日期标记

function(marker)
# 参数 marker = { year, month, day, type, mark, color, bgColor }

editMarker void 修改日期标记

function(marker)
# 参数 marker = { [_markerKey], year, month, day, type, mark, color, bgColor }
# [_markerKey] 标记标识字段，可以由属性_markerKey定义，默认为id

delMarker void 删除日期标记

function(date, type, key)
# 参数 date = { year, month, day } 某个日期 
# 参数 type = [holiday|corner|schedule] 当type为空时，会删除掉date下的所有类型标记
# 参数 key 为标记标识字段的值，当key为空时，会删除掉date下的所有type类型的标记

关于 marker.type

reloadMarkers void 重新加载所有日期标记

reloadPos Promise 重新计算calendar和选中状态的位置

说明

涉及到日期标记无论是标记数组还是单个标记，都是形如以下：

 marker = { year, month, day, type, mark, color, bgColor }
 markers = [{ year, month, day, type, mark, color, bgColor }]

marker说明

year,month,day 年月日
type = [holiday|corner|schedule] 节假日|角标｜日程 
mark 为标记内容
color 为字体颜色
bgColor 为背景颜色

节假日会截取 mark 头两个字符，长度最好为2，角标截取 mark 头一个字符，长度最好为1

农历说明

实用于公历 1901 年至 2100 年之间的 200 年 
参考了eleworld.com上的算法，并修正了5处节气错误

* 2014年3月5日 惊蛰
* 2051年3月21日 春分
* 2083年2月4日 立春
* 2084年3月20日 春分
* 2094年6月6日 芒种

关于

有任何问题或是需求请到 `Issues` 面板提交
忙的时候还请见谅
有兴趣开发维护的小伙伴加微信