createFloatingUI(
propsConfig?):FloatingUI
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
the floating UI service
FloatingUI:
Widget<FloatingUIProps,FloatingUIState,object,FloatingUIDirectives>
Represents the type returned by the createFloatingUI function.
This type is used to define the structure and behavior of the Floating UI component.
arrowDirective:
Directive<void,SSRHTMLElement>
Directive to attach to the arrow element
floatingDirective:
Directive<void,SSRHTMLElement>
Directive to attach to the floating element
referenceDirective:
Directive<void,SSRHTMLElement>
Directive to attach to the reference element
Interface representing the properties for configuring Floating UI.
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
Represents the state of a floating UI 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