# general-calendar

> calendar

Latest version **1.0.1** (published 2018-04-15) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install general-calendar
pnpm add general-calendar
yarn add general-calendar
bun add general-calendar
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-04-15 |
| First published | 2018-04-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 630.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | lisipeng |
| Maintainers | lisipeng |
| Keywords | moment, calendar, month, date |

## Links

- npm: https://www.npmjs.com/package/general-calendar
- Repository: https://github.com/leesipeng/general-calendar
- Homepage: https://github.com/leesipeng/general-calendar#readme
- Issues: https://github.com/leesipeng/general-calendar/issues
- npm.io page: https://npm.io/package/general-calendar

## Dependencies (2)

- [moment](https://npm.io/package/moment.md) ^2.22.0
- [object-assign](https://npm.io/package/object-assign.md) ^4.1.1

## Alternatives

- [@js-joda/timezone](https://npm.io/package/@js-joda/timezone.md) — 383.4K weekly downloads
- [chartjs-adapter-moment](https://npm.io/package/chartjs-adapter-moment.md) — 210.8K weekly downloads
- [strftime](https://npm.io/package/strftime.md) — 171.2K weekly downloads
- [vue-flatpickr-component](https://npm.io/package/vue-flatpickr-component.md) — 115.8K weekly downloads
- [timepicker](https://npm.io/package/timepicker.md) — 51.0K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2018-04-15
- 1.0.0 — 2018-04-13

## README

# [general-calendar](https://github.com/leesipeng/general-calendar) · [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/leesipeng/general-calendar/LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/leesipeng/general-calendar/issues)

general-calendar is a calendar core.

## Examples

We have several examples [on the website](https://github.com/leesipeng/general-calendar). Here is the first one to get you started:

```jsx
var oMonth = new GeneralCalendar({
    startDate: '2018-04-12',
    endDate: '2018-05-17',
});

var months = oMonth.getTotal();
```

This example will return array with date Objects, for example.
```jsx
months = [
    {
        dates: [
            {
                date: "2018-04-01",
                day: "01",
                disabled: true,
                enabled: false,
                isNextMonth: true,
                month: "04",
                week: "日",
                weekday: 0,
                year: "2018"
            }
            {
                date: "2018-04-02",
                day: "02",
                disabled: true,
                enabled: false,
                isNextMonth: true,
                month: "04",
                week: "一",
                weekday: 1,
                year: "2018"
            }
        ],
        title: "2018-04"
    }
]
```

## Installation

general-calendar is available as the `general-calendar` package on [npm](https://www.npmjs.com/). 

### Good First Issues

To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/leesipeng/general-calendar/issues) that contain bugs which have a relatively limited scope. This is a great place to get started.

### License

general-calendar is [MIT licensed](./LICENSE).

---
_Source: https://npm.io/package/general-calendar · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._