Skip to content

Commit 471ad89

Browse files
committed
docs(tooltip): 🐛 refactored table content, and rendering of info content
1 parent 5ae7ade commit 471ad89

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

docs/tooltip.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,20 +28,22 @@ export default function App() {
2828
}
2929
```
3030

31-
This component uses <Popover> component from
31+
This component uses `<Popover>` component from
3232
[`react-native-popper`](https://github.com/intergalacticspacehighway/react-native-popper)
3333

3434
## Props
3535

36-
| Name | Description | Type | Default |
37-
| ------------------ | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -------- |
38-
| placement | Tooltip placement | `top` `bottom` `left` `right` `top left` `top right` `bottom left` `bottom right` `right top` `right bottom` `left top` `left bottom` | `bottom` |
39-
| trigger | The trigger of the Tooltip | JSXELement | |
40-
| content | The content of the Tooltip | JSXELement or string | |
41-
| action | Action in which to show the Tooltip | JSXELement or string | |
42-
| mainOffset | Distance between popover and trigger's main axis | number | 0 |
43-
| crossOffset | Distance between popover and trigger's cross axis | number | 0 |
44-
| hasArrow | Whether popover should have an arrow | boolean | false |
45-
| shouldFlip | Whether the popover should flip if there's less space | boolean | true |
46-
| isTooltipOpen | Is the Tooltip Open for Controlled popovers | boolean | |
47-
| handleTooltipState | A callback to listen to change events also to set state for controlled popovers. | (isOpen: boolean) => void | |
36+
| Name | Description | Type | Default |
37+
|--------------------|----------------------------------------------------------------------------------|---------------------------|---------|
38+
| placement | Tooltip placement with respect to the trigger placement | TooltipPlacement | |
39+
| trigger | The trigger of the Tooltip | JSXELement | |
40+
| content | The content of the Tooltip | JSXELement or string | |
41+
| action | Action in which to show the Tooltip | JSXELement or string | |
42+
| mainOffset | Distance between popover and trigger's main axis | number | 0 |
43+
| crossOffset | Distance between popover and trigger's cross axis | number | 0 |
44+
| hasArrow | Whether popover should have an arrow | boolean | false |
45+
| shouldFlip | Whether the popover should flip if there's less space | boolean | true |
46+
| isTooltipOpen | Is the Tooltip Open for Controlled popovers | boolean | |
47+
| handleTooltipState | A callback to listen to change events also to set state for controlled popovers. | (isOpen: boolean) => void | |
48+
49+
> type TooltipPlacement `top` `bottom` `left` `right` `top left` `top right` `bottom left` `bottom right` `right top` `right bottom` `left top`

0 commit comments

Comments
 (0)