@frxjs/ngx-timeline 2.2.3 → 2.2.4
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.
- package/README.md +14 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
The main goal of this angular library is to give you the possibility to integrate a timeline in your app.
|
|
4
4
|
<br/>
|
|
5
|
-
Version 2.2.
|
|
5
|
+
Version 2.2.4 is compatible with angular 16.
|
|
6
6
|
<br/>
|
|
7
7
|
Go [here](https://emanuelefricano93.github.io/frxjs-Ngx-Timeline/) and discover all possible configurations for the timeline
|
|
8
8
|
|
|
@@ -36,19 +36,19 @@ After installing the library and including NgxTimelineModule in your imports mod
|
|
|
36
36
|
## Configuration
|
|
37
37
|
|
|
38
38
|
### Input
|
|
39
|
-
Input name | Explanation | Mandatory | Type/Supported Values
|
|
40
|
-
--- | --- | ---
|
|
41
|
-
events | list of events to be displayed | yes | NgxTimelineEvent
|
|
42
|
-
langCode | language code use to format dates | no | <ul><li>'en'</li><li>'it'</li><li>'fr'</li><li>'de'</li><li>'es'</li><li>'sl'</li><li>'tr'</li><li>'pt'</li></ul>
|
|
43
|
-
enableAnimation | Boolean used to enable or disable the animations | no | boolean
|
|
44
|
-
reverseOrder | Boolean used to reverse sort order (default older first) | no | boolean
|
|
45
|
-
groupEvent | Logic to be applied in order to group events | no | enum NgxTimelineEventGroup
|
|
46
|
-
changeSideInGroup | Logic to be applied in order to put evetns on LEFT or RIGHT | no | enum NgxTimelineEventChangeSideInGroup
|
|
47
|
-
periodCustomTemplate | Custom Template displayed before a group of events | no | TemplateRef<any>
|
|
48
|
-
eventCustomTemplate | Custom Template displayed to show a single event | no | TemplateRef<any>
|
|
49
|
-
centerIconCustomTemplate | Custom Template displayed to show an separator icon | no | TemplateRef<any>
|
|
50
|
-
dateInstantCustomTemplate | Custom Template displayed to show the side date | no | TemplateRef<any>
|
|
51
|
-
innerEventCustomTemplate | Custom Template displayed to show the inner event | no | TemplateRef<any>
|
|
39
|
+
Input name | Explanation | Mandatory | Type/Supported Values | Default value
|
|
40
|
+
--- | --- | --- |--------------------------------------------------------------------------------------------------------------------------------| ---
|
|
41
|
+
events | list of events to be displayed | yes | NgxTimelineEvent | no default
|
|
42
|
+
langCode | language code use to format dates | no | <ul><li>'en'</li><li>'it'</li><li>'fr'</li><li>'de'</li><li>'es'</li><li>'sl'</li><li>'tr'</li><li>'pt'</li><li>'ru'</li></ul> | 'en'
|
|
43
|
+
enableAnimation | Boolean used to enable or disable the animations | no | boolean | true
|
|
44
|
+
reverseOrder | Boolean used to reverse sort order (default older first) | no | boolean | false
|
|
45
|
+
groupEvent | Logic to be applied in order to group events | no | enum NgxTimelineEventGroup | NgxTimelineEventGroup.MONTH_YEAR
|
|
46
|
+
changeSideInGroup | Logic to be applied in order to put evetns on LEFT or RIGHT | no | enum NgxTimelineEventChangeSideInGroup | NgxTimelineEventChangeSideInGroup.ON_DIFFERENT_DAY
|
|
47
|
+
periodCustomTemplate | Custom Template displayed before a group of events | no | TemplateRef<any> | no default
|
|
48
|
+
eventCustomTemplate | Custom Template displayed to show a single event | no | TemplateRef<any> | no default
|
|
49
|
+
centerIconCustomTemplate | Custom Template displayed to show an separator icon | no | TemplateRef<any> | no default
|
|
50
|
+
dateInstantCustomTemplate | Custom Template displayed to show the side date | no | TemplateRef<any> | no default
|
|
51
|
+
innerEventCustomTemplate | Custom Template displayed to show the inner event | no | TemplateRef<any> | no default
|
|
52
52
|
<br/>
|
|
53
53
|
|
|
54
54
|
### Output
|