Template:Role/doc: Difference between revisions
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" | ||
], | ], | ||