Template:ColorBox2/doc
ColorBox2 is a customizable box that includes a title bar and separate content area. It is a variation of {{ColorBox}}
How to use
Parameters
All parameters are case sensitive.
| Parameter | Allowed values | Notes |
|---|---|---|
width
|
String | Optional. Sets a maximum width for the box. |
t-color
|
List of colors » | Sets the title bar text color. Don't include #. Defaults to 000.
|
t-align
|
left • right • center • justify
|
Sets the alignment of the tile in the title bar. Defaults to center.
|
t-pad
|
String | The padding around the title. Defaults to 0.5em 1em 0.5em 1em.
|
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
|
left • right • center • justify
|
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. |
TemplateData
ColorBox2 is a variation of the ColorBox template.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Box width | width | Optional. Sets a maximum width for the box.
| Unknown | optional |
| Class | class | Optional. Allows for adding extra CSS classes. | String | optional |
| Title text color | t-color | Sets the title bar text color. Either a hex value (don't include a #), or a color template.
| Line | optional |
| Title alignment | t-align | Sets the alignment of the tile in the title bar.
| Line | optional |
| Title padding | t-pad | The padding around the title.
| Unknown | optional |
| Icon | icon | Optional. Allows for an icon to be displayed in the title bar (don't include File:).
| File | optional |
| Icon size | icon-size | Sets the size of the icon. Must include px.
| Line | optional |
| Title | title | The title to be displayed on the title bar. | Line | required |
| Margin | margin | The margin around the box.
| Unknown | optional |
| Content background | c-background | Sets the background color of the content area. Either a hex value (don't include a #), or a color template.
| Line | optional |
| Content text color | c-color | Sets the content area text color. Either a hex value (don't include a #), or a color template.
| Line | optional |
| Content alignment | c-align | Sets the alignment of the text in the content area.
| Line | optional |
| Content padding | c-pad | The padding around the content.
| Unknown | optional |
| Content | content | The content to be displayed in the content area. | String | required |