ui/build/collection-table/collection-table-navigation.svelte

Classes

CollectionTableUrlNavigation

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:34

Implements

• CollectionTableNavigation

Constructors

Constructor

new CollectionTableUrlNavigation(params): CollectionTableUrlNavigation;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:36

Parameters

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

Returns

CollectionTableUrlNavigation

Accessors

current

Get Signature

get current():
  | {
  collectionName: string;
  parentRouteKey?: string;
  recordId: string;
  routeKey: string;
}
  | null;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:40

Returns

| { collectionName: string; parentRouteKey?: string; recordId: string; routeKey: string; } | null

Implementation of

CollectionTableNavigation.current

targets

Get Signature

get targets(): object[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:49

Every frame of the URL stack, shallowest first.

A detail registration only exists while the table that owns it is mounted, and a nested table is mounted by its parent frame's detail surface. Rendering only the deepest frame therefore unmounts the very table the deepest frame needs, so the surface renders the whole chain and keeps each ancestor alive.

Returns

object[]

Methods

detailClient()

detailClient(routeKey, collectionName?):
  | CollectionClient<Readonly<Record<string, CollectionType<CollectionRecord, CollectionRecord, CollectionRecord, CollectionRecord>>>>
  | undefined;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:75

Parameters

Parameter	Type
routeKey	string
collectionName?	string

Returns

| CollectionClient<Readonly<Record<string, CollectionType<CollectionRecord, CollectionRecord, CollectionRecord, CollectionRecord>>>> | undefined

Implementation of

CollectionTableNavigation.detailClient

href()

href(target): string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:55

Parameters

Parameter	Type
target	{ collectionName: string; parentRouteKey?: string; recordId: string; routeKey: string; }
target.collectionName	string
target.parentRouteKey?	string
target.recordId	string
target.routeKey	string

Returns

string

Implementation of

CollectionTableNavigation.href

open()

open(target): void;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:56

Parameters

Parameter	Type
target	{ collectionName: string; parentRouteKey?: string; recordId: string; routeKey: string; }
target.collectionName	string
target.parentRouteKey?	string
target.recordId	string
target.routeKey	string

Returns

void

Implementation of

CollectionTableNavigation.open

pop()

pop(): void;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:78

Returns

void

Implementation of

CollectionTableNavigation.pop

popTo()

popTo(depth): void;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:77

Close the frame at depth, keeping every shallower frame open.

Parameters

Parameter	Type
depth	number

Returns

void

registerCollectionClient()

registerCollectionClient(collectionName, client): () => void;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:74

Registers one explicitly named host projection independently of any mounted table.

This is deliberately collection-by-collection rather than registering every definition on a client: People may own its three host-only projections, but cannot accidentally capture an unrelated tenant collection with the same navigation surface.

Parameters

Parameter	Type
collectionName	string
client	() => CollectionClient<Readonly<Record<string, CollectionType<CollectionRecord, CollectionRecord, CollectionRecord, CollectionRecord>>>>

Returns

() => void

Implementation of

CollectionTableNavigation.registerCollectionClient

registerDetailClient()

registerDetailClient(routeKey, client): () => void;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:66

Makes a table's own client available to the sibling detail frame that its URL opens.

Most tables use the workspace client already published above the navigation surface. Host projections such as People are deliberately different: their rows live in a read-only local client and have no tenant collection to dispatch. The route key identifies the table that opened the frame, so the sheet can read through that exact capability without teaching the runtime about a host-only pseudo-collection.

Parameters

Parameter	Type
routeKey	string
client	CollectionClient<Readonly<Record<string, CollectionType<CollectionRecord, CollectionRecord, CollectionRecord, CollectionRecord>>>>

Returns

() => void

Implementation of

CollectionTableNavigation.registerDetailClient

resolveRecordId()

resolveRecordId(params): string | undefined;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:50

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

CollectionTableNavigation

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:10

Properties

current

readonly current:
  | {
  collectionName: string;
  parentRouteKey?: string;
  recordId: string;
  routeKey: string;
}
  | null;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:11

Methods

detailClient()

detailClient(routeKey, collectionName?):
  | CollectionClient<Readonly<Record<string, CollectionType<CollectionRecord, CollectionRecord, CollectionRecord, CollectionRecord>>>>
  | undefined;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:22

Parameters

Parameter	Type
routeKey	string
collectionName?	string

Returns

| CollectionClient<Readonly<Record<string, CollectionType<CollectionRecord, CollectionRecord, CollectionRecord, CollectionRecord>>>> | undefined

href()

href(target): string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:17

Parameters

Parameter	Type
target	{ collectionName: string; parentRouteKey?: string; recordId: string; routeKey: string; }
target.collectionName	string
target.parentRouteKey?	string
target.recordId	string
target.routeKey	string

Returns

string

open()

open(target): void;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:18

Parameters

Parameter	Type
target	{ collectionName: string; parentRouteKey?: string; recordId: string; routeKey: string; }
target.collectionName	string
target.parentRouteKey?	string
target.recordId	string
target.routeKey	string

Returns

void

pop()

pop(): void;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:19

Returns

void

registerCollectionClient()

registerCollectionClient(collectionName, client): () => void;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:21

Parameters

Parameter	Type
collectionName	string
client	() => CollectionClient<Readonly<Record<string, CollectionType<CollectionRecord, CollectionRecord, CollectionRecord, CollectionRecord>>>>

Returns

() => void

registerDetailClient()

registerDetailClient(routeKey, client): () => void;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:20

Parameters

Parameter	Type
routeKey	string
client	CollectionClient<Readonly<Record<string, CollectionType<CollectionRecord, CollectionRecord, CollectionRecord, CollectionRecord>>>>

Returns

() => void

resolveRecordId()

resolveRecordId(params): string | undefined;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:12

Parameters

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

Returns

string | undefined

Type Aliases

CollectionTableNavigationTarget

type CollectionTableNavigationTarget = typeof collectionTableNavigationTargetSchema.Type;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:9

Functions

createCollectionTableRouteKey()

function createCollectionTableRouteKey(params): string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:31

Parameters

Parameter	Type
params	{ view: string; }
params.view	string

Returns

string

---

getCollectionTableNavigationContext()

function getCollectionTableNavigationContext():
  | CollectionTableNavigation
  | undefined;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:25

Returns

| CollectionTableNavigation | undefined

---

resolveCollectionTableRecordId()

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

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:26

Parameters

Parameter	Type
targets	| { collectionName: string; parentRouteKey?: string; recordId: string; routeKey: string; } | readonly object[] | 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: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-navigation.svelte.d.ts:24

Parameters

Parameter	Type
navigation	CollectionTableNavigation

Returns

CollectionTableNavigation