Jump to content

Template:Userbox/doc: Difference between revisions

From Consumer Rights Wiki
I think that the <noinclude> tags were accidental.
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 39: Line 39:


[[Category:Userbox templates]]
[[Category:Userbox templates]]
<templatedata>
{
"params": {
"id": {
"description": "Text or image shown on the left side of the userbox (typically short)",
"example": "MOD",
"label": "ID",
"suggested": true
},
"id-c": {
"description": "Background color (or gradient) of the ID box. This uses hex colors (#fff for white, #000000 for black).",
"example": "#8f0000",
"label": "ID color",
"type": "string"
},
"info": {
"description": "The main text content of the userbox.",
"example": "This user is a moderator",
"label": "Info",
"required": true
},
"info-fc": {
"example": "#fff",
"label": "Info font color",
"description": "Font color of the info box. This uses hex colors (#fff for white, #000000 for black).",
"type": "string"
},
"id-op": {
"description": "Optional inline styles (e.g. shadows, transitions)."
},
"info-op": {
"description": "Optional inline styles (e.g. shadows, transitions)."
},
"border-op": {
"description": "Optional inline styles (e.g. shadows, transitions)."
},
"border-c": {
"label": "Border color",
"description": "The color of the border. This uses hex colors (#fff for white, #000000 for black)",
"example": "#6a000",
"type": "string"
},
"nocat": {
"label": "No automatic categorisation",
"description": "If set to true, disable automatic categorisation.",
"type": "string"
}
},
"paramOrder": [
"id",
"info",
"border-c",
"id-c",
"info-fc",
"id-op",
"info-op",
"border-op",
"nocat"
],
"description": "Create a custom userbox to add to your profile, which can do multiple things, including tell others about yourself and show others the achievements you have made."
}
</templatedata>

Latest revision as of 20:07, 25 November 2025

This template displays a customizable userbox using Module:Userbox.

To use it, call the template with the appropriate parameters. All parameters are optional unless otherwise noted.

Basic Example

[edit source]
{{#invoke:userbox|userbox
 | id        = '''MOD'''
 | id-c      = linear-gradient(to bottom, #8f0000, #5a0000)
 | id-fc     = #fff
 | info      = This user is a '''moderator''' and may be ''data-mining your contributions'', btw.
 | info-c    = linear-gradient(to bottom, #8f0000, #5a0000)
 | info-fc   = #fff
 | border-c  = #6a0000
}}

Parameters

[edit source]
id
Text or image shown on the left side of the userbox (typically short)
id-c
Background color (or gradient) of the ID box
id-fc
Font color of the ID box
info
Main text content of the userbox
info-c
Background color (or gradient) of the info box
info-fc
Font color of the info box
border-c
Border color of the userbox
id-op, info-op, border-op
Optional inline styles (e.g. shadows, transitions)
nocat
If set to true, disables automatic categorization

Advanced Styling

[edit source]

You can apply CSS gradients, shadows, and more advanced styles using the -op parameters. For example:

| info-op = box-shadow: inset 0 0 8px rgba(255, 255, 255, 0.2);

See also

[edit source]

Create a custom userbox to add to your profile, which can do multiple things, including tell others about yourself and show others the achievements you have made.

Template parameters

ParameterDescriptionTypeStatus
IDid

Text or image shown on the left side of the userbox (typically short)

Example
MOD
Unknownsuggested
Infoinfo

The main text content of the userbox.

Example
This user is a moderator
Unknownrequired
Border colorborder-c

The color of the border. This uses hex colors (#fff for white, #000000 for black)

Example
#6a000
Stringoptional
ID colorid-c

Background color (or gradient) of the ID box. This uses hex colors (#fff for white, #000000 for black).

Example
#8f0000
Stringoptional
Info font colorinfo-fc

Font color of the info box. This uses hex colors (#fff for white, #000000 for black).

Example
#fff
Stringoptional
id-opid-op

Optional inline styles (e.g. shadows, transitions).

Unknownoptional
info-opinfo-op

Optional inline styles (e.g. shadows, transitions).

Unknownoptional
border-opborder-op

Optional inline styles (e.g. shadows, transitions).

Unknownoptional
No automatic categorisationnocat

If set to true, disable automatic categorisation.

Stringoptional