NgDocThemeService

Service for managing themes.

The theme is the data-theme attribute of the document element: auto, dark, the id of a custom theme, or no attribute for the light theme.

DeclarationTypeScript

@Service()
export class NgDocThemeService { … }

Members

change$: Subject<string | null>

protectedreadonly

—

document: Document

protectedreadonly

—

documentElement: HTMLElement

protectedreadonly

—

store: NgDocStoreService

protectedreadonly

—

theme: Signal<string | null>

readonly

The current theme as a signal: the theme id, or null for the light theme.

It starts with the document's data-theme attribute and follows every set() call.

get currentTheme: string | null

Returns the current theme: the document's data-theme attribute, or null without one.

(…): void

Sets the theme by id.

Signature

set(id?: string | undefined): void;

Parameters

Name	Type	Description
id	`string \| undefined`	Theme id. If not provided, the theme will be removed.

Returns

void

(): Observable<string | null>

Emits the theme after every set() call. Read theme for the current value as a signal.

Signature

themeChanges(): Observable<string | null>;

Returns

Observable<string | null>