Releases: elchininet/custom-sidebar
v6.1.4
🧩 Dependencies
- Update home-assistant-javascript-templates
- PR: #179 by @elchininet
v6.1.3
🛠 Fixes
- Fix issues
- PR: #177 by @elchininet
v6.1.2
v6.1.2
Fix styles in Safari browsers
v6.1.1
Fix an issue with number values
v6.0.1
New options in the main configuration
Property | Type | Required | Description |
---|---|---|---|
selection_opacity* | Number or String | no | Sets the opacity of the selected item background. If it is not specified, the default 0.12 will be used |
notification_text_color* | String | no | Sets the color of the sidebar notifications texts |
divider_color* | String | no | Sets the color of the sidebar dividers |
* These options allow JavaScript or Jinja templates.
New options in the order items properties
Property | Type | Required | Description |
---|---|---|---|
selection_opacity* | Number or String | no | Sets the opacity of the selected item background. If it is not specified, the default 0.12 will be used |
notification_text_color* | String | no | Sets the color of the sidebar notifications texts |
* These item properties allow JavaScript or Jinja templates.
v6.0.0
This release refactors in a great level the config-merging-logic of the library and it is a version with tons of new options. It should not break most of the actual configurations but as it is a big change it is safer to release it as a major release.
Most important changes
Main order option is not mandatory anymore
Previously, if a configuration was missing the order
option, or it had no items inside, a validation error was triggered. But the library has a huge amount of options at the moment, it is possible that someone wants to use some of these options without changing the order or the visibility of the sidebar items or without adding new ones. For this reason, the order
option is not mandatory anymore.
New options
New options in the main configuration
Note: these options are available also in the exceptions.
Property | Type | Required | Description |
---|---|---|---|
title_color* | String | no | Sets the color of the sidebar title |
sidebar_color* | String | no | Sets the color of the sidebar |
sidebar_button_color* | String | no | Sets the color of the sidebar hamburger menu |
icon_color* | String | no | Sets the color of the sidebar icons |
icon_color_selected* | String | no | Sets the icon color of the selected sidebar item |
text_color* | String | no | Sets the text color of the sidebar items |
text_color_selected* | String | no | Sets the text color of the selected sidebar item |
selection_color* | String | no | Sets the color of the selected item background. If it is not specified, the icon_color_selected will be used |
info_color* | String | no | Sets the color of the info texts of the sidebar items |
info_color_selected* | String | no | Sets the color of the info text of the selected sidebar item |
notification_color* | String | no | Sets the color of the sidebar notifications |
* These options allow JavaScript or Jinja templates.
New options in the order items properties
Property | Type | Required | Description |
---|---|---|---|
info* | String | no | Sets the content of the info text (a smaller secondary text below the main item text) |
icon_color* | String | no | Sets the color of the icon (it overrides the global icon_color ) |
icon_color_selected* | String | no | Sets the icon color of the item when it is selected (it overrides the global icon_color_selected ) |
text_color* | String | no | Sets the text color of the item (it overrides the global text_color ) |
text_color_selected* | String | no | Sets the text color of the item when it is selected (it overrides the global text_color_selected ) |
selection_color* | String | no | Sets the color of the item background when it is selected. If it is not specified, the icon_color_selected will be used (it overrides the global selection_color ) |
info_color* | String | no | Sets the color of the info text (it overrides the global info_color ) |
info_color_selected* | String | no | Sets the color of the info text when the item is selected (it overrides the global info_color_selected ) |
notification_color* | String | no | Sets the notification color (it overrides the global notification_color ) |
* These item properties allow JavaScript or Jinja templates.
Global color options will target the settings and account items
As the settings and the account items are outside the sidebar items layout, they cannot be hidden or modified by this plugin. But from now on, the color options set in the main configuration will affect also these items. For example, if you choose a color for the icons or the item texts, it will also affect these items to avoid having a discordant items with the rest of the sidebar.
🛠 Fixes
- Fix styles in Safari
- PR: #176 by @elchininet
📝 Documentation
- Fix styles in Safari
- PR: #176 by @elchininet
v6.1.1
v6.1.1
Fix an issue with number values
v6.0.1
New options in the main configuration
Property | Type | Required | Description |
---|---|---|---|
selection_opacity* | Number or String | no | Sets the opacity of the selected item background. If it is not specified, the default 0.12 will be used |
notification_text_color* | String | no | Sets the color of the sidebar notifications texts |
divider_color* | String | no | Sets the color of the sidebar dividers |
* These options allow JavaScript or Jinja templates.
New options in the order items properties
Property | Type | Required | Description |
---|---|---|---|
selection_opacity* | Number or String | no | Sets the opacity of the selected item background. If it is not specified, the default 0.12 will be used |
notification_text_color* | String | no | Sets the color of the sidebar notifications texts |
* These item properties allow JavaScript or Jinja templates.
v6.0.0
This release refactors in a great level the config-merging-logic of the library and it is a version with tons of new options. It should not break most of the actual configurations but as it is a big change it is safer to release it as a major release.
Most important changes
Main order option is not mandatory anymore
Previously, if a configuration was missing the order
option, or it had no items inside, a validation error was triggered. But the library has a huge amount of options at the moment, it is possible that someone wants to use some of these options without changing the order or the visibility of the sidebar items or without adding new ones. For this reason, the order
option is not mandatory anymore.
New options
New options in the main configuration
Note: these options are available also in the exceptions.
Property | Type | Required | Description |
---|---|---|---|
title_color* | String | no | Sets the color of the sidebar title |
sidebar_color* | String | no | Sets the color of the sidebar |
sidebar_button_color* | String | no | Sets the color of the sidebar hamburger menu |
icon_color* | String | no | Sets the color of the sidebar icons |
icon_color_selected* | String | no | Sets the icon color of the selected sidebar item |
text_color* | String | no | Sets the text color of the sidebar items |
text_color_selected* | String | no | Sets the text color of the selected sidebar item |
selection_color* | String | no | Sets the color of the selected item background. If it is not specified, the icon_color_selected will be used |
info_color* | String | no | Sets the color of the info texts of the sidebar items |
info_color_selected* | String | no | Sets the color of the info text of the selected sidebar item |
notification_color* | String | no | Sets the color of the sidebar notifications |
* These options allow JavaScript or Jinja templates.
New options in the order items properties
Property | Type | Required | Description |
---|---|---|---|
info* | String | no | Sets the content of the info text (a smaller secondary text below the main item text) |
icon_color* | String | no | Sets the color of the icon (it overrides the global icon_color ) |
icon_color_selected* | String | no | Sets the icon color of the item when it is selected (it overrides the global icon_color_selected ) |
text_color* | String | no | Sets the text color of the item (it overrides the global text_color ) |
text_color_selected* | String | no | Sets the text color of the item when it is selected (it overrides the global text_color_selected ) |
selection_color* | String | no | Sets the color of the item background when it is selected. If it is not specified, the icon_color_selected will be used (it overrides the global selection_color ) |
info_color* | String | no | Sets the color of the info text (it overrides the global info_color ) |
info_color_selected* | String | no | Sets the color of the info text when the item is selected (it overrides the global info_color_selected ) |
notification_color* | String | no | Sets the notification color (it overrides the global notification_color ) |
* These item properties allow JavaScript or Jinja templates.
Global color options will target the settings and account items
As the settings and the account items are outside the sidebar items layout, they cannot be hidden or modified by this plugin. But from now on, the color options set in the main configuration will affect also these items. For example, if you choose a color for the icons or the item texts, it will also affect these items to avoid having a discordant items with the rest of the sidebar.
🛠 Fixes
- Fix a value as a number
- PR: #174 by @elchininet
v6.1.0
v6.0.0
This release refactors in a great level the config-merging-logic of the library and it is a version with tons of new options. It should not break most of the actual configurations but as it is a big change it is safer to release it as a major release.
Most important changes
Main order option is not mandatory anymore
Previously, if a configuration was missing the order
option, or it had no items inside, a validation error was triggered. But the library has a huge amount of options at the moment, it is possible that someone wants to use some of these options without changing the order or the visibility of the sidebar items or without adding new ones. For this reason, the order
option is not mandatory anymore.
New options
New options in the main configuration
Note: these options are available also in the exceptions.
Property | Type | Required | Description |
---|---|---|---|
title_color* | String | no | Sets the color of the sidebar title |
sidebar_color* | String | no | Sets the color of the sidebar |
sidebar_button_color* | String | no | Sets the color of the sidebar hamburger menu |
icon_color* | String | no | Sets the color of the sidebar icons |
icon_color_selected* | String | no | Sets the icon color of the selected sidebar item |
text_color* | String | no | Sets the text color of the sidebar items |
text_color_selected* | String | no | Sets the text color of the selected sidebar item |
selection_color* | String | no | Sets the color of the selected item background. If it is not specified, the icon_color_selected will be used |
info_color* | String | no | Sets the color of the info texts of the sidebar items |
info_color_selected* | String | no | Sets the color of the info text of the selected sidebar item |
notification_color* | String | no | Sets the color of the sidebar notifications |
* These options allow JavaScript or Jinja templates.
New options in the order items properties
Property | Type | Required | Description |
---|---|---|---|
info* | String | no | Sets the content of the info text (a smaller secondary text below the main item text) |
icon_color* | String | no | Sets the color of the icon (it overrides the global icon_color ) |
icon_color_selected* | String | no | Sets the icon color of the item when it is selected (it overrides the global icon_color_selected ) |
text_color* | String | no | Sets the text color of the item (it overrides the global text_color ) |
text_color_selected* | String | no | Sets the text color of the item when it is selected (it overrides the global text_color_selected ) |
selection_color* | String | no | Sets the color of the item background when it is selected. If it is not specified, the icon_color_selected will be used (it overrides the global selection_color ) |
info_color* | String | no | Sets the color of the info text (it overrides the global info_color ) |
info_color_selected* | String | no | Sets the color of the info text when the item is selected (it overrides the global info_color_selected ) |
notification_color* | String | no | Sets the notification color (it overrides the global notification_color ) |
* These item properties allow JavaScript or Jinja templates.
Global color options will target the settings and account items
As the settings and the account items are outside the sidebar items layout, they cannot be hidden or modified by this plugin. But from now on, the color options set in the main configuration will affect also these items. For example, if you choose a color for the icons or the item texts, it will also affect these items to avoid having a discordant items with the rest of the sidebar.
v6.0.1
New options in the main configuration
Property | Type | Required | Description |
---|---|---|---|
selection_opacity* | Number or String | no | Sets the opacity of the selected item background. If it is not specified, the default 0.12 will be used |
notification_text_color* | String | no | Sets the color of the sidebar notifications texts |
divider_color* | String | no | Sets the color of the sidebar dividers |
* These options allow JavaScript or Jinja templates.
New options in the order items properties
Property | Type | Required | Description |
---|---|---|---|
selection_opacity* | Number or String | no | Sets the opacity of the selected item background. If it is not specified, the default 0.12 will be used |
notification_text_color* | String | no | Sets the color of the sidebar notifications texts |
* These item properties allow JavaScript or Jinja templates.
🚀 Features
- Add new configuration options
- PR: #172 by @elchininet
- Add a notification_text_color option
- PR: #173 by @elchininet
🧩 Dependencies
- [Dependencies]: Bump the dependencies-dev group with 5 updates
- PR: #171 by @dependabot[bot]
📝 Documentation
- Add a section of extras to the documentation
- PR: #170 by @elchininet
- Add new configuration options
- PR: #172 by @elchininet
- Add a notification_text_color option
- PR: #173 by @elchininet
v6.0.0
This release refactors in a great level the config-merging-logic of the library and it is a version with tons of new options. It should not break most of the actual configurations but as it is a big change it is safer to release it as a major release.
Most important changes
Main order option is not mandatory anymore
Previously, if a configuration was missing the order
option, or it had no items inside, a validation error was triggered. But the library has a huge amount of options at the moment, it is possible that someone wants to use some of these options without changing the order or the visibility of the sidebar items or without adding new ones. For this reason, the order
option is not mandatory anymore.
New options
New options in the main configuration
Note: these options are available also in the exceptions.
Property | Type | Required | Description |
---|---|---|---|
title_color* | String | no | Sets the color of the sidebar title |
sidebar_color* | String | no | Sets the color of the sidebar |
sidebar_button_color* | String | no | Sets the color of the sidebar hamburger menu |
icon_color* | String | no | Sets the color of the sidebar icons |
icon_color_selected* | String | no | Sets the icon color of the selected sidebar item |
text_color* | String | no | Sets the text color of the sidebar items |
text_color_selected* | String | no | Sets the text color of the selected sidebar item |
selection_color* | String | no | Sets the color of the selected item background. If it is not specified, the icon_color_selected will be used(this color has an opacity of 0.12) |
info_color* | String | no | Sets the color of the info texts of the sidebar items |
info_color_selected* | String | no | Sets the color of the info text of the selected sidebar item |
notification_color* | String | no | Sets the color of the sidebar notifications |
New options in the order items properties
Property | Type | Required | Description |
---|---|---|---|
info* | String | no | Sets the content of the info text (a smaller secondary text below the main item text) |
icon_color* | String | no | Sets the color of the icon (it overrides the global icon_color ) |
icon_color_selected* | String | no | Sets the icon color of the item when it is selected (it overrides the global icon_color_selected ) |
text_color* | String | no | Sets the text color of the item (it overrides the global text_color ) |
text_color_selected* | String | no | Sets the text color of the item when it is selected (it overrides the global text_color_selected ) |
selection_color* | String | no | Sets the color of the item background when it is selected If it is not specified, the icon_color_selected will be used(this color has an opacity of 0.12 and it overrides the global selection_color ) |
info_color* | String | no | Sets the color of the info text (it overrides the global info_color ) |
info_color_selected* | String | no | Sets the color of the info text when the item is selected (it overrides the global info_color_selected ) |
notification_color* | String | no | Sets the notification color (it overrides the global notification_color ) |
* These item properties allow JavaScript or Jinja templates.
Global color options will target the settings and account items
As the settings and the account items are outside the sidebar items layout, they cannot be hidden or modified by this plugin. But from now on, the color options set in the main configuration will affect also these items. For example, if you choose a color for the icons or the item texts, it will also affect these items to avoid having a discordant items with the rest of the sidebar.
🚀 Features
- Big refactor of the plugin and new options addition
- PR: #167 by @elchininet
- Make order property not mandatory
- PR: #168 by @elchininet
- New options sidebar_background and menu_background
- PR: #169 by @elchininet
📝 Documentation
- Big refactor of the plugin and new options addition
- PR: #167 by @elchininet
- New options sidebar_background and menu_background
- PR: #169 by @elchininet
v5.2.1
🛠 Fixes
- Fix collapsed notification styles
- PR: #166 by @elchininet
📦 Other
- Small refactorings of the configuration merging logic
- PR: #165 by @elchininet
v5.2.0
🚀 Features
- Implement a sidebar_mode option
- PR: #160 by @elchininet
🧩 Dependencies
- [Dependencies]: Bump the dependencies-dev group with 5 updates
- PR: #148 by @dependabot[bot]
- [Dependencies]: Bump the dependencies-dev group with 7 updates
- PR: #152 by @dependabot[bot]
- [Dependencies]: Bump the dependencies-dev group with 4 updates
- PR: #154 by @dependabot[bot]
- [Dependencies]: Bump the dependencies-dev group with 5 updates
- PR: #159 by @dependabot[bot]
⚙️ Configuration
- Update Home Assistant Docker image to version 2024.10.2
- PR: #162 by @elchininet
📝 Documentation
- Add styles example
- PR: #149 by @elchininet
- Change documentation to reflect that the plugin is available in HACS default
- PR: #153 by @elchininet
- Implement a sidebar_mode option
- PR: #160 by @elchininet
- Add missing sidebar_mode option to exceptions
- PR: #161 by @elchininet
📦 Other
- Improve configuration examples
- PR: #151 by @elchininet
- Improve tests descriptions
- PR: #158 by @elchininet
v5.1.0
🧩 Dependencies
- [Dependencies]: Bump the dependencies-dev group with 5 updates
- PR: #144 by @dependabot[bot]
📝 Documentation
- Add Webpage dashboard feature to the documentation
- PR: #147 by @elchininet
📦 Other
- Update home-assistant-javascript-templates
- PR: #146 by @elchininet
v5.0.2
⚠️ ⚠️ ⚠️ [BREAKING CHANGE] READ BEFORE UPDATE ⚠️ ⚠️ ⚠️
This version is a major update of the library and it brings several changes and improvements:
base_order
option inexceptions
has been renamed toextend_from_base
. If it istrue
it will mergeorder
from base with theorder
from theexception
, for the rest of properties it will take the propery from the base if it is not available in theexception
.- Now it is possible to set more options in
exceptions
apart fromorder
:title
sidebar_editable
styles
If
extend_from_base
istrue
and any of these options are not set, it will try to get them from the base config. order
inexceptions
is not mandatory anymore.sidebar_editable
apart from aboolean
now accepts a string with aJavaScript
or aJinja
template. The template should returntrue
orfalse
, otherwise it will be ignored.- When
sidebar_editable
isfalse
it will also avoid showing the glow circle around the mouse when one press and hold over the title - Now you can use some client side variables inside
Jinja
templates (they were available inJavaScript
templates but not inJinja
ones):user_name
: String with the logged user's nameuser_is_admin
: Bolean value than indicates if the logged user is admin or notuser_is_owner
: Bolean value than indicates if the logged user is the owner or notuser_agent
: User agent of the browser in which Home Assistant is being executed
📦 Other
- Manage the blocking of the sidebar title events with the sidebar CSSs
- PR: #142 by @elchininet