Interface SpotlightHandle<TItem>

Imperative handle returned by spotlight.

interface SpotlightHandle<TItem extends SpotlightItem = SpotlightItem> {
    isOpen: boolean;
    activateActive(): TItem | undefined;
    close(): boolean;
    focus(): void;
    query(): string;
    open(): boolean;
    results(): readonly TItem[];
    setQuery(query: string): string;
    toggle(): boolean;
    element: BoxElement;
    destroy(): void;
    setData(data: SpotlightData): void;
}

Type Parameters

TItem extends SpotlightItem = SpotlightItem

Hierarchy (View Summary)

BlessedComponentHandle<SpotlightData<TItem>, blessed.Widgets.BoxElement>
- SpotlightHandle

Index

Properties

Methods

activateActive close focus query open results setQuery toggle destroy setData

Properties

`Readonly`isOpen

isOpen: boolean

Current controlled or uncontrolled open state.

`Readonly`element

element: BoxElement

Underlying Blessed element available for standard element operations.

Methods

activateActive

activateActive(): TItem | undefined
Activates the focused result.

Returns TItem | undefined
- Defined in adapters/blessed/spotlight.ts:85

close

close(): boolean
Requests closing.

Returns boolean
- Defined in adapters/blessed/spotlight.ts:88

focus

focus(): void
Gives terminal focus to the search field when open.

Returns void
- Defined in adapters/blessed/spotlight.ts:91

query

query(): string
Returns the current controlled or uncontrolled query.

Returns string
- Defined in adapters/blessed/spotlight.ts:94

open

open(): boolean
Requests opening.

Returns boolean
- Defined in adapters/blessed/spotlight.ts:97

results

results(): readonly TItem[]
Returns current filtered results.

Returns readonly TItem[]
- Defined in adapters/blessed/spotlight.ts:100

setQuery

setQuery(query: string): string
Sets the query.
Parameters
- query: string
Returns string
- Defined in adapters/blessed/spotlight.ts:103

toggle

toggle(): boolean
Requests opposite open state.

Returns boolean
- Defined in adapters/blessed/spotlight.ts:106

destroy

destroy(): void
Destroys and detaches the owned element without destroying its parent.

Returns void
Inherited from BlessedComponentHandle.destroy
- Defined in adapters/blessed/types.ts:23

setData

setData(data: SpotlightData): void
Re-renders component content using complete replacement data.

The element identity is preserved. Call screen.render() explicitly when one or more updates should become visible.
Parameters
- data: SpotlightData
Returns void
Inherited from BlessedComponentHandle.setData
- Defined in adapters/blessed/types.ts:31