Interface RenderSelectionSummaryOptions<TAction>

Options accepted by renderSelectionSummary.

interface RenderSelectionSummaryOptions<
    TAction extends SelectionSummaryAction = SelectionSummaryAction,
> {
    actions?: readonly TAction[];
    activeActionId?: string;
    characters?: ActionBarCharacters;
    detail?: string;
    noun?: string;
    selectedCount: number;
    totalCount?: number;
    width: number;
}

Type Parameters

TAction extends SelectionSummaryAction = SelectionSummaryAction

Index

Properties

actions? activeActionId? characters? detail? noun? selectedCount totalCount? width

Properties

`Optional`actions

actions?: readonly TAction[]

`Optional`activeActionId

activeActionId?: string

`Optional`characters

characters?: ActionBarCharacters

`Optional`detail

detail?: string

Optional context appended after the selection count.

`Optional`noun

noun?: string

Singular noun for a selected value.

Default Value

'item'

selectedCount

selectedCount: number

Number of selected items.

`Optional`totalCount

totalCount?: number

Total selectable items, when known.

width

width: number