109 lines
4.2 KiB
Markdown
109 lines
4.2 KiB
Markdown
---
|
|
page_type: sample
|
|
products:
|
|
- office-sp
|
|
languages:
|
|
- javascript
|
|
- typescript
|
|
extensions:
|
|
contentType: samples
|
|
technologies:
|
|
- SharePoint Framework
|
|
platforms:
|
|
- react
|
|
createdDate: 04/25/2017 12:00:00 AM
|
|
---
|
|
# Frequently Asked Questions App
|
|
|
|
## Summary
|
|
|
|
- This Web Part allows users to create Frequently Asked Questions(Faq App) in modern and classic SharePoint pages.
|
|
- This web part allows to search within questions and answers which are stored in a SharePoint FAQ list.
|
|
- "React-autosuggest and react-accessible-accordion" react packages are used for the search and accordion control.
|
|
|
|
![Web part preview](assets/FAQWebpart.png)
|
|
|
|
## Compatibility
|
|
|
|
| :warning: 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.8.2](https://img.shields.io/badge/SPFx-1.8.2-green.svg)
|
|
![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg)
|
|
![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
|
|
![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg)
|
|
![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
|
|
![Local Workbench Compatible](https://img.shields.io/badge/Local%20Workbench-Compatible-green.svg)
|
|
![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg)
|
|
![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)
|
|
|
|
## Applies to
|
|
|
|
- [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
|
|
- [Microsoft 365 tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
|
|
|
|
## Contributors
|
|
|
|
- [Ashok Swain](https://github.com/ashokswain27)
|
|
- [Abderahman Moujahid](https://github.com/Abderahman88)
|
|
|
|
## Version history
|
|
|
|
Version|Date|Comments
|
|
-------|----|--------
|
|
1.0.0 | April 25, 2020 | Initial release
|
|
1.0.1 | October 30, 2020 | Fix limit 100 items
|
|
|
|
## 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
|
|
|
|
- `git clone` the repo
|
|
- `npm i`
|
|
- `npm i -g gulp`
|
|
- `gulp serve`
|
|
|
|
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit <https://aka.ms/spfx-devcontainer> for further instructions.
|
|
|
|
### Local Mode
|
|
|
|
A browser in local mode (localhost) will be opened.
|
|
`https://localhost:4321/temp/workbench.html`
|
|
|
|
### SharePoint Mode
|
|
|
|
If you want to try on a real environment, open:
|
|
`https://[your-domain].sharepoint.com/_layouts/15/workbench.aspx`
|
|
|
|
## Usage
|
|
|
|
- Create a FAQ List in SharePoint.
|
|
- Create the below fields:
|
|
- `Title` field can be considered as "Question" field.
|
|
|
|
Column Name|Field Type
|
|
-------|----
|
|
`Title`|Single line of text
|
|
`Answer`|Multiple lines of text
|
|
`Category`|Single line of text
|
|
`CategorySortOrder`|Number
|
|
`QuestionSortOrder`|Number
|
|
|
|
- Edit the web part, set the **ListName** in the property pane
|
|
|
|
## Features
|
|
|
|
- This Web Part allows users to create Frequently Asked Questions(FAQ App) in modern and classic SharePoint pages.
|
|
- An accordion layout is used to make it easy to browse through different questions.
|
|
- Expand answers to your most frequent questions.
|
|
- Include text, links, images in your answers.
|
|
- A search bar to make your FAQ accordion searchable.
|
|
- This web part allows to search within questions and answers which are stored in a SharePoint FAQ list.
|
|
- Sorting is enabled on both the category & Question
|
|
|
|
<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-FAQApp" />
|