Please see the release notes for new features and breaking changes.
This plugin is an AngularJS port of the original jQuery bootstrap calendar that can be found here: http://bootstrap-calendar.azurewebsites.net/
The layout and functionality is intended to be exactly the same, but without the overhead of including jQuery just for a calendar.
All credits for the UI/UX and the less files of the calendar go to the original author.
Pull requests are welcome.
The calendar has a few dependencies, these are as follows, and must be included BEFORE the plugin files:
- AngularJS 1.3.x or 1.4.x are supported
- Bootstrap 3+ (CSS only)
- Moment.js
- ui-bootstrap (optional, include for collapse animations and tooltips on the year and month views.
- interact.js (optional, include to allow drag and drop on the calendar)
- ngTouch (optional, include if using the calendar on mobile devices)
It is recommended that you install the plugin and its dependencies through bower:
bower install --save angular-bootstrap-calendar
You will then need to include the JS and CSS files for the plugin:
<link href="bower_components/angular-bootstrap-calendar/dist/css/angular-bootstrap-calendar.min.css" rel="stylesheet">
<script src="bower_components/angular-bootstrap-calendar/dist/js/angular-bootstrap-calendar-tpls.min.js"></script>
And finally add the module dependency in your AngularJS app (you can remove ui.bootstrap if you don't want the extra dependency - it is only required for collapse animations and tooltips):
angular.module('myApp', ['mwl.calendar', 'ui.bootstrap']);Alternatively you can install through npm:
npm install --save angular-bootstrap-calendar
Or if using npm 3+ where peer dependencies aren't automatically installed:
npm install --save angular-bootstrap-calendar angular bootstrap moment angular-ui-bootstrap
Then add as a dependency to your app:
angular.module('myApp', [require('angular-bootstrap-calendar'), require('angular-ui-bootstrap')]);There is a single directive exposed to create the calendar, use it like so:
<mwl-calendar
view="calendarView"
current-day="calendarDay"
events="events"
view-title="calendarTitle"
on-event-click="eventClicked(calendarEvent)"
on-event-times-changed="calendarEvent.startsAt = calendarNewEventStart; calendarEvent.endsAt = calendarNewEventEnd"
edit-event-html="'<i class=\'glyphicon glyphicon-pencil\'></i>'"
delete-event-html="'<i class=\'glyphicon glyphicon-remove\'></i>'"
on-edit-event-click="eventEdited(calendarEvent)"
on-delete-event-click="eventDeleted(calendarEvent)"
auto-open="true">
</mwl-calendar>An explanation of the properties is as follows:
This variable is a string that can be either year, month, week or day. Changing it will change the view of the calendar.
For the calendar to display this variable needs to be set like so:
$scope.calendarView = 'month';This variable holds the current day the calendar is centralised on. Each view will decide on its current year / month / week / day depending on the value of this variable.
An array of events to display on the calendar. For example:
$scope.events = [
{
title: 'My event title', // The title of the event
type: 'info', // The type of the event (determines its color). Can be important, warning, info, inverse, success or special
startsAt: new Date(2013,5,1,1), // A javascript date object for when the event starts
endsAt: new Date(2014,8,26,15), // Optional - a javascript date object for when the event ends
editable: false, // If edit-event-html is set and this field is explicitly set to false then dont make it editable.
deletable: false, // If delete-event-html is set and this field is explicitly set to false then dont make it deleteable
draggable: true, //Allow an event to be dragged and dropped
resizable: true, //Allow an event to be resizable
incrementsBadgeTotal: true, //If set to false then will not count towards the badge total amount on the month and year view
recursOn: 'year', // If set the event will recur on the given period. Valid values are year or month
cssClass: 'a-css-class-name' //A CSS class (or more, just separate with spaces) that will be added to the event when it is displayed on each view. Useful for marking an event as selected / active etc
}
];title, type and startsAt are required for all events.
This variable will be assigned to the calendar title. If you want to change the formatting you can use the calendarConfigProvider or just override the appropriate method in the calendarTitle factory.
This expression is called when an event is clicked on the calendar. calendarEvent can be used in the expression and contains the calendar event that was clicked on.
This expression is called when an event is dragged and dropped or resized into a different date / time on the calendar. The available values that are passed to the expression are: calendarEvent, calendarNewEventStart and calendarNewEventEnd. The directive won't change the event object and leaves that up to you to implement. Please note drag and drop is only available by including the interact.js library.
If provided this piece of html will be displayed next to an event on the year and month view and will fire the function passed to edit-event-click.
If provided this piece of html will be displayed next to an event on the year and month view and will fire the function passed to delete-event-click.
This expression is called when an event edit link is clicked on the calendar. calendarEvent can be used in the expression and contains the calendar event that was clicked on.
This expression is called when an event delete link is clicked on the calendar. calendarEvent can be used in the expression and contains the calendar event that was clicked on.
This expression is called when a month, day or hour on the calendar is clicked on the year, month and day views respectively. calendarDate can be used in the expression and contains the start of the month, day or hour that was clicked on.
Whether to auto open the year and month view breakdown to the current year / month. Default: false
An interpolated string in the form of hh:mm to start the day view at, e.g. setting it to 06:00 will start the day view at 6am
An interpolated string in the form of hh:mm to end the day view at, e.g. setting it to 22:00 will end the day view at 10pm
The number of chunks to split the day view hours up into. Can be either 10, 15 or 30. Default: 30
An optional expression that is evaluated when the drilldown (clicking on a date to change the view) is triggered. Return false from the expression function to disable the drilldown. calendarDate can be used in the expression and contains the date that was selected. calendarNextView is the view that the calendar will be changed to.
An optional expression that is evaluated on each cell generated for the year and month views. calendarCell can be used in the expression and is an object containing the current cell data which you can modify (see the calendarHelper service source code or just console.log it to see what data is available). If you add the cssClass property it will be applied to the cell.
An interpolated string template url that can be used to override the default month cell template.
An interpolated string template url that can be used to override the default month cell events.
All templates apart from the month cell templates are linked to directives so you can change any template and use your own using a decorator like so:
//This will change the slide box directive template to one of your choosing
app.config(function($provide) {
$provide.decorator('mwlCalendarSlideBoxDirective', function($delegate) {
var directive = $delegate[0];
delete directive.template; //the calendar uses template instead of template-url so you need to delete this
directive.templateUrl = 'path/to/my/slide/box/template.html';
return $delegate;
});
});
For more info on using decorators see this great guide.
There is also a helper directive that you can use for the next, today and previous buttons. Use it like so:
<button
class="btn btn-primary"
mwl-date-modifier
date="calendarDay"
decrement="calendarView">
Previous
</button>
<button
class="btn btn-default"
mwl-date-modifier
date="calendarDay"
set-to-today>
Today
</button>
<button
class="btn btn-primary"
mwl-date-modifier
date="calendarDay"
increment="calendarView">
Next
</button>You can either use angular's date filter or moment.js to format dates. The default is to use angular. You can change the formatter to be moment like so:
angular.module('myModule')
.config(function(calendarConfigProvider) {
calendarConfigProvider.setDateFormatter('moment'); // use moment to format dates
});Then you just need to include the appropriate locale files for your app.
If you want to dynamically change the locale for angular and not include all of the available angular locale files try this library.
Otherwise if using moment you can call moment.locale('YOUR_LOCALE_STRING') to change the locale and the calendar will auto update.
To set Monday as the first day of the week, configure it in moment like so (even if using angular for formatting dates):
moment.locale('en', {
week : {
dow : 1 // Monday is the first day of the week
}
});You can easily customise the date formats and i18n strings used throughout the calendar by using the calendarConfigProvider. Please note that these example formats are those used by moment.js and these won't work if using angular as the date formatter. Example usage:
angular.module('myModule')
.config(function(calendarConfigProvider) {
calendarConfigProvider.setDateFormatter('moment'); // use either moment or angular to format dates on the calendar. Default angular. Setting this will override any date formats you have already set.
calendarConfigProvider.setDateFormats({
hour: 'HH:mm' // this will configure times on the day view to display in 24 hour format rather than the default of 12 hour
});
calendarConfigProvider.setTitleFormats({
day: 'ddd D MMM' //this will configure the day view title to be shorter
});
calendarConfigProvider.setI18nStrings({
eventsLabel: 'Events', //This will set the events label on the day view
timeLabel: 'Time' //This will set the time label on the time view
});
calendarConfigProvider.setDisplayAllMonthEvents(true); //This will display all events on a month view even if they're not in the current month. Default false.
calendarConfigProvider.setDisplayEventEndTimes(true); //This will display event end times on the month and year views. Default false.
});For a full list of all available formats and their defaults see calendarConfig.js
http://mattlewis92.github.io/angular-bootstrap-calendar/
- Install Node.js and NPM (should come with)
- Install local dev dependencies:
npm installwhile current directory is this repo
Run npm start to start a development server on port 8000 with auto reload + run tests.
Run npm test to run tests once or npm run test:watch to continually run tests (this is automatic when you run npm start).
Run npm run build to build the project files in the dist folder
The MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.