Skip to content

@vowel.to/client v0.1.2-393


@vowel.to/client / index / FloatingCursorProvider

Function: FloatingCursorProvider()

ts
function FloatingCursorProvider(__namedParameters): Element;

Defined in: lib/vowel/components/FloatingCursorProvider.tsx:77

Floating Cursor Provider (Internal)

Provides floating cursor state management for React applications. This is automatically wrapped by VowelProvider - users don't need to use this directly.

The actual cursor rendering happens in FloatingCursorRenderer, which can be:

  • Automatically included in VowelAgent (default)
  • Rendered separately for custom placement

Parameters

ParameterType
__namedParametersFloatingCursorProviderProps

Returns

Element

Example

tsx
<VowelProvider client={client} floatingCursor={{ enabled: true }}>
  <VowelAgent /> // Cursor automatically included
</VowelProvider>