Skip to content

Releases: elchininet/custom-sidebar

v6.1.4

24 Oct 00:26
Compare
Choose a tag to compare

🧩 Dependencies

v6.1.3

22 Oct 09:56
Compare
Choose a tag to compare

🛠 Fixes

v6.1.2

21 Oct 21:24
Compare
Choose a tag to compare

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

📝 Documentation

v6.1.1

21 Oct 08:19
Compare
Choose a tag to compare

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

v6.1.0

20 Oct 20:40
Compare
Choose a tag to compare

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

🧩 Dependencies

  • [Dependencies]: Bump the dependencies-dev group with 5 updates

📝 Documentation

v6.0.0

19 Oct 15:26
Compare
Choose a tag to compare

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

📝 Documentation

  • Big refactor of the plugin and new options addition
  • New options sidebar_background and menu_background

v5.2.1

15 Oct 22:14
Compare
Choose a tag to compare

🛠 Fixes

📦 Other

  • Small refactorings of the configuration merging logic

v5.2.0

14 Oct 00:08
Compare
Choose a tag to compare

🚀 Features

🧩 Dependencies

  • [Dependencies]: Bump the dependencies-dev group with 5 updates
  • [Dependencies]: Bump the dependencies-dev group with 7 updates
  • [Dependencies]: Bump the dependencies-dev group with 4 updates
  • [Dependencies]: Bump the dependencies-dev group with 5 updates

⚙️ Configuration

  • Update Home Assistant Docker image to version 2024.10.2

📝 Documentation

📦 Other

v5.1.0

20 Sep 21:50
Compare
Choose a tag to compare

🧩 Dependencies

  • [Dependencies]: Bump the dependencies-dev group with 5 updates

📝 Documentation

  • Add Webpage dashboard feature to the documentation

📦 Other

v5.0.2

11 Sep 20:43
Compare
Choose a tag to compare

⚠️⚠️⚠️ [BREAKING CHANGE] READ BEFORE UPDATE ⚠️⚠️⚠️

This version is a major update of the library and it brings several changes and improvements:

  1. base_order option in exceptions has been renamed to extend_from_base. If it is trueit will merge order from base with the order from the exception, for the rest of properties it will take the propery from the base if it is not available in the exception.
  2. Now it is possible to set more options in exceptions apart from order:
    • title
    • sidebar_editable
    • styles

    If extend_from_base is true and any of these options are not set, it will try to get them from the base config.

  3. order in exceptions is not mandatory anymore.
  4. sidebar_editable apart from a boolean now accepts a string with a JavaScript or a Jinja template. The template should return true or false, otherwise it will be ignored.
  5. When sidebar_editable is false it will also avoid showing the glow circle around the mouse when one press and hold over the title
  6. Now you can use some client side variables inside Jinja templates (they were available in JavaScript templates but not in Jinja ones):
    • user_name: String with the logged user's name
    • user_is_admin: Bolean value than indicates if the logged user is admin or not
    • user_is_owner: Bolean value than indicates if the logged user is the owner or not
    • user_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