Skip to content

Types

Complete reference of VueFinder TypeScript types.

Available Types

VueFinder exports the following types:

TypeDescription
VueFinderPropsComponent props interface
DirEntryFile/folder entry type
DriverDriver interface
ConfigDefaultsConfiguration options
ConfigStateComplete config state
FeaturesConfigFeatures configuration object
FeaturesPresetFeature preset type ('simple' | 'advanced')
ThemeTheme type
FsDataFile system data response
RemoteDriverConfigRemoteDriver configuration
ArrayDriverConfigArrayDriver configuration
IndexedDBDriverConfigIndexedDBDriver configuration
ListParamsParameters for list operation
DeleteParamsParameters for delete operation
RenameParamsParameters for rename operation
TransferParamsParameters for copy/move operations
ArchiveParamsParameters for archive operation
SaveParamsParameters for save operation
DeleteResultResult of delete operation
FileOperationResultResult of file operations
FileContentResultResult of file content operations
SelectEventSelection event type
UpdatePathEventPath change event type
ContextMenuItemContext menu item type

Usage

Import types in your TypeScript files:

ts
import type {
  VueFinderProps,
  DirEntry,
  Driver,
  ConfigDefaults,
  FeaturesConfig,
  Theme,
} from 'vuefinder';

See Guide - TypeScript Support for usage examples.