Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Big refactor of the plugin and new options addition #167

Merged
merged 9 commits into from
Oct 19, 2024

Conversation

elchininet
Copy link
Owner

@elchininet elchininet commented Oct 19, 2024

This pull request refactors a big part of the plugin and adds several new options.

New configuration options

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

* These options allow JavaScript or Jinja templates.

New 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.

New exceptions options

You can define user-specific options using exceptions feature. Exceptions can be used if you would like to define different options for a specific user/device.

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

* These options and item properties allow JavaScript or Jinja templates.

@elchininet elchininet added documentation Improvements or additions to documentation enhancement New feature or request feature-request refactor labels Oct 19, 2024
@coveralls
Copy link

Coverage Status

coverage: 99.765% (-0.006%) from 99.771%
when pulling 9e5ce20 on add_new_options
into fcada91 on master.

@elchininet elchininet merged commit 6f958fb into master Oct 19, 2024
4 checks passed
@elchininet elchininet deleted the add_new_options branch October 19, 2024 02:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request feature-request refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants