sp-dev-fx-webparts/samples/react-realtime-documents
Hugo Bernier 7ed51a0838 Updated sample JSON 2021-03-15 03:48:14 -04:00
..
assets Updated sample JSON 2021-03-15 03:48:14 -04:00
config Added the real-time documents sample (#670) 2018-11-09 09:43:33 +02:00
src Added the real-time documents sample (#670) 2018-11-09 09:43:33 +02:00
teams Added the real-time documents sample (#670) 2018-11-09 09:43:33 +02:00
.editorconfig Added the real-time documents sample (#670) 2018-11-09 09:43:33 +02:00
.gitignore Added the real-time documents sample (#670) 2018-11-09 09:43:33 +02:00
.yo-rc.json Added the real-time documents sample (#670) 2018-11-09 09:43:33 +02:00
README.md URL dev.office.com to docs.microsoft.com 2020-06-09 09:09:22 +02:00
gulpfile.js Added the real-time documents sample (#670) 2018-11-09 09:43:33 +02:00
package-lock.json Added the real-time documents sample (#670) 2018-11-09 09:43:33 +02:00
package.json Added the real-time documents sample (#670) 2018-11-09 09:43:33 +02:00
tsconfig.json Added the real-time documents sample (#670) 2018-11-09 09:43:33 +02:00
tslint.json Added the real-time documents sample (#670) 2018-11-09 09:43:33 +02:00

README.md

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.

Web parts placed on a modern SharePoint page showing information about documents

Used SharePoint Framework Version

drop

Applies to

Solution

Solution Author(s)
react-realtime-documents Waldek Mastykarz (MVP, Rencore, @waldekm)

Version history

Version Date Comments
1.0 November 9, 2018 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
  • 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

Features

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