History

Hugo Bernier 411f1b1eca Changed authors to contributors		2023-02-18 22:58:44 -05:00
..
.devcontainer	Added all 1.12.1 and 1.13 containers	2022-02-14 02:52:18 -05:00
assets	Updated sample.json	2023-02-03 22:32:31 -05:00
config	Added some unit tests for navLinkBuilder	2022-12-22 16:25:25 +01:00
src	(#3425 ) fixed nesting of Headers	2023-01-20 14:25:42 +00: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
.gitignore	react-page-nav SPFx upgrade and code refactoring	2021-10-20 10:40:41 +05:30
.node-version	Added some unit tests for navLinkBuilder	2022-12-22 16:25:25 +01:00
.npmignore	Processing #2721	2022-06-02 16:07:50 -04:00
.yo-rc.json	Processing #2721	2022-06-02 16:07:50 -04:00
README.md	Changed authors to contributors	2023-02-18 22:58:44 -05:00
gulpfile.js	Processing #2721	2022-06-02 16:07:50 -04:00
package-lock.json	Bump decode-uri-component in /samples/react-page-navigator	2022-12-30 23:40:28 -05:00
package.json	Update React package	2022-06-09 15:40:38 +02:00
tsconfig.json	Processing #2721	2022-06-02 16:07:50 -04:00
tslint.json	react-page-nav SPFx upgrade and code refactoring	2021-10-20 10:40:41 +05:30

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

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.

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

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.