|
1 | | -# image-slider |
2 | | - |
| 1 | +# Image Slider |
| 2 | + |
| 3 | + |
| 4 | +[](https://dev.azure.com/scfagan/pipelineBuilds/_build/latest?definitionId=19&repoName=FaganSC%2FspfxImageSlider&branchName=master) |
| 5 | + |
| 6 | + |
| 7 | + |
3 | 8 | ## Summary |
| 9 | +This a SharePoint Online modern web part of an image slider, which cycles images from a Document Libray as a slideshow. It works with a series of images, text, or custom markup. It also includes support for previous/next controls and indicators. |
4 | 10 |
|
5 | | -Short summary on functionality and used technologies. |
6 | | - |
7 | | -[picture of the solution in action, if possible] |
8 | | - |
9 | | -## Used SharePoint Framework Version |
| 11 | +The supporting Document Library is deployed when the solution is added to the site. |
10 | 12 |
|
11 | | - |
| 13 | + |
12 | 14 |
|
13 | 15 | ## Applies to |
14 | 16 |
|
15 | 17 | - [SharePoint Framework](https://aka.ms/spfx) |
16 | 18 | - [Microsoft 365 tenant](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant) |
17 | 19 |
|
18 | | -> Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram) |
19 | | -
|
20 | | -## Prerequisites |
21 | | - |
22 | | -> Any special pre-requisites? |
23 | | -
|
| 20 | +### 3rd Party Packages |
| 21 | +* [PnPjs](https://pnp.github.io/pnpjs/) |
| 22 | +* [PnP Controls React](https://pnp.github.io/sp-dev-fx-controls-react/) |
| 23 | +* [PnP Property Controls](https://pnp.github.io/sp-dev-fx-property-controls/) |
| 24 | +* [Moment.js](https://momentjs.com/) |
| 25 | + |
| 26 | +## Office 365 CDN |
| 27 | +The Office 365 CDN is used by default for downloading generic resource assets like the Office 365 client applications from a public origin. |
| 28 | + |
| 29 | +This image slide supports the use of the Office 365 CDN by enabling the document library deployed with the soluiton by the following PowerShell commands. |
| 30 | +~~~powershell |
| 31 | +Connect-SPOService https://<tenant>-admin.sharepoint.com |
| 32 | +Set-SPOTenantCdnEnabled -CdnType Both -Enable $true |
| 33 | +Add-SPOTenantCdnOrigin -CdnType Public -OriginUrl */SliderImgs |
| 34 | +~~~ |
| 35 | + |
| 36 | +Once enabled, just toggle the setting within the Web Part properties to utilize the Office 365 CDN to display your images. |
24 | 37 | ## Solution |
25 | 38 |
|
26 | 39 | Solution|Author(s) |
27 | 40 | --------|--------- |
28 | | -folder name | Author details (name, company, twitter alias with link) |
| 41 | +SPFX Image Slider | [Shawn Fagan](https://twitter.com/fagansc) |
29 | 42 |
|
30 | | -## Version history |
| 43 | +## Version History |
31 | 44 |
|
32 | 45 | Version|Date|Comments |
33 | 46 | -------|----|-------- |
34 | | -1.1|March 10, 2021|Update comment |
35 | | -1.0|January 29, 2021|Initial release |
36 | | - |
37 | | -## Disclaimer |
38 | | - |
39 | | -**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.** |
40 | | - |
41 | | ---- |
| 47 | +1.0.0.0|January 24, 2021|Initial release |
42 | 48 |
|
43 | | -## Minimal Path to Awesome |
| 49 | +## Current Features |
| 50 | +### Image Size |
44 | 51 |
|
45 | | -- Clone this repository |
46 | | -- Ensure that you are at the solution folder |
47 | | -- in the command-line run: |
48 | | - - **npm install** |
49 | | - - **gulp serve** |
| 52 | +### Slide Speed |
| 53 | +### Display Image Filter |
50 | 54 |
|
51 | | -> Include any additional steps as needed. |
| 55 | +### Display Slide Caption |
52 | 56 |
|
53 | | -## Features |
| 57 | +### Display Slide Indicators |
54 | 58 |
|
55 | | -Description of the extension that expands upon high-level summary above. |
| 59 | +### Render Images using Office 365 Public CDN |
56 | 60 |
|
57 | | -This extension illustrates the following concepts: |
| 61 | +### Select Default Image |
58 | 62 |
|
59 | | -- topic 1 |
60 | | -- topic 2 |
61 | | -- topic 3 |
| 63 | +## Future Features |
| 64 | + - Multplie Layout Options |
| 65 | + - Configurable Caption Settings |
| 66 | + - Configurable Indicators Settings |
| 67 | + - Use of Office 365 Private CDN |
| 68 | + - SharePoint Online Theme integration |
| 69 | + - Controlling required Document Library fields based on Image Filter |
62 | 70 |
|
63 | | -> Notice that better pictures and documentation will increase the sample usage and the value you are providing for others. Thanks for your submissions advance. |
64 | | -
|
65 | | -> Share your web part with others through Microsoft 365 Patterns and Practices program to get visibility and exposure. More details on the community, open-source projects and other activities from http://aka.ms/m365pnp. |
| 71 | +## License |
| 72 | +Connect-MS365 is licensed under terms of GNU Lesser General Publice License (LGPL) v3.0. For further information see LICENSE file. |
66 | 73 |
|
| 74 | +## Contribute |
| 75 | +Please feel free to comment, feedback and contribute to this. I'm still working on the GitHub setup for handling External Pull Requests. |
67 | 76 | ## References |
68 | 77 |
|
69 | 78 | - [Getting started with SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant) |
70 | 79 | - [Building for Microsoft teams](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/build-for-teams-overview) |
71 | 80 | - [Use Microsoft Graph in your solution](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/using-microsoft-graph-apis) |
72 | 81 | - [Publish SharePoint Framework applications to the Marketplace](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/publish-to-marketplace-overview) |
73 | 82 | - [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development |
| 83 | + |
| 84 | +--- |
| 85 | +## Disclaimer |
| 86 | + |
| 87 | +**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.** |
0 commit comments