Fix 3263/dropdown scrolling out aggrid - Dropdown should be inside the parent container when scrolled vertically or horizontally and autoclose in 300ms if not visible.

[khathija-ahamadi]

💡 What is the current behavior?

Dropdown is scrolling outside its ag-grid (parent/wrapper) component - both vertically and horizontally.

Jira # --> IX-3263 IX-3822

🆕 What is the new behavior?

Dropdown does not scroll outside grid view when scrolled horizontally or vertically.
Dropdown automatically closes when fully not visible in the screen after 300ms.

• Closing dropdown when not visible in 300ms:
o Handled in core:
 dropdown.tsx (#sym:Dropdown): Internal logic in @watch('show') and isDropdownFullyNotVisible() auto-closes dropdown after 300ms if fully out of viewport.
 dropdown-controller.ts: Manages global dropdown open/close state.
o Preview examples:
 Do not implement this logic; rely on core IX dropdown.

• Dropdown should not go outside grid:
o Handled in core:
 dropdown.tsx: Uses container prop and limitShift middleware to keep overlay inside the specified container (e.g., grid viewport).
o Preview examples:
Set dropdown container to closest .ag-body-viewport so overlay is clipped to grid.

• Why is "Set dropdown container to closest .ag-body-viewport so overlay is clipped to grid" not handled in core?

• o The core IX dropdown (dropdown.tsx) is framework-agnostic and does not know about AG Grid or the structure of your app.
• o The app/framework code (Preview examples) is responsible for determining the correct container (like .ag-body-viewport) based on the grid's DOM and passing it to the dropdown via the container prop.
• o This allows the dropdown to be reusable in any context, not just AG Grid. The core only enforces containment if a container is provided.

🏁 Checklist

A pull request can only be merged if all of these conditions are met (where applicable):

• 🦮 Accessibility (a11y) features were implemented
• 🗺️ Internationalization (i18n) - no hard coded strings
• 📲 Responsiveness - components handle viewport changes and content overflow gracefully
• 📕 Add or update a Storybook story
• 📄 Documentation was reviewed/updated siemens/ix-docs
• 🧪 Unit tests were added/updated and pass (pnpm test)
• 📸 Visual regression tests were added/updated and pass (Guide)
• 🧐 Static code analysis passes (pnpm lint)
• 🏗️ Successful compilation (pnpm build, changes pushed)

👨‍💻 Help & support

[changeset-bot]

⚠️ No Changeset found

Latest commit: 7cf04e1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[gemini-code-assist]

Summary of Changes

Hello @khathija-ahamadi, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly improves the ix-dropdown component's behavior by addressing common issues related to its positioning and visibility. It provides enhanced control over where dropdowns appear relative to their parent elements and introduces an intelligent auto-closure feature, leading to a more robust and user-friendly experience for applications utilizing these dropdowns.

Highlights

• Dropdown Containment: Introduced a new "container" prop to the ix-dropdown component, allowing developers to specify a parent element to constrain the dropdown's position. This prevents the dropdown from scrolling out of view relative to its intended parent.
• Automatic Dropdown Closure: Implemented an automatic closing mechanism for ix-dropdown that dismisses the dropdown after 300ms if it becomes completely invisible within the viewport due to scrolling or resizing events.
• Framework Integration: The new "container" prop has been exposed to the Angular, React, and Vue wrappers for the ix-dropdown component, ensuring consistent functionality across different frameworks.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a new container property to the ix-dropdown component, allowing users to specify an element to constrain the dropdown's positioning. The changes involve updating the Angular, React, and Vue wrappers to expose this new property, and modifying the core dropdown.tsx component to implement the containment logic. This includes importing limitShift from @floating-ui/dom to restrict the dropdown's movement within the container, dynamically appending the dropdown's host element to the specified container, and adjusting the positioning strategy to 'absolute' when a container is present. Additionally, the PR adds functionality for the dropdown to automatically dismiss if it becomes fully invisible due to scrolling or resizing, implemented with event listeners and a short timeout. Minor adjustments were made to the dropdown-controller for more robust willPresent/willDismiss checks and overscroll-behavior: contain was added to the dropdown's CSS. Review comments raised concerns about a @ts-ignore for a type mismatch in the limitShift boundary property and highlighted the potential side effects of the DOM manipulation involved in moving the dropdown element to the specified container.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud