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

fix: close any open dropdown or related components with overlay clicks #41

Merged
merged 4 commits into from
Dec 27, 2024

Conversation

sun-mota
Copy link
Contributor

@sun-mota sun-mota commented Dec 23, 2024

Alaska Airlines Pull Request

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Resolves: #40

Summary:

Clicking overlay will not close the dialog when there is an open dropdown

Please summarize the scope of the changes you have submitted, what the intent of the work is and anything that describes the before/after state of the project.

Type of change:

Please delete options that are not relevant.

  • New capability
  • Revision of an existing capability
  • Infrastructure change (automation, etc.)
  • Other (please elaborate)

Checklist:

  • My update follows the CONTRIBUTING guidelines of this project
  • I have performed a self-review of my own update

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.

Thank you for your submission!

-- Auro Design System Team

@sun-mota sun-mota self-assigned this Dec 23, 2024
@sun-mota sun-mota requested a review from a team as a code owner December 23, 2024 19:37
Copy link
Contributor

sourcery-ai bot commented Dec 23, 2024

Reviewer's Guide by Sourcery

This pull request addresses issue #40 by modifying the overlay click handling in the ComponentBase class to ensure that dialogs are not closed if any dropdown components are open. Additionally, the auro-menu script is added to the demo page to support testing of the changes.

Sequence diagram for overlay click handling with dropdowns

sequenceDiagram
    actor User
    participant Overlay
    participant ComponentBase
    participant Dropdowns

    User->>Overlay: clicks
    activate Overlay
    Overlay->>ComponentBase: handleOverlayClick()
    activate ComponentBase
    alt open && !modal
        ComponentBase->>ComponentBase: Query for dropdowns
        ComponentBase->>Dropdowns: Check isPopoverVisible
        activate Dropdowns
        Dropdowns-->>ComponentBase: Dropdown states
        deactivate Dropdowns
        alt no dropdowns open
            ComponentBase->>ComponentBase: handleCloseButtonClick()
        end
    end
    deactivate ComponentBase
    deactivate Overlay
Loading

Class diagram showing ComponentBase changes

classDiagram
    class ComponentBase {
        +boolean open
        +boolean modal
        +handleOverlayClick()
        +handleCloseButtonClick()
    }
    note for ComponentBase "Modified handleOverlayClick to check
for open dropdowns before closing"
Loading

File-Level Changes

Change Details Files
Modify overlay click handling to account for open dropdowns
  • Check for open dropdown components before closing the dialog
  • Query for dropdown components and check their visibility
  • Prevent dialog closure if any dropdown is open
src/componentBase.js
Add auro-menu script to demo page
  • Include auro-menu script in the demo page for testing purposes
demo/api.html

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

github-actions bot commented Dec 23, 2024

Surge demo deployment failed! 😭

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @sun-mota - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

src/componentBase.js Outdated Show resolved Hide resolved
@sun-mota sun-mota changed the title fix: close any open dropdown or related components with overlay clips fix: close any open dropdown or related components with overlay clicks Dec 25, 2024
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@sun-mota sun-mota force-pushed the sunMota/close-open-dropdown branch from 7e7448d to 47832ee Compare December 25, 2024 19:55
src/componentBase.js Outdated Show resolved Hide resolved
@sun-mota sun-mota merged commit d54e0a9 into main Dec 27, 2024
6 of 7 checks passed
@sun-mota sun-mota deleted the sunMota/close-open-dropdown branch December 27, 2024 22:06
@jordanjones243
Copy link
Contributor

🎉 This PR is included in version 2.3.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@jordanjones243 jordanjones243 added the released Completed work has been released label Dec 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Completed work has been released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

dropdown in dialog: when clicking outside of dialog while dropdown open, the entire dialog closes
2 participants