Template:Userbox/doc: Difference between revisions
Much more detail + fixed my stupid errors |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 51: | Line 51: | ||
"description": "Background color (or gradient) of the ID box. This uses hex colors (#fff for white, #000000 for black).", | "description": "Background color (or gradient) of the ID box. This uses hex colors (#fff for white, #000000 for black).", | ||
"example": "#8f0000", | "example": "#8f0000", | ||
"label": "ID color" | "label": "ID color", | ||
"type": "string" | |||
}, | }, | ||
"info": { | "info": { | ||
"description": "The main text content of the userbox.", | "description": "The main text content of the userbox.", | ||
"example": "This user is a moderator | "example": "This user is a moderator", | ||
"label": "Info", | "label": "Info", | ||
"required": true | "required": true | ||
| Line 62: | Line 63: | ||
"example": "#fff", | "example": "#fff", | ||
"label": "Info font color", | "label": "Info font color", | ||
"description": "Font color of the info box. This uses hex colors (#fff for white, #000000 for black)." | "description": "Font color of the info box. This uses hex colors (#fff for white, #000000 for black).", | ||
"type": "string" | |||
}, | }, | ||
"id-op": { | "id-op": { | ||
| Line 76: | Line 78: | ||
"label": "Border color", | "label": "Border color", | ||
"description": "The color of the border. This uses hex colors (#fff for white, #000000 for black)", | "description": "The color of the border. This uses hex colors (#fff for white, #000000 for black)", | ||
"example": "#6a000" | "example": "#6a000", | ||
"type": "string" | |||
}, | |||
"nocat": { | |||
"label": "No automatic categorisation", | |||
"description": "If set to true, disable automatic categorisation.", | |||
"type": "string" | |||
} | } | ||
}, | }, | ||
| Line 87: | Line 95: | ||
"id-op", | "id-op", | ||
"info-op", | "info-op", | ||
"border-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> | </templatedata> | ||
Latest revision as of 20:07, 25 November 2025
Usage
[edit source]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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| ID | id | Text or image shown on the left side of the userbox (typically short)
| Unknown | suggested |
| Info | info | The main text content of the userbox.
| Unknown | required |
| Border color | border-c | The color of the border. This uses hex colors (#fff for white, #000000 for black)
| String | optional |
| ID color | id-c | Background color (or gradient) of the ID box. This uses hex colors (#fff for white, #000000 for black).
| String | optional |
| Info font color | info-fc | Font color of the info box. This uses hex colors (#fff for white, #000000 for black).
| String | optional |
| id-op | id-op | Optional inline styles (e.g. shadows, transitions). | Unknown | optional |
| info-op | info-op | Optional inline styles (e.g. shadows, transitions). | Unknown | optional |
| border-op | border-op | Optional inline styles (e.g. shadows, transitions). | Unknown | optional |
| No automatic categorisation | nocat | If set to true, disable automatic categorisation. | String | optional |