honeymoose
/
sp-dev-fx-webparts
mirror of https://github.com/pnp/sp-dev-fx-webparts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
sp-dev-fx-webparts/samples/react-tour-pnpjs/README.md

4.4 KiB
Raw Blame History

Tour Sample

Summary

A SPFx web part using PnP/PnPjs, @pnp/spfx-property-controls and ReactTourJS. It allows to create a configurable tutorial/tour of a SharePoint modern page for adoption scope. When you start the tour, a modal will be displayed, with a description of the highlighted area, and you can go to the next step or go back, thus navigating inside the page. The user will see the descriptions and will have the opportunity to preview the advice that the publisher thought for him. The property pane shows dynamically all web parts in the current page, using PnP/PnPjs to make easy page tour configuration.

WebPartInAction

WebPartInAction

WebPartInAction

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

Applies to

Contributors

Version history

Version Date Comments
1.0 November 23, 2019 Initial release
1.1 March 20, 2024 Upgrade SPFx version

Minimal Path to Awesome

  • Clone this repository
  • in the command line run:
    • restore dependencies: npm install
    • build solution gulp build --ship
    • bundle solution: gulp bundle --ship
    • package solution: gulp package-solution --ship
    • locate solution at .\sharepoint\solution\react-tour-pnpjs.sppkg
    • upload it to your tenant app catalog
    • add react-tour-pnpjs app to your site
    • add react-tour-pnpjs web part to your page to see it in action

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

Features

This Web Part illustrates the following concepts on top of the SharePoint Framework:

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.