fix: close Dropdown on click outside in Safari

[cpsoinos]

Closes #1237

📑 Description

Currently, Dropdown has a bug where clicking outside an open dropdown in Safari will not close it. It works in Chrome and Firefox as-is, but not Safari.

This PR adds explicit event handling to clicks on the document outside the Popper or its triggering elements. It checks if the click is on the floating element or its trigger(s), and if not, closes the popper using the existing hideHandler.

Status

• Not Completed
• Completed

✅ Checks

• My pull request adheres to the code style of this project
• My code requires changes to the documentation
• I have updated the documentation as required
• I have checked the page with https://validator.unl.edu/
• All the tests have passed
• My pull request is based on the latest commit (not the npm version).

ℹ Additional Information

There is an existing clickOutside utility, but it is not a fit for this use case. We need to check both the floating element and its triggers here, which is not possible in the existing clickOutside function.

Summary by CodeRabbit

• Bug Fixes
  • Fixed an issue in Safari where the popper would not close when clicking outside.

[vercel]

@cpsoinos is attempting to deploy a commit to the Themesberg Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

The recent changes to the Popper.svelte file address an issue where dropdowns on mobile devices, particularly Safari and Chrome on iOS, do not close when clicking outside. This was achieved by adding an event listener for 'click' to trigger a closeOnClickOutside function, ensuring the dropdown closes appropriately. The cleanup function was also updated to remove this event listener.

Changes

File	Change Summary
src/lib/utils/Popper.svelte	Added an event listener for 'click' to invoke closeOnClickOutside. Implemented closeOnClickOutside function and updated the cleanup function to remove the event listener.

Assessment against linked issues

Objective	Addressed	Explanation
Dropdown should close when clicking outside on mobile (Safari, Chrome) (#1237)	✅

Poem

In the realm of clicks and taps,
Where dropdowns sometimes had mishaps,
With Safari and Chrome in view,
Now they close as they ought to do.
Code and care, a seamless blend,
Popper’s woes have met their end! 🐰✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[coderabbitai]

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 51ba091 and 8839e45.

Files selected for processing (1)

• src/lib/utils/Popper.svelte (2 hunks)

Additional comments not posted (2)

src/lib/utils/Popper.svelte (2)

Line range hint 154-167: Addition of event listener for 'click' to handle clicks outside the popper.

Ensure the removal of the event listener in the onDestroy function is thoroughly tested to avoid memory leaks.

---

171-181: Implementation of the closeOnClickOutside function to address the Safari-specific bug.

This function effectively checks if the click event is outside the popper and its trigger elements before calling hideHandler. This is a critical fix for the issue described.

[coderabbitai]

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 8839e45 and bccf8ab.

Files selected for processing (1)

• src/lib/utils/Popper.svelte (2 hunks)

Files skipped from review as they are similar to previous changes (1)

• src/lib/utils/Popper.svelte

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
flowbite-svelte	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 18, 2024 4:47am

[shinokada]

Thank you for your contribution.