Skip to content
Files SDK
Esc
navigateopen⌘Jpreview
On this page

File List

A reactive list of stored files with thumbnails, size and type, plus download and delete — driven by useFiles.

Lists the objects under a prefix and keeps itself in sync as you mutate them. Images get an inline thumbnail through the gateway download proxy, so it works on every adapter — even ones that can’t mint a public URL.

Loading…
"use client";

import { demoFiles } from "@/lib/demo-files";
import { FileList } from "@/registry/files-sdk/file-list/file-list";

const Example = () => {
  const files = demoFiles;

  return <FileList files={files} prefix="documents/" />;
};

export default Example;

Installation

npx shadcn@latest add https://files-sdk.dev/r/file-list.json

Usage

import { useFiles } from "files-sdk/react";

import { FileList } from "@/components/files-sdk/file-list";

export function Browser() {
  const files = useFiles({ endpoint: "/api/files" });

  return <FileList files={files} prefix="docs/" />;
}

Delete and download both go through the same files instance you pass in, so ambient error state stays consistent. The component owns its own list state (a files.list() call on mount) — for shared, cached listing bring useList instead.

Props

PropType
filesUseFilesResult

A `useFiles()` instance — lists, downloads and deletes through it.

TypeUseFilesResult
prefix?string

Only show keys under this prefix (folder), e.g. `"docs/"`.

Typestring
endpoint?string

Endpoint for inline image thumbnails (the gateway download proxy). Default `"/api/files"`.

Typestring
readOnly?boolean

Hide the delete action.

Typeboolean
className?string
Typestring

Was this page helpful?