Interface CourseReaderPageOptions

Options for creating a single archive page.

interface CourseReaderPageOptions {
    enhancement?: "svg" | "auto" | "css";
    overrides?: DeepPartial<ScanSettings>;
    preset?: string;
    registry?: PresetRegistry;
    seed?: string | number;
}

Properties

enhancement?: "svg" | "auto" | "css"

"auto" uses SVG filters where supported and otherwise falls back to CSS. "svg" requests SVG filters. "css" forces the basic HTML/CSS fallback.

Settings merged over the resolved preset.

preset?: string

Name of the preset to resolve. Defaults to "clean".

Custom preset registry. Defaults to the global presets.

seed?: string | number

Seed for deterministic noise, artifacts, jitter and the placement of exposure falloff, show-through pattern, noise tiles and edge shadows.