Is it possible to link to a plugin's settings from a navbar icon?

benlye · November 27, 2020, 12:02pm

Is it possible to have a direct link to my plugin's settings from an icon in the nav bar?

I know how to add the icon, but can't work out how to open the settings modal and go directly to my plugin's settings page. Is such a link / action possible?

fieldOfView · November 27, 2020, 5:39pm

Here's how the ngrok plugin does it:

github.com

fieldOfView/OctoPrint-ngrok/blob/76301c1b5e0ce6e4635c6f7032df93c8b7ae6f8a/octoprint_ngrok/templates/ngrok_navbar.jinja2#L24


	<li data-bind="visible: $root.loginState.hasPermissionKo($root.access.permissions.PLUGIN_NGROK_CONTROL)">
		<a href="javascript:void(0)" data-bind="
			text: (tunnelName() != '') ? _('Close tunnel') : _('Create tunnel'),
			click: function() { if (tunnelName() != '') { closeTunnel(); } else { connectTunnel(); } }
		"></a>
	</li>

	<li data-bind="visible: $root.loginState.hasPermissionKo($root.access.permissions.SETTINGS)" class="divider"></li>
	<li data-bind="visible: $root.loginState.hasPermissionKo($root.access.permissions.SETTINGS)">
		<a href="https://dashboard.ngrok.com/" target="_blank">{{ _('ngrok dashboard...') }}</a></li>
	<li data-bind="visible: $root.loginState.hasPermissionKo($root.access.permissions.SETTINGS)">
		<a href="javascript:void(0)" data-bind="click: showTunnelSettings;">{{ _('Tunnel settings...') }}</a>
	</li>
</ul>

and

github.com

fieldOfView/OctoPrint-ngrok/blob/76301c1b5e0ce6e4635c6f7032df93c8b7ae6f8a/octoprint_ngrok/static/js/ngrok.js#L39



self.closeTunnel = function() {
    OctoPrint.simpleApiCommand("ngrok", "close", {});
}

self.connectTunnel = function() {
    self.settings.saveData();
    OctoPrint.simpleApiCommand("ngrok", "connect", {});
}

self.showTunnelSettings = function() {
    if (!self.loginState.hasPermission(self.access.permissions.SETTINGS)) {
        return;
    }
    self.settings.show("#settings_plugin_ngrok");
}

self.requestData = function() {
    OctoPrint.plugins.ngrok.get()
        .done(function(response) {
            self.tunnelName(response.tunnel);

benlye · November 27, 2020, 12:22pm

Thank you! Will look at that and figure it out