Difference between revisions of "Adding jQuery UI tabs to listing detail page"

From JReviews Documentation
Jump to: navigation, search
(Displaying each field group in one tab)
Line 1: Line 1:
 +
<div class="jrError">Starting with JReviews 2.4 we've replaced the 'jr_tabs' CSS class with 'jrTabs'. Make sure you make the necessary replacements in the code below.</div>
 +
 
The most simple way to add tabs to listing detail page is using jQuery UI tabs.
 
The most simple way to add tabs to listing detail page is using jQuery UI tabs.
  

Revision as of 21:35, 11 October 2012

Starting with JReviews 2.4 we've replaced the 'jr_tabs' CSS class with 'jrTabs'. Make sure you make the necessary replacements in the code below.

The most simple way to add tabs to listing detail page is using jQuery UI tabs.

You will need to modify this file to add the tabs code:

  • \com_jreviews\jreviews\views\themes\{theme_name}\listings\detail.thtml


Changes in detail.thtml file

First step is to add some sample tabs to see if the functionality is working.

Add this code into detail.thtml (where you want the tabs to display, usually below SUMMARY/DESCRIPTION text):

<div class="clr"></div>
<div id="jr_tabs" class="jr_tabs">
	<ul>
		<li><a href="#tab1">Tab 1</a></li>
		<li><a href="#tab2">Tab 2</a></li>
		<li><a href="#tab3">Tab 3</a></li>
	</ul>
	<div id="tab1">
		This is tab 1 text
	</div>
	<div id="tab2">
		This is tab 2 text
	</div>
	<div id="tab3">
		This is tab 3 text
	</div>
</div>


You should get this:

UITabs.png


Next, you can start putting parts of detail page into the tabs.

For example, to add summary/description text inside the first tab, rename "Tab 1" to "Description" and replace "This is tab 1 text" with the summary/description code:

<div class="clr"></div>
<div id="jr_tabs" class="jr_tabs">
	<ul>
		<li><a href="#tab1">Description</a></li>
		<li><a href="#tab2">Tab 2</a></li>
		<li><a href="#tab3">Tab 3</a></li>
	</ul>
	<div id="tab1">
		<!-- SUMMARY/DESCRIPTION -->
		<div class="contentFulltext">
			<?php echo nl2br($listing['Listing']['text']);?>
		</div>
	</div>
	<div id="tab2">
		This is tab 2
	</div>
	<div id="tab3">
		This is tab 3
	</div>
</div>

UITabs2.png


Do the same for other parts of detail page, just paste the code into the tab divs.


Changing how the tabs look

If you don't like the default look of the tabs, you can style theme using jQuery UI ThemeRoller tool to make your own styles of download other styles from the gallery.

When you download the jquery ui package (jquery-ui-1.7.1.custom.zip), extract it and copy the files from the /css directory into this folder:

  • root\templates\jreviews_overrides\views\themes\{theme_name}\theme_css\jquery_ui_theme\


Copy both jquery-ui-1.7.1.custom.css file and the /images folder.

After copying, you must Clear File Registry in JReviews administration


NOTE: If the downloaded css file has a different version in the filename (jquery-ui-1.7.2.custom.css), it will not be recognized by JReviews. The quickest fix is to rename the file to jquery-ui-1.7.1.custom.css


Here is an example of modified tabs theme:

UITabs3.png


Displaying each field group in one tab

If you want to display each field group in a separate tab instead of the default field output, replace this code in the detail.thtml file:

<!-- CUSTOM FIELDS -->
<?php echo $CustomFields->displayAll($listing,'content');?>


with this:

<?php
$groups = array();
foreach($listing['Field']['groups'] AS $group=>$fields){
    $groups[$group] = array($group=>$fields);
}
?>
<div id="jr_tabs" class="jr_tabs" style="width: 60%;" >
    <ul>
    <?php $i=0;foreach($groups AS $group_name=>$fieldGroup):$i++;?>
    <li><a href="#field_group<?php echo $i;?>"><span><?php echo $fieldGroup[$group_name]['Group']['title'];?></span></a></li>
    <?php endforeach;?>
    </ul>
    <?php $i=0;foreach($groups AS $group_name=>$fieldGroup):$i++;?>
    <div id="field_group<?php echo $i;?>"><?php echo $CustomFields->displayAll($listing,'content',$group_name);?></div>
    <?php endforeach;?>
</div>


If you want to display the tabs in the same row as the images, you will need to adjust the width here:

<div id="jr_tabs" class="jr_tabs" style="width: 60%;" >


Add this line into detail.css file (it fixes an issue when tabs are displayed next to the images):

#jr_tabs .ui-helper-clearfix:after {clear: left; }


Here is how the field groups will look like:

UITabFields.png

Tabs only on certain Sections/Categories

If you want tabs only on certain sections or categories, use the Theme Manager to create theme suffixes.

For example, you can make modifications on detail_tabs.thtml file, and that file will be used only on sections/categories where you enter "_tabs" as theme suffix in Theme Manager.