Skip to content

docs: document align.overflow option including alwaysByViewport #511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yoyo837 merged 3 commits into from
May 12, 2026
+25 −1
Merged

docs: document align.overflow option including alwaysByViewport #511

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b92a799
docs: document align.overflow option including alwaysByViewport
yoyo837 May 12, 2026
fa51389
docs: fix anchor link for Align Overflow section
yoyo837 May 12, 2026
f6b7416
Apply suggestion from @gemini-code-assist[bot]
yoyo837 May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,36 @@ Online demo: https://tooltip-react-component.vercel.app/
| mouseLeaveDelay | number | 0.1 | delay time (in second) before tooltip hides when mouse leave |
| getTooltipContainer | (triggerNode: HTMLElement) => HTMLElement | () => document.body | get container of tooltip, default to body |
| destroyOnHidden | boolean | false | destroy tooltip when it is hidden |
| align | object | | align config of tooltip. Please ref demo for usage example |
| align | object | | align config of tooltip, ref [dom-align](https://github.com/yiminghe/dom-align). See [Align Overflow](#align-overflow) below |
| showArrow | boolean \| object | false | whether to show arrow of tooltip |
| zIndex | number | | config popup tooltip zIndex |
| classNames | classNames?: { root?: string; container?: string;}; | | Semantic DOM class |
| styles | styles?: {root?: React.CSSProperties;container?: React.CSSProperties;}; | | Semantic DOM styles |

### Align Overflow

The `align` prop accepts an object that may include an `overflow` field to control how the tooltip adjusts when it overflows the visible area. This is powered by [dom-align](https://github.com/yiminghe/dom-align).

| name | type | default | description |
| ---------------- | ---------------- | ------- | -------------------------------------------------------------------------------------------------------- |
| adjustX | boolean \| number | false | adjust tooltip position in the X direction when it overflows |
| adjustY | boolean \| number | false | adjust tooltip position in the Y direction when it overflows |
| alwaysByViewport | boolean | false | when `true`, always adjusts position based on the viewport rather than the scrollable parent container |

```jsx
<Tooltip
placement="top"
align={{
overflow: { adjustX: true, adjustY: true, alwaysByViewport: true },
}}
overlay={<span>tooltip content</span>}
>
<button>hover me</button>
</Tooltip>
```

When `alwaysByViewport` is `true`, the tooltip will reposition itself to stay within the browser viewport. This is particularly useful when the trigger element is inside a scrollable container and you want the tooltip to always be visible on screen.

## Important Note

`Tooltip` requires a child node that accepts an `onMouseEnter`, `onMouseLeave`, `onFocus`, `onClick` event. This means the child node must be a built-in component like `div` or `span`, or a custom component that passes its props to its built-in component child.
Expand Down
Loading