Skip to content

Spfx webpart to display images and folders in Library Thumbnail style

Notifications You must be signed in to change notification settings

CreativeAcer/spfx-sp-image-display

Repository files navigation

spfx-image-display

This project uses React.

About


This project can be used to display images on a page. Images will be gathered from a SharePoint Picture Library.

CodeFactor

If you like the project please Star it .
Feel free to contribute!

Lightroom effect uses the following library:
react-awesome-lightbox.

Core features


  1. Select SharePoint Image/Document Library
  2. Navigate through images and folders
  3. Use breadcrumb to move through the libray
  4. Show lightroom for images
  5. Set the amount of columns for the gallery
  6. Show image title on hover
  7. Create Picture library from spfx webaprt properties

Usage

Install
Install

Demo
Demo

Lightroom-view
Lightroom-view

Global dependencies

Requires Gulp globally installed:

npm install --global gulp

Building the code

Download & install all dependencies, build, bundle & package the project

# download & install dependencies
npm install

# transpile all TypeScript & SCSS => JavaScript & CSS
gulp build

# create component bundle & manifest
gulp bundle

# create SharePoint package
gulp package-solution

These commands produce the following:

  • ./lib: intermediate-stage commonjs build artifacts
  • ./dist: bundled script, along with other resources
  • ./temp/deploy: all resources required by component(s) to deploy to a CDN (when --ship argument present)

Build options

  • gulp clean: Deletes all build output (/dist, /lib, /temp, etc.).
  • gulp build: Transpiles all TypeScript & SCSS to JavaScript & CSS, generates source map files & TypeScript type declaration files
  • gulp bundle [--ship|-p|--production]: Runs gulp task build, then uses webpack to create the JavaScript bundle(s) and component manifest(s) as defined in ./config/config.json. The --ship, -p or --production argument specifies a production build that will generate minified bundles.
  • gulp serve [--ship|-p|--production]: Runs gulp tasks build, bundle & starts the local webserver. Depending on the project type, it opens the browser and navigates to the local workbench or specified URL (in the case of extension components). The --ship, -p or --production argument specifies a production build that modifies the resulting package for production hosting rather than local hosting of assets.
  • gulp package-solution: Creates the SharePoint Package (.sppkg) file.
  • gulp dist: Creates a production-ready SharePoint Package (.sppkg) file. The following gulp task gets executed in this specific order gulp clean, gulp bundle, gulp package-solution.
  • gulp dev: Creates a development-ready SharePoint Package (.sppkg) file. The following gulp task will be executed in this specific order gulp clean, gulp bundle, gulp package-solution.

View all available gulp tasks by running gulp --tasks

More information on SharePoint Framework

Generated with pnp/spfx.

Releases

No releases published

Packages

No packages published