Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wessouza/calendar-base
Base methods for generating calendars using JavaScript.
https://github.com/wessouza/calendar-base
calendar calendar-generator javascript library
Last synced: 4 days ago
JSON representation
Base methods for generating calendars using JavaScript.
- Host: GitHub
- URL: https://github.com/wessouza/calendar-base
- Owner: WesSouza
- License: mit
- Created: 2015-02-17T00:32:10.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-01-20T05:53:34.000Z (10 months ago)
- Last Synced: 2024-11-06T20:44:38.744Z (7 days ago)
- Topics: calendar, calendar-generator, javascript, library
- Language: TypeScript
- Homepage:
- Size: 173 KB
- Stars: 385
- Watchers: 17
- Forks: 20
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Calendar Base
[](https://github.com/WesSouza/calendar-base/actions/workflows/lint-typecheck-test-build.yml) [](https://www.npmjs.com/package/calendar-base)
Base methods for generating calendars using JavaScript.
Output is ES5 compatible.
## Installation
```bash
# using npm
npm install calendar-base
# or yarn
yarn add calendar-base
```
## Usage
```js
const Calendar = require('calendar-base').Calendar;
const cal = new Calendar();
cal.getCalendar(2020, 0);
/*
Returns an Array with the calendar for January 2020, including empty spaces for
days from the previous and next months:
[
false,
false,
{ day: 1, weekDay: 3, month: 0, year: 2020 },
{ day: 2, weekDay: 4, month: 0, year: 2020 },
{ day: 3, weekDay: 5, month: 0, year: 2020 },
{ day: 4, weekDay: 6, month: 0, year: 2020 },
{ day: 5, weekDay: 0, month: 0, year: 2020 },
...
]
*/
```
[Check an online example](https://stackblitz.com/edit/js-ad7edj?file=index.js)
or browse the [`examples`](./examples/) folder for some simple use cases.
### Date object notation
Every returned day or date argument follows this notation:
```js
{
day: 14,
month: 9,
year: 1986,
weekDay: 4,
selected: false,
siblingMonth: false,
weekNumber: 42
}
```
Properties `month` and `weekDay` respect JavaScript’s
[`Date.prototype`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/prototype).
Only `day`, `month`, and `year` are necessary as input parameters for methods
that require a date.
#### `Calendar(options)`
Constructor for a new calendar generator.
The object `options` may have the following properties:
- `startDate`: current selected starting date (default `undefined`)
- `endDate`: current selected ending date (default `undefined`)
- `siblingMonths`: whether to include the previous and next months’ days before
and after the current month when generating a calendar (default `false`)
- `weekNumbers`: whether to include the week number on each day
- `weekStart`: day of the week, respects
[`Date.prototype.getDay`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getDay) (default `0`, Sunday)
#### `Calendar.diff(dateOne, dateTwo)`
Returns the difference in days between `dateOne` and `dateTwo` as a `Number`.
```js
> Calendar.diff({ year: 2010, month: 0, day: 1 }, { year: 2010, month: 0, day: 10 });
-9
```
#### `Calendar.interval(dateOne, dateTwo)`
Returns the amount of days between `dateOne` and `dateTwo` as a `Number`.
```js
> Calendar.interval({ year: 2010, month: 0, day: 1 }, { year: 2010, month: 0, day: 10 });
10
```
#### `Calendar.compare(leftDate, rightDate)`
Compares two date objects, returns:
- `-1` if `leftDate` < `rightDate`
- `0` if `leftDate` == `rightDate`
- `1` if `leftDate` > `rightDate`
Useful for quick comparisons such as sorting an array of dates.
```js
> Calendar.compare({ year: 2010, month: 0, day: 1 }, { year: 2010, month: 0, day: 10 });
1
```
#### `Calendar.daysInMonth(year, month)`
Returns the amount of days in the given month as a `Number`.
```js
> Calendar.daysInMonth(2010, 0);
31
```
#### `Calendar.isLeapYear(year)`
Returns whether the given year is a leap year, as a `Boolean`.
```js
> Calendar.isLeapYear(2100);
false
```
#### `Calendar.calculateWeekNumber(date)`
Returns the week number for the specified date.
```js
> Calendar.calculateWeekNumber({year: 1986, month: 9, day: 14 });
42
```
#### `Calendar.prototype.getCalendar(year, month)`
Returns an `Array` of dates with the days from the given month, always starting
at the configured week day.
If sibling months is disabled, paddings are added as `false` to align the week
days, otherwise the respective days from the previous or next months are
included.
```js
> var cal = new Calendar({ siblingMonths: true });
> cal.getCalendar(2015, 5);
[ { day: 31, weekDay: 0, month: 4, year: 2015, siblingMonth: true },
{ day: 1, weekDay: 1, month: 5, year: 2015 },
{ day: 2, weekDay: 2, month: 5, year: 2015 },
...
{ day: 4, weekDay: 6, month: 6, year: 2015, siblingMonth: true } ]
```
#### `Calendar.prototype.setDate(date)`
Alias to `Calendar.prototype.setStartDate`.
#### `Calendar.prototype.setStartDate(date)`
Sets the current selected starting date.
```js
> cal.setStartDate({ year: 2015, month: 0, day: 1 });
```
#### `Calendar.prototype.setEndDate(date)`
Sets the current selected ending date.
```js
> cal.setEndDate({ year: 2015, month: 0, day: 31 });
```
#### `Calendar.prototype.isDateSelected(date)`
Checks whether the given date is inside the selected dates interval, returns a
`Boolean`.
```js
> cal.isDateSelected({ year: 2015, month: 0, day: 10 });
true
```
## Important note on week numbers
Week numbers are calculated based on the ISO 8601 standard, which assumes
calculations based on weeks starting on Mondays. Be extra careful displaying the
week number if your calendar doesn't start on a Monday.
## Development
This library uses `wes-cli`, which simplifies configuration setup. Instead of
using `yarn install`, you should use `npx wes-cli install`, which will create
all configuration files and run `yarn install`.
[Read more about `wes-cli`.](https://github.com/WesSouza/wes-cli/#wes-install)
## License
MIT, https://wes.dev/LICENSE.txt