Skip to content

Commit

Permalink
chore(Overlay): fixes in README
Browse files Browse the repository at this point in the history
  • Loading branch information
Vladeeg committed Jun 25, 2024
1 parent 5c3db0e commit 49eba67
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/components/Overlay/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,14 @@ i.e. parent element must have `position` set to `relative`.
For example, it can be used to preserve the desired layout while loading data.

```jsx
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>
</Box>;
```

## Appearance
Expand All @@ -40,7 +42,7 @@ You can use `base` or `float` background colors.

| Name | Description | Type | Default |
| :--------- | :---------------------------------- | :----------------: | :-----: |
| className | CSS class name of the root element | `String` | |
| visible | Overlay visibility state | `Boolean` | `false` |
| 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` | |

0 comments on commit 49eba67

Please sign in to comment.