sp-dev-fx-webparts/samples/react-pages-hierarchy

Pages Hierarchy

Summary

This web part allows users to create a faux page hierarchy in their pages library and use it for page-to-page navigation. It will ask you to create a page parent property on first use which is then used by the web part to either show a breadcrumb of the current pages ancestors or buttons for the pages children.

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.

Applies to

• SharePoint Framework
• Office 365 Developer Tenant

Prerequisites

• Office 365 subscription with SharePoint Online
• SharePoint Framework development environment set up

Contributors

• Bo George
• Nick Brown
• SlowRobot
• ruslan-s
• Tobias Maestrini

Version history

Version	Date	Comments
1.0	April 30, 2020	Initial release
1.2	March 24, 2022	Updated to SPFX v1.14 and PnP packages to v3
1.3	March 31, 2022	Added a Tree View
1.4	July 29, 2022	Updated Tree View Functionality
1.5	March 29, 2023	Added support for non-English SitePages library paths
1.6	May 11,2023	Uses treeFrom/expandTo web part properties
1.7	January 08	Updated to SPFX 1.18.2 + Node 18
1.8	October 13, 2024	Updated to SPFX 1.20.0

Minimal path to awesome

• Clone this repository* 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-pages-hierarchy, located under samples)* in the command line run:
  • npm install
  • gulp serve

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

Features

This web part isn't anything fancy but it's useful for some scenarios.

• Parent Page Property Creation - if the web part is added to a page and the Parent Page property does not exist the user will be asked to enable (create) it.
• Security - if the user editing the page/web part doesn't have 'Manage' permissions on the Pages library they will not get the enable button, instead a message telling them to get a site owner to do the enabling.
• Two page relationship views depending on the direction you want to show
  • Ancestors shows a breadcrumb view (including the current page) up to parent pages until the parent page property is not set.
  • Children shows a button view for all pages that have selected the current page as their parent.

Help

We do not support samples, but we 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 while 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.