@opentui/keymap/addons/opentui

Every export of @opentui/keymap/addons/opentui 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 createTextareaBindings(overrides?: readonly Binding[], options?: EditBufferCommandOptions): Binding[]

Built-in addons

function registerAliasesField<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>): () => void

function registerBackspacePopsPendingSequence<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>, options?: BackspacePopsPendingSequenceOptions): () => void

function registerBaseLayoutFallback(keymap: Keymap<Renderable, KeyEvent>): () => void

Built-in addons

function registerBindingOverrides<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>): () => void

function registerCommaBindings<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>): () => void

function registerDeadBindingWarnings<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>): () => void

function registerDefaultBindingParser<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>): () => void

function registerDefaultEventMatchResolver<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>): () => void

function registerDefaultKeys<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>): () => void

function registerEditBufferCommands(keymap: Keymap<Renderable, KeyEvent>, renderer: CliRenderer, options?: EditBufferCommandOptions): () => void

Built-in addons

function registerEmacsBindings<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>): () => void

function registerEnabledFields<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>): () => void

function registerEscapeClearsPendingSequence<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>, options?: EscapeClearsPendingSequenceOptions): () => void

function registerExCommands<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>): () => void

function registerLeader<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>, options: LeaderOptions): () => void

function registerManagedTextareaLayer(keymap: Keymap<Renderable, KeyEvent>, renderer: CliRenderer, layer: ManagedTextareaLayer, options?: EditBufferCommandOptions): () => void

Built-in addons

function registerMetadataFields<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>): () => void

function registerModBindings<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>): () => void

function registerNeovimDisambiguation<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>, options?: NeovimDisambiguationOptions): () => void

function registerTextareaMappingSuspension(keymap: Keymap<Renderable, KeyEvent>, renderer: CliRenderer): () => void

Built-in addons

function registerTimedLeader<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>, options: TimedLeaderOptions): () => void

function registerUnresolvedCommandWarnings<TTarget extends object, TEvent extends KeymapEvent>(keymap: Keymap<TTarget, TEvent>): () => void

Interfaces#

interface BackspacePopsPendingSequenceOptions

• property BackspacePopsPendingSequenceOptions.preventDefault?: boolean
• property BackspacePopsPendingSequenceOptions.priority?: number

interface EditBufferCommandOptions

Built-in addons

• property EditBufferCommandOptions.category?: string
• property EditBufferCommandOptions.commandNames?: Partial<Record<EditBufferCommandName, string>>
• property EditBufferCommandOptions.descriptions?: Partial<Record<EditBufferCommandName, string>>
• property EditBufferCommandOptions.group?: string
• property EditBufferCommandOptions.includeFineGroup?: boolean

interface EscapeClearsPendingSequenceOptions

• property EscapeClearsPendingSequenceOptions.preventDefault?: boolean
• property EscapeClearsPendingSequenceOptions.priority?: number

interface ExCommandPayload

• property ExCommandPayload.args: readonly string[]
• property ExCommandPayload.payload?: unknown
• property ExCommandPayload.raw: string

interface LeaderOptions

• property LeaderOptions.name?: string
• property LeaderOptions.trigger: LeaderTrigger

interface NeovimDisambiguationOptions

• property NeovimDisambiguationOptions.timeoutMs?: number

interface TimedLeaderOptions extends LeaderOptions

• property TimedLeaderOptions.onArm?: () => void
• property TimedLeaderOptions.onDisarm?: () => void
• property TimedLeaderOptions.timeoutMs?: number

Types#

type Aliases = Record<string, string>

type EditBufferCommandName = (typeof editBufferActions)[number]

Built-in addons

type EditBufferFineGroup = "Cursor" | "Selection" | "Delete" | "History" | "Insert" | "Submit"

Built-in addons

type Enabled = boolean | (() => boolean) | ReactiveMatcher

type LeaderTrigger = KeyLike | Readonly<{ key: KeyLike; }> | readonly Readonly<{ key: KeyLike; }>[]

Constants and variables#

const defaultBindingParser: BindingParser

const defaultEventMatchResolver: EventMatchResolver<KeymapEvent>

Namespaces and re-exports#

index ExCommand[key: string]: unknowninterface ExCommand<TTarget extends object = object, TEvent extends KeymapEvent = KeymapEvent>

• property ExCommand.aliases?: string[]
• property ExCommand.name: string
• property ExCommand.nargs?: "0" | "1" | "?" | "*" | "+"
• property ExCommand.run: (ctx: CommandContext<TTarget, TEvent, ExCommandPayload>) => CommandResult<TTarget, TEvent>