Actions

Difference between revisions of "Using the JHtmlTabs class in a component"

From Joomla! Documentation

(fix confusion in useCookie - it works best and is less confusing if using boolean true or false; added startOffset example)
m (updates to make multiversion links)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This article covers usage of JHtmlTabs in your Joomla! component for Joomla! versions {{JVer|1.6}} through {{JVer|2.5}} and greater. If you are using Joomla! {{JVer|1.5}}, see [[How_to_use_the_JPane_classes_in_a_component]].
+
{{disambig|
 
+
{{version|2.5,3.1}}
===Options for JHtmlTabs===
+
}}
 
+
{{other versions/navbox|The '''Using the JHtmlTabs class in a component''' article is available in these versions:-|version}}
'''onActive''': A callback function when a tab is activated with two params. 'title' is the tab itself, and 'description' is the tab content.
+
<noinclude>[[Category:Tutorials]][[Category:Component Development]]</noinclude>
 
+
'''onBackground''': A callback function when a tab is backgrounded
+
 
+
'''startOffset''': The default tab to start with (zero based index).
+
 
+
'''useCookie''': Whether or not to use cookies to store tab active state. (boolean) (true | false) // This is not a string. Don't use quotes.
+
 
+
===Example===
+
<source lang="php">
+
$options = array(
+
    'onActive' => 'function(title, description){
+
        description.setStyle("display", "block");
+
        title.addClass("open").removeClass("closed");
+
    }',
+
    'onBackground' => 'function(title, description){
+
        description.setStyle("display", "none");
+
        title.addClass("closed").removeClass("open");
+
    }',
+
    'startOffset' => 0,  // 0 starts on the first tab, 1 starts the second, etc...
+
    'useCookie' => true, // this must not be a sting. Don't use quotes.
+
);
+
 
+
echo JHtml::_('tabs.start', 'tab_group_id', $options);
+
 
+
echo JHtml::_('tabs.panel', JText::_('PANEL_1_TITLE'), 'panel_1_id');
+
echo 'Panel 1 content can go here.';
+
 
+
echo JHtml::_('tabs.panel', JText::_('PANEL_2_TITLE'), 'panel_2_id');
+
echo 'Panel 2 content can go here.';
+
 
+
echo JHtml::_('tabs.end');
+
</source>
+
 
<noinclude>[[Category:Development]]</noinclude>
 
<noinclude>[[Category:Development]]</noinclude>

Latest revision as of 15:43, 8 May 2013