Merge pull request #1384 from pnp/React-Accordion-Section

Initial version of react-accordion-section

samples/react-accordion-section/.editorconfig

@@ -0,0 +1,25 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+
+# change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# we recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[{package,bower}.json]
+indent_style = space
+indent_size = 2

samples/react-accordion-section/.gitignore

@@ -0,0 +1,32 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Dependency directories
+node_modules
+
+# Build generated files
+dist
+lib
+solution
+temp
+*.sppkg
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# OSX
+.DS_Store
+
+# Visual Studio files
+.ntvs_analysis.dat
+.vs
+bin
+obj
+
+# Resx Generated Code
+*.resx.ts
+
+# Styles Generated Code
+*.scss.ts

samples/react-accordion-section/.yo-rc.json

@@ -0,0 +1,12 @@
+{
+  "@microsoft/generator-sharepoint": {
+    "isCreatingSolution": true,
+    "environment": "spo",
+    "version": "1.10.0",
+    "libraryName": "react-accordion",
+    "libraryId": "bf6fa974-fd40-45a3-80e9-e826abe025b9",
+    "packageManager": "npm",
+    "isDomainIsolated": false,
+    "componentType": "webpart"
+  }
+}

samples/react-accordion-section/README.md

@@ -0,0 +1,78 @@
+# 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).
+
+![Web Part in Action](./assets/react-accordion-section.gif)
+
+### 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.
+
+
+![Create list for use with the Accordion](./assets/ListForAccordion.png)
+
+**2) Add the Accordion Section web part to your page & select your list:**  
+
+
+![Select list from property panel for use with the Accordion](./assets/AccordionSettings.png)
+
+
+## Used SharePoint Framework Version
+
+![1.10.0](https://img.shields.io/badge/version-1.10.0-green.svg)
+
+## 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)
+
+> Update accordingly as needed.
+
+## Prerequisites
+
+> Any special pre-requisites?
+
+## Solution
+
+Solution|Author(s)
+--------|---------
+SPFx Collapsible Accordion Section|Erik Benke
+
+## 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.
+
+
+## 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" />

samples/react-accordion-section/config/config.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/config.2.0.schema.json",
+  "version": "2.0",
+  "bundles": {
+    "react-accordion-web-part": {
+      "components": [
+        {
+          "entrypoint": "./lib/webparts/reactAccordion/ReactAccordionWebPart.js",
+          "manifest": "./src/webparts/reactAccordion/ReactAccordionWebPart.manifest.json"
+        }
+      ]
+    }
+  },
+  "externals": {},
+  "localizedResources": {
+    "ReactAccordionWebPartStrings": "lib/webparts/reactAccordion/loc/{locale}.js",
+    "PropertyControlStrings": "node_modules/@pnp/spfx-property-controls/lib/loc/{locale}.js",
+    "ControlStrings": "node_modules/@pnp/spfx-controls-react/lib/loc/{locale}.js"
+  }
+}

samples/react-accordion-section/config/copy-assets.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/copy-assets.schema.json",
+  "deployCdnPath": "temp/deploy"
+}

samples/react-accordion-section/config/deploy-azure-storage.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/deploy-azure-storage.schema.json",
+  "workingDir": "./temp/deploy/",
+  "account": "<!-- STORAGE ACCOUNT NAME -->",
+  "container": "react-accordion",
+  "accessKey": "<!-- ACCESS KEY -->"
+}

samples/react-accordion-section/config/package-solution.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json",
+  "solution": {
+    "name": "Accordion Section FAQ Builder",
+    "id": "bf6fa974-fd40-45a3-80e9-e826abe025b9",
+    "version": "1.3.0.0",
+    "includeClientSideAssets": true,
+    "skipFeatureDeployment": true
+  },
+  "paths": {
+    "zippedPackage": "solution/FAQ-Accordion.sppkg"
+  }
+}

samples/react-accordion-section/config/serve.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/core-build/serve.schema.json",
+  "port": 4321,
+  "https": true,
+  "initialPage": "https://localhost:5432/workbench",
+  "api": {
+    "port": 5432,
+    "entryPath": "node_modules/@microsoft/sp-webpart-workbench/lib/api/"
+  }
+}

samples/react-accordion-section/config/write-manifests.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/write-manifests.schema.json",
+  "cdnBasePath": "<!-- PATH TO CDN -->"
+}

samples/react-accordion-section/gulpfile.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const gulp = require('gulp');
+const build = require('@microsoft/sp-build-web');
+build.addSuppression(`Warning - [sass] The local CSS class 'ms-Grid' is not camelCase and will not be type-safe.`);
+
+build.initialize(gulp);

samples/react-accordion-section/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "react-accordion",
+  "main": "lib/index.js",
+  "version": "0.0.1",
+  "private": true,
+  "engines": {
+    "node": ">=0.10.0"
+  },
+  "scripts": {
+    "build": "gulp bundle",
+    "clean": "gulp clean",
+    "test": "gulp test"
+  },
+  "dependencies": {
+    "@microsoft/sp-core-library": "1.10.0",
+    "@microsoft/sp-lodash-subset": "1.10.0",
+    "@microsoft/sp-office-ui-fabric-core": "1.10.0",
+    "@microsoft/sp-property-pane": "1.10.0",
+    "@microsoft/sp-webpart-base": "1.10.0",
+    "@pnp/common": "^1.3.4",
+    "@pnp/logging": "^1.3.4",
+    "@pnp/odata": "^1.3.4",
+    "@pnp/sp": "^1.3.4",
+    "@pnp/spfx-controls-react": "1.14.0",
+    "@pnp/spfx-property-controls": "1.16.0",
+    "@types/es6-promise": "0.0.33",
+    "@types/react": "16.8.8",
+    "@types/react-dom": "16.8.3",
+    "@types/webpack-env": "1.13.1",
+    "office-ui-fabric-react": "6.189.2",
+    "react": "16.8.5",
+    "react-accessible-accordion": "^3.0.0",
+    "react-dom": "16.8.5"
+  },
+  "resolutions": {
+    "@types/react": "16.8.8"
+  },
+  "devDependencies": {
+    "@microsoft/rush-stack-compiler-2.9": "0.7.7",
+    "@microsoft/rush-stack-compiler-3.3": "0.3.5",
+    "@microsoft/sp-build-web": "1.10.0",
+    "@microsoft/sp-module-interfaces": "1.10.0",
+    "@microsoft/sp-tslint-rules": "1.10.0",
+    "@microsoft/sp-webpart-workbench": "1.10.0",
+    "@types/chai": "3.4.34",
+    "@types/mocha": "2.2.38",
+    "ajv": "~5.2.2",
+    "gulp": "~3.9.1"
+  }
+}

samples/react-accordion-section/src/index.ts

@@ -0,0 +1 @@
+// A file is required to be in the root of the /src directory by the TypeScript compiler

samples/react-accordion-section/src/webparts/reactAccordion/ReactAccordionWebPart.manifest.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx/client-side-web-part-manifest.schema.json",
+  "id": "061da2cd-f680-4da5-ab30-40a8ba1aafd8",
+  "alias": "ReactAccordionWebPart",
+  "componentType": "WebPart",
+
+  // The "*" signifies that the version should be taken from the package.json
+  "version": "*",
+  "manifestVersion": 2,
+
+  // If true, the component can only be installed on sites where Custom Script is allowed.
+  // Components that allow authors to embed arbitrary script code should set this to true.
+  // https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f
+  "requiresCustomScript": false,
+  "supportedHosts": ["SharePointWebPart", "TeamsTab"],
+  "loadLegacyFabricCss": true,
+
+  "preconfiguredEntries": [{
+    "groupId": "5c03119e-3074-46fd-976b-c60198311f70", // Other
+    "group": { "default": "Other" },
+    "title": { "default": "Accordion Section" },
+    "description": { "default": "Collapsible accordion section for displaying list data" },
+    "officeFabricIconFontName": "MusicInCollectionFill",
+    "properties": {
+      "description": "React Accordion",
+      "listId": ""
+    }
+  }]
+}

samples/react-accordion-section/src/webparts/reactAccordion/ReactAccordionWebPart.ts

@@ -0,0 +1,94 @@
+import * as React from 'react';
+import * as ReactDom from 'react-dom';
+import { Version } from '@microsoft/sp-core-library';
+import { BaseClientSideWebPart } from '@microsoft/sp-webpart-base';
+import {
+  IPropertyPaneConfiguration,
+  PropertyPaneTextField,
+  PropertyPaneDropdown,
+  IPropertyPaneDropdownOption
+} from '@microsoft/sp-property-pane';
+import { sp } from "@pnp/sp";
+import 'core-js/es6/array';
+import 'es6-map/implement';
+import 'core-js/modules/es6.array.find';
+import { PropertyFieldListPicker, PropertyFieldListPickerOrderBy } from '@pnp/spfx-property-controls/lib/PropertyFieldListPicker';
+
+import * as strings from 'ReactAccordionWebPartStrings';
+import ReactAccordion from './components/ReactAccordion';
+import { IReactAccordionProps } from './components/IReactAccordionProps';
+import { string } from 'prop-types';
+
+export interface IReactAccordionWebPartProps {
+  listId: string;
+  accordionTitle: string;
+}
+
+export default class ReactAccordionWebPart extends BaseClientSideWebPart<IReactAccordionWebPartProps> {
+
+  public onInit(): Promise<void> {
+    return super.onInit().then(_ => {
+      sp.setup({
+        spfxContext: this.context
+      });
+    });
+  }
+
+  public render(): void {
+    const element: React.ReactElement<IReactAccordionProps > = React.createElement(
+      ReactAccordion,
+      {
+        listId: this.properties.listId,
+        accordionTitle: this.properties.accordionTitle,
+        onConfigure: () => {
+          this.context.propertyPane.open();
+        }
+      }
+    );
+
+    ReactDom.render(element, this.domElement);
+  }
+
+  protected onDispose(): void {
+    ReactDom.unmountComponentAtNode(this.domElement);
+  }
+
+  protected get dataVersion(): Version {
+    return Version.parse('1.0');
+  }
+
+  protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
+    return {
+      pages: [
+        {
+          header: {
+            description: strings.PropertyPaneDescription
+          },
+          groups: [
+            {
+              groupName: strings.BasicGroupName,
+              groupFields: [
+                PropertyPaneTextField('accordionTitle', {
+                  label: 'Accordion Title (optional)'
+                }),
+                PropertyFieldListPicker('listId', {
+                  label: 'Select a list',
+                  selectedList: this.properties.listId,
+                  includeHidden: false,
+                  orderBy: PropertyFieldListPickerOrderBy.Title,
+                  disabled: false,
+                  onPropertyChange: this.onPropertyPaneFieldChanged.bind(this),
+                  properties: this.properties,
+                  context: this.context,
+                  onGetErrorMessage: null,
+                  deferredValidationTime: 0,
+                  key: 'listPickerFieldId'
+                })
+              ]
+            }
+          ]
+        }
+      ]
+    };
+  }
+}

samples/react-accordion-section/src/webparts/reactAccordion/components/IReactAccordionProps.ts

@@ -0,0 +1,5 @@
+export interface IReactAccordionProps {
+  listId: string;
+  accordionTitle: string;
+  onConfigure: () => void;
+}

samples/react-accordion-section/src/webparts/reactAccordion/components/ReactAccordion.module.scss

@@ -0,0 +1,75 @@
+@import '~@microsoft/sp-office-ui-fabric-core/dist/sass/SPFabricCore.scss';
+@import '~office-ui-fabric-react/dist/sass/References.scss';
+
+ .reactAccordion {
+  .container {
+    max-width: 700px;
+    margin: 0px auto;
+    box-shadow: 0 2px 4px 0 rgba(0, 0, 0, 0.2), 0 25px 50px 0 rgba(0, 0, 0, 0.1);
+  }
+
+  .row {
+    @include ms-Grid-row;
+    @include ms-fontColor-white;
+    background-color: $ms-color-themeDark;
+    padding: 20px;
+  }
+
+  .column {
+    @include ms-Grid-col;
+    @include ms-lg10;
+    @include ms-xl8;
+    @include ms-xlPush2;
+    @include ms-lgPush1;
+  }
+
+  .title {
+    @include ms-font-xl;
+    @include ms-fontColor-white;
+  }
+
+  .subTitle {
+    @include ms-font-l;
+    @include ms-fontColor-white;
+  }
+
+  .description {
+    @include ms-font-l;
+    @include ms-fontColor-white;
+  }
+
+  .button {
+    // Our button
+    text-decoration: none;
+    height: 32px;
+
+    // Primary Button
+    min-width: 80px;
+    background-color: $ms-color-themePrimary;
+    border-color: $ms-color-themePrimary;
+    color: $ms-color-white;
+
+    // Basic Button
+    outline: transparent;
+    position: relative;
+    font-family: "Segoe UI WestEuropean","Segoe UI",-apple-system,BlinkMacSystemFont,Roboto,"Helvetica Neue",sans-serif;
+    -webkit-font-smoothing: antialiased;
+    font-size: $ms-font-size-m;
+    font-weight: $ms-font-weight-regular;
+    border-width: 0;
+    text-align: center;
+    cursor: pointer;
+    display: inline-block;
+    padding: 0 16px;
+
+    .label {
+      font-weight: $ms-font-weight-semibold;
+      font-size: $ms-font-size-m;
+      height: 32px;
+      line-height: 32px;
+      margin: 0 4px;
+      vertical-align: top;
+      display: inline-block;
+    }
+  }
+}

samples/react-accordion-section/src/webparts/reactAccordion/components/ReactAccordion.tsx

@@ -0,0 +1,89 @@
+import * as React from 'react';
+import styles from './ReactAccordion.module.scss';
+import { IReactAccordionProps } from './IReactAccordionProps';
+import { sp } from "@pnp/sp";
+import { Placeholder } from "@pnp/spfx-controls-react/lib/Placeholder";
+import './reactAccordion.css';
+
+import {
+  Accordion,
+  AccordionItem,
+  AccordionItemHeading,
+  AccordionItemButton,
+  AccordionItemPanel,
+} from 'react-accessible-accordion';
+
+export interface IReactAccordionState {
+  items: Array<any>;
+}
+
+export default class ReactAccordion extends React.Component<IReactAccordionProps, IReactAccordionState> {
+
+  constructor(props: IReactAccordionProps) {
+    super(props);
+    
+    this.state = {
+      items: new Array<any>()
+    };
+    this.getListItems();
+  }
+
+  private getListItems(): void {
+    if(typeof this.props.listId !== "undefined" && this.props.listId.length > 0) {
+      sp.web.lists.getById(this.props.listId).items.select("Title","Content").get()
+        .then((results: Array<any>) => {
+          this.setState({
+            items: results
+          });
+        })
+        .catch((error:any) => {
+          console.log("Failed to get list items!");
+          console.log(error);
+        });
+    }
+  }
+
+  public componentDidUpdate(prevProps:IReactAccordionProps): void {
+    if(prevProps.listId !== this.props.listId) {
+      this.getListItems();
+    }
+  }
+
+  public render(): React.ReactElement<IReactAccordionProps> {
+    let listSelected:boolean = typeof this.props.listId !== "undefined" && this.props.listId.length > 0;
+    return (
+      <div className={ styles.reactAccordion }>
+        {!listSelected &&
+          <Placeholder
+            iconName='MusicInCollectionFill'
+            iconText='Configure your web part'
+            description='Select a list with a Title field and Content field to have its items rendered in a collapsible accordion format'
+            buttonLabel='Choose a List'
+            onConfigure={this.props.onConfigure} />
+        }
+        {listSelected &&
+        <div>
+          <h2>{this.props.accordionTitle}</h2>
+          <Accordion> 
+            {this.state.items.map((item:any) => {
+              return (
+                <AccordionItem>
+                  <AccordionItemHeading>
+                    <AccordionItemButton>
+                      {item.Title}
+                    </AccordionItemButton>
+                  </AccordionItemHeading>
+                    <AccordionItemPanel>
+                      <p  dangerouslySetInnerHTML={{__html: item.Content}} />
+                    </AccordionItemPanel>
+                </AccordionItem>
+                );
+              })
+            }
+          </Accordion>
+        </div> 
+        }
+      </div>
+      );
+  }
+}

samples/react-accordion-section/src/webparts/reactAccordion/components/reactAccordion.css

@@ -0,0 +1,57 @@
+.accordion {
+    border: 1px solid rgba(0, 0, 0, 0.1);
+    border-radius: 2px;
+}
+
+.accordion__item + .accordion__item {
+    border-top: 1px solid rgba(0, 0, 0, 0.1);
+}
+
+.accordion__button {
+    background-color: #f4f4f4;
+    color: #444;
+    cursor: pointer;
+    padding: 18px;
+    text-align: left;
+    border: none;
+}
+
+.accordion__button:hover {
+    background-color: #ddd;
+}
+
+.accordion__button:before {
+    display: inline-block;
+    content: '';
+    height: 10px;
+    width: 10px;
+    margin-right: 12px;
+    border-bottom: 2px solid currentColor;
+    border-right: 2px solid currentColor;
+    transform: rotate(-45deg);
+}
+
+.accordion__button[aria-expanded='true']::before,
+.accordion__button[aria-selected='true']::before {
+    transform: rotate(45deg);
+}
+
+.accordion__panel {
+    padding: 20px;
+    animation: fadein 0.35s ease-in;
+}
+
+h2 {
+    text-align: center;
+    color: #444;
+}
+
+@keyframes fadein {
+    0% {
+        opacity: 0;
+    }
+
+    100% {
+        opacity: 1;
+    }
+}

samples/react-accordion-section/src/webparts/reactAccordion/loc/en-us.js

@@ -0,0 +1,7 @@
+define([], function() {
+  return {
+    "PropertyPaneDescription": "",
+    "BasicGroupName": "Settings",
+    "DescriptionFieldLabel": "Accordion Section"
+  }
+});

samples/react-accordion-section/src/webparts/reactAccordion/loc/mystrings.d.ts

@@ -0,0 +1,10 @@
+declare interface IReactAccordionWebPartStrings {
+  PropertyPaneDescription: string;
+  BasicGroupName: string;
+  DescriptionFieldLabel: string;
+}
+
+declare module 'ReactAccordionWebPartStrings' {
+  const strings: IReactAccordionWebPartStrings;
+  export = strings;
+}

samples/react-accordion-section/tsconfig.json

@@ -0,0 +1,38 @@
+{
+  "extends": "./node_modules/@microsoft/rush-stack-compiler-3.3/includes/tsconfig-web.json",
+  "compilerOptions": {
+    "target": "es5",
+    "forceConsistentCasingInFileNames": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "jsx": "react",
+    "declaration": true,
+    "sourceMap": true,
+    "experimentalDecorators": true,
+    "skipLibCheck": true,
+    "outDir": "lib",
+    "inlineSources": false,
+    "strictNullChecks": false,
+    "noUnusedLocals": false,
+    "typeRoots": [
+      "./node_modules/@types",
+      "./node_modules/@microsoft"
+    ],
+    "types": [
+      "es6-promise",
+      "webpack-env"
+    ],
+    "lib": [
+      "es5",
+      "dom",
+      "es2015.collection"
+    ]
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "lib"
+  ]
+}

samples/react-accordion-section/tslint.json

@@ -0,0 +1,30 @@
+{
+  "extends": "@microsoft/sp-tslint-rules/base-tslint.json",
+  "rules": {
+    "class-name": false,
+    "export-name": false,
+    "forin": false,
+    "label-position": false,
+    "member-access": true,
+    "no-arg": false,
+    "no-console": false,
+    "no-construct": false,
+    "no-duplicate-variable": true,
+    "no-eval": false,
+    "no-function-expression": true,
+    "no-internal-module": true,
+    "no-shadowed-variable": true,
+    "no-switch-case-fall-through": true,
+    "no-unnecessary-semicolons": true,
+    "no-unused-expression": true,
+    "no-use-before-declare": true,
+    "no-with-statement": true,
+    "semicolon": true,
+    "trailing-comma": false,
+    "typedef": false,
+    "typedef-whitespace": false,
+    "use-named-parameter": true,
+    "variable-name": false,
+    "whitespace": false
+  }
+}