Template:ScrollBox/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (comment)
(Added color, border-color and style parameter with an example.)
Line 9: Line 9:
* {{param|noscroll}} - If scrolling shouldn't be active at all. Use if scrolling becomes problematic on nested ScrollBoxes.
* {{param|noscroll}} - If scrolling shouldn't be active at all. Use if scrolling becomes problematic on nested ScrollBoxes.
* {{param|maxheight}} - Change the height threshold for when the ScrollBox should be active. This isn't for things such as KV or I/O lists, as ideally these should use the default to maintain a consistency.
* {{param|maxheight}} - Change the height threshold for when the ScrollBox should be active. This isn't for things such as KV or I/O lists, as ideally these should use the default to maintain a consistency.
* {{param|color}} - Sets the background color of the ScrollBox.
* {{param|border-color}} - Sets the color of the border of the ScrollBox.
* {{param|style}} - Allows the editor to throw in any other style attributes to the ScrollBox.


=== Examples ===
=== Examples ===
Line 79: Line 82:
}}</pre>
}}</pre>
| {{ScrollBox| maxheight=8em | bottom-border=1 | noscroll=1|
| {{ScrollBox| maxheight=8em | bottom-border=1 | noscroll=1|
# One
# Two
# Three
# Four
# Five
# Six
# Seven
# Eight
# Nine
# Ten
}}
|-
| <pre style="width:80%;margin:auto auto;">{{ScrollBox| maxheight=8em | color=#234 | border-color=#456 | style=border-left:10px solid #fc6|
# One
# Two
# Three
# Four
# Five
# Six
# Seven
# Eight
# Nine
# Ten
}}</pre>
| {{ScrollBox| maxheight=8em | color=#234 | border-color=#456 | style=border-left:10px solid #fc6|l=1|
# One
# One
# Two
# Two

Revision as of 06:58, 13 December 2021

Edit-copy.png
This is a documentation subpage for Template:ScrollBox.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Use this to rein in lists such as KV, Input and Ouput lists on entity pages. Reaaally long lists won'tnot flood the entire page this way.

Parameters

  • {{{1}}} - Text that's inside the ScrollBox.
  • {{{title}}} - The title that's above the scroll box. Leave empty for no title.
  • {{{bottom-border}}} - If a short, thin line should be present at the bottom. Use if the scrollbar becomes unreliable from long lists.
  • {{{noscroll}}} - If scrolling shouldn't be active at all. Use if scrolling becomes problematic on nested ScrollBoxes.
  • {{{maxheight}}} - Change the height threshold for when the ScrollBox should be active. This isn't for things such as KV or I/O lists, as ideally these should use the default to maintain a consistency.
  • {{{color}}} - Sets the background color of the ScrollBox.
  • {{{border-color}}} - Sets the color of the border of the ScrollBox.
  • {{{style}}} - Allows the editor to throw in any other style attributes to the ScrollBox.

Examples

Wikitext Result
{{ScrollBox| maxheight=8em|
# One
# Two
# Three
# Four
# Five
# Six
# Seven
# Eight
# Nine
# Ten
}}
  1. One
  2. Two
  3. Three
  4. Four
  5. Five
  6. Six
  7. Seven
  8. Eight
  9. Nine
  10. Ten
{{ScrollBox| maxheight=8em | bottom-border=1|
# One
# Two
# Three
# Four
# Five
# Six
# Seven
# Eight
# Nine
# Ten
}}
  1. One
  2. Two
  3. Three
  4. Four
  5. Five
  6. Six
  7. Seven
  8. Eight
  9. Nine
  10. Ten
{{ScrollBox| maxheight=8em | bottom-border=1 | noscroll=1|
# One
# Two
# Three
# Four
# Five
# Six
# Seven
# Eight
# Nine
# Ten
}}
  1. One
  2. Two
  3. Three
  4. Four
  5. Five
  6. Six
  7. Seven
  8. Eight
  9. Nine
  10. Ten
{{ScrollBox| maxheight=8em | color=#234 | border-color=#456 | style=border-left:10px solid #fc6|
# One
# Two
# Three
# Four
# Five
# Six
# Seven
# Eight
# Nine
# Ten
}}
  1. One
  2. Two
  3. Three
  4. Four
  5. Five
  6. Six
  7. Seven
  8. Eight
  9. Nine
  10. Ten