@gluonjs/atoms / packages/atoms/src / installUi

Function: installUi()

installUi(target?, options?): UiOwner

Installs the layer order, Core foundation, UI tokens, active theme, and one target-scoped style owner on a Document or ShadowRoot.

Parameters

target?

StyleTarget = document

options?

InstallUiOptions = {}

Returns

UiOwner

Example

Install one target-scoped UI owner, switch its typed theme, and dispose every retained stylesheet claim:

import {
  UiHydrationError,
  createUiStyleSelection,
  installUi,
  type InstallUiOptions,
  type UiHydrationMismatch,
  type UiOwner,
  type UiStyleSelection,
} from '@gluonjs/atoms';

const options = { theme: 'dark', hydrate: false } satisfies InstallUiOptions;
const selection: UiStyleSelection = createUiStyleSelection(options.theme);
const owner: UiOwner = installUi(document, options);
owner.setTheme('light');
console.log(selection.entries.map((entry) => entry.id), owner.theme, owner.themeSheet);
owner.dispose();

const mismatch: UiHydrationMismatch = 'missing';
const diagnostic = new UiHydrationError(mismatch, 'The server omitted the UI theme carrier.');
console.error(diagnostic.code, diagnostic.mismatch);