Template:Badge/doc: Difference between revisions

Content deleted Content added

Inline

Latest revision as of 06:25, 3 July 2024

This is a documentation subpage for 'Template:Badge'.

It contains usage information, categories, and other content that is not part of the original template page.

This template is used to style text as a badge.

{{Badge|Lando's favourite ship}} gives Lando's favourite ship

{{Badge|Lando's favourite ship|color=#666}} gives Lando's favourite ship

{{Badge|Lando's favourite ship|bg=#d0817d}} gives Lando's favourite ship

{{Badge|Lando's favourite ship|bg=#d0817d|color=#222}} gives Lando's favourite ship

Style text as a badge

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Text	`1`	Text in the badge	String	required
Background color	`bg`	Background color of the badge (HEX/RGB(A)/HSL(A))	String	optional
Color	`color`	Color of the text on the badge Example #000	String	optional
HTML class	`class`	Additional HTML class	String	optional

@@ Line 2: / Line 2: @@
 This template is used to style text as a badge.
+==Usage==
+<code><nowiki>{{Badge|Lando's favourite ship}}</nowiki></code> gives {{Badge|Lando's favourite ship}}
+<code><nowiki>{{Badge|Lando's favourite ship|color=#666}}</nowiki></code> gives {{Badge|Lando's favourite ship|color=#666}}
+<code><nowiki>{{Badge|Lando's favourite ship|bg=#d0817d}}</nowiki></code> gives {{Badge|Lando's favourite ship|bg=#d0817d}}
+<code><nowiki>{{Badge|Lando's favourite ship|bg=#d0817d|color=#222}}</nowiki></code> gives {{Badge|Lando's favourite ship|bg=#d0817d|color=#222}}
 ==TemplateData==
@@ Line 23: / Line 32: @@
 			"type": "string"
 		},
-		"inverted": {
+		"color": {
-			"label": "Invert color",
+			"label": "Color",
-			"description": "Dark text and light background color",
+			"description": "Color of the text on the badge",
-			"example": "true",
+			"example": "#000",
-			"type": "boolean",
+			"type": "string"
-			"default": "false"
 		}
 	},
@@ Line 35: / Line 43: @@
 		"1",
 		"bg",
-		"inverted",
+		"color",
 		"class"
 	],