@opentui/keymap/solid

Every export of @opentui/keymap/solid in the main-branch source, from its type declarations. A version names the release that added an export after the module's first release.

Functions#

function KeymapProvider(props: KeymapProviderProps): JSX.Element

Solid

function reactiveMatcherFromSignal<T>(accessor: Accessor<T>, predicate?: (value: T) => boolean): ReactiveMatcher

Solid

function useBindings<TRenderable extends Renderable = Renderable>(createLayer: () => UseBindingsLayer<TRenderable>): void

Solid

Interfaces#

interface KeymapProviderProps

Solid

• property KeymapProviderProps.children: JSX.Element
• property KeymapProviderProps.keymap: OpenTuiKeymap

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

Solid

• property UseBindingsLayer.target?: UseBindingsTarget<TRenderable>
• property UseBindingsLayer.targetMode?: TargetMode

Types#

type UseBindingsTarget<TRenderable extends Renderable = Renderable> = () => TRenderable | null | undefined

Solid

Constants and variables#

const useKeymap: () => OpenTuiKeymap

Solid

const useKeymapSelector: <T>(selector: (keymap: OpenTuiKeymap) => T) => Accessor<T>

Solid