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

Classes

CollectionUrlNavigation

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

Implements

• CollectionNavigation

Constructors

Constructor

new CollectionUrlNavigation(params): CollectionUrlNavigation;

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

Parameters

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

Returns

CollectionUrlNavigation

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-navigation/collection-navigation.svelte.d.ts:40

Returns

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

Implementation of

CollectionNavigation.current

targets

Get Signature

get targets(): object[];

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

Every frame of the URL stack, shallowest first.

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

Returns

object[]

Methods

detailClient()

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

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

Parameters

Parameter	Type
routeKey	string
collectionName?	string

Returns

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

Implementation of

CollectionNavigation.detailClient

href()

href(target): string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-navigation/collection-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

CollectionNavigation.href

open()

open(target): void;

Defined in: apps/website/.api-docs-entry/ui/build/collection-navigation/collection-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

CollectionNavigation.open

pop()

pop(): void;

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

Returns

void

Implementation of

CollectionNavigation.pop

popTo()

popTo(depth): void;

Defined in: apps/website/.api-docs-entry/ui/build/collection-navigation/collection-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-navigation/collection-navigation.svelte.d.ts:74

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

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>>>>

Returns

() => void

Implementation of

CollectionNavigation.registerCollectionClient

registerDetailClient()

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

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

Makes a collection surface's own client available to the sibling detail frame that it opens.

Most collection surfaces use the workspace client already published above navigation. 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 surface 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>>>>

Returns

() => void

Implementation of

CollectionNavigation.registerDetailClient

resolveRecordId()

resolveRecordId(params): string | undefined;

Defined in: apps/website/.api-docs-entry/ui/build/collection-navigation/collection-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

CollectionNavigation.resolveRecordId

Interfaces

CollectionNavigation

Defined in: apps/website/.api-docs-entry/ui/build/collection-navigation/collection-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-navigation/collection-navigation.svelte.d.ts:11

Methods

detailClient()

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

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

Parameters

Parameter	Type
routeKey	string
collectionName?	string

Returns

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

href()

href(target): string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-navigation/collection-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-navigation/collection-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-navigation/collection-navigation.svelte.d.ts:19

Returns

void

registerCollectionClient()

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

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

Parameters

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

Returns

() => void

registerDetailClient()

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

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

Parameters

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

Returns

() => void

resolveRecordId()

resolveRecordId(params): string | undefined;

Defined in: apps/website/.api-docs-entry/ui/build/collection-navigation/collection-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

CollectionNavigationTarget

type CollectionNavigationTarget = typeof collectionNavigationTargetSchema.Type;

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

Functions

createCollectionRouteKey()

function createCollectionRouteKey(params): string;

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

Parameters

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

Returns

string

---

getCollectionNavigationContext()

function getCollectionNavigationContext():
  | CollectionNavigation
  | undefined;

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

Returns

| CollectionNavigation | undefined

---

resolveCollectionRecordId()

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

Defined in: apps/website/.api-docs-entry/ui/build/collection-navigation/collection-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

---

setCollectionNavigationContext()

function setCollectionNavigationContext(navigation): CollectionNavigation;

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

Parameters

Parameter	Type
navigation	CollectionNavigation

Returns

CollectionNavigation