@vowel.to/client / index / FloatingCursorRenderer
Function: FloatingCursorRenderer()
ts
function FloatingCursorRenderer(__namedParameters): Element | null;Defined in: lib/vowel/components/FloatingCursorRenderer.tsx:63
Floating Cursor Renderer
Renders the floating cursor based on context state. Safe to render multiple times - will only render if cursor is enabled and has state.
This component is automatically included in VowelAgent by default. You only need to use this directly if:
- You disabled cursor in VowelAgent (enableFloatingCursor={false})
- You want custom cursor placement
- You're not using VowelAgent at all
Parameters
| Parameter | Type |
|---|---|
__namedParameters | FloatingCursorRendererProps |
Returns
Element | null
Examples
tsx
<VowelProvider client={client}>
<VowelAgent />
</VowelProvider>tsx
<VowelProvider client={client}>
<VowelAgent enableFloatingCursor={false} />
<FloatingCursorRenderer />
</VowelProvider>tsx
<VowelProvider client={client}>
<MyCustomUI />
<FloatingCursorRenderer />
</VowelProvider>