sp-dev-fx-webparts/samples/react-carousel/README.md

4.9 KiB

page_type products languages extensions
sample
office-sp
sharepoint
javascript
typescript
contentType technologies platforms createdDate
samples
SharePoint Framework
React
06/17/2016 12:00:00 AM

Images and Videos in a Carousel

Summary

This web part show images and videos in carousel

It uses Microsoft Graph API to get image/video url and use PnPjs to load files from Picture library the images/videos are loading in lazy mode, progressively.

carousel

Compatibility

SPFx 1.12.1 Node.js LTS v14 | LTS v12 | LTS v10 SharePoint Online Teams N/A: Untested with Microsoft Teams Workbench Local | Hosted

Applies to

Web Part Properties

Property Type Required comments
Site Url of library Text yes
Picture Library Choice/Dropdown yes this is filled with all Picture Libraries (BaseTemplate : 109)
number images to load number yes number between 1 and 200

react-slick Props

For all available props, go here.

react-slick Methods

For all available methods, go here

Solution

The web part Use PnPjs library, Microsoft Graph API, Office-ui-fabric-react components, react-slick Component

Solution Author(s)
Carousel Image/Video Web Part João Mendes
Carousel Image/Video Web Part Rahul Suryawanshi (@rahulsuryawansh)
Carousel Image/Video Web Part Don Kirkham (@DonKirkham)
Carousel Image/Video Web Part Harsha Vardhini (@harshagracy)
Carousel Image/Video Web Part Giuliano De Luca (@delucagiulian)

Version history

Version Date Comments
1.0.0 July 11, 2019 Initial release
2.0.0 June 17, 2020 Upgraded to SPFx v1.10.0 (Rahul Suryawanshi)
3.0.0 October 31, 2020 Upgraded to SPFx v1.11.0 (Don Kirkham)
4.0.0 June 10, 2021 Upgraded to SPFx v1.12.1 (Giuliano De Luca)

Minimal Path to Awesome

  • Clone this repository
  • in the command line run:
    • npm install
    • gulp build
    • gulp bundle --ship
    • gulp package-solution --ship
    • Add to AppCatalog and deploy
  • Make sure you have at least one Picture Library on one of your site collections
  • Add the web part to a page
  • In the web part's property pane, enter the Site Url (if library is on a different site collect) and select a Picture Library from the Library drop-down.

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.

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 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.