VueFinder

Drivers & Adapters ​

VueFinder uses a driver-based architecture that abstracts file operations. This allows you to connect to different storage backends or implement custom file handling logic.

Driver Interface ​

All drivers must implement the Driver interface. VueFinder provides three built-in drivers:

  • RemoteDriver - For HTTP API backends
  • ArrayDriver - For in-memory file operations (using arrays)
  • IndexedDBDriver - For browser-based persistent storage (using IndexedDB)

RemoteDriver ​

Use RemoteDriver to connect to a backend HTTP API. This is the most common use case for production applications.

Basic Usage ​

js
import { RemoteDriver } from 'vuefinder';

const driver = new RemoteDriver({
  baseURL: '/api',
  url: {
    list: '/files',
    upload: '/files/upload',
    delete: '/files/delete',
    rename: '/files/rename',
    copy: '/files/copy',
    move: '/files/move',
    archive: '/files/archive',
    unarchive: '/files/unarchive',
    createFile: '/files/create-file',
    createFolder: '/files/create-folder',
    preview: '/files/preview',
    download: '/files/download',
    search: '/files/search',
    save: '/files/save',
  },
});

With Authentication ​

js
import { RemoteDriver } from 'vuefinder';

const driver = new RemoteDriver({
  baseURL: '/api',
  token: 'your-auth-token',
  headers: {
    Authorization: 'Bearer your-auth-token',
    'X-Custom-Header': 'value',
  },
  url: {
    list: '/files',
    // ... other endpoints
  },
});

Custom Endpoints ​

You can customize individual endpoint URLs:

js
import { RemoteDriver } from 'vuefinder';

const driver = new RemoteDriver({
  baseURL: '/api/v1',
  url: {
    list: '/list-files',
    upload: '/upload-files',
    delete: '/remove-files',
    // Only specify endpoints you want to override
  },
});

ArrayDriver ​

Use ArrayDriver for in-memory file operations using arrays. Useful for demos, testing, or client-only applications. Files are stored in memory and lost on page reload.

Basic Usage ​

js
import { ArrayDriver } from 'vuefinder';
import { ref } from 'vue';

const files = ref([
  {
    dir: '',
    basename: 'example.txt',
    extension: 'txt',
    path: 'memory://example.txt',
    storage: 'memory',
    type: 'file',
    file_size: 1024,
    last_modified: Date.now(),
    mime_type: 'text/plain',
    visibility: 'public',
  },
  {
    dir: '',
    basename: 'documents',
    extension: '',
    path: 'memory://documents',
    storage: 'memory',
    type: 'dir',
    file_size: null,
    last_modified: Date.now(),
    mime_type: null,
    visibility: 'public',
  },
]);

const driver = new ArrayDriver({
  files: files,
  storage: 'memory',
});

Multi-storage configuration ​

ArrayDriver supports multiple storages via storages.

js
const driver = new ArrayDriver({
  files,
  storage: 'media',
  storages: ['media', 'backup'],
});

Configuration options:

  • files: DirEntry[] or Ref<DirEntry[]> (required)
  • storage: default storage prefix (default: 'memory')
  • storages: list of supported storage prefixes (default: [storage])
  • readOnly: disable write operations when true (default: false)

IndexedDBDriver ​

Use IndexedDBDriver for browser-based persistent storage using IndexedDB. Files persist across page reloads and browser sessions. This is ideal for offline-first applications or when you need client-side file storage without a backend.

Basic Usage ​

js
import { IndexedDBDriver } from 'vuefinder';

const driver = new IndexedDBDriver({
  dbName: 'vuefinder', // Optional: defaults to 'vuefinder'
  storage: 'indexeddb', // Optional: defaults to 'indexeddb'
  readOnly: false, // Optional: defaults to false
  version: 1, // Optional: defaults to 1
});

Configuration Options ​

  • dbName: Name of the IndexedDB database (default: 'vuefinder')
  • storage: Storage identifier used in paths (default: 'indexeddb')
  • storages: List of managed storage identifiers (default: [storage])
  • readOnly: Whether the driver should allow write operations (default: false)
  • version: Database version number for schema migrations (default: 1)

Multi-storage configuration ​

js
const driver = new IndexedDBDriver({
  dbName: 'my-app-files',
  storage: 'local',
  storages: ['local', 'archive'],
});

Features ​

  • Persistent storage: Files persist across browser sessions
  • Automatic initialization: Database and object stores are created automatically
  • Full CRUD operations: Create, read, update, and delete files and folders
  • Content storage: File contents are stored separately from metadata
  • Search support: Full-text search across file names and paths

Example ​

js
import { IndexedDBDriver } from 'vuefinder';

// Create driver with custom database name
const driver = new IndexedDBDriver({
  dbName: 'my-app-files',
  storage: 'indexeddb',
});

// Files will be persisted to IndexedDB and available on next page load

Custom Driver ​

You can create your own driver by implementing the Driver interface:

ts
import { BaseAdapter, type Driver } from 'vuefinder';

import type {
  FsData,
  DeleteResult,
  FileOperationResult,
  FileContentResult,
  ListParams,
  DeleteParams,
  RenameParams,
  TransferParams,
  ArchiveParams,
  SaveParams,
} from 'vuefinder';

class MyCustomDriver extends BaseAdapter implements Driver {
  async list(params?: ListParams): Promise<FsData> {
    // Your implementation
    return {
      storages: ['custom'],
      dirname: params?.path || 'custom://',
      files: [],
    };
  }

  async delete(params: DeleteParams): Promise<DeleteResult> {
    // Your implementation
    return {
      files: [],
      storages: ['custom'],
      read_only: false,
      dirname: params.path,
      deleted: [],
    };
  }

  async rename(params: RenameParams): Promise<FileOperationResult> {
    // Your implementation
  }

  // Implement all other required methods...
  // See the Driver interface for complete list
}

Backend Libraries ​

Official backend libraries are available:

For other languages, you can implement the API endpoints yourself. See the API Reference for the required interface.