Skip to content

Documentation - Collision detection - add boundary option (HDS-5092) #3431

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.

Sign up for GitHub

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

Draft
KristinLBradley wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −1
Draft

Documentation - Collision detection - add boundary option (HDS-5092) #3431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions website/docs/components/dropdown/partials/code/component-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,12 @@ The Dropdown component is composed of different child components each with their
<C.Property @name="onClose" @type="function">
Callback function invoked when the Dropdown is closed, if provided.
</C.Property>
<C.Property @name="boundary" @type="Boundary | string">
Provides an option to specify a parent or ancestor container element to act as the boundary for collision detection vs. the browser window boundaries which is the default. The value provided must be either a `Boundary` type as specified in the [Floating UI library documentation](https://floating-ui.com/docs/detectoverflow#options) or an id string for the boundary container element.
<br />
<br />
Must be used in conjunction with setting `enableCollisionDetection` to `true`.
</C.Property>
<C.Property @name="...attributes">
This component supports use of [`...attributes`](https://guides.emberjs.com/release/in-depth-topics/patterns-for-components/#toc_attribute-ordering).
</C.Property>
Expand Down
8 changes: 7 additions & 1 deletion website/docs/components/rich-tooltip/partials/code/component-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,13 @@ Most of the arguments are forwarded as `anchoredPositionOptions` to the underlyi
<C.Property @name="height" @type="string" @valueNote="any valid CSS height (px, rem, etc)">
By default, the bubble adapts to its content size. If an `@height` parameter is provided, then the bubble will have a fixed height.
</C.Property>
<C.Property @name="boundary" @type="Boundary | string">
Provides an option to specify a parent or ancestor container element to act as the boundary for collision detection vs. the browser window boundaries which is the default. The value provided must be either a `Boundary` type as specified in the [Floating UI library documentation](https://floating-ui.com/docs/detectoverflow#options) or an id string for the boundary container element.
<br />
<br />
Must be used in conjunction with setting `enableCollisionDetection` to `true`.
</C.Property>
<C.Property @name="...attributes">
This component supports use of [`...attributes`](https://guides.emberjs.com/release/in-depth-topics/patterns-for-components/#toc_attribute-ordering).
</C.Property>
</Doc::ComponentApi>
</Doc::ComponentApi>
6 changes: 6 additions & 0 deletions website/docs/utilities/popover-primitive/partials/code/component-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@
<C.Property @name="onClose" @type="function">
Provides a callback function invoked when the popover is closed (if provided).
</C.Property>
<C.Property @name="boundary" @type="Boundary | string">
Provides an option to specify a parent or ancestor container element to act as the boundary for collision detection vs. the browser window boundaries which is the default. The value provided must be either a `Boundary` type as specified in the [Floating UI library documentation](https://floating-ui.com/docs/detectoverflow#options) or an id string for the boundary container element.
<br />
<br />
Must be used in conjunction with setting `enableCollisionDetection` to `true`.
</C.Property>
<C.Property @name="[PP].setupPrimitiveContainer" @type="modifier">
Provides a modifier that needs to be applied to the container of the toggle and popover elements.
</C.Property>
Expand Down