79 lines
3.2 KiB
Markdown
79 lines
3.2 KiB
Markdown
# SPFx Accordion Section FAQ Builder web part
|
|
|
|
## Summary
|
|
|
|
* Adds a collapsible accordion section to an Office 365 SharePoint page or Teams Tab.
|
|
* Ideal for creating FAQs.
|
|
* When adding the web part, you'll be prompted to select a list from a property panel dropdown (target list must have a Title column and Content column). This will generate an accordion with one section for each item in the list.
|
|
* Modifications/deletions/additions to the list items in the target list of an added web part are automatically reflected on the page.
|
|
* To deploy to a Teams tab see current [Microsoft documentation](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/using-web-part-as-ms-teams-tab).
|
|
|
|
|
|
|
|
### Usage
|
|
|
|
**1) Create or use a list with a Title and a Content column:**
|
|
* The value in the Title column for each item will appear in the heading bars of the Accordion.
|
|
* The value in the Content column for each item will appear in the collapsible content section of the Accordion
|
|
* When creating the columns, select "Multiple lines of text". Rich text is now supported within the Content column.
|
|
|
|
|
|
|
|
**2) Add the Accordion Section web part to your page & select your list:**
|
|
|
|
|
|
|
|
|
|
|
|
## Used SharePoint Framework Version
|
|
|
|
|
|
|
|
## Applies to
|
|
|
|
* [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)
|
|
|
|
## Prerequisites
|
|
|
|
Please create the list as described above
|
|
|
|
|
|
## Solution
|
|
|
|
Solution|Author(s)
|
|
--------|---------
|
|
SPFx Collapsible Accordion Section|[Erik Benke](https://github.com/ejbenke) ([@erikjbenke](https://twitter.com/erikjbenke))
|
|
SPFx Collapsible Accordion Section|[Mike Zimmerman](https://github.com/mikezimm)
|
|
|
|
## Version history
|
|
|
|
Version|Date|Comments
|
|
-------|----|--------
|
|
1.0|August 14, 2019|Initial release
|
|
1.1|September 19, 2019|Minor updates, adding to GitHub
|
|
1.2|April 15, 2020|Added Polyfills for IE11 compatibility
|
|
1.3|July 10, 2020|Adding Rich Text support for Content panels
|
|
1.4|July 10, 2020|Upgraded to SPFx 1.10.
|
|
1.5|September 1, 2020|Adds ability to click on expanded section headers to collapse accordions
|
|
1.6|September 2, 2020|Added Web Part Title, and ability to expand multiple sections
|
|
|
|
## 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 or download this repository
|
|
- Run in command line:
|
|
- `npm install` to install the npm dependencies
|
|
- `gulp serve` to display in Developer Workbench (recommend using your tenant workbench so you can test with real lists within your site)
|
|
- To package and deploy:
|
|
- Use `gulp bundle --ship` & `gulp package-solution --ship`
|
|
- Add the `.sppkg` to your SharePoint App Catalog
|
|
|
|
|
|
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-accordion-section" />
|