Template:IconBox/doc: Difference between revisions

From The Deadlock Wiki
Jump to navigation Jump to search
Vergir (talk | contribs)
Document the generic box split out of AbilityInteraction, including the data-attribute contract with Module:AbilitySection (with help from vergir-bot LLM)
 
Vergir (talk | contribs)
Update data attribute names after the iconbox- rename (with help from vergir-bot LLM)
Line 51: Line 51:
== Data attributes ==
== Data attributes ==


The box carries {{code|data-ai-icon}}, {{code|data-ai-title}}, and {{code|data-ai-state}} on its wrapper element. [[Module:AbilitySection]] reads these to build the hint icons shown beside an ability card, and to link each one to its box.
The box carries {{code|data-iconbox-icon}}, {{code|data-iconbox-title}}, and {{code|data-iconbox-state}} on its wrapper element. {{code|data-iconbox-state}} is one of {{code|normal}}, {{code|disabled}}, or {{code|partial}}.
 
[[Module:AbilitySection]] reads these to build the hint icons shown beside an ability card, and to link each one to its box.


These attributes are a contract with that module. The CSS class names are '''not''' — they are presentational and may change. Any code that needs to find these boxes should match on the data attributes.
These attributes are a contract with that module. The CSS class names are '''not''' — they are presentational and may change. Any code that needs to find these boxes should match on the data attributes.

Revision as of 14:43, 15 July 2026

Usage

{{IconBox}} displays a box with a colored header, an icon, and a body of text. It carries no meaning of its own — every part of its appearance is supplied by the caller.

For standard ability interactions, use {{AbilityInteraction}} instead. It picks the header, color, icon, and link from a registry, so a given mechanic looks the same on every page. IconBox is for one-off boxes the registry does not cover.

Parameters

A box with a colored header, an icon, and body text. Presentation is supplied entirely by the caller.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
titletitle

Text shown in the box header.

Stringrequired
texttext

Wikitext shown in the box body. May contain wikilinks, templates such as AbilityIcon, and lists.

Contentoptional
typetype

Header color: positive (green), negative (red), or info (blue).

Suggested values
positive negative info
Stringrequired
iconfileiconfile

File name of the icon image, without the File: prefix.

Example
Healing Booster.png
Stringrequired
linklink

Where the header and icon link. A bare page name (e.g. Healing Booster) or a full URL.

Example
Healing Booster
Stringrequired
statestate

Set to disabled to gray out the icon, or partial to gray out half of it.

Suggested values
disabled partial
Stringoptional

Data attributes

The box carries data-iconbox-icon, data-iconbox-title, and data-iconbox-state on its wrapper element. data-iconbox-state is one of normal, disabled, or partial.

Module:AbilitySection reads these to build the hint icons shown beside an ability card, and to link each one to its box.

These attributes are a contract with that module. The CSS class names are not — they are presentational and may change. Any code that needs to find these boxes should match on the data attributes.

Examples

{{IconBox
| type     = positive
| iconfile = Melee Charge.png
| link     = Melee Charge
| title    = Melee
| text     = This ability benefits from Melee damage bonuses.
}}
Melee

This ability benefits from Melee damage bonuses.