nzta / gallery
A module for creating a gallery of images with captions
Installs: 2 692
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 1
Type:silverstripe-vendormodule
Requires
- silverstripe/cms: ^4 || ^5
- symbiote/silverstripe-gridfieldextensions: ^3 || ^4
Requires (Dev)
This package is auto-updated.
Last update: 2024-11-04 20:59:11 UTC
README
Provides the ability add a Gallery to any number of page types to provide a gallery of images with captions
Requirements
SilverStripe 4.x or 5.x
Features
- Able to create a set of GalleryItems that each consist of an image and a caption
- Define which PageTypes these GalleryItems should be added to through extensions configurations
- When a galleryitem is clicked on, a lightbox popup shows with carousel functionality
Installation
composer require nzta/gallery
Installing assets
You will need to require in the Requirements::javascript('nzta/gallery: js/gallery.js')
in order to display the gallery out of the box and
have the lightbox functionality.
There is also a Requirements::css('nzta/gallery: css/main.css)
file that can be used to display basic styles for the CarouselModal
.
Setting up templates
Once you have the assets being pulled in, you will need to add the gallery to the template, e.g. <% include Gallery %>
You will also need the __galleryData
available globally for the JS to work. You can add the following to your <head>
:
<script>
window.__galleryData = {
items: {$GalleryData}
}
</script>
Adding the extensions
Now you can add the GalleryExtension
to any page type you want to provide a gallery to, e.g.
Page:
extensions:
- NZTA\Gallery\Extensions\GalleryExtension
This will provide the CMS fields to add gallery images to the page.