Skip to content

Commit 56ce834

Browse files
committed
adding docs to TOC and fixing formatting
1 parent fe06b36 commit 56ce834

File tree

5 files changed

+69
-42
lines changed

5 files changed

+69
-42
lines changed

docs/spfx/release-1.17.md

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,23 @@
11
---
2-
title: SharePoint Framework v1.17 preview release notes
3-
description: Release notes for the SharePoint Framework v1.17 preview release
4-
ms.date: 03/28/2023
2+
title: SharePoint Framework v1.17 release notes
3+
description: Release notes for the SharePoint Framework v1.17 release
4+
ms.date: 04/04/2023
55
ms.localizationpriority: high
66
---
77
# SharePoint Framework v1.17 preview release notes
88

99
This release introduces updates across the features around Microsoft Viva, Microsoft Teams, Outlook, Office, and SharePoint.
1010

11-
[!INCLUDE [spfx-release-beta](../../includes/snippets/spfx-release-beta.md)]
12-
13-
- rc.1 **Released:** March 28, 2023
14-
- beta.3 **Released:** March 21, 2023
15-
- beta.1 **Released:** February 23, 2023
11+
**Released:** April 4, 2023
1612

1713
[!INCLUDE [spfx-release-notes-common](../../includes/snippets/spfx-release-notes-common.md)]
1814

1915
## Install the latest preview version
2016

21-
Install the latest preview release of the SharePoint Framework (SPFx) by including the **@next**
17+
Install the latest release of the SharePoint Framework (SPFx) by including the **@latest**
2218

2319
```console
24-
npm install @microsoft/generator-sharepoint@next --global
20+
npm install @microsoft/generator-sharepoint@latest --global
2521
```
2622

2723
## Upgrading projects from v1.16.1 to v1.17
@@ -33,16 +29,26 @@ npm install @microsoft/generator-sharepoint@next --global
3329
npm uninstall @microsoft/{spfx-package-name}@1.16.1
3430
```
3531

36-
2. Install the new v1.16 package:
32+
2. Install the new v1.17 package:
3733

3834
```console
39-
npm install @microsoft/{spfx-package-name}@next --save --save-exact
35+
npm install @microsoft/{spfx-package-name}@latest --save --save-exact
4036
```
4137

4238
[!INCLUDE [spfx-release-upgrade-tip](../../includes/snippets/spfx-release-upgrade-tip.md)]
4339

4440
## New features and capabilities
4541

42+
* Updates and improvements on building Microsoft 365 wide experiences with **Microsoft Teams apps build with SharePoint Framework** – This model enables you to build auto-hosted apps in Microsoft 365, which are extended across Microsoft Teams, Outlook and Office 365 app (office.com). Any Microsoft Teams app build with SharePoint Framework is automatically now compliant with the requirements to get the app exposed across Microsoft 365.
43+
* Updates and improvements on the **Microsoft Viva extensibility build with SharePoint Framework**.
44+
* General availability of the **top actions for custom web parts in SharePoint**.
45+
* **Authentication improvements** with popup flow support for API authentication.
46+
* **Accessibility improvements** for the web part areas.
47+
* **Development time improvements** with central configuration of developer tenant details.
48+
* **Microsoft Teams JS SDK** version update to version **2.19.1** to support new APIs, such as Live Share SDK.
49+
* *“Sync to Teams”* functionality in SharePoint app catalog update to use **Teams Manifest v1.16** for the automatically created Microsoft Teams solution package – making all SPFx components exposed across the Microsoft 365 also with automatically generated packaging
50+
* Viva Connections **Adaptive Cards Extensions** update to support **Adaptive Cards schema v1.5.** - enabling tables and other new features for ACEs
51+
4652
### Teams JS SDK v2.9.1 support
4753

4854
[Microsoft Teams JS SDK](https://learn.microsoft.com/en-us/javascript/api/overview/msteams-client?view=msteams-client-js-latest&tabs=npm) was bumped to v2.9.1 to support new API, such as `LiveShare`.
@@ -63,7 +69,11 @@ Developers can use the `SPFX_SERVE_TENANT_DOMAIN` OS environment variable to spe
6369

6470
In previous versions, web part Top Actions' configuration was based on proxied property pane types. It led to some issues and confusion as not all the properties worked or were supported.
6571

66-
This version includes specific Top Actions-specific types to avoid confusion and make the configuration more clearer.
72+
This version includes specific Top Actions-specific types to avoid confusion and make the configuration more clear.
73+
74+
See more details from documentation
75+
76+
* [Adding support for Top Actions for web parts](web-parts/guidance/getting-started-with-top-actions.md)
6777

6878
### onBeforeAction handler for Adaptive Card Extensions
6979

@@ -86,6 +96,11 @@ New `focusParameters` virtual property allows to set focus when the view is rend
8696
get focusParameters(): IFocusParameters | undefined;
8797
```
8898

99+
See more details from documentation
100+
101+
* [Focus feature in Adaptive Card Extension](viva/features/focus-feature/FocusFeatureDocumentation.md)
102+
* [Create an Adaptive Card Extension with the focus feature](viva/features/focus-feature/FocusFeatureTutorial.md)
103+
89104
### Support for SharePoint Pages 'iframing' in Teams applications
90105

91106
Developers can specify `supportsSelfFramingInTeams` flag in a web part's manifest if the scenario requires the web part to render SharePoint page in an `<iframe>`.
@@ -132,13 +147,15 @@ interface IPropertyPaneLinkProps {
132147

133148
## Deprecations
134149

150+
-
151+
135152
## Fixed Issues
136153

137154
Here's a list of specific issues fixed around SharePoint Framework since the previous public release.
138155

139156
### February-March Timeframe
140157

141-
- [#8705](https://github.com/SharePoint/sp-dev-docs/issues/8705) - LiveShare SDK doesn't work in SPFx web part
158+
- [#8705](https://github.com/SharePoint/sp-dev-docs/issues/8705) - Live Share SDK doesn't work in SPFx web part
142159

143160
### December-February Time Frame
144161

docs/spfx/viva/features/focus-feature/FocusFeatureDocumentation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Focus feature in Adaptive Card Extension
3-
description: The focus feature allows 3P developers to determine focus of elements in the Quick View.
4-
ms.date: 03/15/2023
3+
description: The focus feature allows developers to determine focus of elements in the Quick View.
4+
ms.date: 04/04/2023
55
---
66
# Focus feature in Adaptive Card Extension
77

@@ -14,7 +14,7 @@ Microsoft added support for the focus feature, unique to Viva Connections, in th
1414
1515
## Focus Feature
1616

17-
Just like the way that developers can set a template and data via get data() and get template(), users will be able to hook into a new getter method that will allow them the flexibility to pass in an initial focus element on each render. If there is no implementation provided on the developers end, then a focus on the first tab-able element will be set.
17+
Just like the way that developers can set a template and data via `get data()` and `get template()`, users will be able to hook into a new getter method that will allow them the flexibility to pass in an initial focus element on each render. If implementation isn't provided by developer, then a focus on the first tab-able element will be set.
1818

1919
```typescript
2020
/**
@@ -53,7 +53,7 @@ This new function allows developers to customize what the focus element is by re
5353

5454
## Tutorial and Examples
5555

56-
You can take a look at [this tutorial](./FocusFeatureTutorial.md) which goes over a step by step guide on how to create a card with the available media upload action.
56+
You can take a look at [this tutorial](./FocusFeatureTutorial.md), which goes over a step by step guide on how to create a card with the available media upload action.
5757

5858
1. **Read target information after once user is idle**
5959

docs/spfx/viva/features/focus-feature/FocusFeatureTutorial.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Create an Adaptive Card Extension with the focus feature
33
description: Step by step guide on how to create an Adaptive Card Extension with the focus feature.
4-
ms.date: 03/15/2023
4+
ms.date: 04/04/2023
55
ms.localizationpriority: high
66
---
77
# Create an Adaptive Card Extension with focus feature
@@ -83,14 +83,14 @@ At this point, if you do `gulp serve`, then you'll see the `FocusFeature` card:
8383

8484
At this point, we have out of the box Adaptive Card Extension code. Now it's time to flare things up with focusing on elements in the Quick view.
8585

86-
In the Quick View, we will introduce buttons for two actions:
86+
In the Quick View, we'll introduce buttons for two actions:
8787

8888
- Move to the next quick view
8989
- Move to the previous quick view
9090

91-
We will first define the template of the Quick View. For this, locate and open the following file in your project: **./src/adaptiveCardExtensions/focusFeature/quickView/template/QuickViewTemplate.json**
91+
We'll first define the template of the Quick View. For this, locate and open the following file in your project: **./src/adaptiveCardExtensions/focusFeature/quickView/template/QuickViewTemplate.json**
9292

93-
Replace the content of this file with the following:
93+
Replace the content of this file as below:
9494

9595
```json
9696
{
@@ -151,7 +151,7 @@ Replace the content of this file with the following:
151151
}
152152
```
153153

154-
Next let's implement the logic that will allow us to navigate to the next quick view. We will leverage the QuickViewNavigator to manipulate the view stack.
154+
Next let's implement the logic that will allow us to navigate to the next quick view. We'll use the QuickViewNavigator to manipulate the view stack.
155155

156156
```typescript
157157
public onAction(action: IActionArguments): void {
@@ -219,7 +219,7 @@ Create a new template file for the second quick view: **./src/adaptiveCardExtens
219219
```
220220

221221
Create a new file for the second quick view: **./src/adaptiveCardExtensions/focusFeature/quickView/QuickView2.ts**
222-
We will add the following **onAction** function.
222+
We'll add the following **onAction** function.
223223

224224
```typescript
225225
public onAction(action: IActionArguments): void {
@@ -273,7 +273,7 @@ Create a new template file for the third quick view: **./src/adaptiveCardExtensi
273273
```
274274

275275
Create a new file for the third quick view: **./src/adaptiveCardExtensions/focusFeature/quickView/QuickView3.ts**
276-
We will add the following **onAction** function.
276+
We'll add the following **onAction** function.
277277

278278
```typescript
279279
public onAction(action: IActionArguments): void {
@@ -289,12 +289,18 @@ public onAction(action: IActionArguments): void {
289289
After adding these changes, your Quick Views will look like:
290290

291291
![Card appearance after introducing changes in the first quick-view](./img/focusFeatureFirstView.png)
292+
293+
Second quick view as
294+
292295
![Card appearance after introducing changes in the second quick-view](./img/focusFeatureSecondView.png)
296+
297+
Third quick view as
298+
293299
![Card appearance after introducing changes in the third quick-view](./img/focusFeatureThirdView.png)
294300

295301
### Implement the focusParameters function
296302

297-
So far we have modified our quick views to have a simple title, subtitle, and respective buttons to navigate to other quick views. Now we can finally implement the `focusParameters` function, which gives the ability to the Third Party Developer to decide what they wish to set focus on in the quick view.
303+
So far we'e modified our quick views to have a simple title, subtitle, and respective buttons to navigate to other quick views. Now we can finally implement the `focusParameters` function, which gives the ability to the Third Party Developer to decide what they wish to set focus on in the quick view.
298304

299305
For this, open each respective QuickView file (**./src/adaptiveCardExtensions/focusFeature/quickView/QuickView.ts**) and import the `IFocusParameters` interface, as follows:
300306

@@ -321,7 +327,7 @@ This is it! Congratulations on successfully creating you Adaptive Card Extension
321327

322328
## Notes with screen readers
323329

324-
When loading your card for the first time, you will notice that the contents of the first quick view are read in their entirety. This is the default behaviour when a screen reader sees a dialog as it treats it as navigation. Subsequent loads of the quick view stack will not run into this. As you navigate back and forth threw quick views, you will notice that the element target is focused and will be the only thing to be read.
330+
When loading your card for the first time, you'll notice that the contents of the first quick view are read in their entirety. This is the default behavior when a screen reader sees a dialog as it treats it as navigation. Subsequent loads of the quick view stack won't run into this. As you navigate back and forth threw quick views, you'll notice that the element target is focused and will be the only thing to be read.
325331

326332
## See Also
327333

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

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
---
2-
title: Adding support for Top Actions
2+
title: Adding support for web part Top Actions
33
description: Top Actions is a SharePoint Framework feature that allows web part developers to add commands to a web part's toolbar
4-
ms.date: 11/15/2022
4+
ms.date: 04/04/2023
55
ms.localizationpriority: high
66
---
77

8-
# Adding support for Top Actions
8+
# Adding support for web part Top Actions
99

10-
[!INCLUDE [spfx-release-beta](../../../../includes/snippets/spfx-release-beta.md)]
11-
12-
Today, users need to be aware of the web part property panels to find out the additional options each web part provides. This is a common piece of feedback where users want actions surfacing in context of where they are without having to rely on opening something to get to those options. Therefore, we are now allowing to surface most common configurations from a web part's property panel directly on to the web part's toolbar. These common configurations are referred to as the web part's Top Actions.
10+
Top actions provide an alternative and more end user friendlier way to expose the different options and configuration capabilities for web parts in edit mode. You can use top actions to surface most common configurations from the web part property panel directly in web part toolbar, which is exposed when the page is edited.
1311

1412
![Top Actions Example](../../../images/webpart-top-actions.png)
1513

@@ -20,7 +18,7 @@ Today, users need to be aware of the web part property panels to find out the ad
2018
2119
### Define your Top Action configurations
2220

23-
In the example below we are defining the callback function that will be used to pull the configurations for our Top Action commands.
21+
The example below defines the callback function that will be used to pull the configurations for our Top Action commands.
2422

2523
> [!NOTE]
2624
> `getTopActionsConfiguration` must be defined as public on your web part's class.
@@ -38,10 +36,10 @@ public getTopActionsConfiguration(): ITopActions | undefined {
3836

3937
### Define your toolbar's user interface
4038

41-
The `topActions` array is an ordered list of controls to render in the web part toolbar. In the example below we are defining one top action as a button interface.
39+
The `topActions` array is an ordered list of controls to render in the web part toolbar. The example below defines one top action as a button interface.
4240

4341
```typescript
44-
import { PropertyPaneFieldType } from '@microsoft/sp-property-pane';
42+
import { ITopActions, TopActionsFieldType } from '@microsoft/sp-top-actions';
4543

4644
return {
4745
topActions: [
@@ -50,7 +48,7 @@ return {
5048
properties: {
5149
icon: 'Reset'
5250
},
53-
type: PropertyPaneFieldType.Button
51+
type: TopActionsFieldType.Button
5452
}
5553
]
5654
...
@@ -59,7 +57,7 @@ return {
5957

6058
### Execute the command when the user interacts
6159

62-
The previous step demonstrated how to get a button to display in the web part's toolbar. Now we will perform an action when the user selects the button. Note that `actionName` was defined as `targetProperty` in the last step and since this is a button we can ignore the `newValue` that comes in.
60+
The previous step demonstrated how to get a button to display in the web part's toolbar. This step shows how to perform an action when the user selects the button. `actionName` was defined as `targetProperty` in the last step and since this is a button that can ignore the `newValue` that comes in.
6361

6462
```typescript
6563
return {
@@ -80,7 +78,7 @@ return {
8078

8179
### Button command
8280

83-
The type interace for a button is similar to the property panel's button (`IPropertyPaneButtonProps`).
81+
The type interface for a button is similar to the property panel's button (`IPropertyPaneButtonProps`).
8482

8583
```typescript
8684
import { ITopActions, TopActionsFieldType } from '@microsoft/sp-top-actions';
@@ -153,7 +151,7 @@ public getTopActionsConfiguration(): ITopActions | undefined {
153151

154152
## Advanced configurations
155153

156-
For advanced configurations of your top action commands, checkout the type definitions from `@microsoft/sp-top-actions`.
154+
For advanced configurations of your top action commands, see the type definitions from `@microsoft/sp-top-actions`.
157155

158156

159157
```typescript

docs/toc.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,8 @@
195195
href: spfx/web-parts/basics/determine-web-part-width.md
196196
- name: Support section backgrounds
197197
href: spfx/web-parts/guidance/supporting-section-backgrounds.md
198+
- name: Web part top actions
199+
href: spfx/web-parts/guidance/getting-started-with-top-actions.md
198200
- name: Isolated web parts
199201
href: spfx/web-parts/isolated-web-parts.md
200202
- name: Single Part App Pages
@@ -544,6 +546,8 @@
544546
href: spfx/viva/get-started/actions/geolocation/GeolocationDocumentation.md
545547
- name: Media upload in Adaptive Card Extension
546548
href: spfx/viva/get-started/actions/media-upload/MediaUploadDocumentation.md
549+
- name: Focus feature in Adaptive Card Extension
550+
href: spfx/viva/features/focus-feature/FocusFeatureDocumentation.md
547551
- name: Design Guidance
548552
items:
549553
- name: Introduction
@@ -572,6 +576,8 @@
572576
href: spfx/viva/get-started/actions/media-upload/MediaUploadTutorial.md
573577
- name: Media Upload capability via property pane of an ACE
574578
href: spfx/viva/get-started/actions/media-upload/MediaUploadPropertyPane.md
579+
- name: Using focus feature in an ACE
580+
href: spfx/viva/features/focus-feature/FocusFeatureTutorial.md
575581
- name: Known issues
576582
href: spfx/viva/known-issues-adaptive-cards.md
577583
- name: Extend Viva Connections Learning Path
@@ -2073,6 +2079,8 @@
20732079
href: apis/sharepoint-rest-graph.md
20742080
- name: Application Lifecycle Management (ALM) APIs
20752081
href: apis/alm-api-for-spfx-add-ins.md
2082+
- name: SharePoint Add-in Management APIs
2083+
href: apis/addin-management-apis.md
20762084
- name: Microsoft 365 Copy and Move API
20772085
href: apis/spod-copy-move-api.md
20782086
- name: SharePoint Migration Guidance
@@ -2130,8 +2138,6 @@
21302138
href: /dotnet/api/?term=Officedevpnp
21312139
- name: PnP Sites Core API reference - Extension methods
21322140
href: /dotnet/api/?term=microsoft.sharepoint
2133-
- name: SharePoint Add-in Management APIs
2134-
href: apis/addin-management-apis.md
21352141
- name: SharePoint schema reference
21362142
href: schema/schema-reference-for-sharepoint.md
21372143
items:

0 commit comments

Comments
 (0)