In this tutorial, we're going to build a unique hover effect for content displayed in Oxygen Builder Repeaters. Modeled off of the Codrops "Distortion Hover Effect", and using the source code from that resource, this effect will create a distorted fade to a user-defined image when a visitor hovers on a repeater cell.
This tutorial will incorporate some cool concepts of Oxygen Builder:
Taking it a step further, we're going to make this a 100% dynamic feature, meaning that it'll be set and forget. No need to initialize a specific effect for each cell!
Note: this is a proof-of-concept, and likely requires optimization for use in production sites.
Two other things:
We will use ACF to make this 100% dynamic, and easy for the end user to edit. Make a field group, and add a hover image and displacement image. The initial image will be the featured image of the post. The hover image is what the effect will fade to when the visitor hovers over a repeater post.
The displacement image is what will be used to make the unique morph/fade animation between the two images. In this example, we are using the following images for displacement:
You can actually use any image, but black and white images with great texture are typically the best. It's easy to experiment with this method!
Here's what the field group and associated images look like when adding a new post:
At its core, we are copying the source code from the Codrops example, with minor modifications.
We simply duplicate the HTML structure above, with Oxygen Builder elements. Don't forget to add the classes from the HTML example above, as we're going to add some CSS and the JS uses them to identify specific elements. If you change these classes, you'll need to update the CSS and JS accordingly.
Our Repeater is using CSS grid to evenly space all cells without much work:
There are several things to configure to be dynamic. First, make the repeater query the WordPress Post type.
Next, set the date and post title to be dynamic.
Now, we will set up the three images. This is where things may get complex. Set the URL of image 1 to be the featured image URL.
Set the URL of image 2 to be the hover image, set in the ACF. For this tutorial, ACF fields weren't showing in the "insert dynamic data" popup (likely due to a bug Oxygen Builder 4.0 Beta 2). There's an easy workaround if you ever experience this:
1 - Insert the dynamic data
2 - Select PHP Function Return Value
3 - manually insert the ACF field content with
Finally, we need to set the distortion image that the effect will use to make the morph transition. This is inserted into the HTML as a data-attribute, which the JS reads and incorporates in the effect. From the HTML above, we can see that there are several attributes, which may be edited to change the effect.
The main thing we need to make dynamic is the data-displacement, which will have the URL of the image set in the post using ACF. We hard coded the other three attributes, but you can use the same method outlined below to make these user editable too.
Go to the image wrapper element (the div around the two dynamic images). Click Advanced -> Attributes, and add the following.
data-displacement, we will make this dynamic by clicking the data+ button in the content, and inserting our corresponding ACF field.
The frontend HTML will look like this, and the JS will use all of this data (which is dynamic and user-editable via ACF) to create the cool displacement hover effect on WordPress:
We will add the following CSS to our Universal CSS stylesheet. You may need to play with additional CSS styles to get everything working well.
Finally, we will load the necessary JS libraries, and code (we did this with a code block):
We are using Statically for our example (pulling in the ImagesLoaded and Hover Effect libraries from GitHub), but you should ideally host this on your site, using a tool like Scripts Organizer or Advanced Scripts.
Finally, the JS does the following - it identifies when images are loaded and applies the hover effect to any element that has the
.grid__item-img, pulling the associated images and displacement images from each post. Completely dynamic and will work regardless of the number of posts returned by the Oxygen Builder repeater.
After adding all of this, your effect should be working!