NUKnightLab / NUKnightLab/TimelineJS3
Headless mode
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 3.2k
- Forks
- 645
- PR merge metrics
- No merged PRs in 30d
Description
In my University (Strasbourg in France). We need a timeline for a research project: Octant.
In this project, we have to display historical events in timeline. When the user clicks on one event the text have to updated in the upper right corner but in the upper left corner, we have already the same component, we have to display a map with all event. So we can't use the timeline in the version.
Your timeline is the most beautiful project we have seen and with the best code.
That's why I'm going to develop the library to use it without the "StorySlider" part.
I can make a pull request with a "headless" option to use this version.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing StorySlider portion of TimelineJS3 and how timeline events update the surrounding display. Define what a headless option should expose for the separate map and text components, then verify that the timeline can be used without StorySlider while retaining event selection and updates.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100