sp-dev-fx-webparts/samples/react-sp-pnp-js-property-de...
Hugo Bernier 7e97daab76 Added more contributions 2023-03-15 01:23:34 -04:00
..
.devcontainer
assets
config
src/webparts/customBusinessObjectsPnPJs
typings
.editorconfig
.gitattributes
.gitignore
.npmignore
.yo-rc.json
README.md
gulpfile.js
package.json
tsconfig.json
tslint.json

README.md

Using PnP JS Core custom objects with @select and @expand decorators

Summary

This web part demonstrates how to use PnP JS Core Custom Objects with @select and @expand TypeScript decorators. If you are going to use PnP JS Core library and you've plans for extending it with Custom Business Objects, then this project will show you some best practices. You can also find more information in the blog series about working with Custom Business Objects, Parsers and TypeScript Decorators in PnP JS Core

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.

This sample is designed to be used in the following environments:

SPFx 1.1.0 Node.js v6 Compatible with SharePoint Online Compatible SharePoint 2019 Compatible with SharePoint 2016 (Feature Pack 2) Local Workbench Compatible Hosted Workbench Compatible Compatible with Remote Containers

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

Applies to

Contributors

Version history

Version Date Comments
1.0 July 2, 2017 Initial release

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.

Minimal Path to Awesome

  • clone this repo
  • $ npm i
  • $ gulp trust-dev-cert
  • $ gulp serve

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

Local Mode

A browser in local mode (localhost) will be opened. https://localhost:4321/temp/workbench.html

SharePoint Mode

If you want to try on a real environment, open: https://your-domain.sharepoint.com/_layouts/15/workbench.aspx