Skip to content

Commit 7e8f065

Browse files
committed
Updating docs for SPFx v1.15.2 release details
1 parent 3d5739e commit 7e8f065

File tree

5 files changed

+65
-50
lines changed

5 files changed

+65
-50
lines changed

docs/spfx/release-1.15.2.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: SharePoint Framework v1.15.2 release notes
33
description: Release notes for the SharePoint Framework v1.15.2 release
4-
ms.date: 08/02/2022
4+
ms.date: 08/09/2022
55
ms.localizationpriority: high
66
---
77
# SharePoint Framework v1.15.2 release notes
@@ -40,13 +40,22 @@ npm install @microsoft/generator-sharepoint@latest --global
4040
## New features and capabilities
4141

4242
### Enable Service Principal Registration at Permission Scope Approval Time
43-
When an SPFx solution requires access to APIs we allow administrators to pre-approve those permission scopes for the whole tenant in the "API Access" page in Tenant Admin.
4443

45-
However, previously we assumed and required that API to be already present in the tenant (either via an app principal or Service Principal in case of multi-tenant APIs) and, if that's not the case, we generated an error during the permissions scope approval.
44+
When a SPFx solution requires access to APIs, we allow administrators to pre-approve those permission scopes for the whole tenant in the "API Access" page in Tenant Admin.
45+
46+
Previously it was assumed and required that API to be already present in the tenant (either via an app principal or Service Principal in case of multi-tenant APIs) and, if that's not the case, there was an error during the permissions scope approval.
4647

4748
Now developers are able to specify **optional** attributes `appId` and `replyUrl` in `webApiPermissionRequests` section of `package-solution.json`.
4849

49-
### New Action types for media - General Availability.
50+
When these attributes are present, administartors are presented standard Azure AD app registration consent as part of the API approval process.
51+
52+
### New Action types for media - General Availability
53+
54+
Media upload action type is now generally available.
55+
56+
* [Media upload in Adaptive Card Extension](viva/get-started/actions/media-upload/MediaUploadDocumentation.md)
57+
* [Tutorial - Create an Adaptive Card Extension with the select media action](viva/get-started/actions/media-upload/MediaUploadTutorial.md)
58+
* [Explore Media Upload capability via property pane of card-designer card in Adaptive Card Extension](viva/get-started/actions/media-upload/MediaUploadPropertyPane.md)
5059

5160
```typescript
5261
ISPFxAdaptiveCard.actions?: (
@@ -60,6 +69,7 @@ ISPFxAdaptiveCard.actions?: (
6069
```
6170

6271
The ___location actions can be configured as shown below:
72+
6373
```typescript
6474
actions: [
6575
{
@@ -76,6 +86,7 @@ The ___location actions can be configured as shown below:
7686
```
7787

7888
The SelectMedia action can be configured as shown below:
89+
7990
```typescript
8091
actions: [
8192
{
@@ -89,21 +100,19 @@ The SelectMedia action can be configured as shown below:
89100

90101
The action will be rendered as below:
91102

92-
93103
![Select file button](../images/release-notes/114/file-action.jpg)
94104

95105
The Select Media Action can be used to select Images from your native device. In the browser it uses the file picker to help access relavant files:
96106

97107
![Select file panel](../images/release-notes/114/media-panel.jpg)
98108

99-
100109
### Updates to ESLint rules
101-
Based on received feedback, we "relaxed" applied ESLint rules to removed forced opinionated coding styles practices.
102-
Also, all the rules are added directly to the `eslintrc.js` file for simpler further modifications.
110+
111+
Based on the received feedback from the ecosystem, we "relaxed" applied ESLint rules to removed forced opinionated coding styles practices. These rules are now also added directly to the `eslintrc.js` file for simpler further modifications in environment level.
103112

104113
### Defer loading AdaptiveCardExtension Quick View
105-
When an ACE is loaded on a page we load both the card view and quick view. However, we don't need load the quick view until it is interacted with.
106-
By defer loading a quick view, we will gain performance when loading an ACE.
114+
115+
When an ACE is loaded on a page we load both the card view and quick view. However, we don't need load the quick view until it is interacted with. By defer loading a quick view, we will gain performance when loading an ACE.
107116

108117
Below is an example to defer load quick view.
109118

@@ -117,6 +126,7 @@ this.quickViewNavigator.register(
117126
).then((component) => new component.QuickView())
118127
);
119128
```
129+
120130
`this.quickViewNavigator.register` callback argument now allows to return a `Promise<TView>` or `TView` directly: `() => TView | Promise<TView>`
121131

122132
## Fixed Issues

docs/spfx/viva/get-started/actions/media-upload/MediaUploadDocumentation.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,37 @@
11
---
22
title: Media upload in Adaptive Card Extension
33
description: Media upload is a new action that the SharePoint Adaptive Card Extension framework supports, which enables third party developers to upload data content to sharepoint.
4-
ms.date: 07/20/2022
4+
ms.date: 08/09/2022
55
---
66
# Media upload in Adaptive Card Extension
77

88
> [!NOTE]
9-
> The media upload capability in Adaptive Card Extension will be available in SPFx v1.15.
9+
> The media upload capability in Adaptive Card Extension is available in SPFx v1.15.2.
1010
>
1111
> So make sure that you have installed it before proceeding further.
1212
>
13-
> For more information on installing the SPFx v1.15 Preview, see [SharePoint Framework v1.15 release notes](../../../../release-1.15.md).
13+
> For more information on installing the SPFx v1.15.2, see [SharePoint Framework v1.15.2 release notes](../../../../release-1.15.2.md).
1414
>
1515
> This tutorial also assumes that you have already built a SharePoint Adaptive Card Extension.
1616
>
1717
> To learn how to create your first SharePoint Adaptive Card Extension, try out [this tutorial](../../../get-started/build-first-sharepoint-adaptive-card-extension.md).
1818
19+
## Action type for media upload
1920

20-
### Action type for media upload
21+
### Select Media
2122

22-
#### Select Media
23-
24-
This allows users to upload media content via an ACE. The current size limitation is 1MB per image. A user may specify any image type to be uploaded. **Note**: _If an image type is not specified then an error indicating only images can be uploaded will show up._
23+
Allows users to upload media content via an Adaptice Card Extension (ACE). The current size limitation is 1 MB per image. A user may specify any image type to be uploaded. **Note**: _If an image type isn't specified, then an error indicating only images can be uploaded will show up._
2524

2625
The ACE action for Select Media is: `VivaAction.SelectMedia`.
2726

2827
The parameters that it takes are as follows:
2928

30-
- `mediaType`: This is set to image by default as audio is still under works.
31-
- `allowMultipleCapture` [OPTIONAL]: This enables multiple files to be added at once.
29+
- `mediaType`: Currently set as image by default. Audio option will be supported in future.
30+
- `allowMultipleCapture` [OPTIONAL]: Enables multiple files to be added at once.
3231
- This is enabled by default.
33-
- `maxSizePerFile` [OPTIONAL]: The limitation for the file size to be uploaded, suggested limitation is 1mb.
34-
- `supportedFileFormats` [OPTIONAL]: This is a space delimited format on allowed types. If none are supplied then standard image files are used for type checking.
35-
- Any file which is attempted to be upload that doesn't match the allowed type results in an error message stating: _This isn't a file type we support. You can only upload images._
32+
- `maxSizePerFile` [OPTIONAL]: The limitation for the file size to be uploaded, suggested limitation is 1 MB.
33+
- `supportedFileFormats` [OPTIONAL]: Space delimited format on allowed types. If none are supplied, then standard image files are used for type checking.
34+
- Any file that is attempted to be upload that doesn't match the allowed type results in an error message stating: _This isn't a file type we support. You can only upload images._
3635

3736
```typescript
3837
{
@@ -55,13 +54,13 @@ The parameters that it takes are as follows:
5554
}
5655
```
5756

58-
### Tutorial and Examples
57+
## Tutorial and Examples
5958

6059
You can take a look at [this tutorial](./MediaUploadTutorial.md) which goes over a step by step guide on how to create a card with the available media upload action.
6160

6261
1. **Upload an image**
6362

64-
In your template json file add the following action:
63+
In your template json file, add the following action:
6564

6665
```json
6766
"actions": [
@@ -78,7 +77,7 @@ You can take a look at [this tutorial](./MediaUploadTutorial.md) which goes over
7877

7978
1. **Upload multiple images**
8079

81-
In your template json file add the following action:
80+
In your template json file, add the following action:
8281

8382
```json
8483
"actions": [
@@ -96,7 +95,7 @@ You can take a look at [this tutorial](./MediaUploadTutorial.md) which goes over
9695

9796
1. **Upload only JPG images**
9897

99-
In your template json file add the following action:
98+
In your template json file, add the following action:
10099

101100
```json
102101
"actions": [
@@ -114,7 +113,7 @@ You can take a look at [this tutorial](./MediaUploadTutorial.md) which goes over
114113

115114
1. **Upload allow only small images to be uploaded**
116115

117-
In your template json file add the following action:
116+
In your template json file, add the following action:
118117

119118
```json
120119
"actions": [
@@ -130,14 +129,14 @@ You can take a look at [this tutorial](./MediaUploadTutorial.md) which goes over
130129
]
131130
```
132131

133-
### Access media upload action via card-designer card's property pane
132+
## Access media upload action via card-designer card's property pane
134133

135-
If you don't want to write up a new ACE but still wich to see the media upload in action, be sure to explore [this tutorial](./MediaUploadPropertyPane.md) which allows you to explore this through the property pane.
134+
If you don't want to write up a new ACE but still want to see the media upload in action, be sure to explore [this tutorial](./MediaUploadPropertyPane.md) which allows you to explore this through the property pane.
136135

137136
> [!NOTE]
138-
> The media upload action can be added on the card view, buttons ofthe card view, or inside the quick view itself.
137+
> The media upload action can be added on the card view, buttons of the card view, or inside the quick view itself.
139138

140-
### Availability of media upload action
139+
## Availability of media upload action
141140

142141
> [!NOTE]
143142
> Currently this feature is not supported in teams mobile and will throw an error indicating that this.

docs/spfx/viva/get-started/actions/media-upload/MediaUploadPropertyPane.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
title: Explore Media Upload capability via property pane of card-designer card in Adaptive Card Extension
3-
description: Media Upload is a new action that the SharePoint Adaptive Card Extension framework supports. In this tutorial we will see how we can explore this capability via the property pane of the card-designer card.
4-
ms.date: 07/21/2022
3+
description: Media Upload is a new action that the SharePoint Adaptive Card Extension framework supports. In this tutorial we'll see how we can explore this capability via the property pane of the card-designer card.
4+
ms.date: 08/09/2022
55
ms.localizationpriority: high
66
---
77

88
# Explore Media Upload capability via property pane of card-designer card in Adaptive Card Extension.
99

10-
In this tutorial we will see how we can explore this capability via the property pane of the card-designer card.
10+
In this tutorial we'll see how we can explore this capability via the property pane of the card-designer card.
1111

12-
We will:
12+
we'll:
1313

1414
- Update the card strings
1515
- Introduce media upload actions on the card view, primary button, and secondary button.
@@ -20,31 +20,31 @@ Here, click on the '+' icon in the middle of the page, and add the `card-designe
2020

2121
Next, click the pencil icon adjacent to this card to open the property pane.
2222

23-
### Update the card strings
23+
## Update the card strings
2424

2525
Here, first set the `Card size` to `Large`.
2626

2727
To provide descriptive labels, change `Title` to `Media Upload`, `Heading` to `Media Upload Demo` and `description` to `Demo Media Upload Actions`.
2828

2929
![Adding strings in the property pane of card designer card](./img/mediaUploadPropertyPaneStrings.PNG)
3030

31-
### Adding action on Card View
31+
## Adding action on Card View
3232

3333
Under `Actions`, click the drop-down menu of `Card action` and select `Select media` option. By default **Images** is the only media type to be captured.
3434

3535
Set the expected file formats as **png** and **jpg**.
3636

3737
![Set the on-click action to "Select Media" from the drop-down menu of card-view](./img/mediaUploadPropertyPaneCardAction.PNG)
3838

39-
### Adding action on Primary button
39+
## Adding action on Primary button
4040

4141
Next, for the `Primary Button`, set the `Title` to `Select single media` and from its action drop-down menu, select `Select Media`.
4242

4343
Ensure that `Allow Multiple Capture` is toggled off.
4444

4545
![Set the on-click action to "Select Media" from the drop-down menu for the primary button](./img//mediaUploadPropertyPanePrimaryButtonAction.PNG)
4646

47-
### Adding action on Secondary button
47+
## Adding action on Secondary button
4848

4949
Change the size of the card from Medium to Large.
5050

@@ -54,7 +54,7 @@ Finally, for the `Secondary Button`, set the `Title` to `Select multiple media`
5454

5555
![Set the on-click action to "Select Media" from the drop-down menu for the secondary button and enable multiple file uploading](./img/mediaUploadPropertyPaneSecondaryButtonAction.PNG)
5656

57-
### Try the Select Media action
57+
## Try the Select Media action
5858

5959
Now close the property pane and click `Preview` from the top right hand corner of the page:
6060

docs/spfx/viva/get-started/actions/media-upload/MediaUploadTutorial.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Create an Adpative Card Extension with the select media action
3-
description: Step by step guid on how to create an Adaptive Card Extension with the select media action.
2+
title: Create an Adaptive Card Extension with the select media action
3+
description: Step by step guide on how to create an Adaptive Card Extension with the select media action.
44
ms.date: 07/25/2022
55
ms.localizationpriority: high
66
---
@@ -43,21 +43,21 @@ When you use the gulp task **serve**, by default it will launch a browser with t
4343

4444
- Change the `enter-your-SharePoint-site` ___domain to the URL of your SharePoint tenant and site you want to use for testing. For example: `https://contoso.sharepoint.com/sites/devsite/_layouts/workbench.aspx`.
4545

46-
At this point, if you do `gulp serve`, then you will see the `MediaUpload` card:
46+
At this point, if you do `gulp serve`, then you'll see the `MediaUpload` card:
4747

4848
![See the MediaUpload card icon in the webpart toolbox](./img/mediaUploadTutorialACE.PNG)
4949

5050
## Add media upload action to your Adaptive Card Extension
5151

52-
At this point we have out of the box Adaptive Card Extension code. Now it's time to flare things up with selecting media from the Card and Quick views.
52+
At this point, we have out of the box Adaptive Card Extension code. Now it's time to flare things up with selecting media from the Card and Quick views.
5353

54-
In the Card View, we will provide a button which will perform the following actions:
54+
In the Card View, we'll provide a button that will perform the following actions:
5555

5656
- Upload an image file
5757

5858
### Update the labels that will show up on the card
5959

60-
Before we start adding the actions, let us first update the strings that you will see on the card.
60+
Before we start adding the actions, let us first update the strings that you'll see on the card.
6161

6262
For this, locate and open the following file in your project: **./src/adaptiveCardExtensions/mediaUpload/loc/en-us.js**
6363

@@ -89,7 +89,7 @@ to the `IMediaUploadAdaptiveCardExtensionStrings` interface.
8989

9090
### Add actions on the Card View
9191

92-
As mentioned earlier, on the Card View, we will add a button, which will allow the user to upload a png file when clicking the Card View.
92+
As mentioned earlier, on the Card View, we'll add a button, which will allow the user to upload a png file when clicking the Card View.
9393

9494
Locate and open the following file in your project: **./src/adaptiveCardExtensions/mediaUpload/cardView/CardView.ts**
9595

@@ -134,7 +134,7 @@ With the changes made so far, your Card View would look like:
134134

135135
### Add actions on the Quick View
136136

137-
In the Quick View, we will introduce buttons for 3 actions:
137+
In the Quick View, we will introduce buttons for three actions:
138138

139139
- Upload a png file
140140
- Upload a jpg file
@@ -192,7 +192,7 @@ After adding these actions, your Quick View would look like:
192192

193193
### Set up the state for our Adaptive Card Extension
194194

195-
So far we have created our Card View and Quick View. If you do a `gulp serve` at this point, then you will be able to perform the actions that were described above.
195+
So far we have created our Card View and Quick View. If you do a `gulp serve` at this point, then you'll be able to perform the actions that were described above.
196196

197197
But now, let us take it a notch higher.
198198

docs/toc.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -530,6 +530,8 @@
530530
href: spfx/viva/overview-viva-connections.md
531531
- name: Location capabilities in Adaptive Card Extension
532532
href: spfx/viva/get-started/actions/geolocation/GeolocationDocumentation.md
533+
- name: Media upload in Adaptive Card Extension
534+
href: spfx/viva/get-started/actions/media-upload/MediaUploadDocumentation.md
533535
- name: Design Guidance
534536
items:
535537
- name: Introduction
@@ -553,7 +555,11 @@
553555
- name: Create an Adaptive Card Extension with geolocation action
554556
href: spfx/viva/get-started/actions/geolocation/GeolocationTutorial.md
555557
- name: Geolocation capabilities with the property pane of an ACE
556-
href: spfx/viva/get-started/actions/geolocation/GeolocationPropertyPane.md
558+
href: spfx/viva/get-started/actions/geolocation/GeolocationPropertyPane.md
559+
- name: Create an Adpative Card Extension with the select media action
560+
href: spfx/viva/get-started/actions/media-upload/MediaUploadTutorial.md
561+
- name: Media Upload capability via property pane of an ACE
562+
href: spfx/viva/get-started/actions/media-upload/MediaUploadPropertyPane.md
557563
- name: Known issues
558564
href: spfx/viva/known-issues-adaptive-cards.md
559565
- name: Viva Connections Extensibility Learn module

0 commit comments

Comments
 (0)