sp-dev-fx-webparts/samples/react-pnp-controls
Hugo Bernier 411f1b1eca Changed authors to contributors 2023-02-18 22:58:44 -05:00
..
assets Removed office product from sample.json 2022-03-28 10:22:43 -04:00
config Moved sample to match naming convention 2021-10-30 16:13:08 -04:00
src Moved sample to match naming convention 2021-10-30 16:13:08 -04:00
teams Moved sample to match naming convention 2021-10-30 16:13:08 -04:00
typings Moved sample to match naming convention 2021-10-30 16:13:08 -04:00
.editorconfig Moved sample to match naming convention 2021-10-30 16:13:08 -04:00
.gitignore Moved sample to match naming convention 2021-10-30 16:13:08 -04:00
.yo-rc.json Moved sample to match naming convention 2021-10-30 16:13:08 -04:00
README.md Changed authors to contributors 2023-02-18 22:58:44 -05:00
gulpfile.js Moved sample to match naming convention 2021-10-30 16:13:08 -04:00
package.json Moved sample to match naming convention 2021-10-30 16:13:08 -04:00
tsconfig.json Moved sample to match naming convention 2021-10-30 16:13:08 -04:00
tslint.json Moved sample to match naming convention 2021-10-30 16:13:08 -04:00

README.md

page_type products languages extensions
sample
office-sp
javascript
typescript
contentType technologies platforms createdDate
samples
SharePoint Framework
react
10/1/2017 12:00:00 AM

SharePoint Framework PnP Controls Sample

Summary

This is a sample project that contains a web part which makes use of the PnP SPFx Controls:

Web part outcome

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.11 Node.js v10 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Teams Incompatible Local Workbench Incompatible Hosted Workbench Compatible Compatible with Remote Containers

Which PnP SPFx controls are being used in this sample?

The sample makes use of the following controls:

  • PropertyFieldListPicker
  • PropertyFieldTermPicker
  • Placeholder
  • ListView (which also uses the FileTypeIcon control)

Applies to

Contributors

Version history

Version Date Comments
1.0.1 September 20, 2017 Initial release
1.0.2 March 03, 2018 Update to 1.4.1
1.0.3 December 16, 2020 Update to 1.11.0

Minimal Path to Awesome

To test out this web part, you need to have a library with a managed metadata field. In my case, I made use of a field called Country.

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

Documents

Once you have such a library in place, you can copy the code and run the following commands:

npm install
gulp serve --nobrowser

Help

We do not support samples, but we 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.

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.