Template:Navbox/doc

This is a documentation subpage for Template:Navbox.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Purge base's cache

Navboxes can be misused, resulting in irrelevant text (and often links) on many pages. It also makes it harder for everyone to search. Users should avoid placing loosely related topic or provide arguments to adjust their navboxes or just split them.

The NavBox template is a highly flexible and customizable navigation box template designed for grouping related links/articles. Commonly used in wiki footers, it organizes links into collapsible rows of labeled groups and lists.

Sections "See also" cannot be considered as a replacement for navboxes without Labeled Section Transclusion.

Todo: Make the table nicer.

Todo: Add default styling for elements.

Code

{{Navbox
 | name        = Example
 | title       = Navigation Title
 | state       = collapsed
 | list1       = [[Page1]] • [[Page2]]
 | group1      = Group 1
 | list2       = [[Page3]] • [[Page4]]
 | group2      = Group 2
}}

Parameters

Parameters	Description
border or 1	Changes the outer container style. Values: child, subgroup, none
state	Initial state. Values: collapsed, expanded, autocollapse, plain, off
bodystyle	Inline CSS for outer table
innerstyle	Inline CSS for inner table
style	General style override
bodyclass	Additional class for inner navbox table
title	Text shown in the top header
titleclass	CSS class applied to title text
titlestyle	Inline CSS for the title cell
titlegroup	Separate label column left of title
titlegroupstyle	CSS style for titlegroup
navbar	Whether to show the mini-navbar. Values: off, plain, yes
name	Required if navbar is enabled. Used to identify the template for navbar rendering
above	Text or links shown above group/list rows
aboveclass	CSS class for above row
abovestyle	Style override for above row
groupN	Label on the left for the N-th row (where N = 1 to 20)
groupNstyle	Style for the N-th group
listN	Content of the N-th row, usually links
listNstyle	Style for list content
listNpadding	Padding inside the list cell
evenodd	Alternating row color style (e.g., odd, even, swap)
image	Right-side image (applies to whole box)
imageleft	Left-side image
imageclass	CSS class for image cell
imagestyle	CSS style for image
imageleftstyle	CSS for left image
basestyle	Style applied to all group/list cells
groupstyle	General group cell style
liststyle	General list cell style
oddstyle/evenstyle	Alternating row styles
groupclass	CSS class for all group cells
listclass	CSS class for list cells