Skip to content

Commit 5910ebe

Browse files
committed
PR comment
1 parent ad85478 commit 5910ebe

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/spfx/web-parts/guidance/getting-started-with-top-actions.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,22 @@ public getTopActionsConfiguration(): ITopActions | undefined {
146146
```
147147

148148
## Advanced configurations
149-
For advanced configurations of your top action commands, checkout the type definitions from `@microsoft/sp-property-pane`. Currently, the two supported topActions, button and drop down, can be defined using the same structure as `IPropertyPaneChoiceGroupOption` and `IPropertyPaneButtonProps`. From here you can see how to use features like icons, aria labels, disable state, and more.
149+
For advanced configurations of your top action commands, checkout the type definitions from `@microsoft/sp-property-pane` and `@microsoft/sp-top-actions`. Currently, the two supported top action commands, button and drop down, can be defined using a subset of the types `IPropertyPaneChoiceGroupOption` and `IPropertyPaneButtonProps`. From here you can see how to use features like icons, aria labels, disable state, and more.
150+
151+
For `IPropertyPaneButtonProps`, currently supported properties are `icon`, `text`, `ariaLabel`, `disabled`
152+
153+
For `IPropertyPaneChoiceGroupOption`, currently supported porperty is `options` and from that array we support `key`, `text`, `iconProps.officeFabricIconFontName`, `imageSize`, `checked`, `title`
154+
155+
> [!WARNING]
156+
> The APIs used for Top Actions are subject to change as the feature graduates to stable status.
150157
151158
```typescript
152159
import { IPropertyPaneButtonProps, IPropertyPaneChoiceGroupOption } from '@microsoft/sp-property-pane'
160+
import { ITopActions } from '@microsoft/sp-top-actions';
153161
```
162+
### See more
163+
[Top Actions API](/javascript/api/sp-top-actions)
164+
165+
[IPropertyPaneButtonProps](/javascript/api/sp-webpart-base/ipropertypanebuttonprops)
166+
167+
[IPropertyPaneChoiceGroupOption](/javascript/api/sp-webpart-base/ipropertypanechoicegroupoption)

0 commit comments

Comments
 (0)