Skip to content

Commit b9613d3

Browse files
committed
add note about overlay
1 parent 126501d commit b9613d3

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

content/components/overlay.mdx

+8-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,14 @@ import {AccessibilityLink} from '~/src/components/accessibility-link'
1414

1515
## Usage
1616

17-
Overlay is an internal component and is intended to be used as a private API, composing other components. It is not intended to be used on its own.
17+
<Note variant="danger">
18+
<Text sx={{display: 'block', fontWeight: 'bold', mb: 2}}>⚠️ Usage Warning ⚠️</Text>
19+
<Text>
20+
Overlay is an internal component and is intended to be used as a private API, composing other components. It is not intended to be used on its own.
21+
22+
For a ready-to-use overlay-type component, consider <a href="/components/dialog">Dialog</a>, <a href="/components/selectpanel">Select Panel</a>, or <a href="/components/dialog">Action Menu</a>.
23+
</Text>
24+
</Note>
1825

1926
The overlay component handles all behaviors needed by overlay UIs as well as the common styles that all overlays should have. Overlay is the internal, or base component for many of our overlay-type components. Overlays use shadows to express elevation.
2027

0 commit comments

Comments
 (0)