NGX-Chronology

This is a chronology module and components for Angular projects. Live Demo Here

Badges

Installing / Getting started

To get started using the library install from npm

npm i ngx-chronology --save

This will give you access to the module and components available in the library.

Add module to you NgModule

After installing the library to get access to the features you need to add it to your AppModule.

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { NgxChronologyModule } from 'ngx-chronology';

@NgModule({
   imports: [BrowserModule, NgxChronologyModule],
   declarations: [AppComponent],
})
export class AppModule {}

The inside of you app.component.html you can use the component directve like so:

<ngx-chronology [title]="chronologyTitle" [events]="ArrayOfEvents"></ngx-chronology>

Api Reference

The array of events passed to 'ngx-chronology' component should be a set of objects that match the interface:

export interface IChronologyEvent {
   title: string;
   icon?: string;
   faLibrary: 'far' | 'fas' | 'fab';
   content: string;
}

Want to Contribute?

Go check out our Contributing Document for more information on getting setup.