sp-dev-fx-webparts/samples/react-tree-orgchart/README.md

106 lines
5.5 KiB
Markdown
Raw Normal View History

2020-11-08 23:45:09 -05:00
# Tree Organization
## Summary
2021-10-31 15:49:38 -04:00
The Tree Organization Web Part shows the Organization Chart of the or the team, the web part reads infomation from current user to build the Organization Chart.
2021-10-28 16:44:23 -04:00
You can configure in the web part properties:
2021-02-28 15:53:14 -05:00
* show all Organization Chart
* the only user team, (same manager and peers).
* show Organization Chart by picking up user
2021-02-28 15:53:14 -05:00
![Organization Chart Web Part](./assets/react-tree-orgchart.gif)
![Organization Chart Web Part](./assets/Screenshot1.png)
![Organization Chart Web Part](./assets/Screenshot2.png)
![Organization Chart Web Part](./assets/Screenshot3.png)
2021-02-28 15:53:14 -05:00
2021-10-31 15:49:38 -04:00
## Compatibility
2021-10-31 15:49:38 -04:00
![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg)
![Node.js LTS 10 | LTS 8](https://img.shields.io/badge/Node.js-LTS%2010%20%7C%20LTS%208-green.svg)
![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")
![Local Workbench Incompatible](https://img.shields.io/badge/Local%20Workbench-Incompatible-red.svg "The solution requires access to the user's properties")
![Hosted Workbench Compatible (with API permissions)](https://img.shields.io/badge/Hosted%20Workbench-Compatible%20(with%20API%20permissions)-yellow.svg)
## Applies to
* [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [Office 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
2021-10-31 15:49:38 -04:00
## Web Part Properties
Property |Type|Required| comments
--------------------|----|--------|----------
2021-10-31 15:49:38 -04:00
title | Text| no| Web Part Title
2021-02-26 20:16:28 -05:00
teamLeader |Text|no|UPN of manager if viewType is 4
2021-02-28 15:53:14 -05:00
viewType|viewType(number)|yes|if currentUserTeam is set it's not required
2021-02-26 20:00:18 -05:00
maxLevels | Number| yes | Maximum number of levels to show
detailBehavoir |boolean|no|Delve or Live Persona Card
excludefilter|boolean|no|Filter contains/not contains
filter|string|no|Filter Value
2021-02-26 20:16:28 -05:00
currentUserTeam|boolean|no|only in Interface to handle previouse installations
2021-02-26 20:00:18 -05:00
2021-02-28 15:53:14 -05:00
### viewType Enum:
2021-02-26 20:16:28 -05:00
```
MyTeam = 1,
CompanyHierarchy = 2,
ShowOtherTeam = 4
```
## Solution
Solution|Author(s)
--------|---------
2021-10-31 15:49:38 -04:00
Tree Organization Web Part|[João Mendes](https://github.com/joaojmendes)
Tree Organization Web Part|[Peter Paul Kirschner](https://github.com/petkir) ([@petkir_at](https://twitter.com/petkir_at))
## Version history
Version|Date|Comments
-------|----|--------
1.1.2|October 28, 2021|Fixes the Issue with different TimeZones.
2021-10-31 02:14:37 -04:00
1.1.1|October 5, 2021|Added missing Graph permissions in manifest
2021-02-28 15:53:14 -05:00
1.1.0|Feb 28, 2021|Added <ul><li>Show Other Team</li><li>Live Contact Card</li><li>Filter user by userPrincipalName</li><li>Graph API</li><li>PNPJS updates</li></ul>
2021-02-26 20:00:18 -05:00
1.0.2|June 12, 2020|Added exception handler for profiles missing display name
1.0.1|Jan 28, 2020|Update to SPFx 1.10, minor fixes and refactoring.
2021-02-26 20:00:18 -05:00
1.0.0|Feb 25, 2019|Initial release
## Minimal Path to Awesome
- Clone this repository
- in the command line run:
- `npm install`
- `gulp build`
- `gulp bundle --ship`
- `gulp package-solution --ship`
2021-10-31 15:49:38 -04:00
## Help
We do not support samples, but we 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%3Areact-tree-orgchart) 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=label%3Areact-tree-orgchart) and see what the community is saying.
2021-11-20 23:55:10 -05:00
If you encounter any issues while 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-tree-orgchart&template=bug-report.yml&sample=react-tree-orgchart&authors=@joaojmendes%20@petkir&title=react-tree-orgchart%20-%20).
2021-10-31 15:49:38 -04:00
2021-11-20 23:55:10 -05:00
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-tree-orgchart&template=question.yml&sample=react-tree-orgchart&authors=@joaojmendes%20@petkir&title=react-tree-orgchart%20-%20).
2021-10-31 15:49:38 -04:00
2021-11-20 23:55:10 -05:00
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-tree-orgchart&template=question.yml&sample=react-tree-orgchart&authors=@joaojmendes%20@petkir&title=react-tree-orgchart%20-%20).
2021-10-31 15:49:38 -04:00
2021-11-07 02:11:17 -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.**
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-tree-orgchart" />