sp-dev-fx-webparts/samples/react-accordion
Hugo Bernier c7fecfd583 Moved disclaimer to bottom 2021-11-07 02:11:17 -05:00
..
assets Updated sample.json and readme 2021-10-30 00:40:09 -04:00
config Added sorting 2021-09-30 15:01:42 +02:00
src Added sorting 2021-09-30 15:01:42 +02:00
teams Upgrade react accordion to SPFx 1.10 2020-01-19 23:45:43 +00:00
.editorconfig SPFx React Accordion sample (#599) 2018-09-10 13:06:51 +03:00
.gitignore SPFx React Accordion sample (#599) 2018-09-10 13:06:51 +03:00
.yo-rc.json Upgrade react accordion to SPFx 1.10 2020-01-19 23:45:43 +00:00
README.md Moved disclaimer to bottom 2021-11-07 02:11:17 -05:00
gulpfile.js SPFx React Accordion sample (#599) 2018-09-10 13:06:51 +03:00
package-lock.json Updated sample.json and readme 2021-10-30 00:40:09 -04:00
package.json Added sorting 2021-09-30 15:01:42 +02:00
tsconfig.json Upgrade react accordion to SPFx 1.10 2020-01-19 23:45:43 +00:00
tslint.json Upgrade react accordion to SPFx 1.10 2020-01-19 23:45:43 +00:00

README.md

page_type products languages extensions
sample
office-sp
javascript
typescript
contentType technologies platforms createdDate
samples
SharePoint Framework
React
1/8/2018 12:00:00 AM

Using React Accordion plugin with SPFx

Summary

This is a sample web Part that illustrates the use of React Accessible Accordion plugin for building SharePoint Framework client-side web parts to show SharePoint list data in Accordion format.

Sample Web Part built using SPFx with React Framework showing list data in accordion format

Compatibility

SPFx 1.10 Node.js v10 | v8 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Incompatible Hosted Workbench Compatible

Applies to

Solution

Solution Author(s)
react-accordion Gautam Sheth (SharePoint Consultant, RapidCircle)
react-accordion Abhishek Garg

Version history

Version Date Comments
1.0 August 17, 2018 Initial release
2.0 January 19, 2020 Upgrade to SPFx 1.10
2.1 June 22, 2020 Added pagination (Abhishek Garg)
2.2 October 1, 2020 Added new Pagination Configuration (@beau__cameron)
2.3 September 30, 2021 Added sorting (@fthorild)

Minimal Path to Awesome

Build and Test

  1. Clone this repo
  2. In the command line run
    • npm i
    • gulp build
    • gulp serve --nobrowser
  3. Create a custom list (e.g. FAQ) with Title and Description(internal name) of type Enhanced rich text on your SharePoint site.
  4. Populate the list with some items
  5. Navigate to the hosted version of SharePoint workbench, eg. https://<tenant>.sharepoint.com/sites/<your site>/_layouts/15/workbench.aspx
  6. Add the Web Part to the canvas and configure it.

Package and deploy

  1. In the command line run
    • gulp bundle --ship
    • gulp package-solution --ship
  2. Install into your SharePoint app catalog and add it to a SharePoint site.
  3. Navigate to your site, eg. https://<tenant>.sharepoint.com/sites/<your site>
  4. Create a custom list with Title and Description(internal name) of type Enhanced rich text.
  5. Populate the list with some items
  6. Navigate to a page on your site where the custom list is created
  7. Add the Web Part to the page and configure it.

Features

This project contains sample client-side web part built on the SharePoint Framework illustrating how to show list data in Accordion format using React framework.

This sample illustrates the following concepts on top of the SharePoint Framework:

General

  • performing SharePoint GET operation in React using inbuilt SP Http Client
  • Using Fabric UI button component for pagination
  • optimizing REST responses for performance using nometadata option of JSON light
  • using PnP web part title control of @pnp/spfx-controls-react library
  • showing SharePoint list data in Accordion format using React Accessible Accordion plugin
  • searching in the fetched data by making use of Search Box from Office Fabric UI

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.

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.