@gluonjs/core / packages/atoms/src / InstallUiOptions

Interface: InstallUiOptions

Properties

hydrate?

readonly optional hydrate?: boolean

Validate and consume SSR carriers for this UI selection before returning.

---

tenant?

readonly optional tenant?: UiTenantOptions

Optional isolated tenant scope for multi-tenant applications.

---

theme?

readonly optional theme?: UiThemeName

Example

Select the initial typed UI theme and whether installation must validate server carriers first:

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);