sp-dev-fx-webparts/samples/react-pnp-js-sample
Hugo Bernier c24aacbd7f Updated telemetry link 2023-03-12 21:16:15 -04:00
..
.devcontainer Added sample.json, container and test for new contributor list 2023-02-18 13:31:12 -05:00
assets Added sample.json, container and test for new contributor list 2023-02-18 13:31:12 -05:00
config Bug fix & dependency update 2022-08-29 21:25:12 +00:00
src Fixing Context Conditional in GetSP 2023-02-14 06:53:24 -07:00
teams New PnPjs v3 sample 2022-01-27 21:03:19 +00:00
.eslintrc.js Bug fix & dependency update 2022-08-29 21:25:12 +00:00
.gitignore Bug fix & dependency update 2022-08-29 21:25:12 +00:00
.npmignore New PnPjs v3 sample 2022-01-27 21:03:19 +00:00
.yo-rc.json Bug fix & dependency update 2022-08-29 21:25:12 +00:00
README.md Updated telemetry link 2023-03-12 21:16:15 -04:00
gulpfile.js Bug fix & dependency update 2022-08-29 21:25:12 +00:00
package-lock.json Bump decode-uri-component in /samples/react-pnp-js-sample 2022-12-30 23:33:19 -05:00
package.json Bug fix & dependency update 2022-08-29 21:25:12 +00:00
tsconfig.json Bug fix & dependency update 2022-08-29 21:25:12 +00:00

README.md

Using @pnp/js and ReactJS

Summary

This solution builds off of the solution react-async-await-sp-pnp-js submitted by Jose Quinto (@jquintozamora , blog.josequinto.com)

This implementation refactors to take aspects out and utilize and showcase PnPjs Version 3.

React-pnp-js-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.2 Node.js v14 | v12| v16 Compatible with SharePoint Online Incompatible with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Incompatible Hosted Workbench Compatible

For more information about SPFx compatibility, please refer to https://aka.ms/spfx-matrix

Applies to

Contributors

Julie Turner Beau Cameron
Julie Turner Beau Cameron

Version history

Version Date Comments
1.2 Feb 14, 2023 Fixed context handling
1.1 Aug 29, 2022 Bug fix & dependency updates
1.0 Jan 13, 2022 Initial release

Minimal Path to Awesome

  1. clone this repo
  2. npm i
  3. Update online workbench URL in the initialPage property of the config/serve.json file.
  4. gulp serve

Features

  • Establishing context for the SharePoint Factory Interface
  • Creating a project config file to centralize defining the PnPjs imports and SharePoint Queryable object for reuse.
  • Demo extending the SharePoint Queryables instance with the PnPLogging behavior.
  • Demo extending the SharePoint Queryable instance with the Caching behavior
  • Demo loading list items from a SharePoint library
  • Demo creating a batched instance of the SharePoint Queryable object.
  • Demo updating list items by modifying the Title property.
  • Demo executing a batch and working with the results.

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 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.