_ pop Owner
_popOwner : ( owner : unknown ) => void
_ push Owner
_pushOwner : ( owner : unknown ) => void
abort Composition
abortComposition : () => void
activate Focus Group
activateFocusGroup : ( focusId : string , groupOrOptions ?: string | FocusSetOptions , ) => boolean
add Condition
addCondition : ( id : string , defaultVal : boolean ) => boolean
add Mapping
addMapping : ( base : string [] , target : string [] , options ?: Omit < MappingKeyEntry < ComponentType < any > > , "keys" | "target" > , ) => boolean
add Mode
addMode : ( mode : string ) => boolean
buffered Composition Count
bufferedCompositionCount : () => number
clear All Composition Keys
clearAllCompositionKeys : () => void
clear Composition Buffers
clearCompositionBuffers : () => void
clear Sequence Operations
clearSequenceOperations : () => void
clear Shortcut Operations
clearShortcutOperations : () => void
current Screen Has Sequence Waiting
currentScreenHasSequenceWaiting : ( sync ?: () => void ) => boolean
enable Wildcard Priority
enableWildcardPriority : () => () => void
focus Current
focusCurrent : ( groupOrOptions ?: string | FocusSetOptions , ) => { noFound ?: boolean ; noLayer ?: boolean ; noOwner ?: boolean ; result ?: { fromGroup : string | typeof defaultTargetsSymbol ; id : string } ; }
focus Set
focusSet : ( focusId : string , groupOrOptions ?: string | FocusSetOptions ) => void
focus Unregister
focusUnregister : ( focusId : string , groupOrOptions ?: string | FocusSetOptions , ) => void
get Composition Context
getCompositionContext : () => CompositionContext
get Current Mode
getCurrentMode : () => string | null
get Global Pending Sequence
getGlobalPendingSequence : () => GlobalPendingSequence | null
get Global Sequences
getGlobalSequences : () => ResolvedGlobalSequenceEntry []
get Hovered Mouse Region
getHoveredMouseRegion : () => { layerId : string ; regionId : string } | null
get Last Composition Event
getLastCompositionEvent : () => CompositionEvent | null
global Keys
globalKeys : ( entries : GlobalKeyEntry [] , options ?: { mode ?: "replace" | "add" } , ) => void
global Sequence
globalSequence : ( entries : GlobalSequenceEntry [] , options ?: { mode ?: "replace" | "add" } , ) => void
has Action
hasAction : ( actionId : string ) => boolean
has Pending Composition
hasPendingComposition : () => boolean
has Sequence Action
hasSequenceAction : ( sequenceActionId : string ) => boolean
modify Action
modifyAction : ( actionId : string , keys : string [] ) => void
modify Sequence Action
modifySequenceAction : ( sequenceActionId : string , keys : string [] , timeout ?: number , ) => void
next Mode
nextMode : () => void
prev Mode
prevMode : () => void
read Layer
readLayer : ( owner : unknown , ) => PageKeyboardLayer | ElementKeyboard | LayerKeyboardLayer | undefined
register Mouse Region
registerMouseRegion : ( entry : MouseRegionEntry ) => () => void
registry Composition Key
registryCompositionKey : ( entry : CompositioKey < ComponentType < any > > ) => void
remove Action
removeAction : ( actionId : string ) => void
remove Composition Key
removeCompositionKey : ( key : string ) => boolean
remove Condition
removeCondition : ( target : string ) => boolean
remove Mapping
removeMapping : ( firstKey : string ) => boolean
remove Mapping Key
removeMappingKey : ( keys : string [] ) => boolean
remove Mode
removeMode : ( mode : string ) => boolean
remove Processor
removeProcessor : ( processorId : string ) => boolean
remove Sequence Action
removeSequenceAction : ( sequenceActionId : string ) => void
reset Processors
resetProcessors : () => void
set Condition
setCondition : ( target : string , value : boolean ) => boolean
set Mode
setMode : ( mode : string | null ) => boolean
set Value Schema
setValueSchema : ( schema : ValueSchema ) => void
stop
stop : ( keys : string [] , options ?: StopOptions ) => () => void
subscribe Composition
subscribeComposition : ( fn : () => void ) => () => void
subscribe Focus
subscribeFocus : ( listener : () => void ) => () => void
subscribe Mapping
subscribeMapping : ( fn : () => void ) => () => void
there Global Queue Waiting
thereGlobalQueueWaiting : ( sync ?: () => void ) => boolean
undo Composition
undoComposition : ( steps ?: number , options ?: { byKey ?: boolean ; isolated ?: boolean } , ) => CompositionContext < unknown > | null
unregister Mouse Region
unregisterMouseRegion : ( layerId : string , regionId : string ) => void
update Composition Key
updateCompositionKey : ( key : string , flags : Flags , updates : Partial < Omit < CompositioKey < ComponentType < any > > , "key" | "flags" > > , ) => boolean
Value exposed by the keyboard system via React context.
Exposes the KeyboardEngine API bound to the engine instance. Layer and element scoping of bindings is handled automatically by useKeyboard; consume the context directly only when necessary.