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

60 lines
1.6 KiB
Markdown
Raw Normal View History

# Page Contributors Web Part
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
## Used SharePoint Framework Version
![drop](https://img.shields.io/badge/version-GA-green.svg)
## Applies to
* [SharePoint Framework](https:/dev.office.com/sharepoint)
* [Office 365 tenant](https://dev.office.com/sharepoint/docs/spfx/set-up-your-development-environment)
## Prerequisites
PnP-JS-Core
## Solution
Solution|Author(s)
--------|---------
PageContributors | Stéphane Magne ([@SPParse](https://twitter.com/SPParse))
## Version history
Version|Date|Comments
-------|----|--------
1.0|July 27, 2017|Initial release
## 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 serve`
## 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
- Pnp JS Core
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-pagecontributors" />