pdfrx_web
    Preparing search index...

    Interface CollaborativePdfViewerProps

    Configuration for the ready-made collaborative React viewer.

    interface CollaborativePdfViewerProps {
        actorId: string;
        className?: string;
        memberToken?: string;
        name?: string;
        onConnectionStateChange?: (state: CollaborationConnectionState) => void;
        onPresenceChange?: (connectedCount: number) => void;
        relayUrl: string;
        sessionId: string;
        src: PdfSource;
        srcDocumentId?: string;
        transport?: CollaborationTransport;
        wasmModulesUrl?: string;
    }
    Index
    actorId className? memberToken? name? onConnectionStateChange? onPresenceChange? relayUrl sessionId src srcDocumentId? transport? wasmModulesUrl?
    actorId: string

    Stable participant identifier attached to page and annotation operations.

    className?: string

    Additional class applied to the outer .collab-pane element.

    memberToken?: string

    Device-specific membership token issued when this participant was admitted.

    name?: string

    Accessible participant label shown in the built-in chrome.

    onConnectionStateChange?: (state: CollaborationConnectionState) => void

    Reports relay connection lifecycle changes.

    onPresenceChange?: (connectedCount: number) => void

    Reports the number of participants currently connected.

    relayUrl: string

    WebSocket endpoint of the collaboration relay.

    sessionId: string

    Shared session identifier.

    src: PdfSource

    Initial PDF opened before the authoritative session snapshot arrives.

    srcDocumentId?: string

    Document id represented by src. Defaults to main.

    transport?: CollaborationTransport

    Authentication and routing hooks for relay WebSocket and source requests.

    wasmModulesUrl?: string

    Directory containing the PDFium worker assets.

    Settings
    Member Visibility

    On This Page
    Properties