Skip to content

Repository files navigation

Hello, Sidebar

HarborClient plugin that replaces the built-in Collections sidebar with a collections-only tree — folders, requests, and markdown documents. No Environments, Runs, History, Workspaces, Archive, or Trash sections.

This is the “Hello, World” demo for sidebar replacement via contributes.sidebarPanels with replaces: "collections".

Features

  • Replaces the built-in Collections sidebar when loaded
  • Reads the library with hc.host.listLibraryTree and refreshes on onLibraryChanged
  • Opens requests and documents through host selection / load APIs
  • Host-mediated row context menus (showEntityContextMenu)
  • UI built from @harborclient/sdk/components (SidebarTree, SidebarFolderItem, SidebarRequestItem, SidebarDocumentItem, …)

Setup

pnpm install
pnpm build

Load the project folder in HarborClient via Settings → Plugins → Load unpacked….

Requires a HarborClient build that supports collections sidebar replacement (engines.harborclient >= 2.6.0) and @harborclient/sdk with the library host APIs (listLibraryTree, selection bridge, entity context menus).

Local SDK development

Do not commit file: paths in package.json. To test against a local @harborclient/sdk checkout without changing tracked files, use one of:

  • pnpm link from the published package directory after pnpm pack in packages/sdk
  • A gitignored override file (for example .pnpmfile.cjs or a local-only pnpm-workspace.yaml entry) that only exists on your machine

Development

pnpm dev

Rebuilds dist/renderer.js and dist/main.js on change. Keep the sidebar panel open for hot reload.

Customize

  1. Change id, name, and contributes in manifest.json.
  2. Extend the tree under src/components/.
  3. Add mutations or DnD using the host APIs documented in the SDK sidebar-replacement-tree example.

About

HarborClient plugin that replaces the built-in Collections sidebar with a collections-only tree — folders, requests, and markdown documents.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages