createFloatingUI(
propsConfig
?):object
Create a floating UI service.
The returned service includes the patch method to patch the states, the stores to track the states and directives to apply.
• propsConfig?: PropsConfig
<FloatingUIProps
>
the props config for the floating UI service
object
the floating UI service
directives:
object
arrowDirective:
Directive
<void
,SSRHTMLElement
>
Directive to be used on the arrow element, if any
floatingDirective:
Directive
<void
,SSRHTMLElement
>
Directive to be used on the floating element
referenceDirective:
Directive
<void
,SSRHTMLElement
>
Directive to be used on the reference element from where the floating element will be positioned
patch: <
U
>(storesValues
?) =>void
• U extends Partial
<FloatingUIProps
>
• storesValues?: void
| U
void
state$:
ReadableSignal
<FloatingUIState
>
stores:
object
middlewareData$:
ReadableSignal
<undefined
|MiddlewareData
>
placement$:
ReadableSignal
<undefined
|Placement
>
strategy$:
ReadableSignal
<undefined
|Strategy
>
x$:
ReadableSignal
<undefined
|number
>
y$:
ReadableSignal
<undefined
|number
>
FloatingUI:
ReturnType
<*typeof*createFloatingUI
>
arrowOptions:
Omit
<object
,"element"
> |Derivable
<Omit
<object
,"element"
>>
Options to use when calling the arrow middleware from Floating UI
autoUpdateOptions:
AutoUpdateOptions
Options to use when calling autoUpdate from Floating UI
computePositionOptions:
object
Options to use when calling computePosition from Floating UI
optional
middleware: (undefined
|null
|false
|object
)[]
Array of middleware objects to modify the positioning or provide data for rendering.
optional
placement:Placement
Where to place the floating element relative to the reference element.
optional
platform:Platform
Custom or extended platform object.
optional
strategy:Strategy
The strategy to use when positioning the floating element.
middlewareData:
undefined
|MiddlewareData
Object containing data returned from all middleware, keyed by their name
placement:
undefined
|Placement
The final chosen placement of the floating element
strategy:
undefined
|Strategy
The strategy used to position the floating element
x:
undefined
|number
The x coordinate of the floating ui
y:
undefined
|number
The y coordinate of the floating ui