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-page-navigator
History
Hugo Bernier 58cfc621e4 Updated readme and devcontainer 2024-10-12 15:56:53 -04:00
..
.devcontainer Updated readme and devcontainer 2024-10-12 15:56:53 -04:00
assets Updated readme and devcontainer 2024-10-12 15:56:53 -04:00
config change package description and bump version number 2024-10-06 15:29:48 +02:00
src fix linting errors 2024-10-06 12:07:51 +02:00
teams React Page Navigator webpart to display page header tags in Nav component 2019-09-05 23:19:19 +05:30
tools React Page Navigator webpart to display page header tags in Nav component 2019-09-05 23:19:19 +05:30
.eslintrc.js change eslint definition 2024-10-05 01:39:23 +02:00
.gitignore update several modules and dependencies 2024-10-05 01:39:07 +02:00
.npmignore Processing #2721 2022-06-02 16:07:50 -04:00
.nvmrc change README and bump node version newly added .nvmrc file 2024-10-06 15:16:07 +02:00
.yo-rc.json update several modules and dependencies 2024-10-05 01:39:07 +02:00
README.md Updated readme and devcontainer 2024-10-12 15:56:53 -04:00
gulpfile.js Processing #2721 2022-06-02 16:07:50 -04:00
junit.xml fix test packages and dependencies according to new spfx v1.20.0 2024-10-06 12:07:37 +02:00
package-lock.json generate new module dependencies 2024-10-06 13:04:05 +02:00
package.json change package description and bump version number 2024-10-06 15:29:48 +02:00
tsconfig.json fix test packages and dependencies according to new spfx v1.20.0 2024-10-06 12:07:37 +02:00

README.md

Page Navigator

Summary

This web part fetches all the automatically added header anchor tags in a SharePoint page and displays them in a navigation component.

When added to a vertical section it can be used as a contents table for the page:

Page Navigator

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

Version history

Version Date Comments
1.0 September 5, 2019 Initial release
1.1 October 20, 2021 SPFx Upgraded to 1.12.1 and code refactored
1.2 May, 2022 SPFx Upgraded to 1.14.0
1.3 June 9, 2022 Updated React package from ^16.14.0 to 16.13.1
1.4 June 29, 2022 Adds the capability to find collapsible section headers and insert them into the navigation
1.5 July 19, 2022 Bug fixes
1.6 August 8, 2022 Add theme provider and bug fixes
1.7 December 22, 2022 Fixed issue with duplicated level 2 headings
1.8 May 13, 2023 Fixed issue when heading has a + symbol
1.9 October 6, 2024 SPFx Upgraded to 1.20.0 and code refactored

Minimal Path to Awesome

  • Clone this repository (or download this solution as a .ZIP file then unzip it)
  • From your command line, change your current directory to the directory containing this sample (react-page-navigator, located under samples)
  • in the command line run:
    • npm i
    • gulp bundle --ship
    • gulp package-solution --ship
  • Add the app package to Site Collection App Catalog and Install the App
  • Add the web part to a page in the Site Collection

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

Contributors

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 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.