Interface TemplateContext

Full template context produced by routes/helpers/render.ts when rendering views. Extends AppLocals with request-scoped data like the current user, CSRF token, and asset lists.

interface TemplateContext {
    configScript?: string;
    csrfToken?: string;
    currentLanguage?: { langKey: LocaleCode; name: string };
    dal?: DataAccessLayer | DalContext;
    languageNames?: TemplateLanguageName[];
    locale?: LocaleCode;
    localeChange?: {
        new: LocaleCodeWithUndetermined;
        old: LocaleCodeWithUndetermined;
    };
    permissions?: Record<string, boolean>;
    qualifiedURL?: string;
    returnTo?: string;
    scripts?: string[];
    siteErrors?: string[];
    siteMessages?: string[];
    styles?: string[];
    titleKey?: string;
    urlPath?: string;
    user?: RequestUser;
    vite?: ViteDevServer;
    webHooks?: default;
    [key: string]: unknown;
}

Hierarchy (View Summary)

Indexable

  • [key: string]: unknown

Properties

configScript? csrfToken? currentLanguage? dal? languageNames? locale? localeChange? permissions? qualifiedURL? returnTo? scripts? siteErrors? siteMessages? styles? titleKey? urlPath? user? vite? webHooks?

Properties

OptionalconfigScript

configScript?: string

OptionalcsrfToken

csrfToken?: string

OptionalcurrentLanguage

currentLanguage?: { langKey: LocaleCode; name: string }

Optionaldal

dal?: DataAccessLayer | DalContext

OptionallanguageNames

languageNames?: TemplateLanguageName[]

Optionallocale

locale?: LocaleCode

OptionallocaleChange

localeChange?: {
    new: LocaleCodeWithUndetermined;
    old: LocaleCodeWithUndetermined;
}

Optionalpermissions

permissions?: Record<string, boolean>

OptionalqualifiedURL

qualifiedURL?: string

OptionalreturnTo

returnTo?: string

Optionalscripts

scripts?: string[]

OptionalsiteErrors

siteErrors?: string[]

OptionalsiteMessages

siteMessages?: string[]

Optionalstyles

styles?: string[]

OptionaltitleKey

titleKey?: string

OptionalurlPath

urlPath?: string

Optionaluser

user?: RequestUser

Optionalvite

vite?: ViteDevServer

OptionalwebHooks

webHooks?: default

Settings

Member Visibility

On This Page

Properties