Adapted from the canonical English UIX documentation by Lint-Free-Technology/uix, CC BY 4.0. Source:
dev/ 9.0.0-beta.2, revision 26e54e6, reviewed 22 October 2026. This source mirror may describe preview behavior beyond stable 8.4.0. Markup adapted for this site; the original documentation remains authoritative.
Sparks â
Sparks are optional behaviours added to a UIX Forge forged element via the forge.sparks list. Each spark has a type key and its own configuration options.
Available sparks:
- đŹ Tooltip â attach a styled tooltip to any element within the forged element.
- :material-button-cursor: Button â insert an interactive
ha-buttonelement as a sibling after any element within the forged element. - :material-badge-account-horizontal-outline: Badge â insert a Web Awesome-styled
uix-badgeas a sibling before or after any element within the forged element. - đ·ïž Attribute â add, replace or remove an attribute of any element within the forged element.
- ⥠Event â receive DOM events from
fire-dom-eventactions and expose their data as template variables. - â Tile Icon â insert a
ha-tile-iconelement as a sibling before or after any element within the forged element. - đĄïž State Badge â insert a
state-badgeelement as a sibling before or after any element within the forged element. - :material-grid: Grid â apply CSS Grid layout to any container element within the forged element.
- đ Search â find elements within a container by CSS selector and optional text filter, then apply class, attribute, or text mutations to all matches.
- :material-map: Map â preserve the zoom level and centre of a map card across Home Assistant state updates.
- :material-lock: Lock â overlay a lock icon on any element to block interaction until the user passes a PIN, passphrase, or confirmation challenge.
- :material-information-outline: More-info â embed Home Assistant more-info content for an entity inside a forged element.
- :material-form-select: Form â add a Home Assistant form and optional submit and clear actions to a forged element.
- :material-star-four-points-outline: Overlay Icon â overlay a
ha-icon/ha-state-iconon any element inside the forged element. - :material-image-outline: Background â inject a background layer (colour, image, video, or live camera) behind any element within the forged element.
- :material-palette: Theme â apply a Frontend theme to the forged element or one of its descendants.