dl/gallery

Neos plugin to easily render image galleries

4.4.0 2023-11-05 18:45 UTC

Requires

• neos/neos: ^5.0 || ^7.0 || ^8.0

MIT

README

Neos Gallery

This package provides a node type to easily render image galleries.

Installation and integration

The installation is done with composer:

composer require dl/gallery

(De)activate CSS / Javascript autoloading

By default, the galleries CSS and JavaScript files are added to the header and footer includes of your page automatically on pages, where an instance of the gallery plugin is added. If you want to compile the JS / CSS into your pages main files you can deactivate this behavior via settings:

DL:
  Gallery:
    loadGalleryCSS: false
    loadGalleryJS: false

Show a set of images as a gallery

Select images to be displayed in the gallery

Add a new gallery node to your page and use the inspector add images from the media module or upload them directly.

Use Tags or collections

1. Use tags or collections to group images

The images to show in a gallery need to be grouped by a tag or collection. To group images, go to the media module and add a new tag or collection. Drag and drop images onto this or select it in the image detail view.

2. Chose a tag in the plugins inspector

Add a new gallery plugin to your page. You can now choose a tag or a collection as the gallery source in the inspector. The images will then be rendered equally within the gallery.

Gallery Presentation

Theme Bootstrap Lightbox

The thumbnails of the gallery are displayed squared using a bootstrap grid. The lightbox photoswipe is used to open a large representation of the image.

Theme Justified

Uses the jquery plugin justified.js to display the thumbnails and also photoswipe as lightbox.

Build your own theme

The themes are written mostly using Neos Fusion code. That means you can adjust the existing two themes from within your own package easily or build your own theme.

Building a new theme is as easy as adding a new fusion prototype to render the images and register your prototype in the settings:

DL:
  Gallery:
    themes:
      yourThemeName:
        label: 'Displays the images like I want'
        fusionPrototype: 'YourVendor.YourPackage:renderingPrototype'
        themeSettings:
            settingForMyTheme:SomeSetting

Your theme is now selectable in the Nodes theme selector.