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

feat: Allow clicking on widgets behind the barrier #101

Merged
merged 3 commits into from
Jan 5, 2025

Conversation

mcquenji
Copy link
Contributor

@mcquenji mcquenji commented Jan 2, 2025

  • lib/src/popover_route.dart: Added a new PopoverRoute class that extends RawDialogRoute and includes the allowClicksOnBackground property to control whether widgets behind the barrier can receive pointer events.
  • lib/src/popover.dart: Updated the showPopover function to use PopoverRoute instead of RawDialogRoute and added the allowClicksOnBackground parameter to customize the behavior.

Closes #96
Solves #27

Pre-launch Checklist

  • I read and followed the Effective Dart.
  • I listed at least one issue or feature that this PR fixes or adds in the description above.
  • I updated/added relevant documentation (doc comments with ///).
  • I updated/added relevant documentation to README.md.
  • I updated/added relevant code samples to example.
  • I added new tests to check the change I am making or feature I am adding, or Minikin said the PR is test-exempt.
  • All existing and new tests are passing.

Summary by CodeRabbit

  • New Features

    • Added ability to control background clicks in popovers.
    • Expanded popover module exports.
  • Chores

    • Updated .gitignore to improve version management and IDE settings tracking.
    • Removed VSCode Java null analysis setting.
  • Documentation

    • Updated popover documentation to reflect new interaction behavior.
  • Tests

    • Added tests for popover background click behavior and configuration.

Copy link
Contributor

coderabbitai bot commented Jan 2, 2025

Walkthrough

The pull request introduces modifications to the project's configuration and popover functionality. Changes include updating the .gitignore file to manage Flutter Version Management (FVM) and VS Code settings, removing a Java null analysis setting, and enhancing the popover mechanism. The primary focus is on adding an allowClicksOnBackground parameter to the showPopover function, which provides more control over background interactions when a popover is displayed.

Changes

File Change Summary
.gitignore Added .fvm/, .fvmrc, and .vscode/settings.json; Removed .fvm/flutter_sdk
.vscode/settings.json Removed Java compile null analysis mode setting
lib/popover.dart Added export for src/popover_route.dart
lib/src/popover.dart Updated showPopover function with allowClicksOnBackground parameter
lib/src/popover_route.dart Introduced new PopoverRoute class with allowClicksOnBackground property

Assessment against linked issues

Objective Addressed Explanation
Enable scrolling while popover is open [#96] The current changes do not explicitly address the requirement for scrolling while the popover is open.
Provide option to control background interactions [#96]

Poem

🐰 A popover's dance, a new delight,
With background clicks now set just right,
Scroll freely, tap with glee,
Our code hops forward, wild and free!
Rabbit's magic, code so bright! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b97d5a7 and ac25a5d.

📒 Files selected for processing (2)
  • .gitignore (0 hunks)
  • test/popover_test.dart (1 hunks)
💤 Files with no reviewable changes (1)
  • .gitignore
🔇 Additional comments (2)
test/popover_test.dart (2)

93-133: Well-structured test verifying that background clicks are blocked by default.

This test name precisely conveys its purpose, and the assertion on didOpenDialog is straightforward and descriptive. The setup using createAppWithButtonThatLaunchesDialog is intuitive and maintains clarity.


135-177: Clear demonstration of allowing clicks on background.

The test effectively confirms that allowClicksOnBackground: true toggles background interactivity. This well-labeled scenario ensures that any future regressions in popover background handling can be caught.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@minikin minikin self-requested a review January 4, 2025 16:04
Copy link
Owner

@minikin minikin left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution! Overall lgtm, I left a few minor comments.
Please also add a test case for bool allowClicksOnBackground. and fix CI.

.fvmrc Outdated Show resolved Hide resolved
.gitignore Show resolved Hide resolved
.vscode/settings.json Outdated Show resolved Hide resolved
@mcquenji mcquenji requested a review from minikin January 4, 2025 18:16
@mcquenji mcquenji changed the title feat: allow clicking on widgets behind the barrier Feat: allow clicking on widgets behind the barrier Jan 4, 2025
@mcquenji mcquenji changed the title Feat: allow clicking on widgets behind the barrier feat: allow clicking on widgets behind the barrier Jan 4, 2025
@mcquenji mcquenji changed the title feat: allow clicking on widgets behind the barrier feat: Allow clicking on widgets behind the barrier Jan 4, 2025
@minikin minikin merged commit 1283ecd into minikin:main Jan 5, 2025
4 of 9 checks passed
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.

[Bug]: Unable to scroll while popover is open
2 participants