ngx-icon-calendar
TypeScript icon, indicating that this package has built-in type declarations

1.5.2 • Public • Published

NgxIconCalendar

ngx-icon-calendar is a very simple Angular calendar component with a month-view. It allows you to display up to 4 icons at once or show a dialog for more than that.

ngx-icon-calendar screenshot

Features

  1. Very light-weight monthly calendar, drawn with basic JS.
  2. Displays up to 4 icons at once. Displays a button to show a dialog for more than 4 icons.
  3. Responsive modern material design.

Installation

Run npm install ngx-icon-calendar --save or download zip from github / clone repo.

Usage

Include the module in your component as:

import { NgxIconCalendarModule } from 'ngx-icon-calendar';

Add the component in your HTML with the following inputs:

<ngx-icon-calendar
        [events]="events"
        [iconPath]="'assets/my_icons/'"
        [iconFormat]="'.png'"
        [prevButtonText]="'previous'"
        [nextButtonText]="'next'"
        [daysShort]="['mon', 'tue', 'wed', 'thu', 'fri', 'sat', 'sun']"
>
</ngx-icon-calendar>
 
  iconPath (required): Relative path to your icons.
  iconFormat (optional. Default: '.png'): Image format of your icons.
  prevButtonText (optional. Default: 'previous'): Text for previous button.
  nextButtonText (optional. Default: 'next'): Text for next button.
  daysShort (optional. Default: 'mon', 'tue', 'wed', 'thu', 'fri', 'sat', 'sun'): Shortened day names.
 

Your events array should look like the following:

  events = {
    '2020-09-15': { icon: 'food' },
    '2020-09-16': { icon: 'food-gym' },
    '2020-09-17': { icon: 'food-gym-book' },
    '2020-09-18': { icon: 'food-gym-book-car' },
    '2020-09-19': { icon: 'food-gym-book-car-fifthIcon' }
  };

Finally, for the styling you can use the following classes in your css:

.primary-bg {
  color: mat-color($your-primary-variable);
}
.accent-bg {
  color: mat-color($your-accent-variable);
}

Or simply:

.primary-bg {
  background-color: #ffffff;
}
.accent-bg {
  background-color: #000000;
}

Package Sidebar

Install

npm i ngx-icon-calendar

Weekly Downloads

0

Version

1.5.2

License

MIT

Unpacked Size

305 kB

Total Files

24

Last publish

Collaborators

  • tahaerden