development/vscode
development/vscode
1
0
Fork 0
mirror of https://github.com/Microsoft/vscode synced 2024-10-06 03:17:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc updates for https://github.com/microsoft/vscode/issues/167874 (#183129)

Browse source
This commit is contained in:
Johannes Rieken 2023-05-22 18:33:08 +02:00 committed by GitHub
parent 770d321a57
commit 360d6f75ba
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/vs/workbench/api/browser/statusBarExtensionPoint.ts
View file

@ -139,15 +139,15 @@ const statusBarItemSchema: IJSONSchema = {
properties: {
id: {
type: 'string',
description: localize('id', 'The unique identifier of the status bar entry.')
markdownDescription: localize('id', 'The identifier of the status bar entry. Must be unique within the extension. The same value must be used when calling the `vscode.window.createStatusBarItem(id, ...)`-API')
},
name: {
type: 'string',
description: localize('name', 'The name of the status bar entry.')
description: localize('name', 'The name of the entry, like \'Python Language Indicator\', \'Git Status\' etc. Try to keep the length of the name short, yet descriptive enough that users can understand what the status bar item is about.')
},
text: {
type: 'string',
description: localize('text', 'The text to display in the status bar entry.')
description: localize('text', 'The text to show for the entry. You can embed icons in the text by leveraging the `$(<name>)`-syntax, like \'Hello $(globe)!\'')
},
command: {
type: 'string',
@ -160,7 +160,7 @@ const statusBarItemSchema: IJSONSchema = {
},
priority: {
type: 'number',
description: localize('priority', 'The priority of the status bar entry.')
description: localize('priority', 'The priority of the status bar entry. Higher value means the item should be shown more to the left.')
}
}
};

21
src/vscode-dts/vscode.d.ts vendored
View file

@ -10153,22 +10153,23 @@ declare module 'vscode' {
/**
* Creates a status bar {@link StatusBarItem item}.
*
* @param alignment The alignment of the item.
* @param priority The priority of the item. Higher values mean the item should be shown more to the left.
* @return A new status bar item.
*/
export function createStatusBarItem(alignment?: StatusBarAlignment, priority?: number): StatusBarItem;
/**
* Creates a status bar {@link StatusBarItem item}.
*
* @param id The unique identifier of the item.
* @param id The identifier of the item. Must be unique within the extension.
* @param alignment The alignment of the item.
* @param priority The priority of the item. Higher values mean the item should be shown more to the left.
* @return A new status bar item.
*/
export function createStatusBarItem(id: string, alignment?: StatusBarAlignment, priority?: number): StatusBarItem;
/**
* Creates a status bar {@link StatusBarItem item}.
*
* @see {@link createStatusBarItem} for creating a status bar item with an identifier.
* @param alignment The alignment of the item.
* @param priority The priority of the item. Higher values mean the item should be shown more to the left.
* @return A new status bar item.
*/
export function createStatusBarItem(alignment?: StatusBarAlignment, priority?: number): StatusBarItem;
/**
* Creates a {@link Terminal} with a backing shell process. The cwd of the terminal will be the workspace
* directory if it exists.