Skip to main content

workbench

A headless React file tree and editor. Workbench shows a lazily loaded, virtualized file tree next to tabbed editors, and gets its files from a WorkbenchAdapter, so the same widget works over a local folder, a REST API or any other source. It ships no CSS: every element exposes data-* attributes for your own styles.

Install​

pnpm add @jbpark/workbench

React 19.1.1 or later is a peer dependency. The default editor, a CodeMirror editor from @jbpark/ui-kit, is a separate entry with its own optional peers; see File editor.

Quick start​

Open a local folder in a Chromium-based browser and edit it:

import { useState } from 'react';

import {
Workbench,
type WorkbenchAdapter,
createFsAdapter,
} from '@jbpark/workbench';
import { codeEditorRenderer } from '@jbpark/workbench/code-editor';

export function App() {
const [adapter, setAdapter] = useState<WorkbenchAdapter>();

const openFolder = async () => {
const directory = await window.showDirectoryPicker({ mode: 'readwrite' });

setAdapter(createFsAdapter(directory));
};

if (!adapter) {
return <button onClick={openFolder}>Open folder</button>;
}

// The widget fills its parent, which must have a height.
return (
<div style={{ height: '100vh' }}>
<Workbench adapter={adapter} renderEditor={codeEditorRenderer} />
</div>
);
}

Then add styles: Workbench renders unstyled markup until you do. The Styling page has a complete stylesheet to start from.

Pages​

PageCovers
WorkbenchThe composite widget: props, saving, tabs, read-only, theme, resizing. Live demo
File treeFileTree on its own: lazy loading, selection, icons. Live demo
File editorFileEditor, the editor renderer contract, the ui-kit CodeEditor entry, custom editors. Live demo
AdapterscreateFsAdapter, createHttpAdapter, and writing your own WorkbenchAdapter
StylingThe headless styling surface, every data-* attribute, and a complete Tailwind CSS v4 stylesheet