sp-dev-fx-webparts/samples/react-adaptive-cards-image-gallery/README.md

page_type	products	languages	extensions
sample	office-sp	javascript typescript	contentType technologies platforms createdDate samples SharePoint Framework React 11/28/2018 12:00:00 AM

Image Gallery Built with Adaptive Cards

Summary

This sample demonstrates the capability of using Adaptive Cards with SharePoint Framework. Adaptive cards are great fit for Bot, however they can be effectively used with SPFx to render the content. This web part helps to display the image gallery from SharePoint list.

When added to SharePoint site, the source list containing images information, number of images to display can be configured from web part properties. The sample also provisions the list called "Adaptive Card Images" which can be used as an example to start using the web part.

SharePoint Asset

A SharePoint list (named "Adaptive Card Images") is provisioned to store the image information. The schema of the list is as below.

• The "Image Link" column stores the url of image to be displayed in adaptive card.
• The "Navigation URL" column represents the url to navigate by clicking on image in adaptive card.
• The "Sort Order" column represents the order in which images to be displayed in adaptive card.

The solution also provisions sample data to the "Adaptive Card Images" list.

NPM Packages Used

Below NPM packages are used to develop this sample.

1. sp-pnp-js (https://www.npmjs.com/package/sp-pnp-js)
2. adaptivecards (https://www.npmjs.com/package/adaptivecards)

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

• SharePoint Framework Developer Preview
• Office 365 developer tenant

Contributors

• Nanddeep Nachan
• Ravi Kulkarni

Version history

Version	Date	Comments
1.1.0	June 15, 2020	Upgrade to SPFx 1.10.0
1.0.0	November 28, 2018	Initial release

Prerequisites

• SharePoint Online tenant
• Site Collection created under the /sites/ or /

Minimal Path to Awesome

• Clone this repository.
• On the command prompt, navigate to the web part folder and execute:
• npm i
• gulp bundle --ship
• gulp package-solution --ship
• The package can be found at \react-adaptive-cards-image-gallery\sharepoint\solution\react-adaptive-cards-image-gallery.sppkg
• Deploy the package to the app catalog.
• Install the client-side solution to your SharePoint site.
• Add web part to your SharePoint page named "Adaptive Cards Image Gallery".

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

Features

This sample web part shows how adaptive cards can be used effectively with SharePoint Framework to render an image gallery with data stored in a SharePoint list.

• Integrating adaptive cards
• Rendering image gallery
• SharePoint assets provisioning
• Creating extensible services
• Using @sp-pnp-js
• Using @adaptivecards

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.