Skip to content

Commit

Permalink
add note about overlay
Browse files Browse the repository at this point in the history
  • Loading branch information
khiga8 committed Jan 30, 2025
1 parent 126501d commit ba855ea
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion content/components/overlay.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,14 @@ import {AccessibilityLink} from '~/src/components/accessibility-link'

## Usage

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.
<Note variant="danger">
<Text sx={{display: 'block', fontWeight: 'bold', mb: 2}}>⚠️ Usage Warning ⚠️</Text>
<Text>
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.

For a ready-to-use overlay-type component, refer to <a href="/components/dialog">Dialog</a>, <a href="/components/selectpanel">Select Panel</a>, or <a href="/components/dialog">Action Menu</a>.
</Text>
</Note>

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.

Expand Down

0 comments on commit ba855ea

Please sign in to comment.