Skip to content

Latest commit

 

History

History
254 lines (186 loc) · 8.97 KB

README.md

File metadata and controls

254 lines (186 loc) · 8.97 KB
Raw

angular-material-extensions' logo

calendar - angular responsive calendar built with material design for desktop and mobile

npm version npm demo Join the chat at https://gitter.im/angular-material-extensions/Lobby Build Status Coverage Status dependency Status devDependency Status Greenkeeper Badge license

Built by and for developers ❤️

Do you have any question or suggestion ? Please do not hesitate to contact us! Alternatively, provide a PR | open an appropriate issue here

If did you like this project, support angular-material-extensions by starring ⭐ and sharing it 📢

Table of Contents

Demo

View all the directives in action at https://angular-material-extensions.github.io/calendar

Dependencies

  • Angular developed and tested with 6.1.78

Requirements (peer dependencies):

npm i @angular/cdk @angular/material @angular/animations @angular/forms

or use angular schematics like e.g:

ng add @angular/material

Additional requirements Theme (Material Design)

Additional Requirements - Import the material design icons learn more

  • The easiest way to import material design icons is to provide a link in your index.html file like below:
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
  • alternative solution:
  1. Install of the official npm module of the material design icons
npm i -s material-design-icons
  1. Import them in your angular.json file
"styles": [
        "styles.css",
        "../node_modules/material-design-icons/iconfont/material-icons.css"
      ],

Installation

Install above dependencies via npm.

Now install @angular-material-extensions/calendar via:

npm install --save @angular-material-extensions/calendar
SystemJS

Note:If you are using SystemJS, you should adjust your configuration to point to the UMD bundle. In your systemjs config file, map needs to tell the System loader where to look for @angular-material-extensions/calendar:

map: {
  '@angular-material-extensions/calendar': 'node_modules/@angular-material-extensions/calendar/bundles/calendar.umd.js',
}

Once installed you need to import the main module:

import { MatCalendarModule } from '@angular-material-extensions/calendar';

The only remaining part is to list the imported module in your application module. The exact method will be slightly different for the root (top-level) module for which you should end up with the code similar to (notice MatCalendarModule .forRoot()):

import { MatCalendarModule } from '@angular-material-extensions/calendar';

@NgModule({
  declarations: [AppComponent, ...],
  imports: [MatCalendarModule.forRoot(), ...],  
  bootstrap: [AppComponent]
})
export class AppModule {
}

Other modules in your application can simply import MatCalendarModule:

import { MatCalendarModule } from '@angular-material-extensions/calendar';

@NgModule({
  declarations: [OtherComponent, ...],
  imports: [MatCalendarModule, ...], 
})
export class OtherModule {
}

Usage

Run Demo App Locally

$ git clone https://github.com/angular-material-extensions/calendar.git
  • link the @angular-material-extensions/calendar package
$ gulp link
  • navigate to the demo app directory
$ cd demo
  • install the dependencies
$ npm i
  • run/start/serve the app
$ npm run start

or

$ ng serve --open
  • the app is now hosted by http://localhost:4200/

Development

  1. clone this repo
  2. Install the dependencies by running npm i
  3. build the library npm run build or gulp build
  4. Link the library gulp link
  5. Navigate to the demo app's directory
  • cd demo _ npm i _ npm start

Other Angular Libraries

Support

Built by and for developers ❤️ we will help you 👊

jetbrains logo

This project is supported by jetbrains with 1 ALL PRODUCTS PACK OS LICENSE incl. webstorm

License

Copyright (c) 2018 Anthony Nahas. Licensed under the MIT License (MIT)