This template allows anavigational template to be set up relatively quickly by supplying it with one or more lists of links. It comes equipped with default styles that should work for most navigational templates. Changing the default styles is possible, but not recommended. Using this template, or one of its "Navbox suite" sister templates, is highly recommended for standardization of navigational templates, and for ease of use.
Templates using the classesclass=navbox ({{navbox}}) orclass=nomobile ({{sidebar}}) are not displayed in article space on themobile web site of English Wikipedia. Mobile page views account for approximately 68% of all page views (90-day average as of September 2024[update]). Briefly, these templates are not included in articles because 1) they are not well designed for mobile, and 2) they significantly increase page sizes—bad for mobile downloads—in a way that is not useful for the mobile use case. You can review/watchphab:T124168 for further discussion.
Usage
Please remove the parameters that are left blank.
{{Navbox| name={{subst:PAGENAME}}{{subst:void|Don't change anything on this line. It will change itself when you save.}}| title=| listclass= hlist| state={{{state|}}}| above=| image=| group1=| list1=| group2=| list2=| group3=| list3=<!-- ... -->| below=}}<noinclude>{{navbox documentation}}<!-- add a navbox category here --></noinclude>
{{{below}}} See alternate navbox formats under:Layout of table
The navbox uses lowercase parameter names, as shown in the box (above). The requiredname andtitle will create a one-line box if other parameters are omitted.
Notice "group1" (etc.) is optional, as are sections named "above/below".
The basic and most common parameters are as follows (seebelow for the full list):
name – the name (Wikipedia location) of the template.
title – text in the title bar, such as: [[Widget stuff]].
listclass – a CSS class for the list cells, usuallyhlist for horizontal lists. Alternatively, use bodyclass for the whole box.
state – controls when a navbox is expanded or collapsed.
titlestyle – a CSS style for the title-bar, such as:background: gray;
groupstyle – a CSS style for the group-cells, such as:background: #eee;
above – text to appear above the group/list section (could be a list of overall wikilinks).
image – an optional right-side image, coded as the whole image, such as:[[File:XX.jpg|80px|alt=Alternate text]]
Note that most of such images don't comply withMOS:DECOR and should be removed at sight (further information:WP:NAVIMAGES).
imageleft – an optional left-side image (code the same as the "image" parameter).
groupn – the left-side text before list-n (if group-n omitted, list-n extends to the left edge of the box, and defaults totext-align:center styling).
listn – text listing wikilinks using awikilist format.
below – optional text to appear below the group/list section.
Parameter descriptions
The following is a complete list of parameters for using{{Navbox}}. In most cases, the only required parameters arename,title, andlist1, thoughchild navboxes do not even require those to be set.
{{Navbox}} shares numerous common parameter names with its sister templates,{{Navbox with columns}} and{{Navbox with collapsible groups}}, for consistency and ease of use. Parameters marked with an asterisk (*) are common to all three master templates.
Setup parameters
name*
The name of the template, which is needed for the "V • T • E" ("View • Talk • Edit") links to work properly on all pages where the template is used. You can enter{{subst:PAGENAME}} for this value as a shortcut. The name parameter is only mandatory if atitle is specified, and theborder parameter is not set, and thenavbar parameter is not used to disable the navbar.
Defaults toautocollapse. A navbox withautocollapse will start out collapsed if there are two or more collapsible elements on the same page. Otherwise, the navbox will be expanded. For the technically minded, seeMediaWiki:Common.js (search for "autocollapse").
If set tocollapsed, the navbox will always start out in a collapsed state.
If set toexpanded, the navbox will always start out in an expanded state.
If set toplain, the navbox will always be expanded with no [hide] link on the right, and the title will remain centered (by using padding to offset theV • T • E links).
If set tooff, the navbox will always be expanded with no [hide] link on the right, but no padding will be used to keep the title centered. This is for advanced use only; the "plain" option should suffice for most applications where the [show]/[hide] button needs to be hidden.
To show the box when standalone (non-included) but then auto-hide contents when in an article, put "expanded" inside<noinclude>...</noinclude> tags. This setting will force the box to be visible when standalone (even when followed by other boxes), displaying "[hide]", but then it will auto-collapse the box when stacked inside an article:
The<includeonly>| will make the template expanded when viewing the template page by itself.
Example 1:{{Peso}} withautocollapse as the default initial state.Catalan peseta transcludes it and has only one navbox; thus, the peso navbox shows.Chilean peso has more than two navboxes; thus, the peso navbox collapses.
|state={{{state<includeonly>|expanded</includeonly>}}} All transcluding articles show the content by default, unless there is a hypothetical article that specifies{{templatename|state=collapsed}} when transcluding.
Example 3:{{Tourism}} withcollapsed as the default initial state, as such:
|state={{{state<includeonly>|collapsed</includeonly>}}} All transcluding articles will show the template as collapsed by default, but the template will still be uncollapsed when displayed on its own page.
The template{{Collapsible option}} explains how to use thestate parameter. It can be added to a<noinclude>...</noinclude> section after the template definition or to the instructions on the{{documentation subpage}}.
navbar*
If set toplain, theV • T • E links on the left side of the titlebar will not be displayed, and padding will be automatically used to keep the title centered. Useoff to remove theV • T • E links, but not apply padding (this is for advanced use only; the "plain" option should suffice for most applications where a navbar is not desired). It is highly recommended that one not hide the navbar, in order to make it easier for users to edit the template, and to keep a standard style across pages.
border*
See later section onusing navboxes within one another for examples and a more complete description. If set tochild orsubgroup, then the navbox can be used as a borderless child that fits snugly in another navbox. The border is hidden and there is no padding on the sides of the table, so it fits into thelist area of its parent navbox. If set tonone, then the border is hidden and padding is removed, and the navbox may be used as a child of another container (do not use thenone option inside of another navbox; similarly, only use thechild/subgroup option inside of another navbox). If set to anything else (default), then a regular navbox is displayed with a 1px border. An alternate way to specify the border to be a subgroup style is like this (i.e. use the first unnamed parameter instead of the namedborder parameter):
Text that appears centered in the top row of the table. It is usually the template's topic, i.e. a succinct description of the body contents. This should be a single line, but if a second line is needed, use{{-}} to ensure proper centering. This parameter is technically not mandatory, but using{{Navbox}} is rather pointless without a title.
above*
A full-width cell displayed between the titlebar and first group/list, i.e.above the template's body (groups, lists and image). In a template without an image,above behaves in the same way as thelist1 parameter without thegroup1 parameter.
groupn*
(i.e.group1,group2, etc.) If specified, text appears in a header cell displayed to the left oflistn. If omitted,listn uses the full width of the table.
listn*
(i.e.list1,list2, etc.) The body of the template, usually a list of links. Format is inline, although the text can be entered on separate lines if the entire list is enclosed within<div>...</div>. At least onelist parameter is required; each additionallist is displayed in a separate row of the table. Eachlistn may be preceded by a correspondinggroupn parameter, if provided (see below).
Entries should be separated using anewline and anasterisk (*). If instead two asterisks are used, it providesnesting within the previous entry by enclosing the entry with brackets. Increasing the number of asterisks used increases the number of brackets around entries.
An image to be displayed in a cell below the title and to the right of the body (the groups/lists). For the image to display properly, thelist1 parameter must be specified. Theimage parameter accepts standard wikicode for displaying an image,e.g.:[[File:XX.jpg|80px|link=|alt=]] nb: including|right will produce the usual left margin to provide separation from the list items andzebra striping.
Note that most of such images don't comply withMOS:DECOR and should be removed at sight. A rare example of a correct usage would bethis one: a map shows (in green) the location of a region within the state of Kazakhstan, and this is consistently implemented forall state's regions.
imageleft*
An image to be displayed in a cell below the title and to the left of the body (lists). For the image to display properly, thelist1 parameter must be specified and no groups can be specified. It accepts the same sort of parameter thatimage accepts.
below*
A full-width cell displayedbelow the template's body (groups, lists and image). In a template without an image,below behaves in the same way as the template's finallistn parameter without agroupn parameter. For an example of thebelow parameter in use, seethis version of{{Lists of the provinces and territories of Canada}}.{{icon}} is often used for non-article links, for example{{icon|category}}[[:Category:name|Category]].
Style parameters
Styles are generally advised against, to maintain consistency among templates and pages in Wikipedia; but the option to modify styles is given.
bodystyle*
SpecifiesCSS styles to apply to the template body. This option should be used sparingly as it can lead to visual inconsistencies. Examples:
bodystyle = background: #nnnnnn;
bodystyle = width:N [em/%/px or width: auto];
bodystyle = float: [left/right/none];
bodystyle = clear: [right/left/both/none];
basestyle*
CSS styles to apply to thetitle,above,below, andgroup cells all at once. The styles are not applied tolist cells. This is convenient for easily changing the basic color of the navbox without having to repeat the style specifications for the different parts of the navbox. Example:basestyle = background: lightskyblue;
titlestyle*
CSS styles to apply totitle, most often the titlebar's background color:
titlestyle = background:#nnnnnn;
titlestyle = background:name;
titlestyle = background: none; — for no background color
groupstyle*
CSS styles to apply to thegroupN cells. This option overrides any styles that are applied to the entire table. Examples:
groupstyle = background: #nnnnnn;
groupstyle = text-align: [left/center/right];
groupstyle = vertical-align: [top/middle/bottom];
groupnstyle*
CSS styles to apply to a specific group, in addition to any styles specified by thegroupstyle parameter. This parameter should only be used when absolutely necessary in order to maintain standardization and simplicity. Example:group3style = background: red; color: white;
groupwidth
A number and unit specifying a uniform width for the group cells, in cases where little content in the list cells may cause group cells to be too wide. No default. However, may be overridden by thegroup(n)style parameter. Example:groupwidth = 9em
liststyle*
CSS styles to apply to all lists. Overruled by theoddstyle andevenstyle parameters (if specified) hereafter. When using backgound colors in the navbox, see thenote hereafter.
listnstyle*
CSS styles to apply to a specific list, in addition to any styles specified by theliststyle parameter. This parameter should only be used when absolutely necessary in order to maintain standardization and simplicity. Example:list5style = background: #ddddff;
listpadding*
A number and unit specifying the padding in eachlist cell. Thelist cells come equipped with a default padding of 0.25em on the left and right, and 0 on the top and bottom. Due to complex technical reasons, simply setting "liststyle = padding: 0.5em;" (or any other padding setting) will not work. Examples:
listpadding = 0.5em 0; (sets 0.5em padding for the top/bottom, and 0 padding for the left/right.)
listpadding = 0; (removes all list padding.)
oddstyle
evenstyle
Applies to odd/even list numbers. Overrules styles defined byliststyle. The default behavior is to add striped colors (white and gray) to odd/even rows, respectively, in order to improve readability. These should not be changed except in extraordinary circumstances.
evenodd[swap, even, odd, off]
If set toswap, then the automatic striping of even and odd rows is reversed. Normally, even rows get a light gray background for striping; when this parameter is used, the odd rows receive the gray striping instead of the even rows. Setting toeven orodd sets all rows to have that striping color. Setting tooff disables automatic row striping.
abovestyle*
belowstyle*
CSS styles to apply to the top cell (specified via theabove parameter) and bottom cell (specified via thebelow parameter). Typically used to set background color or text alignment:
abovestyle = background: #nnnnnn;
abovestyle = text-align: [left/center/right];
belowstyle = background: #nnnnnn;
belowstyle = text-align: [left/center/right];
imagestyle*
imageleftstyle*
CSS styles to apply to the cells where the image/imageleft sits. These styles should only be used in exceptional circumstances, usually to fix width problems if the width of groups is set and the width of the image cell grows too large. Example:imagestyle = width:5em;
Default styles
The style settings listed here are those that editors using the navbox change most often. The other more complex style settings were left out of this list to keep it simple. Most styles are set inModule:Navbox/styles.css.
Sinceliststyle andoddstyle are transparent, odd lists have the color of thebodystyle, which defaults to #fdfdfd (white with a hint of gray). A list defaults totext-align: left; if it has a group, if not it defaults totext-align: center;. Since onlybodystyle has a vertical-align all the others inherit itsvertical-align: middle;.
Advanced parameters
bodyclass
aboveclass
groupclass
listclass
belowclass
This enables attaching a CSS class to group or list cells. The most common use forlistclass is to give it thehlist class that will cause lists to render horizontally. All these parameters accept thehlist class, but if more than one parameter is used forhlist, use|bodyclass=hlist instead.
{{navbox}} automatically adds the classnowraplinks which can be overridden, for example with|listclass=wraplinks.
innerstyle
A very advanced parameter to be usedonly for advanced meta-templates employing the navbox. Internally, the navbox uses an outer table to draw the border, and then an inner table for everything else (title/above/groups/lists/below/images, etc.). Thestyle/bodystyle parameter sets the style for the outer table, which the inner table inherits, but in advanced cases (meta-templates) it may be necessary to directly set the style for the inner table. This parameter provides access to that inner table so styles can be applied. Use at your own risk.
nowrapitems
Setting|nowrapitems=yes applies nowrap to each line in a list item, and to anyabove orbelow item.
orphan
Setting|orphan=yes in a child navbox fixes odd/even striping and removesCategory:Navbox orphans.
Microformats
bodyclass
This parameter is inserted into the "class" attribute for the navbox as a whole.
titleclass
This parameter is inserted into the "class" attribute for the navbox's title caption.
This template supports the addition of microformat information. This is done by adding "class" attributes to various data cells, indicating what kind of information is contained within. To flag a navbox as containinghCard information about a person, for example, add the following parameter:
| bodyclass = vcard
and
| titleclass = fn
or (for example):
| title = The books of<spanclass="fn">[[Iain Banks]]</span>
It is possible to place multiple navboxes within a single border. These can either be specified inline or by using a nested navbox template, although the latter method can result in a significantly largepost-expand include size.
To specify child navboxes inline, set thelistn parameter tochild orsubgroup. Elements of the child navbox can be specified by prependingchildn_,subgroupn_, or justn_ to the parameter names (e.g.1_list1). Child navboxes can be nested by adding an additional prefix (e.g.1_1_list1). The basic code for doing this is as follows (which adds a subgroup for the first group/list area):
To specify child navboxes using a nested template, use "child" as the first parameter or set theborder parameter. The basic code for doing this is as follows (which adds a subgroup for the first group/list area):
This example shows two subgroups and a sub-subgroup created usingchild andsubgroup keywords (both are interchangible). The striping is alternated automatically. To remove the striping altogether, you can setchildn_liststyle = background:transparent; in each.
This navbox template works in conjunction with two other templates:{{Navbox with columns}} and{{Navbox with collapsible groups}}. All three of these templates share common parameters for consistency and ease of use (such parameters are marked with an asterisk (*) in theparameter descriptions list hereinbefore). Most importantly, each template can be used as a child of one another. Using the inline notation, then_type= parameter can be set towith columns orwith collapsible groups to set the type of that child navbox, as shown in the example below. Press the edit button for the section to view the code.
Navbox with nested regular Navbox, Navbox with Collapsible Groups, and Navbox with Columns
Regular Navbox
Group 1
List 1.1
List 1.2
Group 2
List 2.1
List 2.2
Navbox with Collapsible Groups
Group 1
List 1.1
List 1.2
Group 2
List 2.1
List 2.2
Navbox with Columns
Column 1
Column 2
List 1.1
List 1.2
List 2.1
List 2.2
Regular Navbox
Group 1
List 1.1
List 1.2
Group 2
List 2.1
List 2.2
Navbox with Collapsible Groups
Group 1
List 1.1
List 1.2
Group 2
List 2.1
List 2.2
Navbox with Columns
Column 1
Column 2
List 1.1
List 1.2
List 2.1
List 2.2
You can also nest these or other navbox templates by using the|border=child parameter, or by specifying the first unnamed parameter to bechild. For example:{{Navbox|child ...}},{{Navbox with columns|child ...}} or{{Navbox with collapsible groups|child ...}}. Note that this style of nesting can lead to a large increase in the template'spost-expand include size.
The example below is generated using a regular navbox for the main container, then its list1, list2, and list3 parameters each contain thechild keyword. The view (v), talk (t), edit (e) navbar links are hidden automatically because the "child" or "subgroup" keyword is used, so usingnavbar = plain for each of them is not necessary. The codeN_state ={{#ifeq:{{{selected|}}|ABBREVIATION|uncollapsed|{{{stateN|collapsed}}}}} is used to replicate theabbrN = ABBREVIATION functionality of{{Navbox with collapsible groups}}.
The 2px wide border between groups and lists is drawn using the border-left property of the list cell. Thus, if you wish to change the background color of the template (for examplebodystyle = background:purple;), then you'll need to make the border-left-color match the background color (i.e.liststyle = border-left-color: purple;). If you wish to have a border around each list cell, then the 2px border between the list cells and group cells will disappear; you'll have to come up with your own solution.
Adjacent navboxes have only a 1 pixel border between them. If you set the top or bottom margin ofstyle/bodystyle, then this will not work.
The default margin-left and margin-right of the outer navbox table are set to "auto;". If you wish to use navbox as a float, you need to manually set the margin-left and margin-right values, because the auto margins interfere with the float option. For example, add the following code to use the navbox as a float:
Navbox templates, including this one, are a major contributor to thepost-expand include size of pages, and can cause pages to exceed the limit and not render correctly. There are a few ways to mitigate this.
{{Navbox}} can be replaced with{{#invoke:Navbox|navbox}}, which approximately halves the include size.
Nesting other templates inside of a navbox can cause the include size increase by a factor of two or more. Using the in-line child syntax documented at#Child navboxes mitigates this, but only for plain Navboxes, Navboxes with columns, and Navboxes with collapsible groups (not other types of navboxes).
Copying to other projects or wikis
If you are trying to copy{{Navbox}} to your local wiki, there are several other things that must be installed or copied over as well:
Optionally, theAdd support to mw-collapsible for autocollapse, innercollapse and outercollapse script fromMediaWiki:Common.js may be copied, if autocollapsing is desired.
The name of the template. Needed for "View • Talk • Edit" links to work properly.
Default
{{subst:PAGENAME}}{{subst:void|Don't change anything on this line. It will change itself when you save.}}
String
suggested
Title
title
Text in the title bar; centered in the top row of the table. Usually the template's topic.
Example
[[Widget stuff]]
Unknown
suggested
Group 1
group1
If specified, text appears in a header cell displayed to the left of list 1. If omitted, list 1 uses the full width of the table.
Unknown
suggested
List 1
list1
Body of the template; usually a list of links. Format is inline. At least one list parameter is required; each additional list is displayed in a separate row of the table. Each listn may be preceded by a corresponding groupn parameter.Entries should be separated using a newline and an asterisk. If two asterisks are used, it provides nesting within the previous entry with brackets.
Unknown
required
List class
listclass
CSS class for the list cells, usually hlist for horizontal lists. Alternatively, use bodyclass for the whole box.
Example
hlist
String
optional
State
state
Controls when a navbox is expanded or collapsed
Suggested values
autocollapsecollapsedexpandedplainoff
Default
autocollapse
Example
autocollapse
Unknown
suggested
Above
above
Full-width cell displayed between the titlebar and first group/list, i.e. above the template's body (groups, lists and image)
String
suggested
Below
below
Full-width cell displayed below the template's body.
Unknown
suggested
Image
image
Image to be displayed in a cell below the title and to the right of the body
Example
[[File:XX.jpg | 80px | link= | alt= ]]
File
suggested
group2
group2
no description
Unknown
suggested
list2
list2
no description
Unknown
suggested
group3
group3
no description
Unknown
suggested
list3
list3
no description
Unknown
suggested
group4
group4
no description
Unknown
optional
list4
list4
no description
Unknown
optional
Image left
imageleft
Image to be displayed in a cell below the title and to the left of the body. For the image to display properly, list1 parameter must be specified and no groups can be specified.
Example
[[File:XX.jpg | 80px | link= | alt= ]]
File
optional
Navbar status
navbar
no description
Example
plain, off
String
optional
Border status
border
no description
Example
child, subgroup, none
String
optional
bodystyle
bodystyle
no description
Unknown
optional
basestyle
basestyle
no description
Unknown
optional
titlestyle
titlestyle
no description
Unknown
optional
groupstyle
groupstyle
no description
Unknown
optional
liststyle
liststyle
no description
Unknown
optional
group1style
group1style
no description
Unknown
optional
list1style
list1style
no description
Unknown
optional
groupwidth
groupwidth
no description
Unknown
optional
listpadding
listpadding
no description
Unknown
optional
oddstyle
oddstyle
no description
Unknown
optional
evenstyle
evenstyle
no description
Unknown
optional
evenodd
evenodd
no description
Suggested values
swapevenoddoff
Unknown
optional
abovestyle
abovestyle
no description
Unknown
optional
belowstyle
belowstyle
no description
Unknown
optional
imagestyle
imagestyle
no description
Unknown
optional
imageleftstyle
imageleftstyle
no description
Unknown
optional
See also
{{Navbox decade list}} — To create a row of ten evenly spaced year links.
{{Navboxes}} — groups several navigation boxes together.
{{Nobold}} — To display text at normal font-weight within a context where the default font-weight is bold, e.g. header cells in tables.
Wikipedia:Line-break handling — The how-to guide about how to handle word wraps (line breaks) on Wikipedia, such as the wrapping of the link lists used in navboxes.
{{Nowrap begin}},{{·}} and{{•}} aredeprecated in favor of thehlist class for formatting lists. SeeFlatlist for a technical explanation of howhlist works.
