📄️ Configuration File
Depending on the file that you have added to [extramoduleurl], you will need to add your configuration in YAML or JSON format. If you used custom-sidebar-yaml.js you need to provide the configuration in YAML format. If you have used custom-sidebar-json.js you need to provide the configuration in JSON format.
📄️ Main Configuration Options
These options are intended to change the functionality of the sidebar and to change the texts, the order and the visibility of their elements among other options. Check Themeable Configuration Options if you are interested in changing the colors and the appareance of the sidebar elements.
📄️ Themeable Configuration Options
These options are only useful if you plan to change the appareance of the sidebar. If you are interested in changing the order or the visibility of the sidebar items as well as changing its functionality, check the Main Configuration Options.
📄️ The on_click property
The onclick property allows one to attach click actions to specific sidebar items. These actions will be triggered every time that the sidebar item containing an onclick property is clicked. The onclick property doesn't stop redirecting to a dashboard or to an external page if it is provided together with an href property. But if the href property is # (or it is just omitted in new items), then the onclick action will be executed without redirecting to any dashboard or external page.
📄️ Exceptions
You can define user/device-specific options using the exceptions feature. Creating an exception basically means starting a new configuration different from the main one when certian matchers match. If multiple exceptions match with the current user/device, then they are merged from top to bottom creating a new configuration and if they have an order property, it will be merged too. As well as in the main configuration, it is possible to extend from extendable configurations using the extend_from advanced configuration option. Consult the Extendable Configurations section to know how two or more configurations are merged together.
📄️ Sidebar Analytics
It is possible to log sidebar usage through Logbook entries. In this way you can analyse which users make a higher usage of the sidebar, which items are the most clicked ones, if someone entered in a dashboard even if the item in the sidebar was hidden, etc.