Context

The host supplies contexts to mount, activate and action handlers. Optional capabilities depend on declarations, placement and host support. Check availability before use. Register disposables with subscriptions; signal ends with the caller scope, not with a shared background connection.

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.

Lifetime

Source

Lifetime.signal

readonly signal: AbortSignal;

Lifetime.subscriptions

readonly subscriptions: {
    add<T extends Disposable>(value: T): T;
};

Related types: Disposable.

CommonCapabilities

Source

CommonCapabilities.background

readonly background?: PluginBackground;

CommonCapabilities.fs

readonly fs?: PluginFileSystem;

CommonCapabilities.filemeta

readonly filemeta?: PluginFileMeta;

CommonCapabilities.storage

readonly storage?: PluginStorage;

CommonCapabilities.network

Deprecated

readonly network?: PluginNetwork;

CommonCapabilities.settings

readonly settings?: Pick<PluginSettings, "get">;

CommonCapabilities.connections

readonly connections?: PluginConnections;

CommonCapabilities.ui

readonly ui: HostUI;

Related types: PluginBackground, PluginFileSystem, PluginFileMeta, PluginStorage, PluginNetwork, PluginSettings, PluginConnections, HostUI.

CommonContext

Source

interface CommonContext extends Lifetime { /* members below */ }

CommonContext.i18n

readonly i18n: PluginI18n;

CommonContext.capabilities

readonly capabilities: CommonCapabilities;

Related types: PluginI18n, CommonCapabilities, Lifetime.

PluginI18n

Source

PluginI18n.locale

readonly locale: string;

PluginI18n.t

t(key: string, values?: Record<string, string | number>): string;

Parameter	Type	Required
key	string	Yes
values	Record<string, string &#124; number>	No

Returns: string.

PluginI18n.onDidChangeLocale

onDidChangeLocale(listener: (event: {
    locale: string;
}) => void): Disposable;

Parameter	Type	Required
listener	(event: { locale: string; }) => void	Yes

Returns: Disposable.

Related types: Disposable.

ViewCapabilities

Source

interface ViewCapabilities extends CommonCapabilities { /* members below */ }

ViewCapabilities.explorer

readonly explorer?: ExplorerContext;

ViewCapabilities.document

readonly document?: TextDocument;

ViewCapabilities.eidos

readonly eidos?: EidosCapabilities;

Related types: ExplorerContext, TextDocument, EidosCapabilities, CommonCapabilities.

ViewContext

Source

interface ViewContext extends CommonContext { /* members below */ }

ViewContext.presentation

readonly presentation?: {
    mode: "standalone" | "embedded";
};

ViewContext.binding

readonly binding: ViewBinding;

ViewContext.capabilities

readonly capabilities: ViewCapabilities;

Related types: ViewBinding, ViewCapabilities, CommonContext.

TextFileViewContext

Source

export type TextFileViewContext = ViewContext & {
    readonly binding: Extract<ViewBinding, {
        kind: "file";
    }>;
    readonly capabilities: ViewCapabilities & {
        readonly document: TextDocument;
    };
};

Related types: ViewContext, ViewBinding, ViewCapabilities, TextDocument.

TableFileViewContext

Source

export type TableFileViewContext = ViewContext & {
    readonly binding: Extract<ViewBinding, {
        kind: "file";
    }>;
    readonly capabilities: ViewCapabilities & {
        readonly eidos: EidosCapabilities & {
            readonly table: EidosTable;
        };
    };
};

Related types: ViewContext, ViewBinding, ViewCapabilities, EidosCapabilities, EidosTable.

ActionContext

Source

interface ActionContext extends CommonContext { /* members below */ }

ActionContext.binding

readonly binding: ActionBinding;

ActionContext.capabilities

readonly capabilities: CommonCapabilities & {
    readonly document?: TextDocument;
    readonly settings: PluginSettings;
};

Related types: ActionBinding, CommonCapabilities, TextDocument, PluginSettings, CommonContext.

ExtensionContext

Source

interface ExtensionContext extends Lifetime { /* members below */ }

ExtensionContext.i18n

readonly i18n: PluginI18n;

ExtensionContext.capabilities

readonly capabilities: {
    readonly hooks: {
        register(id: string, handler: FileHookHandler): Disposable;
    };
    readonly formatters: {
        register(id: string, provider: FormatterProvider): Disposable;
    };
    readonly actions: {
        registerTableProvider(id: string, provider: TableActionProvider): Disposable;
        register(id: string, handler: (ctx: ActionContext) => void | Promise<void>): Disposable;
    };
};

Related types: PluginI18n, FileHookHandler, Disposable, FormatterProvider, TableActionProvider, ActionContext, Lifetime.

TableActionContext

Source

TableActionContext.i18n

readonly i18n: PluginI18n;

TableActionContext.signal

readonly signal: AbortSignal;

TableActionContext.capabilities

readonly capabilities: TableActionCapabilities;

Related types: PluginI18n, TableActionCapabilities.

Mount

Source

export type Mount = (ctx: ViewContext, root: HTMLElement) => void | Disposable | Promise<void | Disposable>;

Related types: ViewContext, Disposable.

Activate

Source

export type Activate = (ctx: ExtensionContext) => void | Disposable | Promise<void | Disposable>;

Related types: ExtensionContext, Disposable.