sp-dev-fx-webparts/samples/react-doccard-faq/README.md

5.2 KiB

FAQ Document Card

React FAQ Document Card Web Part

Summary

For detailed instructions on how to build this web part and the needed list please watch: https://www.youtube.com/watch?v=oIr-rgGvUUk

picture of the web part in action picture of the web part in action

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.

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 Compatible with Remote Containers

Applies to

Prerequisites

  1. Build a SharePoint Online list named FAQ

  2. Rename Title column to Question

  3. Add 3 additional columns:

    • Multiple lines of text column, toggle Use rich text to yes, name Answer
    • Choice column, Options Work, Personal, and Hobby, name Category
    • Yes/No column, set default to No, name Featured
  4. Add items to your list making sure to set some to yes in the Featured column

  5. Navigate to your sites workbench (https://.sharepoint.com/sites//_layouts/15/workbench.aspx)

Solution

Solution Author(s)
react-doccard-faq Sam Collins (@samc148)

Version history

Version Date Comments
1.0 April 5, 2021 Initial release

Minimal Path to Awesome

  • Clone this repository
  • in the command line run:
    • npm install
    • gulp serve

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

Features

DefaultButton, Modal, DetailsList, IColumn, from office-ui-fabric-react

IPropertyPaneDropdownOption from @microsoft/sp-property-pane

RichText, Accessible Accordion from @pnp/spfx-controls-react

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.