Skip to content

fix: #1067 dropdown broken on Safari #1634

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

cameront
Copy link

@cameront cameront commented Jun 7, 2025

Closes #1067

📑 Description

When looking into #1067, I found that the Popper element used by Dropdown contained some race conditions when managing two-way-bound state of isOpen

This PR delays the processing of the two popover state-changing paths (interactive events, and the changing of is_open) in order to simplify state management. This also results in unifying dropdown behavior on chrome and safari.

I know that the Popper element is used by elements other than Dropdown, but as far as I can tell (logically and via interacting with them in the examples) this PR shouldn't negatively those elements.

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

Summary by CodeRabbit

  • Refactor
    • Improved popover open and close behavior with a debounced state management system, resulting in smoother transitions and more reliable interactions during rapid user actions.

Copy link

vercel bot commented Jun 7, 2025

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

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Jun 7, 2025

"""

Walkthrough

The changes refactor popover open/close/toggle logic in Popper.svelte by introducing a debounced state management system. Direct assignments to the isOpen state are replaced with calls to new start_change and finish_change functions, which handle delayed, prioritized, and centralized state transitions, improving consistency and control over popover behavior.

Changes

File(s) Change Summary
src/lib/utils/Popper.svelte Refactored popover open/close/toggle logic to use debounced state management via start_change and finish_change. Introduced prioritization between interactive and programmatic changes, removed isTriggered flag, and consolidated state transitions. Added ChangeContext interface.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PopperComponent
    participant DebounceManager

    User->>PopperComponent: Triggers open/close/toggle event
    PopperComponent->>DebounceManager: start_change(nextOpen, interactive)
    DebounceManager-->>PopperComponent: (after triggerDelay) finish_change()
    PopperComponent->>PopoverState: Update isOpen
Loading

Assessment against linked issues

Objective Addressed Explanation
Fix Dropdown not working on Safari when using bind:open (#1067)

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Possibly related PRs

Poem

A popover hops with gentle delay,
Debounced and tidy, now it will stay—
Open or closed, with logic refined,
No more Safari woes to find!
With every click, the state will flow,
As rabbits cheer, "Let dropdowns go!"
🐇✨
"""


📜 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 369b29f and 29cd585.

📒 Files selected for processing (1)
  • src/lib/utils/Popper.svelte (6 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/lib/utils/Popper.svelte

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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
Contributor

@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: 3

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8a77b47 and 4643bf3.

📒 Files selected for processing (1)
  • src/lib/utils/Popper.svelte (6 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: mrh1997
PR: themesberg/flowbite-svelte#1442
File: src/lib/utils/Popper.svelte:144-145
Timestamp: 2024-11-22T08:37:27.996Z
Learning: In `src/lib/utils/Popper.svelte`, inconsistencies in event handling (e.g., using both `mouseenter`/`mouseleave` and `pointerenter`/`pointerleave`) may be intentional to minimize modifications and reduce the risk of new problems.
src/lib/utils/Popper.svelte (1)
Learnt from: mrh1997
PR: themesberg/flowbite-svelte#1442
File: src/lib/utils/Popper.svelte:144-145
Timestamp: 2024-11-22T08:37:27.996Z
Learning: In `src/lib/utils/Popper.svelte`, inconsistencies in event handling (e.g., using both `mouseenter`/`mouseleave` and `pointerenter`/`pointerleave`) may be intentional to minimize modifications and reduce the risk of new problems.
🪛 ESLint
src/lib/utils/Popper.svelte

[error] 192-192: 'NodeJS' is not defined.

(no-undef)

🔇 Additional comments (3)
src/lib/utils/Popper.svelte (3)

52-60: LGTM! Clean transition to debounced state management.

The change properly delegates the open action to the debouncing system and correctly marks it as interactive.


62-69: Good addition of toggle functionality.

The new toggle function properly integrates with the debouncing system and maintains consistency with other event handlers.


121-128: Correct handling of programmatic state changes.

The change properly marks toggle events as non-interactive, allowing the debouncing system to prioritize programmatic control over user interactions.

@cameront cameront force-pushed the cameron-fix-popper-race-conditions branch from 369b29f to 29cd585 Compare June 17, 2025 16:50
@cameront cameront changed the title fix: attempt to debounce popover logic to simplify two-way binding of isOpen fix: #1067 dropdown broken on Safari Jun 17, 2025
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.

Dropdown is broken on Safari
1 participant