site.svelte.ts

Declarations
#

3 declarations

view source

site_context
#

site.svelte.ts view source

{ get: (error_message?: string | undefined) => SiteState; get_maybe: () => SiteState | undefined; set: (value: SiteState) => SiteState; }

SiteState
#

site.svelte.ts view source

Light site-identity values for app chrome - the icon, glyph, and repo url used by components like Breadcrumb and DocsFooter. Set once per app at the root layout. Distinct from library_context, which carries the heavy module/declaration metadata that only docs and API pages need.

icon

type SvgData | null

glyph

type string | null

repo_url

type Url | null

constructor

type new (options?: SiteStateOptions): SiteState

options
default {}

SiteStateOptions
#

site.svelte.ts view source

SiteStateOptions

icon

The site's icon, e.g. a logo from logos.ts.

type SvgData | null

glyph

The site's glyph, a single unicode character identifying the project.

type string | null

repo_url

The site's source repository url, e.g. for DocsFooter links.

type Url | null

Depends on
#

Imported by
#