/MobileCalendar

常用日历组件演示,结合swiper支持滑动屏幕左右切换动画等效果

Primary LanguageJavaScript

移动端H5日历组件

文档维护者:孙尊路

喜欢的话,记得star 一下噢!

适用场景

  • 该组件目前仅适用于移动端H5页面展示,后期高级用法中会讲述到如何基于日历基类实现自定义模板传入。(即:开发者只需要传入自己的模板即可实现出自己的优美的日历出来。) 本篇主要是带大家入门日历组件的使用,该文档后面会持续优化更新。若有不足,请大家多多指教,小编会及时更正!

实例展示

典型项目应用案例

  • 【移动OA类】 我的日程
  • 【招投标类】 开标日程

依赖资源

  • libs/calendar_base.js 日历组件基类js库
  • libs/calendar_base.css 日历组件基类css库,可以根据业务需求,任意个性化,从而达到设计视觉效果

配置和使用方法

DOM结构

一个div即可

<div id="calendar"></div>

初始化

以下代码是最简单的用法,更多复杂用法请参考calendar_showcase源码下载

var calendar = new Calendar({
    // 日历容器
    container: "#calendar",
    // 点击日期事件
    onItemClick: function(item) {
        var defaultDate = item.date;
    }
});

参数说明

参数 参数类型 说明
container string或HTMLElement 必选 Calendar容器的css选择器,例如“#calendar”。默认为#calendar
pre string或HTMLElement 可选 前一个月按钮的css选择器或HTML元素。默认.pre
next string或HTMLElement 可选后一个月按钮的css选择器或HTML元素。默认.next
backToToday string或HTMLElement 可选 返回今天按钮的css选择器或HTML元素。默认.backToToday
dataRequest Function 可选 回调函数,绑定业务数据。例如:某天有日程,则会在对应日期上标识出一个小红点或者其他标识,默认传入数据格式:data=[{"date":"2018-04-18"},{"date":"2018-04-17"},{"date":"2018-04-16"}]
onItemClick Function 必选 回调函数,当你点击或轻触某日期 300ms后执行。回调日期结果:2018-04-07
swipeCallback Function 可选 回调函数,滑块释放时如果触发slider向后(左、上)切换则执行
template Function或String 可选,元素渲染的模板,可以是一个模板字符串,也可以是一个函数,为函数时,确保返回模板字符串,默认组件内置模板
isDebug Boolean 可选是否开启调试模式,默认false

API

生成的calendar对象可以调用如下API

var calendar = new Calendar(...);

refresh()

会销毁清空日历容器中的数据重新进行渲染。默认传入参数为空,刷新当前月份的日历数据。

calendar.refresh();

同时也可以手动传入某个日期渲染日历数据,例如:渲染出2020-08-08的日历如下:

calendar.refresh({
    year: "2020",
    month: "08",
    day: "08"
});

参数说明

参数 参数类型 说明
{} object 必选 日期对象必须传入以下格式:{year:"2018",month:"04",day:"08"}

slidePrev()

切换为上一个月,与组件内部传入参数pre作用一样,该API支持Promise异步成功回调里处理自己的业务逻辑。

calendar.slidePrev().then(...).then(...);

slideNext()

切换为下一个月,与组件内部传入参数next作用一样,该API支持Promise异步成功回调里处理自己的业务逻辑。

calendar.slideNext().then(...).then(...);

addActiveStyleFordate()

给特定日期新增选中激活样式,比如:把日期2018-08-21标记位已选中状态。

calendar.addActiveStyleFordate("2018-08-21");

参数说明

参数 参数类型 说明
"2018-08-21" String 必选 日期格式必须符合以下格式:2018-08-21

refreshData()

会获取整个月的日历数据(6 * 7 = 42方格的日期),可根据该API自行个性化开发自己的日历组件,例如:

calendar.refreshData({
    year: "2018",
    month: "04",
    day: "08"
},
function(output, data) {
    console.log("==某个月的日历渲染数据:==" + JSON.stringify(data));
    console.log("==组件自带模板==" + output);
});

输出日历数据格式:

[{"day":25,"lunar":"初九","date":"2018-03-25","isforbid":"0"}]

输出内置组件模板格式:

<div class="em-calendar-item  isforbid0"date="2018-03-25"><span class="day">25</span><p class="lunar">初九</p></div>

优点和好处

能够极大方便实际项目上开发人员的上手使用,而且版本是不断根据实际项目上的需求进行优化升级的,开放源码可以让特殊需求的项目开发人员进行修改、补充和完善。

存在的不足之处

目前依赖js库有多个(mustache.min.js、mui.min.js)主要是一些常用的移动端js库(无可厚非),包含组件的核心库,或许有人认为影响加载速度之类的,其实已经有很多项目在应用效果还可以,当然了小编也正在努力剥离第三方js库,思路已经有了,只不过需要一点时间进行代码重构,若在此之前给你带来的不便,还请多多包涵,毕竟优化组件确实需要花费大量时间的。