View source for Template:Collapsible list/doc

{{Documentation subpage}}
{{tsh|clist}}
{{Lua|Module:Collapsible list}}
__NOTOC__

This template produces a collapsible list. It is possible to set [[wikipedia:CSS|CSS]] styles for the "frame" (the {{tag|div}} tags surrounding the list), for the list title, and for the list items. The template supports an unlimited number of list items.

This template is typically used in [[wikipedia:Infobox|infoboxes]] and [[wikipedia:NAVBOX|navboxes]]; it should not normally be used in regular article content.

== Syntax ==
{{tj|Collapsible list
 | expand: 
 | framestyle: 
 | titlestyle: 
 | title: 
 | liststyle: 
 | hlist: 
 | bullets: 
 | 1:     <nowiki><!--(First item in list; the "1 =" is usually not required)--></nowiki>
 | 2:     <nowiki><!--(Second item in list; ditto)--></nowiki>
 | 3:     <nowiki><!--(Third item in list; etc.)--></nowiki>
 | <nowiki><!-- etc --></nowiki>
}}

== Parameters ==
{| class="wikitable" style="margin:auto"
|-
! Parameter !! Description
|-
| {{para|expand}} || Any text in this parameter (including "no") sets the list's default state to expanded rather than collapsed. Omit the parameter or leave it blank to set the default state to collapsed.
|-
| {{para|framestyle}} || Custom CSS styling applied the template overall (title and list).
|-
| {{para|titlestyle}} || Custom CSS styling applied to the title.
|-
| {{para|title}} || The list's title (always on view beside the list's [show/hide] link).
|-
| {{para|liststyle}} || Custom CSS styling applied to the list (specifically, to the {{tag|ul}} tags delimiting the list).
|-
| {{para|hlist}} || Include as {{para|hlist|on}}, {{para|hlist|true}}, etc to produce a horizontal rather than vertical list.
|-
| {{para|bullets}} || Include as {{para|bullets|on}}, {{para|bullets|true}}, etc to place a [[wikipedia:Bullet (typography)|bullet point]] before each list item.
|-
| Unnamed parameters{{br}}(first, second, third...) || The list items (in the order in which they will appear). If none are supplied, the template outputs nothing.
|}

== Examples ==
<div style="float:right;width:45%">
{{collapsible list |title=[[wikipedia:European Free Trade Association|European Free Trade Association]] members |[[wikipedia:Iceland|Iceland]] |[[wikipedia:Liechtenstein|Liechtenstein]] |[[wikipedia:Norway|Norway]] |[[wikipedia:Switzerland|Switzerland]]}}
</div>

{{tj|Collapsible list
 | title: {{!(n(}}European Free Trade Association]] members
 | {{!(n(}}Iceland]]
 | {{!(n(}}Liechtenstein]]
 | {{!(n(}}Norway]]
 | {{!(n(}}Switzerland]]
}}

=== Example of a list without borders because it is within an infobox ===
In these examples, the fields Associate Names and Circles have been changed to use collapsible list.
{{Infobox Creator
  | Name Romanji = Enzou
  | Name Kanji = エンゾウ
  | Image = Enzou.jpg
  | Occupation = Mangaka
  | Place of Birth = Japan
  | Birth Date = {{Bdy|09|05}}
  | Death Date =  
  | Sex = Female
  | Blood Type = A
  | Associated Names = 
{{Collapsible list
  | framestyle= border:none; padding:0; <!--Hides borders and improves row spacing-->
  | title= List of Pseudonym
  | bullets= on
  | Theta (Enzou) 
  | θ (エンゾウ)
}}
  | Circles = 
{{Collapsible list
  | framestyle= border:none; padding:0; <!--Hides borders and improves row spacing-->
  | title= List of Doujin Circles
  | bullets= on
  | Fake Circle
  | Fake 2nd Circle
  | Fake 3rd Circle
}}
  | Activity Period =  
}}

{{Pre|{{{{fcb|#4169e1|Infobox Creator}}
  | {{fcb|#2e8b57|Name Romanji}} = {{fc|#933|Enzou}}
  | {{fcb|#2e8b57|Name Kanji}} = {{fc|#933|エンゾウ}}
  | {{fcb|#2e8b57|Image}} = {{fc|#933|Enzou.jpg}}
  | {{fcb|#2e8b57|Occupation}} = {{fc|#933|Mangaka}}
  | {{fcb|#2e8b57|Place of Birth}} = {{fc|#933|Japan}}
  | {{fcb|#2e8b57|Birth Date}} = {{fc|#933|{{((}}Bdy{{!}}09{{!}}05{{))}}}}
  | {{fcb|#2e8b57|Death Date}} =  
  | {{fcb|#2e8b57|Sex}} = {{fc|#933|Female}}
  | {{fcb|#2e8b57|Blood Type}} = {{fc|#933|A}}
  | {{fcb|#2e8b57|Associated Names}} = 
{{{{fcb|#4169e1|Collapsible list}}
  | {{fcb|#2e8b57|framestyle}} = {{fc|#933|border:none; padding:0; <nowiki><!--Hides borders and improves row spacing--></nowiki>}}
  | {{fcb|#2e8b57|title}} = {{fc|#933|List of Pseudonym}}
  | {{fcb|#2e8b57|bullets}} = {{fc|#933|on}}
  | {{fc|#933|Theta (Enzou)}}
  | {{fc|#933|θ (エンゾウ)}}
}}
  | Circles =  
{{{{fcb|#4169e1|Collapsible list}}
  | {{fcb|#2e8b57|framestyle}} = {{fc|#933|border:none; padding:0; <nowiki><!--Hides borders and improves row spacing--></nowiki>}}
  | {{fcb|#2e8b57|title}} = {{fc|#933|List of Doujin Circles}}
  | {{fcb|#2e8b57|bullets}} = {{fc|#933|on}}
  | {{fc|#933|Fake Circle}}
  | {{fc|#933|Fake 2nd Circle}}
  | {{fc|#933|Fake 3rd Circle}}
}}
  | {{fcb|#2e8b57|Activity Period}} =  
}}}}

== TemplateData ==
<templatedata>
{
	"params": {
		"1": {
			"label": "First list item",
			"description": "A single list item",
			"type": "content",
			"suggested": true
		},
		"2": {
			"label": "Second list item",
			"description": "A single list item",
			"type": "content",
			"suggested": true
		},
		"3": {
			"label": "Third list item",
			"description": "A single list item",
			"type": "content",
			"suggested": true
		},
		"4": {
			"label": "Fourth list item",
			"description": "A single list item",
			"type": "content"
		},
		"5": {
			"type": "content"
		},
		"6": {
			"type": "content"
		},
		"7": {
			"type": "content"
		},
		"8": {
			"type": "content"
		},
		"9": {
			"type": "content"
		},
		"10": {
			"type": "content"
		},
		"expand": {
			"label": "Expand list",
			"description": "Expand the list instead of collapsing it",
			"example": "true",
			"type": "string",
			"autovalue": "true"
		},
		"framestyle": {
			"aliases": [
				"frame_style"
			],
			"label": "Frame style",
			"description": "Custom CSS styling applied the template overall (title and list).",
			"example": "border: 1px;",
			"type": "string"
		},
		"titlestyle": {
			"aliases": [
				"title_style"
			],
			"label": "Title style",
			"description": "CSS styling applied to the title",
			"example": "color:brown;",
			"type": "string"
		},
		"title": {
			"label": "Title",
			"description": "The list's title (Always in view beside the list's [show/hide] link).",
			"type": "string",
			"suggested": true
		},
		"liststyle": {
			"aliases": [
				"list_style"
			],
			"label": "List style",
			"description": "CSS styling applied solely to the list itself",
			"example": "list-style-type: square;",
			"type": "string"
		},
		"hlist": {
			"label": "Horizontal list",
			"description": "Use value 'on' or 'true' to produce a horizontal rather than vertical list",
			"example": "true",
			"type": "string",
			"autovalue": "true"
		},
		"bullets": {
			"label": "Bullets",
			"description": "Set as 'on' or 'true' to place a bullet point before each list item",
			"example": "true",
			"type": "string",
			"autovalue": "true"
		}
	},
	"description": "Produces an HTML list that can be collapsed",
	"paramOrder": [
		"title",
		"hlist",
		"bullets",
		"expand",
		"1",
		"framestyle",
		"titlestyle",
		"liststyle",
		"2",
		"3",
		"4",
		"5",
		"6",
		"7",
		"8",
		"9",
		"10"
	],
	"format": "block"
}
</templatedata>

<includeonly>{{sandbox other||{{testcases other||

<!-- Categories below this line, please -->
[[Category:Templates]]
[[Category:Infobox formatting templates]]
}}}}</includeonly>