Update README.md
This commit is contained in:
parent
0e18c255cd
commit
27cd1f666e
|
@ -13,59 +13,61 @@ extensions:
|
||||||
- react
|
- react
|
||||||
createdDate: 11/1/2017 12:00:00 AM
|
createdDate: 11/1/2017 12:00:00 AM
|
||||||
---
|
---
|
||||||
# Documents Web Part
|
# Documents Web Part
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
This sample shows how to build web parts that display documents in accordance with the SharePoint Online modern experience. The code uses Office UI Fabric components on the top of SharePoint framework. The web parts implement filtering and sorting. Two data source approaches are demonstrated: items retrieved from the search index and real-time query to a document library.
|
This sample shows how to build web parts that display documents in accordance with the SharePoint Online modern experience. The code uses Office UI Fabric components on the top of SharePoint framework. The web parts implement filtering and sorting. Two data source approaches are demonstrated: items retrieved from the search index and real-time query to a document library.
|
||||||
|
|
||||||
![Demo](./assets/Preview.gif)
|
![Demo](./assets/Preview.gif)
|
||||||
|
|
||||||
## Used SharePoint Framework Version
|
## Used SharePoint Framework Version
|
||||||
![drop](https://img.shields.io/badge/version-GA-green.svg)
|
![1.10.0](https://img.shields.io/badge/version-1.10.0-green.svg)
|
||||||
|
|
||||||
## Applies to
|
## Applies to
|
||||||
|
|
||||||
* [SharePoint Framework](https:/dev.office.com/sharepoint)
|
* [SharePoint Framework](https:/dev.office.com/sharepoint)
|
||||||
* [Office 365 tenant](https://dev.office.com/sharepoint/docs/spfx/set-up-your-development-environment)
|
* [Office 365 tenant](https://dev.office.com/sharepoint/docs/spfx/set-up-your-development-environment)
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- Office 365 subscription with SharePoint Online.
|
- Office 365 subscription with SharePoint Online.
|
||||||
- SharePoint Framework [development environment](https://dev.office.com/sharepoint/docs/spfx/set-up-your-development-environment) already set up.
|
- SharePoint Framework [development environment](https://dev.office.com/sharepoint/docs/spfx/set-up-your-development-environment) already set up.
|
||||||
|
|
||||||
## Solution
|
## Solution
|
||||||
|
|
||||||
Solution|Author(s)
|
Solution|Author(s)
|
||||||
--------|---------
|
--------|---------
|
||||||
react-documents|Dimcho Tsanov
|
react-documents|Dimcho Tsanov
|
||||||
|
react-documents (v2.0)|Harsha Vardhini ([harshagracy](https://twitter.com/harshagracy?s=20))
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
Version|Date|Comments
|
Version|Date|Comments
|
||||||
-------|----|--------
|
-------|----|--------
|
||||||
1.0|October 13, 2017|Initial release
|
1.0|October 13, 2017|Initial release
|
||||||
|
2.0|April 28, 2020|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.**
|
## 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
|
|
||||||
|
## Minimal Path to Awesome
|
||||||
- Clone this repository
|
|
||||||
- in the command line run:
|
- Clone this repository
|
||||||
- `npm install`
|
- in the command line run:
|
||||||
- `gulp serve`
|
- `npm install`
|
||||||
|
- `gulp serve`
|
||||||
## Features
|
|
||||||
This Web Part illustrates the following concepts on top of the SharePoint Framework:
|
## Features
|
||||||
|
|
||||||
-Using React for building SharePoint Framework client-side web parts.
|
This Web Part illustrates the following concepts on top of the SharePoint Framework:
|
||||||
-Using Office UI Fabric React styles for building user experience consistent with SharePoint and Office.
|
|
||||||
-Using the SharePoint rest API for querying document library's files.
|
-Using React for building SharePoint Framework client-side web parts.
|
||||||
-Using the SharePoint rest API for retrieving documents from the search index.
|
-Using Office UI Fabric React styles for building user experience consistent with SharePoint and Office.
|
||||||
-Passing web part properties to React components.
|
-Using the SharePoint rest API for querying document library's files.
|
||||||
-Reusing single React component between two web parts.
|
-Using the SharePoint rest API for retrieving documents from the search index.
|
||||||
|
-Passing web part properties to React components.
|
||||||
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-documents-detailslist" />
|
-Reusing single React component between two web parts.
|
||||||
|
|
||||||
|
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-documents-detailslist" />
|
||||||
|
|
Loading…
Reference in New Issue