Template:Alert/doc: Difference between revisions

Line 8:

* <code>text</code>: Message to be displayed in the box.

* <code>icon</code>: Icon to be displayed in the box, if provided. Icons appear on the left side of the message box.

:~~: The~~ <code>~~icon~~</code> ~~parameter~~ is ~~for images. If~~ an {{w|emoji}} ~~is used~~ as an icon, <code>~~label~~</code> ~~should be used instead.~~

:* <code><nowiki>{{alert}}</nowiki></code> is designed to use an {{w|emoji}} as an icon instead of an image. We recommend passing in the icon using its {{w|HTML entity}} representation (e.g. use <code>&#x1F642;</code> for 🙂</code>).

* <code>icon size</code>~~: Size of the icon displayed. Default is 20px~~.

* <code>label</code>: A custom label to be used, if desired. This is not used by <code><nowiki>{{note}}</nowiki></code>, <code><nowiki>{{tip}}</nowiki></code>, or <code><nowiki>{{warning}}</nowiki></code> as their labels are the same as the template names.

* <code>label</code>: ~~Displays a~~ label ~~such as "warning"~~, ~~"note", or "tip"~~. This is ~~also useful if an emoji is~~ used ~~as the icon instead of an image. Use as follows:~~

:: <~~syntaxhighlight lang="wikitext"~~>

~~| label =~~ <~~span class~~{{=}}~~"alert-icon"~~>~~&#xHHHH;~~</~~span~~>~~'''Text:'''~~

~~| text =~~ {{~~{1|}~~}}

</~~syntaxhighlight~~>

~~:: where~~ <code>~~&#xHHHH;~~</code> ~~represents the hexadecimal~~ {{~~w|HTML entity~~}} ~~representation of the emoji in mind (e.g. use <code>&#x1F642;~~</~~code~~> ~~for 🙂~~</code>).

=== Types and examples ===

@@ Line 8: / Line 8: @@
 * <code>text</code>: Message to be displayed in the box.
 * <code>icon</code>: Icon to be displayed in the box, if provided. Icons appear on the left side of the message box.
-:: The <code>icon</code> parameter is for images. If an {{w|emoji}} is used as an icon, <code>label</code> should be used instead.
+:* <code><nowiki>{{alert}}</nowiki></code> is designed to use an {{w|emoji}} as an icon instead of an image. We recommend passing in the icon using its {{w|HTML entity}} representation (e.g. use <code>&amp;#x1F642;</code> for &#x1F642;</code>).
-* <code>icon size</code>: Size of the icon displayed. Default is 20px.
+* <code>label</code>: A custom label to be used, if desired. This is not used by <code><nowiki>{{note}}</nowiki></code>, <code><nowiki>{{tip}}</nowiki></code>, or <code><nowiki>{{warning}}</nowiki></code> as their labels are the same as the template names.
-* <code>label</code>: Displays a label such as "warning", "note", or "tip". This is also useful if an emoji is used as the icon instead of an image. Use as follows:
-:: <syntaxhighlight lang="wikitext">
-| label = <span class{{=}}"alert-icon">&#xHHHH;</span>'''Text:'''
-| text = {{{1|}}}
-</syntaxhighlight>
-:: where <code>&amp;#xHHHH;</code> represents the hexadecimal {{w|HTML entity}} representation of the emoji in mind (e.g. use <code>&amp;#x1F642;</code> for &#x1F642;</code>).
 === Types and examples ===