This is a documentation for Board Game Arena: play board games online !

Difference between revisions of "Template:InfoBox"

From Board Game Arena
Jump to navigation Jump to search
(maxWidth variable, parameters documentation)
Line 14: Line 14:
 
   <div><code>title</code></div>
 
   <div><code>title</code></div>
 
   <div><code>null</code></div>
 
   <div><code>null</code></div>
   <div><code><nowiki>{{quoridorboard |title=Your title text}}</nowiki></code></div>
+
   <div><code><nowiki>{{infoBox |title=Your title text}}</nowiki></code></div>
 
   <div><b><i>Optional:</i></b> specify a title for the infoBox.</div>
 
   <div><b><i>Optional:</i></b> specify a title for the infoBox.</div>
 
   <div><code>body</code></div>
 
   <div><code>body</code></div>
 
   <div><code>null</code></div>
 
   <div><code>null</code></div>
   <div><code><nowiki>{{quoridorboard |body=Your body content}}</nowiki></code>.</div>
+
   <div><code><nowiki>{{infoBox |body=Your body content}}</nowiki></code>.</div>
 
   <div><b><i>Optional:</i></b> specify any body content.</div>
 
   <div><b><i>Optional:</i></b> specify any body content.</div>
 
   <div><code>maxWidth</code></div>
 
   <div><code>maxWidth</code></div>
 
   <div><code>600</code></div>
 
   <div><code>600</code></div>
   <div><code><nowiki>{{quoridorboard |maxWidth=400}}</nowiki></code></div>
+
   <div><code><nowiki>{{infoBox |maxWidth=400}}</nowiki></code></div>
   <div><b><i>Optional:</i></b> specify the maximum width of the infoBox.</div>
+
   <div><b><i>Optional:</i></b> specify the maximum width of the infoBox in px units.</div>
 
   <div><code>topLeftColour</code></div>
 
   <div><code>topLeftColour</code></div>
 
   <div><code>#c30</code></div>
 
   <div><code>#c30</code></div>
   <div><code><nowiki>{{quoridorboard |topLeftColour=red}}</nowiki></code></div>
+
   <div><code><nowiki>{{infoBox |topLeftColour=red}}</nowiki></code></div>
 
   <div><b><i>Optional:</i></b> specify the top left corner colour gradient of the infoBox as a [https://developer.mozilla.org/en-US/docs/Web/CSS/color CSS colour] e.g. <code>blue</code>.</div>
 
   <div><b><i>Optional:</i></b> specify the top left corner colour gradient of the infoBox as a [https://developer.mozilla.org/en-US/docs/Web/CSS/color CSS colour] e.g. <code>blue</code>.</div>
 
   <div><code>middleColour</code></div>
 
   <div><code>middleColour</code></div>
 
   <div><code>#707</code></div>
 
   <div><code>#707</code></div>
   <div><code><nowiki>{{quoridorboard |middleColour=green}}</nowiki></code></div>
+
   <div><code><nowiki>{{infoBox |middleColour=green}}</nowiki></code></div>
 
   <div><b><i>Optional:</i></b> specify the middle colour gradient of the infoBox as a [https://developer.mozilla.org/en-US/docs/Web/CSS/color CSS colour] e.g. <code>blue</code>.</div>
 
   <div><b><i>Optional:</i></b> specify the middle colour gradient of the infoBox as a [https://developer.mozilla.org/en-US/docs/Web/CSS/color CSS colour] e.g. <code>blue</code>.</div>
 
   <div><code>bottomRightColour</code></div>
 
   <div><code>bottomRightColour</code></div>
 
   <div><code>#70c</code></div>
 
   <div><code>#70c</code></div>
   <div><code><nowiki>{{quoridorboard |bottomRightColour=blue}}</nowiki></code></div>
+
   <div><code><nowiki>{{infoBox |bottomRightColour=blue}}</nowiki></code></div>
 
   <div><b><i>Optional:</i></b> specify the bottom right corner colour gradient of the infoBox as a [https://developer.mozilla.org/en-US/docs/Web/CSS/color CSS colour] e.g. <code>blue</code>.</div>
 
   <div><b><i>Optional:</i></b> specify the bottom right corner colour gradient of the infoBox as a [https://developer.mozilla.org/en-US/docs/Web/CSS/color CSS colour] e.g. <code>blue</code>.</div>
 
   <div><code>titleColour</code></div>
 
   <div><code>titleColour</code></div>
 
   <div><code>#fff</code></div>
 
   <div><code>#fff</code></div>
   <div><code><nowiki>{{quoridorboard |titleColour=black}}</nowiki></code></div>
+
   <div><code><nowiki>{{infoBox |titleColour=black}}</nowiki></code></div>
 
   <div><b><i>Optional:</i></b> specify the title text colour as a [https://developer.mozilla.org/en-US/docs/Web/CSS/color CSS colour] e.g. <code>blue</code>.</div>
 
   <div><b><i>Optional:</i></b> specify the title text colour as a [https://developer.mozilla.org/en-US/docs/Web/CSS/color CSS colour] e.g. <code>blue</code>.</div>
 
   <div><code>corner</code></div>
 
   <div><code>corner</code></div>
 
   <div><code>0.5</code></div>
 
   <div><code>0.5</code></div>
   <div><code><nowiki>{{quoridorboard |corner=1}}</nowiki></code></div>
+
   <div><code><nowiki>{{infoBox |corner=1}}</nowiki></code></div>
 
   <div><b><i>Optional:</i></b> specify the corner radius of the infoBox  in rem units.</div>
 
   <div><b><i>Optional:</i></b> specify the corner radius of the infoBox  in rem units.</div>
 
</div>
 
</div>
  
 
</noinclude>
 
</noinclude>

Revision as of 17:21, 15 February 2022

{{{title}}}

{{{body}}}

To insert this info box template into a BGA wiki page, simply type {{infoBox}} (or {{infoBoxes}} for a pair of info boxes) when editing the page.

Available parameters

Parameter
Default value
Example
Description
title
null
{{infoBox |title=Your title text}}
Optional: specify a title for the infoBox.
body
null
{{infoBox |body=Your body content}}.
Optional: specify any body content.
maxWidth
600
{{infoBox |maxWidth=400}}
Optional: specify the maximum width of the infoBox in px units.
topLeftColour
#c30
{{infoBox |topLeftColour=red}}
Optional: specify the top left corner colour gradient of the infoBox as a CSS colour e.g. blue.
middleColour
#707
{{infoBox |middleColour=green}}
Optional: specify the middle colour gradient of the infoBox as a CSS colour e.g. blue.
bottomRightColour
#70c
{{infoBox |bottomRightColour=blue}}
Optional: specify the bottom right corner colour gradient of the infoBox as a CSS colour e.g. blue.
titleColour
#fff
{{infoBox |titleColour=black}}
Optional: specify the title text colour as a CSS colour e.g. blue.
corner
0.5
{{infoBox |corner=1}}
Optional: specify the corner radius of the infoBox in rem units.