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

Disable input during predictive back animation #775

Merged
merged 1 commit into from
Sep 7, 2024

Conversation

arkivanov
Copy link
Owner

@arkivanov arkivanov commented Sep 7, 2024

Fixes #773.

Summary by CodeRabbit

  • New Features

    • Introduced InputConsumingOverlay to enhance input event handling during animations.
    • Added conditional rendering logic for InputConsumingOverlay in the predictive back animation to improve user interaction control.
  • Bug Fixes

    • Simplified input handling by removing the custom Overlay function, maintaining functionality to prevent user interactions during transitions.

Copy link

coderabbitai bot commented Sep 7, 2024

Walkthrough

The changes involve the introduction of an InputConsumingOverlay component to manage pointer input events during animations in the AbstractStackAnimation and PredictiveBackAnimation classes. The previous custom Overlay function has been removed, simplifying the code. The new component ensures that user interactions are appropriately managed during transitions, enhancing the overall input handling in the UI.

Changes

Files Change Summary
extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/stack/animation/AbstractStackAnimation.kt, extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/stack/animation/predictiveback/PredictiveBackAnimation.kt Removed the custom Overlay function and integrated InputConsumingOverlay for input management during animations.
extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/utils/InputConsumingOverlay.kt Introduced a new InputConsumingOverlay composable to handle pointer events effectively.

Assessment against linked issues

Objective Addressed Explanation
Disallow clicks for either of stack destinations while the iOS's PredictiveBackOverlay gesture is in progress (#773)

🐰 In a world where gestures glide,
A rabbit hops with joy and pride.
With overlays that gently sway,
Clicks are hushed, they fade away.
In transitions smooth, we find our way,
A dance of screens, come out to play! 🐇✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ba105fd and e7c597f.

Files selected for processing (3)
  • extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/stack/animation/AbstractStackAnimation.kt (2 hunks)
  • extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/stack/animation/predictiveback/PredictiveBackAnimation.kt (2 hunks)
  • extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/utils/InputConsumingOverlay.kt (1 hunks)
Additional comments not posted (3)
extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/utils/InputConsumingOverlay.kt (1)

8-20: Well-implemented utility for consuming pointer input events.

The InputConsumingOverlay function is correctly implemented to consume all pointer input events, which is essential for preventing unintended user interactions during animations. The use of an infinite loop to handle events continuously is appropriate for this use case.

extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/stack/animation/AbstractStackAnimation.kt (1)

13-13: Refactoring to use InputConsumingOverlay enhances maintainability and clarity.

The replacement of the custom Overlay function with InputConsumingOverlay simplifies the codebase and potentially optimizes pointer event handling. The conditional use of this overlay based on animation states and input disabling flags is well-implemented.

Run the following script to verify the integration of InputConsumingOverlay in the broader system:

Also applies to: 59-59

Verification successful

Integration of InputConsumingOverlay Verified

The integration of InputConsumingOverlay is consistent and well-implemented across the codebase, enhancing maintainability and clarity as intended. The usage in AbstractStackAnimation.kt and PredictiveBackAnimation.kt aligns with the expected behavior of consuming input events during animations. No issues were found in the integration.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the integration of `InputConsumingOverlay` in the broader system.

# Test: Search for the usage of `InputConsumingOverlay`. Expect: Proper integration and no issues reported.
rg --type kotlin -A 5 $'InputConsumingOverlay'

Length of output: 5242

extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/stack/animation/predictiveback/PredictiveBackAnimation.kt (1)

21-21: Logical conditional rendering of InputConsumingOverlay based on the state of handler.items.

The addition of InputConsumingOverlay under the condition that handler.items.size > 1 is a thoughtful implementation to prevent unintended user interactions during complex transitions. This change should enhance the user experience by ensuring that interactions are only possible when appropriate.

Run the following script to verify the behavior during runtime and ensure it aligns with user experience expectations:

Also applies to: 100-102

Verification successful

Conditional Rendering of InputConsumingOverlay Verified

The conditional rendering of InputConsumingOverlay based on handler.items.size > 1 is present in the code, as described in the review comment. This implementation should indeed enhance the user experience by preventing unintended interactions during complex transitions.

  • Location: extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/stack/animation/predictiveback/PredictiveBackAnimation.kt, line 101
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the behavior of `InputConsumingOverlay` during runtime.

# Test: Search for runtime logs or issues related to `InputConsumingOverlay`. Expect: No issues and positive feedback on user experience.
rg --type logs -A 5 $'InputConsumingOverlay'

Length of output: 72


Script:

#!/bin/bash
# Search for the implementation of InputConsumingOverlay to verify its conditional rendering.
ast-grep --lang kotlin --pattern 'InputConsumingOverlay' 

# Search for any logging or comments related to InputConsumingOverlay to understand its runtime behavior.
rg 'InputConsumingOverlay' -A 5

Length of output: 6318


Script:

#!/bin/bash
# Search for the conditional logic involving handler.items.size in PredictiveBackAnimation.kt
rg 'handler.items.size' -A 5 -B 5 --glob '**/PredictiveBackAnimation.kt'

Length of output: 1925

@arkivanov arkivanov merged commit 365b434 into master Sep 7, 2024
3 checks passed
@arkivanov arkivanov deleted the disable-input-during-predictive-back-animation branch September 7, 2024 12:40
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.

Disallow clicks for either of stack destinations while the iOS's PredictiveBackOverlay gesture is in progress.
1 participant