sp-dev-fx-webparts/samples/react-display-hierarchy
Hugo Bernier eb8bd92a0b Updating telemetry link 2021-12-20 10:25:30 -05:00
..
assets Removing unnecessary office product from the sample metadata 2021-12-10 19:55:32 +02:00
config Adding PnP identifier for the MPN ID entries in samples - distinct sample usage in production 2021-01-07 14:51:39 +02:00
sharepoint/assets added react-display-hierarchy (#673) 2018-11-12 10:50:47 +02:00
src Fixed Web Part doesn't react to property change 2020-12-01 10:38:14 +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
.gitignore added react-display-hierarchy (#673) 2018-11-12 10:50:47 +02:00
.yo-rc.json Upgraded solution to SPFx v1.11.0 and use pnp/sp 2020-11-21 17:48:27 +00:00
README.md Updating telemetry link 2021-12-20 10:25:30 -05:00
gulpfile.js added react-display-hierarchy (#673) 2018-11-12 10:50:47 +02:00
package-lock.json Upgraded solution to SPFx v1.11.0 and use pnp/sp 2020-11-21 17:48:27 +00:00
package.json Upgraded solution to SPFx v1.11.0 and use pnp/sp 2020-11-21 17:48:27 +00:00
tsconfig.json Upgraded solution to SPFx v1.11.0 and use pnp/sp 2020-11-21 17:48:27 +00:00
tslint.json Upgraded solution to SPFx v1.11.0 and use pnp/sp 2020-11-21 17:48:27 +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

The web part is configured to render the mock data when added to the local SharePoint workbench. Local SharePoint Workbench Run

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. sp-pnp-js (https://www.npmjs.com/package/sp-pnp-js)
  2. react-orgchart (https://www.npmjs.com/package/react-orgchart)
  3. array-to-tree (https://www.npmjs.com/package/array-to-tree)

Compatibility

SPFx 1.11 Node.js v10 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Teams Incompatible Local Workbench Incompatible Hosted Workbench Compatible

Applies to

Solution

Solution Author(s)
react-display-hierarchy Nanddeep Nachan (SharePoint Consultant, @NanddeepNachan )
  Ravi Kulkarni (SharePoint Consultant)

Version history

Version Date Comments
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

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 mock data to test the web part locally
  • 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.