honeymoose
/
sp-dev-fx-webparts
mirror of https://github.com/pnp/sp-dev-fx-webparts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
sp-dev-fx-webparts/samples/react-graph-pnpjs/README.md

4.5 KiB
Raw Blame History

Using PnPJS with Microsoft Graph

Summary

This web part demonstrates how to use PnPJS with SharePoint Framework and how to query Microsoft Graph with PnPJS. It requests a list of Azure AD groups at your tenant and shows them using Office UI Fabric React list.

Main UI

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

Applies to

Solution

Solution Author(s)
react-graph-pnpjs Sergei Sergeev (@sergeev_srg, spblog.net)

Version history

Version Date Comments
1.0 Jan 09, 2019 Initial release

Minimal Path to Awesome

  • clone this repo
  • navigate to the folder with current sample
  • restore dependencies: $ npm i
  • bundle solution: $ gulp bundle --ship
  • package solution: $ gulp package-solution --ship
  • locate solution at ./sharepoint/solution/pn-p-graph-web-part.sppkg and upload it to your tenant app catalog
  • you will see a message saying that solution has pending permissions which need to be approved:
    Pending permission requests
  • you should approve permission requests from your SharePoint Framework web part. There are different options available - new SharePoint Admin UI, PowerShell, $o365 cli. For the matter of this sample, the fastest way to do it is through new SharePoint Admin UI. Open Web API permission management page by navigating to the url https://<org>-admin.sharepoint.com/_layouts/15/online/AdminHome.aspx#/webApiPermissionManagement (changing <org> to your real organization name) or by going to the new Admin UI directly from old SharePoint Admin Center. Select Pending Group.Read.All request and approve it: Approve request from new Admin UI
  • run $ gulp serve and open hosted workbench, i.e. https://<org>.sharepoint.com/sites/<your site>/_layouts/15/workbench.aspx
  • add PnPGraph web part to see it in action

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

Features

Web part in this solution illustrates the following concepts on top of the SharePoint Framework:

  • showcases PnPJS configuration inside SharePoint Framework
  • showcases how to use MS Graph with PnPJS
  • showcases how to correctly configure SharePoint Framework solution and tenant to allow PnPJS to call MS Graph

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.