README.md

angular 2.0+ calendar

Demo

https://mattlewis92.github.io/angular-calendar/demos/

Table of contents

• About
• Getting started
• Documentation
• Angular 1 version
• Development
• License

About

A calendar component for angular 2.0+ that can display events on a month, week or day view. The successor of: https://github.com/mattlewis92/angular-bootstrap-calendar

Getting started

First install through npm:

npm install --save angular-calendar

Next include the CSS file somewhere into your app:

node_modules/angular-calendar/dist/css/angular-calendar.css

Finally import the calendar module into your apps module:

import { NgModule } from '@angular/core';
import { CalendarModule } from 'angular-calendar';

@NgModule({
  imports: [
    CalendarModule.forRoot()
  ]
})
export class MyModule {}

Then you can use the mwl-calendar-month-view, mwl-calendar-week-view and mwl-calendar-day-view components in your app. For a full e2e example see the demo source.

Module bundlers

You can find quick start examples for all common module bundlers in the examples folder.

Usage without a module bundler

<script src="node_modules/angular-calendar/dist/umd/angular-calendar.js"></script>
<script>
    // everything is exported angularCalendar namespace
</script>

Documentation

To see all available API options see the auto generated documentation or you may find it helpful to view the examples on the demo page.

Angular 1 version

https://github.com/mattlewis92/angular-bootstrap-calendar

Development

Prepare your environment

• Install Node.js and NPM (should come with)
• Install local dev dependencies: npm install while current directory is this repo

Development server

Run npm start to start a development server on port 8000 with auto reload + tests.

Testing

Run npm test to run tests once or npm run test:watch to continually run tests.

Release

• Bump the version in package.json (once the module hits 1.0 this will become automatic)

npm run release

License

MIT