sp-dev-fx-webparts/samples/react-people-directory/README.md

2.2 KiB

People Directory web part

NOTE: This sample is available in the PnP Starter Kit. You can find the sample code for this web part at https://github.com/SharePoint/sp-starter-kit/tree/master/solution/src/webparts/peopleDirectory.

This web part provides you the ability to add a searchable people directory. A people search box and alphabet list are provided to enable both searching by name as well as selecting a specific letter. This web part requires no configuration and utilizes the people search API to surface people results.

People Directory

How to use this web part on your web pages

  1. Place the page you want to add this web part to in edit mode.
  2. Search for and insert the People Directory web part.
  3. Configure the webpart to update its properties.

Configurable Properties

The People Directory web part can be configured with the following properties:

Label Property Type Required Description
Web part title title string no The web part title, editable inline with the web part itself

Installing the web part

See getting started from SP-Starter-Kit repository readme.

You can also download just the SharePoint Framework solution package (spppkg) file and install that to your tenant. This web part does not have external dependencies.

Screenshots

People Directory

Source Code

https://github.com/SharePoint/sp-starter-kit/tree/master/solution/src/webparts/peopleDirectory

Minimal Path to Awesome

  • Clone this repository
  • Move to Solution folder
  • in the command line run:
    • npm install
    • gulp serve

Version history

Version Date Comments
1.0 May 2018 Initial release