collection-table

Classes

CollectionDetailPreferences

Defined in: packages/ui/build/collection-table/collection-detail-preferences.svelte.d.ts:1

Constructors

Constructor

new CollectionDetailPreferences(): CollectionDetailPreferences;

Returns

CollectionDetailPreferences

Methods

isFullScreen()

isFullScreen(collectionName): boolean;

Defined in: packages/ui/build/collection-table/collection-detail-preferences.svelte.d.ts:3

Parameters

Parameter	Type
`collectionName`	`string`

Returns

boolean

toggleFullScreen()

toggleFullScreen(collectionName): void;

Defined in: packages/ui/build/collection-table/collection-detail-preferences.svelte.d.ts:4

Parameters

Parameter	Type
`collectionName`	`string`

Returns

void

CollectionTableUrlNavigation

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:41

Implements

CollectionTableNavigation

Constructors

Constructor

new CollectionTableUrlNavigation(params): CollectionTableUrlNavigation;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:43

Parameters

Parameter	Type
`params`	{ `getUrl`: () => `URL`; `navigate`: (`href`) => `void`; `onRegistrationsChanged?`: () => `void`; }
`params.getUrl`	() => `URL`
`params.navigate`	(`href`) => `void`
`params.onRegistrationsChanged?`	() => `void`

Returns

CollectionTableUrlNavigation

Accessors

current

Get Signature

get current(): 
  | CollectionTableNavigationTarget
  | null;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:48

Returns

| CollectionTableNavigationTarget | null

Implementation of

CollectionTableNavigation.current

Methods

href()

href(target): string;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:56

Parameters

Parameter	Type
`target`	`CollectionTableNavigationTarget`

Returns

string

Implementation of

CollectionTableNavigation.href

open()

open(target): void;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:57

Parameters

Parameter	Type
`target`	`CollectionTableNavigationTarget`

Returns

void

Implementation of

CollectionTableNavigation.open

pop()

pop(): void;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:58

Returns

void

Implementation of

CollectionTableNavigation.pop

register()

register(registration): () => void;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:54

Parameters

Parameter	Type
`registration`	`CollectionTableDetailRegistration`

Returns

() => void

Implementation of

CollectionTableNavigation.register

resolveCurrentRegistration()

resolveCurrentRegistration(): 
  | CollectionTableDetailRegistration
  | undefined;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:55

Returns

| CollectionTableDetailRegistration | undefined

resolveRecordId()

resolveRecordId(params): string | undefined;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:49

Parameters

Parameter	Type
`params`	{ `collectionName`: `string`; `parentRouteKey?`: `string`; `routeKey`: `string`; }
`params.collectionName`	`string`
`params.parentRouteKey?`	`string`
`params.routeKey`	`string`

Returns

string | undefined

Implementation of

CollectionTableNavigation.resolveRecordId

Interfaces

CollectionTableActionPanel

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:61

Properties

content

content: Snippet<[CollectionTableActionPanelContext]>;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:64

description?

optional description?: string;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:63

title

title: string;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:62

CollectionTableActionPanelContext

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:57

Extended by

CollectionTablePageActionsContext

Methods

close()

close(): void;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:58

Returns

void

refresh()

refresh(): Promise<void>;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:59

Returns

Promise<void>

CollectionTableColumn

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:9

Type Parameters

Type Parameter
`TRow` extends `object`

Properties

card?

optional card?: CollectionTableCardRole;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:20

Which auto-card slot this column feeds (title/subtitle/badge) when no ListCard is given.

hideable?

optional hideable?: boolean;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:17

key

key: Extract<keyof TRow>;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:10

label?

optional label?: string;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:11

maxWidth?

optional maxWidth?: number;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:14

minWidth?

optional minWidth?: number;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:13

pinnable?

optional pinnable?: boolean;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:18

render?

optional render?: (context) => unknown;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:21

Parameters

Parameter	Type
`context`	{ `field`: `CollectionField`; `row`: `TRow`; `value`: `unknown`; }
`context.field`	`CollectionField`
`context.row`	`TRow`
`context.value`	`unknown`

Returns

unknown

resizable?

optional resizable?: boolean;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:16

sortable?

optional sortable?: boolean;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:15

width?

optional width?: number;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:12

CollectionTableColumnsComposition

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:34

Type Parameters

Type Parameter
`TRow` extends `object`

Properties

Column

Column: Component<CollectionTableColumnPrimitiveProps<TRow>>;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:35

CollectionTableDetailRegistration

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:12

Properties

parentRouteKey?

optional parentRouteKey?: string;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:14

renderDetail

renderDetail: Snippet<[CollectionTableDetailRenderContext]>;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:15

routeKey

routeKey: string;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:13

CollectionTableDetailRenderContext

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:8

Properties

actions?

optional actions?: Snippet<[]>;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:10

recordId

recordId: string;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:9

CollectionTableIntegrationStatus

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:96

Properties

description?

readonly optional description?: string;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:99

id

readonly id: string;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:97

label

readonly label: string;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:98

state

readonly state: CollectionTableIntegrationState;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:100

statusLabel?

readonly optional statusLabel?: string;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:101

CollectionTableNavigation

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:17

Properties

current

readonly current: 
  | CollectionTableNavigationTarget
  | null;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:18

Methods

href()

href(target): string;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:25

Parameters

Parameter	Type
`target`	`CollectionTableNavigationTarget`

Returns

string

open()

open(target): void;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:26

Parameters

Parameter	Type
`target`	`CollectionTableNavigationTarget`

Returns

void

pop()

pop(): void;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:27

Returns

void

register()

register(registration): () => void;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:24

Parameters

Parameter	Type
`registration`	`CollectionTableDetailRegistration`

Returns

() => void

resolveRecordId()

resolveRecordId(params): string | undefined;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:19

Parameters

Parameter	Type
`params`	{ `collectionName`: `string`; `parentRouteKey?`: `string`; `routeKey`: `string`; }
`params.collectionName`	`string`
`params.parentRouteKey?`	`string`
`params.routeKey`	`string`

Returns

string | undefined

CollectionTableNavigationTarget

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:2

Properties

collectionName

collectionName: string;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:3

parentRouteKey?

optional parentRouteKey?: string;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:6

recordId

recordId: string;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:4

routeKey

routeKey: string;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:5

CollectionTablePageActionsContext

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:66

Extends

CollectionTableActionPanelContext

Methods

close()

close(): void;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:58

Returns

void

Inherited from

CollectionTableActionPanelContext.close

openPanel()

openPanel(panel): void;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:67

Parameters

Parameter	Type
`panel`	`CollectionTableActionPanel`

Returns

void

refresh()

refresh(): Promise<void>;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:59

Returns

Promise<void>

Inherited from

CollectionTableActionPanelContext.refresh

CollectionTablePageDataSource

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:49

Type Parameters

Type Parameter
`TRow` extends `object`

Properties

supportsFilters?

readonly optional supportsFilters?: boolean;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:55

Enables the interactive filter builder when page implements its filter predicates.

Methods

findRecord()

findRecord(recordId): RemoteQuery<CollectionTablePageResult<TRow>>;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:53

Resolves deep links inside the same fixed domain scope as page.

Parameters

Parameter	Type
`recordId`	`string`

Returns

RemoteQuery<CollectionTablePageResult<TRow>>

page()

page(query): RemoteQuery<CollectionTablePageResult<TRow>>;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:51

Loads one server-filtered page and must honor the table's automatic search/filter query.

Parameters

Parameter	Type
`query`	`CollectionTablePageQuery`<`TRow`>

Returns

RemoteQuery<CollectionTablePageResult<TRow>>

CollectionTablePageQuery

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:37

Type Parameters

Type Parameter
`TRow` extends `object`

Properties

filters?

readonly optional filters?: readonly object[];

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:41

limit

readonly limit: number;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:42

offset

readonly offset: number;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:43

orderBy?

readonly optional orderBy?: Partial<Record<Extract<keyof TRow, string>, "asc" | "desc">>;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:38

search?

readonly optional search?: string;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:40

where?

readonly optional where?: Readonly<Record<string, unknown>>;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:39

CollectionTablePageResult

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:45

Type Parameters

Type Parameter
`TRow` extends `object`

Properties

rows

readonly rows: readonly TRow[];

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:46

total

readonly total: number;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:47

CollectionTablePipeline

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:84

Type Parameters

Type Parameter
`TRow` extends `object`

Properties

description?

readonly optional description?: string;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:87

getDisabledReason?

readonly optional getDisabledReason?: (selectedRows) => string | null;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:92

Returns user-facing copy when the current selection cannot run this pipeline.

Parameters

Parameter	Type
`selectedRows`	readonly `TRow`[]

Returns

string | null

icon?

readonly optional icon?: string;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:88

id

readonly id: string;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:85

label

readonly label: string;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:86

requiresSelection?

readonly optional requiresSelection?: boolean;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:90

Keeps the pipeline visible but muted until at least one row is selected.

Methods

run()

run(context): unknown;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:93

Parameters

Parameter	Type
`context`	`CollectionTablePipelineContext`<`TRow`>

Returns

unknown

CollectionTablePipelineContext

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:79

Type Parameters

Type Parameter
`TRow` extends `object`

Properties

collectionName

readonly collectionName: string;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:80

selectedRows

readonly selectedRows: readonly TRow[];

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:81

Methods

refresh()

refresh(): Promise<void>;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:82

Returns

Promise<void>

CollectionTableRowActionContext

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:30

Type Parameters

Type Parameter
`TRow` extends `object`

Properties

hovered

hovered: boolean;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:32

row

row: TRow;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:31

Type Aliases

CollectionDetailActions

type CollectionDetailActions = ReturnType<typeof CollectionDetailActions>;

Defined in: packages/ui/build/collection-table/collection-detail-actions.svelte.d.ts:6

CollectionName

type CollectionName<TCollections> = Extract<keyof TCollections, string>;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:4

Type Parameters

Type Parameter
`TCollections` extends `CollectionRegistry`

CollectionRecordDetailEmpty

type CollectionRecordDetailEmpty = ReturnType<typeof CollectionRecordDetailEmpty>;

Defined in: packages/ui/build/collection-table/collection-record-detail-empty.svelte.d.ts:6

CollectionRecordDetailTabs

type CollectionRecordDetailTabs = ReturnType<typeof CollectionRecordDetailTabs>;

Defined in: packages/ui/build/collection-table/collection-record-detail-tabs.svelte.d.ts:13

CollectionTable

type CollectionTable<TCollections, TName, TRow> = InstanceType<typeof CollectionTable>;

Defined in: packages/ui/build/collection-table/collection-table.svelte.d.ts:24

Type Parameters

Type Parameter	Default type
`TCollections` extends `CollectionRegistry`	`CollectionRegistry`
`TName` extends `CollectionName`<`TCollections`>	`CollectionName`<`TCollections`>
`TRow` extends `object`	`CollectionTableRow`<`TCollections`, `TName`>

CollectionTableColumnPrimitiveProps

type CollectionTableColumnPrimitiveProps<TRow> = Omit<CollectionTableColumn<TRow>, "key"> & object;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:27

Type Declaration

name

name: CollectionTableFieldName<TRow>;

Type Parameters

Type Parameter
`TRow` extends `object`

CollectionTableIntegrationState

type CollectionTableIntegrationState = "connected" | "configured" | "degraded" | "error" | "disabled";

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:95

CollectionTableNavigationSurface

type CollectionTableNavigationSurface = ReturnType<typeof CollectionTableNavigationSurface>;

Defined in: packages/ui/build/collection-table/collection-table-navigation-surface.svelte.d.ts:7

CollectionTableProps

type CollectionTableProps<TCollections, TName, TRow> = CollectionTableBaseProps<TCollections, TName, TRow> & 
  | CollectionTableCollectionSource<TCollections, TName, TRow>
| CollectionTableRemoteSource<TRow>;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:162

Type Parameters

Type Parameter	Default type
`TCollections` extends `CollectionRegistry`	`CollectionRegistry`
`TName` extends `CollectionName`<`TCollections`>	`CollectionName`<`TCollections`>
`TRow` extends `object`	`CollectionTableRow`<`TCollections`, `TName`>

CollectionTableRow

type CollectionTableRow<TCollections, TName> = CollectionRow<TCollections[TName]>;

Defined in: packages/ui/build/collection-table/collection-table.types.d.ts:5

Type Parameters

Type Parameter
`TCollections` extends `CollectionRegistry`
`TName` extends `CollectionName`<`TCollections`>

Variables

CollectionDetailActions

const CollectionDetailActions: Component;

Defined in: packages/ui/build/collection-table/collection-detail-actions.svelte.d.ts:6

CollectionRecordDetailEmpty

const CollectionRecordDetailEmpty: Component;

Defined in: packages/ui/build/collection-table/collection-record-detail-empty.svelte.d.ts:6

CollectionRecordDetailTabs

const CollectionRecordDetailTabs: Component;

Defined in: packages/ui/build/collection-table/collection-record-detail-tabs.svelte.d.ts:13

CollectionTable

const CollectionTable: $$IsomorphicComponent;

Defined in: packages/ui/build/collection-table/collection-table.svelte.d.ts:24

CollectionTableNavigationSurface

const CollectionTableNavigationSurface: Component;

Defined in: packages/ui/build/collection-table/collection-table-navigation-surface.svelte.d.ts:7

Functions

collectionTableRowMatchesFilters()

function collectionTableRowMatchesFilters(row, filters): boolean;

Defined in: packages/ui/build/collection-table/collection-table-row-query.d.ts:3

Parameters

Parameter	Type
`row`	`object`
`filters`	readonly `object`[] \| `undefined`

Returns

boolean

collectionTableRowMatchesSearch()

function collectionTableRowMatchesSearch(row, search): boolean;

Defined in: packages/ui/build/collection-table/collection-table-row-query.d.ts:2

Parameters

Parameter	Type
`row`	`object`
`search`	`string`

Returns

boolean

collectionTableRowMatchesWhere()

function collectionTableRowMatchesWhere(row, where): boolean;

Defined in: packages/ui/build/collection-table/collection-table-row-query.d.ts:4

Parameters

Parameter	Type
`row`	`object`
`where`	`Readonly`<`Record`<`string`, `unknown`>> \| `undefined`

Returns

boolean

createCollectionTableRouteKey()

function createCollectionTableRouteKey(params): string;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:36

Parameters

Parameter	Type
`params`	{ `collectionName`: `string`; `instanceId`: `string`; `persistenceKey?`: `string`; }
`params.collectionName`	`string`
`params.instanceId`	`string`
`params.persistenceKey?`	`string`

Returns

string

getCollectionTableNavigationContext()

function getCollectionTableNavigationContext(): 
  | CollectionTableNavigation
  | undefined;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:30

Returns

| CollectionTableNavigation | undefined

resolveCollectionTableRecordId()

function resolveCollectionTableRecordId(targets, params): string | undefined;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:31

Parameters

Parameter	Type
`targets`	\| `CollectionTableNavigationTarget` \| readonly `CollectionTableNavigationTarget`[] \| `null` \| `undefined`
`params`	{ `collectionName`: `string`; `parentRouteKey?`: `string`; `routeKey`: `string`; }
`params.collectionName`	`string`
`params.parentRouteKey?`	`string`
`params.routeKey`	`string`

Returns

string | undefined

setCollectionTableNavigationContext()

function setCollectionTableNavigationContext(navigation): CollectionTableNavigation;

Defined in: packages/ui/build/collection-table/collection-table-navigation.svelte.d.ts:29

Parameters

Parameter	Type
`navigation`	`CollectionTableNavigation`

Returns

CollectionTableNavigation