Template:WarnAlt: Difference between revisions

From Caps Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 75: Line 75:
"label": "Severity and Color",
"label": "Severity and Color",
"description": "The severity of the warning that will also determine the color of the warning.",
"description": "The severity of the warning that will also determine the color of the warning.",
             "suggestedvalues": [
             "example": "danger, warning, caution, note, custom",
      "danger",
              "warning",
      "caution",
      "note",
      "custom"
        ],
"type": "string",
"type": "string",
"required": true,
"required": true,
Line 89: Line 83:
"label": "Warning Box Size",
"label": "Warning Box Size",
"description": "The size or type of the warning to be created.",
"description": "The size or type of the warning to be created.",
             "suggestedvalues": [
             "example": "large, medium, small",
      "large",
              "medium",
      "small"
        ],
"type": "string",
"type": "string",
"required": true,
"required": true,

Revision as of 21:22, 17 February 2022

Error: The severity and size arguments are required.

Create a warning box to get the users attention

[Edit template data]

Template parameters

ParameterDescriptionTypeStatus
Severity and Colorseverity 1

The severity of the warning that will also determine the color of the warning.

Example
danger, warning, caution, note, custom
Stringrequired
Warning Box Sizesize 2

The size or type of the warning to be created.

Example
large, medium, small
Stringrequired
Displayed Textmessage 3

The text to be displayed in the warning box.

Example
Caps may retain charge after poweroff
Stringoptional
Custom Labelcustom_label

A custom label to be displayed before the message. Required when ''severity'' is set to ''custom''.

Example
ACHTUNG
Stringoptional
Custom Iconcustom_icon

An image file to be displayed as an icon before the label. Required when ''severity'' is set to ''custom''. Do not include ''File:''. Since the custom option displays in a blue theme, blue-colored icons are suggested.

Example
OOjs UI icon laptop-progressive.svg
Stringoptional