Skip to content

Commit 6b4398f

Browse files
committed
SPFx 1.20 release notes
1 parent fcd544e commit 6b4398f

File tree

5 files changed

+128
-70
lines changed

5 files changed

+128
-70
lines changed
Loading
Loading

docs/spfx/release-1.20.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
title: SharePoint Framework v1.20 preview release notes
3+
description: Release notes for the SharePoint Framework v1.20 preview release.
4+
ms.date: 08/20/2024
5+
ms.localizationpriority: high
6+
---
7+
# SharePoint Framework v1.19 release notes
8+
9+
This release focuses primarely on the new features within the [Microsoft Viva Connections](./viva/overview-viva-connections.md) side with two key new capabilities: new data visualization options for Card Views and HTML Quick View option for Viva Connections Quick Views.
10+
11+
[!INCLUDE spfx-release-beta]
12+
13+
beta.0 **Released:** August 20, 2024
14+
15+
[!INCLUDE [spfx-release-notes-common](../../includes/snippets/spfx-release-notes-common.md)]
16+
17+
## Install the preview version
18+
19+
Install the preview release of the SharePoint Framework (SPFx) by using the **@next** tag
20+
21+
```console
22+
npm install @microsoft/generator-sharepoint@next --global
23+
```
24+
25+
## Upgrading projects from the SPFx v1.19 to v1.20 preview version
26+
27+
In the project's **package.json** file, identify all SPFx v1.19 packages. For each SPFx package:
28+
29+
1. Uninstall the existing v1.19 package:
30+
31+
```console
32+
npm uninstall @microsoft/{spfx-package-name}@1.19
33+
```
34+
35+
1. Install the new v1.20 preview package:
36+
37+
```console
38+
npm install @microsoft/{spfx-package-name}@1.20.0-beta.0 --save --save-exact
39+
```
40+
41+
[!INCLUDE [spfx-release-upgrade-tip](../../includes/snippets/spfx-release-upgrade-tip.md)]
42+
43+
## New features and capabilities
44+
45+
### New Data Visualization Card options for Viva Connections
46+
47+
As part of the 1.19 release, we provided new line chart card layout option and with the 1.20, we are introducing three new data visualization options: bar chart, pie chart and donat chart.
48+
49+
![Sample chart card layouts](../images/120-release-notes/chart-cards-options.png)
50+
51+
Related updated documentation for the SPFx v1.20 release:
52+
53+
- **[Create a Data Visualization Adaptive Card Extension](viva/get-started/build-data-visualization-adaptive-card-extension.md)** (tutorial): Step-by-step guide on creating Data Visualization Adaptive Card Extension - updated with the 1.20 release details
54+
- **[Introduction to new data visualization components for Viva Connections](https://www.youtube.com/watch?v=zBLEEF6cC7I)** (video) - This video focuses on the creation of ACE data visualization cards with SPFx and also showcases the future plans within this area. Example charts are also demonstrated in the context of example Viva Connections experience.
55+
56+
New sample showcasing the new data visualization options for ACEs:
57+
58+
- **[Chart Card - Data Visualization Options](https://github.com/pnp/sp-dev-fx-aces/tree/main/samples/ChartCard-DataVisualizationOptions)**: Baseline example of the data visualization card rendering options, which was introduced as part of the SPFx 1.20 release.
59+
60+
### HTML Quick View support for Viva Connections cards
61+
62+
With the 1.20 version, we are introducing new option to use HTML to render the Viva Connection Adaptive Card Extension quick views. This will enable more advance user experiences and you can use whatever suitable JavaScript extensibility model (React etc.) in your quick view experiences.
63+
64+
You can start using this option by updating your quick view implementation to be inherited from xxx class, which will be automatically detected by the underlaying platform.
65+
66+
Out-of-the-box OneDrive (files) card is using this rendering option as a reference point.
67+
68+
![Sample chart card layouts](../images/120-release-notes/html-quick-views.png)
69+
70+
Related updated documentation for the SPFx v1.20 release:
71+
72+
- **HTML based quick views**: Conceptual documentation for the HTML Quick views - coming soon
73+
- **Creating your first HTML based quick view** (tutorial): Step-by-step guide on creating an ACE with the a custom HTML quick view - coming soon
74+
- **[Introduction to new data visualization components for Viva Connections](https://www.youtube.com/watch?v=DaRoCFNtFrY)** (video) - This video focuses on the creation of ACE data visualization cards with SPFx and also showcases the future plans within this area. Example charts are also demonstrated in the context of example Viva Connections experience.
75+
76+
New sample showcasing the new data visualization options for ACEs:
77+
78+
- **[Basic Card - HTML Quick View](https://github.com/pnp/sp-dev-fx-aces/tree/main/samples/BasicCard-HTML-QuickView)**: Baseline example of the data visualization card rendering options, which was introduced as part of the SPFx 1.20 release.
79+
80+
## Deprecations
81+
82+
No new updates.
83+
84+
## Fixed Issues
85+
86+
No new updates.
87+
88+
## Feedback and issues
89+
90+
We're interested on your feedback around the release. Do let us know any findings or other feedback using the [SPFx issue list](https://github.com/SharePoint/sp-dev-docs/issues).
91+
92+
Happy coding! Sharing is caring! 🧡

docs/spfx/viva/get-started/build-data-visualization-adaptive-card-extension.md

Lines changed: 36 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Create a Data Visualization Adaptive Card Extension
33
description: Step-by-step guide on creating Data Visualization Adaptive Card Extension.
4-
ms.date: 07/19/2024
4+
ms.date: 08/19/2024
55
ms.localizationpriority: high
66
---
77
# Create a Data Visualization Adaptive Card Extension
@@ -11,6 +11,9 @@ The [SharePoint Framework v1.19](../../release-1.19.md) introduces a new Data Vi
1111
> [!NOTE]
1212
> Before you start, complete the procedures in the following articles to ensure that you understand the basic flow of creating a custom Adaptive Card Extension: [Build your first SharePoint Adaptive Card Extension](./build-first-sharepoint-adaptive-card-extension.md)
1313
14+
> [!IMPORTANT]
15+
> Line chart data visualization type was released as part of the [SPFx 1.19 release](../../release-1.19.md). Other data visualization types are released as part of the [SPFx 1.20 release](../../release-1.20.md).
16+
1417
## Scaffold an Adaptive Card Extension project
1518

1619
Create a new project directory for your project and change your current folder to that directory.
@@ -30,7 +33,7 @@ When prompted, enter the following values (select the default option for all oth
3033

3134
At this point, Yeoman installs the required dependencies and scaffolds the solution files. This process might take few minutes.
3235

33-
Next, run **gulp serve** from the command line in the root of the project. Select the add icon in the hosted workbench to open the toolbox, you'll see the **Data Visualization** card:
36+
Next, run **gulp serve** from the command line in the root of the project. Select the **add** icon in the hosted workbench to open the toolbox, you see the **Data Visualization** card:
3437

3538
![See the Data Visualization card icon in the workbench toolbox](../../../../docs/images/viva-extensibility/data-visualization/toolbox.png)
3639

@@ -83,7 +86,7 @@ Adding zero or one component along with a `dataVisualization` component in the b
8386

8487
#### Right side
8588

86-
Adding more than one component in the card view along with `dataVisualization` component in the body will render the chart on the right side of the card. For example: Header and Footer along with `dataVisualization` component in body.
89+
Adding more than one component in the card view along with `dataVisualization` component in the body renders the chart on the right side of the card. For example: Header and Footer along with `dataVisualization` component in body.
8790

8891
Locate & replace the `cardViewParameters()` getter with the following code to add a `header` and `footer` to the card:
8992

@@ -132,7 +135,7 @@ The ACE class is located in the following file: **./src/adaptiveCardExtensions/d
132135

133136
## Support for multiple data series in the chart
134137

135-
The ACE `dataVisualization` component supports multiple series lines in the chart. To add multiple lines to the chart, add additional entries to the `body.series` array on the `LineChartCardView` object in the card view.
138+
The ACE `dataVisualization` component supports multiple series lines in the chart. To add multiple lines to the chart, add other entries to the `body.series` array on the `LineChartCardView` object in the card view.
136139

137140
For example, consider the following data series:
138141

@@ -210,87 +213,47 @@ export class CardView extends BaseComponentsCardView<
210213
}
211214
```
212215

213-
This card when in the large mode will generate the following rendering:
216+
This card when in the large mode generates the following rendering:
214217

215218
![Chart with three series displayed](../../../../docs/images/viva-extensibility/data-visualization/chart-three-series.png)
216219

217-
## Support for additional chart types
218-
The SharePoint Framework v1.20 introduces support for newer chart types, enabling developers to create visually appealing data visualizations like bar, pie and donut charts. This section provides an example of each of them.
220+
## Support for more chart types
221+
222+
The [SharePoint Framework v1.20](../../release-1.20.md) introduces support for newer chart types, enabling developers to create visually appealing data visualizations like bar, pie, and donut charts. This section provides an example of each of them.
219223

220224
### Bar Chart
225+
221226
To render a vertically grouped bar chart, follow this example:
227+
222228
```typescript
223229
// Sample Data
224230
const seriesData: IDataPoint<string>[] = [
225-
{
226-
x: "Jan",
227-
y: 12986
228-
},
229-
{
230-
x: "Feb",
231-
y: 13424
232-
},
233-
{
234-
x: "Mar",
235-
y: 17118
236-
},
237-
{
238-
x: "Apr",
239-
y: 14017
240-
},
241-
{
242-
x: "May",
243-
y: 11245
244-
}
231+
{ x: "Jan", y: 12986 },
232+
{ x: "Feb", y: 13424 },
233+
{ x: "Mar", y: 17118 },
234+
{ x: "Apr", y: 14017 },
235+
{ x: "May", y: 11245 }
245236
];
246237

247238
const seriesData2: IDataPoint<string>[] = [
248-
{
249-
x: "Jan",
250-
y: 19631
251-
},
252-
{
253-
x: "Feb",
254-
y: 19905
255-
},
256-
{
257-
x: "Mar",
258-
y: 17098
259-
},
260-
{
261-
x: "Apr",
262-
y: 11918
263-
},
264-
{
265-
x: "May",
266-
y: 10357
267-
}
239+
{ x: "Jan", y: 19631},
240+
{ x: "Feb", y: 19905},
241+
{ x: "Mar", y: 17098},
242+
{ x: "Apr", y: 11918},
243+
{ x: "May", y: 10357}
268244
];
269245

270246
const seriesData3: IDataPoint<string>[] = [
271-
{
272-
x: "Jan",
273-
y: 19762
274-
},
275-
{
276-
x: "Feb",
277-
y: 12926
278-
},
279-
{
280-
x: "Mar",
281-
y: 17670
282-
},
283-
{
284-
x: "Apr",
285-
y: 19055
286-
},
287-
{
288-
x: "May",
289-
y: 18142
290-
}
247+
{ x: "Jan", y: 19762},
248+
{ x: "Feb", y: 12926},
249+
{ x: "Mar", y: 17670},
250+
{ x: "Apr", y: 19055},
251+
{ x: "May", y: 18142}
291252
];
292253
```
254+
293255
Add all three series to the data visualization card view and optionally set the name or color of the individual series:
256+
294257
```typescript
295258
export class CardView extends BaseComponentsCardView<
296259
IDataVisualizationAdaptiveCardExtensionProps,
@@ -321,11 +284,14 @@ export class CardView extends BaseComponentsCardView<
321284
}
322285
}
323286
```
287+
324288
The rendered bar chart looks something like this:
325289
![Vertically grouped bar chart](../../../../docs/images/viva-extensibility/data-visualization/bar-chart.png)
326290

327291
### Pie/Donut Charts
328-
Here is an example of the CardView.ts file that renders a Pie chart with the given data:
292+
293+
Here's an example of the CardView.ts file that renders a Pie chart with the given data:
294+
329295
```typescript
330296
import {
331297
BaseComponentsCardView,
@@ -371,7 +337,8 @@ export class CardView extends BaseComponentsCardView<
371337
}
372338
}
373339
```
374-
Notice how the `dataVisualizationKind` is set to `pie` and `PieChartCardView` is returned with the required parameters. Upon refreshing the card on the workbench, you will see that a pie chart is rendered:
340+
341+
Notice how the `dataVisualizationKind` is set to `pie` and `PieChartCardView` is returned with the required parameters. Upon refreshing the card on the workbench, you see that a pie chart is rendered:
375342
![Pie chart example](../../../../docs/images/viva-extensibility/data-visualization/pie-chart.png)
376343

377344
The `isDonut` flag indicates if the pie chart should be rendered as a donut chart, which is `false` by default. When set to true, the donut chart is rendered as follows:

sp-dev-docs

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)