Template:ColorBox/doc

From Bulbapedia, the community-driven Pokémon encyclopedia.
< Template:ColorBox
Revision as of 19:45, 1 September 2024 by Rustle (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Colorbox is a customisable box that includes a colored title bar and seperate content area. It if often used in combination with {{ContentGrid}}.

How to use

Parameters

All parameters are case sensitive.

Parameter Allowed values Notes
t-background List of colors » Sets the background color of the title bar. If using a color template, use the whole name, e.g. {{Emerald color}}. Don't include #. Defaults to {{bulba color light}}.
t-background2 List of colors » Optional. Allows for a second title bar color. If using a color template, use the whole name, e.g. {{Emerald color}}. Don't include #.
t-color List of colors » Sets the title bar text color. Don't include #. Defaults to 000.
t-align leftrightcenterjustify Sets the alignment of the tile in the title bar. Defaults to center.
icon File name Optional. Allows for an icon to be displayed in the title bar. Don't include File:.
icon-size String Sets the size of the icon. Must include px. Defaults to 20px.
title String The title to be displayed on the title bar.
margin String The margin around the box. Defaults to 0.5em 0.5em 1em 0.5em.
c-background List of colors » Sets the background color of the content area. If using a color template, use the whole name, e.g. {{Emerald color}}. Don't include #. Defaults to FFF.
c-color List of colors » Sets the content area text color. Don't include #. Defaults to 000.
c-align leftrightcenterjustify Sets the alignment of the text in the content area. Defaults to left.
c-pad String The padding around the content. Defaults to 0.5em 1em 0.5em 1em.
content String The content to be displayed in the content area.

Examples

Example 1

{{ColorBox
| t-background = CCC
| icon = Bulbagarden Archives bulb.png
| title = {{color2|000|a:Main Page|Bulbagarden Archives}}
| content = <nowiki/>
* [[a:Archives:FAQ|FAQ]]
* [[a:Help:Uploading images|Uploading images]]
* [[a:Archives:Tagging images|Tagging images]]
* [[a:Archives:Manual of style|Manual of style]]
}}


Example 2

{{ColorBox
| c-align = center
| title = [[File:BMGf bulb.png|90px|link=https://bulbagarden.net/forums/bulbawiki-forum.195/]]
| content = [https://bulbagarden.net/forums/bulbawiki-forum.195/ Ask a question on the forums]
}}


Example 3

{{ColorBox
| t-background = {{diamond color}}
| t-background2 = {{pearl color}}
| c-align = center
| title = {{color2|FFF|Appendix:Diamond and Pearl walkthrough|Pokémon Diamond & Pearl walkthrough}}
| content = [[File:Diamond EN boxart.jpg|150px|border|link=Appendix:Diamond and Pearl walkthrough]] [[File:Pearl EN boxart.jpg|150px|border|link=Appendix:Diamond and Pearl walkthrough]]
}}

TemplateData

Colorbox is a customisable box that includes a colored title bar and seperate content area. It if often used in combination with the ContentGrid template.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Title backgroundt-background

Sets the background color of the title bar. Either a hex value (don't include a #), or a color template.

Default
{{bulba color light}}
Example
CCC
Lineoptional
Title background 2t-background2

Optional. Allows for a second title bar color. Either a hex value (don't include a #), or a color template.

Default
{{bulba color light}}
Example
000
Lineoptional
Title text colort-color

Sets the title bar text color. Either a hex value (don't include a #), or a color template.

Default
000
Example
FFF
Lineoptional
Title alignmentt-align

Sets the alignment of the tile in the title bar.

Suggested values
left right center justify
Default
center
Lineoptional
Iconicon

Optional. Allows for an icon to be displayed in the title bar (don't include File:).

Example
001Bulbasaur.png
Fileoptional
Icon sizeicon-size

Sets the size of the icon. Must include px.

Default
20px
Lineoptional
Titletitle

The title to be displayed on the title bar.

Linerequired
Marginmargin

The margin around the box.

Default
0.5em 0.5em 1em 0.5em
Unknownoptional
Content backgroundc-background

Sets the background color of the content area. Either a hex value (don't include a #), or a color template.

Default
FFF
Example
{{bulba color light}}
Lineoptional
Content text colorc-color

Sets the content area text color. Either a hex value (don't include a #), or a color template.

Default
FFF
Example
CCC
Lineoptional
Content alignmentc-align

Sets the alignment of the text in the content area.

Suggested values
left right center justify
Default
left
Lineoptional
Content paddingc-pad

The padding around the content.

Default
0.5em 1em 0.5em 1em
Unknownoptional
Contentcontent

The content to be displayed in the content area.

Stringrequired