WorkspaceEditEntryMetadata

Additional data for entries of a workspace edit. Supports to label entries and marks entries as needing confirmation by the user. The editor groups edits with equal labels into tree nodes, for instance all edits labelled with "Changes in Strings" would be a tree node.

Hierarchy

WorkspaceEditEntryMetadata

Index

Properties

description
iconPath
label
needsConfirmation

Properties

Optional description

description?: string

A human-readable string which is rendered less prominent on the same line.

Optional iconPath

iconPath?: Uri | ThemeIcon | { dark: Uri; light: Uri }

The icon path or ThemeIcon for the edit.

label

label: string

A human-readable string which is rendered prominent.

needsConfirmation

needsConfirmation: boolean

A flag which indicates that user confirmation is needed.