stig-gradle-plugin/com.stigway.gradle.support/StigIcon

StigIcon

data class StigIcon(val semanticName: String, val spriteId: String, val unicode: String, val cssColor: String? = null)

Central STIG icon vocabulary.

Each StigIcon carries:

a stable semanticName used as data-stig-icon="..." for CSS / debugging,
a spriteId referencing a <symbol> in stig-icons.svg (vendored under dokka/assets/, generated by StigIconSpriteGenerator from pinned Iconify JSON packages and canonical STIG vector resources),
a Unicode fallback glyph for plain-text contexts (Gradle log output, console messages, DOT-label placeholders).

One source of truth. All status / role / element-kind markers in generated documentation route through this file. Do not hard-code icon literals elsewhere.

One icon database. The sprite is the only icon source — every spriteId is checked against stig-icons.svg at task-action time by StigSpriteIconValidator. The previous Material-Symbols-font system (validated against material-symbols-names.txt) has been retired; the same icons are now served from @iconify-json/material-symbols via the unified sprite (see GenerateStigIcons.kt).

Constructors

StigIcon

constructor(semanticName: String, spriteId: String, unicode: String, cssColor: String? = null)

Types

Companion

object Companion

Properties

cssColor

val cssColor: String?

Optional CSS color for status-style icons.

semanticName

val semanticName: String

Stable semantic name used in data-stig-icon="..." for CSS / debugging.

spriteId

val spriteId: String

Sprite-id referencing a <symbol> in stig-icons.svg.

unicode

val unicode: String

Unicode glyph used in plain-text contexts and as DOT-label placeholder.

Functions

toHtml

fun toHtml(): String

Emits inline HTML that references the vendored sprite via an SVG <use> element. Width/height come from the sprite's viewBox; CSS class stig-icon lets the host stylesheet size / align consistently with surrounding text.

toMarkdown

fun toMarkdown(): String

Markdown rendering — Dokka passes raw HTML through, so the inline svg works.

toString

open override fun toString(): String

Plain-text rendering (for DOT labels, log messages, CHANGELOG entries).