From e3b7f587ee002f730e2e1b592f56d07f21de92bb Mon Sep 17 00:00:00 2001
From: khuntoriia <120667115@qq.com>
Date: Mon, 10 Oct 2022 13:57:24 +0800
Subject: [PATCH] =?UTF-8?q?feat(editor):=20=E6=94=AF=E6=8C=81=E9=80=9A?=
 =?UTF-8?q?=E8=BF=87=E5=B7=A6=E4=BE=A7=E7=BB=84=E4=BB=B6=E6=A0=91=E8=BF=9B?=
 =?UTF-8?q?=E8=A1=8C=E7=BB=84=E4=BB=B6=E5=A4=9A=E9=80=89?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* feat(layerpanel): 支持通过组件树对组件进行多选

* feat(editor): 重构LayerPanel为ts setup语法形式

* feat(editor): 组件列表选中节点与高亮节点时的逻辑优化,两种形态互斥处理

* fix(editor): 修复按住ctrl不放但鼠标移出的layerpanel时选择模式无法复原的问题,修复点击组件树index多选框可进行选择的问题

* fix(editor): 修复多选场景点击组件树节点取消多选时,节点高亮样式冲突的问题

close #404

Co-authored-by: parisma <parisma@tencent.com>
---
 .../editor/src/layouts/sidebar/LayerPanel.vue | 396 +++++++++++-------
 packages/stage/src/StageCore.ts               |   6 +-
 2 files changed, 246 insertions(+), 156 deletions(-)

diff --git a/packages/editor/src/layouts/sidebar/LayerPanel.vue b/packages/editor/src/layouts/sidebar/LayerPanel.vue
index f0187346..52c0d516 100644
--- a/packages/editor/src/layouts/sidebar/LayerPanel.vue
+++ b/packages/editor/src/layouts/sidebar/LayerPanel.vue
@@ -1,5 +1,9 @@
 <template>
-  <el-scrollbar class="magic-editor-layer-panel">
+  <el-scrollbar
+    class="magic-editor-layer-panel"
+    @mouseenter="addSelectModeListener"
+    @mouseleave="removeSelectModeListener"
+  >
     <slot name="layer-panel-header"></slot>
 
     <el-input
@@ -17,7 +21,7 @@
       node-key="id"
       empty-text="页面空荡荡的"
       draggable
-      :default-expanded-keys="expandedKeys"
+      :default-expanded-keys="defaultExpandedKeys"
       :load="loadItems"
       :data="values"
       :expand-on-click-node="false"
@@ -27,20 +31,22 @@
       }"
       :filter-node-method="filterNode"
       :allow-drop="allowDrop"
+      :show-checkbox="isMultiSelectStatus || selectedIds.length > 1"
       @node-click="clickHandler"
       @node-contextmenu="contextmenu"
       @node-drag-end="handleDragEnd"
       @node-collapse="handleCollapse"
       @node-expand="handleExpand"
+      @check="multiClickHandler"
+      @mousedown="toggleClickFlag"
+      @mouseup="toggleClickFlag"
     >
       <template #default="{ node, data }">
         <div
           :id="data.id"
           class="cus-tree-node"
-          @mousedown="toggleClickFlag"
-          @mouseup="toggleClickFlag"
           @mouseenter="highlightHandler(data)"
-          :class="{ 'cus-tree-node-hover': canHighlight && data.id === highlightNode?.id }"
+          :class="{ 'cus-tree-node-hover': canHighlight(data) }"
         >
           <slot name="layer-node-content" :node="node" :data="data">
             <span>
@@ -57,24 +63,48 @@
   </el-scrollbar>
 </template>
 
-<script lang="ts">
-import { computed, defineComponent, inject, Ref, ref, watchEffect } from 'vue';
+<script lang="ts" setup>
+import { computed, inject, ref, watch } from 'vue';
 import type { ElTree } from 'element-plus';
+import KeyController from 'keycon';
 import { throttle } from 'lodash-es';
 
 import type { Id, MNode, MPage } from '@tmagic/schema';
 import { MContainer, NodeType } from '@tmagic/schema';
 import StageCore from '@tmagic/stage';
 
-import type { EditorService } from '../../services/editor';
 import type { Services } from '../../type';
 import { Layout } from '../../type';
 
 import LayerMenu from './LayerMenu.vue';
 
 const throttleTime = 150;
+const services = inject<Services>('services');
+const tree = ref<InstanceType<typeof ElTree>>();
+const menu = ref<InstanceType<typeof LayerMenu>>();
+const editorService = services?.editorService;
+const page = computed(() => editorService?.get('page'));
+const values = computed(() => (page.value ? [page.value] : []));
+// 多选选中的节点数组
+const selectedNodes = ref<MNode[]>([]);
+// 多选选中的组件id数组
+const selectedIds = computed(() => selectedNodes.value.map((node: MNode) => node.id));
+// 是否多选
+const isMultiSelectStatus = ref(false);
+// 多选场景 取消选中的那个节点id
+const spliceNodeKey = ref<Id>();
+const filterText = ref('');
+// 默认展开节点
+const defaultExpandedKeys = computed(() => (selectedIds.value.length > 0 ? selectedIds.value : []));
 
-const select = async (data: MNode, editorService?: EditorService) => {
+editorService?.on('remove', () => {
+  setTimeout(() => {
+    tree.value?.getNode(editorService.get('node').id)?.updateChildren();
+  }, 0);
+});
+
+// 触发画布单选
+const select = async (data: MNode) => {
   if (!data.id) {
     throw new Error('没有id');
   }
@@ -83,7 +113,14 @@ const select = async (data: MNode, editorService?: EditorService) => {
   editorService?.get<StageCore>('stage')?.select(data.id);
 };
 
-const highlight = (data: MNode, editorService?: EditorService) => {
+// 触发画布多选
+const multiSelect = async (data: Id[]) => {
+  await editorService?.multiSelect(data);
+  editorService?.get<StageCore>('stage')?.multiSelect(data);
+};
+
+// 触发画布高亮
+const highlight = (data: MNode) => {
   if (!data?.id) {
     throw new Error('没有id');
   }
@@ -91,58 +128,97 @@ const highlight = (data: MNode, editorService?: EditorService) => {
   editorService?.get<StageCore>('stage')?.highlight(data.id);
 };
 
-const useDrop = (tree: Ref<InstanceType<typeof ElTree> | undefined>, editorService?: EditorService) => ({
-  allowDrop: (draggingNode: any, dropNode: any, type: string): boolean => {
-    const { data } = dropNode || {};
-    const { data: ingData } = draggingNode;
+const expandedKeys = new Map<Id, Id>();
 
-    const { type: ingType } = ingData;
+// tree方法：拖拽时判定目标节点能否成为拖动目标位置
+const allowDrop = (draggingNode: any, dropNode: any, type: string): boolean => {
+  const { data } = dropNode || {};
+  const { data: ingData } = draggingNode;
 
-    if (ingType !== NodeType.PAGE && data.type === NodeType.PAGE) return false;
-    if (ingType === NodeType.PAGE && data.type !== NodeType.PAGE) return false;
-    if (!data || !data.type) return false;
-    if (['prev', 'next'].includes(type)) return true;
-    if (data.items || data.type === 'container') return true;
+  const { type: ingType } = ingData;
 
-    return false;
-  },
+  if (ingType !== NodeType.PAGE && data.type === NodeType.PAGE) return false;
+  if (ingType === NodeType.PAGE && data.type !== NodeType.PAGE) return false;
+  if (!data || !data.type) return false;
+  if (['prev', 'next'].includes(type)) return true;
+  if (data.items || data.type === 'container') return true;
 
-  async handleDragEnd(e: any) {
+  return false;
+};
+
+// tree事件：拖拽结束时（可能未成功）触发的事件
+const handleDragEnd = async (e: any) => {
+  if (!tree.value) return;
+  const { data: node } = e;
+  const parent = editorService?.getParentById(node.id, false) as MContainer;
+  const layout = await editorService?.getLayout(parent);
+  node.style.position = layout;
+  if (layout === Layout.RELATIVE) {
+    node.style.top = 0;
+    node.style.left = 0;
+  }
+  const { data } = tree.value;
+  const [page] = data as [MPage];
+  editorService?.update(page);
+};
+
+// tree方法： 加载子树数据的方法
+const loadItems = (node: any, resolve: Function) => {
+  if (Array.isArray(node.data)) {
+    return resolve(node.data);
+  }
+  if (Array.isArray(node.data?.items)) {
+    return resolve(node.data?.items);
+  }
+  resolve([]);
+};
+
+// tree事件：节点被关闭时触发的事件
+const handleCollapse = (data: MNode) => {
+  expandedKeys.delete(data.id);
+};
+
+// tree事件：节点被展开时触发的事件
+const handleExpand = (data: MNode) => {
+  const parent = editorService?.getParentById(data.id);
+  if (!parent?.id) return;
+  expandedKeys.set(parent.id, parent.id);
+};
+
+// tree方法：对树节点进行筛选时执行的方法
+const filterNode = (value: string, data: MNode): boolean => {
+  if (!value) {
+    return true;
+  }
+  let name = '';
+  if (data.name) {
+    name = data.name;
+  } else if (data.items) {
+    name = 'container';
+  }
+  return `${data.id}${name}${data.type}`.indexOf(value) !== -1;
+};
+
+// 过滤关键字
+const filterTextChangeHandler = (val: string) => {
+  tree.value?.filter(val);
+};
+
+// 展开树节点
+const expandNodes = () => {
+  expandedKeys.forEach((key) => {
     if (!tree.value) return;
-    const { data: node } = e;
-    const parent = editorService?.getParentById(node.id, false) as MContainer;
-    const layout = await editorService?.getLayout(parent);
-    node.style.position = layout;
-    if (layout === Layout.RELATIVE) {
-      node.style.top = 0;
-      node.style.left = 0;
-    }
-    const { data } = tree.value;
-    const [page] = data as [MPage];
-    editorService?.update(page);
-  },
-});
+    tree.value.getNode(key)?.expand();
+  });
+};
 
-const useStatus = (tree: Ref<InstanceType<typeof ElTree> | undefined>, editorService?: EditorService) => {
-  const node = ref<MNode>();
-  const page = computed(() => editorService?.get('page'));
-  const expandedKeys = new Map<Id, Id>();
-
-  const expandNodes = () => {
-    expandedKeys.forEach((key) => {
-      if (!tree.value) return;
-      tree.value.getNode(key)?.expand();
-    });
-  };
-
-  watchEffect(() => {
+watch(
+  () => editorService?.get('nodes'),
+  (nodes) => {
     if (!tree.value) return;
     if (!editorService) return;
-    node.value = editorService.get('node');
-
-    if (!node.value) return;
-
-    tree.value.setCurrentKey(node.value.id, true);
+    if (!nodes) return;
+    selectedNodes.value = nodes as unknown as MNode[];
 
     const parent = editorService.get('parent');
     if (!parent?.id) return;
@@ -159,114 +235,128 @@ const useStatus = (tree: Ref<InstanceType<typeof ElTree> | undefined>, editorSer
         });
       expandNodes();
     });
-  });
+  },
+);
 
-  return {
-    values: computed(() => (page.value ? [page.value] : [])),
-
-    loadItems: (node: any, resolve: Function) => {
-      if (Array.isArray(node.data)) {
-        return resolve(node.data);
-      }
-      if (Array.isArray(node.data?.items)) {
-        return resolve(node.data?.items);
-      }
-      resolve([]);
-    },
-
-    highlightNode: computed(() => editorService?.get('highlightNode')),
-    clickNode: node,
-    expandedKeys: computed(() => (node.value ? [node.value.id] : [])),
-
-    handleCollapse: (data: MNode) => {
-      expandedKeys.delete(data.id);
-    },
-
-    handleExpand: (data: MNode) => {
-      const parent = editorService?.getParentById(data.id);
-      if (!parent?.id) return;
-      expandedKeys.set(parent.id, parent.id);
-    },
-  };
+// 设置树节点选中状态
+const setTreeKeyStatus = () => {
+  if (!tree.value) return;
+  if (selectedIds.value.length === 0) {
+    tree.value.setCheckedKeys([]);
+    tree.value.setCurrentKey();
+  } else if (selectedIds.value.length === 1 && !isMultiSelectStatus.value) {
+    // 选中1个
+    tree.value.setCurrentKey(selectedIds.value[0], true);
+    tree.value.setCheckedKeys([]);
+  } else {
+    // 多选框选中多个
+    tree.value.setCheckedKeys(selectedIds.value);
+    tree.value.setCurrentKey();
+  }
 };
 
-const useFilter = (tree: Ref<InstanceType<typeof ElTree> | undefined>) => ({
-  filterText: ref(''),
-
-  filterNode: (value: string, data: MNode): boolean => {
-    if (!value) {
-      return true;
-    }
-    let name = '';
-    if (data.name) {
-      name = data.name;
-    } else if (data.items) {
-      name = 'container';
-    }
-    return `${data.id}${name}${data.type}`.indexOf(value) !== -1;
-  },
-
-  filterTextChangeHandler(val: string) {
-    tree.value?.filter(val);
-  },
+watch(selectedIds, () => {
+  setTreeKeyStatus();
 });
 
-export default defineComponent({
-  name: 'magic-editor-layer-panel',
+const keycon = ref<KeyController>();
+// 监听模式选择
+const addSelectModeListener = () => {
+  const isMac = /mac os x/.test(navigator.userAgent.toLowerCase());
+  const ctrl = isMac ? 'meta' : 'ctrl';
+  keycon.value = new KeyController();
+  keycon.value.keydown(ctrl, (e) => {
+    e.inputEvent.preventDefault();
+    isMultiSelectStatus.value = true;
+  });
+  // ctrl+tab切到其他窗口，需要将多选状态置为false
+  keycon.value.on('blur', () => {
+    isMultiSelectStatus.value = false;
+  });
+  keycon.value.keyup(ctrl, (e) => {
+    e.inputEvent.preventDefault();
+    isMultiSelectStatus.value = false;
+  });
+};
+// 移除监听
+const removeSelectModeListener = () => {
+  keycon.value?.destroy();
+  // 如果鼠标移出监听范围，且当前只选中了一个，置为单选模式(修复按住ctrl不放但鼠标移出的情况)
+  if (selectedIds.value.length === 1) isMultiSelectStatus.value = false;
+};
 
-  components: { LayerMenu },
+// 鼠标是否按下标志，用于高亮状态互斥
+const clicked = ref(false);
+// 高亮的节点
+const highlightNode = computed(() => editorService?.get('highlightNode'));
 
-  setup() {
-    const services = inject<Services>('services');
-    const tree = ref<InstanceType<typeof ElTree>>();
-    const menu = ref<InstanceType<typeof LayerMenu>>();
-    const clicked = ref(false);
-    const editorService = services?.editorService;
-    const highlightHandler = throttle((data: MNode) => {
-      highlight(data, editorService);
-    }, throttleTime);
+// 鼠标在组件树移动触发高亮
+const highlightHandler = throttle((data: MNode) => {
+  highlight(data);
+}, throttleTime);
 
-    const toggleClickFlag = () => {
-      clicked.value = !clicked.value;
-    };
+const toggleClickFlag = () => {
+  clicked.value = !clicked.value;
+};
 
-    const statusData = useStatus(tree, editorService);
-    const canHighlight = computed(
-      () => statusData.highlightNode.value?.id !== statusData.clickNode.value?.id && !clicked.value,
-    );
+// 是否满足展示高亮
+const canHighlight = (data: MNode) => {
+  if (clicked.value) return false;
+  return (
+    data.id === highlightNode?.value?.id && !selectedIds.value.includes(data.id) && spliceNodeKey.value !== data.id
+  );
+};
 
-    editorService?.on('remove', () => {
-      setTimeout(() => {
-        tree.value?.getNode(editorService.get('node').id)?.updateChildren();
-      }, 0);
-    });
-
-    return {
-      tree,
-      menu,
-      ...statusData,
-      ...useDrop(tree, editorService),
-      ...useFilter(tree),
-
-      highlightHandler,
-      toggleClickFlag,
-      canHighlight,
-
-      clickHandler(data: MNode): void {
-        if (services?.uiService.get<boolean>('uiSelectMode')) {
-          document.dispatchEvent(new CustomEvent('ui-select', { detail: data }));
-          return;
-        }
-        tree.value?.setCurrentKey(data.id);
-        select(data, editorService);
-      },
-
-      async contextmenu(event: MouseEvent, data: MNode) {
-        event.preventDefault();
-        await select(data, editorService);
-        menu.value?.show(event);
-      },
-    };
-  },
+// 监听选择模式，针对多选情况做一些处理
+watch(isMultiSelectStatus, () => {
+  // 多选模式如果已存在第一个选中的元素是页面(magic-ui-page) 剔除页面选中状态
+  if (isMultiSelectStatus.value && selectedNodes.value.length === 1 && selectedNodes.value[0].type === NodeType.PAGE) {
+    selectedNodes.value = [];
+  }
 });
+
+// 选择节点多选框
+const multiClickHandler = (data: MNode): void => {
+  if (!data?.id) {
+    throw new Error('没有id');
+  }
+
+  // 页面(magic-ui-page)不可选中
+  if (data.type === NodeType.PAGE) {
+    tree.value?.setCheckedKeys([]);
+    return;
+  }
+
+  const index = selectedNodes.value.findIndex((node) => node.id === data.id);
+  if (index !== -1) {
+    // 已经包含就移除掉
+    selectedNodes.value.splice(index, 1);
+    spliceNodeKey.value = data.id;
+  } else {
+    selectedNodes.value = [...selectedNodes.value, data];
+  }
+  tree.value?.setCheckedKeys(selectedIds.value);
+  multiSelect(selectedIds.value);
+};
+
+// 点击节点
+const clickHandler = (data: MNode): void => {
+  if (!isMultiSelectStatus.value) {
+    if (services?.uiService.get<boolean>('uiSelectMode')) {
+      document.dispatchEvent(new CustomEvent('ui-select', { detail: data }));
+      return;
+    }
+    tree.value?.setCurrentKey(data.id);
+    select(data);
+  } else {
+    multiClickHandler(data);
+  }
+};
+
+// 右键菜单
+const contextmenu = async (event: MouseEvent, data: MNode): Promise<void> => {
+  event.preventDefault();
+  await select(data);
+  menu.value?.show(event);
+};
 </script>
diff --git a/packages/stage/src/StageCore.ts b/packages/stage/src/StageCore.ts
index 248ba839..adeae495 100644
--- a/packages/stage/src/StageCore.ts
+++ b/packages/stage/src/StageCore.ts
@@ -134,6 +134,7 @@ export default class StageCore extends EventEmitter {
           this.selectedDomList.push(el);
         }
         this.multiSelect(this.selectedDomList);
+        this.emit('multiSelect', this.selectedDomList);
       });
 
     // 要先触发select，在触发update
@@ -238,9 +239,8 @@ export default class StageCore extends EventEmitter {
    */
   public async multiSelect(idOrElList: HTMLElement[] | Id[]): Promise<void> {
     this.clearSelectStatus('select');
-    const elList = await Promise.all(idOrElList.map(async (idOrEl) => await this.getTargetElement(idOrEl)));
-    this.multiDr.multiSelect(elList);
-    this.emit('multiSelect', elList);
+    this.selectedDomList = await Promise.all(idOrElList.map(async (idOrEl) => await this.getTargetElement(idOrEl)));
+    this.multiDr.multiSelect(this.selectedDomList);
   }
 
   /**