Interface SpotlightOptions<TItem>

Options accepted by spotlight.

interface SpotlightOptions<TItem extends SpotlightItem = SpotlightItem> {
    box?: BoxElementOptions;
    content?: BoxElementOptions;
    input?: BoxElementOptions;
    data: SpotlightData<TItem>;
    results?: BoxElementOptions;
    parent: Node;
}

Type Parameters

TItem extends SpotlightItem = SpotlightItem

Index

Properties

box? content? input? data results? parent

Properties

`Optional`box

box?: BoxElementOptions

Full-screen layer position, style, and standard Blessed settings.

`Optional`content

content?: BoxElementOptions

Panel layout overrides.

`Optional`input

input?: BoxElementOptions

Search input layout overrides.

data

data: SpotlightData<TItem>

Text, state, actions, and semantic theme configuration.

`Optional`results

results?: BoxElementOptions

Results menu layout overrides.

parent

parent: Node

Blessed screen or node receiving the Spotlight layer.