sp-dev-fx-webparts/samples/react-teams-meeting-app-que.../README.md

11 KiB

Questionnaire Teams Meeting App

Summary

SPFx v1.12.1 and later support for Microsoft Teams meeting apps development. Questionnaire meeting app provides Pre-meeting app experience for MS Teams meeting attendees to ask the questions related to meeting before the meeting starts.

Web Part Preview

The Questionnaire meeting app displays the questions from attendees as pre-meeting app experience. Questionnaire Preview

NPM Packages Used

Below NPM package(s) are used to develop this sample:

  1. @pnp/sp (https://pnp.github.io/pnpjs/sp/)
  2. moment (https://www.npmjs.com/package/moment)

Project setup and important files

spfx-react-teams-meeting-app-questionnaire
    ├── teams                                                     <-- MS Teams manifest
    │   └── manifest.json
    └── src
        └── models
            ├── IQuestionnaireItem.ts
        └── services
            ├── SPOService.ts                                     <-- Extensible Service
        └── webparts
            └── questionnaireMeetingApp
                ├── QuestionnaireMeetingAppWebPart.manifest.json  <-- Configurable web part properties
                ├── QuestionnaireMeetingAppWebPart.ts
                ├── components
                │   └── QuestionnaireMeetingApp
                │   │   ├── QuestionnaireMeetingApp.tsx           <-- Questionnaire Component
                │   │   ├── QuestionnaireMeetingApp.module.scss
                │   │   ├── IQuestionnaireMeetingAppProps.ts
                │   │   ├── IQuestionnaireMeetingAppState.ts
                │   └── Popup                                     <-- New Question Creation Component
                |   │   ├── AskQuestion.tsx
                |   │   ├── IAskQuestionProps.ts
                |   │   ├── IAskQuestionState.ts
                └── loc
                    ├── en-us.js
                    └── mystrings.d.ts

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.14 Node.js v14 | v12 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Unsupported Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Get your own free development tenant by subscribing to Microsoft 365 developer program

Prerequisites

  • Administrative access to MS Teams to deploy the package

Web Part Properties

The properties should be pre-configured inside QuestionnaireMeetingAppWebPart.manifest.json as when the web part is added as MS Teams meeting experience, we do not get any settings to configure.

Property Type Required Default value Comments
siteUrl Text Yes / Provide the relative URL of the site where below list exists.
listName Text Yes Teams Meeting Questionnaire Title of the list storing meeting questionnaires.

SharePoint Asset

A SharePoint list (named Teams Meeting Questionnaire) should be manually created to store the meeting questionnaires. The schema of the list is as below.

Display Name Internal Name Type Required Comments
Title Title Single line of text Y OOB Title column
Description Description Multiple lines of text N
MeetingID MeetingID Single line of text N

Minimal Path to Awesome

SharePoint deployment

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

  • Clone this repo
  • Navigate to the folder with current sample
  • Restore dependencies: npm i
  • Bundle the solution: gulp bundle --ship
  • Package the solution: gulp package-solution --ship
  • Locate the solution at ./sharepoint/solution/spfx-ms-teams-questionnaire-meeting-app.sppkg and upload it to SharePoint tenant app catalog

Deploy SPFx solution

  • Select Make this solution available to all sites in the organization.
  • Click Deploy.

MS Teams deployment

  • Navigate to teams folder and zip the content (2 .png files and manifest.json).
  • Open MS Teams.
  • Click Apps.
  • Click Upload a custom app > Upload for .

Deploy to MS Teams

Solution

Solution Author(s)
spfx-react-teams-meeting-app-questionnaire Nanddeep Nachan (https://www.linkedin.com/in/nanddeepnachan/) (SharePoint Consultant, @NanddeepNachan)
spfx-react-teams-meeting-app-questionnaire Ravi Kulkarni (SharePoint Consultant, @RaviKul16a87)
spfx-react-teams-meeting-app-questionnaire Smita Nachan (SharePoint Consultant, @SmitaNachan)

Version history

Version Date Comments
2.0.0 September 28, 2021 Upgraded to SPFx v1.12.1 (Nanddeep Nachan, Smita Nachan)
1.0.0 March 22, 2021 Initial release

Features

This project contains sample client-side web part built on the SharePoint Framework illustrating possibilities to surface SPFx web part as Microsoft Teams meeting app.

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

  • Surface SPFx web part as Microsoft Teams meeting app
  • Using PnP/PnPjs
  • Creating extensible services
  • Using Office UI Fabric controls for building SharePoint Framework client-side web parts

Video

Microsoft Teams Meeting Questionnaire App with SharePoint Framework

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.

References

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.