Template:ScrollBox: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(ScrollBoxes are a good idea in theory but nobody seems to conform to this template's standards. Even using relative measurements like "em" is not a sure fire thing. Nested scrollboxes are nasty on nearly any device, and completely break page "printing")
(Wow, should of fixed this template. Docs are being made.)
Line 1: Line 1:
<noinclude>
{{lang|Template:Scrollbox}}<!--
Use this to rein in the KV, I and O lists on entity pages.
--><onlyinclude><includeonly><!-- {{Lang}} causes mysterious line break due to ParserExtensions, but apparently this prevents indenting using :{{ExpandBox|...}}. Sigh -->


{{tip|If you've got a short ScrollBox containing a long one, set <code>noscroll<nowiki>=</nowiki>true</code> on the shorter of the pair to avoid having two scrollbars right next to each other.}}
<!--
 
  ++ HEADER ++
{{tip|If the scrollbar on your ScrollBox starts to get lost, set <code>bottom-border<nowiki>=</nowiki>true</code> to add a faint rule after it.}}
-->
 
{{#if:{{{title|}}} | <p style="font-style:italic;border-bottom:1px solid #3A3937;">{{{title}}}&#58;</p> }}
[[Category:Layout Container]]
<!--
</noinclude>{{#if:{{{title|}}} | <p style="font-style:italic;border-bottom:1px solid #3A3937;">{{{title}}}&#58;</p> }}
  ++ BOX CONTENTS ++
<div class="scrollbox" style="{{#if:{{{bottom-border|}}} | border-bottom:1px solid #3A3937;}}{{#if:{{{noscroll|}}} | | max-height:100%;}}overflow:auto;">{{{1}}}</div>
-->
<div style="overflow:auto;max-height:30em;
{{#if:{{{bottom-border|}}} | border-bottom:1px solid #3A3937;}}
{{#if:{{{noscroll|}}} | max-height:100%; |
  <!-- Since {{{noscroll|}}} isn't used, lets set if we should set the max-height.-->
  <!-- Since {{{noscroll|}}} isn't used, lets set the max-height.-->
  {{#if:{{{maxheight|}}} | max-height:{{{maxheight|}}};}}
}}
">{{{1}}}</div></includeonly></onlyinclude>
{{documentation}}
<!-- Add categories to the /doc subpage, not here -->

Revision as of 07:34, 31 October 2021

English (en)Deutsch (de)Esperanto (eo)Español (es)Français (fr)Suomi (fi)Hrvatski (hr)Magyar (hu)Italiano (it)日本語 (ja)한국어 (ko)Nederlands (nl)Polski (pl)Português (pt)Português do Brasil (pt-br)Русский (ru)Slovenčina (sk)Svenska (sv)Türkçe (tr)Українська (uk)Tiếng Việt (vi)中文 (zh)中文(臺灣) (zh-tw)
Curly brackets white.pngTemplate Documentation [view] [edit]
Icon-translate.png Available doc translations
View
Page history

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}}} – The text inside the ScrollBox.
  • {{{title}}} – The title above the scroll box. Leave empty for no title.
  • {{{bottom-border}}} – If set to a non-empty value, then a short, thin line will be present at the bottom. Use if the scrollbar becomes unreliable from long lists.
  • {{{noscroll}}} – If set to a non-zero value, scrolling is disabled. 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|bottom-border=1|noscroll=0|
# 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