History

Hugo Bernier 103907bdc6 Added compatibility warning on readme and template		2023-02-10 10:22:32 -05:00
..
assets	V1.0	2020-11-06 17:29:14 +08:00
config	V1.0	2020-11-06 17:29:14 +08:00
src	V1.0	2020-11-06 17:29:14 +08:00
teams	V1.0	2020-11-06 17:29:14 +08:00
typings	V1.0	2020-11-06 17:29:14 +08:00
.editorconfig	V1.0	2020-11-06 17:29:14 +08:00
.gitattributes	V1.0	2020-11-06 17:29:14 +08:00
.gitignore	V1.0	2020-11-06 17:29:14 +08:00
.npmignore	V1.0	2020-11-06 17:29:14 +08:00
.yo-rc.json	V1.0	2020-11-06 17:29:14 +08:00
README.md	Added compatibility warning on readme and template	2023-02-10 10:22:32 -05:00
gulpfile.js	V1.0	2020-11-06 17:29:14 +08:00
package-lock.json	V1.0	2020-11-06 17:29:14 +08:00
package.json	V1.0	2020-11-06 17:29:14 +08:00
tsconfig.json	V1.0	2020-11-06 17:29:14 +08:00
tslint.json	V1.0	2020-11-06 17:29:14 +08:00

README.md

Microsoft Bot Framework Web Chat

Summary

A web part sample that uses the botframework-webchat module to create a React component to render the Bot Framework v4 webchat component. This web part is able to render Text and rich attachments (Images, Cards, Adaptive Cards, ...) and has settings for branding purposes.

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.

Applies to

Prerequisites

You need to have this bot created and registered using the Microsoft Bot Framework and registered to use the Direct Line Channel, which will give you the token generation endpoint needed when adding this web part to the page. For more information on creating a bot and registering the channel you can see the official web site at dev.botframework.com.

Minimal Path to Awesome

Clone this repository
in the command line run:
```
npm install
gulp serve
```
Set the bot service URI as Bot EndPoint.
Config bot endpoint
Add the web part, set the bot endpoint to https://YOUR_BOT.azurewebsites.net, refresh the page, then you can successfully connect the bot with SharePoint.

Deploy

If you want to deploy the bot follow the steps in the Host your client-side web part from Microsoft 365 CDN article

Features

This Web Part illustrates the following concepts on top of the SharePoint Framework:

Connecting and communicating with a bot built on the Microsoft Bot Framework using the Direct Line Channel
Validating Property Pane Settings
Office UI Fabric
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.