layout

Interfaces

PageShellProps

Defined in: packages/ui/build/layout/page-shell.svelte.d.ts:5

Properties

actions?

optional actions?: Snippet<[]>;

Defined in: packages/ui/build/layout/page-shell.svelte.d.ts:9

children

children: Snippet;

Defined in: packages/ui/build/layout/page-shell.svelte.d.ts:10

class?

optional class?: string;

Defined in: packages/ui/build/layout/page-shell.svelte.d.ts:14

contentBehavior?

optional contentBehavior?: "scroll" | "contain";

Defined in: packages/ui/build/layout/page-shell.svelte.d.ts:11

contentClass?

optional contentClass?: string;

Defined in: packages/ui/build/layout/page-shell.svelte.d.ts:16

density?

optional density?: PageShellDensity;

Defined in: packages/ui/build/layout/page-shell.svelte.d.ts:13

description?

optional description?: string;

Defined in: packages/ui/build/layout/page-shell.svelte.d.ts:8

eyebrow?

optional eyebrow?: string;

Defined in: packages/ui/build/layout/page-shell.svelte.d.ts:6

headerClass?

optional headerClass?: string;

Defined in: packages/ui/build/layout/page-shell.svelte.d.ts:15

title

title: string;

Defined in: packages/ui/build/layout/page-shell.svelte.d.ts:7

width?

optional width?: PageShellWidth;

Defined in: packages/ui/build/layout/page-shell.svelte.d.ts:12

ResponsiveSidebarLayoutProps

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:3

Properties

children

children: Snippet;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:5

class?

optional class?: string;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:18

collapsible?

optional collapsible?: "icon" | "none" | "offcanvas";

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:16

contentClass?

optional contentClass?: string;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:23

defaultExpanded?

optional defaultExpanded?: boolean;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:11

insetAs?

optional insetAs?: "main" | "div";

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:22

insetClass?

optional insetClass?: string;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:21

mobileActions?

optional mobileActions?: Snippet<[]>;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:8

mobileDescription?

optional mobileDescription?: string;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:7

mobileSidebarClass?

optional mobileSidebarClass?: string;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:20

mobileTitle

mobileTitle: string;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:6

mode?

optional mode?: ResponsiveSidebarLayoutMode;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:12

navigation: Snippet;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:4

navigationLabel?

optional navigationLabel?: string;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:9

persistenceKey?

optional persistenceKey?: string;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:10

side?

optional side?: "left" | "right";

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:17

sidebarClass?

optional sidebarClass?: string;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:19

sidebarWidth?

optional sidebarWidth?: string;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:14

sidebarWidthIcon?

optional sidebarWidthIcon?: string;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:15

topOffset?

optional topOffset?: string;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:13

Type Aliases

LayoutBehavior

type LayoutBehavior = "flow" | "scroll" | "contain";

Defined in: packages/ui/build/layout/layout.types.d.ts:8

One explicit scroll owner per bounded layout chain:

flow: natural height; an ancestor owns scrolling.
scroll: fill the remaining space and scroll this region.
contain: fill the remaining space while a child owns scrolling.

LayoutElement

type LayoutElement = "div" | "section" | "main" | "aside" | "header" | "footer";

Defined in: packages/ui/build/layout/layout.types.d.ts:1

PageShell

type PageShell = ReturnType<typeof PageShell>;

Defined in: packages/ui/build/layout/page-shell.svelte.d.ts:18

PageShellDensity

type PageShellDensity = "compact" | "comfortable";

Defined in: packages/ui/build/layout/page-shell.svelte.d.ts:4

PageShellWidth

type PageShellWidth = "full" | "wide" | "reading";

Defined in: packages/ui/build/layout/page-shell.svelte.d.ts:3

Region

type Region = ReturnType<typeof Region>;

Defined in: packages/ui/build/layout/region.svelte.d.ts:9

ResponsiveSidebarLayout

type ResponsiveSidebarLayout = ReturnType<typeof ResponsiveSidebarLayout>;

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:25

ResponsiveSidebarLayoutMode

type ResponsiveSidebarLayoutMode = "viewport" | "document";

Defined in: packages/ui/build/layout/responsive-sidebar-layout.svelte.d.ts:2

Variables

layoutBehaviorClasses

const layoutBehaviorClasses: Record<LayoutBehavior, string>;

Defined in: packages/ui/build/layout/layout.types.d.ts:9