Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 2.05 KB

README_CN.md

File metadata and controls

69 lines (46 loc) · 2.05 KB

日期表格

注意:这是一个JS库,不包含UI

它用于生成如下图的数据结构

安装

>   有两种方法,

1. 使用npm; npm install kalendar --save-dev
2. 直接引用dist/kalendar.js

使用

options:

  • startTime: 开始时间 如:'2018-03' 默认当前月
  • endTime: 结束时间 如:'2018-06' 默认开始时间月份的后三个月
  • unifiedMount: 需要对所有日期统一挂载的字段 {'price':370}
  • mount: 单独挂载项 如 {'2018-03-14': {'festival': '情人节','price':'368'}} ,遇到unifiedMount相同的Key,覆盖unifiedMount的Value
  • weekStart: 周几开始 0为周日 1为周一 ,默认为0
  • continuous: 使用静态方法 Kalendar.monthly 时,可以设置日期是否连续。

   var kalendar = new Kalendar({
         start: '2018-03',
         end: '2018-06',
         mount: {
             '2018-03-14': {'festival': '情人节'}
         },
         weekStart: 0
     })

     console.log(kalendar)

由Kalendar得到如下对象结构

  1. Kalendar.monthly(options)

    用于构建一个月的数据

  2. new Kalendar(options)

内部属性

每一天的数据以周为单位存放在月份数据的对象下,Day对象中除了挂载了,常用的 年、月、日信息外, 还有用户挂载的扩展数据和当天的 Date 对象(通过属性:__DateObject__获取)

  • _DateObject_ : 当天的Date对象
  • year : 年份
  • month: 月份(0-11)
  • date: 日期(1-31)
  • day: 周几(0-6)周日-周六
  • dateText: '2018-03-19'
  • past: 小于今天的日期时为true
  • today: 等于今天的日期时为true
  • ... : new Kalendar时挂载的mount、unifiedMount中的字段