record-shell.svelte

Interfaces

RecordShellProps

Defined in: apps/website/.api-docs-entry/ui/build/record-shell/record-shell.svelte.d.ts:3

Properties

actions?

optional actions?: Snippet<[]>;

Defined in: apps/website/.api-docs-entry/ui/build/record-shell/record-shell.svelte.d.ts:35

The record's actions (for example a Process button). Inside the record sheet they sit in the sheet's header beside its controls, so every record's actions are in the same place; elsewhere they trail the shell's own heading.

badge?

optional badge?: string;

Defined in: apps/website/.api-docs-entry/ui/build/record-shell/record-shell.svelte.d.ts:27

Short state pill carrying the icon (for example the framework's read-only label). The caller passes the translated string; the shell only places it.

children?

optional children?: Snippet<[]>;

Defined in: apps/website/.api-docs-entry/ui/build/record-shell/record-shell.svelte.d.ts:48

Content when tabs is omitted (for example a create form or a message body).

class?

optional class?: string;

Defined in: apps/website/.api-docs-entry/ui/build/record-shell/record-shell.svelte.d.ts:46

Height contract from the caller, on the shell's own column. A record whose body owns its scrollport passes h-full so that body can take the height its host grants it; without one the column stays content-sized and the host's scrollport scrolls the whole record.

hint?

optional hint?: string;

Defined in: apps/website/.api-docs-entry/ui/build/record-shell/record-shell.svelte.d.ts:29

One sentence behind the pill, shown on hover: what the state means and what to do instead.

icon?

optional icon?: string;

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

Iconify icon inside the state pill (for example a lock on a read-only record). Inside the record sheet the pill trails the sheet's own record label; elsewhere it trails the shell's heading. Muted either way: the shell stays subordinate to the chrome.

kind?

optional kind?: string;

Defined in: apps/website/.api-docs-entry/ui/build/record-shell/record-shell.svelte.d.ts:16

What the record is, in the reader's words ("Employment contract"). Inside the record sheet it replaces the collection name in the chrome, so two representations of related collections read as the two different things they are.

subtitle?

optional subtitle?: string;

Defined in: apps/website/.api-docs-entry/ui/build/record-shell/record-shell.svelte.d.ts:10

One muted line under the heading (state, owner, summary).

tabs?

optional tabs?: TabConfig[];

Defined in: apps/website/.api-docs-entry/ui/build/record-shell/record-shell.svelte.d.ts:40

Tab strip rendered under the header. Records keep their tab configs; the shell owns placement, animation, and spacing so every record reads the same.

title?

optional title?: string;

Defined in: apps/website/.api-docs-entry/ui/build/record-shell/record-shell.svelte.d.ts:8

Record heading. Omit where the framework chrome already names the record — the record sheet's header carries the record label, and repeating it here reads as a second title.

Type Aliases

default

type default = ReturnType<typeof default>;

Defined in: apps/website/.api-docs-entry/ui/build/record-shell/record-shell.svelte.d.ts:50

Variables

default

const default: Component;

Defined in: apps/website/.api-docs-entry/ui/build/record-shell/record-shell.svelte.d.ts:50