honeymoose
/
sp-dev-fx-webparts
mirror of https://github.com/pnp/sp-dev-fx-webparts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
sp-dev-fx-webparts/samples/react-carousel/README.md

6.4 KiB
Raw Blame History

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

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

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

Contributors

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.

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

Video

Community Demo - Building a custom React based carousel web part for modern SharePoint

Help

We do not support samples, but 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.