Interface FileDecorationProvider

The decoration provider interfaces defines the contract between extensions and file decorations.

interface FileDecorationProvider {
    onDidChangeFileDecorations?: Event<undefined | Uri | Uri[]>;
    provideFileDecoration(
        uri: Uri,
        token: CancellationToken,
    ): ProviderResult<FileDecoration>;
}

Index

Properties

onDidChangeFileDecorations?

Methods

provideFileDecoration

Properties

`Optional`onDidChangeFileDecorations

onDidChangeFileDecorations?: Event<undefined | Uri | Uri[]>

An optional event to signal that decorations for one or many files have changed.

Note that this event should be used to propagate information about children.

See

Methods

provideFileDecoration

provideFileDecoration(
uri: Uri,
token: CancellationToken,
): ProviderResult<FileDecoration>
Provide decorations for a given uri.

Note that this function is only called when a file gets rendered in the UI. This means a decoration from a descendent that propagates upwards must be signaled to the editor via the onDidChangeFileDecorations-event.
Parameters
- uri: Uri
  The uri of the file to provide a decoration for.
- token: CancellationToken
  A cancellation token.
Returns ProviderResult<FileDecoration>
A decoration or a thenable that resolves to such.
- Defined in packages/plugin/src/theia.d.ts:4025