@frxjs/ngx-timeline

The main goal of this angular library is to give you the possibility to integrate a timeline in your app. <br/> Version 1.2.0 is compatible with angular 13. <br/> Go [here](https://emanuelefricano93.github.io/frxjs-Ngx-Timeline/) and discover all possible

Usage no npm install needed!

<script type="module">
  import frxjsNgxTimeline from 'https://cdn.skypack.dev/@frxjs/ngx-timeline';
</script>

README

NgxTimeline check-code-coverage

The main goal of this angular library is to give you the possibility to integrate a timeline in your app.
Version 1.2.0 is compatible with angular 13.
Go here and discover all possible configurations for the timeline

image

Fig.1 - Preview of Timeline example configuration page



Installation

Running the following command to install the library

npm install @frxjs/ngx-timeline



Examples of Usage

After installing the library and including NgxTimelineModule in your imports module you could add one of following examples to your template in order to display your timeline

<ngx-timeline [events]="events"></ngx-timeline>
<ngx-timeline [events]="events" [langCode]="it"></ngx-timeline>
<ngx-timeline [events]="events" [langCode]="it" [enableAnimation]="false"></ngx-timeline>



Configuration

Input

Input name Explanation Mandatory Type/Supported Values Default value
events list of events to be displayed yes NgxTimelineEvent no default
langCode language code use to format dates no
  • 'en'
  • 'it'
  • 'fr'
  • 'de'
  • 'es'
'en'
enableAnimation Boolean used to enable or disable the animations no boolean true
groupEvent Logic to be applied in order to group events no enum NgxTimelineEventGroup NgxTimelineEventGroup.MONTH_YEAR
changeSideInGroup Logic to be applied in order to put evetns on LEFT or RIGHT no enum NgxTimelineEventChangeSideInGroup NgxTimelineEventChangeSideInGroup.ON_DIFFERENT_DAY
periodCustomTemplate Custom Template displayed before a group of events no TemplateRef no default
eventCustomTemplate Custom Template displayed to show a single event no TemplateRef no default
centerIconCustomTemplate Custom Template displayed to show an separator icon no TemplateRef no default
dateInstantCustomTemplate Custom Template displayed to show the side date no TemplateRef no default
innerEventCustomTemplate Custom Template displayed to show the inner event no TemplateRef no default

Output

Output name Explanation Mandatory Type/Supported Values Default value
clickEmitter Output click event emitter no BehaviorSubject no default

Types and Enums

interface NgxTimelineEvent {
  timestamp?: Date;
  title?: string;
  description?: string;
  id?: any;
}
enum NgxTimelineEventGroup {
  YEAR = 'YEAR',
  MONTH_YEAR = 'MONTH_YEAR',
  DAY_MONTH_YEAR = 'DAY_MONTH_YEAR'
}
enum NgxTimelineEventChangeSideInGroup {
  ALL = 'ALL',
  ON_DIFFERENT_HMS = 'ON_DIFFERENT_HMS',
  ON_DIFFERENT_DAY = 'ON_DIFFERENT_DAY',
  ON_DIFFERENT_MONTH = 'ON_DIFFERENT_MONTH'
}

Examples with contexts of custom templates

  <ng-template #periodCustomTemplate let-period=period let-index=index>
    <div [ngClass]="{'transparent first-line': !index}" class="line"></div>
    <div class="period-container">
      <p>
        {{index}} - {{period | json  }}
      </p>
    </div>
    <div class="line"></div>
  </ng-template>
  <ng-template #centerIconCustomTemplate>
    <div class="icon-container">
      <img src="assets/image.png"/>
    </div>
  </ng-template>
  <ng-template #innerEventCustomTemplate let-event=event>
    <div class="event" (click)="handleClick(event)">
      {{event | json}}
    </div>
  </ng-template>
  <ng-template #eventCustomTemplate let-event=event let-colSidePosition=colSidePosition>
    <div class="event" (click)="handleClick(event)">
      {{event | json}}
    </div>
  </ng-template>
  <ng-template #dateInstantCustomTemplate let-item=item>
    <span>
      {{item | json}}
    </span>
  </ng-template>



How to contribute

First of all, in order to track everything, open an issue describing the problem or a missing functionality you would like to add to the lib.

To start the contribution:

  • npm run watch-lib (you are builduing the lib with --watch options)
  • npm run start-dev (you are linking the lib and starting the demo app )

Every time you will change the code in your lib, any update will trigger the re-load of the app. When your code will be ready, create a Pull Request and put the link in a comment under the issue you opened before. Now is time to enjoy and start to code.

Thanks in advance for your contribution