sp-dev-fx-webparts/samples/react-image-gallery
Hugo Bernier 7e97daab76 Added more contributions 2023-03-15 01:23:34 -04:00
..
.devcontainer Updated sample.json and readme 2022-06-02 13:21:11 -04:00
assets Changed docs links to learn 2022-10-24 09:42:45 -04:00
config Update SPFx 2022-05-23 00:17:10 +07:00
src Update SPFx 2022-05-23 00:17:10 +07:00
teams Update SPFx 2022-05-23 00:17:10 +07:00
.editorconfig
.gitignore Updated sample.json and readme 2022-06-02 13:21:11 -04:00
.npmignore Update SPFx 2022-05-23 00:17:10 +07:00
.yo-rc.json Update SPFx 2022-05-23 00:17:10 +07:00
README.md Added more contributions 2023-03-15 01:23:34 -04:00
gulpfile.js Update SPFx 2022-05-23 00:17:10 +07:00
npm-shrinkwrap.json Bump decode-uri-component in /samples/react-image-gallery 2022-12-31 03:55:43 +00:00
package-lock.json Bump decode-uri-component in /samples/react-image-gallery 2022-12-31 03:55:43 +00:00
package.json Update SPFx 2022-05-23 00:17:10 +07:00
tsconfig.json Update SPFx 2022-05-23 00:17:10 +07:00
tslint.json Update SPFx 2022-05-23 00:17:10 +07:00

README.md

Filterable Image Gallery

Summary

This sample describes an SPFx application which implements an image gallery with taxonomy base filtering and typed search. This application also implements pagination.

Filterable Image Gallery web part built on the SharePoint Framework using React

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.14 Node.js v14 | v12 Compatible with SharePoint Online Compatible with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Compatible Hosted Workbench Compatible

Applies to

Contributors

Version history

Version Date Comments
1.0 March 01, 2019 Initial release
1.1 May 23, 2022 Update SPFx version, update README, and fix minor issues

Minimal Path to Awesome

  • Clone this repository (or download this solution as a .ZIP file then unzip it)

  • From your command line, change your current directory to the directory containing this sample (react-image-gallery, located under samples)

  • in the command line run:

    • npm install
    • gulp serve
  • Create a Departments Term set with associated child terms, for example, HR, Information Services, Sales, Marketing

  • Create an Image Library and add some sample images

  • Tag each image with Department Metadata Column

  • Also fill in Title field for each image, this is require for typed search functionality

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

Features

Here are the main features for this application

  • Taxonomy-based filtering
  • Typed Search
  • Right-side popup panel
  • Server-side pagination using REST API

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