useFloating

Import

import { useFloating, floatingAvailableHeightVar, createFloatingAnchor } from '@feugene/granularity/composables/useFloating'

Exports

UseFloatingPlacementtype

type UseFloatingPlacement = Placement

floatingAvailableHeightVarconst

const floatingAvailableHeightVar = "--gr-floating-available-height"

GrFloatingAnchorRectinterface

interface GrFloatingAnchorRect

UseFloatingReferencetype

type UseFloatingReference = HTMLElement | VirtualElement | null

createFloatingAnchorfunction

function createFloatingAnchor(get: () => GrFloatingAnchorRect | null | undefined, options?:

UseFloatingOptionsinterface

interface UseFloatingOptions

UseFloatingReturninterface

interface UseFloatingReturn

useFloatingfunction

function useFloating(reference: Ref<HTMLElement | null> | (() => UseFloatingReference), floatingEl: Ref<HTMLElement | null>, open: Ref<boolean>, options?: UseFloatingOptions): UseFloatingReturn

Descriptions come from the library in Russian and are not shown here — translating them is a decision of its own, see ADR-0003.