Carousel Particle Documentation

Create a list of items to use as a responsive carousel slider. See how Carousel can be designed beautifully on Demo Page.

# Carousel Package contents

Files Description
jlcarousel.yaml Contains the Carousel particle settings.

jlcarousel.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 Carousel 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 Carousel particle (i.e: Home) -> Layout tab -> Drag and drop the Carousel Particle from Particles panel (left corner) to the section you want to display the particle.

Tab Content

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

Settings Description
Image An image field with an image picker
Image ALT Enter the image’s alt attribute.
Title Customize the Title
Meta Customize the Meta.
Content Customize the content.
Link Specify the link for button. Scroll smoothly added automatically to internal link that contains a URL fragment to add the smooth scrolling behavior.
Item Color Set light or dark color mode for text, buttons and controls.

Layout Common settings for Carousel Layout. The Height and Min Height are not available for Auto Item Width mode.

Settings Description
Item Width Mode Define whether the width of the slider items is fixed or automatically expanded by its content widths.

NOTE: The Height settings and Item Width columns are not working for the AUTO Item Width Mode.

Height The height will adapt automatically based on its content. Alternatively, the height can adapt to the height of the view port.

This option won’t have any effect unless FIXED Item Width Mode is selected.

Note: Make sure, no height is set in the section settings when using on of the viewport options.

Min Height Use an optional minimum height to prevent the slider from becoming smaller than its content on small devices.

This option won’t have any effect unless FIXED Item Width Mode and Viewport Height are selected.

Column Gap Set the size of the gap between the grid columns.
Dividers Show a divider between grid columns.

Item Width Common settings for Columns – Set Item Width Mode to FIXED to use these settings.

Settings Description
Phone Portrait Set the item width for each breakpoint. Inherit refers to the item width of the next smaller screen size.
Phone Landscape
Tablet Landscape
Desktop
Large Screens

Animation Common settings for Slider Animation.

Settings Description
Set Slide all visible items at once. Group items into sets. The number of items within a set depends on the defined item width, e.g. 33% means that each set contains 3 items.
Center Center the active slide.
Finite Disable infinite scrolling
Velocity Set the velocity in pixels per millisecond. Min 20, Max 300
Autoplay Enable autoplay for slider items.
Pause On Hover Pause autoplay on hover.
Interval Set the autoplay interval in seconds. Min 5 Max 15.

Navigation Common settings for Slider Navigation.

Settings Description
Navigation Select the navigation type.
Position Align the navigation’s items.
Margin Set the vertical margin.
Breakpoint Display the navigation only on this device width and larger.
Color Set light or dark color mode.
Show Tooltip Display Image ALT as tooltip when hovering.

Slidenav Common settings for Slider Slidenav.

Settings Description
Position Select the position of the slidenav.
Show On Hover Show the slidenav on hover only.
Larger style To increase the size of the slidenav icons.
Margin Apply a margin between the slidenav and the slider container.
Breakpoint Display the slidenav only on this device width and larger.
Color Set light or dark color mode.
Outside Breakpoint Display the slidenav only outside on this device width and larger. Otherwise it will be displayed inside.
Outside Color Set light or dark color if the slidenav is outside of the slider.
Custom Slidenav Icons Custom previous/next icons (replace default Slidenav navigation)
Previous Icon An icon picker to choose custom Previous icon
Next Icon An icon picker to create choose custom Next icon
CSS Classes CSS class name for the particle.

Tab Style

Image Common settings for Image

Settings Description
Width Set the width of the image.
Height Set the height of the image.
Image Transition Select an image transition.

Title Settings Common settings for title.

Settings Description
Transition Select a transition for the title when the overlay appears on hover.
Style Heading styles differ in font-size but may also come with a predefined color, size and font.
Decoration Decorate the headline with a divider, bullet or a line that is vertically centered to the heading.
Predefined Color Select a predefined text color.
Custom Color Customize the title color instead using predefined title color mode.
You need to set the predefined color to None to use the customize color option.
Font Size Customize the title text font size.
Transform The following options will transform text into uppercased, capitalized or lowercased characters.
HTML Element Choose one of the elements to fit your semantic structure.
Margin Top Set the top margin. Note that the margin will only apply if the content field immediately follows another content field.

Meta Settings Common settings for meta.

Settings Description
Transition Select a transition for the meta when the overlay appears on hover.
Style Select a predefined meta text style, including color, size and font-family.
Predefined Color Select the predefined meta color.
Custom Color Customize the meta color. Set Predefined Color for Meta to None before using this feature.
Font Size Customize the title text font size.
Transform The following options will transform text into uppercased, capitalized or lowercased characters.
Alignment Align the meta text.
Margin Top Set the top margin. Note that the margin will only apply if the content field immediately follows another content field.

Content Settings Common settings for content.

Settings Description
Transition Select a transition for the content when the overlay appears on hover.
Style Select a predefined text style, including color, size and font-family.
Predefined Color Select the predefined meta color.
Content Color Customize the content color instead using predefined text color.
You need to set the predefined color to None to use the customize color option.
Font Size Customize the content text font size.
Transform The following options will transform text into uppercased, capitalized or lowercased characters.
Margin Top Set the top margin. Note that the margin will only apply if the content field immediately follows another content field.

Link Settings Common settings for link.

Settings Description
Transition Select a transition for the link when the overlay appears on hover.
Type Show the link as a button or choose between linking just the image and title or the whole particle.
Target Target browser window when item is clicked.
Text Specify the button label.
Style Set the button style.
Button Size Set the button size.
Margin Top Set the top margin. Note that the margin will only apply if the content field immediately follows another content field.

Overlay Tab

Settings Description
Mode When using cover mode, you need to set the text color manually.
Overlay on hover Display content overlay on hover.
Animate background only Animate background only on hover.
Overlay Style Select the style for the overlay.
Color Set light or dark color mode for text, buttons and controls.
Padding Set the padding between the overlay and its content.
Position Select the overlay or content position.
Margin Apply a margin between the overlay and the image container if the Overlay Style is Selected.
Max Width Set the maximum content width.
Overlay Transition Select 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

Comments

Leave a Reply

XHTML: You can use these tags: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>