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

Updated shared transitions sample #798

Merged
merged 1 commit into from
Oct 17, 2024

Conversation

arkivanov
Copy link
Owner

@arkivanov arkivanov commented Oct 16, 2024

Summary by CodeRabbit

  • New Features
    • Enhanced predictive back animation functionality in the app.
  • Improvements
    • Updated shared transition methods in the Gallery and Photo components for better performance and clarity.
    • Adjusted parameters in the Gallery and Photo content to improve transition behavior.

Copy link

coderabbitai bot commented Oct 16, 2024

Walkthrough

The pull request introduces enhancements to the predictive back animation functionality within the SharedTransitionsContent, GalleryContent, and PhotoContent composable functions. Key changes include the addition of a new import for materialPredictiveBackAnimatable and updates to the PredictiveBackParams instantiation. Additionally, the Image composable method calls in both GalleryContent and PhotoContent have been modified from .sharedElement(...) to .sharedBounds(...), reflecting a change in parameter names and the addition of new parameters.

Changes

File Path Change Summary
.../sharedtransitions/SharedTransitionsContent.kt Added import for materialPredictiveBackAnimatable; updated PredictiveBackParams to include animatable.
.../sharedtransitions/gallery/GalleryContent.kt Changed .sharedElement(...) to .sharedBounds(...); renamed state to sharedContentState.
.../sharedtransitions/photo/PhotoContent.kt Changed .sharedElement(...) to .sharedBounds(...); renamed state to sharedContentState; added new param renderInOverlayDuringTransition.

Possibly related PRs

🐰 In the meadow, where bunnies play,
New animations hop in, brightening the day!
With transitions shared, and bounds set right,
We leap through the changes, oh what a delight!
So here’s to the code, with joy we embrace,
A dance of the pixels, in a beautiful space! 🌼✨


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: 0

🧹 Outside diff range and nitpick comments (2)
sample/shared/compose/src/commonMain/kotlin/com/arkivanov/sample/shared/sharedtransitions/gallery/GalleryContent.kt (1)

45-48: LGTM! Consider minor formatting adjustment.

The update from .sharedElement(...) to .sharedBounds(...) and the parameter name change from state to sharedContentState appear to be correct and consistent with the new API. These changes likely improve the clarity and functionality of shared transitions.

For better readability, consider aligning the parameters vertically:

.sharedBounds(
    sharedContentState = rememberSharedContentState(key = image.id),
    animatedVisibilityScope = animatedVisibilityScope,
)
sample/shared/compose/src/commonMain/kotlin/com/arkivanov/sample/shared/sharedtransitions/SharedTransitionsContent.kt (1)

Line range hint 17-41: Overall, good enhancement to predictive back animation.

The changes successfully introduce Material Design-specific predictive back animation to the SharedTransitionsContent composable. This improvement aligns well with the PR objectives and should enhance the user experience.

As a minor suggestion, consider adding a brief comment explaining the purpose of the materialPredictiveBackAnimatable function for future maintainability.

You could add a comment like this above the PredictiveBackParams instantiation:

// Use Material Design-specific animatable for predictive back animation
PredictiveBackParams(
    // ... existing parameters ...
    animatable = ::materialPredictiveBackAnimatable,
)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3376b24 and a40a0a1.

📒 Files selected for processing (3)
  • sample/shared/compose/src/commonMain/kotlin/com/arkivanov/sample/shared/sharedtransitions/SharedTransitionsContent.kt (2 hunks)
  • sample/shared/compose/src/commonMain/kotlin/com/arkivanov/sample/shared/sharedtransitions/gallery/GalleryContent.kt (1 hunks)
  • sample/shared/compose/src/commonMain/kotlin/com/arkivanov/sample/shared/sharedtransitions/photo/PhotoContent.kt (1 hunks)
🧰 Additional context used
🔇 Additional comments (4)
sample/shared/compose/src/commonMain/kotlin/com/arkivanov/sample/shared/sharedtransitions/photo/PhotoContent.kt (1)

35-38: LGTM! Verify transition behavior with new API.

The update from .sharedElement(...) to .sharedBounds(...) aligns with the PR objectives of updating the shared transitions sample. The use of rememberSharedContentState(key = component.image.id) is a good practice for maintaining state consistency across recompositions.

Please verify that:

  1. The transition behavior works as expected with renderInOverlayDuringTransition = false.
  2. The performance is not negatively impacted by these changes.

You may want to test different scenarios to ensure the shared transition still functions correctly with these API updates.

sample/shared/compose/src/commonMain/kotlin/com/arkivanov/sample/shared/sharedtransitions/gallery/GalleryContent.kt (1)

45-48: Verify API change consistency across the codebase.

The change from .sharedElement(...) to .sharedBounds(...) appears to be part of a larger API update. It's important to ensure this change has been applied consistently across the entire codebase.

Run the following script to check for any remaining instances of .sharedElement(...) that might need updating:

If any results are returned, please review those files and update them accordingly.

sample/shared/compose/src/commonMain/kotlin/com/arkivanov/sample/shared/sharedtransitions/SharedTransitionsContent.kt (2)

17-17: LGTM: New import for predictive back animation.

The addition of materialPredictiveBackAnimatable import is appropriate. This function will be used to enhance the predictive back animation functionality, specifically for Material Design-based animations.


39-41: LGTM: Enhanced predictive back animation.

The addition of the animatable parameter to PredictiveBackParams with ::materialPredictiveBackAnimatable is a good improvement. This change enhances the predictive back animation by providing a specific Material Design-based animatable function, which should result in a more polished and consistent user experience.

@arkivanov arkivanov merged commit 6dcca39 into master Oct 17, 2024
3 checks passed
@arkivanov arkivanov deleted the update-shared-transitions-animation-sample branch October 17, 2024 21:12
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