Skip to content

Component | Timeline: Enhancements and fixes #536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 25 commits into from
May 28, 2025

Conversation

rokotyan
Copy link
Contributor

This PR introduces several improvements to the Timeline component:

New features:

  • Adds labelTextAlign config option to Timeline component to control label alignment
  • Timeline can now automatically calculate line and row widths if they were not provided
  • Adds configurable clip path extension to XYContainer

Fixes:

  • Improves Timeline component clipping behavior with dedicated clipPath
  • Fixes label positioning and width calculations

Refactoring:

  • Moves text alignment utility to a shared function textAlignToAnchor

Before. Setting xDomain lead to this:
SCR-20250219-ndmx

After:
SCR-20250219-neay

@rokotyan rokotyan force-pushed the fix/timeline-clipping branch 3 times, most recently from 8899b8d to 0b19cb4 Compare February 21, 2025 23:34
@rokotyan rokotyan force-pushed the fix/timeline-clipping branch 4 times, most recently from 8035c06 to 1b50ddc Compare March 4, 2025 16:41
@rokotyan rokotyan force-pushed the fix/timeline-clipping branch 4 times, most recently from 1241041 to 19c1dbe Compare March 13, 2025 21:08
@rokotyan rokotyan force-pushed the fix/timeline-clipping branch 5 times, most recently from a8f34c1 to 29c5afd Compare March 22, 2025 15:11
@rokotyan rokotyan force-pushed the fix/timeline-clipping branch from 29c5afd to fb7dcc2 Compare April 2, 2025 16:38
@rokotyan rokotyan changed the title [WIP] Component | Timeline: Enhancements and fixes Component | Timeline: Enhancements and fixes May 19, 2025
@rokotyan rokotyan marked this pull request as ready for review May 20, 2025 20:50
rokotyan added 11 commits May 27, 2025 15:13
This commit introduces several improvements to the Timeline component and related utilities:

- Improves Timeline component clipping behavior with dedicated clipPath
- Adds `labelTextAlign` config option to Timeline component to control label alignment
- Moves text alignment utility to a shared function `textAlignToAnchor`
- Fixes label positioning and width calculations
- Makes Timeline automatically calculate line and row widths if they were not provided
- Adds configurable clip path extension to XYContainer
- Introduce a dedicated TimelineRowLabel type to encapsulate label data, including formatted labels.
- Added the `rowLabelStyle` config option.
- Update the `groupBy` utility to pass the index to the accessor.
- Introduce `TimelineArrow` types and render state interfaces in types.ts
- Add new arrow rendering group and data preparation logic in timeline/index.ts
- Implement arrowLinePath utility in utils/path.ts to generate customizable SVG arrow paths
- Add corresponding arrow style rules and theme variables in `timeline/style.ts`
- Update timeline configuration and default constants for arrow head dimensions in config.ts and constants.ts
- Re-export timeline types in src/types.ts
Introduce a new timeline arrows example in the xy-components library that demonstrates arrow configuration between timeline rows.
…ransitions

- Introduce new timeline config options animationLineEnterPosition and animationLineExitPosition in config.ts to control the starting and exit positions of animated lines.
- Update Timeline component to utilize these options, including support for functional configurations using the new isFunction import.
- Refactor label and rect transitions with smartTransition for smoother enter/exit animations.
- Adjust data bindings to use TimelineRowLabel keys for improved label rendering consistency.
rokotyan added 14 commits May 27, 2025 15:13
… fix duration fallback

- Introduce a new timeline animation example with configurable enter/exit animation line positions.
- Update the timeline tooltip example to use TimelineRowLabel for enhanced type safety in tooltips.
- Adjust timeline component to apply a default duration of 1000 when none is provided.
… domain, and arrow exit transition

- Add a missing domain based on rowLabels to the ordinal scale for improved record mapping.
- Wrap bound data for both lineStartIcon and lineEndIcon selections to ensure single datum binding.
- Adjust arrow exit transition to fade out (opacity 0) before removal, correcting cleanup behavior.
- Added configurable hover style to timeline lines, changing stroke width and color on hover.
- Defined new CSS variables for hover stroke width and color, including dark theme variants.
- Add a new `_rowIconsGroup` in the Timeline component to render icons before row labels, including position calculation using maximum icon size.
- Update the timeline configuration (`config.ts`) to include a rowIcon callback and adjust the `rowLabelFormatter` to receive the row index.
- Extend timeline types by introducing `TimelineRowIcon` and updating `TimelineRowLabel` to support `iconHref`, `iconSize`, and `iconColor`.
- Dummy arrow points to smooth transitions
- Make scrolling work when hovering over labels
- More robust bleed calculations
- More robust `arrowPolylinePath` function
- Clip path transition
@rokotyan rokotyan force-pushed the fix/timeline-clipping branch from fb7dcc2 to 121a04e Compare May 27, 2025 22:13
Copy link
Collaborator

@lee00678 lee00678 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This update is amazing! We should definitely feature this in the 1.6 release.

@lee00678 lee00678 merged commit 817adc5 into f5:main May 28, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants