main
2
Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
 CainandChristopher Biscardi
|
5428eb8399 |
editor: Fix cursor animation across width and scroll changes (#64184)
Follow-up to #63195. This PR fixes the cursor animation problems reported in [this comment](https://github.com/zed-industries/zed/pull/63195#issuecomment-5662566417): - Block cursors snapped instead of animating when moving between characters with different display widths, such as an ASCII character and an emoji or CJK character. - Cursor animation disappeared near the top and bottom scroll margins when keyboard navigation triggered vertical autoscrolling. The first issue happened because any cursor geometry size change was treated as a reason to snap. Cursor movement now retargets the animation when either the rectangle position or size changes, while geometry changes without a logical cursor move still snap immediately. The second issue happened because every viewport change cleared the active animation. Scroll-only viewport changes now translate the current and target corner positions, as well as the previous target geometry, by the scroll pixel delta before retargeting. This preserves the spring's motion and velocity across autoscroll. Actual layout changes, including text-area size, line height, and font advance changes, continue to snap. Regression coverage includes: - Both narrow-to-wide and wide-to-narrow cursor transitions, including convergence to the new rectangle. - Cursor movement in both directions while the viewport scrolls. - Scrolling during an active animation without clearing its position or velocity. - Layout changes that must still snap. - An editor-level keyboard autoscroll test using a vertical scroll margin of 3. Validation: - `cargo test -p editor cursor_animation --lib` - `cargo fmt --all --check` - `cargo build -p zed --bin zed --profile release-fast` - Manual verification with the release-fast binary Release Notes: - Fixed cursor animations when moving between characters of different widths and during keyboard-triggered autoscrolling. --------- Co-authored-by: Christopher Biscardi <chris@christopherbiscardi.com> |
||
|
CainandChristopher Biscardi
|
326a5f026a |
editor: Add optional cursor movement animation (#63195)
# Objective Add an optional smooth cursor movement animation to make cursor position changes easier to follow, especially during larger jumps and multi-cursor editing. Related to #4991. ## Solution - Add a new `cursor_animation.enabled` editor setting, disabled by default. - Animate local bar and block cursors using a damped spring while preserving momentum during rapid cursor movement. - Support multiple local cursors independently. - Continue using the cursor color provided by the active theme. - Snap immediately when scrolling, resizing, or other viewport changes would make interpolation misleading. - Respect the `reduce_motion` setting. - Request animation frames only while an enabled cursor animation is active. Enabling the feature causes additional editor redraws while the cursor is moving, so it is opt-in and the performance cost is mentioned in the setting documentation. ### Attribution The cursor spring physics and four-corner deformation algorithm are adapted from [vscode-neovide-cursor](https://github.com/LengineerC/vscode-neovide-cursor), which is available under the MIT License and inspired by Neovide. The implementation adapts the algorithm to Zed's editor and GPUI architecture, including viewport handling, selection state reconciliation, multi-cursor support, theme integration, and reduced-motion behavior. The attribution and license information are also retained in the source file. ## Testing Automated checks run on Windows: - `cargo fmt --all --check` - `cargo test -p editor cursor_animation --lib` - 15 cursor animation tests passed. The tests cover: - Spring convergence. - Short and long cursor movements. - Mid-animation retargeting and momentum preservation. - Multiple independent cursors. - Selection replacement and state cleanup. - Viewport and scroll changes. - Invalid or unusually large timing values. - Supported cursor shapes. To test manually: 1. Add the following to the settings file: ```json "cursor_animation": { "enabled": true } ``` 2. Move the cursor using typing, arrow keys, mouse clicks, and multi-cursor actions. 3. Toggle the setting off and confirm that cursor rendering immediately returns to its normal behavior. Manual testing was performed on Windows and Linux using a release build from this exact PR branch. Verified that: - Cursor animation is disabled by default. - Enabling `cursor_animation.enabled` is hot-reloaded without restarting Zed. - Disabling the setting immediately restores the original cursor behavior. - Cursor movement remains responsive during typing, keyboard navigation, and mouse navigation. This exact PR branch has not yet been manually tested on macOS. ## Self-Review Checklist: - [x] I've reviewed my own diff for quality, security, and reliability - [x] Unsafe blocks (if any) have justifying comments - [x] The content adheres to Zed's UI standards ([UX/UI](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) and [icon](https://github.com/zed-industries/zed/blob/main/crates/icons/README.md) guidelines) - [x] Tests cover the new/changed behavior - [x] Performance impact has been considered and is acceptable ## Showcase https://github.com/user-attachments/assets/17450529-491e-4982-b539-c46e3d5df467 --- Release Notes: - Added an optional cursor movement animation setting. --------- Co-authored-by: Christopher Biscardi <chris@christopherbiscardi.com> |