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

    Interface WhiteboardRenderProps

    Whiteboard render props for custom rendering

    interface WhiteboardRenderProps {
        activeUsers: Record<string, ActiveUser>;
        auditEvents: WhiteboardAuditEntry[];
        canRedo: boolean;
        canUndo: boolean;
        canvas: Canvas | null;
        currentColor: string;
        currentTool: WhiteboardTool;
        currentWidth: number;
        hasUnsavedChanges: boolean;
        isLoading: boolean;
        isSaving: boolean;
        localPointer: LocalLaserPointer | null;
        ownerPresent: boolean;
        readOnly: boolean;
        remotePointers: Record<string, RemoteLaserPointer>;
        selectedObjects: WhiteboardObject[];
        zoomLevel: number;
    }
    Index

    Properties

    activeUsers: Record<string, ActiveUser>

    Active users

    auditEvents: WhiteboardAuditEntry[]

    Current audit log. Consumers can pass this directly to <WhiteboardAuditPanel events={renderProps.auditEvents} /> to render the change history in their own UI surface (drawer, modal, sidebar tab, etc.). Empty array when the log feature is unused or the loaded file has no prior entries.

    canRedo: boolean

    Whether redo is available

    canUndo: boolean

    Whether undo is available

    canvas: Canvas | null

    Canvas instance

    currentColor: string

    Current color

    currentTool: WhiteboardTool

    Current tool

    currentWidth: number

    Current stroke width

    hasUnsavedChanges: boolean

    Whether there are unsaved changes

    isLoading: boolean

    Whether loading

    isSaving: boolean

    Whether saving

    localPointer: LocalLaserPointer | null

    Local laser pointer

    ownerPresent: boolean

    Whether owner is present

    readOnly: boolean

    Whether read-only

    remotePointers: Record<string, RemoteLaserPointer>

    Remote laser pointers

    selectedObjects: WhiteboardObject[]

    Selected objects

    zoomLevel: number

    Current zoom level