Skip to content

Commit 9e12258

Browse files
committed
Add basic authored info for extensions members
1 parent 92c5451 commit 9e12258

File tree

83 files changed

+464
-273
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+464
-273
lines changed

hub/powertoys/command-palette/microsoft-commandpalette-extensions/color.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Color Struct
3-
description:
3+
description: The Color struct represents a color value in the Command Palette.
44
ms.date: 2/7/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,11 +12,13 @@ no-loc: [PowerToys, Windows, Insider]
1212

1313
Namespace: [Microsoft.CommandPalette.Extensions](microsoft-commandpalette-extensions.md)
1414

15+
The **Color** struct represents a color value in the Command Palette. It is used to define colors in the RGB (Red, Green, Blue) color model, with an optional alpha (transparency) channel.
16+
1517
## Fields
1618

1719
| Field | Type | Description |
1820
| :--- | :--- | :--- |
19-
| A | UInt8 | Alpha value |
21+
| A | UInt8 | Alpha value (transparency) |
2022
| B | UInt8 | Blue value |
2123
| G | UInt8 | Green value |
2224
| R | UInt8 | Red value |

hub/powertoys/command-palette/microsoft-commandpalette-extensions/commandresultkind.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: CommandResultKind Enum
3-
description:
3+
description: The CommandResultKind enum is used to specify the result of a command execution in the Command Palette.
44
ms.date: 2/10/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,6 +12,8 @@ no-loc: [PowerToys, Windows, Insider]
1212

1313
Namespace: [Microsoft.CommandPalette.Extensions](microsoft-commandpalette-extensions.md)
1414

15+
The **CommandResultKind** enum is used to specify the result of a command execution in the Command Palette. It defines the different actions that can be taken after a command is executed.
16+
1517
## Fields
1618

1719
| Field | Description |

hub/powertoys/command-palette/microsoft-commandpalette-extensions/icommand.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ Action a user can take within the Command Palette.
2222
| Id | String | Gets the ID of the command. This is optional but can help support more efficient command lookup in [ICommandProvider.GetCommand()](icommandprovider_getcommand.md). |
2323
| Name | String | Gets the name of the command. |
2424

25-
## Samples
25+
## Example
2626

27-
[Add a command](../samples.md#add-a-command)
27+
See the [Add a command](../samples.md#add-a-command) section for an example of how to use this interface.

hub/powertoys/command-palette/microsoft-commandpalette-extensions/icommandcontextitem.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: ICommandContextItem Interface
3-
description:
3+
description: The ICommandContextItem interface is used to represent a context item in the Command Palette.
44
ms.date: 2/7/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,9 +12,15 @@ no-loc: [PowerToys, Windows, Insider]
1212

1313
Namespace: [Microsoft.CommandPalette.Extensions](microsoft-commandpalette-extensions.md)
1414

15+
The **ICommandContextItem** interface is used to represent a context item in the Command Palette. It is used to define the properties and methods that a context item must implement in order to be displayed in the Command Palette.
16+
1517
## Properties
1618

1719
| Property | Type | Description |
1820
| :--- | :--- | :--- |
19-
| IsCritical | Boolean | Makes the item red. |
20-
| RequestedShortcut | [KeyChord](keychord.md) | |
21+
| IsCritical | Boolean | Makes the item red to indicate that it's critical and requires attention. |
22+
| RequestedShortcut | [KeyChord](keychord.md) | The shortcut that was requested for this item. This property is used to define the shortcut that will be used to activate the item in the Command Palette. |
23+
24+
## Remarks
25+
26+
When displaying a **IListItem**'s default **Command** as a context item, a new **ICommandContextItem** is created.
Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: ICommandItem Interface
3-
description:
3+
description: The ICommandItem interface is used to represent a command item in the Command Palette.
44
ms.date: 2/7/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,12 +12,23 @@ no-loc: [PowerToys, Windows, Insider]
1212

1313
Namespace: [Microsoft.CommandPalette.Extensions](microsoft-commandpalette-extensions.md)
1414

15+
The **ICommandItem** interface is used to represent a command item in the Command Palette. It is used to define the properties and methods that a command item must implement in order to be displayed in the Command Palette.
16+
1517
## Properties
1618

1719
| Property | Type | Description |
1820
| :--- | :--- | :--- |
19-
| Command | [ICommand](icommand.md) | |
20-
| Icon | [IIconInfo](iiconinfo.md) | |
21-
| MoreCommands | [IContextItem[]](icontextitem.md) | |
22-
| Subtitle | String | |
23-
| Title | String | |
21+
| Command | [ICommand](icommand.md) | The command associated with this item. This is the command that will be executed when the item is activated. |
22+
| Icon | [IIconInfo](iiconinfo.md) | The icon associated with this item. This icon will be displayed next to the item in the Command Palette. |
23+
| MoreCommands | [IContextItem[]](icontextitem.md) | An array of additional commands that can be displayed in a submenu. This property is used to define a list of related commands that can be executed from the Command Palette. |
24+
| Subtitle | String | The subtitle associated with this item. This subtitle will be displayed below the item in the Command Palette. |
25+
| Title | String | The title associated with this item. This title will be displayed as the main text of the item in the Command Palette. |
26+
27+
## Remarks
28+
29+
If an **ICommandItem** in a context menu has **MoreCommands**, then activating it will open a submenu with those items. If an **ICommandItem** in a context menu has **MoreCommands** and a non-null **Command**, then activating it will open a submenu with the **Command** first (following the same rules for building a context item from a default **Command**), followed by the items in **MoreCommands**.
30+
31+
When displaying a page:
32+
33+
- The title will be `IPage.Title ?? ICommand.Name`
34+
- The icon will be `ICommand.Icon`
Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: ICommandProvider Interface
3-
description:
3+
description: The ICommandProvider interface is used to provide commands for the Command Palette to use.
44
ms.date: 2/7/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,21 +12,23 @@ no-loc: [PowerToys, Windows, Insider]
1212

1313
Namespace: [Microsoft.CommandPalette.Extensions](microsoft-commandpalette-extensions.md)
1414

15+
This is the interface that an extension must implement to provide commands to the Command Palette. The Command Palette will call this interface to get the commands that it should display.
16+
1517
## Properties
1618

1719
| Property | Type | Description |
1820
| :--- | :--- | :--- |
19-
| DisplayName | String | |
20-
| Frozen | Boolean | |
21-
| Icon | [IIconInfo](iiconinfo.md) | |
22-
| Id | String | |
23-
| Settings | [ICommandSettings](icommandsettings.md) | |
21+
| DisplayName | String | The display name of the command provider. This is used to identify the provider in the Command Palette. |
22+
| Frozen | Boolean | Indicates whether the command provider is frozen. A frozen command provider will not be updated or refreshed. |
23+
| Icon | [IIconInfo](iiconinfo.md) | The icon associated with the command provider. This is used to display an icon in the Command Palette. |
24+
| Id | String | The unique identifier of the command provider. This is used to identify the provider in the Command Palette. |
25+
| Settings | [ICommandSettings](icommandsettings.md) | The settings associated with the command provider. This is used to provide additional information or resources related to the item being displayed in the Command Palette. |
2426

2527
## Methods
2628

2729
| Method | Description |
2830
| :--- | :--- |
29-
| [FallbackCommands()](icommandprovider_fallbackcommands.md) | |
30-
| [GetCommand(String)](icommandprovider_getcommand.md) | |
31-
| [InitializeWithHost(IExtensionHost)](icommandprovider_initializewithhost.md) | |
32-
| [TopLevelCommands()](icommandprovider_toplevelcommands.md) | |
31+
| [FallbackCommands()](icommandprovider_fallbackcommands.md) | Returns the fallback commands for the command provider. |
32+
| [GetCommand(String)](icommandprovider_getcommand.md) | Returns the command associated with the specified ID. |
33+
| [InitializeWithHost(IExtensionHost)](icommandprovider_initializewithhost.md) | Initializes the command provider with the specified host. This is called when the command provider is first created. |
34+
| [TopLevelCommands()](icommandprovider_toplevelcommands.md) | Returns the top-level commands for the command provider. |

hub/powertoys/command-palette/microsoft-commandpalette-extensions/icommandprovider_fallbackcommands.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: ICommandProvider.FallbackCommands() Method
3-
description:
3+
description: The FallbackCommands are special top-level items which allow extensions to have dynamic top-level items which respond to the text the user types on the main list page.
44
ms.date: 2/7/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,6 +12,8 @@ no-loc: [PowerToys, Windows, Insider]
1212

1313
Namespace: [Microsoft.CommandPalette.Extensions](microsoft-commandpalette-extensions.md)
1414

15+
The **FallbackCommands** are special top-level items which allow extensions to have dynamic top-level items which respond to the text the user types on the main list page. These are not shown in the top-level list of commands, but are shown when the user types text in the Command Palette. This allows extensions to provide dynamic commands that are not shown in the top-level list.
16+
1517
## Returns
1618

17-
[IFallbackCommandItem[]](ifallbackcommanditem.md)
19+
An [IFallbackCommandItem[]](ifallbackcommanditem.md) that contains the commands that should be shown in the Command Palette. The commands will be displayed in the order that they are returned by this method.

hub/powertoys/command-palette/microsoft-commandpalette-extensions/icommandprovider_getcommand.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: ICommandProvider.GetCommand(String) Method
3-
description:
3+
description: The GetCommand method is used to retrieve a command by its ID.
44
ms.date: 2/7/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,10 +12,14 @@ no-loc: [PowerToys, Windows, Insider]
1212

1313
Namespace: [Microsoft.CommandPalette.Extensions](microsoft-commandpalette-extensions.md)
1414

15+
The **GetCommand** method is used to retrieve a command by its ID. This method is used to get a command that has been registered with the Command Palette.
16+
1517
## Parameters
1618

1719
**`id`** String
1820

21+
The ID of the command to retrieve. The ID is a unique identifier for the command and is used to identify the command in the Command Palette.
22+
1923
## Returns
2024

21-
[ICommand](icommand.md)
25+
An [ICommand](icommand.md) that contains the command that was registered with the Command Palette. If the command is not found, this method returns null.

hub/powertoys/command-palette/microsoft-commandpalette-extensions/icommandprovider_initializewithhost.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: ICommandProvider.InitializeWithHost(IExtensionHost) Method
3-
description:
3+
description: The InitializeWithHost method is called when the extension is loaded. This method is used to initialize the extension with the host application.
44
ms.date: 2/7/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,6 +12,10 @@ no-loc: [PowerToys, Windows, Insider]
1212

1313
Namespace: [Microsoft.CommandPalette.Extensions](microsoft-commandpalette-extensions.md)
1414

15+
The **InitializeWithHost** method is called when the extension is loaded. This method is used to initialize the extension with the host application. The host application provides the extension with a reference to the [IExtensionHost](iextensionhost.md) interface, which allows the extension to interact with the host application.
16+
1517
## Parameters
1618

1719
**`host`** [IExtensionHost](iextensionhost.md)
20+
21+
The host application that is loading the extension. The host application provides the extension with a reference to the [IExtensionHost](iextensionhost.md) interface, which allows the extension to interact with the host application.

hub/powertoys/command-palette/microsoft-commandpalette-extensions/icommandprovider_toplevelcommands.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: ICommandProvider.TopLevelCommands() Method
3-
description:
3+
description: The TopLevelCommands method is called to get the list of actions that should be shown when the user opens the Command Palette.
44
ms.date: 2/7/2025
55
ms.topic: reference
66
no-loc: [PowerToys, Windows, Insider]
@@ -12,6 +12,8 @@ no-loc: [PowerToys, Windows, Insider]
1212

1313
Namespace: [Microsoft.CommandPalette.Extensions](microsoft-commandpalette-extensions.md)
1414

15+
**TopLevelCommands** is the method that Command Palette will call to get the list of actions that should be shown when the user opens it. These are the commands that will allow the user to interact with the rest of your extension. They can be simple actions, or they can be pages that the user can navigate to.
16+
1517
## Returns
1618

17-
[ICommandItem[]](icommanditem.md)
19+
An [ICommandItem[]](icommanditem.md) array that contains the commands that should be shown in the Command Palette. The commands will be displayed in the order that they are returned by this method.

0 commit comments

Comments
 (0)