Template:Spoiler/doc
Jump to navigation
Jump to search
This template is used to mark text and other elements as spoilers. Users can click or optionally hover to reveal their content.
{
"params": {
"1": {
"aliases": [
"text"
],
"label": "Text",
"description": "The text to be shown.",
"example": "Character A died during the battle.",
"type": "content",
"required": true
},
"hover": {
"label": "Show on Hover?",
"description": "Show spoiler text on mouse hover.",
"example": "hover=yes",
"type": "boolean",
"default": "hover=no"
},
"block": {
"label": "Display as block?",
"description": "If given, display the spoiler as a block instead of inline. Useful for long spoilers spanning multiple lines or using block-level elements like lists.",
"example": "y",
"type": "boolean",
"suggested": true
},
"class": {
"label": "Class",
"description": "A class or classes to apply to the spoiler",
"type": "string"
},
"id": {
"label": "ID",
"description": "A CSS ID to apply to the spoiler.",
"type": "string"
},
"style": {
"description": "Inline CSS styles to pass in.",
"type": "string",
"aliases": [
"css"
],
"label": "Style"
}
},
"description": "This template can be used to mark text as a spoiler.",
"maps": {
"1": {}
},
"paramOrder": [
"1",
"hover",
"block",
"class",
"id",
"style"
],
"format": "inline"
}
The hoverShowSpoilers gadget
Users can enable thehoverShowSpoilers gadget to make spoilers show on hover, not just on click. The code for this gadget can be found at MediaWiki:Gadgets/hoverShowSpoilers/main.css.
Examples
| Code | Result |
|---|---|
| Spoiler — show detailsspoiler text |
| Spoiler — show detailsspoiler text with a link |
{{spoiler|block=y|Really long spoiler that spans multiple lines
| Spoiler — show detailsReally long spoiler that spans multiple linesIt even has a bulleted list inside it:
|
Dependencies
For this template to work properly, you need the following:- The
spoilersgadget with JavaScript code for toggling the.spoilerclass on/off on click: - MediaWiki:Gadgets/spoilers
- MediaWiki:Gadgets/spoilers/main.js
- The
.spoiler-contentand any related classes, found in MediaWiki:Common.css.