https://github.com/chanceyu/month-calculator
:paperclip: A plugin for month date calculator
https://github.com/chanceyu/month-calculator
calendar calendars date datepicker
Last synced: 11 months ago
JSON representation
:paperclip: A plugin for month date calculator
- Host: GitHub
- URL: https://github.com/chanceyu/month-calculator
- Owner: ChanceYu
- License: mit
- Created: 2017-12-02T07:16:16.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-11T13:43:01.000Z (over 7 years ago)
- Last Synced: 2025-06-30T20:16:35.443Z (12 months ago)
- Topics: calendar, calendars, date, datepicker
- Language: JavaScript
- Homepage:
- Size: 189 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-zh.md
- License: LICENSE
Awesome Lists containing this project
README
# month-calculator
[![NPM][img-npm]][url-npm]
[![Build Status][img-travis]][url-travis]
[![Language][img-javascript]][url-github]
[![License][img-mit]][url-mit]
一个月份日期计算器插件，[English](./README.md)
## 安装
```bash
npm install month-calculator --save
```
## 特点
- 高度可定制
- 不依赖任何UI, 你可以自己设计
- 支持浏览器、Node端、小程序
## 使用
```javascript
var oMonth = new MonthCalculator({
startDate: '2017-07-17',
endDate: '2018-08-18'
});
var months = oMonth.getTotal();
console.log(months);
```
## 参数
- `startDate` - 开始日期，形如 `YYYY-MM-DD`
- `endDate` - 结束日期，形如 `YYYY-MM-DD`
## 方法
- `getTotal` - 获取开始日期到结束日期之间的所有月份
- `getToday` - 如果今天的日期在开始日期和结束日期之间, 将会返回一个对象 `{ monthIndex, date }`, 其中值 `monthIndex` 就是今天的月份对应的索引（所有月份中的第几个月），否则返回`undefined`
## 结果
使用 `getTotal` 方法将会返回以下数据结构
```bash
[
{
title: '2017-07',
dates: [
{
date: '2017-06-25',
year: '2017',
month: '06',
day: '25',
disabled: true,
isPrevMonth: true,
week: '日',
weekday: 0
}
...
]
}
...
]
```
### 每条数据的属性（也就是每一天的数据）
- `date` - 当天完整的日期 ，格式 `YYYY-MM-DD`
- `year` - 当天的年份 ，格式 `YYYY`
- `month` - 当天的月份 ，格式 `MM`
- `day` - 当天的日期 ，格式 `DD`
- `weekday` - 数字从 `0` 到 `6` 的每周值
- `week` - 中文的每周值，`日一二三四五六`
- `isPrevMonth` - 如果是上个月份的日期, 就是 `true`
- `isNextMonth` - 如果是下个月份的日期, 就是 `true`
- `disabled` - 如果是上个月份的日期、下个月份的日期，或者当月不可用的日期(不在 `startDate`开始日期和`endDate`结束日期范围之内), 就是 `true`
## 案例
- [react-calendar-picker](https://github.com/ChanceYu/react-calendar-picker)
- [weapp-calendar-picker 微信小程序组件](https://github.com/ChanceYu/weapp#weapp-calendar-picker)
## 协议
[![license][img-mit]][url-mit]
[url-github]: https://github.com/ChanceYu/month-calculator
[url-npm]: https://www.npmjs.com/package/month-calculator
[url-travis]: https://travis-ci.org/ChanceYu/month-calculator
[url-david]: https://david-dm.org/ChanceYu/month-calculator
[url-mit]: https://opensource.org/licenses/mit-license.php
[img-npm]: https://nodei.co/npm/month-calculator.png?compact=true
[img-travis]: https://travis-ci.org/ChanceYu/month-calculator.svg?branch=master
[img-david]: https://david-dm.org/ChanceYu/month-calculator/status.svg
[img-javascript]: https://img.shields.io/badge/language-JavaScript-brightgreen.svg
[img-mit]: https://img.shields.io/badge/license-MIT-blue.svg