Skip to content

This project contains a Gantry Particle and adds a very powerful image render and animation component to the Gantry templating framework.

License

Notifications You must be signed in to change notification settings

thexmanxyz/Logo-Image-Hover-Gantry

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

97 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo | Image | Hover - Particle for Gantry

This project contains a Gantry Particle and adds a very powerful image render and animation component to the Gantry templating framework. Logo | Image | Hover is an advanced version of the standard Logo / Image Particle. However, it is much more flexible and encapsulates the parameterization of many fancy CSS3 rollover, hover and transition effects within. Furthermore, it provides an easy, user friendly and GUI assisted configuration and integration. In the current revision the following CMSs are supported:

  • Joomla
  • Wordpress
  • Grav

Prerequisites

  • CMS (Joomla, Wordpress, Grav)
  • Gantry Templating Framework and Theme

Download

Choose the correct download for your target platform. The Joomla Plugin System is supported for all Gantry themes globally or locally for the templates Helium and Hydrogen. The latest Particle version is v1.2.1.


Default Particle: English / German

Legacy Particle - Gantry <5.3.2: English / German

Joomla Plugin - All Templates (Global): English / German

Joomla Plugin - Hydrogen: English / German

Joomla Plugin - Helium: English / German


Automatic Installation (Joomla only)

  1. Download the Plugin of the Logo | Image | Hover Particle for Hydrogen, Helium or Global installation.
  2. Install it over the Joomla Plugin System.
  3. Create or modify the custom.scss file located under /[GANTRY_THEME]/custom/scss and add the following line @import "logo-image-hover"; at the end. Please check the list below to determine where the template folder for your CMS is located.

If you install the plugin globally be aware that the resource location changes to /media/gantry5/engines/nucleus

Manual Installation

  1. Download the Default or Legacy Package of the Logo | Image | Hover Particle. If you are using Gantry <5.3.2 please use the Legacy Package for compatibility reasons.
  2. Extract the files.
  3. Copy the .html.twig and the .yaml file to your particle folder /[GANTRY_THEME]/custom/particles. Please check the listing below to determine where the template folder for your CMS is located.
  4. Copy the .js file to the folder /[GANTRY_THEME]/custom/js. Create the folder if it does not exist.
  5. Copy the .scss file to the folder /[GANTRY_THEME]/custom/scss. Create the folder if it does not exist.
  6. Create or modify the custom.scss file located under /[GANTRY_THEME]/custom/scss and add the following line @import "logo-image-hover"; at the end.

CMS Template Folder

Please be aware that the template folder path varies in dependence of the used CMS. Here is a list of the folders for the different platforms:

Wordpress

/wp-content/themes/[GANTRY_THEME]

Joomla

/templates/[GANTRY_THEME]

Grav

/user/data/gantry5/themes/[GANTRY_THEME]

Configuration

  1. Go to your Gantry templating backend (e.g. Extensions/Templates).
  2. Switch to Layout and add the new appearing Particle called Logo | Image | Hover either globally to your site (base outline), to a specific template or page by dragging it to the designated section.
  3. Configure the appearance according to your favor.
  4. [Optional] The download package contains the JS file of the project. You can embed it over the backend configuration if you do not want to use the default CDN. If you chose automatic installation the file is already there.

Supported Parameters and Particle Options

  • Container attributes
  • Custom CSS classes
    • For container and image text
  • Output rendering
    • Prioritized, image only, text only or both
  • URL configuration for the image and text
    • Enable, target and title
  • Text position and custom styling
  • Image configuration
    • Two Images with overlay supported for fancy transition, timer and rollover effects
    • alt and title attribute configurable for both Images
  • many different CSS3 effects included (over 150 variations)
    • E.g. Zoom-In, Zoom-Out, Slide, Rotate, Blur, Unblur, Sepia, Gray, Pulse, ...
    • Predefined effect slots for custom adaptions available
  • Lazy load of images supported (requires 3rd party library)
  • JS priority and placement (head or footer)
  • JS loading
    • Remote, Local and Default
  • JS execution
    • Asynchronous
    • Deferred

Showroom

Insight of the Logo | Image | Hover - Gantry Particle configuration:

Backend (1) - General

1

Backend (2) - Text

2

Backend (3) - Image

3

Backend (4) - Effect

4

Backend (5) - JS

5

Example for a basic image effect:

Frontend (1) - Fade

6

Future Tasks

  • add more CSS3 effects
  • add more languages

Known Issues

None

Dependencies

Gantry Framework

Credits

Thanks to the Gantry team for providing a modern templating framework.

Thanks to Naoya of NxWorld and Rich Bradshaw for the inspiration in terms of the the used CSS3 effects.

Copyright (c) 2018, free to use in personal and commercial software as per the license.

About

This project contains a Gantry Particle and adds a very powerful image render and animation component to the Gantry templating framework.

Resources

License

Stars

Watchers

Forks

Packages

No packages published