Template:Notify/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (→‎Inline mode: very very very very very very very very very very very very very very very very very very very very very very very very very very very minor grammar)
Line 55: Line 55:
|-
|-
| align="center" | {{Code|style=2| {{Param|color}} }}
| align="center" | {{Code|style=2| {{Param|color}} }}
| style="padding:8px" | Notification color (RGB only).<br> RGBA may also works.
| style="padding:8px" | Notification color (RGB only).<br> RGBA may also work.
| {{CodeBlock|margin = 5px|<nowiki>| color = 240,211,0</nowiki>}}
| {{CodeBlock|margin = 5px|<nowiki>| color = 240,211,0</nowiki>}}
| style="padding:8px" | {{Notify|mode = inline|size=10px|img = Important template.png|type = Important|text = Hello, World!|color = 240,211,0}}
| style="padding:8px" | {{Notify|mode = inline|size=10px|img = Important template.png|type = Important|text = Hello, World!|color = 240,211,0}}

Revision as of 11:19, 18 December 2023

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

Different types of notifications in one template. Created as a basis for other templates.

Copy and Paste

{{Notify | mode = inline | size = 10px | img = | text = | color = }}

Parameters and Examples

Shared

Parameter Description Example Preview
{{{1}}} or {{{text}}} Your text.
Icon-Important.pngImportant: Do not use {{{text}}} in other templates that are based on this template. The named parameter breaks the lists.
| Hello, World!
| text = Hello, World!
Hello, World!
Hello, World!
{{{mode}}} Switches the template modes. Avaliable modes: inline.
| mode = inline
Hello, World!

Inline mode

Parameter Description Example Preview
{{{img}}} Notification icon.
| img = Note.png
Hello, World!
{{{size}}} Notification icon size (Highly recommended to specify since most icons support high DPI.)
| size = 16px
Important template.pngImportant:Hello, World!
{{{type}}} Notification type.
| type = Warning
Important template.pngImportant:Hello, World!
{{{color}}} Notification color (RGB only).
RGBA may also work.
| color = 240,211,0
Important template.pngImportant:Hello, World!

Offset

  1. Important template.pngImportant:Hello, World!
  2. Important template.pngImportant:Hello, World!
  3. Important template.pngImportant:Hello, World!
  4. Important template.pngImportant:Hello, World!
  5. Important template.pngImportant:Hello, World!
  6. Important template.pngImportant:Hello, World!
  7. Important template.pngImportant:Hello, World!

Custom styles

  1. Important template.pngImportant:Hello, World!
  2. Important template.pngImportant:Hello, World!
  3. Important template.pngImportant:Hello, World!
  4. Important template.pngImportant:Hello, World!
  5. Important template.pngImportant:Hello, World!
  6. Important template.pngImportant:Hello, World!
  7. Important template.pngImportant:Hello, World!
  8. Important template.pngImportant:Hello, World!
  9. Important template.pngImportant:Hello, World!
  10. Important template.pngImportant:Hello, World!
  11. Important template.pngImportant:Hello, World!
  12. Important template.pngImportant:Hello, World!
  13. Important template.pngImportant:Hello, World!
  14. Important template.pngImportant:Hello, World!
  15. Important template.pngImportant:Hello, World!
  16. Important template.pngImportant:Hello, World!

Special Subpages

See Also