sp-dev-fx-webparts/samples/react-document-links-accordion/README.md

77 lines
4.1 KiB
Markdown
Raw Normal View History

2023-03-15 00:11:27 -04:00
# Documents Links Accordion
2023-03-15 00:11:27 -04:00
## Summary
2023-03-15 00:11:27 -04:00
This web part allows user create a accordion with documents links grouped by any column of document library.
When the user clicks on the header it dynamically load documents.
![documentsLinksAccordion](./assets/documentsLinksAccordion.gif)
2023-03-15 00:11:27 -04:00
## Screenshots
![documentsLinksAccordion](./assets/documentsLinksAccordion1.png)
2023-03-15 00:11:27 -04:00
## Compatibility
2023-03-15 00:11:27 -04:00
![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg)
![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-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)
![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg)
2023-03-15 00:11:27 -04:00
## Applies to
2023-03-15 00:11:27 -04:00
* [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)
2023-03-15 00:11:27 -04:00
## Web Part Properties
2023-03-15 00:11:27 -04:00
Property |Type|Required| comments
--------------------|----|--------|----------
2023-03-15 00:11:27 -04:00
Web part Title| Text| no|
Select Document Library| dropdown|yes
Select Field to Group By | dropdown|yes
2022-02-14 02:52:18 -05:00
2023-03-15 00:11:27 -04:00
## Contributors
2023-03-15 00:11:27 -04:00
- [João Mendes](https://github.com/joaojmendes)
2022-02-14 02:52:18 -05:00
2023-03-15 00:11:27 -04:00
## Version history
Version|Date|Comments
-------|----|--------
2023-03-15 00:11:27 -04:00
1.0.0|October 10, 2021|Initial release
2022-02-14 02:52:18 -05:00
2023-03-15 00:11:27 -04:00
## Minimal Path to Awesome
2023-03-15 00:11:27 -04:00
* Clone this repository
* Move to sample folder
* in the command line run:
* `npm install`
* `gulp build`
* `gulp bundle --ship`
* `gulp package-solution --ship`
* Add to AppCatalog and deploy
2023-03-15 00:11:27 -04:00
## Disclaimer
2023-03-15 00:11:27 -04:00
**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.**
2023-03-15 00:11:27 -04:00
## Help
2023-03-15 00:11:27 -04:00
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.
2023-03-15 00:11:27 -04:00
You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/labels/react-document-links-accordion) to see if anybody else is having the same issues.
2023-03-15 00:11:27 -04:00
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-document-links-accordion) and see what the community is saying.
2021-10-31 17:35:55 -04:00
2023-03-15 00:11:27 -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%2Csample%3A%20react-document-links-accordion&template=bug-report.yml&sample=react-document-links-accordion&authors=@joaojmendes%20@Ravikadri&title=react-document-links-accordion%20-%20).
2021-10-31 17:35:55 -04:00
2023-03-15 00:11:27 -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%3Aquestion%2Csample%3A%20react-document-links-accordion&template=question.yml&sample=react-document-links-accordion&authors=@joaojmendes%20@Ravikadri&title=react-document-links-accordion%20-%20).
2023-03-15 00:11:27 -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%3Aenhancement%2Csample%3A%20react-document-links-accordion&template=question.yml&sample=react-document-links-accordion&authors=@joaojmendes%20@Ravikadri&title=react-document-links-accordion%20-%20).
2023-03-15 00:11:27 -04:00
<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-documents-links-accordion" />