Bonsaibauer: 1 revision imported: Import Star Citizen Modules

2026-11-04T22:22:13Z

1 revision imported: Import Star Citizen Modules

← Older revision		Revision as of 22:22, 4 November 2026
(No difference)

starcitizen>Alistar Bot: Sync from Git (d69195e) (via update-page on MediaWiki MCP Server)

2026-09-12T00:21:06Z

Sync from Git (d69195e) (via update-page on MediaWiki MCP Server)

New page

{{documentation|git=true}}

Renders a single inline icon, either as a rasterised <code><nowiki>[[File:]]</nowiki></code> thumbnail or as a CSS mask filled with <code><nowiki>currentColor</nowiki></code> (so it recolours with the surrounding text). Optionally linked.

Required by [[Module:BadgeLua]], [[Module:Boolean]], [[Module:IconText]], [[Module:IconLink]], and [[Module:AGGridColumns]]' <code><nowiki>Kind/BadgeList</nowiki></code> and <code><nowiki>Kind/Boolean</nowiki></code>; not invoked from templates.

== For module editors ==

=== API ===

<code><nowiki>p.render(props)</nowiki></code> returns markup only, no <code><nowiki><templatestyles></nowiki></code> (see Styles below).

{| class="wikitable"
|-
! Field
! Type
! Required
! Default
! Description
|-
| <code><nowiki>icon</nowiki></code>
| <code><nowiki>string</nowiki></code>
| Yes
|
| File name (without the <code><nowiki>File:</nowiki></code> prefix).
|-
| <code><nowiki>size</nowiki></code>
| <code><nowiki>string</nowiki></code>
| No
| <code><nowiki>20px</nowiki></code>
| Mode-dependent: with <code><nowiki>mask</nowiki></code> a CSS length for width and height (<code><nowiki>1em</nowiki></code> works); otherwise a MediaWiki image size passed into <code><nowiki>[[File:…]]</nowiki></code> (<code><nowiki>x16px</nowiki></code> works, <code><nowiki>1em</nowiki></code> does not).
|-
| <code><nowiki>mask</nowiki></code>
| <code><nowiki>boolean</nowiki></code>
| No
| <code><nowiki>false</nowiki></code>
| Render as a <code><nowiki>currentColor</nowiki></code> mask instead of a thumbnail.
|-
| <code><nowiki>link</nowiki></code>
| <code><nowiki>string</nowiki></code>
| No
|
| Link target; empty/nil leaves the icon unlinked.
|-
| <code><nowiki>title</nowiki></code>
| <code><nowiki>string</nowiki></code>
| No
|
| Tooltip / caption.
|-
| <code><nowiki>class</nowiki></code>
| <code><nowiki>string</nowiki></code>
| No
|
| Extra class(es), appended after the base <code><nowiki>t-icon</nowiki></code> (+ <code><nowiki>t-icon--mask</nowiki></code> in mask mode).
|}

<code><nowiki>p.src(icon)</nowiki></code> resolves an icon file name to its plain (entity-decoded) URL, for a caller that paints its own mask client-side, e.g. an [https://www.mediawiki.org/wiki/Extension:AGGrid AG Grid] badge cell whose <code><nowiki>iconSrc</nowiki></code> is read into a CSS custom property by JavaScript rather than an HTML style attribute.

<code><nowiki>p.main(frame)</nowiki></code> is the <code><nowiki>#invoke</nowiki></code> entry point: reads named arguments (and positional <code><nowiki>1</nowiki></code> as <code><nowiki>icon</nowiki></code>; <code><nowiki>title</nowiki></code> also accepts <code><nowiki>iconTitle</nowiki></code>), emits [[Module:Icon/styles.css]], and forwards to <code><nowiki>render</nowiki></code>. <code><nowiki>mask</nowiki></code> accepts any [[Module:Yesno]] truthy value.

=== Gotchas ===

* Mask mode's <code><nowiki>mask-image</nowiki></code> fetch is constrained by the wiki's enforced CSP <code><nowiki>default-src</nowiki></code>, not by CORS: the file URL must resolve to a host that policy allows, regardless of cross-origin headers.
* The <code><nowiki>nowiki</nowiki></code> <code><nowiki>filepath</nowiki></code> parser function HTML-entity-encodes <code><nowiki>:</nowiki></code> as <code><nowiki>:</nowiki></code>; a browser decodes that inside an HTML <code><nowiki>style</nowiki></code> attribute (the server-rendered mask) but not when a script assigns it to a CSS custom property, which is why <code><nowiki>p.src</nowiki></code> decodes it back to plain text for client-side callers.
* Thumbnail mode always prepends <code><nowiki>class=metadata</nowiki></code> to the <code><nowiki>[[File:...]]</nowiki></code> markup, ahead of <code><nowiki>t-icon</nowiki></code>.

=== Styles ===

<code><nowiki>render</nowiki></code> returns markup only, no <code><nowiki><templatestyles></nowiki></code>: callers must load [[Module:Icon/styles.css]] themselves. This keeps the style tag out of any wikilink label when a caller wraps the icon in a link of its own (e.g. BadgeLua's whole-pill link). <code><nowiki>p.main</nowiki></code> (the wikitext entry point) does emit the stylesheet, since it returns a standalone value.

Module:Icon/doc - Revision history

Bonsaibauer: 1 revision imported: Import Star Citizen Modules

starcitizen>Alistar Bot: Sync from Git (d69195e) (via update-page on MediaWiki MCP Server)