Wikimore

Collapse

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Template documentation

[view] [edit] [history] [purge]

This template, {{Collapse}}, creates a collapsible container for page content that would benefit from an (optional) ability to be hidden from view, with the ability to appear in either the collapsed or expanded state by default.

Usage

In its simplest functional use case, the template's invocation need only include the parameters for the container's title and contents, taking the form:

{{Collapse|title=Box title|content=The contents of the box…}}

Blank example blocks

With common parameters only

Below is an example of the template formatted as a block with the most commonly used parameters, plus guidance on valid values where applicable; please delete all unused parameters before saving if copied and pasted.

{{Collapse
 | title        =
 | expand       = <!-- 'no' to default to collapsed state, otherwise leave unset -->
 | background-c =
 | align        =
 | padding      =
 | content      = <!-- Box content goes here -->
}}

With all parameters

Below is an example of the template formatted as a block with all possible named parameters, plus guidance on valid values where applicable; please delete all unused parameters before saving if copied and pasted.

{{Collapse
 | title        =
 | expand       = <!-- 'no' to default to collapsed state, otherwise leave unset -->
 | background-c =
 | color        =
 | font-size    =
 | align        =
 | padding      =
 | width        =
 | margin       =
 | clear        = <!-- [ none | left | right ] -->
 | border-w     = <!-- [ thin | medium | thick ] or absolute length -->
 | border-s     = <!-- [ none | hidden | dotted | dashed | double | groove | ridge | inset | outset ] -->
 | border-c     =
 | header-align = <!-- [ start | end | left | right | justify | match-parent | justify-all ] -->
 | header-c     =
 | header-bw    = <!-- [ thin | medium | thick ] or absolute length -->
 | header-bs    = <!-- [ none | hidden | dotted | dashed | double | groove | ridge | inset | outset ] -->
 | header-bc    =
 | header-fc    =
 | header-fs    =
 | header-fw    = <!-- [ 100 | 200 | 300 | normal | 500 | 600 | bold | 800 | 900 ] -->
 | header-p     =
 | class        =
 | style        =
 | content      = <!-- Box content goes here -->
}}

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Collapse

Category:Templates using TemplateData

Places page content that consumes excess vertical space or is likely to interest only a subset of readers within a collapsible box that can appear in either state by default, keeping it in place and accessible without detriment to the overall layout or readability

Template parameters
This template has custom formatting.
Parameter		Description	Type	Status
Title	`title` `2`	The heading which describes the box's contents and is the only thing shown when in the collapsed state Default {{PAGENAME}} Example Some additional technical details…	Line	required
Content	`content` `1`	The page content to appear within the collapsible box Example Lorem ipsum dolor sit amet,…	Content	required
Default expansion state	`expand`	When assigned the value 'no', the container's default appearance becomes its collapsed state Default yes Example no	Boolean	optional
Title background color	`header-c`	Background color of the box title's rectangular element, must be a valid CSS color value (named, hexadecimal code, RGB decimals, etc.) Default #eaecf0 Example goldrenrod	Line	optional
Background color	`background-c`	The background color for the box's contents, which also narrowly surrounds the title in the collapsed state; must be a valid CSS color value (named, hexadecimal code, RGB decimals, etc.). Default white Example #abcdef	Line	optional
Title text color	`header-fc`	Font text color of the box's title, must be a valid CSS color value (named, hexadecimal code, RGB decimals, etc.) Default black Example indigo	Line	optional
Text color	`color`	Font text color of the box's content and, optionally, its title; must be a valid CSS color value (named, hexadecimal code, RGB decimals, etc.). Default #222 Example dimgray	Line	optional
Title font weight	`header-fw`	Sets the thickness of the title text font, must be an unsigned (positive) integer between 100 and 900, inclusive, or a relative CSS font-weight keyword Suggested values `normal` `bold` `lighter` `bolder` `100` `200` `300` `400` `500` `600` `700` `800` `900` Default bold Example 500	Line	optional
Title text size	`header-fs`	Size of the box's title text font, must be a valid CSS length value with unit suffix or a relative size keyword Suggested values `xx-small` `x-small` `small` `medium` `large` `x-large` `xx-large` `xxx-large` Default 0.95rem	Line	optional
Text size	`font-size`	Font size of the text content contained within the box, must be a valid CSS length value with unit suffix or a relative size keyword Suggested values `xx-small` `x-small` `small` `medium` `large` `x-large` `xx-large` `xxx-large` Default 0.85rem	Line	optional
Title alignment	`header-align`	Sets the horizontal alignment of the box's title within its rectangular element Suggested values `start` `end` `left` `right` `center` `justify` `match-parent` `justify-all` Default center Example left	Line	optional
Content alignment	`align`	Sets the horizontal alignment of the box's contents Suggested values `start` `end` `left` `right` `center` `justify` `match-parent` `justify-all` Default none Example justify	Line	optional
Title padding	`header-p`	Sets the padding of the box title's rectangular element, or the distance from which it extends in all four directions beyond the title text; must be composed of 1–4 valid CSS length value(s) with unit suffix(es) Default 0.15rem Example 0.4rem	Line	optional
Content padding	`padding`	Defines the thickness of the null space between the box's contents and its borders, must be composed of 1–4 valid CSS length value(s) with unit suffix(es) Default 0.4em 0.8em 0.2em Example 1rem	Line	optional
Width	`width`	The width of the collapsible box, either as an exact CSS length value with unit suffix or relative percentage of the page or viewport Default 100% Example 50vw	Line	optional
Margin width	`margin`	Defines the size of the collapsible box's margins from other elements on the page, must consist of 1–4 valid CSS length values with unit suffix Suggested values `auto` `0.25rem` `0.5rem` `0.75rem` `1rem` `1.25rem` `1.5rem` `1.75rem` `2rem` Default 0.75rem auto 1.25rem Example 1rem	Line	optional
Float clearance	`clear`	Forces box to move below any floating elements on either or both page margins that prevent it from extending there Suggested values `none` `left` `right` `both` `inline-start` `inline-end` Default both Example both	Line	optional
Title border width	`header-bw`	Thickness of the box title rectangular element's border, must be a valid CSS length value with unit suffix or one of: 'thin', 'medium' or 'thick' Suggested values `thin` `medium` `thick` Default thin Example medium	Line	optional
Border width	`border-w`	Thickness of the box's outer border, must be a valid CSS length value with unit suffix or one of: 'thin', 'medium' or 'thick' Suggested values `thin` `medium` `thick` Default thin Example 2px	Line	optional
Title border style	`header-bs`	Style of the box title rectangular element's border Suggested values `none` `hidden` `dotted` `dashed` `solid` `double` `groove` `ridge` `inset` `outset` Default solid Example ridge	Line	optional
Border style	`border-s`	Style of the box's outer border Suggested values `none` `hidden` `dotted` `dashed` `solid` `double` `groove` `ridge` `inset` `outset` Default solid Example double	Line	optional
Title border color	`header-bc`	Color of the box title rectangular elements's outer border, must be a valid CSS color value (named, hexadecimal code, RGB decimals, etc.) Default #a4aab080 Example navy	Line	optional
Border color	`border-c`	Color of the box's outer border, must be a valid CSS color value (named, hexadecimal code, RGB decimals, etc.) Default #aaa Example darkslateblue	Line	optional
Extra CSS classes	`class`	Adds additional class names to the top-level 'div' HTML container element Example toccolours	Line	optional
Extra CSS style declarations	`style`	Defines additional CSS style declarations to be added to the collapsible container's outer table element, multiple declarations must be semicolon-delimited Example white-space: nowrap;	String	optional