Skip to content
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

Don't seek stack animation transition on back start when predictive back animatable is specified #797

Merged
merged 1 commit into from
Oct 15, 2024

Conversation

arkivanov
Copy link
Owner

@arkivanov arkivanov commented Oct 14, 2024

Summary by CodeRabbit

  • New Features

    • Improved back navigation animations for smoother transitions.
    • Introduced a new composable function for float animations in transition states.
    • Enhanced testing for predictive back gestures with new scenarios.
  • Bug Fixes

    • Resolved issues with animation behavior during stack transitions.
  • Documentation

    • Updated method names and signatures for clarity in animation handling.

Copy link

coderabbitai bot commented Oct 14, 2024

Walkthrough

The pull request involves significant refactoring of the DefaultStackAnimation class to enhance back navigation animation handling. The start method has been renamed to progress, streamlining the animation logic based on back event progress. Additionally, a new composable function animateFloat has been introduced in TestUtils.kt, and the PredictiveBackGestureTest class has been updated with new test cases to better evaluate animation behavior during predictive back gestures. These changes improve clarity and efficiency in animation state management during stack transitions.

Changes

File Change Summary
extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/DefaultStackAnimation.kt Refactored DefaultStackAnimation class; renamed start method to progress; added cancel and finish methods for animation state management. Updated onBackProgressed in PredictiveBackCallback.
extensions-compose-experimental/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/experimental/TestUtils.kt Added new composable function animateFloat for transitioning float values based on EnterExitState.
extensions-compose-experimental/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackGestureTest.kt Enhanced PredictiveBackGestureTest with new imports and two test cases for predictive back gesture behavior.

Possibly related PRs

Poem

In the stack where rabbits hop,
Animations now smoothly swap.
With progress clear and tests anew,
Back gestures dance, a joyful view!
So let us cheer, with ears held high,
For transitions bright that leap and fly! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 674b14f and 72a0187.

📒 Files selected for processing (2)
  • extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/DefaultStackAnimation.kt (1 hunks)
  • extensions-compose-experimental/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackGestureTest.kt (2 hunks)
🧰 Additional context used
🔇 Additional comments (2)
extensions-compose-experimental/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackGestureTest.kt (2)

417-444: Tests correctly verify non-animating transition when predictiveBackAnimatable is not null

The test GIVEN_predictive_animatable_not_null_and_two_children_in_stack_WHEN_gesture_progressed_THEN_animation_transition_not_animating accurately checks that the animation transition does not animate when a non-null predictiveBackAnimatable is provided, which aligns with the intended behavior.


447-474: Tests correctly verify animating transition when predictiveBackAnimatable is null

The test GIVEN_predictive_animatable_null_and_two_children_in_stack_WHEN_gesture_progressed_THEN_animation_transition_animating appropriately verifies that the animation transition animates based on gesture progress when predictiveBackAnimatable is null, ensuring correct functionality.

@arkivanov arkivanov force-pushed the dont-animate-transition-on-back-start branch from 72a0187 to 2051b46 Compare October 15, 2024 09:49
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
extensions-compose-experimental/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/experimental/TestUtils.kt (1)

17-25: LGTM: Well-implemented animation function with a minor suggestion.

The animateFloat function is well-implemented and aligns with the PR objective. It correctly maps the EnterExitState to appropriate float values for animation purposes.

Consider adding a brief comment explaining the purpose of this function and the meaning of the float values. This would enhance readability and maintainability. For example:

/**
 * Animates the transition between EnterExitState values.
 * @return A State<Float> representing the animation progress:
 *         0F for PreEnter and PostExit (not visible)
 *         1F for Visible (fully visible)
 */
@Composable
internal fun Transition<EnterExitState>.animateFloat(): State<Float> =
    // ... (rest of the function remains the same)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 72a0187 and 2051b46.

📒 Files selected for processing (3)
  • extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/DefaultStackAnimation.kt (1 hunks)
  • extensions-compose-experimental/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/experimental/TestUtils.kt (1 hunks)
  • extensions-compose-experimental/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackGestureTest.kt (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/DefaultStackAnimation.kt
  • extensions-compose-experimental/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackGestureTest.kt
🧰 Additional context used
🔇 Additional comments (2)
extensions-compose-experimental/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/experimental/TestUtils.kt (2)

3-9: LGTM: Import statements are correct and necessary.

The new import statements are appropriately added to support the new animateFloat function. They include the required classes and annotations from the androidx.compose packages.


1-25: Summary: Effective addition of animation utility function.

The changes to this file are focused and well-implemented. The new animateFloat function provides a useful utility for animating transitions between EnterExitState values, which aligns with the PR's objective of improving stack animation transitions. The function is properly integrated into the existing TestUtils.kt file without disrupting other utilities.

These changes enhance the animation capabilities of the library, particularly for testing purposes, as indicated by the file's location in the test package. The implementation is clean, concise, and follows Compose best practices.

@arkivanov arkivanov merged commit 53d6593 into master Oct 15, 2024
3 checks passed
@arkivanov arkivanov deleted the dont-animate-transition-on-back-start branch October 15, 2024 10:19
@arkivanov arkivanov changed the title Don't seek stack animation transition on back start when predictive b… Don't seek stack animation transition on back start when predictive back animatable is specified Oct 16, 2024
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.

1 participant