sp-dev-fx-webparts/samples/react-page-navigator/README.md

77 lines
5.0 KiB
Markdown
Raw Normal View History

2021-11-07 00:52:25 -04:00
# 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](./assets/PageNavigator.gif)
2021-10-31 14:29:33 -04:00
## Compatibility
2022-06-02 16:07:50 -04:00
![SPFx 1.14.0](https://img.shields.io/badge/SPFx-1.14.0-green.svg)
![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg)
2021-10-31 14:29:33 -04:00
![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg "SharePoint Server 2019 requires SPFx 1.4.1 or lower")
![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
![Local Workbench Incompatible](https://img.shields.io/badge/Local%20Workbench-Incompatible-red.svg "The solution requires access to the page structure")
2021-10-31 15:14:35 -04:00
![Hosted Workbench Partially](https://img.shields.io/badge/Hosted%20Workbench-Partially-yellow.svg "The solution needs to run on a hosted page to work as intended")
2022-02-14 02:52:18 -05:00
![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)
## 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
2022-06-02 16:07:50 -04:00
1.2|May, 2022|SPFx Upgraded to 1.14.0
2022-06-19 22:28:13 -04:00
1.3|June 9, 2022|Updated React package from `^16.14.0` to `16.13.1`
2022-06-29 23:25:35 -04:00
1.4|June 29, 2022|Adds the capability to find collapsible section headers and insert them into the navigation
2022-07-27 23:47:24 -04:00
1.5|July 19, 2022|Bug fixes
2022-08-17 08:15:33 -04:00
1.6|August 8, 2022|Add theme provider and bug fixes
2022-12-30 20:44:41 -05:00
1.7|December 22, 2022|Fixed issue with duplicated level 2 headings
2022-07-27 23:47:24 -04:00
## Minimal Path to Awesome
2022-06-02 16:07:50 -04:00
* Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-page-navigator) 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:
2022-06-19 22:28:13 -04:00
* `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
2022-06-19 22:28:13 -04:00
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit <https://aka.ms/spfx-devcontainer> for further instructions.
2022-02-14 02:52:18 -05:00
## Solution
Solution|Author(s)
--------|---------
2021-10-31 14:29:33 -04:00
react-page-navigator|[Aakash Bhardwaj](https://github.com/aakashbhardwaj619)
2022-06-19 22:28:13 -04:00
react-page-navigator|[Jasey Waegebaert](https://github.com/Jwaegebaert)
2021-10-31 14:29:33 -04:00
## Help
2022-08-21 18:58:07 -04:00
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.
2021-10-31 14:29:33 -04:00
2022-08-21 18:58:07 -04:00
If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-page-navigator%22) to see if anybody else is having the same issues.
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-page-navigator) and see what the community is saying.
If you encounter any issues using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-page-navigator&template=bug-report.yml&sample=react-page-navigator&authors=@aakashbhardwaj619&title=react-page-navigator%20-%20).
2021-10-31 14:29:33 -04:00
2021-11-20 23:55:10 -05:00
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-page-navigator&template=question.yml&sample=react-page-navigator&authors=@aakashbhardwaj619&title=react-page-navigator%20-%20).
2021-10-31 14:29:33 -04:00
2022-08-21 18:58:07 -04:00
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-page-navigator&template=suggestion.yml&sample=react-page-navigator&authors=@aakashbhardwaj619&title=react-page-navigator%20-%20).
2021-10-31 14:29:33 -04:00
2021-11-07 02:11:17 -05:00
## 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.**
2021-12-20 10:25:30 -05:00
<img src="https://pnptelemetry.azurewebsites.net/sp-dev-fx-webparts/samples/react-page-navigator" />