Skip to content

[Feature] Refactor ScrollAnimation exports#494

Merged
titouanmathis merged 42 commits intodevelopfrom
feature/refactor-scroll-animation-exports
Jan 28, 2026
Merged

[Feature] Refactor ScrollAnimation exports#494
titouanmathis merged 42 commits intodevelopfrom
feature/refactor-scroll-animation-exports

Conversation

@titouanmathis
Copy link
Contributor

@titouanmathis titouanmathis commented Jan 12, 2026

🔗 Linked issue

Fixes #441

❓ Type of change

  • 📖 Documentation (updates to the documentation, readme or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

  • Add ScrollAnimationTimeline (new name for ScrollAnimationParent)
  • Add ScrollAnimationTarget (new name for ScrollAnimationChild)
  • Deprecate ScrollAnimation, ScrollAnimationWithEase, ScrollAnimationChild, ScrollAnimationChildWithEase, ScrollAnimationParent and animationScrollWithEase
  • Add tests for the new components

📝 Checklist

  • I have linked an issue or discussion.
  • I have added tests (if possible).
  • I have updated the documentation accordingly.
  • I have updated the changelog.

- Add ScrollAnimationTimeline (new name for ScrollAnimationParent)
- Add ScrollAnimationTarget (new name for ScrollAnimationChild)
- Deprecate ScrollAnimation, ScrollAnimationWithEase, ScrollAnimationChild,
  ScrollAnimationChildWithEase, ScrollAnimationParent and animationScrollWithEase
- Add tests for the new components

Fixes #441

Co-authored-by: Claude <claude@anthropic.com>
@codecov
Copy link

codecov bot commented Jan 12, 2026

Codecov Report

❌ Patch coverage is 26.76056% with 104 lines in your changes missing coverage. Please review.
✅ Project coverage is 67.82%. Comparing base (c2db39b) to head (d1d1a28).
⚠️ Report is 44 commits behind head on develop.

Files with missing lines Patch % Lines
...ges/ui/ScrollAnimation/withScrollAnimationDebug.ts 6.66% 80 Missing and 18 partials ⚠️
...ages/ui/ScrollAnimation/ScrollAnimationWithEase.ts 0.00% 2 Missing and 1 partial ⚠️
...ages/ui/ScrollAnimation/animationScrollWithEase.ts 0.00% 2 Missing and 1 partial ⚠️
Additional details and impacted files
@@              Coverage Diff              @@
##             develop     #494      +/-   ##
=============================================
- Coverage      70.81%   67.82%   -2.99%     
  Complexity        20       20              
=============================================
  Files             74       77       +3     
  Lines           1850     1989     +139     
  Branches         332      357      +25     
=============================================
+ Hits            1310     1349      +39     
- Misses           477      558      +81     
- Partials          63       82      +19     
Flag Coverage Δ
unittests 67.82% <26.76%> (-2.99%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
packages/ui/ScrollAnimation/ScrollAnimation.ts 100.00% <100.00%> (ø)
...ackages/ui/ScrollAnimation/ScrollAnimationChild.ts 100.00% <100.00%> (ø)
...ui/ScrollAnimation/ScrollAnimationChildWithEase.ts 100.00% <100.00%> (ø)
...ckages/ui/ScrollAnimation/ScrollAnimationParent.ts 100.00% <100.00%> (ø)
...ckages/ui/ScrollAnimation/ScrollAnimationTarget.ts 100.00% <100.00%> (ø)
...ages/ui/ScrollAnimation/ScrollAnimationTimeline.ts 100.00% <100.00%> (ø)
...ages/ui/ScrollAnimation/ScrollAnimationWithEase.ts 25.00% <0.00%> (-75.00%) ⬇️
...ages/ui/ScrollAnimation/animationScrollWithEase.ts 78.57% <0.00%> (+14.93%) ⬆️
...ges/ui/ScrollAnimation/withScrollAnimationDebug.ts 6.66% <6.66%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
Copy link

github-actions bot commented Jan 12, 2026

Export Size

@studiometa/ui

Name Size Diff
ScrollAnimationTimeline 3.82 kB +3.82 kB (+100.00%) 🔺
ScrollAnimationTarget 3.75 kB +3.75 kB (+100.00%) 🔺
withScrollAnimationDebug 2.04 kB +2.04 kB (+100.00%) 🔺
animationScrollWithEase 763 B +115 B (+17.75%) 🔺
ScrollAnimationWithEase 4.28 kB +124 B (+2.98%) 🔺
ScrollAnimationChildWithEase 4.41 kB +111 B (+2.58%) 🔺
ScrollAnimationParent 3.88 kB +76 B (+2.00%) 🔺
ScrollAnimation 3.69 kB +72 B (+1.99%) 🔺
ScrollAnimationChild 3.81 kB +61 B (+1.63%) 🔺
Unchanged

@studiometa/ui

Name Size Diff
AbstractFrameTrigger 1.74 kB -
AbstractPrefetch 366 B -
AbstractScrollAnimation 3.56 kB -
AbstractSliderChild 600 B -
Accordion 1.77 kB -
AccordionItem 1.75 kB -
Action 1.11 kB -
AnchorNav 3.85 kB -
AnchorNavLink 3.74 kB -
AnchorNavTarget 125 B -
AnchorScrollTo 2.53 kB -
CircularMarquee 550 B -
Cursor 650 B -
DataBind 697 B -
DataComputed 856 B -
DataEffect 837 B -
DataModel 780 B -
Draggable 1.64 kB -
Fetch 2.34 kB -
Figure 1.72 kB -
FigureShopify 1.98 kB -
FigureTwicpics 2.26 kB -
FigureVideo 1.87 kB -
FigureVideoTwicpics 2.44 kB -
Frame 3.47 kB -
FrameAnchor 1.84 kB -
FrameForm 1.92 kB -
FrameLoader 1.45 kB -
FrameTarget 1.75 kB -
FrameTriggerLoader 1.46 kB -
Hoverable 953 B -
LargeText 713 B -
LazyInclude 322 B -
Menu 2.33 kB -
MenuBtn 140 B -
MenuList 1.9 kB -
Modal 1.99 kB -
ModalWithTransition 2.09 kB -
Panel 2.38 kB -
PrefetchWhenOver 408 B -
PrefetchWhenVisible 417 B -
ScrollReveal 1.63 kB -
Sentinel 129 B -
Slider 2.3 kB -
SliderBtn 817 B -
SliderCount 650 B -
SliderDots 1.86 kB -
SliderDrag 269 B -
SliderItem 998 B -
SliderProgress 961 B -
Sticky 771 B -
Tabs 1.38 kB -
Target 86 B -
Transition 1.41 kB -
withDeprecation 166 B -
withTransition 1.39 kB -

titouanmathis and others added 6 commits January 12, 2026 21:00
- Add documentation for ScrollAnimationTimeline and ScrollAnimationTarget
- Update examples to use new component names
- Add deprecation notices for old components
- Update changelog with PR reference

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
@titouanmathis titouanmathis force-pushed the feature/refactor-scroll-animation-exports branch from 6d1b472 to 82bba35 Compare January 26, 2026 13:03
- Move ScrollAnimationTimeline to the top as the recommended API
- Add clear separation between Timeline and Target components
- Document all options under ScrollAnimationTarget section
- Move deprecated ScrollAnimation to the bottom with warning
- Update all code examples to use the new Timeline/Target pattern
Document all breaking changes for ScrollAnimation components:
- ScrollAnimation → ScrollAnimationTimeline + ScrollAnimationTarget
- ScrollAnimationParent → ScrollAnimationTimeline
- ScrollAnimationChild → ScrollAnimationTarget
- ScrollAnimationChildWithEase → ScrollAnimationTarget with dampFactor
- ScrollAnimationWithEase → ScrollAnimationTimeline + ScrollAnimationTarget
- animationScrollWithEase decorator removed
@titouanmathis titouanmathis force-pushed the feature/refactor-scroll-animation-exports branch from bf0aa2f to befc0d4 Compare January 26, 2026 13:24
titouanmathis and others added 17 commits January 26, 2026 14:25
Add a custom Vite plugin that serves the public/play directory
using sirv middleware. This prevents VitePress from intercepting
requests to /play/* and rendering them as pages instead of serving
the static files.
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
The decorator adds debug capabilities to ScrollAnimationTimeline.
It is exported separately to allow tree-shaking from production bundles.

Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
titouanmathis and others added 12 commits January 26, 2026 18:16
- Reorganize examples with simple option examples first
- Add scroll indicators to all examples
- Add debug and offset examples

Co-authored-by: Claude <claude@anthropic.com>
- Add debug option documentation
- Add offset option documentation
- Add withScrollAnimationDebug decorator documentation

Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
- Separate each offset example into its own playground
- Add plain English explanations for each offset value
- Explain the offset format and its components

Co-authored-by: Claude <claude@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
@titouanmathis titouanmathis force-pushed the feature/refactor-scroll-animation-exports branch from 9670b5a to 47f1606 Compare January 26, 2026 17:23
@titouanmathis titouanmathis merged commit b30fa92 into develop Jan 28, 2026
21 checks passed
@titouanmathis titouanmathis deleted the feature/refactor-scroll-animation-exports branch January 28, 2026 19:56
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.

[ScrollAnimation] Refactor exported components

1 participant