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

    Interface FileEditorOverlayProps

    Props for FileEditorOverlay.

    interface FileEditorOverlayProps {
        connectedRoom?: string | null;
        editors?: FileEditorMap;
        ensureRoom?: (roomName: string) => void;
        file: FileEntry;
        isNewFile?: boolean;
        isReady?: boolean;
        onClose: () => void;
        onError?: (error: Error) => void;
        onGetFileUrl?: (file: FileEntry) => Promise<string | null>;
    }
    Index

    Properties

    connectedRoom? editors? ensureRoom? file isNewFile? isReady? onClose onError? onGetFileUrl?

    Properties

    connectedRoom?: string | null

    The currently connected room name. When omitted, assumes the file's room is active.

    editors?: FileEditorMap

    Editor components keyed by resource type. Pass only the editors your app uses.

    ensureRoom?: (roomName: string) => void

    Switch file-ops target to a different room. When omitted, room switching is a no-op.

    file: FileEntry

    The file to edit.

    isNewFile?: boolean

    When true, the file was just created and has no content on the server yet. Editors will initialize with empty content instead of fetching from the server.

    isReady?: boolean

    Whether the room connection is ready for file operations. When omitted, defaults to true.

    onClose: () => void

    Called when the user closes the overlay.

    onError?: (error: Error) => void

    Called on errors (file load, save, connection).

    onGetFileUrl?: (file: FileEntry) => Promise<string | null>

    Resolve a presigned URL for the file (used to pre-fetch note/assignment/clip content).

    Settings

    Member Visibility

    On This Page

    Properties