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.
Process to follow the UI eXtension quick start guide.

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 thing keys are uix-<thing>(-yaml):.
HTML node for UI eXtension is <uix-node> and properties of the node all refer to uix.
You can use {# uix.debug #} to debug templates.
All debug console messages will start with UIX.

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 Fronted 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 button.

How do I uninstall UI eXtension?

Uninstallation of UI eXtensions 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.