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

Add resizeObserver to trigger popper update #270 #271

Merged
merged 4 commits into from
Dec 19, 2024

Conversation

rmenner
Copy link
Contributor

@rmenner rmenner commented Dec 19, 2024

Alaska Airlines Pull Request

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

Summary by Sourcery

Enhancements:

  • Integrate ResizeObserver to monitor element size changes and trigger popper updates accordingly.

@rmenner rmenner requested a review from a team as a code owner December 19, 2024 01:38
@rmenner rmenner self-assigned this Dec 19, 2024
Copy link

sourcery-ai bot commented Dec 19, 2024

Reviewer's Guide by Sourcery

This PR adds a ResizeObserver to the auro-dropdown component to handle dynamic size changes of the trigger element. The implementation uses the browser's ResizeObserver API to automatically update the popper positioning when the trigger element's size changes.

Updated class diagram for AuroDropdown with ResizeObserver

classDiagram
    class AuroDropdown {
        +boolean isPopoverVisible
        +boolean matchWidth
        +boolean noHideOnThisFocusLoss
        +ResizeObserver resizeObserver
        +void privateDefaults()
        +void notifyReady()
        +void dispatchEventDropdownToggle()
        +void render()
        +void setUpResizeObserver()
    }
    note for AuroDropdown "Added resizeObserver attribute and setUpResizeObserver method"
Loading

File-Level Changes

Change Details Files
Added ResizeObserver functionality to handle dynamic size changes
  • Initialized resizeObserver property as null in the constructor
  • Created setUpResizeObserver method to initialize the ResizeObserver instance
  • Added observer setup call in the firstUpdated lifecycle method
  • Implemented observer start/stop on dropdown toggle
  • Added popper update trigger when resize is detected
src/auro-dropdown.js

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

@rmenner rmenner linked an issue Dec 19, 2024 that may be closed by this pull request
Copy link

github-actions bot commented Dec 19, 2024

Surge demo deployment failed! 😭

Copy link

@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 @rmenner - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding cleanup for the ResizeObserver in disconnectedCallback() to prevent potential memory leaks
Here's what I looked at during the review
  • 🟡 General issues: 2 issues 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/auro-dropdown.js Outdated Show resolved Hide resolved
src/auro-dropdown.js Show resolved Hide resolved
src/auro-dropdown.js Outdated Show resolved Hide resolved
src/auro-dropdown.js Outdated Show resolved Hide resolved
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.2.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Dec 19, 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.

auro-select issue: select dropdown position is off
3 participants