Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emanuelefricano93/frxjs-Ngx-Timeline
NgxTimeline Angular Library
https://github.com/emanuelefricano93/frxjs-Ngx-Timeline
angular timeline
Last synced: about 1 month ago
JSON representation
NgxTimeline Angular Library
- Host: GitHub
- URL: https://github.com/emanuelefricano93/frxjs-Ngx-Timeline
- Owner: emanuelefricano93
- Created: 2021-04-17T15:37:39.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-10T21:35:42.000Z (9 months ago)
- Last Synced: 2024-05-02T23:04:14.940Z (8 months ago)
- Topics: angular, timeline
- Language: TypeScript
- Homepage:
- Size: 22.5 MB
- Stars: 19
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- trackawesomelist - frxjs-Ngx-Timeline (⭐35) - This library allows you to integrate a timeline in your Angular app. (Recently Updated / [Dec 06, 2024](/content/2024/12/06/README.md))
- fucking-awesome-angular - frxjs-Ngx-Timeline - This library allows you to integrate a timeline in your Angular app. (Table of contents / Third Party Components)
- awesome-angular - frxjs-Ngx-Timeline - This library allows you to integrate a timeline in your Angular app. (Table of contents / Third Party Components)
README
# NgxTimeline 
The main goal of this angular library is to give you the possibility to integrate a timeline in your app.
Version 19.0.0 is compatible with angular 18.
Go [here](https://emanuelefricano93.github.io/frxjs-Ngx-Timeline/) and discover all possible configurations for the timeline
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
```html
```
## 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'
- 'sl'
- 'tr'
- 'pl'
- 'pt'
- 'ru'
enableAnimation | Boolean used to enable or disable the animations | no | boolean | true
reverseOrder | Boolean used to reverse sort order (default older first) | no | boolean | false
groupEvent | Logic to be applied in order to group events | no | enum NgxTimelineEventGroup | NgxTimelineEventGroup.MONTH_YEAR
orientation | Orientation of the timeline | no | enum NgxTimelineOrientation | NgxTimelineOrientation.VERTICAL
changeSide | Logic to be applied in order to put events on LEFT or RIGHT | no | enum NgxTimelineEventChangeSide | NgxTimelineEventChangeSide.ON_DIFFERENT_DAY_IN_GROUP
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
eventDescriptionCustomTemplate| Custom Template displayed to show the description | 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
```typescript
interface NgxTimelineEvent {
timestamp?: Date;
title?: string;
description?: string;
id?: any;
itemPosition?: NgxTimelineItemPosition;
}
```
```typescript
enum NgxTimelineEventGroup {
YEAR = 'YEAR',
MONTH_YEAR = 'MONTH_YEAR',
DAY_MONTH_YEAR = 'DAY_MONTH_YEAR'
}
```
```typescript
export enum NgxTimelineOrientation {
HORIZONTAL = 'HORIZONTAL',
VERTICAL = 'VERTICAL',
}
```
```typescript
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'
}
```
### Custom Theme supported
This is an example of custom-theme that can be applied for istance via an ng-class directive to the container of the library. In this way you are redefine some variables that are defined and used inside the library and it is easier to override some properties
```scss
.custom-theme {
--ngx-timeline-icon: black;
--ngx-timeline-period-inner-container: black;
--ngx-timeline-line-background: black;
}
```
### Examples with contexts of custom templates
```html
{{index}} - {{period | json }}
```
```html
```
```html
{{event | json}}
```
```html
{{event?.eventInfo?.description}}
```
```html
{{event | json}}
```
```html
{{item | json}}
```
## 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 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