Skip to content

@vowel.to/client v0.3.3-beta


@vowel.to/client / react / FloatingCursorContextType

Interface: FloatingCursorContextType

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

Floating cursor context state

Properties

PropertyTypeDescriptionDefined in
cursorState| FloatingCursorUpdate | nullCurrent cursor position and statelib/vowel/components/FloatingCursorProvider.tsx:20
isEnabledbooleanWhether cursor is enabledlib/vowel/components/FloatingCursorProvider.tsx:23
configFloatingCursorConfigCursor configurationlib/vowel/components/FloatingCursorProvider.tsx:26
updateCursor(update) => voidUpdate cursor position and textlib/vowel/components/FloatingCursorProvider.tsx:29
showResting(text?) => voidShow cursor in resting positionlib/vowel/components/FloatingCursorProvider.tsx:32
hide() => voidHide cursorlib/vowel/components/FloatingCursorProvider.tsx:35
enable() => voidEnable cursorlib/vowel/components/FloatingCursorProvider.tsx:38
disable() => voidDisable cursorlib/vowel/components/FloatingCursorProvider.tsx:41