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
