sp-dev-fx-webparts/samples/react-ppp-pnp-controls
Hugo Bernier 4d56d63006
Merge pull request #4899 from pnp/dependabot/npm_and_yarn/samples/react-ppp-pnp-controls/follow-redirects-1.15.6
2024-03-25 22:04:46 -04:00
..
.devcontainer Added container and sample.json 2022-03-28 00:14:56 -04:00
.vscode Add 'samples/react-ppp-pnp-controls/' from commit 'b1105e2c434bc5a5514761f5094ea324c84261a0' 2022-03-20 21:42:11 -07:00
assets Changed docs links to learn 2022-10-24 09:42:45 -04:00
config Add 'samples/react-ppp-pnp-controls/' from commit 'b1105e2c434bc5a5514761f5094ea324c84261a0' 2022-03-20 21:42:11 -07:00
src Add 'samples/react-ppp-pnp-controls/' from commit 'b1105e2c434bc5a5514761f5094ea324c84261a0' 2022-03-20 21:42:11 -07:00
teams Add 'samples/react-ppp-pnp-controls/' from commit 'b1105e2c434bc5a5514761f5094ea324c84261a0' 2022-03-20 21:42:11 -07:00
.gitignore Added container and sample.json 2022-03-28 00:14:56 -04:00
.npmignore Add 'samples/react-ppp-pnp-controls/' from commit 'b1105e2c434bc5a5514761f5094ea324c84261a0' 2022-03-20 21:42:11 -07:00
.yo-rc.json Add 'samples/react-ppp-pnp-controls/' from commit 'b1105e2c434bc5a5514761f5094ea324c84261a0' 2022-03-20 21:42:11 -07:00
README.md Updated links to devprogram 2024-02-06 11:16:44 -05:00
gulpfile.js Add 'samples/react-ppp-pnp-controls/' from commit 'b1105e2c434bc5a5514761f5094ea324c84261a0' 2022-03-20 21:42:11 -07:00
package-lock.json Merge pull request #4899 from pnp/dependabot/npm_and_yarn/samples/react-ppp-pnp-controls/follow-redirects-1.15.6 2024-03-25 22:04:46 -04:00
package.json Bump postcss and @microsoft/sp-build-web 2023-10-10 16:25:08 +00:00
tsconfig.json Add 'samples/react-ppp-pnp-controls/' from commit 'b1105e2c434bc5a5514761f5094ea324c84261a0' 2022-03-20 21:42:11 -07:00
tslint.json Add 'samples/react-ppp-pnp-controls/' from commit 'b1105e2c434bc5a5514761f5094ea324c84261a0' 2022-03-20 21:42:11 -07:00

README.md

https://aka.ms/m365/devprogramhttps://aka.ms/m365/devprogramhttps://aka.ms/m365/devprogramhttps://aka.ms/m365/devprogram# Property Pane Portal PnP Controls

Summary

The React-PPP-PnP-Controls sample showcases the use of the Property Pane Portal to display the PnP SPFx React controls (version 3.7.0) in the SPFx Property Pane.

We are NOT using the SPFx Property Controls, that's the point of the sample.

React-PPP-PnP-Controls-Sample

Compatibility

⚠️ Important
Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please 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.

SPFx 1.15 Node.js v14 | v12 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Unsupported Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Get your own free development tenant by subscribing to Microsoft 365 developer program

Contributors

Version history

Version Date Comments
0.1.0 March 20, 2022

Minimal Path to Awesome

  • Clone this repository (or download this solution as a .ZIP file then unzip it)
  • From your command line, change your current directory to the directory containing this sample (react-ppp-pnp-controls, located under samples)
  • in the command line run:
    • npm install
    • gulp serve

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

Features

This sample showcases the use of the Property Pane Portal NPM module. It allows us to use PnP SPFx React controls in the Property Pane, without the need to build custom property controls.

The Property Pane Portal module includes:

  • The PropertyPaneHost function, which creates placeholders in the Property Pane
  • The PropertyPanePortal component, which leverages React Portals to teleport React components to the Property Pane.

Implemented controls:

  • Location Picker
  • People Picker
  • List Picker and List Item Picker (cascading selection)

Known Issues

There are a couple minor issues with the Location Picker of the SPFx React Controls library. I am working with the authors to get them addressed in the next release. In the meantime, be aware that:

  • the control will overflow its container width if the address is too long
  • the control doesn't work on the root site

References

Help

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 from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues while using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

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.