@wdprlib/runtime
    Preparing search index...

    Interface RuntimeOptions

    Configuration for initWdprRuntime().

    interface RuntimeOptions {
        fade?: boolean;
        onJoin?: () => Promise<void>;
        onPageAction?: (action: string) => void | Promise<void>;
        onRate?: (
            ref: RatingRef,
            action: RatingAction,
        ) => Promise<RatingState | null>;
        root?: HTMLElement;
    }
    Index

    Properties

    fade? onJoin? onPageAction? onRate? root?

    Properties

    fade?: boolean

    Whether collapsible blocks use a CSS fade animation when opening and closing. Defaults to true.

    onJoin?: () => Promise<void>

    Called when a user clicks the [[module Join]] button to request membership in the site.

    onPageAction?: (action: string) => void | Promise<void>

    Handle a standalone page-option button. The host owns permissions and UI.

    onRate?: (ref: RatingRef, action: RatingAction) => Promise<RatingState | null>

    Submit an action on the displayed page's Rate or CustomRate. The host must bind the page, revalidate registration, include-expanded declarations and permissions, and persist the action. Return updated viewer state, or null to withdraw the widget. Reject to show a retryable error. Neutral voting (value 0) and cancellation are distinct.

    root?: HTMLElement

    DOM element to scan for interactive Wikidot markup. Defaults to document.body when omitted.

    Settings

    Member Visibility

    On This Page

    Properties