Template:Navbox documentation
| File:Handheld devices no.svg | This template does not display in the mobile view of Wikipedia; it is desktop only. See Template:Navbox visibility for a brief explanation. |
This is a navigational template created using {{navbox}}. It can be transcluded on pages by placing {{Navbox documentation}} below the standard article appendices.
Initial visibility
This template's initial visibility currently defaults to autocollapse, meaning that if there is another collapsible item on the page (a navbox, sidebar, or table with the collapsible attribute), it is hidden apart from its title bar; if not, it is fully visible.
To change this template's initial visibility, the |state= parameter may be used:
{{Navbox documentation|state=collapsed}}will show the template collapsed, i.e. hidden apart from its title bar.{{Navbox documentation|state=expanded}}will show the template expanded, i.e. fully visible.
Templates using the classes class=navbox ({{navbox}}) or class=nomobile ({{sidebar}}) are not displayed in article space on the mobile web site of English Wikipedia. Mobile page views accounted for 60% to 70% of all page views from 2020 through 2025. 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/watch phab:T124168 for further discussion.
TemplateData
A navigational box that can be placed at the bottom of articles.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| State | state | The initial visibility of the navbox
| String | suggested |
Template transclusions
| Transclusion maintenance |
|---|
| Check completeness of transclusions |
| Warning | This template is used on approximately 45,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This is a wrapper for {{Documentation}} to provide a semblance of documentation for navbox templates. See that template for further guidance.
Elements
This template uses the following single elements: {{Template display}}, {{Collapsible option}}, {{Navbox visibility}} and {{Check completeness of transclusions}}. The {{Collapsible option}} template can be suppressed with |stateless=yes.
TemplateData
TemplateData for Navbox documentation
A wrapper for the {{Documentation}} template to provide a semblance of documentation for navbox templates.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Hatnotes | hatnotes | Hatnotes to appear above the template banners
| Content | optional |
| Top content | intro or 2 | Template shortcuts/redirects, High-use template, templatestyles, usage, etc. (put below {{Template display|nomobile}}) | Content | optional |
| Content | 3 | TemplateData, See also, etc. (below {{collapsible option}}) | Content | optional |
| State | state or 1 | The default initial state of the template. Set to either: (1) expanded, (2) collapsed, or (3) autocollapse
| Unknown | suggested |
| Template | template | To call the template anything other than {{PAGENAME}} within the documentation
| String | optional |
| Stateless | stateless | Hides the {{Collapsible option}} transclusion for when the navbox doesn't support a state.
| Unknown | optional |
| nobase | nobase | Pass through to {{Collapsible option}} to disable BASEPAGENAME detection. Use it when the template's name contains a forward slash, which can break basepage-subpage distinction. | Boolean | optional |