Interface RenderFilterBarOptions

Options accepted by renderFilterBar.

interface RenderFilterBarOptions {
    activeTarget?: FilterBarTarget;
    characters?: FilterBarCharacters;
    filters?: readonly FilterBarFilter[];
    resultCount?: number;
    query?: string;
    pad?: boolean;
    showReset?: boolean;
    width: number;
}

Index

Properties

activeTarget? characters? filters? resultCount? query? pad? showReset? width

Properties

`Optional`activeTarget

activeTarget?: FilterBarTarget

`Optional`characters

characters?: FilterBarCharacters

`Optional`filters

filters?: readonly FilterBarFilter[]

Ordered active filters.

`Optional`resultCount

resultCount?: number

Optional compact result metadata.

`Optional`query

query?: string

Current query text.

`Optional`pad

pad?: boolean

Whether output is padded to width.

`Optional`showReset

showReset?: boolean

Whether the reset control is shown.

width

width: number

Available terminal-cell width.