string RootAttributes { get; }
Source
Gets serialized attributes placed on the theme root.
Theming
IAppSurfaceThemeDocumentProvider
SourceProvides the immutable Web document for the configured default AppSurface theme.
GetDocument
AppSurfaceThemeDocument GetDocument()
Source
Gets the current safe document snapshot.
Returns
A renderable document, or AppSurfaceThemeDocument.Empty when it is unsafe.
AppSurfaceThemeDocumentProvider
SourceBuilds and retains the immutable Web document from the neutral default-theme resolver.
AppSurfaceThemeDocument
SourceRepresents the deterministic HTML fragments required to apply one AppSurface theme resolution.
Remarks
The document contains no request-specific values. In particular, HeadContent never contains a CSP nonce; the live head TagHelper adds one only to its inline style element. Only the package serializer can create a renderable instance, so adapters cannot accidentally bypass the validated neutral-theme boundary.
RootAttributes
RootThemeId
string RootThemeId { get; }
Source
Gets the theme identifier for the root metadata.
RootThemeMode
string RootThemeMode { get; }
Source
Gets the rendered theme mode for the root metadata.
RootSchemaVersion
string RootSchemaVersion { get; }
Source
Gets the rendered payload schema version for the root metadata.
RootStyle
string RootStyle { get; }
Source
Gets the safe color-scheme declaration for the theme root.
HeadContent
string HeadContent { get; }
Source
Gets serialized head metadata and critical CSS without a nonce.
Empty
AppSurfaceThemeDocument Empty { get; }
Source
Gets an empty document used when a resolver cannot produce a safe renderable snapshot.
IsRenderable
bool IsRenderable { get; }
Source
Gets a value indicating whether the document contains renderable theme fragments.
AppSurfaceThemePreferenceOptions
SourceConfigures the browser-local System/Light/Dark preference enhancement for Web theme documents.
Remarks
The enhancement stores only an explicit Light or Dark selection in browser local storage for the current origin; selecting System removes that value and returns to the operating-system preference. It neither reads nor writes cookies, server-side preference state, or additional document URLs.
Snapshot
AppSurfaceThemePreferenceOptions Snapshot()
Source
Validates and copies this configuration for service registration.
Returns
A validated snapshot detached from the caller's mutable options instance.
Exceptions
ArgumentExceptionStorageKeyis blank, unsafe for an HTML data attribute, or longer than 64 characters.
StorageKey
string StorageKey { get; set; }
Source
Gets or sets the origin-scoped local-storage key used for explicit Light or Dark selection.
Remarks
The default is as_theme. Keys must contain 1 to 64 non-whitespace characters and cannot include quote or control characters because the value is emitted as an encoded HTML data attribute.
AppSurfaceThemeCspNonce
SourceProvides the documented request-item key for a host-generated AppSurface theme CSP nonce.
Get
string? Get(HttpContext httpContext)
Source
Gets the host-generated nonce from the current request, when one is available.
Parameters
httpContextCurrent request context.
Returns
The nonce supplied by the host, or null when the host does not use a nonce-based CSP.
AppSurfaceThemePreferenceDocumentProvider
SourceProvides a cached System-first document for browser-local theme preferences.
Remarks
The neutral resolver is evaluated exactly once during construction. The resulting document is cached for every request and is empty when the resolved pair cannot safely be serialized. This provider does not inspect HTTP state or browser storage; the deterministic bootstrap performs browser-local selection after rendering.
GetDocument
AppSurfaceThemeDocument GetDocument()
Source
Gets the cached document without re-resolving the configured theme pair.
Returns
The cached renderable document, or an empty document when the resolved pair was unsafe.
AppSurfaceThemePreferenceBootstrap
SourceRenders the deterministic browser bootstrap for local theme preferences.
Remarks
The bootstrap reads the configured origin-scoped local-storage key before the critical theme style renders, applies a System/Light/Dark selection to the document root, and synchronizes every rendered preference control. Storage access is best-effort: blocked or malformed browser storage falls back to the System mode without affecting server rendering, HTTP state, or the canonical document URL. Keep Script deterministic because CspHash is the public Content Security Policy source expression for its exact contents.
Render
string Render(string? nonce)
Source
Renders the bootstrap script with an optional encoded CSP nonce.
Parameters
nonceThe request-specific nonce, if the host uses nonce-based CSP.
Returns
A script element that supplies the configured storage key by data attribute.
StorageKey
string StorageKey { get; }
Source
Gets the encoded-data-attribute-safe key read and written by the browser bootstrap.
CspHash
string CspHash { get; }
Source
Gets the stable sha256- source expression for Script.
AppSurfaceThemePreferenceCsp
SourceProvides the stable CSP source hash for the opt-in theme-preference bootstrap.
Remarks
The hash covers only the deterministic inline script emitted by <appsurface-theme-head> after AppSurfaceWebThemingServiceCollectionExtensions.AddAppSurfaceWebThemePreferences(Microsoft.Extensions.DependencyInjection.IServiceCollection, Action{AppSurfaceThemePreferenceOptions}?). The configured storage key is supplied by an encoded data attribute, so it does not change this value. A dynamic host can instead supply its request nonce through the TagHelper. Static hosts remain responsible for separately hashing their generated critical styles.
ScriptHash
string ScriptHash { get; }
Source
Gets the sha256- source expression for the deterministic bootstrap script.
AppSurfaceThemeDocumentSerializer
SourceSerializes validated neutral theme resolutions into deterministic Web document fragments.
Serialize
AppSurfaceThemeDocument Serialize(AppSurfaceThemeResolution resolution)
Source
Creates a deterministic, nonce-free document for a neutral theme resolution.
Parameters
resolutionThe sealed neutral theme resolution.
Returns
A renderable document, or AppSurfaceThemeDocument.Empty when the snapshot is unsafe.
SerializePreference
AppSurfaceThemeDocument SerializePreference(AppSurfaceThemeResolution resolution)
Source
Creates the System-first document used by the browser-local preference enhancement.
Parameters
resolutionThe configured theme-pair resolution whose Light and Dark branches are emitted.
Returns
A document with System, Light, and Dark selectors, or AppSurfaceThemeDocument.Empty when the resolution is unsafe to render.
Remarks
This method deliberately replaces the configured startup mode with System while retaining the same Light and Dark pair. The browser bootstrap can then select an explicit branch without changing the URL or duplicating the HTML document. Safety validation is repeated before serialization so an invalid resolution fails closed instead of emitting partially trusted markup.
TrySerialize
bool TrySerialize(AppSurfaceThemeResolution? resolution, out AppSurfaceThemeDocument document)
Source
Attempts to create a deterministic document from a neutral theme resolution.
Parameters
resolutionThe sealed neutral theme resolution.documentThe renderable document when the snapshot is safe.
Returns
true when all values are safe to emit; otherwise false.
SerializeHeadContent
string SerializeHeadContent(AppSurfaceThemeDocument document, string? nonce = null)
Source
Adds an encoded nonce to the live inline style in a previously serialized head fragment.
Parameters
documentThe nonce-free document.nonceThe CSP nonce to apply to the inline style, if present.
Returns
Head content with the nonce applied only to the inline style element.