Gallery Particle Documentation

  • JoomLeadTeam
  • 6 January 2017
  • No comments
  • Docs
Gallery Particle is a powerful and customizable grid based image gallery. Create responsive and adaptive galleries on your website. See how Gallery can be designed beautifully on Demo Page.

# Gallery Package contents

Files Description
jlgallery.yaml Contains the Gallery particle settings.
jlgallery.html.twig The Twig file to pull information, settings.

Installation Installing the particle on your website is a really simple process. You can refer to the document here to know more.

Requirements Gallery requires Uikit 3 for Gantry 5 Atom to be installed and enabled in your theme layout settings.

Go to Template/Theme Settings > select the Layout to add Gallery particle (i.e: Home) -> Layout tab -> Drag and drop the Gallery Particle from Particles panel (left corner) to the section you want to display the gallery.

Settings

Content Tab – Items

Settings Description
Items List Gallery items to display. You can add new items to the collection using the plus + icon

Items You can add new items to the collection using the plus + icon

Settings Description
Items Create each image item to display.
Image An image field with an image picker.
Image ALT Enter the image’s alt attribute.
Title Customize the title.
Meta Customize the meta text.
Content Customize the content.
Link Specify the image link URL.
Link Text Specify the button label.
Link ARIA Label Set a different ARIA label for the link to improve accessibility.
Hover Image Select an optional image that appears on hover.
Item Color Set light or dark mode for text, buttons, and controls.
Inverse text color Invert the text color on hover.
CSS Classes (item) Specify a CSS class name for the item.
Image Style
Background Use a background color behind the image, often with a blend mode.
Blend Mode Control how the image blends with the background using a CSS blend mode.
Overlay Color Apply a semi-transparent overlay to soften the image.
Item
Expand image Stretch the image height to fill the available vertical space.
Link overlay Link the entire overlay area when a link is provided.
Max Width Set the maximum width of the item container (e.g., small, medium, large).
CSS Classes (particle) CSS class name for the overall particle.

Gallery Settings Common settings for gallery and column layout

Settings Description
Gallery
MasonryChoose a masonry layout algorithm: Pack or Next.
ParallaxSet a vertical parallax offset (in pixels). Columns scroll at different speeds.
Parallax JustifyAlign parallax columns to the bottom.
Parallax StartDefine the offset where animation begins (e.g. 100px, 50vh, 50vh + 50%).
Parallax EndDefine the offset where animation ends. Accepts same formats as start.
Column GapSet the spacing between grid columns.
Row GapSet the spacing between grid rows.
DividersShow dividers between grid items.
Center columnsHorizontally center columns within the grid.
Center rowsVertically center rows within the grid.
Columns
Phone PortraitNumber of columns for phone portrait. Inherit uses the next smaller size.
Phone LandscapeNumber of columns for phone landscape. Inherit uses the next smaller size.
Tablet LandscapeNumber of columns for tablets. Inherit uses the next smaller size.
DesktopNumber of columns for desktops. Inherit uses the next smaller size.
Large ScreensNumber of columns for large screens. Inherit uses the next smaller size.

Lightbox Settings Enable/Disable lightbox control.

Settings Description
LightBox
Enable LightboxActivate a responsive lightbox gallery with images.
Show controls alwaysAlways display navigation controls inside the lightbox.
Show counterDisplay the slide counter in the lightbox.
Close on backgroundAllow closing the lightbox by clicking the background.
AnimationChoose the transition between slides (e.g. fade, scale).
NavigationSelect a navigation style: Slidenav, Dotnav, or Thumbnav.
Show TitleDisplay the item title in the overlay, lightbox, or both.
Show ContentDisplay the content in the overlay, lightbox, or both.

Tab Style

Image & Title Common settings for images and title style.

Settings Description
Image
WidthSet the width of the image.
HeightSet the height of the image.
Load image eagerlyEnable eager loading for images in the initial viewport. By default, images are lazy-loaded.
TransitionSelect a hover transition for the overlay.
Min HeightPrevent images from becoming smaller than the content on small devices using a minimum height.
Box ShadowSelect the image’s box shadow size.
Hover Box ShadowSelect the image’s box shadow size on hover.
Title
TransitionSelect a transition for the title when the overlay appears on hover.
StyleChoose a title style that modifies font size, weight, or color.
Link titleLink the title if a link exists.
Hover StyleSet a hover style for a linked title (requires enabling “Link title”).
DecorationAdd a divider, bullet, or line to the title for visual emphasis.
Predefined ColorSelect a predefined title color. If background is selected, it defaults to primary unless a background image is present.
Custom ColorCustomize the title color. Set predefined color to “None” before using this.
Font SizeCustomize the font size of the title text.
TransformApply uppercase, capitalize, or lowercase transformation to title text.
Font weightSelect font weight for the title text.
HTML ElementChoose the HTML tag for the title (e.g., h1–h6, div).
Margin TopSet the top margin. Only applies if content follows another field.

Meta & Content Common style settings for meta and title.

Settings Description
Meta
TransitionSelect a transition for the meta when the overlay appears on hover.
StyleSelect a predefined meta text style, including color, size and font-family.
Predefined ColorSelect a predefined color for meta text.
Custom ColorCustomize the meta color. Set predefined color to “None” first.
Font SizeCustomize the font size of the meta text.
AlignmentPosition meta text above title, below title, or below all content.
TransformApply uppercase, capitalize, or lowercase transformation to meta text.
Font weightSelect font weight for meta text.
HTML ElementChoose the HTML tag for the meta text (e.g., h1–h6, div).
Margin TopSet the top margin for the meta text if it follows another content field.
Content
TransitionSelect a transition for the content when the overlay appears on hover.
StyleSelect a predefined content text style including color, size, and font.
Predefined ColorSelect a predefined color for content text.
Custom ColorCustomize the content color. Set predefined color to “None” before using this.
Font SizeCustomize the font size of the content text.
TransformApply uppercase, capitalize, or lowercase transformation to content text.
Font weightSelect font weight for the content text.
Margin TopSet the top margin for content if it follows another content field.

Link Settings Common settings for link.

Settings Description
Link
TransitionSelect a transition for the link when the overlay appears on hover.
TargetOpen the link in a same or new window. This feature no longer working if you use Lightbox feature.
TextSpecify the button label.
ARIA LabelEnter a descriptive text label to make it accessible if the link has no visible text.
IconPick an optional Font Awesome icon.
Icon AlignmentChoose the icon position.
StyleSet the button style.
Button SizeSet the button size.
Full width buttonMake the button span the full width.
Font weightAdd one of the following classes to modify the font weight of your text.
TransformThe following options will transform text into uppercased, capitalized or lowercased characters.
Margin TopSet the top margin. Note that the margin will only apply if the content field immediately follows another content field.

Overlay Tab

Settings Description
Overlay
ModeWhen using cover mode, you need to set the text color manually.
Overlay On HoverDisplay content overlay on hover.
Animate backgroundAnimate the background only on hover.
StyleSelect the style for the overlay.
Text ColorSet light or dark color mode for text, buttons and controls.
Inverse text colorInverse the text color on hover.
PaddingSet the padding between the overlay and its content.
Expand contentExpand the height of the content to fill the available space in the overlay and push the link to the bottom.
PositionSelect the overlay or content position.
MarginApply a margin between the overlay and the image container IF the overlay style is Selected.
Max WidthSet the maximum content width.
Overlay TransitionSelect a transition for the overlay when it appears on hover.

General, Parallax and Parallax Background tab

Please take a look the documentation here for more detail about these tabs settings

Video Tutorial

Comments

Leave a Reply

You must be logged in to post a comment.

80+ Joomla templates updated for Joomla 5.3 and JoomLead particles 2.3.2 Download
Flash Sale. Get Up to 25% Off - Coupon: FLASH25 Shop Now