sp-dev-fx-webparts/samples/react-realtime-documents

List subscription

Sample web part illustrating using the SharePoint Framework List subscription capability, which allows you to get notified of changes to documents in a SharePoint Document Library and refresh the displayed data.

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.

Applies to

• SharePoint Framework
• Office 365 developer tenant

Contributors

• Waldek Mastykarz

Version history

Version	Date	Comments
1.0	November 9, 2018	Initial release

Minimal Path to Awesome

• clone this repo
• change the working directory to the cloned repository
• in the command line execute:
  • npm install
  • gulp bundle --ship
  • gulp package-solution --ship
• from the sharepoint/solution folder, deploy the .sppkg file to the App catalog in your tenant
• in the site where you want to test this solution
  • ensure that you have a document library
  • add the web part to the page
  • in the web part properties, select the document library and apply the configuration
  • in the document library, add or update an existing document > web part should automatically update the list of documents

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

Features

This sample contains a SharePoint Framework client-side web part that illustrates the List subscription capability:

• subscribing to changes in SharePoint Document Libraries from a SharePoint Framework web part
• using PnPjs to communicate with the SharePoint REST API
• using PnP Reusable property pane controls for easily managing web part properties
• using PnP Reusable React controls for building rich web experiences

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.