You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content/Overlay.mdx
+18-11Lines changed: 18 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,23 +72,13 @@ See the W3C accessibility recommendations for modals [here](https://www.w3.org/T
72
72
73
73
## Positioning
74
74
75
-
`Overlay` renders its `children` within a div positioned absolutely within a portal within the default portal root. The overlay will not update its positioning if the portal root's positioning changes (e.g., if the portal root is statically positioned after some DOM element that dynamically resizes). You may consider [customizing the portal or specifying a different portal root](/Portal#customizing-the-portal-root) to achieve different positioning behavior.
75
+
`Overlay` renders its `children` within a div positioned absolutely within a portal within the default portal root. The overlay will not update its positioning if the portal root's positioning changes (e.g., if the portal root is statically positioned after some DOM element that dynamically resizes). You may consider using the [AnchoredOverlay](/AnchoredOverlay) component or [customizing the portal root](/Portal#customizing-the-portal-root) to achieve different positioning behavior.
76
76
77
77
## Props
78
78
79
79
### Overlay
80
80
81
81
<PropsTable>
82
-
<PropsTableRow
83
-
required
84
-
name="anchorRef"
85
-
type="React.RefObject<HTMLElement>"
86
-
description={
87
-
<>
88
-
Element the <InlineCode>Overlay</InlineCode> should be anchored to.
89
-
</>
90
-
}
91
-
/>
92
82
<PropsTableRow
93
83
required
94
84
name="returnFocusRef"
@@ -182,6 +172,23 @@ See the W3C accessibility recommendations for modals [here](https://www.w3.org/T
182
172
</>
183
173
}
184
174
/>
175
+
<PropsTableRow
176
+
name="maxHeight"
177
+
type={`|'xsmall'
178
+
|'small'
179
+
|'medium'
180
+
|'large'
181
+
|'xlarge'`}
182
+
description={
183
+
<>
184
+
Sets the maximum height of the <InlineCode>Overlay</InlineCode>, pick from our set list of heights.
185
+
<InlineCode>xsmall</InlineCode> corresponds to <InlineCode>192px</InlineCode>, <InlineCode>small</InlineCode> corresponds
186
+
to <InlineCode>256px</InlineCode>, <InlineCode>medium</InlineCode> corresponds to <InlineCode>320px</InlineCode>,{' '}
187
+
<InlineCode>large</InlineCode> corresponds to <InlineCode>432px</InlineCode>, <InlineCode>xlarge</InlineCode> corresponds
0 commit comments