Skip to content
THE COMPONENT LIBRARY
Skip to content

Component reference

FileManager

Browse and manage a project's assets.

Preview

Live preview

Changes apply to this preview only.

5 items
BrandOct 14, 20263 items
DeliverablesSep 30, 20263 items
EngineeringOct 18, 20262 items
README.mdOct 19, 20262.3 KB
roadmap-2027.pdfOct 20, 2026957 KB

Selection

Ctrl/Cmd click adds entries; Shift click selects a range.

list view0 selected

Nothing selected yet.

Last opened

Double click a folder to navigate, or a file to hand it to the host application.

No entry opened yet.

Width adapts to the available space

More examples

Different configurations and compositions using the real Pimolu API. Each preview runs independently and follows the site appearance.

Single-file selection

Browse local mock files with real folder navigation and selection feedback.

Open preview

Open a nested folder

Browse local mock files with real folder navigation and selection feedback.

Open preview

Asset picker

Grid tiles with single selection, shown without folders.

Open preview

Usage

File actions report application intent; connect them to real permissions and storage before shipping.

API reference

Generated from the public TypeScript declarations. Native HTML attributes are inherited where the component extends them; this reference includes Pimolu props and selected common native attributes.

PimoluFileManagerSort

Type source
PimoluFileManagerSort public API
NameTypeDefaultDescription
byRequiredPimoluFileManagerSortBy—Public Pimolu prop; see the source declaration for details.
directionRequiredPimoluFileManagerSortDirection—Public Pimolu prop; see the source declaration for details.
byRequired

PimoluFileManagerSortBy

No default extracted.

Public Pimolu prop; see the source declaration for details.

directionRequired

PimoluFileManagerSortDirection

No default extracted.

Public Pimolu prop; see the source declaration for details.

PimoluFileEntry

Type source
PimoluFileEntry public API
NameTypeDefaultDescription
idRequiredstring—Stable identifier.
nameRequiredstring—Visible name.
typeRequiredPimoluFileEntryType—Whether the entry can be opened as a folder.
sizenumber | undefined—Size in bytes, for files.
modifiedDate | undefined—Last modification date.
mimestring | undefined—MIME type, used to choose the icon.
childrenreadonly PimoluFileEntry[] | undefined—Nested children. Their parent is inferred from this entry.
parentIdstring | null | undefined—Parent folder id for flat data. `null` means the root.
idRequired

string

No default extracted.

Stable identifier.

nameRequired

string

No default extracted.

Visible name.

typeRequired

PimoluFileEntryType

No default extracted.

Whether the entry can be opened as a folder.

size

number | undefined

No default extracted.

Size in bytes, for files.

modified

Date | undefined

No default extracted.

Last modification date.

mime

string | undefined

No default extracted.

MIME type, used to choose the icon.

children

readonly PimoluFileEntry[] | undefined

No default extracted.

Nested children. Their parent is inferred from this entry.

parentId

string | null | undefined

No default extracted.

Parent folder id for flat data. `null` means the root.

PimoluFileManagerProps

Type source
PimoluFileManagerProps public API
NameTypeDefaultDescription
entriesRequiredreadonly PimoluFileEntry[]—Full data set. Only the direct children of the current folder are shown.
viewPimoluFileManagerView | undefined—Controlled view.
defaultViewPimoluFileManagerView | undefined"list"Initial view when uncontrolled. Defaults to "list".
onViewChange((view: PimoluFileManagerView) => void) | undefined—Called when the List/Grid toggle changes.
selectedreadonly string[] | undefined—Controlled selected ids.
defaultSelectedreadonly string[] | undefined[]Initial selected ids when uncontrolled.
onSelectionChange((ids: string[], entries: PimoluFileEntry[]) => void) | undefined—Called with the selected ids and their entries whenever selection changes.
onSelect((entries: PimoluFileEntry[]) => void) | undefined—Called with the selected entries whenever selection changes.
pathreadonly string[] | undefined—Controlled folder path, from the root to the current folder.
defaultPathreadonly string[] | undefinedthe rootInitial folder path when uncontrolled. Defaults to the root.
onPathChange((path: string[]) => void) | undefined—Called when the current folder changes.
selectionMode"single" | "multiple" | undefined"multiple""single" replaces the selection; "multiple" supports Ctrl/Cmd and Shift.
searchstring | undefined—Controlled search term.
defaultSearchstring | undefined""Initial search term when uncontrolled.
onSearchChange((value: string) => void) | undefined—Called whenever the search term changes.
sortPimoluFileManagerSort | undefined—Controlled sort.
defaultSortPimoluFileManagerSort | undefinedname ascendingInitial sort when uncontrolled. Defaults to name ascending.
onSortChange((sort: PimoluFileManagerSort) => void) | undefined—Called whenever the sort column or direction changes.
onOpen((entry: PimoluFileEntry) => void) | undefined—Called when a folder is opened or when a file is double-clicked (or activated with Enter).
onDelete((entries: PimoluFileEntry[]) => void) | undefined—Called with the selected entries when Delete is pressed or the toolbar action is used.
localestring | undefined"en-US"BCP 47 locale used for dates and name sorting. Defaults to "en-US".
rootLabelstring | undefined"Files"Label of the root breadcrumb. Defaults to "Files".
foldersFirstboolean | undefinedtrueKeep folders before files regardless of the sort column. Defaults to true.
classNamestring | undefined—Class applied to the outer file manager.
aria-labelstring | undefined"File manager"Accessible name of the file manager. Defaults to "File manager".
entriesRequired

readonly PimoluFileEntry[]

No default extracted.

Full data set. Only the direct children of the current folder are shown.

view

PimoluFileManagerView | undefined

No default extracted.

Controlled view.

defaultView

PimoluFileManagerView | undefined

Default: "list"

Initial view when uncontrolled. Defaults to "list".

onViewChange

((view: PimoluFileManagerView) => void) | undefined

No default extracted.

Called when the List/Grid toggle changes.

selected

readonly string[] | undefined

No default extracted.

Controlled selected ids.

defaultSelected

readonly string[] | undefined

Default: []

Initial selected ids when uncontrolled.

onSelectionChange

((ids: string[], entries: PimoluFileEntry[]) => void) | undefined

No default extracted.

Called with the selected ids and their entries whenever selection changes.

onSelect

((entries: PimoluFileEntry[]) => void) | undefined

No default extracted.

Called with the selected entries whenever selection changes.

path

readonly string[] | undefined

No default extracted.

Controlled folder path, from the root to the current folder.

defaultPath

readonly string[] | undefined

Default: the root

Initial folder path when uncontrolled. Defaults to the root.

onPathChange

((path: string[]) => void) | undefined

No default extracted.

Called when the current folder changes.

selectionMode

"single" | "multiple" | undefined

Default: "multiple"

"single" replaces the selection; "multiple" supports Ctrl/Cmd and Shift.

search

string | undefined

No default extracted.

Controlled search term.

defaultSearch

string | undefined

Default: ""

Initial search term when uncontrolled.

onSearchChange

((value: string) => void) | undefined

No default extracted.

Called whenever the search term changes.

sort

PimoluFileManagerSort | undefined

No default extracted.

Controlled sort.

defaultSort

PimoluFileManagerSort | undefined

Default: name ascending

Initial sort when uncontrolled. Defaults to name ascending.

onSortChange

((sort: PimoluFileManagerSort) => void) | undefined

No default extracted.

Called whenever the sort column or direction changes.

onOpen

((entry: PimoluFileEntry) => void) | undefined

No default extracted.

Called when a folder is opened or when a file is double-clicked (or activated with Enter).

onDelete

((entries: PimoluFileEntry[]) => void) | undefined

No default extracted.

Called with the selected entries when Delete is pressed or the toolbar action is used.

locale

string | undefined

Default: "en-US"

BCP 47 locale used for dates and name sorting. Defaults to "en-US".

rootLabel

string | undefined

Default: "Files"

Label of the root breadcrumb. Defaults to "Files".

foldersFirst

boolean | undefined

Default: true

Keep folders before files regardless of the sort column. Defaults to true.

className

string | undefined

No default extracted.

Class applied to the outer file manager.

aria-label

string | undefined

Default: "File manager"

Accessible name of the file manager. Defaults to "File manager".

Accessibility

  • Test selection, contextual actions, rename/delete confirmation and focus after a file disappears.
Read the accessibility guide →