@frxjs/ngx-timeline 1.0.6 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/README.md +138 -136
  2. package/esm2020/frxjs-ngx-timeline.mjs +5 -0
  3. package/{esm2015/lib/components/index.js → esm2020/lib/components/index.mjs} +3 -3
  4. package/esm2020/lib/components/ngx-timeline-event/ngx-timeline-event.component.mjs +58 -0
  5. package/esm2020/lib/components/ngx-timeline.component.mjs +157 -0
  6. package/esm2020/lib/models/NgxConfigObj.mjs +93 -0
  7. package/esm2020/lib/models/NgxTimelineEvent.mjs +6 -0
  8. package/{esm2015/lib/models/index.js → esm2020/lib/models/index.mjs} +3 -3
  9. package/esm2020/lib/ngx-timeline.module.mjs +28 -0
  10. package/{esm2015/lib/pipes/index.js → esm2020/lib/pipes/index.mjs} +2 -2
  11. package/esm2020/lib/pipes/ngx-date-pipe.mjs +31 -0
  12. package/{esm2015/public-api.js → esm2020/public-api.mjs} +7 -7
  13. package/fesm2015/frxjs-ngx-timeline.mjs +366 -0
  14. package/fesm2015/frxjs-ngx-timeline.mjs.map +1 -0
  15. package/fesm2020/frxjs-ngx-timeline.mjs +365 -0
  16. package/fesm2020/frxjs-ngx-timeline.mjs.map +1 -0
  17. package/frxjs-ngx-timeline.d.ts +5 -7
  18. package/lib/components/index.d.ts +2 -2
  19. package/lib/components/ngx-timeline-event/ngx-timeline-event.component.d.ts +38 -35
  20. package/lib/components/ngx-timeline.component.d.ts +79 -76
  21. package/lib/models/NgxConfigObj.d.ts +59 -59
  22. package/lib/models/NgxTimelineEvent.d.ts +29 -29
  23. package/lib/models/index.d.ts +2 -2
  24. package/lib/ngx-timeline.module.d.ts +10 -2
  25. package/lib/pipes/index.d.ts +1 -1
  26. package/lib/pipes/ngx-date-pipe.d.ts +10 -7
  27. package/package.json +22 -9
  28. package/public-api.d.ts +4 -4
  29. package/bundles/frxjs-ngx-timeline.umd.js +0 -696
  30. package/bundles/frxjs-ngx-timeline.umd.js.map +0 -1
  31. package/bundles/frxjs-ngx-timeline.umd.min.js +0 -2
  32. package/bundles/frxjs-ngx-timeline.umd.min.js.map +0 -1
  33. package/esm2015/frxjs-ngx-timeline.js +0 -8
  34. package/esm2015/lib/components/ngx-timeline-event/ngx-timeline-event.component.js +0 -55
  35. package/esm2015/lib/components/ngx-timeline.component.js +0 -147
  36. package/esm2015/lib/models/NgxConfigObj.js +0 -93
  37. package/esm2015/lib/models/NgxTimelineEvent.js +0 -6
  38. package/esm2015/lib/ngx-timeline.module.js +0 -23
  39. package/esm2015/lib/pipes/ngx-date-pipe.js +0 -28
  40. package/fesm2015/frxjs-ngx-timeline.js +0 -350
  41. package/fesm2015/frxjs-ngx-timeline.js.map +0 -1
  42. package/frxjs-ngx-timeline.metadata.json +0 -1
@@ -1,76 +1,79 @@
1
- import { OnInit, TemplateRef, OnChanges, SimpleChanges } from '@angular/core';
2
- import { NgxTimelineEvent, NgxTimelineItem, NgxTimelineItemPosition, NgxTimelinePeriodInfo, NgxDateFormat, NgxTimelineEventGroup, NgxTimelineEventChangeSideInGroup } from '../models';
3
- import { BehaviorSubject } from 'rxjs';
4
- export declare class NgxTimelineComponent implements OnInit, OnChanges {
5
- /**
6
- * List of events to be displayed
7
- */
8
- events: NgxTimelineEvent[];
9
- /**
10
- * Language code used to show the date formatted
11
- */
12
- langCode?: string;
13
- /**
14
- * Boolean used to enable or disable the animations
15
- */
16
- enableAnimation: boolean;
17
- /**
18
- * Logic to be applied in order to group events
19
- */
20
- groupEvent?: NgxTimelineEventGroup;
21
- /**
22
- * Logic to be applied in order to put evetns on LEFT or RIGHT
23
- */
24
- changeSideInGroup?: NgxTimelineEventChangeSideInGroup;
25
- /**
26
- * Custom Template displayed before a group of events
27
- */
28
- periodCustomTemplate: TemplateRef<any>;
29
- /**
30
- * Custom Template displayed to show a single event
31
- */
32
- eventCustomTemplate: TemplateRef<any>;
33
- /**
34
- * Custom Template displayed to show an separator icon
35
- */
36
- centerIconCustomTemplate: TemplateRef<any>;
37
- /**
38
- * Custom Template displayed to show the side date
39
- */
40
- dateInstantCustomTemplate: TemplateRef<any>;
41
- /**
42
- * Custom Template displayed to show the inner event
43
- */
44
- innerEventCustomTemplate: TemplateRef<any>;
45
- /**
46
- * Output click event emitter
47
- */
48
- clickEmitter: BehaviorSubject<NgxTimelineItem>;
49
- groups: {
50
- [key: string]: NgxTimelineEvent[];
51
- };
52
- periods: NgxTimelineItem[];
53
- items: NgxTimelineItem[];
54
- ngxTimelineItemPosition: typeof NgxTimelineItemPosition;
55
- ngxDateFormat: typeof NgxDateFormat;
56
- private readonly separator;
57
- constructor();
58
- ngOnInit(): void;
59
- ngOnChanges(changes: SimpleChanges): void;
60
- getPeriodKeyDateFormat(): string;
61
- protected clear(): void;
62
- protected groupEvents(events: NgxTimelineEvent[]): void;
63
- protected sortEvents(events: NgxTimelineEvent[]): void;
64
- protected setGroups(events: NgxTimelineEvent[]): void;
65
- protected setItems(): void;
66
- protected addPeriodEvents(periodInfo: NgxTimelinePeriodInfo, onLeft: boolean): void;
67
- protected pushEventOnItems(event: NgxTimelineEvent, onLeft: boolean): void;
68
- /**
69
- * Compare the events inside the same group
70
- */
71
- protected compareEvents(prevEvent: NgxTimelineEvent, event: NgxTimelineEvent): boolean;
72
- protected compareEventsField(prevEvent: NgxTimelineEvent, event: NgxTimelineEvent, ...fields: string[]): boolean;
73
- protected setPeriods(): void;
74
- private getPeriodInfo;
75
- protected getPeriodKeyFromEvent(event: NgxTimelineEvent): string;
76
- }
1
+ import { OnInit, TemplateRef, OnChanges, SimpleChanges } from '@angular/core';
2
+ import { NgxTimelineEvent, NgxTimelineItem, NgxTimelineItemPosition, NgxTimelinePeriodInfo, NgxDateFormat, NgxTimelineEventGroup, NgxTimelineEventChangeSideInGroup } from '../models';
3
+ import { BehaviorSubject } from 'rxjs';
4
+ import * as i0 from "@angular/core";
5
+ export declare class NgxTimelineComponent implements OnInit, OnChanges {
6
+ /**
7
+ * List of events to be displayed
8
+ */
9
+ events: NgxTimelineEvent[];
10
+ /**
11
+ * Language code used to show the date formatted
12
+ */
13
+ langCode?: string;
14
+ /**
15
+ * Boolean used to enable or disable the animations
16
+ */
17
+ enableAnimation: boolean;
18
+ /**
19
+ * Logic to be applied in order to group events
20
+ */
21
+ groupEvent?: NgxTimelineEventGroup;
22
+ /**
23
+ * Logic to be applied in order to put evetns on LEFT or RIGHT
24
+ */
25
+ changeSideInGroup?: NgxTimelineEventChangeSideInGroup;
26
+ /**
27
+ * Custom Template displayed before a group of events
28
+ */
29
+ periodCustomTemplate: TemplateRef<any>;
30
+ /**
31
+ * Custom Template displayed to show a single event
32
+ */
33
+ eventCustomTemplate: TemplateRef<any>;
34
+ /**
35
+ * Custom Template displayed to show an separator icon
36
+ */
37
+ centerIconCustomTemplate: TemplateRef<any>;
38
+ /**
39
+ * Custom Template displayed to show the side date
40
+ */
41
+ dateInstantCustomTemplate: TemplateRef<any>;
42
+ /**
43
+ * Custom Template displayed to show the inner event
44
+ */
45
+ innerEventCustomTemplate: TemplateRef<any>;
46
+ /**
47
+ * Output click event emitter
48
+ */
49
+ clickEmitter: BehaviorSubject<NgxTimelineItem>;
50
+ groups: {
51
+ [key: string]: NgxTimelineEvent[];
52
+ };
53
+ periods: NgxTimelineItem[];
54
+ items: NgxTimelineItem[];
55
+ ngxTimelineItemPosition: typeof NgxTimelineItemPosition;
56
+ ngxDateFormat: typeof NgxDateFormat;
57
+ private readonly separator;
58
+ constructor();
59
+ ngOnInit(): void;
60
+ ngOnChanges(changes: SimpleChanges): void;
61
+ getPeriodKeyDateFormat(): string;
62
+ protected clear(): void;
63
+ protected groupEvents(events: NgxTimelineEvent[]): void;
64
+ protected sortEvents(events: NgxTimelineEvent[]): void;
65
+ protected setGroups(events: NgxTimelineEvent[]): void;
66
+ protected setItems(): void;
67
+ protected addPeriodEvents(periodInfo: NgxTimelinePeriodInfo, onLeft: boolean): void;
68
+ protected pushEventOnItems(event: NgxTimelineEvent, onLeft: boolean): void;
69
+ /**
70
+ * Compare the events inside the same group
71
+ */
72
+ protected compareEvents(prevEvent: NgxTimelineEvent, event: NgxTimelineEvent): boolean;
73
+ protected compareEventsField(prevEvent: NgxTimelineEvent, event: NgxTimelineEvent, ...fields: string[]): boolean;
74
+ protected setPeriods(): void;
75
+ private getPeriodInfo;
76
+ protected getPeriodKeyFromEvent(event: NgxTimelineEvent): string;
77
+ static ɵfac: i0.ɵɵFactoryDeclaration<NgxTimelineComponent, never>;
78
+ static ɵcmp: i0.ɵɵComponentDeclaration<NgxTimelineComponent, "ngx-timeline", never, { "events": "events"; "langCode": "langCode"; "enableAnimation": "enableAnimation"; "groupEvent": "groupEvent"; "changeSideInGroup": "changeSideInGroup"; "periodCustomTemplate": "periodCustomTemplate"; "eventCustomTemplate": "eventCustomTemplate"; "centerIconCustomTemplate": "centerIconCustomTemplate"; "dateInstantCustomTemplate": "dateInstantCustomTemplate"; "innerEventCustomTemplate": "innerEventCustomTemplate"; }, { "clickEmitter": "clickEmitter"; }, never, never>;
79
+ }
@@ -1,59 +1,59 @@
1
- export declare let supportedLanguageCodes: string[];
2
- export interface NgxConfigDate {
3
- code: string;
4
- dayMonthYear: string;
5
- fullDate: string;
6
- hoursMinutes: string;
7
- monthYear: string;
8
- year: string;
9
- }
10
- export interface NgxDateObjMap {
11
- [key: string]: NgxConfigDate;
12
- }
13
- export declare let dateConfigMap: NgxDateObjMap;
14
- export declare enum NgxDateFormat {
15
- DAY_MONTH_YEAR = "DAY_MONTH_YEAR",
16
- FULL_DATE = "FULL_DATE",
17
- MONTH_YEAR = "MONTH_YEAR",
18
- HOURS_MINUTES = "HOURS_MINUTES",
19
- YEAR = "YEAR"
20
- }
21
- export declare let fieldConfigDate: {
22
- MONTH_YEAR: string;
23
- YEAR: string;
24
- HOURS_MINUTES: string;
25
- FULL_DATE: string;
26
- DAY_MONTH_YEAR: string;
27
- };
28
- /**
29
- * Enum used to set the group event logic
30
- */
31
- export declare enum NgxTimelineEventGroup {
32
- YEAR = "YEAR",
33
- MONTH_YEAR = "MONTH_YEAR",
34
- DAY_MONTH_YEAR = "DAY_MONTH_YEAR"
35
- }
36
- export declare let fieldsToAddEventGroup: {
37
- YEAR: string[];
38
- MONTH_YEAR: string[];
39
- DAY_MONTH_YEAR: string[];
40
- };
41
- export declare let periodKeyDateFormat: {
42
- YEAR: NgxDateFormat;
43
- MONTH_YEAR: NgxDateFormat;
44
- DAY_MONTH_YEAR: NgxDateFormat;
45
- };
46
- /**
47
- * Enum used to set the change side event logic
48
- */
49
- export declare enum NgxTimelineEventChangeSideInGroup {
50
- ALL = "ALL",
51
- ON_DIFFERENT_HMS = "ON_DIFFERENT_HMS",
52
- ON_DIFFERENT_DAY = "ON_DIFFERENT_DAY",
53
- ON_DIFFERENT_MONTH = "ON_DIFFERENT_MONTH"
54
- }
55
- export declare let fieldsToCheckEventChangeSideInGroup: {
56
- ON_DIFFERENT_MONTH: string[];
57
- ON_DIFFERENT_DAY: string[];
58
- ON_DIFFERENT_HMS: string[];
59
- };
1
+ export declare const supportedLanguageCodes: string[];
2
+ export interface NgxConfigDate {
3
+ code: string;
4
+ dayMonthYear: string;
5
+ fullDate: string;
6
+ hoursMinutes: string;
7
+ monthYear: string;
8
+ year: string;
9
+ }
10
+ export interface NgxDateObjMap {
11
+ [key: string]: NgxConfigDate;
12
+ }
13
+ export declare const dateConfigMap: NgxDateObjMap;
14
+ export declare enum NgxDateFormat {
15
+ DAY_MONTH_YEAR = "DAY_MONTH_YEAR",
16
+ FULL_DATE = "FULL_DATE",
17
+ MONTH_YEAR = "MONTH_YEAR",
18
+ HOURS_MINUTES = "HOURS_MINUTES",
19
+ YEAR = "YEAR"
20
+ }
21
+ export declare const fieldConfigDate: {
22
+ MONTH_YEAR: string;
23
+ YEAR: string;
24
+ HOURS_MINUTES: string;
25
+ FULL_DATE: string;
26
+ DAY_MONTH_YEAR: string;
27
+ };
28
+ /**
29
+ * Enum used to set the group event logic
30
+ */
31
+ export declare enum NgxTimelineEventGroup {
32
+ YEAR = "YEAR",
33
+ MONTH_YEAR = "MONTH_YEAR",
34
+ DAY_MONTH_YEAR = "DAY_MONTH_YEAR"
35
+ }
36
+ export declare const fieldsToAddEventGroup: {
37
+ YEAR: string[];
38
+ MONTH_YEAR: string[];
39
+ DAY_MONTH_YEAR: string[];
40
+ };
41
+ export declare const periodKeyDateFormat: {
42
+ YEAR: NgxDateFormat;
43
+ MONTH_YEAR: NgxDateFormat;
44
+ DAY_MONTH_YEAR: NgxDateFormat;
45
+ };
46
+ /**
47
+ * Enum used to set the change side event logic
48
+ */
49
+ export declare enum NgxTimelineEventChangeSideInGroup {
50
+ ALL = "ALL",
51
+ ON_DIFFERENT_HMS = "ON_DIFFERENT_HMS",
52
+ ON_DIFFERENT_DAY = "ON_DIFFERENT_DAY",
53
+ ON_DIFFERENT_MONTH = "ON_DIFFERENT_MONTH"
54
+ }
55
+ export declare const fieldsToCheckEventChangeSideInGroup: {
56
+ ON_DIFFERENT_MONTH: string[];
57
+ ON_DIFFERENT_DAY: string[];
58
+ ON_DIFFERENT_HMS: string[];
59
+ };
@@ -1,29 +1,29 @@
1
- /**
2
- * Event to be provided from outside the timeline
3
- */
4
- export interface NgxTimelineEvent {
5
- timestamp?: Date;
6
- title?: string;
7
- description?: string;
8
- id?: any;
9
- }
10
- export interface NgxTimelinePeriodInfo {
11
- periodKey?: string;
12
- year?: number;
13
- month?: number;
14
- day?: number;
15
- firstDate?: any;
16
- }
17
- /**
18
- * Item used inside the timeline
19
- */
20
- export interface NgxTimelineItem {
21
- type?: string;
22
- position?: NgxTimelineItemPosition.ON_LEFT | NgxTimelineItemPosition.ON_RIGHT;
23
- periodInfo?: NgxTimelinePeriodInfo;
24
- eventInfo?: NgxTimelineEvent;
25
- }
26
- export declare enum NgxTimelineItemPosition {
27
- ON_LEFT = "ON_LEFT",
28
- ON_RIGHT = "ON_RIGHT"
29
- }
1
+ /**
2
+ * Event to be provided from outside the timeline
3
+ */
4
+ export interface NgxTimelineEvent {
5
+ timestamp?: Date;
6
+ title?: string;
7
+ description?: string;
8
+ id?: any;
9
+ }
10
+ export interface NgxTimelinePeriodInfo {
11
+ periodKey?: string;
12
+ year?: number;
13
+ month?: number;
14
+ day?: number;
15
+ firstDate?: any;
16
+ }
17
+ /**
18
+ * Item used inside the timeline
19
+ */
20
+ export interface NgxTimelineItem {
21
+ type?: string;
22
+ position?: NgxTimelineItemPosition.ON_LEFT | NgxTimelineItemPosition.ON_RIGHT;
23
+ periodInfo?: NgxTimelinePeriodInfo;
24
+ eventInfo?: NgxTimelineEvent;
25
+ }
26
+ export declare enum NgxTimelineItemPosition {
27
+ ON_LEFT = "ON_LEFT",
28
+ ON_RIGHT = "ON_RIGHT"
29
+ }
@@ -1,2 +1,2 @@
1
- export * from './NgxConfigObj';
2
- export * from './NgxTimelineEvent';
1
+ export * from './NgxConfigObj';
2
+ export * from './NgxTimelineEvent';
@@ -1,2 +1,10 @@
1
- export declare class NgxTimelineModule {
2
- }
1
+ import * as i0 from "@angular/core";
2
+ import * as i1 from "./components/ngx-timeline.component";
3
+ import * as i2 from "./components/ngx-timeline-event/ngx-timeline-event.component";
4
+ import * as i3 from "./pipes/ngx-date-pipe";
5
+ import * as i4 from "@angular/common";
6
+ export declare class NgxTimelineModule {
7
+ static ɵfac: i0.ɵɵFactoryDeclaration<NgxTimelineModule, never>;
8
+ static ɵmod: i0.ɵɵNgModuleDeclaration<NgxTimelineModule, [typeof i1.NgxTimelineComponent, typeof i2.NgxTimelineEventComponent, typeof i3.NgxDatePipe], [typeof i4.CommonModule], [typeof i1.NgxTimelineComponent, typeof i3.NgxDatePipe]>;
9
+ static ɵinj: i0.ɵɵInjectorDeclaration<NgxTimelineModule>;
10
+ }
@@ -1 +1 @@
1
- export * from './ngx-date-pipe';
1
+ export * from './ngx-date-pipe';
@@ -1,7 +1,10 @@
1
- import { PipeTransform } from '@angular/core';
2
- export declare class NgxDatePipe implements PipeTransform {
3
- constructor();
4
- transform(date: Date | string, dateFormat?: string, langCode?: string): string;
5
- private dateFormat;
6
- private getDateConfig;
7
- }
1
+ import { PipeTransform } from '@angular/core';
2
+ import * as i0 from "@angular/core";
3
+ export declare class NgxDatePipe implements PipeTransform {
4
+ constructor();
5
+ transform(date: Date | string, dateFormat?: string, langCode?: string): string;
6
+ private dateFormat;
7
+ private getDateConfig;
8
+ static ɵfac: i0.ɵɵFactoryDeclaration<NgxDatePipe, never>;
9
+ static ɵpipe: i0.ɵɵPipeDeclaration<NgxDatePipe, "ngxdate">;
10
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@frxjs/ngx-timeline",
3
- "version": "1.0.6",
3
+ "version": "1.2.0",
4
4
  "keywords": [
5
5
  "angular",
6
6
  "timeline"
@@ -14,18 +14,31 @@
14
14
  },
15
15
  "license": "MIT",
16
16
  "peerDependencies": {
17
- "@angular/common": "^11.0.9",
18
- "@angular/core": "^11.0.9"
17
+ "@angular/common": "~13.2.1",
18
+ "@angular/compiler": "~13.2.1",
19
+ "@angular/core": "~13.2.1"
19
20
  },
20
21
  "dependencies": {
21
22
  "tslib": "^2.0.0"
22
23
  },
23
- "main": "bundles/frxjs-ngx-timeline.umd.js",
24
- "module": "fesm2015/frxjs-ngx-timeline.js",
25
- "es2015": "fesm2015/frxjs-ngx-timeline.js",
26
- "esm2015": "esm2015/frxjs-ngx-timeline.js",
27
- "fesm2015": "fesm2015/frxjs-ngx-timeline.js",
24
+ "module": "fesm2015/frxjs-ngx-timeline.mjs",
25
+ "es2020": "fesm2020/frxjs-ngx-timeline.mjs",
26
+ "esm2020": "esm2020/frxjs-ngx-timeline.mjs",
27
+ "fesm2020": "fesm2020/frxjs-ngx-timeline.mjs",
28
+ "fesm2015": "fesm2015/frxjs-ngx-timeline.mjs",
28
29
  "typings": "frxjs-ngx-timeline.d.ts",
29
- "metadata": "frxjs-ngx-timeline.metadata.json",
30
+ "exports": {
31
+ "./package.json": {
32
+ "default": "./package.json"
33
+ },
34
+ ".": {
35
+ "types": "./frxjs-ngx-timeline.d.ts",
36
+ "esm2020": "./esm2020/frxjs-ngx-timeline.mjs",
37
+ "es2020": "./fesm2020/frxjs-ngx-timeline.mjs",
38
+ "es2015": "./fesm2015/frxjs-ngx-timeline.mjs",
39
+ "node": "./fesm2015/frxjs-ngx-timeline.mjs",
40
+ "default": "./fesm2020/frxjs-ngx-timeline.mjs"
41
+ }
42
+ },
30
43
  "sideEffects": false
31
44
  }
package/public-api.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export * from './lib/components';
2
- export * from './lib/models';
3
- export * from './lib/pipes/';
4
- export * from './lib/ngx-timeline.module';
1
+ export * from './lib/components';
2
+ export * from './lib/models';
3
+ export * from './lib/pipes/';
4
+ export * from './lib/ngx-timeline.module';