November 25, 2020

How To Open Easy Post Content in a Modal with Oxygen Builder

This article will show how to open custom post types using easy posts in a modal overlay with navigation in Oxygen.

Post updated 26th November 2020

On a recent project, I struggled with trying to get a clients site opening custom post types from an Easy Posts query. They needed to allow users to view projects quickly and include navigation.

To see it in action, watch the video below or visit https:/ksn.ie/projects or https://hmc-ip.com/our-team :

I tried accessing various sources for help but the solution never quite did what I wanted.

After posting my struggle on the Official Oxygen User Facebook group, Briany Hearne helped with the following solution for which I am truly grateful.

Essentially I had a custom post type called projects with some custom ACF fields including an ACF gallery field for project images. I created a blank template that applied only to this custom post and inherited no other templates as I didn’t want the footer and header navigation on these posts.

I also included the ‘previous‘ and ‘next‘ posts tags in the template as this would let users navigate between posts quickly.

Once the post template was complete, I went to where they would be viewed from.

1. Create a modal, style it how you wish. I added a modal to the page displaying the post query, which, in this case was Projects. I setup the modal so it displayed across all devices.

2. Use the click trigger to display the modal using the js-trigger-iframe class.

3. Add the following jQuery to a code block on the page displaying the post query.

jQuery(document).ready(function($){ 
$('.js-trigger-iframe').click(function(){ 
$this = $(this); 
$href = $this.find('.oxy-post-title'); 
if ($href.attr('href') && $this.attr('target')){ 
$('iframe[name="' + $this.attr('target') + '"]').attr('src',$href.attr('href')); 
} 
}); 
$('.oxy-close-modal, .oxy-modal-backdrop').click(function(){ 
$('.ct-modal').find('iframe').removeAttr('src'); 
}); 
});

4. Add this to the code block html :

<iframe src="" width="100%" height="100%"></iframe> 

5. Make sure the code block is set to the same height as the modal container.

6. Add the class (js-trigger-iframe) to the easy post php template around the post link along with the target element below.

target="myiframe"

Essentially anything wrapped in the js-trigger-iframe class will open in an overlay once the modal has been added as above.

I can see a lot of use cases for this and it also has the bonus of being navigatable if the template showing the content has the previous and next tags included.

In order to make sure the modals were scrollable on mobile, I had to add this to the modal parent to enable it on IOS:

overflow:auto; -webkit-overflow-scrolling:touch; 

I will be keeping this post up to date in case of any code changes as I know it is something I will use on many clients sites.

Love to know in the comments if you find it useful.

Amanda Lucas

Amanda Lucas runs a web design agency in Ireland called Itchy Fingers Design. She enjoys creating websites that help support business goals and growth and sharing her knowledge.