Hiyve Components - v1.0.0
    Preparing search index...

    Interface UseCursorSyncOptions

    interface UseCursorSyncOptions {
        canvas: Canvas | null;
        enabled?: boolean;
        fileId: string;
        localUserId: string;
        publishEnabled?: boolean;
    }
    Index

    Properties

    canvas enabled? fileId localUserId publishEnabled?

    Properties

    canvas: Canvas | null
    enabled?: boolean

    When false, the hook is a no-op (no publishes, no subscribes).

    fileId: string
    localUserId: string
    publishEnabled?: boolean

    When false, the hook only listens — it doesn't publish the local pointer. Defaults to enabled. Use this to broadcast the local cursor only while a specific tool is active (e.g., laser pointer) while still rendering other peers' cursors all the time.

    Settings

    Member Visibility

    On This Page

    Properties