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
History
Hugo Bernier 7202809a7d Changed docs links to learn 2022-10-24 09:42:45 -04:00
..
.devcontainer Added spfx 1.9.1 containers 2022-02-15 23:34:24 -05:00
.vscode SPFX Tour sample WebPart - react-tour-pnpjs (#1082) 2019-12-09 11:06:36 +02:00
assets Changed docs links to learn 2022-10-24 09:42:45 -04:00
config SPFX Tour sample WebPart - react-tour-pnpjs (#1082) 2019-12-09 11:06:36 +02:00
src displaying the web part order as well to assist with selecting the correct part to highlight in the tour 2022-04-06 09:38:53 -04:00
teams SPFX Tour sample WebPart - react-tour-pnpjs (#1082) 2019-12-09 11:06:36 +02:00
.editorconfig SPFX Tour sample WebPart - react-tour-pnpjs (#1082) 2019-12-09 11:06:36 +02:00
.gitignore Updated sample.json 2022-04-11 02:12:02 +00:00
.yo-rc.json SPFX Tour sample WebPart - react-tour-pnpjs (#1082) 2019-12-09 11:06:36 +02:00
README.md Changed docs links to learn 2022-10-24 09:42:45 -04:00
gulpfile.js SPFX Tour sample WebPart - react-tour-pnpjs (#1082) 2019-12-09 11:06:36 +02:00
package-lock.json SPFX Tour sample WebPart - react-tour-pnpjs (#1082) 2019-12-09 11:06:36 +02:00
package.json SPFX Tour sample WebPart - react-tour-pnpjs (#1082) 2019-12-09 11:06:36 +02:00
tsconfig.json SPFX Tour sample WebPart - react-tour-pnpjs (#1082) 2019-12-09 11:06:36 +02:00
tslint.json SPFX Tour sample WebPart - react-tour-pnpjs (#1082) 2019-12-09 11:06:36 +02:00

README.md

react-tour-pnpjs - SharePoint modern page tutorial: SPFx Tour sample Web Part.

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 dinamically all webparts in the current page, using PnP/PnPjs to make easy page tour configuration.

react-tour-pnpjs in action

WebPartInAction

react-tour-pnpjs tour configuration property

WebPartInAction

react-tour-pnpjs configurations

WebPartInAction

Compatibility

SPFx 1.9.1 Node.js v10 | v8 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

Solution

Solution Author(s)
react-tour-pnpjs Federico Porceddu

Version history

Version Date Comments
1.0 November 23, 2019 Initial release

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.