Skip to content

Commit

Permalink
2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
chrobaktruhlik authored Mar 10, 2023
1 parent c3bb0b7 commit 066c8ce
Show file tree
Hide file tree
Showing 38 changed files with 900 additions and 621 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Auto detect text files and perform LF normalization
* text=auto
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,8 @@ obj
*.scss.ts

package-lock.json

# Sensitive data
.env

*.scss.d.ts
16 changes: 16 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
!dist
config

gulpfile.js

release
src
temp

tsconfig.json
tslint.json

*.log

.yo-rc.json
.vscode
6 changes: 3 additions & 3 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"recommendations": [
"msjsdiag.debugger-for-chrome"
]
"recommendations": [
"rioj7.command-variable"
]
}
81 changes: 40 additions & 41 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -1,43 +1,42 @@
{
/**
* Install Chrome Debugger Extension for Visual Studio Code to debug your components with the
* Chrome browser: https://aka.ms/spfx-debugger-extensions
*/
"version": "0.2.0",
"configurations": [{
"name": "Local workbench",
"type": "chrome",
"request": "launch",
"url": "https://localhost:4321/temp/workbench.html",
"webRoot": "${workspaceRoot}",
"sourceMaps": true,
"sourceMapPathOverrides": {
"webpack:///.././src/*": "${webRoot}/src/*",
"webpack:///../../../src/*": "${webRoot}/src/*",
"webpack:///../../../../src/*": "${webRoot}/src/*",
"webpack:///../../../../../src/*": "${webRoot}/src/*"
},
"runtimeArgs": [
"--remote-debugging-port=9222"
]
},
{
"name": "Hosted workbench",
"type": "chrome",
"request": "launch",
"url": "https://enter-your-SharePoint-site/_layouts/workbench.aspx",
"webRoot": "${workspaceRoot}",
"sourceMaps": true,
"sourceMapPathOverrides": {
"webpack:///.././src/*": "${webRoot}/src/*",
"webpack:///../../../src/*": "${webRoot}/src/*",
"webpack:///../../../../src/*": "${webRoot}/src/*",
"webpack:///../../../../../src/*": "${webRoot}/src/*"
},
"runtimeArgs": [
"--remote-debugging-port=9222",
"-incognito"
]
}
]
"version": "0.2.0",
"configurations": [
{
"name": "SPFx",
"type": "msedge",
"request": "launch",

// You have to create '.env' file with key: 'URL=https://your-sharepoint-site'
"url": "${input:envfile.url}/_layouts/workbench.aspx",

"webRoot": "${workspaceRoot}",
"sourceMaps": true,
"resolveSourceMapLocations": [
"${workspaceFolder}/**",
"!**/node_modules/**"
],
"sourceMapPathOverrides": {
"webpack:///.././src/*": "${webRoot}/src/*",
"webpack:///../../../src/*": "${webRoot}/src/*",
"webpack:///../../../../src/*": "${webRoot}/src/*",
"webpack:///../../../../../src/*": "${webRoot}/src/*"
},
"runtimeArgs": [
"--remote-debugging-port=9222",
"-incognito"
]
}
],
"inputs": [
{
"id": "envfile.url",
"type": "command",
"command": "extension.commandvariable.file.content",
"args": {
"fileName": "${workspaceFolder}/.env",
"key": "URL",
"default": "https://enter-your-SharePoint-site"
}
}
]
}
15 changes: 14 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
// Place your settings in this file to overwrite default and user settings.
{
"typescript.tsdk": "node_modules/typescript/lib"
// Configure glob patterns for excluding files and folders in the file explorer.
"files.exclude": {
"**/.git": true,
"**/.DS_Store": true,
"**/bower_components": true,
"**/coverage": true,
"**/lib-amd": true,
"src/**/*.scss.ts": true
},
"typescript.tsdk": "./node_modules/typescript/lib",
"files.associations": {
"**/src/webparts/**/*.manifest.json": "jsonc"
}
}
13 changes: 0 additions & 13 deletions .yo-rc.json

This file was deleted.

23 changes: 18 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,25 @@

All notable changes to the `align-comments-vscode-extension` extension.

Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.

## [Unreleased]
- Add options specifying how to sort photo gallery folders.
- Folder name in two lines.
- Correct the names of libraries and library folders
- Nothing


## [2.0.0] - 2023-03-xx
First public release. It retains the version numbering continuing from the original. Release 2.0.0 is first new, modified version.

- New: Ordering the root document library in the properties panel by name (custom name instead of internal name).
- New: Folders in Library order by choice: Name (default), Name reverse, TimeCreated, TimeCreated reverse.
- New: Files in Folders order by choice: Name (default), Name reverse, TimeCreated, TimeCreated reverse.
- New: Folder name in two lines.
- New: Both photo thumbnails in folders and thumbnails/photos in Lightbox presentation are created using SharePoint Image Helper API to achieve faster speed and smaller size of transferred data.
- Change: Update to SPFx v1.14.0
- Change: The thumbnails of the photos in the folders are displayed from left to right, top to bottom. Previously, they were displayed in columns like a newspaper article.
- Change: This web part is disabled on SharePoint classic pages. Target is only Sharepoint Online Modern sites.
- Change: Update Toolbox, App page and Package icons.
- Fix: Show library root folder title instead of name.
- Fix: Hidden libraries no longer appear in the properties panel.
- Fix: [Images in the upper level folder overrides those in the lower level folder](https://github.com/chrobaktruhlik/spfx-lightbox-image-gallery/issues/7#issue-1603108675).

## [1.0.1] - 2023-01-29
- Cleanup and edit project workspace. Start of work on the project.
Expand Down
48 changes: 30 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,30 @@
# SharePoint Lightroom Image Gallery Web Part
# SharePoint Lightbox Image Gallery Web Part

Fork from [YannickRe / spfx-lightbox-image-gallery](https://github.com/YannickRe/spfx-lightbox-image-gallery) version 1.0.0
Fork from [YannickRe / spfx-lightbox-image-gallery](https://github.com/YannickRe/spfx-lightbox-image-gallery) version 1.0.0<br>
The web part uses the same id as the original repository making it easy to be replace.
## Summary

A SharePoint web part, created with SharePoint Framework (SPFx) that visualizes images/photos from a Document Library or Picture Library on a page. It uses the existing folder structure to create albums and puts them in the breadcrumb when opened. Clicking on an image opens a nice Lightbox effect for easy browsing the fullsized versions.

[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

![directory](/assets/SPFxLightRoomImageGalleryWebPart.gif)
<!-- ![directory](/assets/SPFxLightRoomImageGalleryWebPart.gif) -->

Feature set:
1. Select SharePoint Picture/Document Library
2. Navigate through images and folders
3. Show breadcrumb to visualize context in the library
4. Show Lightbox effect for images, using [react-lightgallery](https://github.com/VLZH/react-lightgallery)
- Select SharePoint Picture/Document Library
- Navigate through images and folders
- Show breadcrumb to visualize context in the library
- Show Lightbox effect for images, using [react-lightgallery](https://github.com/VLZH/react-lightgallery)

## Release Notes

![drop](https://img.shields.io/badge/version-1.0.1-green.svg)
![drop](https://img.shields.io/badge/Version-2.0.0-green.svg)

For more information see [CHANGELOG](CHANGELOG.md) file.

## Applies to

* [SharePoint Online](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [SharePoint Online](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) Modern Site

## Disclaimer
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Expand All @@ -32,12 +33,23 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
Licensed under the [MIT](LICENSE.md) License.

## Minimal Path to Awesome
Either download [compiled package](https://github.com/chrobak.truhlik/spfx-lightbox-image-gallery/releases/latest) or build it yourself:
- Clone this repository
- In the command line run:
- `npm install`
- `npm run dist`

Install the package:
- Add to AppCatalog and deploy<br>`.\sharepoint\solution\spfx-lightbox-image-gallery.sppkg`
- Add the web part `Lightbox Image Gallery` to a SharePoint page
Either download [compiled package](https://github.com/chrobaktruhlik/spfx-lightbox-image-gallery/releases/latest) or build it yourself:

- Download this repository
- Install development toolchain prerequisites<br><span style="font-style:italic;">The SharePoint Framework development and build toolchain leverages various popular open-source tools. While most dependencies are included in project, you need to install a few dependencies globally on your workstation.</span>

- Install Gulp: `npm install gulp-cli --global`
- Install Yeoman: `npm install yo --global`<br>Important: Yeoman v4.x is required by the SPFx v1.13 forward.
- In the command line (in a package directory) run:
- Install the dependencies to the local node_modules folder: `npm install`
- Create the solution package (sppkg) in sharepoint\solution folder: `npm run dist`

Install package to SharePoint:
- Add `spfx-lightbox-image-gallery.sppkg` to SharePoint AppCatalog and deploy
- Add the web part `Lightbox Image Gallery` to a SharePoint page and enjoy

Debug package:
- Install `npm install spfx-fast-serve -g`
- Run `npm run serve`
- Create .env file with `URL=https://your-sharepoint-site`
- In Visual Studio Code: `Start Debugging – F5`
13 changes: 13 additions & 0 deletions assets/slideshow123x70.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions assets/slideshow40x28.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions config/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"externals": {},
"localizedResources": {
"ImagesGalleryWebPartStrings": "lib/webparts/imagesgallery/loc/{locale}.js",
"PropertyControlStrings": "node_modules/@pnp/spfx-property-controls/lib/loc/{locale}.js",
"ControlStrings": "node_modules/@pnp/spfx-controls-react/lib/loc/{locale}.js"
"ControlStrings": "node_modules/@pnp/spfx-controls-react/lib/loc/{locale}.js",
"PropertyControlStrings": "node_modules/@pnp/spfx-property-controls/lib/loc/{locale}.js"
}
}
4 changes: 0 additions & 4 deletions config/copy-assets.json

This file was deleted.

64 changes: 46 additions & 18 deletions config/package-solution.json
Original file line number Diff line number Diff line change
@@ -1,21 +1,49 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json",
"solution": {
"developer": {
"name": "Contoso",
"privacyUrl": "https://contoso.com/privacy",
"termsOfUseUrl": "https://contoso.com/terms-of-use",
"websiteUrl": "https://contoso.com/my-app",
"mpnId": "000000"
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json",
"solution": {
"developer": {
"name": "",
"privacyUrl": "",
"termsOfUseUrl": "",
"websiteUrl": "",
"mpnId": "Undefined-1.14.0"
},
"name": "SharePoint Lightbox Image Gallery",
"id": "a7d34cfc-bc45-4910-9ec5-3e2ca97a5d27",
"iconPath": "assets/slideshow96x96.png",
"version": "2.0.0.0",
"supportedLocales": [
"en-us",
"sk-sk"
],
"includeClientSideAssets": true,
"skipFeatureDeployment": true,
"isDomainIsolated": false,
"metadata": {
"shortDescription": {
"default": "spfx-lightbox-image-gallery short description.",
"sk-sk": "Krátky opis aplikácie."
},
"longDescription": {
"default": "Display a good looking image gallery using lightbox effects.",
"sk-sk": "Popis aplikácie."
},
"screenshotPaths": [],
"videoUrl": "",
"categories": [
"Site Design"
]
},
"features": [
{
"title": "spfx Feature",
"description": "The feature that activates elements of the solution.",
"id": "256cc7e1-1154-4987-83ae-644419f6ce57",
"version": "1.0.0.0"
}
]
},
"name": "SharePoint Lightbox Image Gallery",
"id": "a7d34cfc-bc45-4910-9ec5-3e2ca97a5d27",
"version": "1.0.1.0",
"includeClientSideAssets": true,
"skipFeatureDeployment": true,
"isDomainIsolated": false
},
"paths": {
"zippedPackage": "solution/spfx-lightbox-image-gallery.sppkg"
}
"paths": {
"zippedPackage": "solution/spfx-lightbox-image-gallery.sppkg"
}
}
6 changes: 1 addition & 5 deletions config/serve.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,5 @@
"$schema": "https://developer.microsoft.com/json-schemas/core-build/serve.schema.json",
"port": 4321,
"https": true,
"initialPage": "https://localhost:8080/workbench",
"api": {
"port": 8080,
"entryPath": "node_modules/@microsoft/sp-webpart-workbench/lib/api/"
}
"initialPage": "https://<your-SharePoint-teanant-site>/_layouts/workbench.aspx"
}
6 changes: 6 additions & 0 deletions fast-serve/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"$schema": "https://raw.githubusercontent.com/s-KaiNet/spfx-fast-serve/master/schema/config.latest.schema.json",
"cli": {
"isLibraryComponent": false
}
}
Loading

0 comments on commit 066c8ce

Please sign in to comment.