@tmagic/stage 1.0.0-beta.8 → 1.0.0-rc.10

package/src/StageMask.ts

@@ -16,6 +16,8 @@
  * limitations under the License.
  */
 
+import { throttle } from 'lodash-es';
+
 import { Mode, MouseButton, ZIndex } from './const';
 import Rule from './Rule';
 import type StageCore from './StageCore';
@@ -23,6 +25,7 @@ import type { StageMaskConfig } from './types';
 import { createDiv, getScrollParent, isFixedParent } from './util';
 
 const wrapperClassName = 'editor-mask-wrapper';
+const throttleTime = 100;
 
 const hideScrollbar = () => {
   const style = globalThis.document.createElement('style');
@@ -78,10 +81,20 @@ export default class StageMask extends Rule {
   public height = 0;
   public wrapperHeight = 0;
   public wrapperWidth = 0;
+  public maxScrollTop = 0;
+  public maxScrollLeft = 0;
+  public intersectionObserver: IntersectionObserver | null = null;
 
   private mode: Mode = Mode.ABSOLUTE;
   private pageResizeObserver: ResizeObserver | null = null;
   private wrapperResizeObserver: ResizeObserver | null = null;
+  /**
+   * 高亮事件处理函数
+   * @param event 事件对象
+   */
+  private highlightHandler = throttle((event: MouseEvent): void => {
+    this.emit('highlight', event);
+  }, throttleTime);
 
   constructor(config: StageMaskConfig) {
     const wrapper = createWrapper();
@@ -93,6 +106,8 @@ export default class StageMask extends Rule {
     this.content.addEventListener('mousedown', this.mouseDownHandler);
     this.wrapper.appendChild(this.content);
     this.content.addEventListener('wheel', this.mouseWheelHandler);
+    this.content.addEventListener('mousemove', this.highlightHandler);
+    this.content.addEventListener('mouseleave', this.mouseLeaveHandler);
   }
 
   public setMode(mode: Mode) {
@@ -118,6 +133,27 @@ export default class StageMask extends Rule {
     this.page = page;
     this.pageScrollParent = getScrollParent(page) || this.core.renderer.contentWindow?.document.documentElement || null;
     this.pageResizeObserver?.disconnect();
+    this.wrapperResizeObserver?.disconnect();
+    this.intersectionObserver?.disconnect();
+
+    if (typeof IntersectionObserver !== 'undefined') {
+      this.intersectionObserver = new IntersectionObserver(
+        (entries) => {
+          entries.forEach((entry) => {
+            const { target, intersectionRatio } = entry;
+            if (intersectionRatio <= 0) {
+              this.scrollIntoView(target);
+            }
+            this.intersectionObserver?.unobserve(target);
+          });
+        },
+        {
+          root: this.pageScrollParent,
+          rootMargin: '0px',
+          threshold: 1.0,
+        },
+      );
+    }
 
     if (typeof ResizeObserver !== 'undefined') {
       this.pageResizeObserver = new ResizeObserver((entries) => {
@@ -125,6 +161,11 @@ export default class StageMask extends Rule {
         const { clientHeight, clientWidth } = entry.target;
         this.setHeight(clientHeight);
         this.setWidth(clientWidth);
+
+        this.scroll();
+        if (this.core.dr.moveable) {
+          this.core.dr.updateMoveable();
+        }
       });
 
       this.pageResizeObserver.observe(page);
@@ -134,6 +175,8 @@ export default class StageMask extends Rule {
         const { clientHeight, clientWidth } = entry.target;
         this.wrapperHeight = clientHeight;
         this.wrapperWidth = clientWidth;
+        this.setMaxScrollLeft();
+        this.setMaxScrollTop();
       });
       this.wrapperResizeObserver.observe(this.wrapper);
     }
@@ -153,6 +196,14 @@ export default class StageMask extends Rule {
     this.setMode(isFixedParent(el) ? Mode.FIXED : Mode.ABSOLUTE);
   }
 
+  public scrollIntoView(el: Element): void {
+    el.scrollIntoView();
+    if (!this.pageScrollParent) return;
+    this.scrollLeft = this.pageScrollParent.scrollLeft;
+    this.scrollTop = this.pageScrollParent.scrollTop;
+    this.scroll();
+  }
+
   /**
    * 销毁实例
    */
@@ -162,12 +213,23 @@ export default class StageMask extends Rule {
     this.pageScrollParent = null;
     this.pageResizeObserver?.disconnect();
     this.wrapperResizeObserver?.disconnect();
+
+    this.content.removeEventListener('mouseleave', this.mouseLeaveHandler);
     super.destroy();
   }
 
   private scroll() {
+    this.fixScrollValue();
+
     let { scrollLeft, scrollTop } = this;
 
+    if (this.pageScrollParent) {
+      this.pageScrollParent.scrollTo({
+        top: scrollTop,
+        left: scrollLeft,
+      });
+    }
+
     if (this.mode === Mode.FIXED) {
       scrollLeft = 0;
       scrollTop = 0;
@@ -187,6 +249,7 @@ export default class StageMask extends Rule {
    */
   private setHeight(height: number): void {
     this.height = height;
+    this.setMaxScrollTop();
     this.content.style.height = `${height}px`;
   }
 
@@ -196,14 +259,42 @@ export default class StageMask extends Rule {
    */
   private setWidth(width: number): void {
     this.width = width;
+    this.setMaxScrollLeft();
     this.content.style.width = `${width}px`;
   }
 
+  /**
+   * 计算并设置最大滚动宽度
+   */
+  private setMaxScrollLeft(): void {
+    this.maxScrollLeft = Math.max(this.width - this.wrapperWidth, 0);
+  }
+
+  /**
+   * 计算并设置最大滚动高度
+   */
+  private setMaxScrollTop(): void {
+    this.maxScrollTop = Math.max(this.height - this.wrapperHeight, 0);
+  }
+
+  /**
+   * 修复滚动距离
+   * 由于滚动容器变化等因素，会导致当前滚动的距离不正确
+   */
+  private fixScrollValue(): void {
+    if (this.scrollTop < 0) this.scrollTop = 0;
+    if (this.scrollLeft < 0) this.scrollLeft = 0;
+    if (this.maxScrollTop < this.scrollTop) this.scrollTop = this.maxScrollTop;
+    if (this.maxScrollLeft < this.scrollLeft) this.scrollLeft = this.maxScrollLeft;
+  }
+
   /**
    * 点击事件处理函数
    * @param event 事件对象
    */
-  private mouseDownHandler = async (event: MouseEvent): Promise<void> => {
+  private mouseDownHandler = (event: MouseEvent): void => {
+    this.emit('clearHighlight');
+
     event.stopImmediatePropagation();
     event.stopPropagation();
 
@@ -214,6 +305,8 @@ export default class StageMask extends Rule {
       return;
     }
 
+    this.content.removeEventListener('mousemove', this.highlightHandler);
+
     this.emit('beforeSelect', event);
 
     // 如果是右键点击，这里的mouseup事件监听没有效果
@@ -222,46 +315,33 @@ export default class StageMask extends Rule {
 
   private mouseUpHandler = (): void => {
     globalThis.document.removeEventListener('mouseup', this.mouseUpHandler);
+    this.content.addEventListener('mousemove', this.highlightHandler);
     this.emit('select');
   };
 
   private mouseWheelHandler = (event: WheelEvent) => {
+    this.emit('clearHighlight');
     if (!this.page) throw new Error('page 未初始化');
 
     const { deltaY, deltaX } = event;
-    const { height, wrapperHeight, width, wrapperWidth } = this;
-
-    const maxScrollTop = height - wrapperHeight;
-    const maxScrollLeft = width - wrapperWidth;
 
-    if (maxScrollTop > 0) {
-      if (deltaY > 0) {
-        this.scrollTop = this.scrollTop + Math.min(maxScrollTop - this.scrollTop, deltaY);
-      } else {
-        this.scrollTop = Math.max(this.scrollTop + deltaY, 0);
-      }
-    }
+    if (this.page.clientHeight < this.wrapperHeight && deltaY) return;
+    if (this.page.clientWidth < this.wrapperWidth && deltaX) return;
 
-    if (width > wrapperWidth) {
-      if (deltaX > 0) {
-        this.scrollLeft = this.scrollLeft + Math.min(maxScrollLeft - this.scrollLeft, deltaX);
-      } else {
-        this.scrollLeft = Math.max(this.scrollLeft + deltaX, 0);
-      }
+    if (this.maxScrollTop > 0) {
+      this.scrollTop = this.scrollTop + deltaY;
     }
 
-    if (this.mode !== Mode.FIXED) {
-      this.scrollTo(this.scrollLeft, this.scrollTop);
+    if (this.maxScrollLeft > 0) {
+      this.scrollLeft = this.scrollLeft + deltaX;
     }
 
-    if (this.pageScrollParent) {
-      this.pageScrollParent.scrollTo({
-        top: this.scrollTop,
-        left: this.scrollLeft,
-      });
-    }
     this.scroll();
 
     this.emit('scroll', event);
   };
+
+  private mouseLeaveHandler = () => {
+    setTimeout(() => this.emit('clearHighlight'), throttleTime);
+  };
 }

package/src/StageRender.ts

@@ -114,6 +114,7 @@ export default class StageRender extends EventEmitter {
 
   private loadHandler = async () => {
     this.emit('onload');
+
     if (this.render) {
       const el = await this.render(this.core);
       if (el) {

package/src/TargetCalibrate.ts

@@ -0,0 +1,119 @@
+/*
+ * Tencent is pleased to support the open source community by making TMagicEditor available.
+ *
+ * Copyright (C) 2021 THL A29 Limited, a Tencent company.  All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* eslint-disable no-param-reassign */
+import { EventEmitter } from 'events';
+
+import { Mode } from './const';
+import StageCore from './StageCore';
+import StageDragResize from './StageDragResize';
+import StageMask from './StageMask';
+import type { Offset, TargetCalibrateConfig } from './types';
+import { getMode } from './util';
+
+/**
+ * 将选中的节点修正定位后，添加一个操作节点到蒙层上
+ */
+export default class TargetCalibrate extends EventEmitter {
+  public parent: HTMLElement;
+  public mask: StageMask;
+  public dr: StageDragResize;
+  public core: StageCore;
+  public operationEl: HTMLDivElement;
+
+  constructor(config: TargetCalibrateConfig) {
+    super();
+
+    this.parent = config.parent;
+    this.mask = config.mask;
+    this.dr = config.dr;
+    this.core = config.core;
+
+    this.operationEl = globalThis.document.createElement('div');
+    this.parent.append(this.operationEl);
+  }
+
+  public update(el: HTMLElement, prefix: String): HTMLElement {
+    const { left, top } = this.getOffset(el);
+    const { transform } = getComputedStyle(el);
+    this.operationEl.style.cssText = `
+      position: absolute;
+      transform: ${transform};
+      left: ${left}px;
+      top: ${top}px;
+      width: ${el.clientWidth}px;
+      height: ${el.clientHeight}px;
+    `;
+
+    this.operationEl.id = `${prefix}${el.id}`;
+
+    if (typeof this.core.config.updateDragEl === 'function') {
+      this.core.config.updateDragEl(this.operationEl, el);
+    }
+
+    return this.operationEl;
+  }
+
+  public destroy(): void {
+    this.operationEl?.remove();
+  }
+
+  private getOffset(el: HTMLElement): Offset {
+    const { offsetParent } = el;
+
+    const left = el.offsetLeft;
+    const top = el.offsetTop;
+
+    if (offsetParent) {
+      const parentOffset = this.getOffset(offsetParent as HTMLElement);
+      return {
+        left: left + parentOffset.left,
+        top: top + parentOffset.top,
+      };
+    }
+
+    // 选中固定定位元素后editor-mask高度被置为视窗大小
+    if (this.dr.mode === Mode.FIXED) {
+      // 弹窗的情况
+      if (getMode(el) === Mode.FIXED) {
+        return {
+          left,
+          top,
+        };
+      }
+
+      return {
+        left: left - this.mask.scrollLeft,
+        top: top - this.mask.scrollTop,
+      };
+    }
+
+    // 无父元素的固定定位需按滚动值计算
+    if (getMode(el) === Mode.FIXED) {
+      return {
+        left: left + this.mask.scrollLeft,
+        top: top + this.mask.scrollTop,
+      };
+    }
+
+    return {
+      left,
+      top,
+    };
+  }
+}

package/src/const.ts

@@ -16,29 +16,58 @@
  * limitations under the License.
  */
 
-// 流式布局下拖动时需要clone一个镜像节点，镜像节点的id前缀
+/** 流式布局下拖动时需要clone一个镜像节点，镜像节点的id前缀 */
 export const GHOST_EL_ID_PREFIX = 'ghost_el_';
 
-// 默认放到缩小倍数
+/** 拖动的时候需要在蒙层中创建一个占位节点，该节点的id前缀 */
+export const DRAG_EL_ID_PREFIX = 'drag_el_';
+
+/** 高亮事需要在蒙层中创建一个占位节点，该节点的id前缀 */
+export const HIGHLIGHT_EL_ID_PREFIX = 'highlight_el_';
+
+/** 默认放到缩小倍数 */
 export const DEFAULT_ZOOM = 1;
 
+/** 参考线类型 */
 export enum GuidesType {
+  /** 水平 */
   HORIZONTAL = 'horizontal',
+  /** 垂直 */
   VERTICAL = 'vertical',
 }
 
+/** css z-index */
 export enum ZIndex {
+  /** 蒙层，用于监听用户操作，需要置于顶层 */
   MASK = '99999',
+  /** 选中的节点 */
+  SELECTED_EL = '666',
+  GHOST_EL = '700',
+  DRAG_EL = '9',
 }
 
+/** 鼠标按键 */
 export enum MouseButton {
+  /** 左键 */
   LEFT = 0,
+  /** z中健 */
   MIDDLE = 1,
+  /** 右键 */
   RIGHT = 2,
 }
 
+/** 布局方式 */
 export enum Mode {
+  /** 绝对定位布局 */
   ABSOLUTE = 'absolute',
+  /** 固定定位布局 */
   FIXED = 'fixed',
+  /** 流式布局 */
   SORTABLE = 'sortable',
 }
+
+/** 选中节点的class name */
+export const SELECTED_CLASS = 'tmagic-stage-selected-area';
+
+export const H_GUIDE_LINE_STORAGE_KEY = '$MagicStageHorizontalGuidelinesData';
+export const V_GUIDE_LINE_STORAGE_KEY = '$MagicStageVerticalGuidelinesData';

package/src/types.ts

@@ -16,14 +16,17 @@
  * limitations under the License.
  */
 
-import { MoveableOptions } from 'react-moveable/declaration/types';
+import { MoveableOptions } from 'moveable';
 
+import Core from '@tmagic/core';
 import { Id, MApp, MNode } from '@tmagic/schema';
 
 import { GuidesType } from './const';
 import StageCore from './StageCore';
+import StageDragResize from './StageDragResize';
+import StageMask from './StageMask';
 
-export type CanSelect = (el: HTMLElement, stop: () => boolean) => boolean | Promise<boolean>;
+export type CanSelect = (el: HTMLElement, event: MouseEvent, stop: () => boolean) => boolean | Promise<boolean>;
 
 export type StageCoreConfig = {
   /** 需要对齐的dom节点的CSS选择器字符串 */
@@ -35,6 +38,8 @@ export type StageCoreConfig = {
   /** runtime 的HTML地址，可以是一个HTTP地址，如果和编辑器不同域，需要设置跨域，也可以是一个相对或绝对路径 */
   runtimeUrl?: string;
   render?: (renderer: StageCore) => Promise<HTMLElement> | HTMLElement;
+  autoScrollIntoView?: boolean;
+  updateDragEl?: (el: HTMLDivElement, target: HTMLElement) => void;
 };
 
 export interface StageRenderConfig {
@@ -69,10 +74,14 @@ export interface UpdateEventData {
   el: HTMLElement;
   ghostEl: HTMLElement;
   style: {
-    width: number;
-    height: number;
+    width?: number;
+    height?: number;
     left?: number;
     top?: number;
+    transform?: {
+      rotate?: string;
+      scale?: string;
+    };
   };
 }
 
@@ -93,8 +102,9 @@ export interface RemoveData {
 }
 
 export interface Runtime {
+  getApp?: () => Core;
   beforeSelect?: (el: HTMLElement) => Promise<boolean> | boolean;
-  getSnapElements?: (el: HTMLElement) => HTMLElement[];
+  getSnapElements?: (el?: HTMLElement) => HTMLElement[];
   updateRootConfig: (config: MApp) => void;
   updatePageId?: (id: Id) => void;
   select?: (id: Id) => Promise<HTMLElement> | HTMLElement;
@@ -114,3 +124,15 @@ export interface Magic {
 export interface RuntimeWindow extends Window {
   magic: Magic;
 }
+
+export interface StageHighlightConfig {
+  core: StageCore;
+  container: HTMLElement;
+}
+
+export interface TargetCalibrateConfig {
+  parent: HTMLElement;
+  mask: StageMask;
+  dr: StageDragResize;
+  core: StageCore;
+}

package/src/util.ts

@@ -16,39 +16,24 @@
  * limitations under the License.
  */
 
-import { Mode } from './const';
+import { GuidesType, H_GUIDE_LINE_STORAGE_KEY, Mode, SELECTED_CLASS, V_GUIDE_LINE_STORAGE_KEY } from './const';
 import type { Offset } from './types';
 
+const getParents = (el: Element, relative: Element) => {
+  let cur: Element | null = el.parentElement;
+  const parents: Element[] = [];
+  while (cur && cur !== relative) {
+    parents.push(cur);
+    cur = cur.parentElement;
+  }
+  return parents;
+};
+
 export const getOffset = (el: HTMLElement): Offset => {
-  const { transform } = getComputedStyle(el);
   const { offsetParent } = el;
 
-  let left = el.offsetLeft;
-  let top = el.offsetTop;
-
-  if (transform.indexOf('matrix') > -1) {
-    let a = 1;
-    let b = 1;
-    let c = 1;
-    let d = 1;
-    let e = 0;
-    let f = 0;
-    transform.replace(
-      /matrix\((.+), (.+), (.+), (.+), (.+), (.+)\)/,
-      ($0: string, $1: string, $2: string, $3: string, $4: string, $5: string, $6: string): string => {
-        a = +$1;
-        b = +$2;
-        c = +$3;
-        d = +$4;
-        e = +$5;
-        f = +$6;
-        return transform;
-      },
-    );
-
-    left = a * left + c * top + e;
-    top = b * left + d * top + f;
-  }
+  const left = el.offsetLeft;
+  const top = el.offsetTop;
 
   if (offsetParent) {
     const parentOffset = getOffset(offsetParent as HTMLElement);
@@ -154,3 +139,43 @@ export const createDiv = ({ className, cssText }: { className: string; cssText:
   el.style.cssText = cssText;
   return el;
 };
+
+export const removeSelectedClassName = (doc: Document) => {
+  const oldEl = doc.querySelector(`.${SELECTED_CLASS}`);
+
+  if (oldEl) {
+    oldEl.classList.remove(SELECTED_CLASS);
+    (oldEl.parentNode as HTMLDivElement)?.classList.remove(`${SELECTED_CLASS}-parent`);
+    doc.querySelectorAll(`.${SELECTED_CLASS}-parents`).forEach((item) => {
+      item.classList.remove(`${SELECTED_CLASS}-parents`);
+    });
+  }
+};
+
+export const addSelectedClassName = (el: Element, doc: Document) => {
+  el.classList.add(SELECTED_CLASS);
+  (el.parentNode as Element)?.classList.add(`${SELECTED_CLASS}-parent`);
+  getParents(el, doc.body).forEach((item) => {
+    item.classList.add(`${SELECTED_CLASS}-parents`);
+  });
+};
+
+export const getGuideLineFromCache = (type: GuidesType): number[] => {
+  const key = {
+    [GuidesType.HORIZONTAL]: H_GUIDE_LINE_STORAGE_KEY,
+    [GuidesType.VERTICAL]: V_GUIDE_LINE_STORAGE_KEY,
+  }[type];
+
+  if (!key) return [];
+
+  const guideLineCacheData = globalThis.localStorage.getItem(key);
+  if (guideLineCacheData) {
+    try {
+      return JSON.parse(guideLineCacheData) || [];
+    } catch (e) {
+      console.error(e);
+    }
+  }
+
+  return [];
+};