ui/build/collection-toolbar/collection-toolbar.types
ui/build/collection-toolbar/collection-toolbar.types
Interfaces
CollectionActionToolbarProps
Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:69
Type Parameters
| Type Parameter | Default type |
|---|---|
TCollections extends CollectionRegistry |
- |
TName extends CollectionToolbarName<TCollections> |
- |
TRow extends object |
CollectionRow<TCollections[TName]> |
Properties
about?
optional about?: CollectionToolbarAbout;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:80
actions?
optional actions?: Snippet<[CollectionToolbarComposition<NoInfer<TRow>>]>;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:94
Mutating actions, placed at the trailing edge.
client
client: CollectionDbClient<TCollections, TName>;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:70
collection
collection: TName;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:71
disabled?
optional disabled?: boolean;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:86
features?
optional features?: CollectionToolbarFeatures;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:87
filterPersistenceKey?
optional filterPersistenceKey?: string;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:91
View key a cleared seed is remembered against.
initialFilters?
optional initialFilters?: readonly CollectionInitialFilter[];Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:89
Conditions the view opens with, seeded into the builder as removable rows.
navigation?
optional navigation?: Snippet<[]>;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:85
The scope the surface is pinned to and can step through — a month, a period, a legal entity. Placed at the leading edge, before search, on every surface.
operations?
optional operations?: CollectionToolbarOperations<NoInfer<TRow>>;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:92
query
query: CollectionQueryState<TRow>;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:78
The query model the search box and the filter popover write to.
Owned by the surface rather than the toolbar, because the surface is what runs the query. The filter paths a surface may set are checked against the row type this state was created with.
title?
optional title?: string;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:79
CollectionToolbarAbout
Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:51
What the view applies on the operator's behalf, shown behind the toolbar's info button.
Properties
applied?
readonly optional applied?: readonly string[];Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:54
Conditions the view pins that the operator cannot see in the filter builder.
appliedContent?
readonly optional appliedContent?: Snippet<[]>;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:56
Schema-aware rendering for pinned conditions whose values are not plain text.
description?
readonly optional description?: string;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:52
CollectionToolbarActionProps
Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:8
Properties
icon?
optional icon?: string;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:11
Iconify name. With iconOnly, the label becomes the accessible name.
iconOnly?
optional iconOnly?: boolean;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:12
label
label: string;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:9
onRun
onRun: () => void | Effect<void, never, never>;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:26
Returns
void | Effect<void, never, never>
pending?
optional pending?: boolean;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:15
Shows a spinner and refuses re-entry while the action is in flight.
unavailable?
optional unavailable?: string;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:25
Why this action cannot be run right now, in the operator's words.
A refusal is a fact about the record, not about the button: "the month is published, so it
cannot take an import" is the same sentence whether the operator reads it from the toolbar or
from the pipeline panel. Given here it disables the control and states the reason where
both a pointer and a screen reader reach it — a title attribute does neither reliably, and
a bare disabled button leaves the operator guessing which precondition they missed.
variant?
optional variant?: CollectionToolbarActionVariant;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:13
CollectionToolbarComposition
Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:64
Type Parameters
| Type Parameter |
|---|
TRow extends object |
Properties
Action
Action: Component<CollectionToolbarActionProps>;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:65
query
query: CollectionQueryState<TRow>;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:67
The one search + filter + page model this toolbar drives.
CollectionToolbarFeatures
Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:58
Properties
filter?
readonly optional filter?: boolean;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:62
The schema-derived filter builder.
search?
readonly optional search?: boolean;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:60
Free-text search over the collection's text fields.
CollectionToolbarOperations
Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:34
Import, export and integrations, as the shared operations menu takes them.
fields is deliberately absent: the toolbar has the client and the collection name, so it reads
the field list from the same definition the filter builder does.
Type Parameters
| Type Parameter |
|---|
TRow extends object |
Properties
bulkPipelines?
readonly optional bulkPipelines?: readonly CollectionPipeline<TRow>[];Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:38
Changes to the selected records that are neither an import nor an export.
deletion?
readonly optional deletion?: any;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:40
disabled?
readonly optional disabled?: boolean;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:48
Refuses the menu on its own without taking search and filters down with it.
exportPipelines?
readonly optional exportPipelines?: readonly CollectionPipeline<TRow>[];Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:35
importPipelines?
readonly optional importPipelines?: readonly CollectionPipeline<TRow>[];Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:36
integrations?
readonly optional integrations?: readonly CollectionIntegrationStatus[];Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:39
selectedRows?
readonly optional selectedRows?: readonly TRow[];Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:41
selectionControls?
readonly optional selectionControls?: object;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:42
allSelected
readonly allSelected: boolean;totalRows
readonly totalRows: number;toggleAll()
toggleAll(): void;Returns
void
Type Aliases
CollectionToolbarActionVariant
type CollectionToolbarActionVariant = "default" | "outline" | "ghost" | "destructive";Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:7
CollectionToolbarName
type CollectionToolbarName<TCollections> = Extract<keyof TCollections, string>;Defined in: apps/website/.api-docs-entry/ui/build/collection-toolbar/collection-toolbar.types.d.ts:6
Type Parameters
| Type Parameter |
|---|
TCollections extends CollectionRegistry |