Add functionality to hide plugins from quick access menu (#468)

backend/browser.py

@@ -122,10 +122,7 @@ async def uninstall_plugin(self, name):
                 logger.debug("Plugin %s was stopped", name)
                 del self.plugins[name]
                 logger.debug("Plugin %s was removed from the dictionary", name)
-                current_plugin_order = self.settings.getSetting("pluginOrder")
-                current_plugin_order.remove(name)
-                self.settings.setSetting("pluginOrder", current_plugin_order)
-                logger.debug("Plugin %s was removed from the pluginOrder setting", name)
+                self.cleanup_plugin_settings(name)
             logger.debug("removing files %s" % str(name))
             rmtree(plugin_dir)
         except FileNotFoundError:
@@ -234,3 +231,18 @@ async def confirm_plugin_install(self, request_id):
 
     def cancel_plugin_install(self, request_id):
         self.install_requests.pop(request_id)
+
+    def cleanup_plugin_settings(self, name):
+        """Removes any settings related to a plugin. Propably called when a plugin is uninstalled.
+
+        Args:
+            name (string): The name of the plugin
+        """
+        hidden_plugins = self.settings.getSetting("hiddenPlugins", [])
+        hidden_plugins.remove(name)
+        self.settings.setSetting("hiddenPlugins", hidden_plugins)
+
+        plugin_order = self.settings.getSetting("pluginOrder")
+        plugin_order.remove(name)
+        self.settings.setSetting("pluginOrder", plugin_order)
+        logger.debug("Removed any settings for plugin %s", name)

backend/locales/en-US.json

@@ -17,6 +17,13 @@
             "select": "Use this folder"
         }
     },
+    "PluginView": {
+        "hidden_one": "1 plugin is hidden from this list",
+        "hidden_other": "{{count}} plugins are hidden from this list"
+    },
+    "PluginListLabel": {
+        "hidden": "Hidden from the quick access menu"
+    },
     "PluginCard": {
         "plugin_full_access": "This plugin has full access to your Steam Deck.",
         "plugin_install": "Install",
@@ -73,6 +80,8 @@
         "reload": "Reload",
         "uninstall": "Uninstall",
         "update_to": "Update to {{name}}",
+        "show": "Quick access: Show",
+        "hide": "Quick access: Hide",
         "update_all_one": "Update 1 plugin",
         "update_all_other": "Update {{count}} plugins"
     },

backend/settings.py

@@ -22,7 +22,7 @@ def __init__(self, name, settings_directory = None) -> None:
         for file in listdir(wrong_dir):
             if file.endswith(".json"):
                 rename(path.join(wrong_dir,file),
-                       path.join(settings_directory, file)) 
+                       path.join(settings_directory, file))
                 self.path = path.join(settings_directory, name + ".json")
 
 

frontend/.gitignore

@@ -2,3 +2,5 @@ node_modules/
 
 .yalc
 yalc.lock
+
+stats.html

frontend/package.json

@@ -33,6 +33,7 @@
     "rollup-plugin-delete": "^2.0.0",
     "rollup-plugin-external-globals": "^0.6.1",
     "rollup-plugin-polyfill-node": "^0.10.2",
+    "rollup-plugin-visualizer": "^5.9.0",
     "tslib": "^2.5.2",
     "typescript": "^4.9.5"
   },

frontend/rollup.config.js

@@ -7,6 +7,7 @@ import typescript from '@rollup/plugin-typescript';
 import { defineConfig } from 'rollup';
 import del from 'rollup-plugin-delete';
 import externalGlobals from 'rollup-plugin-external-globals';
+import { visualizer } from 'rollup-plugin-visualizer';
 
 const hiddenWarnings = ['THIS_IS_UNDEFINED', 'EVAL'];
 
@@ -16,7 +17,7 @@ export default defineConfig({
     del({ targets: '../backend/static/*', force: true }),
     commonjs(),
     nodeResolve({
-      browser: true
+      browser: true,
     }),
     externalGlobals({
       react: 'SP_REACT',
@@ -33,6 +34,7 @@ export default defineConfig({
       'process.env.NODE_ENV': JSON.stringify('production'),
     }),
     image(),
+    visualizer(),
   ],
   preserveEntrySignatures: false,
   output: {
@@ -46,4 +48,4 @@ export default defineConfig({
     if (hiddenWarnings.some((warning) => message.code === warning)) return;
     handleWarning(message);
   },
-});
+});

frontend/src/components/DeckyState.tsx

@@ -7,6 +7,7 @@ import { VerInfo } from '../updater';
 interface PublicDeckyState {
   plugins: Plugin[];
   pluginOrder: string[];
+  hiddenPlugins: string[];
   activePlugin: Plugin | null;
   updates: PluginUpdateMapping | null;
   hasLoaderUpdate?: boolean;
@@ -17,6 +18,7 @@ interface PublicDeckyState {
 export class DeckyState {
   private _plugins: Plugin[] = [];
   private _pluginOrder: string[] = [];
+  private _hiddenPlugins: string[] = [];
   private _activePlugin: Plugin | null = null;
   private _updates: PluginUpdateMapping | null = null;
   private _hasLoaderUpdate: boolean = false;
@@ -29,6 +31,7 @@ export class DeckyState {
     return {
       plugins: this._plugins,
       pluginOrder: this._pluginOrder,
+      hiddenPlugins: this._hiddenPlugins,
       activePlugin: this._activePlugin,
       updates: this._updates,
       hasLoaderUpdate: this._hasLoaderUpdate,
@@ -52,6 +55,11 @@ export class DeckyState {
     this.notifyUpdate();
   }
 
+  setHiddenPlugins(hiddenPlugins: string[]) {
+    this._hiddenPlugins = hiddenPlugins;
+    this.notifyUpdate();
+  }
+
   setActivePlugin(name: string) {
     this._activePlugin = this._plugins.find((plugin) => plugin.name === name) ?? null;
     this.notifyUpdate();
@@ -111,11 +119,11 @@ export const DeckyStateContextProvider: FC<Props> = ({ children, deckyState }) =
     return () => deckyState.eventBus.removeEventListener('update', onUpdate);
   }, []);
 
-  const setIsLoaderUpdating = (hasUpdate: boolean) => deckyState.setIsLoaderUpdating(hasUpdate);
-  const setVersionInfo = (versionInfo: VerInfo) => deckyState.setVersionInfo(versionInfo);
-  const setActivePlugin = (name: string) => deckyState.setActivePlugin(name);
-  const closeActivePlugin = () => deckyState.closeActivePlugin();
-  const setPluginOrder = (pluginOrder: string[]) => deckyState.setPluginOrder(pluginOrder);
+  const setIsLoaderUpdating = deckyState.setIsLoaderUpdating.bind(deckyState);
+  const setVersionInfo = deckyState.setVersionInfo.bind(deckyState);
+  const setActivePlugin = deckyState.setActivePlugin.bind(deckyState);
+  const closeActivePlugin = deckyState.closeActivePlugin.bind(deckyState);
+  const setPluginOrder = deckyState.setPluginOrder.bind(deckyState);
 
   return (
     <DeckyStateContext.Provider

frontend/src/components/PluginView.tsx

@@ -8,6 +8,8 @@ import {
   staticClasses,
 } from 'decky-frontend-lib';
 import { VFC, useEffect, useState } from 'react';
+import { useTranslation } from 'react-i18next';
+import { FaEyeSlash } from 'react-icons/fa';
 
 import { Plugin } from '../plugin';
 import { useDeckyState } from './DeckyState';
@@ -16,8 +18,10 @@ import { useQuickAccessVisible } from './QuickAccessVisibleState';
 import TitleView from './TitleView';
 
 const PluginView: VFC = () => {
+  const { hiddenPlugins } = useDeckyState();
   const { plugins, updates, activePlugin, pluginOrder, setActivePlugin, closeActivePlugin } = useDeckyState();
   const visible = useQuickAccessVisible();
+  const { t } = useTranslation();
 
   const [pluginList, setPluginList] = useState<Plugin[]>(
     plugins.sort((a, b) => pluginOrder.indexOf(a.name) - pluginOrder.indexOf(b.name)),
@@ -48,6 +52,7 @@ const PluginView: VFC = () => {
         <PanelSection>
           {pluginList
             .filter((p) => p.content)
+            .filter(({ name }) => !hiddenPlugins.includes(name))
             .map(({ name, icon }) => (
               <PanelSectionRow key={name}>
                 <ButtonItem layout="below" onClick={() => setActivePlugin(name)}>
@@ -59,6 +64,12 @@ const PluginView: VFC = () => {
                 </ButtonItem>
               </PanelSectionRow>
             ))}
+          {hiddenPlugins.length > 0 && (
+            <div style={{ display: 'flex', alignItems: 'center', gap: '10px', fontSize: '0.8rem', marginTop: '10px' }}>
+              <FaEyeSlash />
+              <div>{t('PluginView.hidden', { count: hiddenPlugins.length })}</div>
+            </div>
+          )}
         </PanelSection>
       </div>
     </>