Manifest

Declarations request capabilities; the host validates and grants access. apiVersion is the package protocol; requires.pluginApi is the minimum host API. Access defaults to read. Background requires Lite API 3.4; templates 3.2; hooks 3.3; file metadata and explorer 3.1.

Usage guide: views. API index.

Signatures, parameters and return types are generated from the SDK. Optional members are not available in every host and context.

PluginManifest

Source

PluginManifest.apiVersion

apiVersion: 1;

PluginManifest.kind

kind?: "theme";

PluginManifest.id

id: string;

PluginManifest.name

name: string;

PluginManifest.description

An optional nonempty plain-text line, at most 1024 UTF-16 code units.

description?: string;

PluginManifest.version

version: string;

PluginManifest.i18n

i18n?: {
    defaultLocale: string;
    messages: Record<string, string>;
    readme?: Record<string, string>;
};

PluginManifest.requires

requires?: {
    pluginApi: string;
};

PluginManifest.icon

icon?: PluginIconDefinition;

PluginManifest.extension

extension?: string;

PluginManifest.background

A separate Worker-style entry. network: true permits public HTTPS/WSS after approval; up to eight exact networkOrigins optionally restrict it. bluetooth: true grants the selected device, optionally narrowed by a service whitelist. Device IDs are chosen by the host. API 3.6 adds autoStart: true for approved startup on Space opening, and fileHistory: true for file-open metadata in the owner window and Space; fileHistory does not grant file contents.

background?: {
    entry: string;
    network?: true;
    networkOrigins?: string[];
    bluetooth?: true | {
        services: BluetoothServicePermission[];
    };
    fileHistory?: true;
    autoStart?: true;
};

PluginManifest.views

views?: ViewDeclaration[];

PluginManifest.fileTemplates

Static UTF-8 templates, up to 256 KiB each. The referenced document View must have a matching file/open placement.

fileTemplates?: FileTemplateDeclaration[];

PluginManifest.actions

actions?: ActionDeclaration[];

PluginManifest.formatters

formatters?: FormatterDeclaration[];

PluginManifest.hooks

hooks?: FileHookDeclaration[];

PluginManifest.placements

placements?: Placement[];

PluginManifest.settings

settings?: Record<string, SettingDeclaration>;

PluginManifest.browser

browser?: {
    workers?: boolean;
    network?: true;
    networkOrigins?: string[];
};

PluginManifest.storage

storage?: {
    maxBytes: number;
};

PluginManifest.workspace

workspace?: {
    files?: boolean | {
        read?: boolean;
        write?: boolean;
    };
    filemeta?: {
        namespaces: string[];
        write?: boolean;
    };
};

PluginManifest.connections

connections?: Record<string, {
    title: string;
    url: string;
    configurable?: boolean;
}>;

PluginManifest.theme

theme?: ThemeDeclaration;

ThemeDeclaration

Source

ThemeDeclaration.stylesheet

stylesheet: string;

FileTemplateDeclaration

Source

FileTemplateDeclaration.id

id: string;

FileTemplateDeclaration.title

title: string;

FileTemplateDeclaration.extension

extension: string;

FileTemplateDeclaration.view

view: string;

FileTemplateDeclaration.content

content: string;

ViewDeclaration

Source

ViewDeclaration.id

id: string;

ViewDeclaration.title

title: string;

ViewDeclaration.entry

entry: string;

ViewDeclaration.kind

kind: "page" | "file";

ViewDeclaration.capabilities

capabilities?: ViewCapability[];

ViewDeclaration.access

access?: "read" | "write";

ViewDeclaration.configuration

configuration?: ViewConfiguration;

ViewDeclaration.icon

icon?: PluginIconDefinition;

ViewConfiguration

Source

ViewConfiguration.type

type: "object";

ViewConfiguration.properties

properties: Record<string, SettingDeclaration & {
    "x-field"?: true;
}>;

Related types: SettingDeclaration.

ActionDeclaration

Source

ActionDeclaration.id

id: string;

ActionDeclaration.title

title: string;

ActionDeclaration.context

context: "workspace" | "file" | "document" | "table";

ActionDeclaration.access

access?: "read" | "write";

ActionDeclaration.extensions

extensions?: string[];

ActionDeclaration.icon

icon?: PluginIconDefinition;

Related types: PluginIconDefinition.

FormatterDeclaration

Source

FormatterDeclaration.id

id: string;

FormatterDeclaration.title

title: string;

FormatterDeclaration.extensions

extensions: string[];

FileHookDeclaration

Source

FileHookDeclaration.id

id: string;

FileHookDeclaration.title

title: string;

FileHookDeclaration.event

event: FileHookEventType;

FileHookDeclaration.extensions

extensions: string[];

FileHookDeclaration.access

access?: "read" | "write";

Related types: FileHookEventType.

Placement

Source

export type Placement = {
    location: "plugin/settings";
    view: string;
} | {
    location: "navigation";
    view: string;
} | {
    location: "sidebar/explorer";
    view: string;
} | {
    location: "file/open";
    view: string;
    extensions: string[];
} | {
    location: "table/view";
    view: string;
} | {
    location: "command-palette";
    action: string;
} | {
    location: "file/context";
    action: string;
} | {
    location: "table/context";
    action: string;
} | {
    location: "view/toolbar";
    action: string;
    view: string;
} | {
    location: "keybinding";
    action: string;
    key: string;
    mac?: string;
    linux?: string;
};

BluetoothServicePermission

Source

BluetoothServicePermission.uuid

uuid: string;

BluetoothServicePermission.read

read?: boolean;

BluetoothServicePermission.write

write?: boolean;

BluetoothServicePermission.notify

notify?: boolean;

SettingDeclaration

Source

export type SettingDeclaration = {
    title: string;
    description?: string;
} & ({
    type: "boolean";
    default: boolean;
} | {
    type: "string";
    default: string;
    enum?: string[];
} | {
    type: "number";
    default: number;
    minimum?: number;
    maximum?: number;
});