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

    Interface FileListViewProps

    Shared props interface for FileTableView and FileCardView. Both views receive the same data and handlers from FileManager.

    interface FileListViewProps {
        areAllFilesSelected: (files: FileEntry[]) => boolean;
        areSomeFilesSelected: (files: FileEntry[]) => boolean;
        clientThumbnails?: {
            generators: ThumbnailGenerator[];
            getFileUrl: (file: FileEntry) => Promise<string>;
            maxDimension?: number;
        };
        colors: FileManagerColors;
        displayColumns: FileListColumn[];
        dragHoverFolderPath: string
        | null;
        enableDragDrop: boolean;
        enableMultiSelect: boolean;
        files: FileEntry[];
        folders: FolderEntry[];
        formatField?: (
            file: FileEntry,
            column: FileListColumn,
        ) => string | undefined;
        getCommentCount?: (file: FileEntry) => number;
        getDisplayName: (file: FileEntry) => string;
        getThumbnailUrl?: (file: FileEntry) => string | undefined;
        handleContextMenu: (
            event: MouseEvent,
            item: FileEntry | FolderEntry,
        ) => void;
        handleDragEnterFolder: (path: string) => (event: DragEvent) => void;
        handleDragLeaveFolder: (event: DragEvent) => void;
        handleDragOver: (event: DragEvent) => void;
        handleDragStart: (file: FileEntry) => (event: DragEvent) => void;
        handleDropOnFolder: (path: string) => (event: DragEvent) => void;
        handleFileDoubleClick: (file: FileEntry) => void;
        handleFolderDoubleClick: (folder: FolderEntry) => void;
        handleMoreClick: (
            event: MouseEvent<HTMLButtonElement>,
            item: FileEntry | FolderEntry,
        ) => void;
        handleSelectAll: (files: FileEntry[], checked: boolean) => void;
        handleSelectItem: (item: FileEntry | FolderEntry) => void;
        handleSortClick: (column: FileListColumn) => void;
        handleToggleSelect: (file: FileEntry, checked: boolean) => void;
        icons: FileManagerIcons;
        isFileSelected: (file: FileEntry) => boolean;
        isFileShared?: (file: FileEntry) => boolean;
        isFlatView: boolean;
        labels: FileManagerLabels;
        onCommentClick?: (file: FileEntry) => void;
        onShareFile?: (file: FileEntry) => void;
        renderCellContent: (file: FileEntry, column: FileListColumn) => ReactNode;
        renderColumnHeader: (column: FileListColumn) => ReactNode;
        rowExtras?: Record<string, (file: FileEntry) => ReactNode>;
        selectedFiles: FileEntry[];
        selectedItem: FileEntry | FolderEntry | null;
        sortColumn: FileListColumn | null;
        sortDirection: SortDirection;
        styles: FileManagerStyles;
        userId: string;
    }
    Index

    Properties

    areAllFilesSelected areSomeFilesSelected clientThumbnails? colors displayColumns dragHoverFolderPath enableDragDrop enableMultiSelect files folders formatField? getCommentCount? getDisplayName getThumbnailUrl? handleContextMenu handleDragEnterFolder handleDragLeaveFolder handleDragOver handleDragStart handleDropOnFolder handleFileDoubleClick handleFolderDoubleClick handleMoreClick handleSelectAll handleSelectItem handleSortClick handleToggleSelect icons isFileSelected isFileShared? isFlatView labels onCommentClick? onShareFile? renderCellContent renderColumnHeader rowExtras? selectedFiles selectedItem sortColumn sortDirection styles userId

    Properties

    areAllFilesSelected: (files: FileEntry[]) => boolean

    Check if all files are selected

    areSomeFilesSelected: (files: FileEntry[]) => boolean

    Check if some (but not all) files are selected

    clientThumbnails?: {
        generators: ThumbnailGenerator[];
        getFileUrl: (file: FileEntry) => Promise<string>;
        maxDimension?: number;
    }

    Client-side thumbnail generation + caching configuration. When present, card-view tiles generate thumbnails on demand (viewport-gated, serialized) and cache them in IndexedDB for later visits.

    Type Declaration

    • generators: ThumbnailGenerator[]

      Generators tried in order. Consumer-supplied generators should be listed first; the SDK's defaults (image/video/text-preview/placeholder) cover the fallback cases.

    • getFileUrl: (file: FileEntry) => Promise<string>

      Resolve a fetch-able URL (e.g. presigned S3 URL) for the file content.

    • OptionalmaxDimension?: number

      Longest edge of the generated thumbnail, in pixels. Defaults to 320.

    colors: FileManagerColors

    Merged colors

    displayColumns: FileListColumn[]

    Columns to display (table view)

    dragHoverFolderPath: string | null

    Folder currently hovered during drag

    enableDragDrop: boolean

    Whether drag-and-drop is enabled

    enableMultiSelect: boolean

    Whether multi-select is enabled

    files: FileEntry[]

    Files to display

    folders: FolderEntry[]

    Folders to display

    formatField?: (file: FileEntry, column: FileListColumn) => string | undefined

    Format a field value for display (from fieldFormatters prop)

    getCommentCount?: (file: FileEntry) => number

    Check if a file has comments (returns the count)

    getDisplayName: (file: FileEntry) => string

    Get display name for a file

    getThumbnailUrl?: (file: FileEntry) => string | undefined

    Resolve a thumbnail/preview image URL for a file. When provided and returning a URL, card-view tiles render it as a banner at the top of the card. file.thumbnailUrl takes precedence when set.

    handleContextMenu: (event: MouseEvent, item: FileEntry | FolderEntry) => void

    Handle right-click context menu

    handleDragEnterFolder: (path: string) => (event: DragEvent) => void

    Handle drag enter on a folder

    handleDragLeaveFolder: (event: DragEvent) => void

    Handle drag leave from a folder

    handleDragOver: (event: DragEvent) => void

    Handle drag over

    handleDragStart: (file: FileEntry) => (event: DragEvent) => void

    Start dragging a file

    handleDropOnFolder: (path: string) => (event: DragEvent) => void

    Handle drop on a folder

    handleFileDoubleClick: (file: FileEntry) => void

    Handle file double-click (open)

    handleFolderDoubleClick: (folder: FolderEntry) => void

    Handle folder double-click (navigate)

    handleMoreClick: (
        event: MouseEvent<HTMLButtonElement>,
        item: FileEntry | FolderEntry,
    ) => void

    Handle more (⋮) button click

    handleSelectAll: (files: FileEntry[], checked: boolean) => void

    Handle select-all checkbox

    handleSelectItem: (item: FileEntry | FolderEntry) => void

    Handle item click selection

    handleSortClick: (column: FileListColumn) => void

    Handle sort column click

    handleToggleSelect: (file: FileEntry, checked: boolean) => void

    Handle checkbox toggle

    icons: FileManagerIcons

    Merged icons

    isFileSelected: (file: FileEntry) => boolean

    Check if a file is selected

    isFileShared?: (file: FileEntry) => boolean

    Determine whether a file's "Shared" badge should appear. When omitted, the badge shows whenever file.shared.length > 0. Consumers can override to scope visibility — e.g. inside a live room, hide the badge unless the file is actually shared with one of the current participants.

    isFlatView: boolean

    Whether flat view is active (hides folders)

    labels: FileManagerLabels

    Merged labels

    onCommentClick?: (file: FileEntry) => void

    Open comments panel for a file (undefined if comments are not available)

    onShareFile?: (file: FileEntry) => void

    Open share dialog for a file (undefined if sharing is not available)

    renderCellContent: (file: FileEntry, column: FileListColumn) => ReactNode

    Render cell content for a column (table view)

    renderColumnHeader: (column: FileListColumn) => ReactNode

    Render column header (table view)

    rowExtras?: Record<string, (file: FileEntry) => ReactNode>

    Per-resource-type inline metadata renderers (from rowExtras prop)

    selectedFiles: FileEntry[]

    Array of selected files

    selectedItem: FileEntry | FolderEntry | null

    Currently selected item

    sortColumn: FileListColumn | null

    Current sort column

    sortDirection: SortDirection

    Current sort direction

    styles: FileManagerStyles

    Merged styles

    userId: string

    Current user's ID (for ownership checks)

    Settings

    Member Visibility

    On This Page

    Properties