sp-dev-fx-webparts/samples/react-display-hierarchy/README.md

3.9 KiB
Raw Blame History

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)

Used SharePoint Framework Version

SPFx 1.11

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

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.


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