elchininet
Custom Sidebar is broken in Home Assistant 2025.5.0
Update
This issue has been solved in the major version 10.0.0. Read the instructions before update. I'll let this issue open as a second filter wall for those that updated to the major version without being updated Home Assistant.
In Home Assistant 2025.5.0, the sidebar has been replaced entirely. This means that not only elements have changed their name, but also their location in the DOM tree. For this reason, the library will require an entire refactor that will potentially be a breaking change in its API.
If you want to keep using Custom Sidebar, you need to avoid updating Home Assistant to version 2025.5.0 until a new major version is released. I'll be updating about the progress in this issue.
Keep posted.
This is a bummer. Will issue #399 be the communication point for a new version release?
This is a bummer. Will issue https://github.com/elchininet/custom-sidebar/issues/399 be the communication point for a new version release?
That's right and that will be occurring in a few minutes.
@jkosharek, The communication has been made as an edit of the main issue.
My previous config items looked like this:
order:
- new_item: true
item: File Editor
href: "/hassio/ingress/core_configurator"
icon: mdi:book-edit-outline
order: 1
- new_item: true
item: HA Editor
href: "/ha-data-editor"
icon: mdi:book-edit-outline
order: 2
and from what I see in the browser dev tools that is the correct href, but none of the items are showing in the side bar.
and from what I see in the browser dev tools that is the correct href, but none of the items are showing in the side bar.
Check all the steps in the troubleshooting section and let me know your results.
Did a full HAOS Host restart and it's back to normal on HA Core v2025.5 and Custom Sidebar v10.0.0
Did a full HAOS Host restart and it's back to normal on HA Core v2025.5 and Custom Sidebar v10.0.0
Perfect, glad to know 👍
Hello, For me, this doesn’t work. Since the update (I updated side by side both HA Core to 2025.5 and custom-sidebar to 10.0), I can’t manage to reorder my sidebar. The behaviour is as if custom-sidebar is completely ineffective on the sidebar.
Here a test case configuration code (everything else is now commented in the file):
title: 'My Home'
sidebar_editable: false
hide_all: true
order:
- item: "/home-views"
match: href
hide: false
order: 1
- item: "/lovelace"
match: href
hide: false
order: 2
The first two configuration lines are effective (I can easily change my title) but everything after "hide_all" looks as unexistent.
Note: I tried te restart HA a lot of times / I refresh the cache on every test (F5) / The "href" should be correct.
@kerotonic did you do a host restart? I did several full restarts and it took the host restart to get it to work after installing HA Core to 2025.5 and custom-sidebar to 10.0.
Hello, Well, the VM on which HA runs was restarded twice since the update. The host itself was restarted once. I’ll try again.
Yeah, that would cover the reboot. In the process of trying to be mine to work I also selected to redownload in HACS and then Host rebooted.
@schuettecarsten,
On my installation,the subtitle setting is no longer applied.
Please, share more details to check why the subtitle is not applied in your case, there are several regression tests like this one in place, so it is important to know more details to check why it doesn't work for you.
And also follow the troubleshooting and post your results.
@kerotonic
For me, this doesn’t work. Since the update (I updated side by side both HA Core to 2025.5 and custom-sidebar to 10.0), I can’t manage to reorder my sidebar. The behaviour is as if custom-sidebar is completely ineffective on the sidebar.
Please, follow the troubleshooting and post your results.
On my installation,the subtitle setting is no longer applied.
Please, share more details to check why the subtitle is not applied in your case, there are several regression tests like this one in place , so it is important to know more details to check why it doesn't work for you.
And also follow the troubleshooting and post your results.
Edit: I was able to fix it by uninstalling the extension from HACS and re-install it.
After updating the extension, you also need to clean caches on Home Assistant Android app manually. That's something that needs to be improved at all, caching behaviour of HA is sometimes weird.
Edit: I was able to fix it by uninstalling the extension from HACS and re-install it.
After updating the extension, you also need to clean caches on Home Assistant Android app manually. That's something that needs to be improved at all, caching behaviour of HA is sometimes weird.
From your previous post I see that Home Assistant was loading version 9.3.0 of the plugin (which is a version from March 30th, after that one there were two more versions before the current major version). If you updated to Home Assistant 2025.5.0 it is logic that it failed trying to load a previous version.
Home Assistant has a very strong caching mechanism, this is something widely known. It is for that reason that parts of the troubleshooting section are related to instruct how to clear cache.
Glad to know that it is already solved for you 👍🏼
For me, this doesn’t work. Since the update (I updated side by side both HA Core to 2025.5 and custom-sidebar to 10.0), I can’t manage to reorder my sidebar. The behaviour is as if custom-sidebar is completely ineffective on the sidebar.
Please, follow the troubleshooting and post your results.
I could finally get it working by deleting all HA cached data in Firefox general settings.
I could finally get it working by deleting all HA cached data in Firefox general settings.
~Could you get it working on your tablet too?~
Sorry, I crossed responses. Glad that you get it working again 👍🏼
I could finally get it working by deleting all HA cached data in Firefox general settings.
Yep, this fixed it for me. Ctrl + F5 is an easy way to clear a page's cache without having to go into any settings.
Yep, this fixed it for me. Ctrl + F5 is an easy way to clear a page's cache without having to go into any settings.
I always recommend cleaning the cache or checking the "ignore cache" checkbox in the Network tab. Mainly when we are dealing with Home Assistant. CTRL + F5 doesn't clean cache but loads the page bypassing the cache. So if the cache is not cleaned entirely and it remains stored you will be hit again sooner or later.
about that cache: https://github.com/home-assistant/frontend/pull/25555 its being discussed whether that is a breaking change or a feature....
about that cache: https://github.com/home-assistant/frontend/pull/25555 its being discussed whether that is a breaking change or a feature....
That will probably break something in Custom Sidebar but it is a good thing, at the moment the beta tests are still working, let's wait to see if they break with that change. I hope that in some moment it becomes something that an admin can configure for all users, until then, I'll try to keep the feature of the order and visibility.
do you follow the #beta on Discord? it's discussed now, so might be useful to at least lurk there ;-)
about that cache: home-assistant/frontend#25555 its being discussed whether that is a breaking change or a feature....
I don't really understand the PR, wasn't the same way for sidebar organization set up until now? That the order of panels is stored in localStorage? :D So far I see only a new sidebar config dialog in the change.
I don't really understand the PR, wasn't the same way for sidebar organization set up until now? That the order of panels is stored in localStorage? :D So far I see only a new sidebar config dialog in the change.
Now the changes will be stored in your user settings instead of in the local storage of the device, so you can have the same configuration on every device and it will not get lost when you log out and log in again.
Oh, I see... so it will be similar to the browser mode integration, where it is possible to configure for different users or devices. Thanks for the explanation. 👍
at the moment the beta tests are still working, let's wait to see if they break with that change
- By default it should be possible to edit the sidebar
- If sidebar_editable is set to true it should be possible to edit the sidebar
And most probably those tests are failing because they expect an element that doesn't exist anymore and not because some functionality got broken. So, it seems that no issues so far.
Near the 60% of the installations have already updated to Home Assistant >= 2025.5.1. Closing this issue.