Skip to content

Commit

Permalink
Added react-connected-web-parts sample
Browse files Browse the repository at this point in the history
  • Loading branch information
GuidoZam committed Mar 16, 2024
1 parent 0336f96 commit 38dbd37
Show file tree
Hide file tree
Showing 47 changed files with 32,295 additions and 0 deletions.
353 changes: 353 additions & 0 deletions samples/react-connected-web-parts/.eslintrc.js

Large diffs are not rendered by default.

34 changes: 34 additions & 0 deletions samples/react-connected-web-parts/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Logs
logs
*.log
npm-debug.log*

# Dependency directories
node_modules

# Build generated files
dist
lib
release
solution
temp
*.sppkg
.heft

# Coverage directory used by tools like istanbul
coverage

# OSX
.DS_Store

# Visual Studio files
.ntvs_analysis.dat
.vs
bin
obj

# Resx Generated Code
*.resx.ts

# Styles Generated Code
*.scss.ts
16 changes: 16 additions & 0 deletions samples/react-connected-web-parts/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
!dist
config

gulpfile.js

release
src
temp

tsconfig.json
tslint.json

*.log

.yo-rc.json
.vscode
1 change: 1 addition & 0 deletions samples/react-connected-web-parts/.nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v18.17.1
21 changes: 21 additions & 0 deletions samples/react-connected-web-parts/.yo-rc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"@microsoft/generator-sharepoint": {
"plusBeta": false,
"isCreatingSolution": false,
"nodeVersion": "18.17.1",
"sdksVersions": {
"@microsoft/microsoft-graph-client": "3.0.2",
"@microsoft/teams-js": "2.12.0"
},
"version": "1.18.2",
"libraryName": "connected-web-parts",
"libraryId": "9548bb33-c24b-4601-af93-8edd4334e657",
"environment": "spo",
"packageManager": "npm",
"solutionName": "connected-web-parts",
"solutionShortDescription": "connected-web-parts description",
"skipFeatureDeployment": true,
"isDomainIsolated": false,
"componentType": "webpart"
}
}
210 changes: 210 additions & 0 deletions samples/react-connected-web-parts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,210 @@
# connected-web-parts

## Summary

This samples showcase how to connect two web parts together.

![Connected web parts](./assets/connected-web-parts.gif)

![Blank web parts](./assets/Blank.png)

![Filled web parts](./assets/Filled.png)

![Filled web parts](./assets/PropertyPane.png)

## Compatibility

| :warning: Important |
|:---------------------------|
| Every SPFx version is optimally compatible with specific versions of Node.js. In order to be able to build this sample, you need to ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.|
|Refer to <https://aka.ms/spfx-matrix> for more information on SPFx compatibility. |

This sample is optimally compatible with the following environment configuration:

![SPFx 1.18.2](https://img.shields.io/badge/SPFx-1.18.2-green.svg)
![Node.js v16 | v18](https://img.shields.io/badge/Node.js-v16%20%7C%20v18-green.svg)
![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg "SharePoint Server 2019 requires SPFx 1.4.1 or lower")
![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
![Local Workbench Unsupported](https://img.shields.io/badge/Local%20Workbench-Unsupported-red.svg "Local workbench is no longer available as of SPFx 1.13 and above")
![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg)
![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)

## Used SharePoint Framework Version

![version](https://img.shields.io/badge/version-1.18.2-green.svg)

## Applies to

* [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [Microsoft 365 tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)

> Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram)

## Contributors
<!--
We use this section to recognize and promote your contributions. Please provide one author per line -- even if you worked together on it.
We'll only use the info you provided here. Make sure to include your full name, not just your GitHub username.
Provide a link to your GitHub profile to help others find more cool things you have done. The only link we'll accept is a link to your GitHub profile.
If you want to provide links to your social media, blog, and employer name, make sure to update your GitHub profile.
-->

* [Guido Zambarda](https://github.com/guidozam)

## Version history

Version|Date|Comments
-------|----|--------
|1.0|March 16, 2024|Initial release|

## Prerequisites

<!--
Any special pre-requisites? Include any lists, permissions, offerings to the demo gods, or whatever else needs to be done for this web part to work.
Please describe the steps to configure the pre-requisites. Feel free to add screen shots, but make sure that there is a text description of the steps to perform.
-->
## Minimal path to awesome

* Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-connected-web-parts) then unzip it)
* From your command line, change your current directory to the directory containing this sample (`react-connected-web-parts`, located under `samples`)
* in the command line run:
* `npm install`
* `gulp serve`

> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit <https://aka.ms/spfx-devcontainer> for further instructions.
## Features

This sample illustrates how to use the `IDynamicDataCallables` interface to connect two web parts together. The first web part is a provider, and the second web part is a consumer. The provider has no configuration in the property pane, the consumer instead has properties in the property pane that allow the user to select the provider web part and the specific property to bind.

The `IDynamicDataCallables` interface define the methods that the provider web part must implement to expose its properties to the consumer web part.

One of the required methods in the provider web part is the following:

```typescript
public getPropertyDefinitions(): ReadonlyArray<IDynamicDataPropertyDefinition> {
return [
{
id: Constants.FirstNamePropertyId,
title: strings.FirstName,
},
{
id: Constants.LastNamePropertyId,
title: strings.LastName,
},
{
id: Constants.PreferencesPropertyId,
title: strings.Preferences,
},
];
}
```
This define the properties that the provider web part exposes to the consumer web part.

The other method that the provider web part must implement is the following:

```typescript
public getPropertyValue(propertyId: string): string | IPreferences {
switch (propertyId) {
case Constants.FirstNamePropertyId:
return this._firstName;
case Constants.LastNamePropertyId:
return this._lastName;
case Constants.PreferencesPropertyId:
return this._preferences;
}
throw new Error(strings.BadPropertyId);
}
```
This method returns the value of the property identified by the `propertyId` parameter.

In the provider web part the properties are updated by the user through the UI, and the consumer web part is automatically updated with the new values, to enable the automatic update the provider web part must call the `notifyPropertyChanged` method every time a property is updated, for example the following code is called every time the first name is updated:

```typescript
private _firstNameChanged = (firstName: string): void => {
this._firstName = firstName;
// notify subscribers that the first name has changed
this.context.dynamicDataSourceManager.notifyPropertyChanged(
Constants.FirstNamePropertyId
);
};
```

The consumer web part's properties that needs to be connected to the provider web part must be defined in the property pane using the `PropertyPaneDynamicField` as the following:

```typescript
PropertyPaneDynamicField("firstName", {
label: strings.FirstName,
})
```

In the consumer web part's properties the dynamic properties must be specified as the following:

```typescript
firstName: DynamicProperty<string>;
```

The last step to display the value of the connected property in the consumer web part control is to use the property as the following:

```typescript
const firstNameValue = this.props.firstName?.tryGetValue();
```

<!--
RESERVED FOR REPO MAINTAINERS

We'll add the video from the community call recording here

## Video

[![YouTube video title](./assets/video-thumbnail.jpg)](https://www.youtube.com/watch?v=XXXXX "YouTube video title")
-->

## Help

<!--
You can just search and replace this page with the following values:

Search for:
react-connected-web-parts

Replace with your sample folder name. E.g.: react-my-cool-sample

Search for:
@YOURGITHUBUSERNAME

Replace with your GitHub username, prefixed with an "@". If you have more than one author, use %20 to separate them, making sure to prefix everyone's username individually with an "@".

Example:
@hugoabernier

Or:
@hugoabernier%20@VesaJuvonen%20@PopWarner
-->

We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-connected-web-parts%22) to see if anybody else is having the same issues.

You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-connected-web-parts) and see what the community is saying.

If you encounter any issues using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-connected-web-parts&template=bug-report.yml&sample=react-connected-web-parts&authors=@guidozam&title=react-connected-web-parts%20-%20).

For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-connected-web-parts&template=question.yml&sample=react-connected-web-parts&authors=@guidozam&title=react-connected-web-parts%20-%20).

Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-connected-web-parts&template=suggestion.yml&sample=react-connected-web-parts&authors=@guidozam&title=react-connected-web-parts%20-%20).

## Disclaimer

**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**

<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-connected-web-parts" />
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
82 changes: 82 additions & 0 deletions samples/react-connected-web-parts/assets/sample.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
[
{
"name": "pnp-sp-dev-spfx-web-parts-react-connected-web-parts",
"source": "pnp",
"title": "React Connected web parts",
"shortDescription": "This samples showcase how to connect two web parts together.",
"url": "https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-connected-web-parts",
"longDescription": [
"This samples showcase how to connect two web parts together using the property pane specifying the IDynamicDataCallables interface in the provider web part and the PropertyPaneDynamicField in the consumer web part."
],
"creationDateTime": "2024-03-16",
"updateDateTime": "2024-03-16",
"products": ["SharePoint"],
"metadata": [
{
"key": "CLIENT-SIDE-DEV",
"value": "React"
},
{
"key": "SPFX-VERSION",
"value": "1.18.2"
}
],
"thumbnails": [
{
"type": "image",
"order": 100,
"url": "https://github.com/pnp/sp-dev-fx-webparts/blob/main/samples/react-connected-web-parts/assets/connected-web-parts.gif?raw=true",
"alt": "Connected web parts"
},
{
"type": "image",
"order": 101,
"url": "https://github.com/pnp/sp-dev-fx-webparts/blob/main/samples/react-connected-web-parts/assets/Blank.png?raw=true",
"alt": "Empty connected web parts"
},
{
"type": "image",
"order": 102,
"url": "https://github.com/pnp/sp-dev-fx-webparts/blob/main/samples/react-connected-web-parts/assets/Filled.png?raw=true",
"alt": "Filled in connected web parts"
},
{
"type": "image",
"order": 103,
"url": "https://github.com/pnp/sp-dev-fx-webparts/blob/main/samples/react-connected-web-parts/assets/PropertyPane.png?raw=true",
"alt": "Connected web parts property pane"
}
],
"authors": [
{
"gitHubAccount": "guidozam",
"company": "PiaSys",
"pictureUrl": "https://github.com/guidozam.png",
"name": "Guido Zambarda",
"twitter": "iamguidozam"
}
],
"references": [
{
"name": "Build your first SharePoint client-side web part",
"description": "Client-side web parts are client-side components that run in the context of a SharePoint page. Client-side web parts can be deployed to SharePoint environments that support the SharePoint Framework. You can also use modern JavaScript web frameworks, tools, and libraries to build them.",
"url": "https://learn.microsoft.com/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part"
},
{
"name": "Integrate web part properties with SharePoint",
"description": "Learn how to integrate web part properties with SharePoint.",
"url": "https://learn.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/guidance/integrate-web-part-properties-with-sharepoint"
},
{
"name": "Make your SharePoint client-side web part configurable",
"description": "Learn how to make your SharePoint client-side web part configurable.",
"url": "https://learn.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/basics/integrate-with-property-pane"
},
{
"name": "Connect SharePoint Framework components using dynamic data",
"description": "Learn how to connect SharePoint Framework components using dynamic data.",
"url": "https://learn.microsoft.com/en-us/sharepoint/dev/spfx/dynamic-data"
}
]
}
]
27 changes: 27 additions & 0 deletions samples/react-connected-web-parts/config/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/config.2.0.schema.json",
"version": "2.0",
"bundles": {
"source-web-part": {
"components": [
{
"entrypoint": "./lib/webparts/source/SourceWebPart.js",
"manifest": "./src/webparts/source/SourceWebPart.manifest.json"
}
]
},
"target-web-part": {
"components": [
{
"entrypoint": "./lib/webparts/target/TargetWebPart.js",
"manifest": "./src/webparts/target/TargetWebPart.manifest.json"
}
]
}
},
"externals": {},
"localizedResources": {
"SourceWebPartStrings": "lib/webparts/source/loc/{locale}.js",
"TargetWebPartStrings": "lib/webparts/target/loc/{locale}.js"
}
}
Loading

0 comments on commit 38dbd37

Please sign in to comment.