17.0.7 • Published 1 month ago

@frxjs/ngx-timeline v17.0.7

Weekly downloads
-
License
MIT
Repository
github
Last release
1 month ago

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 17.0.7 is compatible with angular 17. Go here and discover all possible configurations for the timeline

image

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 nameExplanationMandatoryType/Supported ValuesDefault value
eventslist of events to be displayedyesNgxTimelineEventno default
langCodelanguage code use to format datesno'en''it''fr''de''es''sl''tr''pl''pt''ru''en'
enableAnimationBoolean used to enable or disable the animationsnobooleantrue
reverseOrderBoolean used to reverse sort order (default older first)nobooleanfalse
groupEventLogic to be applied in order to group eventsnoenum NgxTimelineEventGroupNgxTimelineEventGroup.MONTH_YEAR
changeSideLogic to be applied in order to put events on LEFT or RIGHTnoenum NgxTimelineEventChangeSideNgxTimelineEventChangeSide.ON_DIFFERENT_DAY_IN_GROUP
periodCustomTemplateCustom Template displayed before a group of eventsnoTemplateRefno default
eventCustomTemplateCustom Template displayed to show a single eventnoTemplateRefno default
centerIconCustomTemplateCustom Template displayed to show an separator iconnoTemplateRefno default
dateInstantCustomTemplateCustom Template displayed to show the side datenoTemplateRefno default
innerEventCustomTemplateCustom Template displayed to show the inner eventnoTemplateRefno default
eventDescriptionCustomTemplateCustom Template displayed to show the descriptionnoTemplateRefno default

Output

Output nameExplanationMandatoryType/Supported ValuesDefault value
clickEmitterOutput click event emitternoBehaviorSubjectno default

Types and Enums

interface NgxTimelineEvent {
  timestamp?: Date;
  title?: string;
  description?: string;
  id?: any;
  itemPosition?: NgxTimelineItemPosition;
}
enum NgxTimelineEventGroup {
  YEAR = 'YEAR',
  MONTH_YEAR = 'MONTH_YEAR',
  DAY_MONTH_YEAR = 'DAY_MONTH_YEAR'
}
enum NgxTimelineEventChangeSide {
  ALL = 'ALL',
  ALL_IN_GROUP = 'ALL_IN_GROUP',
  ON_DIFFERENT_DAY_IN_GROUP = 'ON_DIFFERENT_DAY_IN_GROUP',
  ON_DIFFERENT_HMS_IN_GROUP = 'ON_DIFFERENT_HMS_IN_GROUP',
  ON_DIFFERENT_MONTH_IN_GROUP = 'ON_DIFFERENT_MONTH_IN_GROUP'
}

To start the contribution:

  • npm run watch-lib (you are building 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

How to deploy new version (for maintainers only)

After testing the fix or the new feature with 100% test coverage:

  • npm run lint:fix
  • npm run prepare-github-pages
  • npm run new-version patch
  • git push --tags
  • git push
  • npm run publish
17.0.7

1 month ago

17.0.5

2 months ago

17.0.4

3 months ago

17.0.3

3 months ago

17.0.2

4 months ago

2.2.1

10 months ago

2.2.3

7 months ago

2.2.2

10 months ago

2.2.4

7 months ago

17.0.1

6 months ago

17.0.0

6 months ago

2.2.0

11 months ago

1.2.7

1 year ago

2.1.0

12 months ago

2.0.0

12 months ago

1.2.6

1 year ago

1.2.5

1 year ago

1.2.4

1 year ago

1.2.3

2 years ago

1.2.2

2 years ago

1.2.1

2 years ago

1.2.0

2 years ago

1.1.0

2 years ago

1.0.12

2 years ago

1.0.7

2 years ago

1.0.6

2 years ago

1.0.2

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago

1.0.5

3 years ago

1.0.4

3 years ago

1.0.3

3 years ago

0.0.10

3 years ago

0.0.9

3 years ago

0.0.8

3 years ago

0.0.7

3 years ago

0.0.6

3 years ago

0.0.5

3 years ago

0.0.4

3 years ago

0.0.3

3 years ago

0.0.2

3 years ago

0.0.1

3 years ago