honeymoose
/
sp-dev-fx-webparts
mirror of https://github.com/pnp/sp-dev-fx-webparts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated readme and sample.json

This commit is contained in:
Hugo Bernier 2021-05-01 22:04:22 -04:00
parent b28deb8045
commit ba2faea0ef
2 changed files with 29 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
samples/react-list-search/README.md
View File

@ -3,7 +3,8 @@
## Summary
This list search web part allows the user to show data from lists or libraries. The web part can be used to (for more details see images below):
* [Show merged items from diferents lists/libraries](#merge-items-from-different-listslibraries)
* [Show merged items from different lists/libraries](#merge-items-from-different-listslibraries)
* [Open item data in modal window (same data shown in the table)](#merge-items-from-different-listslibraries)
* [Select render by field type](#select-render-of-the-selected-fields)
* [Open item detail in modal window (it allows to select the fields to show by list)](#open-selected-item-with-selected-properties)
@ -23,39 +24,38 @@ This list search web part allows the user to show data from lists or libraries.
* Get section color
* Show item count with custom message
#### Merge items from different lists/libraries
### Merge items from different lists/libraries
![Merge items from different lists/libraries](assets/differentSources.gif)
#### Select render of the selected fields
### Select render of the selected fields
![Select render of the selected fields](assets/selectFieldRenderType.gif)
#### Open documents in modal window
### Open documents in modal window
![Open documents in modal window](assets/docInModal.gif)
#### Open documents in new tab
### Open documents in new tab
![Open documents in new tab](assets/docInNewTab.gif)
#### Use of dynamic data
### Use of dynamic data
![Use of dynamic data](assets/dynamicData.gif)
#### Open selected item with same data
### Open selected item with same data
![Open selected item with same data](assets/itemCurrentData.gif)
#### Open selected item with selected properties
### Open selected item with selected properties
![Open selected item with selected properties](assets/itemSelectedData.gif)
#### Redirect to url depends on selected item
### Redirect to url depends on selected item
![Redirect to url depends on selected item](assets/redirectToUrl.gif)
## Compatibility
![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg)
@ -64,7 +64,6 @@ This list search web part allows the user to show data from lists or libraries.
![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)
## Applies to
* [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
@ -74,7 +73,7 @@ This list search web part allows the user to show data from lists or libraries.
Solution|Author(s)
--------|---------
react-list-search | Alberto Gutiérrez ([@albertogperez](https://twitter.com/albertogperez))
react-list-search | [Alberto Gutiérrez](https://github.com/albegut) ([@albertogperez](https://twitter.com/albertogperez))
## Version history
@ -83,12 +82,6 @@ Version|Date|Comments
1.0.0|December 20, 2020|Initial release
1.1.0|April 25, 2021|List item modern audience support
## 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
### Dev Mode
@ -115,8 +108,22 @@ This Web Part illustrates the following concepts on top of the SharePoint Framew
* Using [PnP Js](https://pnp.github.io/pnpjs) to retrieve SharePoint data
* Using [PnP Js](https://pnp.github.io/pnpjs/odata/caching) to cache SharePoint data
* Connection between SharePoint Framework components using dynamic data
* [Support of section backgrounds color ](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/guidance/supporting-section-backgrounds)
* [Support of section backgrounds color](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/guidance/supporting-section-backgrounds)
* [Custom property pane control](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/guidance/build-custom-property-pane-controls)
* Use [react-js-pagination](https://www.npmjs.com/package/react-js-pagination) library
## 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.**
## Support
We do not support samples, but we do use GitHub to track issues and constantly want to improve these samples.
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-list-search&authors=@albegut&title=react-list-search%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%3Abug-suspected&template=question.yml&sample=react-list-search&authors=@albegut&title=react-list-search%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%3Abug-suspected&template=suggestion.yml&sample=react-list-search&authors=@albegut&title=react-list-search%20-%20).
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-list-search" />

6
samples/react-list-search/assets/sample.json
View File

@ -8,8 +8,8 @@
"longDescription": [
"This list search web part allows the user to show data from lists or libraries."
],
"created": "2020-12-20",
"modified": "2020-12-20",
"creationDateTime": "2020-12-20",
"updateDateTime": "2021-04-25",
"products": [
"SharePoint",
"Office"
@ -100,4 +100,4 @@
}
]
}
]
]