Skip to content

@harborclient/plugin-api

Main Navigation v0.3.1

Sidebar Navigation

Introduction

Install

Skeleton plugin

Development

Building

Quick start

Renderer entry

Main entry

Utility imports

Package layout

Manifest

Plugin metadata

description

Permissions

icon

Screenshots

company, homepage, and bugs

Contribution types

Permissions

Architecture

Two runtimes

Lifecycle

Building

Packaging as .hcp

Recommended project setup

TypeScript

Main entry

Dev workflow

Load unpacked

Hot reload

Recommended dev workflow

Load unpacked at startup (optional)

Unpacked vs installed

Host IPC (development)

Renderer API

hc.pluginId

hc.react

React and JSX

hc.http

hc.http.onAfterSend(handler)

hc.ipc

hc.ipc.invoke(channel, ...args)

hc.host

hc.host.openRequestDraft(payload)

hc.host.loadRequest(requestId)

Related reference

UI contributions

hc.ui.registerSettingsSection(section)

hc.ui.registerSidebarPanel(panel)

hc.ui.registerSidebarSection(section)

hc.ui.registerMainView(view)

hc.ui.registerRequestTab(tab)

hc.ui.registerResponseTab(tab)

hc.ui.registerCollectionSettingsTab(tab)

hc.ui.registerFooterPanel(panel)

hc.ui.registerMenuItem(item)

hc.ui.registerRequestToolbarAction(action)

hc.ui.registerContextMenuItem(item)

hc.ui.registerStatusBarItem(item)

hc.ui.showToast(message, options?)

Themes and storage

hc.themes

hc.themes.register(theme)

hc.themes.getActive()

hc.themes.onDidChange(listener)

Theme color tokens

hc.commands

hc.commands.register(id, handler)

hc.commands.execute(id, ...args)

hc.storage

hc.storage.get(key)

hc.storage.set(key, value)

hc.fs

hc.fs.pickFile(options?)

hc.fs.pickDirectory(defaultPath?)

hc.fs.saveFile(content, options?)

hc.fs.readFile(path)

hc.fs.writeFile(path, content)

hc.http

hc.ipc

hc.host

hc.subscriptions

Not extensible

Main API

hc.storage

hc.http.onBeforeSend(handler)

hc.http.onAfterSend(handler)

hc.ipc.handle(channel, handler)

Examples

Request logger

Request audit tab

Solarized theme

Marketplace

Requirements

Catalog entry fields

Performance

Plugins vs scripts

License

On this page

License

MIT

Pager

Previous pagePlugins vs scripts