Skip to content

Commit 2db2c99

Browse files
HDS-5092 Add documentation for boundary option
1 parent 6490e6c commit 2db2c99

File tree

3 files changed

+19
-1
lines changed

3 files changed

+19
-1
lines changed

website/docs/components/dropdown/partials/code/component-api.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,12 @@ The Dropdown component is composed of different child components each with their
9090
<C.Property @name="onClose" @type="function">
9191
Callback function invoked when the Dropdown is closed, if provided.
9292
</C.Property>
93+
<C.Property @name="boundary" @type="Boundary | string">
94+
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.
95+
<br />
96+
<br />
97+
Must be used in conjunction with setting `enableCollisionDetection` to `true`.
98+
</C.Property>
9399
<C.Property @name="...attributes">
94100
This component supports use of [`...attributes`](https://guides.emberjs.com/release/in-depth-topics/patterns-for-components/#toc_attribute-ordering).
95101
</C.Property>

website/docs/components/rich-tooltip/partials/code/component-api.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,13 @@ Most of the arguments are forwarded as `anchoredPositionOptions` to the underlyi
122122
<C.Property @name="height" @type="string" @valueNote="any valid CSS height (px, rem, etc)">
123123
By default, the bubble adapts to its content size. If an `@height` parameter is provided, then the bubble will have a fixed height.
124124
</C.Property>
125+
<C.Property @name="boundary" @type="Boundary | string">
126+
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.
127+
<br />
128+
<br />
129+
Must be used in conjunction with setting `enableCollisionDetection` to `true`.
130+
</C.Property>
125131
<C.Property @name="...attributes">
126132
This component supports use of [`...attributes`](https://guides.emberjs.com/release/in-depth-topics/patterns-for-components/#toc_attribute-ordering).
127133
</C.Property>
128-
</Doc::ComponentApi>
134+
</Doc::ComponentApi>

website/docs/utilities/popover-primitive/partials/code/component-api.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@
2121
<C.Property @name="onClose" @type="function">
2222
Provides a callback function invoked when the popover is closed (if provided).
2323
</C.Property>
24+
<C.Property @name="boundary" @type="Boundary | string">
25+
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.
26+
<br />
27+
<br />
28+
Must be used in conjunction with setting `enableCollisionDetection` to `true`.
29+
</C.Property>
2430
<C.Property @name="[PP].setupPrimitiveContainer" @type="modifier">
2531
Provides a modifier that needs to be applied to the container of the toggle and popover elements.
2632
</C.Property>

0 commit comments

Comments
 (0)