sp-dev-fx-webparts/samples/react-display-hierarchy
Hugo Bernier ac499de720 Added devcontainer, updated sample 2024-07-14 22:13:25 -04:00
..
.devcontainer Added devcontainer, updated sample 2024-07-14 22:13:25 -04:00
assets Added devcontainer, updated sample 2024-07-14 22:13:25 -04:00
config Upgrade to 1.18.2 2024-07-01 12:48:48 +00:00
sharepoint/assets added react-display-hierarchy (#673) 2018-11-12 10:50:47 +02:00
src Resolved warnings 2024-07-01 13:11:17 +00:00
teams Upgraded solution to SPFx v1.11.0 and use pnp/sp 2020-11-21 17:48:27 +00:00
.editorconfig added react-display-hierarchy (#673) 2018-11-12 10:50:47 +02:00
.eslintrc.js Upgrade to 1.18.2 2024-07-01 12:48:48 +00:00
.gitignore Upgrade to 1.18.2 2024-07-01 12:48:48 +00:00
.npmignore Upgrade to 1.18.2 2024-07-01 12:48:48 +00:00
.nvmrc Added nvmrc 2024-07-01 12:57:18 +00:00
.yo-rc.json Upgrade to 1.18.2 2024-07-01 12:48:48 +00:00
README.md Added devcontainer, updated sample 2024-07-14 22:13:25 -04:00
gulpfile.js Upgrade to 1.18.2 2024-07-01 12:48:48 +00:00
package-lock.json Added devcontainer, updated sample 2024-07-14 22:13:25 -04:00
package.json Upgrade to 1.18.2 2024-07-01 12:48:48 +00:00
tsconfig.json Upgrade to 1.18.2 2024-07-01 12:48:48 +00:00

README.md

Displaying hierarchical information from SharePoint list

Summary

At the time of developing this sample, the Office 365 UI fabric does not have any control for displaying hierarchical information. This web part helps to display the hierarchical information from SharePoint list.

Web part preview

When added to SharePoint site, the source list containing hierarchical information can be configured from web part properties.

The sample also provisions the list called “Hierarchy” which can be used as an example to start using the web part.

SharePoint Run

SharePoint Asset

A SharePoint list (named Hierarchy) is provisioned to store the hierarchical data. The schema of the list is as below.

List Schema

The Parent column is a lookup on same lists Title column.

The solution also provisions sample data to the Hierarchy list.

List Sample Data

NPM Packages Used

Below NPM packages are used to develop this sample.

  1. @pnp/sp (https://pnp.github.io/pnpjs/)
  2. react-orgchart (https://www.npmjs.com/package/react-orgchart)
  3. array-to-tree (https://www.npmjs.com/package/array-to-tree)

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

Applies to

Contributors

Version history

Version Date Comments
3.0.0 July 01, 2024 Upgraded to SPFx v1.18.2 (Nanddeep Nachan, Smita Nachan)
2.0.0 November 21, 2020 Upgraded to SPFx v1.11.0 (Nanddeep Nachan)
1.0.0 October 15, 2018 Initial release

Prerequisites

  • SharePoint Online tenant
  • Site Collection created under the /sites/ or /

Minimal Path to Awesome

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

Features

This sample web part shows how data stored in SharePoint list can be transformed to show hierarchical information

  • Rendering hierarchical information
  • SharePoint assets provisioning
  • Creating extensible services
  • Using @pnp/sp
  • Using @react-orgchart
  • Using @array-to-tree

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.

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.