@opentui/keymap/react

Every export of @opentui/keymap/react in the 0.6.0 release, from its type declarations. A version names the release that added an export after the module's first release.

Functions#

function KeymapProvider({ keymap, children }: KeymapProviderProps): FunctionComponentElement<ProviderProps<OpenTuiKeymap | null>>

React

function reactiveMatcherFromStore<T>(subscribe: (onStoreChange: () => void) => () => void, getSnapshot: () => T, predicate?: (value: T) => boolean): ReactiveMatcher

React

function useBindings<TRenderable extends Renderable = Renderable>(createLayer: () => UseBindingsLayer<TRenderable>, deps?: DependencyList): void

React

Interfaces#

interface KeymapProviderProps

React

• property KeymapProviderProps.children?: ReactNode
• property KeymapProviderProps.keymap: OpenTuiKeymap

interface UseBindingsLayer<TRenderable extends Renderable = Renderable> extends Omit<Layer<Renderable, KeyEvent>, "target" | "targetMode">

React

• property UseBindingsLayer.targetMode?: TargetMode
• property UseBindingsLayer.targetRef?: UseBindingsTargetRef<TRenderable>

interface UseBindingsTargetRef<TRenderable extends Renderable = Renderable>

React

• property UseBindingsTargetRef.current: TRenderable | null

Constants and variables#

const useActiveKeys: (options?: ActiveKeyOptions) => readonly ActiveKey[]

React

const useKeymap: () => OpenTuiKeymap

React

const usePendingSequence: () => readonly KeySequencePart[]

React