Skip to main content

Floating

Floating is a positioning primitive for custom overlays anchored to a trigger, another element, or a point in the viewport.

Import

import { Floating } from '@vortexlabs/vortex';
import type { FloatingProps } from '@vortexlabs/vortex';

Allied components

Other links

Floating

Floating props
PropTypeDefaultAttributes
id
string
No default value
triggerType
union
click
role
union
No default value
groupTimeouts
boolean
No default value
position
union
bottom-center
fallbackPositions
union
No default value
fallbackAdjustLayout
boolean
No default value
fallbackMinHeight
string
No default value
trapFocusMode
union
dialog
disabled
boolean
No default value
hideAnimationDisabled
boolean
No default value
contentHoverDisabled
boolean
No default value
closeOnOutsideClickDisabled
boolean
No default value
autoFocus
boolean
true
originCoordinates
object
No default value
children
React.ReactNode
No default value
onOpen
callback
No default value
onClose
callback
No default value
width
string
No default value
contentGap
number
2
contentShift
number
No default value
contentMaxHeight
union
No default value
contentMaxWidth
union
No default value
contentClassName
string
No default value
contentAttributes
object
No default value
instanceRef
ref
No default value
containerRef
ref
No default value
positionRef
ref
No default value
initialFocusRef
ref
No default value
active
boolean
No default value
defaultActive
boolean
false

Floating.Trigger

Floating.Trigger props
PropTypeDefaultAttributes
children
indexed
No default value

Floating.Content

Floating.Content props
PropTypeDefaultAttributes
children
React.ReactNode
No default value
className
union
No default value
attributes
object
No default value

Floating Instance

Floating instance methods
PropTypeDefaultAttributes
open
callback
No default value
close
callback
No default value
updatePosition
callback
No default value