@suluk/scalar - v0.8.0
    Preparing search index...

    Interface ScalarV4Options

    interface ScalarV4Options {
        pageTitle?: string;
        cdn?: string;
        facetBadges?: boolean;
        customCss?: string;
        configuration?: Record<string, unknown>;
        brand?: string;
        specUrl?: string;
        specParam?: string;
        views?: { label: string; value: string }[];
        insightsUrl?: string;
        insightsLabel?: string;
        nativeUrl?: string;
        nativeLabel?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    pageTitle? cdn? facetBadges? customCss? configuration? brand? specUrl? specParam? views? insightsUrl? insightsLabel? nativeUrl? nativeLabel?

    Properties

    pageTitle?: string

    Browser tab title.

    cdn?: string

    CDN URL for the Scalar standalone bundle (override for pinning/self-hosting).

    facetBadges?: boolean

    Surface v4 facets (cost + access) as Scalar badges on each operation (default true).

    customCss?: string

    Override the injected suluk theme CSS.

    configuration?: Record<string, unknown>

    Extra Scalar configuration merged into createApiReference (theme, layout, hideModels, …).

    brand?: string

    Brand shown in the suluk toolbar.

    specUrl?: string

    Endpoint returning the ENRICHED 3.1 spec (see enrichedSpec); the view selector appends ?<param>=<value> and re-mounts Scalar with the result — a real per-role v4 projection driving Scalar's UI.

    specParam?: string
    views?: { label: string; value: string }[]

    Role/view projections offered in the toolbar (e.g. Anonymous / Signed-in / Admin).

    insightsUrl?: string

    URL of the embeddable v4 SUPERPOWERS panels (e.g. @suluk/reference's referenceInsightsHtml) — opened as an in-page slide-in DRAWER (no second dashboard). The current "View as" role is passed via the same specParam.

    insightsLabel?: string
    nativeUrl?: string

    (legacy) link out to a separate renderer instead of the in-page drawer. Prefer insightsUrl.

    nativeLabel?: string

    Settings

    Member Visibility

    On This Page

    Properties