Template:Simple navbox

Template documentation[view] [edit] [history] [purge]

A simple navbox template used to construct other navigational templates. Use {{Navbox}} for anything more complicated.

Usage

Simple box with links

{{Simple navbox
|name = {{subst:PAGENAME}}
|title = 
|image =
|list =
}}

Simple box with ordered links

{{Simple navbox
|name = {{subst:PAGENAME}}
|title = 
|image = 
|group1 =
|list1 =
|group2 =
|list2 =
<!-- ... -->
}}

Simple box with nested navboxes

{{Simple navbox
|name = {{subst:PAGENAME}}
|title = 
|image = 
|list =
{{Simple navbox
|title =
|list =
}}
{{Simple navbox
|title =
|group1 =
|list1 =
}}
<!-- ... -->
}}

Parameter list

Standard navbox

Outer image navbox

All Parameters

name – the page name for the template, needed for the "v·t·e" section to work, omitting this will remove the "v·t·e" navbar

title – text in the title bar

collapsible – defaults to yes, set to no if you want a non-collapsible navigation template.

state – set to collapsed to keep navbox closed by default, set to expanded to keep navbox open by default, set to plain if you want a non-collapsible navbox (same as setting collapsible to no).

image – optional image, uses wiki syntax, as in: [[File:Example.png|50px]], will not show if |collapsible=no

imageleft – optional image, like image except it's on the left. You can use both image and imageleft, unless imageouter is used.

imagealign – defaults to right.

imagevalign – defaults to "center" (like middle in "valign"), set to "auto" to vertically align the image to top, accepts values for "align-self" CSS property

imageouter – like image, except it sits next to the header and content, does NOT accept image-align or image-valign parameters, MUST have |collapsible=no or |state=plain, overrides image as well.

imageouterright – like imageouter but on the right.

bodystyle – inline styling for the whole navbox container, such as: background:red; color:white

titlestyle or headerstyle – inline styling for the navbox header, such as: font-size:200%; color:green

navcontentstyle – inline styling for all navbox content.

containerstyle – inline styling for navbox content, except {{{above}}} and {{{below}}}.

contentstyle – inline styling for div containing all grouped list content, such as: color:gray; font-variant:small-caps

list – text listing the links you want, NOT compatible with group1,list1

You can also use group1, list1 parameters to make an ordered list.

group1 – name of group, goes up to 50

list1 – list of links for group, goes up to 50

basestyle – sets a style for the title header, group names, and above and below sections, will be overriden by the respective parameters (titlestyle, groupstyle, abovestyle, etc.).

rowstyle – inline styling for the entire row containing the group and list.

groupstyle – inline styling for each of the group rows, such as background: pink, border:1px solid blue

liststyle – inline styling for each of the list rows, such as background: pink, border:1px solid blue

oddgroupstyle and evengroupstyle – inline styling for every odd or even group, overrides groupstyle

oddliststyle and evenliststyle – inline styling for every odd or even list, overrides liststyle

groupnstyle – inline styling for the nth group row, with n being the number, like group4style, overrides oddgroupstyle and evengroupstyle

listnstyle – inline styling for the nth list row, with n being the number, like list4style, overrides oddliststyle and evenliststyle

above or below – adds a group row above, or below, the group list

abovestyle – inline styling for the "above" or "below" row, automatically applies to below section as well unless using belowstyle.

belowstyle – inline styling for the "below" row, will override abovestyle if both are present.

tablestyle – inline styling for table holding grouped lists

CSS trickery

WARNING: WILL BREAK STUFF IF YOU DO SOMETHING WRONG

You can specify a unique class for the template navbox by using bodyclass

bodyclass – adds a CSS class to the navbox container, either existing ones (i.e. "hlist", "hlist toccolours") or a custom one, which can be used with either {{#CSS:}} or TemplateStyles to further customize the navbox template

listclass – adds a CSS class to the list content (technically, within the class .simple-content).

templatestyles – loads a CSS stylesheet: setting parameter to Example/styles.css would load the stylesheet at Template:Example/styles.css

Semantic styling behavior

Using certain parameters, or certain inline styling within parameters, will add classes to elements of the Simple Navbox. This subtly changes the appearance of certain elements, so that users seeking to create a navbox with a certain style do not have to tinker with or add a dozen styling parameters. The footnotes get into more detail, but here is a brief overview for each trigger.

• Using basestyle will add .simple-basestyle to the navbox class, modifying the look of groups and lists to be more "Wikipedian", notably, lists will have an alternating white and lightgrey background instead of lines.
• Using background: or background-color: property within the inline styling of either group or list parameters will slightly expand the padding of groups, lists and the main title header.
• Using color: property within the inline styling of group or title (also called header) parameters will make links within group names and the main title header inherit the color specified for those elements.
• Setting either |collapse = no or |state = plain and using imageouter will add .simple-outer class to the navbox, which allow outer image navboxes to work.

Footnotes

The above documentation is transcluded from Template:Simple navbox/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.