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

97 lines
3.0 KiB
Markdown
Raw Normal View History

# React Directory Web Part
## Summary
Search People from Organization Directory and show live persona card on hover.
##
![directory](/samples/react-directory/assets/react-directory7.png)
![directory](/samples/react-directory/assets/react-directory8.png)
![directory](/samples/react-directory/assets/react-directory9.png)
![directory](/samples/react-directory/assets/react-directory.jpg)
![directory](/samples/react-directory/assets/react-directory-teams1.jpg)
![directory](/samples/react-directory/assets/react-directory2.jpg)
![directory](/samples/react-directory/assets/react-directory-teams2.png)
![directory](/samples/react-directory/assets/react-directory21.png)
![directory](/samples/react-directory/assets/react-directory3.jpg)
![directory](/samples/react-directory/assets/react-directory6.png)
![directory](/samples/react-directory/assets/react-directory5.jpg)
2020-09-18 11:13:17 -04:00
![directory](./assets/react-directory-withPaging.png)
## Used SharePoint Framework Version
2020-09-24 01:05:36 -04:00
![SPFx 1.11](https://img.shields.io/badge/version-1.11-green.svg)
## Applies to
* [SharePoint Online](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [Microsoft Teams](https://products.office.com/en-US/microsoft-teams/group-chat-software)
* [Office 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
## WebPart Properties
Property |Type|Required| comments
--------------------|----|--------|----------
2020-07-19 16:37:29 -04:00
Title | Text| no|WebPart Title
2020-07-19 16:49:18 -04:00
searchFirstName | boolean|no| Lastname or Firstname search query
2020-09-18 11:13:17 -04:00
Properties to search | text | no | By default **FirstName,LastName,WorkEmail,Department** are used for search. You can add custom properties separated by comma.
Results per page | number | Number of people result to be displayed per page. Max of **20** is allowed, default of **10** is set.
## Solution
2020-09-24 01:05:36 -04:00
2020-07-19 16:49:18 -04:00
The web part use PnPjs library, Office-ui-fabric-react components
Solution|Author(s)
--------|---------
2020-10-02 02:54:22 -04:00
Directory Web Part| João Mendes
2020-07-19 16:37:29 -04:00
Directory Web Part| Peter Paul Kirschner ([@petkir_at](https://twitter.com/petkir_at))
2020-09-18 11:13:17 -04:00
Directory Web Part| Sudharsan K ([@sudharsank](https://twitter.com/sudharsank))
## Version history
Version|Date|Comments
-------|----|--------
1.0.0|July 29, 2019|Initial release
2020-07-19 16:49:18 -04:00
1.0.1|July 19, 2020|Bugfix and mock-service for workbench (```LivePersonaCard``` not supported in workbench)
2020-10-02 02:54:22 -04:00
2.0.0|Sep 18 2020|React hooks, paging, dynamic search props, result alignment using office ui fabric stack.
## 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.**
---
## Minimal Path to Awesome
- Clone this repository
- in the command line run:
- `npm install`
- `gulp build`
- `gulp bundle --ship`
- `gulp package-solution --ship`
- `Add to AppCatalog and deploy`
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-directory" />