Skip to content

Commit 3876c2c

Browse files
committed
Add documentation for clamping to README
1 parent fcc7bb1 commit 3876c2c

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,3 +211,11 @@ Target alignment refers to the alignment of the pivot relative to the target of
211211
### Root Alignment
212212

213213
Root alignment refers to the alignment of the tooltip's root relative to the pivot. See `rootAlign` and `rootAlignOffset`.
214+
215+
## Clamping
216+
217+
By default the tooltip is "clamped" to its parent. Meaning even if the target leaves the viewport, the tooltip would never leave the viewport. The clamping behaviour can be controlled via the `clamp` property.
218+
219+
When `clamp` is `true`, the flyout will always remains in the parent even if the target is out of the parent.
220+
221+
When `clamp` is `false`, the flyout will always attatch itself to the target, even if it’s outside the parent, but it will make a best effort to be in the parent.

0 commit comments

Comments
 (0)