sp-dev-fx-webparts/samples/react-accordion-section

Accordion Section -- FAQ Builder

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.

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:

Compatibility

⚠️ Important
Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.
Refer to https://aka.ms/spfx-matrix for more information on SPFx compatibility.

This sample is designed to be used in the following environments:

For more information about SPFx compatibility, please refer to https://aka.ms/spfx-matrix

Applies to

• SharePoint Framework
• Microsoft 365 tenant

Prerequisites

Please create the list as described above

Contributors

• Erik Benke (@erikjbenke)
• Mike Zimmerman
• Ravi Chandra
• Jack Vinitsky

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
1.7	January 5, 2021	Fixed web part title style to be consistent with first-party web parts; updated other dependencies

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

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

Video

Help

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.

If you're having issues building the solution, please run spfx doctor from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues while using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

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.