UIKit
7.24.0
• OverlayComponents
UIKit
7.24.0
Date Components
3.3.2
Navigation
3.7.2
visible
background
import {Overlay} from '@gravity-ui/uikit';
The Overlay component renders an overlay over the parent element with the relative position, i.e., the parent element must have position set to relative.
For example, it can be used to preserve the desired layout while loading data.
import {Box, Overlay, Loader} from '@gravity-ui/uikit';
<Box position="relative">
<div>Some content to hide under overlay</div>
<Overlay visible={loading}>
<Loader />
</Overlay>
</Box>;
§Appearance
§Background
You can use base or float background colors.
§Properties
| Name | Description | Type | Default |
|---|---|---|---|
| className | CSS class name of the root element | string | |
| visible | Overlay visibility state | boolean | false |
| background | Overlay background style | "base" "float" | base |
| children | Content (usually, a Loader component) | React.ReactNode |