Interface RenderKeymapHelpOptions<TCommand>

Options accepted by renderKeymapHelp.

interface RenderKeymapHelpOptions<
    TCommand extends KeymapHelpCommand = KeymapHelpCommand,
> {
    characters?: KeymapHelpCharacters;
    commands: readonly TCommand[];
    height?: number;
    query?: string;
    scope?: string;
    width?: number;
}

Type Parameters

TCommand extends KeymapHelpCommand = KeymapHelpCommand

Index

Properties

characters? commands height? query? scope? width?

Properties

`Optional`characters

characters?: KeymapHelpCharacters

commands

commands: readonly TCommand[]

`Optional`height

height?: number

`Optional`query

query?: string

`Optional`scope

scope?: string

`Optional`width

width?: number