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

92 lines
3.5 KiB
Markdown
Raw Normal View History

---
page_type: sample
products:
- office-sp
languages:
- javascript
- typescript
extensions:
contentType: samples
technologies:
- SharePoint Framework
platforms:
- react
createdDate: 8/1/2017 12:00:00 AM
---
2020-11-09 00:25:06 -05:00
# Page Contributors
2017-08-07 09:56:43 -04:00
## Summary
Displays page contributors in reverse chronological order.
![Organisation Chart for the current user running in SharePoint](./assets/pagecontributors_inaction.PNG)
2017-08-07 09:56:43 -04:00
![Organisation Chart for the current user running in local Workbench](./assets/pagecontributors_mockup.PNG)
2017-08-07 09:56:43 -04:00
2021-05-23 03:58:50 -04:00
## Compatibility
![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg)
2021-07-04 21:14:10 -04:00
![Node.js LTS 14.x](https://img.shields.io/badge/Node.js-LTS%2014.x-green.svg)
2021-05-23 03:58:50 -04:00
![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg)
![Teams N/A: Untested with Microsoft Teams](https://img.shields.io/badge/Teams-N%2FA-lightgrey.svg "Untested with Microsoft Teams")
![Workbench Local | Hosted](https://img.shields.io/badge/Workbench-Local%20%7C%20Hosted-green.svg)
2017-08-07 09:56:43 -04:00
## Applies to
* [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
2021-05-23 03:58:50 -04:00
* [Microsoft 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
2017-08-07 09:56:43 -04:00
## Solution
Solution|Author(s)
--------|---------
2021-06-02 23:14:57 -04:00
PageContributors | [Stéphane Magne](https://github.com/SPParseError) ([@SPParse](https://twitter.com/SPParse))
PageContributors | [Ari Gunawan](https://github.com/AriGunawan) ([@arigunawan3023](https://twitter.com/arigunawan3023))
2017-08-07 09:56:43 -04:00
## Version history
Version|Date|Comments
-------|----|--------
2021-05-23 03:58:50 -04:00
1.0.0|July 27, 2017|Initial release
1.1.0|May 23, 2021|Update SPFx (v1.12.1) version and replace sp-pnp-js with @pnp/sp (v2.5)
2021-07-04 21:14:10 -04:00
1.2.0|July 5, 2021|Add support for homepage page
2017-08-07 09:56:43 -04:00
## Minimal Path to Awesome
2021-05-23 03:58:50 -04:00
* Clone this repository
* in the command line run:
* `npm install`
* `gulp serve`
2017-08-07 09:56:43 -04:00
## Features
Settings :
1. The maximum number of contributors to show
2. The size of their icon
3. A page URL to display contributors from an other page than the current one.
This Web Part illustrates the following concepts on top of the SharePoint Framework:
- Office UI Fabric
- React
2021-05-23 03:58:50 -04:00
- PNP JS
2021-11-01 21:07:49 -04:00
## Help
2021-05-23 03:58:50 -04:00
We do not support samples, but we do use GitHub to track issues and constantly want to improve these samples.
2021-06-02 23:14:57 -04: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&template=bug-report.yml&sample=react-pagecontributors&authors=@SPParseError%20@AriGunawan&title=react-pagecontributors%20-%20).
2021-05-23 03:58:50 -04:00
2021-06-02 23:14:57 -04: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%3Abug-suspected&template=question.yml&sample=react-pagecontributors&authors=@SPParseError%20@AriGunawan&title=react-pagecontributors%20-%20).
2021-05-23 03:58:50 -04:00
2021-06-02 23:14:57 -04: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%3Abug-suspected&template=suggestion.yml&sample=react-pagecontributors&authors=@SPParseError%20@AriGunawan&title=react-pagecontributors%20-%20).
2017-08-07 09:56:43 -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.**
2020-11-09 00:25:06 -05:00
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-pagecontributors" />