Template:Role/doc: Difference between revisions

From Irony Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 2: Line 2:


== Parameters ==
== Parameters ==
<code><nowiki>{{role|name|color|dark-background=yes}}</nowiki></code>
<code><nowiki>{{role|name|color|gradient=|dark-background=yes}}</nowiki></code>


* <code>name</code> - The name of the role. This will be the text that will appear in the template.
* <code>name</code> - The name of the role. This will be the text that will appear in the template.
* <code>color</code> - The color of the role. Can be a hex code (you must include the #) or any other [https://developer.mozilla.org/en-US/docs/Web/CSS/color_value valid CSS color value]. If not specified, defaults to ''#c4c9ce'' (the default appearance for non-colored roles).
* <code>color</code> - The color of the role. Can be a hex code (you must include the #) or any other [https://developer.mozilla.org/en-US/docs/Web/CSS/color_value valid CSS color value]. If not specified, defaults to ''#c4c9ce'' (the default appearance for non-colored roles).
* <code>gradient=</code> - If specified, this will override <code>color</code>. Intended for roles with color gradients, this allows you to specify a series of comma-separated colors which will appear as a left-to-right gradient. For example: <code>gradient=#7129f6, #e7d57b, #7129f6</code>
* <code>dark-background=</code> - Set this to "yes" to change the background color of the template to the dark color used on Discord profiles. Otherwise, the background will remain white (or whatever color the surrounding background is).
* <code>dark-background=</code> - Set this to "yes" to change the background color of the template to the dark color used on Discord profiles. Otherwise, the background will remain white (or whatever color the surrounding background is).


Line 37: Line 38:
"description": "Set this to \"yes\" to change the background color of the template to the dark color used on Discord profiles.",
"description": "Set this to \"yes\" to change the background color of the template to the dark color used on Discord profiles.",
"example": "yes",
"example": "yes",
"type": "string"
},
"gradient": {
"label": "Color gradient",
"description": "If specified, this will override Color. Intended for roles with color gradients. Specify a series of comma-separated colors which will appear as a left-to-right gradient.",
"example": "#7129f6, #e7d57b, #7129f6",
"type": "string"
"type": "string"
}
}
Line 44: Line 51:
"1",
"1",
"2",
"2",
"gradient",
"dark-background"
"dark-background"
],
],

Latest revision as of 07:42, 6 August 2025

This template displays a role in the same style Discord does when you click on a user. Like this

Parameters

[edit source]

{{role|name|color|gradient=|dark-background=yes}}

  • name - The name of the role. This will be the text that will appear in the template.
  • color - The color of the role. Can be a hex code (you must include the #) or any other valid CSS color value. If not specified, defaults to #c4c9ce (the default appearance for non-colored roles).
  • gradient= - If specified, this will override color. Intended for roles with color gradients, this allows you to specify a series of comma-separated colors which will appear as a left-to-right gradient. For example: gradient=#7129f6, #e7d57b, #7129f6
  • dark-background= - Set this to "yes" to change the background color of the template to the dark color used on Discord profiles. Otherwise, the background will remain white (or whatever color the surrounding background is).

Example

[edit source]

{{role|Was it worth it?|#eb2d37}}

outputs:

Was it worth it?

TemplateData

[edit source]

Displays a role in the same style that Discord uses when you click on a user.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Role name1

The name of the role. This will be the text that will appear.

Example
Was it worth it?
Stringrequired
Color2

The color of the role. Can be a hex code (you must include the #, e.g. #ff7f00) or any other valid CSS color value.

Default
#c4c9ce
Stringsuggested
Color gradientgradient

If specified, this will override Color. Intended for roles with color gradients. Specify a series of comma-separated colors which will appear as a left-to-right gradient.

Example
#7129f6, #e7d57b, #7129f6
Stringoptional
Dark backgrounddark-background

Set this to "yes" to change the background color of the template to the dark color used on Discord profiles.

Example
yes
Stringoptional