FAQ
How do I best migrate from Card-mod?
- Uninstall card-mod.
- If you use extra_module_url for card-mod resource, remove and restart Home Assistant.
- Proceed to follow the UI eXtension quick start guide.
Add UI eXtension as a Service
UI eXtension is an integration and needs to be added as a Service once you have downloaded by HACS. Make sure you don't miss the Add UI eXtension service step. This is something you may miss if you are not accustomed to adding integrations like UIX as a Service.
UI Lovelace Minimalist may load card-mod resource
If you have UI Lovelace Minimalist installed it may load card-mod resource. Due to load order of integrations, UI eXtension cannot check for this conflict. To continue to use UI Lovelace Minimalist with UI eXtension you need to turn off UI Lovelace Minimalist config option Include custom card resources it's depending on and load any required custom cards through HACS or manually.
Is UI eXtension a drop in replacement for Card-mod?
Yes, UI eXtension is a drop in replacement for Card-mod versions up to 4.2.1. All Card-mod card and themes configurations are supported. While you are encouraged to update to use uix: in your cards and uix-<thing>(-yaml) for your themes, it is not required.
Is UI eXtension just Card-mod with different documentation?
No, UI eXtension code has been updated so that UIX is primary domain and config key. Card-mod keys are supported but overridden by uix:.
UI eXtension differences from Card-mod
- Config key for cards is
uix:. - Theme key is
uix-theme:. - Theme
thingkeys areuix-<thing>(-yaml):. - HTML node for UI eXtension is
<uix-node>and properties of the node all refer touix. - You can use
{# uix.debug #}to debug templates. - All debug console messages will start with
UIX.
Is there a list of differences between Card-mod and UI eXtension?
Yes, see the table below.
| Feature | Card-mod | UIX |
|---|---|---|
Correctly loads ...-yaml theme variables |
❌ Since 2026.8.0 |
Yes |
Correctly handles ...-more-info(-yaml) theme variable |
❌ Since 2026.3.0 |
Yes |
Correctly patches adaptive dialogs for ...-dialog(-yaml) theme variable |
❌ Since 2026.3.0 |
Yes |
| DOM inspection helpers | No | Yes |
| Host/element path selection | No | Yes |
| Express search selector | No | Yes |
| Forge (custom lovelace element) | No | Yes |
| Foundries (reusable forges) | No | Yes |
| Macros (reusable jinja templates) | No | Yes |
| Sparks (self-contained behaviours that augment forged elements) | No | Yes |
| Frontend state throttling (optional) | No | Yes |
| Dialog Styling delay (optional) | No | Yes |
| Dashboard view backgrounds | No | Yes |
| Section backgrounds | No | Yes |
| View backgrounds | No | Yes |
| Icon styling - entity override | No | Yes |
| Styling entity images | No | Yes |
| Reload/Clear cache popup | No | Yes |
| Expansive documentation including visual examples | Limited | Yes |
| Mod-Card | Yes | Yes |
| CSS styling in themes | Yes | Yes |
| Reload/Clear cache service/action | Yes | Yes |
| Provides variables (e.g current user) | Yes | Yes |
| CSS styling | Yes | Yes |
| Resource url | Yes | N/A |
Does UI eXtension have resource URL issues?
No, being an integration, UI eXtension manages its resource URLs directly. You don't need to do anything to have UI eXtension run at peak performance. UI eXtension dynamically adds its Frontend resource, uix.js, as an extra module, as well as adding a Dashboard resource in case you use CAST. UI eXtension will add its version to these resources automatically each time the integration loads.
Does UI eXtension need manual cache clear after upgrade for Browsers and device Companion Apps?
UI eXtension will show a toast message when it detects that a reload is needed to clear caches, with a convenient Reload Now button and auto reload after 60s.
Note
While the Auto reload code is in 8.1.0, auto Reload will be available when you next update. When you install 8.1.0, device will still be running 8.0.1 code which does not have the auto reload feature.
How do I uninstall UI eXtension?
Uninstallation of UI eXtension is a two step process. First, remove the service entry in Devices & services. Next uninstall the integration either using HACS or manually removing the uix folder from custom_components directory if you installed manually.