Skip to content

Commit

Permalink
Fix Tooltip documentation (#58013)
Browse files Browse the repository at this point in the history
  • Loading branch information
Mothblocks authored Mar 28, 2021
1 parent 6a84fb9 commit e692b05
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions tgui/docs/component-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -1083,21 +1083,22 @@ Intended for usage on interfaces where tab color has relevance.

### `Tooltip`

A boxy tooltip from tgui 1. It is very hacky in its current state, and
requires setting `position: relative` on the container.
A boxy tooltip that displays when hovering over its children.

Please note, that [Button](#button) component has a `tooltip` prop, and
it is recommended to use that prop instead.

Usage:

```jsx
<Box position="relative">
Sample text.
<Tooltip
position="bottom"
content="Box tooltip" />
</Box>
<Tooltip
position="bottom"
content="Box tooltip"
>
<Box>
Sample text.
</Box>
</Tooltip>
```

**Props:**
Expand Down

0 comments on commit e692b05

Please sign in to comment.