Timeline Particle Documentation

  • JoomLeadTeam
  • 6 January 2017
  • 1 Comment
  • Docs
Timeline Particle is a Gantry5 particle that helps you create and show a beautiful timeline, history, stories easily. See how Timeline Particle can be designed beautifully on Demo Page. 🙂

# Timeline Package contents

Files Description
jltimeline.yaml Contains the Timeline particle settings.
jltimeline.html.twig The Twig file to pull information, settings.
timeline.min.css / timeline-rtl.min.css Contains the Timeline CSS and a right-to-left version.

Note Timeline, Joomla/Wordpress uses the same timeline css file, so you just need to copy the css files once.

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

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

Settings

Settings Description
Items List timeline items to display. You can add new items to the collection using the plus + icon
Timeline Settings Common settings for Timeline Style
Link Card Link the whole card if a link exists.
Date Badge Show or hide the Timeline Date badge on mobile/tablet devices.
Max Width Set the maximum content width.
Max Width Alignment Define the alignment in case the container exceeds the particle’s max-width.
Max Width Breakpoint Define the device width from which the particle’s max-width will apply.
CSS Classes CSS class name for the particle.

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

Settings Description
Date Pick an event date.
Icon Choose Icon for the event
Title Customize the timeline item title.
Meta Customize the timeline meta for item.
Content Customize the content.
Image An image field with an image picker.
Image ALT Enter the image’s alt attribute.
Link Specify the link for heading.
Note: Scroll smoothly added automatically to internal link that contains a URL fragment to add the smooth scrolling behavior.
Link Text Specify the button label.
Layout Settings Common settings for Layout
Style Select one of the boxed card styles or a blank panel.
Size Define the card’s size by selecting the padding between the card and its content.
Alignment Align the item to the left or right.
Custom Background Customize the card background color.
Custom Arrow Color Customize the arrow color.
Inverse Color Set light or dark color mode for text, buttons and controls.

Style Settings Common settings for Style

Settings Description
Line Background Color Customize the line background color.
Background on scroll Customize the line background color on scroll.
Icon Color Customize the Icon Color.

Date Style Settings Common settings for Date Style

Settings Description
Date Format Select preferred date format. Leave empty not to display a date.
Predefined Style Highlight parts of your timeline date.
Custom Background Customize the date background color. You need to set the Predefined color to None before using the color customization.
Color Customize the date color text.

Title Settings Common settings for Title Style

Settings Description
Style Heading styles differ in font-size but may also come with a predefined color, size and font.
Link title Link the title if a link exists.
Hover Style Set the hover style for a linked title. Enable link title to use this option.
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.

Meta Settings Common settings for Meta

Settings Description
Style Display the meta text in a sentence or a horizontal list.
Subnav Style Select the subnav style for Meta List Style.
Author Select if the article author should be shown.
Author Meta Translate or replace the Author meta text for Sentence Style. Default: Written by
Date Select if the article date should be shown.
Date Format Select preferred date format. Leave empty not to display a date.
Date Meta Translate or replace the Date meta text for Sentence Style. Default: on
Category Select if and how the article category should be shown.
Category Meta Translate or replace the Category meta text for Sentence Style. Default: Posted in
Hits Select if the article hits should be shown.
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 above/below the title or below the content.
Margin Top Set the top margin.

Content Settings Common settings for Content Style

Settings Description
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.

Image Settings Common settings for Image Style

Settings Description
Align image without padding Top, left or right aligned images can be attached to the card’s edge. If the image is aligned to the left or right, it will also extend to cover the whole space.
This option won’t have any effect if Card Style assigned to None or Image Alignment Between is selected.
Width Enter the image’s width.
Height Enter the image’s height.
Image Border Select the image’s border style.
This option won’t have any effect if Align image without padding is enabled.
Box Shadow Select the image’s box shadow size.
This option won’t have any effect unless Blank Card Style is enabled.
Hover Box Shadow Select the image’s box shadow size on hover.
This option won’t have any effect unless Blank Card Style is enabled.
Link image Link the image if a link exists.
Hover Transition Set the hover transition for a linked image.
Hover Box Shadow Select the image’s box shadow size on hover.
This option won’t have any effect unless Blank Card Style is enabled.
Link image Link the image if a link exists.
Image Alignment Align the image to the top,left, right or place it between the title and the content.
Grid Width Define the width of the image within the grid. Choose between percent and fixed widths or expand columns to the width of their content.
This option won’t have any effect unless Left/Right Image Alignment are enabled.
Grid Column Gap Set the size of the gap between the image and the content.
This option won’t have any effect unless Left/Right Image Alignment are enabled.
Grid Row Gap Set the size of the gap if the grid items stack.
This option won’t have any effect unless Left/Right Image Alignment are enabled.
Grid Breakpoint Set the breakpoint from which grid cells will stack.
This option won’t have any effect unless Left/Right Image Alignment are enabled.
Vertical Alignment Vertically center grid cells.
This option won’t have any effect unless Left/Right Image Alignment are enabled.
Margin Top Set the top margin.
Set the top margin. This option won’t have any effect unless Bottom and Between are enabled for Image Alignment.

Link Settings Common settings for Link Style

Settings Description
Target Target browser window when item is clicked.
Read More Label Type in the label for the ‘Read More’ button.
Style Set the button style.
Button Size Set the button size.
Margin Top Set the top margin.

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.