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

105 lines
6.1 KiB
Markdown
Raw Normal View History

2021-02-16 18:39:54 -05:00
---
page_type: sample
products:
- office-sp
languages:
- javascript
- typescript
extensions:
contentType: samples
technologies:
- SharePoint Framework
- Msgraph
- Fluent UI React Controls
platforms:
- React
createdDate: 4/9/2020 12:00:00 AM
---
# Staff Directory (Search Directory)
## Summary
2021-02-18 10:29:13 -05:00
This web part shows the current user's colleagues, and allows the user to search AD directory, The user can configure the properties to show when expand the user card.
2021-02-16 18:39:54 -05:00
2021-02-18 10:28:08 -05:00
![staff](./assets/staffdirectory.gif)
2021-03-09 18:08:05 -05:00
![staff](./assets/staffTeams01.png)
![staff](./assets/staffTeams02.png)
2021-02-16 18:39:54 -05:00
2021-02-18 10:11:44 -05:00
## Compatibility
2021-02-16 18:39:54 -05:00
| :warning: 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. |
2022-06-16 12:31:07 -04:00
![SPFx 1.14.0](https://img.shields.io/badge/SPFx-1.14.0-green.svg)
![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20|%20v12-green.svg)
2021-10-30 22:34:42 -04:00
![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg "SharePoint Server 2019 requires SPFx 1.4.1 or lower")
![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
![Teams Incompatible](https://img.shields.io/badge/Teams-Incompatible-lightgrey.svg)
![Local Workbench Incompatible](https://img.shields.io/badge/Local%20Workbench-Incompatible-red.svg "This solution requires API permissions")
![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg)
2022-02-15 00:37:36 -05:00
![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)
2021-02-16 18:39:54 -05:00
## Applies to
2022-10-24 09:42:45 -04:00
* [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [Microsoft 365 tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
2021-02-16 18:39:54 -05:00
2023-02-18 22:58:44 -05:00
## Contributors
* [Ari Gunawan](https://github.com/AriGunawan) ([@arigunawan3023](https://twitter.com/arigunawan3023))
* [João Mendes](https://github.com/joaojmendes) ([joaojmendes](https://github.com/joaojmendes))
* [Milan Holemans](https://github.com/milanholemans)
2021-02-16 18:39:54 -05:00
## Version history
Version|Date|Comments
-------|----|--------
1.0.0|February 16, 2021|Initial release
2021-03-28 06:54:43 -04:00
1.0.1|March 28, 2021|Added missing Graph API Permission (User.Read.All) for getting users information
2021-04-21 22:43:28 -04:00
1.0.2|April 14, 2021|Added About Me and Skills
2022-06-16 12:31:07 -04:00
1.0.3|June 16, 2022|Upgraded project to SPFx v1.14.0
2021-02-16 18:39:54 -05:00
## Minimal Path to Awesome
Please follow all the steps:
2022-02-15 00:37:36 -05:00
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit https://aka.ms/spfx-devcontainer for further instructions.
2022-06-20 00:01:35 -04:00
- Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-staffdirectory) then unzip it)
- From your command line, change your current directory to the directory containing this sample (`react-staffdirectory`, located under `samples`)
2021-02-16 18:39:54 -05:00
- in the command line run:
- `npm install`
- `gulp build`
- `gulp bundle --ship`
- `gulp package-solution --ship`
- Add and deploy package to your tenant's App Catalog
2021-03-28 06:54:43 -04:00
- Go to **API Access** - from **SharePoint Admin Center** new experience, and **Approve** the permission to use Microsoft Graph scopes **Presence.Read.All** and **User.Read.All**
2021-02-16 18:39:54 -05:00
2022-06-20 00:01:35 -04:00
## Help
We do not support samples, but 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](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-staffdirectory%22) to see if anybody else is having the same issues.
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-staffdirectory) and see what the community is saying.
If you encounter any issues using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-staffdirectory&template=bug-report.yml&sample=react-staffdirectory&authors=@AriGunawan%20@joaojmendes%20@tristian2%20@milanholemans&title=react-staffdirectory%20-%20).
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-staffdirectory&template=question.yml&sample=react-staffdirectory&authors=@AriGunawan%20@joaojmendes%20@tristian2%20@milanholemans&title=react-staffdirectory%20-%20).
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-staffdirectory&template=suggestion.yml&sample=react-staffdirectory&authors=@AriGunawan%20@joaojmendes%20@tristian2%20@milanholemans&title=react-staffdirectory%20-%20).
2021-02-16 18:39:54 -05:00
2021-11-07 01:54:14 -05:00
## 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.**
2021-12-20 10:25:30 -05:00
<img src="https://pnptelemetry.azurewebsites.net/sp-dev-fx-webparts/samples/react-staffdirectory" />
2022-06-20 00:01:35 -04:00