From 75dd058ce216c5cd990057ffe71b923e5bfe72e0 Mon Sep 17 00:00:00 2001
From: Mutasem Aldmour <4711238+mutdmour@users.noreply.github.com>
Date: Fri, 9 Apr 2021 23:44:53 +0300
Subject: [PATCH] :sparkles: Add support to dynamically add menu items

* add menu items POC

* remove sidebar hook

* use getters

* update menu to add items

* add home icon for CLD-202

* center icon

* address comments

* :zap: Minor improvements

Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
---
 packages/editor-ui/src/Interface.ts           | 17 +++++++
 .../editor-ui/src/components/MainSidebar.vue  | 44 +++++++++++++++++++
 packages/editor-ui/src/main.ts                |  2 +
 packages/editor-ui/src/store.ts               | 16 +++++--
 4 files changed, 76 insertions(+), 3 deletions(-)

diff --git a/packages/editor-ui/src/Interface.ts b/packages/editor-ui/src/Interface.ts
index 972ef0cbd8..745e0f11fb 100644
--- a/packages/editor-ui/src/Interface.ts
+++ b/packages/editor-ui/src/Interface.ts
@@ -428,3 +428,20 @@ export interface ITimeoutHMS {
 }
 
 export type WorkflowTitleStatus = 'EXECUTING' | 'IDLE' | 'ERROR';
+
+export type MenuItemType = 'link';
+export type MenuItemPosition = 'top' | 'bottom';
+
+export interface IMenuItem {
+	id: string;
+	type: MenuItemType;
+	position: MenuItemPosition;
+	properties: ILinkMenuItemProperties;
+}
+
+export interface ILinkMenuItemProperties {
+	title: string;
+	icon: string;
+	href: string;
+	newWindow?: boolean;
+}
\ No newline at end of file
diff --git a/packages/editor-ui/src/components/MainSidebar.vue b/packages/editor-ui/src/components/MainSidebar.vue
index 2b6ae3e054..6de1de6c98 100644
--- a/packages/editor-ui/src/components/MainSidebar.vue
+++ b/packages/editor-ui/src/components/MainSidebar.vue
@@ -21,6 +21,22 @@
 					</a>
 				</el-menu-item>
 
+				<el-menu-item
+					v-for="item in sidebarMenuTopItems"
+					:key="item.id"
+					:index="item.id"
+				>
+					<a
+						v-if="item.type === 'link'"
+						:href="item.properties.href"
+						:target="item.properties.newWindow ? '_blank' : '_self'"
+						class="primary-item"
+					>
+						<font-awesome-icon :icon="item.properties.icon" />
+						<span slot="title" class="item-title-root">{{ item.properties.title }}</span>
+					</a>
+				</el-menu-item>
+
 				<el-submenu index="workflow" title="Workflow">
 					<template slot="title">
 						<font-awesome-icon icon="network-wired"/>&nbsp;
@@ -152,6 +168,22 @@
 					</el-menu-item>
 				</el-submenu>
 
+				<el-menu-item
+					v-for="item in sidebarMenuBottomItems"
+					:key="item.id"
+					:index="item.id"
+				>
+					<a
+						v-if="item.type === 'link'"
+						:href="item.properties.href"
+						:target="item.properties.newWindow ? '_blank' : '_self'"
+						class="primary-item"
+					>
+						<font-awesome-icon :icon="item.properties.icon" />
+						<span slot="title" class="item-title-root">{{ item.properties.title }}</span>
+					</a>
+				</el-menu-item>
+
 			</el-menu>
 
 		</div>
@@ -167,6 +199,7 @@ import {
 	IExecutionResponse,
 	IExecutionsStopData,
 	IWorkflowDataUpdate,
+	IMenuItem,
 } from '../Interface';
 
 import About from '@/components/About.vue';
@@ -266,6 +299,12 @@ export default mixins(
 			workflowRunning (): boolean {
 				return this.$store.getters.isActionActive('workflowRunning');
 			},
+			sidebarMenuTopItems(): IMenuItem[] {
+				return this.$store.getters.sidebarMenuItems.filter((item: IMenuItem) => item.position === 'top');
+			},
+			sidebarMenuBottomItems(): IMenuItem[] {
+				return this.$store.getters.sidebarMenuItems.filter((item: IMenuItem) => item.position === 'bottom');
+			},
 		},
 		methods: {
 			clearExecutionData () {
@@ -533,6 +572,11 @@ export default mixins(
 .el-menu-item {
 	a {
 		color: #666;
+
+		&.primary-item {
+			color: $--color-primary;
+			vertical-align: baseline;
+		}
 	}
 
 	&.logo-item {
diff --git a/packages/editor-ui/src/main.ts b/packages/editor-ui/src/main.ts
index f79cc1acef..af74cd0fcd 100644
--- a/packages/editor-ui/src/main.ts
+++ b/packages/editor-ui/src/main.ts
@@ -56,6 +56,7 @@ import {
 	faFilePdf,
 	faFolderOpen,
 	faHdd,
+	faHome,
 	faHourglass,
 	faImage,
 	faInbox,
@@ -136,6 +137,7 @@ library.add(faFileImport);
 library.add(faFilePdf);
 library.add(faFolderOpen);
 library.add(faHdd);
+library.add(faHome);
 library.add(faHourglass);
 library.add(faImage);
 library.add(faInbox);
diff --git a/packages/editor-ui/src/store.ts b/packages/editor-ui/src/store.ts
index 349b11f8a9..0309075d68 100644
--- a/packages/editor-ui/src/store.ts
+++ b/packages/editor-ui/src/store.ts
@@ -21,12 +21,13 @@ import {
 	ICredentialsResponse,
 	IExecutionResponse,
 	IExecutionsCurrentSummaryExtended,
-	IPushDataExecutionFinished,
-	IPushDataNodeExecuteAfter,
-	IWorkflowDb,
+	IMenuItem,
 	INodeUi,
 	INodeUpdatePropertiesInformation,
+	IPushDataExecutionFinished,
+	IPushDataNodeExecuteAfter,
 	IUpdateInformation,
+	IWorkflowDb,
 	XYPositon,
 } from './Interface';
 
@@ -79,6 +80,7 @@ export const store = new Vuex.Store({
 			nodes: [] as INodeUi[],
 			settings: {} as IWorkflowSettings,
 		} as IWorkflowDb,
+		sidebarMenuItems: [] as IMenuItem[],
 	},
 	mutations: {
 		// Active Actions
@@ -597,6 +599,11 @@ export const store = new Vuex.Store({
 			Vue.set(state, 'nodeTypes', updatedNodes);
 			state.nodeTypes = updatedNodes;
 		},
+
+		addSidebarMenuItems (state, menuItems: IMenuItem[]) {
+			const updated = state.sidebarMenuItems.concat(menuItems);
+			Vue.set(state, 'sidebarMenuItems', updated);
+		},
 	},
 	getters: {
 
@@ -834,6 +841,9 @@ export const store = new Vuex.Store({
 			return workflowRunData[nodeName];
 		},
 
+		sidebarMenuItems: (state): IMenuItem[] => {
+			return state.sidebarMenuItems;
+		},
 	},
 
 });