kotlin-floating-ui-react-dom/floating.ui.react.dom/UseFloatingOptions

UseFloatingOptions

external interface UseFloatingOptions<R : ReferenceElement>(source)

Types

interface Elements<R : ReferenceElement>

WhileElementsMounted

typealias WhileElementsMounted<R> = (reference: R, floating: HTMLElement, update: () -> Unit) -> () -> Unit

Properties

abstract val elements: UseFloatingOptions.Elements<R>?

Object containing the reference and floating elements.

abstract val middleware: ReadonlyArray<Middleware?>?

Array of middleware objects to modify the positioning or provide data for rendering.

abstract val open: Boolean?

The open state of the floating element to synchronize with the isPositioned value.

abstract val placement: Placement?

Where to place the floating element relative to the reference element.

abstract val platform: Platform?

Object to interface with the current platform.

abstract val strategy: Strategy?

The strategy to use when positioning the floating element.

abstract val transform: Boolean?

Whether to use transform for positioning instead of top and left (layout) in the floatingStyles object.

whileElementsMounted

abstract val whileElementsMounted: UseFloatingOptions.WhileElementsMounted<R>?

A callback invoked when both the reference and floating elements are mounted, and cleaned up when either is unmounted. This is useful for setting up event listeners (e.g. pass autoUpdate).