Interface DeckColumnSearch<T>

Makes a field a picker: the member searches the way they would in the forum's search, and has to choose a real result, whose params are stored.

interface DeckColumnSearch<T extends Model = any> {
    browse?: boolean;
    display?(result: T): Children;
    label(result: T): string;
    params(result: T): Record<string, string | number>;
    source(): GlobalSearchSource;
}

Type Parameters

T extends Model = any

Index

Properties

Methods

display? label params source

Properties

`Optional`browse

browse?: boolean

List every result before anything is typed, for short lists such as tags.

Methods

`Optional`display

display?(result: T): Children
The chosen result as the field shows it; defaults to label.
Parameters
- result: T
Returns Children
- Defined in extensions/deck/js/dist-typings/forum/columns/DeckColumnType.d.ts:57

label

label(result: T): string
Parameters
- result: T
Returns string
- Defined in extensions/deck/js/dist-typings/forum/columns/DeckColumnType.d.ts:58

params

params(result: T): Record<string, string | number>
Merged into the column's params when chosen.
Parameters
- result: T
Returns Record<string, string | number>
- Defined in extensions/deck/js/dist-typings/forum/columns/DeckColumnType.d.ts:60

source

source(): GlobalSearchSource
Lists results as the forum's search does, e.g. core's GlobalUsersSearchSource. Each result's data-id is looked up in the store under the source's resource.

Returns GlobalSearchSource
- Defined in extensions/deck/js/dist-typings/forum/columns/DeckColumnType.d.ts:53