Merge pull request #9814 from owncloud/nav-item-extension

feat: add registering nav items via extension
owncloud · Oct 17, 2023 · b8bf549 · b8bf549
2 parents cbeccce + 6b4863a
commit b8bf549
Show file tree

Hide file tree

Showing 9 changed files with 115 additions and 47 deletions.
diff --git a/changelog/unreleased/enhancement-nav-item-extension b/changelog/unreleased/enhancement-nav-item-extension
@@ -0,0 +1,11 @@
+Enhancement: Registering nav items as extension
+
+Nav items can now be registered with the new extension type `SidebarNavExtension`, which consists of a `AppNavigationItem` and optionally `scopes` (a list of app IDs where the nav item should show).
+
+Also, 2 new optional properties have been added to the `AppNavigationItem` interface:
+
+`handler` - a click handler that get executes on click. It takes priority over a given route.
+`priority` - a number that determines the nav item's position.
+
+https://github.com/owncloud/web/pull/9814
+https://github.com/owncloud/web/issues/9239
diff --git a/packages/web-app-admin-settings/src/index.ts b/packages/web-app-admin-settings/src/index.ts
@@ -109,7 +109,8 @@ const navItems = ({ $ability }: { $ability: Ability }): AppNavigationItem[] => [
     },
     enabled: () => {
       return $ability.can('read-all', 'Setting')
-    }
+    },
+    priority: 10
   },
   {
     name: $gettext('Users'),
@@ -119,7 +120,8 @@ const navItems = ({ $ability }: { $ability: Ability }): AppNavigationItem[] => [
     },
     enabled: () => {
       return $ability.can('read-all', 'Account')
-    }
+    },
+    priority: 20
   },
   {
     name: $gettext('Groups'),
@@ -129,7 +131,8 @@ const navItems = ({ $ability }: { $ability: Ability }): AppNavigationItem[] => [
     },
     enabled: () => {
       return $ability.can('read-all', 'Group')
-    }
+    },
+    priority: 30
   },
   {
     name: $gettext('Spaces'),
@@ -139,7 +142,8 @@ const navItems = ({ $ability }: { $ability: Ability }): AppNavigationItem[] => [
     },
     enabled: () => {
       return $ability.can('read-all', 'Drive')
-    }
+    },
+    priority: 40
   }
 ]
 

diff --git a/packages/web-app-files/src/index.ts b/packages/web-app-files/src/index.ts
@@ -62,7 +62,8 @@ export const navItems = (context): AppNavigationItem[] => {
         return !!context?.$store?.getters['runtime/spaces/spaces'].find(
           (drive) => isPersonalSpaceResource(drive) && drive.isOwner(context.$store.getters.user)
         )
-      }
+      },
+      priority: 10
     },
     {
       name: $gettext('Favorites'),
@@ -72,7 +73,8 @@ export const navItems = (context): AppNavigationItem[] => {
       },
       enabled(capabilities) {
         return capabilities.files?.favorites
-      }
+      },
+      priority: 20
     },
     {
       name: $gettext('Shares'),
@@ -91,7 +93,8 @@ export const navItems = (context): AppNavigationItem[] => {
       ],
       enabled(capabilities) {
         return capabilities.files_sharing?.api_enabled !== false
-      }
+      },
+      priority: 30
     },
     {
       name: $gettext('Spaces'),
@@ -102,7 +105,8 @@ export const navItems = (context): AppNavigationItem[] => {
       activeFor: [{ path: `/${appInfo.id}/spaces/project` }],
       enabled(capabilities) {
         return capabilities.spaces?.projects
-      }
+      },
+      priority: 40
     },
     {
       name: $gettext('Deleted files'),
@@ -113,7 +117,8 @@ export const navItems = (context): AppNavigationItem[] => {
       activeFor: [{ path: `/${appInfo.id}/trash` }],
       enabled(capabilities) {
         return capabilities.dav?.trashbin === '1.0' && capabilities.files?.undelete
-      }
+      },
+      priority: 50
     }
   ]
 }

diff --git a/packages/web-pkg/src/apps/types.ts b/packages/web-pkg/src/apps/types.ts
@@ -21,6 +21,8 @@ export interface AppNavigationItem {
   name?: string | ((capabilities?: Record<string, any>) => string)
   route?: RouteLocationRaw
   tag?: string
+  handler?: () => void
+  priority?: number
 }
 
 /**

diff --git a/packages/web-pkg/src/composables/piniaStores/extensionRegistry.ts b/packages/web-pkg/src/composables/piniaStores/extensionRegistry.ts
@@ -4,10 +4,12 @@ import { defineStore } from 'pinia'
 import { Ref, hasInjectionContext, unref } from 'vue'
 import { useConfigurationManager } from '../configuration'
 import { ConfigurationManager } from '../../configuration'
+import { AppNavigationItem } from '../../apps'
 
 export type BaseExtension = {
   id: string
   type: string
+  scopes?: string[]
 }
 
 export interface ActionExtension extends BaseExtension {
@@ -20,7 +22,12 @@ export interface SearchExtension extends BaseExtension {
   searchProvider: SearchProvider
 }
 
-export type Extension = ActionExtension | SearchExtension
+export interface SidebarNavExtension extends BaseExtension {
+  type: 'sidebarNav'
+  navItem: AppNavigationItem
+}
+
+export type Extension = ActionExtension | SearchExtension | SidebarNavExtension
 
 export const useExtensionRegistry = ({
   configurationManager
@@ -41,13 +48,20 @@ export const useExtensionRegistry = ({
     getters: {
       requestExtensions:
         (state) =>
-        <ExtensionType extends Extension>(type: string) => {
+        <ExtensionType extends Extension>(type: string, scope?: string) => {
           return state.extensions
             .map((e) =>
-              unref(e).filter((e) => e.type === type && !options.disabledExtensions.includes(e.id))
+              unref(e).filter(
+                (e) =>
+                  e.type === type &&
+                  !options.disabledExtensions.includes(e.id) &&
+                  (!scope || e.scopes?.includes(scope))
+              )
             )
             .flat() as ExtensionType[]
         }
     }
   })()
 }
+
+export type ExtensionRegistry = ReturnType<typeof useExtensionRegistry>
diff --git a/packages/web-runtime/src/components/SidebarNav/SidebarNav.vue b/packages/web-runtime/src/components/SidebarNav/SidebarNav.vue
@@ -39,6 +39,7 @@
           :name="link.name"
           :collapsed="navigation.closed"
           :tag="link.tag"
+          :handler="link.handler"
         />
       </oc-list>
     </nav>
@@ -189,7 +190,8 @@ export default defineComponent({
     justify-content: flex-end !important;
   }
 
-  .oc-sidebar-nav li a:not(.active) {
+  .oc-sidebar-nav li a:not(.active),
+  .oc-sidebar-nav li button:not(.active) {
     &:hover,
     &:focus {
       text-decoration: none !important;
@@ -198,7 +200,8 @@ export default defineComponent({
     }
   }
 
-  .oc-sidebar-nav li a.active {
+  .oc-sidebar-nav li a.active,
+  .oc-sidebar-nav li button.active {
     &:focus,
     &:hover {
       color: var(--oc-color-swatch-primary-contrast);

diff --git a/packages/web-runtime/src/components/SidebarNav/SidebarNavItem.vue b/packages/web-runtime/src/components/SidebarNav/SidebarNavItem.vue
@@ -2,13 +2,13 @@
   <li class="oc-sidebar-nav-item oc-pb-xs oc-px-s" :aria-current="active ? 'page' : null">
     <oc-button
       v-oc-tooltip="toolTip"
-      type="router-link"
+      :type="handler ? 'button' : 'router-link'"
       :appearance="active ? 'raw-inverse' : 'raw'"
       :variation="active ? 'primary' : 'passive'"
-      :class="['oc-sidebar-nav-item-link', { active: active }]"
-      :to="target"
+      :class="['oc-sidebar-nav-item-link', 'oc-oc-width-1-1', { active: active }]"
       :data-nav-id="index"
       :data-nav-name="navName"
+      v-bind="attrs"
     >
       <span class="oc-flex">
         <oc-icon :name="icon" :fill-type="fillType" variation="inherit" />
@@ -19,7 +19,7 @@
   </li>
 </template>
 <script lang="ts">
-import { defineComponent, PropType } from 'vue'
+import { computed, defineComponent, PropType } from 'vue'
 import { RouteLocationRaw } from 'vue-router'
 
 export default defineComponent({
@@ -60,11 +60,29 @@ export default defineComponent({
       type: String,
       required: false,
       default: null
+    },
+    handler: {
+      type: Function as PropType<() => void>,
+      required: false,
+      default: null
     }
   },
+  setup(props) {
+    const attrs = computed(() => {
+      return {
+        ...(props.handler && { onClick: props.handler }),
+        ...(props.target && { to: props.target })
+      }
+    })
+
+    return { attrs }
+  },
   computed: {
     navName() {
-      return this.$router?.resolve(this.target, this.$route)?.name || 'route.name'
+      if (this.target) {
+        return this.$router?.resolve(this.target, this.$route)?.name || 'route.name'
+      }
+      return this.name
     },
     toolTip() {
       const value = this.collapsed

diff --git a/packages/web-runtime/src/layouts/Application.vue b/packages/web-runtime/src/layouts/Application.vue
@@ -35,7 +35,8 @@
 
 <script lang="ts">
 import { mapActions, mapGetters } from 'vuex'
-import { AppLoadingSpinner } from '@ownclouders/web-pkg'
+import orderBy from 'lodash-es/orderBy'
+import { AppLoadingSpinner, SidebarNavExtension, useExtensionRegistry } from '@ownclouders/web-pkg'
 import TopBar from '../components/Topbar/TopBar.vue'
 import MessageBar from '../components/MessageBar.vue'
 import SidebarNav from '../components/SidebarNav/SidebarNav.vue'
@@ -78,6 +79,13 @@ export default defineComponent({
     const { $gettext } = useGettext()
     const isUserContext = useUserContext({ store })
     const activeApp = useActiveApp()
+    const extensionRegistry = useExtensionRegistry()
+
+    const extensionNavItems = computed(() =>
+      extensionRegistry
+        .requestExtensions<SidebarNavExtension>('sidebarNav', unref(activeApp))
+        .map(({ navItem }) => navItem)
+    )
 
     // FIXME: we can convert to a single router-view without name (thus without the loop) and without this watcher when we release v6.0.0
     watch(
@@ -119,36 +127,39 @@ export default defineComponent({
         return []
       }
 
-      const items = store.getters['getNavItemsByExtension'](unref(activeApp)) as AppNavigationItem[]
-      if (!items) {
-        return []
-      }
+      const items = [
+        ...store.getters['getNavItemsByExtension'](unref(activeApp)),
+        ...unref(extensionNavItems)
+      ] as AppNavigationItem[]
 
       const { href: currentHref } = router.resolve(unref(route))
-      return items.map((item) => {
-        let active = typeof item.isActive !== 'function' || item.isActive()
+      return orderBy(
+        items.map((item) => {
+          let active = typeof item.isActive !== 'function' || item.isActive()
 
-        if (active) {
-          active = [item.route, ...(item.activeFor || [])].filter(Boolean).some((currentItem) => {
-            try {
-              const comparativeHref = router.resolve(currentItem).href
-              return currentHref.startsWith(comparativeHref)
-            } catch (e) {
-              console.error(e)
-              return false
-            }
-          })
-        }
+          if (active) {
+            active = [item.route, ...(item.activeFor || [])].filter(Boolean).some((currentItem) => {
+              try {
+                const comparativeHref = router.resolve(currentItem).href
+                return currentHref.startsWith(comparativeHref)
+              } catch (e) {
+                console.error(e)
+                return false
+              }
+            })
+          }
 
-        const name =
-          typeof item.name === 'function' ? item.name(store.getters['capabilities']) : item.name
+          const name =
+            typeof item.name === 'function' ? item.name(store.getters['capabilities']) : item.name
 
-        return {
-          ...item,
-          name: $gettext(name),
-          active
-        }
-      })
+          return {
+            ...item,
+            name: $gettext(name),
+            active
+          }
+        }),
+        ['priority', 'name']
+      )
     })
 
     const isSidebarVisible = computed(() => {

diff --git a/...es/web-runtime/tests/unit/components/SidebarNav/__snapshots__/SidebarNavItem.spec.ts.snap b/...es/web-runtime/tests/unit/components/SidebarNav/__snapshots__/SidebarNavItem.spec.ts.snap
@@ -2,12 +2,12 @@
 
 exports[`OcSidebarNav renders navItem with toolTip if collapsed 1`] = `
 <li class="oc-sidebar-nav-item oc-pb-xs oc-px-s" id="123">
-  <router-link-stub class="oc-button oc-rounded oc-button-m oc-button-justify-content-center oc-button-gap-m oc-button-passive oc-button-passive-raw oc-sidebar-nav-item-link" data-nav-id="5" data-nav-name="route.name" to="/files/list/all"></router-link-stub>
+  <router-link-stub class="oc-button oc-rounded oc-button-m oc-button-justify-content-center oc-button-gap-m oc-button-passive oc-button-passive-raw oc-sidebar-nav-item-link oc-oc-width-1-1" data-nav-id="5" data-nav-name="route.name" to="/files/list/all"></router-link-stub>
 </li>
 `;
 
 exports[`OcSidebarNav renders navItem without toolTip if expanded 1`] = `
 <li class="oc-sidebar-nav-item oc-pb-xs oc-px-s" id="123">
-  <router-link-stub class="oc-button oc-rounded oc-button-m oc-button-justify-content-center oc-button-gap-m oc-button-passive oc-button-passive-raw oc-sidebar-nav-item-link" data-nav-id="5" data-nav-name="route.name" to="/files/list/all"></router-link-stub>
+  <router-link-stub class="oc-button oc-rounded oc-button-m oc-button-justify-content-center oc-button-gap-m oc-button-passive oc-button-passive-raw oc-sidebar-nav-item-link oc-oc-width-1-1" data-nav-id="5" data-nav-name="route.name" to="/files/list/all"></router-link-stub>
 </li>
 `;