https://github.com/vaadin-component-factory/vcf-timeline
https://github.com/vaadin-component-factory/vcf-timeline
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/vaadin-component-factory/vcf-timeline
- Owner: vaadin-component-factory
- License: apache-2.0
- Created: 2021-09-07T12:54:40.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-19T20:16:44.000Z (over 2 years ago)
- Last Synced: 2024-04-17T10:09:43.816Z (about 1 year ago)
- Language: Java
- Size: 126 KB
- Stars: 2
- Watchers: 9
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Timeline component for Vaadin Flow
Timeline component uses [vis-timeline](https://visjs.github.io/vis-timeline/docs/timeline/) library to display data in time.
This component is part of Vaadin Component Factory.
## Description
Timeline component provides support to the following features:
- Create a timeline with a defined visible range.
- Make items readonly.
- Update items content.
- Give items a style by defining a class name.
- Edit an item by resizing it.
- Edit an item by drag and drop.
- Multiple items selection.
- Possiblity to define zoom options (e.g. 1 day, 3 days, 5 days).
- Items are shown connected by an horizontal line between them. (*)
- Show tooltips for items.
- Possibility to revert resizing or dragging if condition is not met.
- Autoscrolling when reaching limits of visible range.
- Tooltip on item update.
(*) Horizontal lines implementation is based on [timeline-arrows](https://github.com/javdome/timeline-arrows).
## Development instructions
- Build the project and install the add-on locally:
```
mvn clean install
```
- For starting the demo server go to timeline-demo and run:
```
mvn jetty:run
```
This deploys demo at http://localhost:8080
## How to use it
Create a new component Timeline:
```java
Timeline timeline = new Timeline(items);
```
## Examples
See examples on [timeline-demo](https://github.com/vaadin-component-factory/vcf-timeline/tree/master/timeline-demo/src/main/java/com/vaadin/componentfactory/timeline).
## Missing features or bugs
You can report any issue or missing feature on [GitHub](https://github.com/vaadin-component-factory/vcf-timeline/issues).