Template:WarnAlt: Difference between revisions
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.", | ||
" | "example": "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.", | ||
" | "example": "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
Parameter | Description | Type | Status | |
---|---|---|---|---|
Severity and Color | severity 1 | The severity of the warning that will also determine the color of the warning.
| String | required |
Warning Box Size | size 2 | The size or type of the warning to be created.
| String | required |
Displayed Text | message 3 | The text to be displayed in the warning box.
| String | optional |
Custom Label | custom_label | A custom label to be displayed before the message. Required when ''severity'' is set to ''custom''.
| String | optional |
Custom Icon | custom_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.
| String | optional |