opsinjs

ViewParams

Everything a chrome-less preview URL can carry.

How this is generated

Source: lib/routes.ts. Script: scripts/build-reference.mts. Command: pnpm run generate.

Everything below is copied from the symbol, so a page is improved by improving its doc comment. The API index says why there is a page per symbol and what these pages still do not carry.

ViewParams

Everything a chrome-less preview URL can carry. Name and kind become path segments, and the rest become query parameters applied before first paint.

KindDeclared in
interfacelib/routes.ts
export interface ViewParams {
  name: string
  kind?: ViewKind
  base?: string
  style?: string
  mode?: "light" | "dark"
  density?: "comfortable" | "compact"
  text?: 100 | 125 | 150 | 200
  theme?: string
}

On this page