Actions

Template

Navbox with collapsible groups

From Joomla! Documentation

[view] [edit] [history]

Template-info.pngTemplate documentation

Contents

This template produces a navigation template that has groups of relevant articles on a certain topic. All groups are hidden by default. However, with a parameter call, an individual group can be shown that has the other articles in the same group.

Usage

Please remove the parameters that are left blank. The template currently supports up to 20 groups/lists but more can be added if needed. You should use a minimum of two groups/lists; otherwise, use {{Navbox}} instead.

{{Navbox with collapsible groups
|name = {{subst:PAGENAME}}
|state = 
|selected = {{{1|}}}

|title = 
|titlestyle = 
|groupstyle = 
|image = 

|group1 = 
|abbr1 = 
|list1 =

|group2 = 
|abbr2 = 
|list2 = 

 ...

|group20 = 
|abbr20 = 
|list20 = 
}}

Parameters

This template shares many common parameters with its sister templates {{Navbox}} and {{Navbox with columns}}. The common parameters are marked with a cross. Please refer to the documentation of {{Navbox}} for more in depth descriptions and examples of those parameters.

Setup parameters

name
The name of the template. The name of this template, for example, is "Navbox with collapsible groups".
state [uncollapsed, collapsed, plain, off]
The initial state of the show/hide feature for the main title. See {{Navbox}} for more information. Does not affect display or hiding of group items, see staten, below.
navbar
Possible values are plain, off, and the default value of blank. See {{Navbox}} for more information.
border
Possible values are child, none, and the default value of blank. Set to child if you wish to use the navbox inside of another navbox; with this option, the child navbox is borderless and fits snuggly inside of its parent navbox. The parent navbox may be the list area of {{Navbox}}, the columns of a {{Navbox with columns}}, or a list area of {{Navbox with collapsible groups}}. See {{Navbox}} for more information and examples.

Basic data parameters

title
The title of the template, displayed centered in the titlebar at the top of the template.
above
Text or other elements to appear above groups/lists.
image
Image to the right of all of the groups/lists.
imageleft
Image to the left of all of the groups/lists.
below
Text or other elements to appear below the groups/lists.

Group/list parameters

groupn
The title of each section.
listn
The content/wikilinks that will be shown in the group. Use dots or bullets as separators (see the See also section). A {{Navbox}} or {{Navbox with columns}} can optionally be used here with its border = child parameter set. If this is done, leave the corresponding groupn blank, as the child navbox will already provide the collapsible feature.
abbrn
This is the abbreviation of the group. See selected parameter immediately below to see how to use this parameter. This parameter is optional, but recommended.
selected
If the value of selected equals the value of abbrn, then listn is uncollapsed and all other lists are collapsed. If selected is left blank, or if it does not match any abbrn, then all groups are collapsed. Usually this parameter should be set to {{{1|}}}. Since this template is a base template for others, there has to be a way to pass the group parameter from the article, to the secondary template to this one.
The collapsed/uncollapsed options can be listed on the template's page by using the {{Collapsible sections option}} template in the <noinclude> part of the page.
staten [uncollapsed, collapsed, plain, off]
The initial collapsible state of listn. Set to collapsed by default. Overridden to uncollapsed if selected equals abbrn.
imagen
An image to appear in the listn content area on the right side.
imageleftn
An image to appear in the listn content area on the left side.

Style parameters

bodystyle
CSS style/s to apply to the entire template
titlestyle
CSS style/s to apply to titlebar; usually background:color. The color of wikilink text must be manually changed using span tags. For example use title = [[Scouting|<span style="color:ivory;">Scouting</span>]] to change the color of the link to ivory. The [show]/[hide] button and the vde link button use the color set in the titlestyle parameter. Here is an example of setting the titlestyle:
titlestyle = background:darkgreen;color:ivory;
abovestyle
belowstyle
CSS style/s to apply to the above and below parameters, respectively.
basestyle
CSS style/s to apply to the title, above, below, and groupn parameters, all at the same time.
imagestyle
CSS style/s to apply to the image parameter. Does not get applied to the imagen parameters.
imageleftstyle
CSS style/s to apply to the imageleft parameter. Does not get applied to the imageleftn parameters.
groupstyle
CSS style/s to apply to all group heading parameters. Visit this website to get a lighter color similar to the title background color. Example:
groupstyle = background:lightgreen;
groupnstyle
CSS style/s to apply to a specific group heading; overrides any CSS styles set in groupstyle.
liststyle
CSS style/s to apply to all list content parameters.
listnstyle
CSS style/s to apply to specific list content parameters; overrides any CSS styles set in liststyle.
listpadding
Padding to have in each list cell; defaults to 0.25em on the left/right and 0em on the top/bottom.

Microformat parameters

bodyclass
This parameter is inserted into the "class" attribute for the infobox as a whole.
titleclass
This parameter is inserted into the "class" attribute for the infobox's title caption.

See also

  • {{tl|Nowrap begin}} – Provides an explanation of the preferred method of using bullets or pipes to delimit list items. Deprecated; use the hlist class.
Navigation templates comparison
view · talk · edit Collapsible Header color Image Groups Style (body)
parameter/s
Examples
{{Navbox}} collapsible navbox Left/right of body Yes Yes
{{Navbox with collapsible groups}} collapsible navbox Left/right of body and/or in each list Yes Yes
{{Navbox with columns}} collapsible navbox Left/right of columns No Yes
{{Navbox years}} collapsible navbox No No No
Collapsible attributes
Type CSS classes Javascript Collapses when Custom
initial state
Nesting
Collapsible tables collapsible Defined in Common.js 2 or more autocollapse on page Yes Yes