wip: Provide ready-made configuration snippets to help set up the app's configuration file #1140

Author: cnouguier

extras/configs/panes.left.js

@@ -8,47 +8,55 @@ module.exports = {
       route: { name: `${name}-activity`, params }
     }
   },
-  SETTINGS: {
-    id: 'settings-action',
-    icon: 'las la-cog',
-    label: 'layout.SETTINGS',
-    renderer: 'item',
-    dialog: {
-      component: 'app/KSettings',
-      title: 'SETTINGS',
-      cancelAction: 'CANCEL',
-      okAction: {
-        id: 'apply-settings', label: 'APPLY', handler: 'apply'
+  settings: (options) => {
+    return Object.assign({
+      id: 'settings-action',
+      icon: 'las la-cog',
+      label: 'layout.SETTINGS',
+      renderer: 'item',
+      dialog: {
+        component: 'app/KSettings',
+        title: 'SETTINGS',
+        cancelAction: 'CANCEL',
+        okAction: {
+          id: 'apply-settings', label: 'APPLY', handler: 'apply'
+        }
       }
-    }
+    }, options)
   },
-  ABOUT: {
-    id: 'about-action',
-    icon: 'las la-info',
-    label: 'layout.ABOUT',
-    renderer: 'item',
-    dialog: {
-      component: 'app/KAbout', title: 'ABOUT', okAction: 'CLOSE'
-    }
+  about: (options) => {
+    return Object.assign({
+      id: 'about-action',
+      icon: 'las la-info',
+      label: 'layout.ABOUT',
+      renderer: 'item',
+      dialog: {
+        component: 'app/KAbout', title: 'ABOUT', okAction: 'CLOSE'
+      },
+    }, options)
   },
-  PLATFORM_INFO: {
-    id: 'platform-info',
-    icon: 'las la-desktop',
-    label: 'KAbout.PLATFORM_INFO',
-    stack: true,
-    dialog: {
-      title: 'KAbout.PLATFORM_INFO',
-      component: 'app/KPlatform',
-      okAction: 'CLOSE',
-      widthPolicy: 'narrow'
-    }
+  platformInfo: (options) => {
+    return Object.assign({
+      id: 'platform-info',
+      icon: 'las la-desktop',
+      label: 'KAbout.PLATFORM_INFO',
+      stack: true,
+      dialog: {
+        title: 'KAbout.PLATFORM_INFO',
+        component: 'app/KPlatform',
+        okAction: 'CLOSE',
+        widthPolicy: 'narrow'
+      }
+    }, options)
   },
-  REPORT_BUG: {
-    id: 'report-bug',
-    icon: 'las la-bug',
-    label: 'KAbout.BUG_REPORT',
-    stack: true,
-    component: 'action/KBugReportAction'
+  reportBug: (options) => {
+    return Object.assign({
+      id: 'report-bug',
+      icon: 'las la-bug',
+      label: 'KAbout.BUG_REPORT',
+      stack: true,
+      component: 'action/KBugReportAction'
+    }, options)
   },
   legalNotice: (options) => {
     return Object.assign({
@@ -71,30 +79,36 @@ module.exports = {
     }, options)
   },
   onlineHelp: (options) => {
-    return {
+    return Object.assign({
       id: 'online-help-action',
       icon: 'las la-book',
       label: 'layout.ONLINE_HELP',
       url,
       renderer: 'item'
-    }
+    }, options)
   },
-  CONTEXTUAL_HELP: {
-    id: 'contextual-help-action',
-    icon: 'las la-question-circle',
-    label: 'layout.CONTEXTUAL_HELP',
-    handler: { name: 'launchTour', params: ['home'] },
-    renderer: 'item'
+  contextualHelp: (options) => {
+    // route: default tour route. Default to 'home'
+    const route = options?.route || 'home'
+    return Object.assign({
+      id: 'contextual-help-action',
+      icon: 'las la-question-circle',
+      label: 'layout.CONTEXTUAL_HELP',
+      handler: { name: 'launchTour', params: [route] },
+      renderer: 'item'
+    }, options)
   },
-  logout: (provider = null) => {
-    return {
+  logout: (options) => {
+    // provider: whether to use an Oauth provider to logout
+    const provider = options?.provider
+    return Object.assign({
       id: 'logout-action',
       icon: 'las la-sign-out-alt',
       label: 'layout.LOGOUT',
       route: {
         name: 'logout', ...(provider && { params: { provider } })
       },
       renderer: 'item'
-    }
+    }, options)
   }
 }