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

    Interface UseWhiteboardFileResult

    File operations hook return type

    interface UseWhiteboardFileResult {
        clearError: () => void;
        error: string | null;
        file: WhiteboardFile | null;
        fileMetadata: Record<string, unknown> | null;
        hasUnsavedChanges: boolean;
        isLoading: boolean;
        isSaving: boolean;
        loadFile: () => Promise<void>;
        markSaved: () => void;
        markUnsaved: () => void;
        renameFile: (newTitle: string) => Promise<void>;
        saveFile: () => Promise<void>;
    }
    Index

    Properties

    clearError error file fileMetadata hasUnsavedChanges isLoading isSaving loadFile markSaved markUnsaved renameFile saveFile

    Properties

    clearError: () => void

    Clear the current error

    error: string | null

    Error message from last operation

    file: WhiteboardFile | null

    Loaded file data

    fileMetadata: Record<string, unknown> | null

    File metadata

    hasUnsavedChanges: boolean

    Whether there are unsaved changes

    isLoading: boolean

    Whether loading is in progress

    isSaving: boolean

    Whether saving is in progress

    loadFile: () => Promise<void>

    Load file from server

    markSaved: () => void

    Mark changes as saved

    markUnsaved: () => void

    Mark that changes exist

    renameFile: (newTitle: string) => Promise<void>

    Rename the file's display name and internal name

    saveFile: () => Promise<void>

    Save file to server

    Settings

    Member Visibility

    On This Page

    Properties