angular-calendar
v0.32.0TypeScript
A calendar component for angular 20.2+ that can display events on a month, week or day view
0/weekUpdated 5 months agoMITUnpacked: 729.7 KB
Published by Matt Lewis
npm install angular-calendarangular 20.2+ calendar
Demo
https://mattlewis92.github.io/angular-calendar/
Sponsors
Table of contents
- About
- Getting started
- Documentation
- Breaking changes
- FAQ
- Angular 1 version
- Development
- License
About
A calendar component for angular 20.2+ that can display events on a month, week or day view. The successor of angular-bootstrap-calendar.
Getting started
$3
``sh`
ng add angular-calendar
$3
First install through npm:
`bash`
npm install angular-calendar date-fns
Next include the CSS file in the global (not component scoped) styles of your app:
`
/ angular-cli file: src/styles.css /
@import "../node_modules/angular-calendar/css/angular-calendar.css";
Finally add the calendar to a component in your app:
`typescript
import { Component } from '@angular/core';
import { DateAdapter, provideCalendar, CalendarPreviousViewDirective, CalendarTodayDirective, CalendarNextViewDirective, CalendarMonthViewComponent, CalendarWeekViewComponent, CalendarDayViewComponent, CalendarEvent, CalendarView, CalendarDatePipe } from 'angular-calendar';
import { adapterFactory } from 'angular-calendar/date-adapters/date-fns';
@Component({
imports: [CalendarPreviousViewDirective, CalendarTodayDirective, CalendarNextViewDirective, CalendarMonthViewComponent, CalendarWeekViewComponent, CalendarDayViewComponent, CalendarDatePipe],
providers: [
provideCalendar({
provide: DateAdapter,
useFactory: adapterFactory,
}),
],
template:
{{ viewDate | calendarDate: view + 'ViewTitle' : 'en' }}
@switch (view) {
@case (CalendarView.Month) {
}
@case (CalendarView.Week) {
}
@case (CalendarView.Day) {
}
}
,
})
export class MyComponent {
readonly CalendarView = CalendarView;
viewDate = new Date();
events: CalendarEvent[] = [
{
start: new Date(),
title: 'An event',
},
]; setView(view: CalendarView) {
this.view = view;
}
}
`In order to allow the most flexibility for all users there is a substantial amount of boilerplate required to get up and running. Please see the demos list for a series of comprehensive examples of how to use this library within your application.
Once you are up and running, to access a full list of options for each component, the individual APIs are documented here:
, mwl-calendar-week-view and mwl-calendar-day-view.> Please note: angular-calendar uses Scarf to collect anonymized installation analytics. These analytics help support the maintainers of this library. However, if you'd like to opt out, you can do so by setting
scarfSettings.enabled = false in your project's package.json. Alternatively, you can set the environment variable SCARF_ANALYTICS=false before you install.Documentation
To see all available API options, take a look at the auto generated documentation. You may find it helpful to view the examples on the demo page.
Breaking changes
Where possible this library will strictly adhere to semver and only introduce API breaking changes in 0.x releases or new major versions post 1.0. The only exception to this is if you are using custom templates or extending the base components to add additional functionality, whereby critical bug fixes may introduce breakages as the internal API changes.
FAQ
$3
Yes.
$3
| Angular major | Last supported angular-calendar version |
| --------------- | ------------------------------------------------------------------------ |
| 20.x and higher | latest version |
| 15.x - 19.x | 0.31.1 |
| 14.x | 0.30.1 |
| 12.x - 13.x | 0.29.0 |
| 6.x - 11.x | 0.28.28 |
| 5.x | 0.24.1 |
| 4.x | 0.22.3 |
| 2.x | 0.9.1 |
$3
No component styles are included with each component to make it easier to override them (otherwise you’d have to use
!important on every rule that you customised). Thus you need to import the CSS file separately from node_modules/angular-calendar/css/angular-calendar.css.$3
When building the calendar some parts were found to be reusable so they were split out into their own modules. Only the bare minimum that is required is included with the calendar, there is no extra code than if there were no dependencies.
date-fns especially only imports directly the functions it needs and not the entire library.$3
Build your own component to replace that view, and use it in place of the one this library provides. It’s impossible to provide a calendar component that meets everyones use cases, hopefully though at least some of the day / week / month view components provided can be customised with the calendars API enough to be of some use to most projects.
$3
As there are so many events to show on each month, it doesn’t provide a lot of value and is just an extra burden to maintain. There is nothing to stop someone from building a new lib like
angular-calendar-year-view though ;)$3
This library is not optimised for mobile. Due to the complex nature of a calendar component, it is non trivial to build a calendar that has a great UX on both desktop and mobile. It is recommended to build your own calendar component for mobile that has a dedicated UX. You may be able to get some degree of mobile support by setting some custom CSS rules for smaller screens on the month view and showing less days on the week view.
$3
All parts of this calendar can be customised via the use of an
ng-template. The recipe for applying one is as follows:- Find the template you would like to customise for the month, week or day view component. You can find all available custom templates by reading the documentation for each component. For this example we will pick the
cellTemplate from the month view.
- Next find the corresponding child component that will render the template by viewing the source. For our example of the month view cell it is this component
- Now copy the template source for your chosen template into your own component and modify as your see fit.
- Finally pass the template to the components input:
- You can see an e2e working example of this here$3
All evergreen browsers supported by angular.
$3
No! While the demo site uses bootstrap, it isn't a requirement of this library. The styling is designed to adapt to whatever global styling your app has.
Angular 1 version
https://github.com/mattlewis92/angular-bootstrap-calendar
Development
$3
- Install Node.js (>=24.5.0)
- Install pnpm:
- Install local dev dependencies: while current directory is this repo$3
Run
pnpm start to start a development server on port 8000 with auto reload + tests.$3
Run
pnpm test to run tests once or pnpm test:watch to continually run tests.$3
- Bump the version in package.json (once the module hits 1.0 this will become automatic)
`bash
pnpm release
``