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

# React 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)

## Used SharePoint Framework Version

![version](https://img.shields.io/badge/version-1.9.1-green.svg)

## Version history

Version|Date|Comments
-------|----|--------
1.0|September 5, 2019|Initial release

## Minimal Path to Awesome

- git clone the repo
- 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

## Solution

Solution|Author(s)
--------|---------
react-page-navigator|Aakash Bhardwaj

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

<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-page-navigator" />
React Page Navigator webpart to display page header tags in Nav component 2019-09-05 13:49:19 -04:00			`# React 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)`

			`## Used SharePoint Framework Version`

			`![version](https://img.shields.io/badge/version-1.9.1-green.svg)`

Added telemetry image and version history. 2019-09-08 06:58:32 -04:00			`## Version history`

			`Version\|Date\|Comments`
			`-------\|----\|--------`
			`1.0\|September 5, 2019\|Initial release`

React Page Navigator webpart to display page header tags in Nav component 2019-09-05 13:49:19 -04:00			`## Minimal Path to Awesome`

			`- git clone the repo`
			`- npm i`
			`- gulp bundle --ship`
			`- gulp package-solution --ship`
Updated steps for Site Collection App Catalog 2019-09-08 07:50:35 -04:00			`- Add the app package to Site Collection App Catalog and Install the App`
			`- Add the web part to a page in the Site Collection`
React Page Navigator webpart to display page header tags in Nav component 2019-09-05 13:49:19 -04:00
			`## Solution`

			`Solution\|Author(s)`
			`--------\|---------`
			`react-page-navigator\|Aakash Bhardwaj`

			`## 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.**`

Added telemetry image and version history. 2019-09-08 06:58:32 -04:00			`<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-page-navigator" />`