plain-design 1.0.0-beta.8 → 1.0.0-beta.80

package/src/packages/components/VirtualList/createVirtualDraggier.ts

@@ -0,0 +1,412 @@
+import {iElementRect} from "../../utils/getRowEl";
+import {getComponentCls, iMouseEvent, iTouchEvent, reactive, SimpleFunction, StyleProperties} from "plain-design-composition";
+import {doNothing} from "plain-utils/utils/doNothing";
+import {defer, DFD} from "plain-utils/utils/defer";
+import {findParentElement} from "plain-utils/dom/findParentElement";
+import {hasClass} from "plain-utils/dom/hasClass";
+import {getElementRect} from "../../utils/getElementRect";
+import {notNull} from "plain-utils/utils/notNull";
+import {createWebDraggier, iDraggierData} from "../../utils/createDraggier";
+import {delay} from "plain-utils/utils/delay";
+import {PlainScroll} from "../Scroll";
+import {iVirtualList} from "./useVirtualList";
+
+/**
+ * 创建虚拟列表的拖拽移动节点管理对象
+ * @author  韦胜健
+ * @date    2024/5/29 14:55
+ */
+export function createVirtualDraggier(
+  {
+    props,
+    getVirtual,
+    getScroll,
+    dataModel,
+    onDraggierStart,
+    onDraggierMove,
+    onDraggierEnd,
+    onDraggierTap,
+  }: {
+    props: { horizontal: boolean },
+    getVirtual: () => iVirtualList,
+    getScroll: () => PlainScroll | undefined,
+    dataModel: { value: any[] | undefined | null },
+
+    onDraggierStart?: iVirtualDraggierHandler,
+    onDraggierMove?: iVirtualDraggierHandler,
+    onDraggierEnd?: iVirtualDraggierHandler,
+    onDraggierTap?: iVirtualDraggierHandler,
+  }
+) {
+
+  /*管理自动滚动*/
+  const autoScrollManager = (() => {
+    const _state = { value: null as null | 'top' | 'bottom' | 'left' | 'right' };
+
+    const handler = {
+      top: () => {
+        getScroll()?.methods.autoScrollTop();
+      },
+      bottom: () => {
+        getScroll()?.methods.autoScrollBottom();
+      },
+      left: () => {
+        getScroll()?.methods.autoScrollLeft();
+      },
+      right: () => {
+        getScroll()?.methods.autoScrollRight();
+      },
+      stop: () => {
+        getScroll()?.methods.stopAutoScroll();
+      },
+    };
+
+    const set = (val: null | 'top' | 'bottom' | 'left' | 'right') => {
+      const newVal = val;
+      const oldVal = _state.value;
+      if (newVal == oldVal) {
+        return;
+      }
+      _state.value = val;
+
+      if (!oldVal && !!newVal) {
+        handler[newVal]();
+      } else {
+        handler.stop();
+      }
+    };
+    const get = () => _state.value;
+    const stop = () => getScroll()?.methods.stopAutoScroll();
+    return { get, set, stop };
+  })();
+
+  /*静态变量*/
+  const dragStaticState = createDefaultDraggierStaticState();
+
+  /*响应式变量*/
+  const dragReactiveState = reactive(createDefaultDraggierReactiveState());
+
+  const start = (e: iMouseEvent | iTouchEvent) => {
+
+    /*重置静态变量*/
+    Object.assign(dragReactiveState, createDefaultDraggierReactiveState());
+    /*重置响应式变量*/
+    Object.assign(dragReactiveState, createDefaultDraggierStaticState());
+
+    /*初始化部分静态变量*/
+    dragStaticState.dragElement = findParentElement(e.currentTarget as any, el => el.hasAttribute('data-vid'), true) as HTMLDivElement;
+    if (!dragStaticState.dragElement) {
+      throw new Error(`Can't find [data-vid] elements!`);
+    }
+    dragStaticState.hostElement = findParentElement(dragStaticState.dragElement, el => hasClass(el, getComponentCls('virtual-list')))!;
+    if (!dragStaticState.hostElement) {
+      throw new Error(`Can't find host elements`);
+    }
+    dragStaticState.strutElement = findParentElement(dragStaticState.dragElement, el => hasClass(el, 'virtual-list-strut'))!;
+    if (!dragStaticState.strutElement) {
+      throw new Error(`Can't find strut elements`);
+    }
+
+    dragStaticState.initDragElementRect = getElementRect(dragStaticState.dragElement);
+    dragStaticState.dragElementVid = dragStaticState.dragElement.dataset.vid || '';
+    dragStaticState.dragIndex = notNull(getVirtual().nodes.value.find(i => i.id == dragStaticState.dragElementVid)?.index, -1);
+    if (dragStaticState.dragIndex == -1) {
+      throw new Error(`Can't find index of drag elements`);
+    }
+
+    draggier.start(e);
+  };
+
+  const update = () => {
+
+    const { dragElement, dragElementVid, oldDragElementStyles, strutElement } = dragStaticState;
+
+    if (dragElement.dataset.vid !== dragElementVid) {
+      /*节点复用，应该恢复显示这个节点*/
+      dragElement.style.opacity = oldDragElementStyles.opacity;
+    } else {
+      /*节点的标识不变，继续隐藏*/
+      dragElement.style.opacity = '0';
+    }
+
+    const offsetStart = props.horizontal ?
+      draggier.staticState.moveX - getElementRect(strutElement!).left :
+      draggier.staticState.moveY - getElementRect(strutElement!).top;
+
+    const newPointIndex = getVirtual().nodes.value.findIndex(node => node.start <= offsetStart && node.end > offsetStart);
+    // console.log({ newPointIndex });
+    /*值有效的时候才更新值，新值无效的话，就用老的值，因为如果超出边界的话就会得到无效的新值，此时用老值即可*/
+    if (newPointIndex != null && newPointIndex != -1) {
+      dragReactiveState.pointIndex = newPointIndex || 0;
+    }
+  };
+
+  const getItemStyles = (index: number) => {
+    const { dragIndex, initDragElementRect } = dragStaticState;
+    if (dragReactiveState.pointIndex == null || dragIndex == null) {
+      return;
+    }
+    const styles: StyleProperties = {};
+    styles.transition = 'transform ease 300ms';
+    if (dragReactiveState.pointIndex >= index && index > dragIndex) {
+      styles.transform = props.horizontal ?
+        `translateX(-${initDragElementRect?.width || 0}px)` :
+        `translateY(-${initDragElementRect?.height || 0}px)`;
+    } else if (dragReactiveState.pointIndex <= index && index < dragIndex) {
+      styles.transform = props.horizontal ?
+        `translateX(${initDragElementRect?.width || 0}px)` :
+        `translateY(${initDragElementRect?.height || 0}px)`;
+    } else {
+      styles.transform = props.horizontal ?
+        `translateX(0px)` :
+        `translateY(0px)`;
+    }
+    return styles;
+  };
+
+  const draggier = createWebDraggier({
+    horizontal: props.horizontal,
+    vertical: !props.horizontal,
+    onInit: () => {
+    },
+    onStart: (draggierData) => {
+
+      const { draggierEffects } = draggierData;
+
+      const { dragElement, initDragElementRect, hostElement } = dragStaticState;
+
+      if (!dragElement || !initDragElementRect || !hostElement) {
+        return;
+      }
+
+      const dragElementShadow = dragStaticState.dragElementShadow = dragElement.cloneNode(true) as any;
+
+      if (!dragElementShadow) {
+        return;
+      }
+
+      /*强制启用动画，避免被Scroll禁用*/
+      dragElementShadow.setAttribute('data-force-transition', 'true');
+      dragElementShadow.style.height = initDragElementRect.height + 'px';
+      dragElementShadow.style.width = initDragElementRect.width + 'px';
+      dragElementShadow.style.position = 'fixed';
+      dragElementShadow.style.top = initDragElementRect.top + 'px';
+      dragElementShadow.style.left = initDragElementRect.left + 'px';
+      dragElementShadow.style.pointerEvents = 'none';
+      dragElementShadow.style.transition = 'none';
+
+      /*添加克隆节点*/
+      hostElement.appendChild(dragElementShadow);
+      draggierEffects.push(async () => {
+        if (!dragElementShadow || !hostElement) {
+          return;
+        }
+        await dragReactiveState.endingDefer.promise;
+        await delay(23);
+        hostElement.removeChild(dragElementShadow);
+        dragStaticState.dragElementShadow = null as any;
+      });
+
+      /*隐藏原始对象*/
+      dragStaticState.oldDragElementStyles.opacity = dragElement.style.opacity;
+      dragElement.style.opacity = "0";
+      draggierEffects.push(async () => {
+        if (!dragElement) {
+          return;
+        }
+        await dragReactiveState.endingDefer.promise;
+        dragElement.style.opacity = dragStaticState.oldDragElementStyles.opacity;
+        dragStaticState.dragElement = null as any;
+      });
+
+      /*监听滚动*/
+      dragReactiveState.onScroll = (e: Event) => {
+        update();
+      };
+      draggierEffects.push(() => dragReactiveState.onScroll = doNothing);
+
+      /*拖拽结束的时候停止自动滚动*/
+      draggierEffects.push(() => getScroll()?.methods.stopAutoScroll());
+      draggierEffects.push(async () => {
+        await dragReactiveState.endingDefer.promise;
+        dragReactiveState.pointIndex = null;
+      });
+
+      /*标记拖拽中响应式变量*/
+      dragReactiveState.isDragging = true;
+      draggierEffects.push(async () => {
+        await dragReactiveState.endingDefer.promise;
+        dragReactiveState.isDragging = false;
+      });
+
+      /*操作结束之后的更新数据动作*/
+      draggierEffects.push(async () => {
+        const { strutElement, dragIndex } = dragStaticState;
+        const virtual = getVirtual();
+        if (!initDragElementRect || dragReactiveState.pointIndex == null || !virtual || !dragElementShadow || !strutElement || dragIndex == null) {
+          return;
+        }
+        // console.log('==>>', dragReactiveState.pointIndex);
+        const pointNode = virtual.nodes.value[dragReactiveState.pointIndex];
+        // console.log(pointNode, dragElementShadow);
+        const afterTransition = () => {
+          if (dragReactiveState && dragReactiveState.pointIndex != null && dragIndex != null && dragReactiveState.pointIndex != dragIndex) {
+            const insertIndex = dragReactiveState.pointIndex;
+            const newList = [...dataModel.value || []];
+            const spliceArr = newList.splice(dragIndex, 1);
+            newList.splice(insertIndex, 0, ...spliceArr);
+            dataModel.value = (newList);
+          }
+          dragReactiveState.endingDefer.resolve();
+        };
+
+        const newStart = Math.ceil(
+          (() => {
+            if (props.horizontal) {
+              return dragReactiveState.pointIndex < dragIndex ?
+                (getElementRect(strutElement).left + pointNode.start) :
+                (getElementRect(strutElement).left + pointNode.end - initDragElementRect.width);
+            } else {
+              return dragReactiveState.pointIndex < dragIndex ?
+                (getElementRect(strutElement).top + pointNode.start) :
+                (getElementRect(strutElement).top + pointNode.end - initDragElementRect.height);
+            }
+          })()
+        ) + 'px';
+
+        const styleName = props.horizontal ? 'left' : 'top';
+        if (dragElementShadow.style[styleName] == newStart) {
+          /*位置没有变化，直接更新数据，因为值没有变化，导致就算复制也不会触发transition动画*/
+          afterTransition();
+        } else {
+          /*位置有变化，等transition动画结束之后再更新数据*/
+          dragElementShadow.style.transition = 'all ease 300ms';
+          dragElementShadow.addEventListener('transitionend', async () => {
+            afterTransition();
+          });
+        }
+        dragElementShadow.style[styleName] = newStart;
+      });
+
+      onDraggierStart?.({ ...draggierData, dragStaticState, dragReactiveState });
+    },
+    onMove: (draggierData) => {
+
+      const { staticState } = draggierData;
+
+      const { dragElementShadow, initDragElementRect, hostElement, strutElement } = dragStaticState;
+
+      if (!dragElementShadow || !initDragElementRect || !hostElement || !strutElement) {
+        return;
+      }
+
+      const strutRect = getElementRect(strutElement);
+      const hostRect = getElementRect(hostElement);
+
+      const newStart = props.horizontal ?
+        initDragElementRect.left + staticState.durX :
+        initDragElementRect.top + staticState.durY;
+      const minStart = props.horizontal ?
+        getElementRect(hostElement).left :
+        getElementRect(hostElement).top;
+      const maxStart1 = props.horizontal ?
+        strutRect.left + strutRect.width - initDragElementRect.width :
+        strutRect.top + strutRect.height - initDragElementRect.height;
+      const maxStart2 = props.horizontal ?
+        hostRect.left + hostRect.width - initDragElementRect.width :
+        hostRect.top + hostRect.height - initDragElementRect.height;
+      const maxStart = Math.min(maxStart1, maxStart2);
+
+      const resultStart = Math.max(minStart, Math.min(maxStart, newStart));
+
+      if (resultStart == minStart) {
+        autoScrollManager.set(props.horizontal ? 'left' : 'top');
+      } else if (resultStart == maxStart) {
+        autoScrollManager.set(props.horizontal ? 'right' : 'bottom');
+      } else {
+        autoScrollManager.set(null);
+      }
+
+      const styleName = props.horizontal ? 'left' : 'top';
+      dragElementShadow.style[styleName] = resultStart + 'px';
+
+      update();
+
+      onDraggierMove?.({ ...draggierData, dragStaticState, dragReactiveState });
+    },
+    onEnd: (draggierData) => {
+      onDraggierEnd?.({ ...draggierData, dragStaticState, dragReactiveState });
+    },
+    onTap: (draggierData) => {
+      onDraggierTap?.({ ...draggierData, dragStaticState, dragReactiveState });
+    },
+  });
+
+  const emitScroll = (e: any) => {
+    dragReactiveState.onScroll(e);
+  };
+
+  return {
+    dragStaticState,
+    dragReactiveState,
+    start,
+    getItemStyles,
+    emitScroll,
+  };
+}
+
+export interface iDraggierStaticState {
+  /*拖拽节点在所有数据中的索引*/
+  dragIndex: number;
+  /*拖拽元素的节点的 data-vid 标识字符*/
+  dragElementVid: string;
+  /*拖拽元素的dom对象*/
+  dragElement: HTMLElement;
+  /*拖拽元素的拖拽开始时的定位信息*/
+  initDragElementRect: iElementRect;
+  /*拖拽元素的旧的行内样式*/
+  oldDragElementStyles: StyleProperties;
+  /*拖拽元素的克隆元素*/
+  dragElementShadow: HTMLElement;
+  /*宿主滚动容器节点*/
+  hostElement: HTMLElement;
+  /*虚拟滚动strut滚动容器节点*/
+  strutElement: HTMLElement;
+}
+
+export interface iDraggierReactiveState {
+  pointIndex: number | null,
+  onScroll: SimpleFunction,
+  isDragging: boolean,
+  endingDefer: DFD<void>,
+}
+
+export function createDefaultDraggierReactiveState(): iDraggierReactiveState {
+  return {
+    pointIndex: null,
+    onScroll: doNothing,
+    isDragging: false,
+    endingDefer: defer(),
+  };
+}
+
+export function createDefaultDraggierStaticState(): iDraggierStaticState {
+  const fakeEle = null as any;
+  return {
+    dragIndex: -1,
+    dragElementVid: '',
+    dragElement: fakeEle,
+    initDragElementRect: { top: 0, left: 0, right: 0, bottom: 0, height: 0, width: 0 },
+    oldDragElementStyles: {},
+    dragElementShadow: fakeEle,
+    hostElement: fakeEle,
+    strutElement: fakeEle,
+  };
+}
+
+export interface iVirtualDraggierData extends iDraggierData {
+  dragStaticState: iDraggierStaticState,
+  dragReactiveState: iDraggierReactiveState,
+}
+
+export type iVirtualDraggierHandler = (data: iVirtualDraggierData) => void

package/src/packages/components/VirtualList/index.tsx

@@ -1,63 +1,109 @@
-import './virtual-list.scss';
-import {designComponent, useRefs} from "plain-design-composition";
-import Scroll from "../Scroll";
-import {useVirtualList} from "./useVirtualList";
-
-export const VirtualList = designComponent({
-  name: 'virtual-list',
-  inheritPropsType: Scroll,
-  props: {
-    data: { type: Array, require: true, default: [] },            // 要渲染的长数据
-    size: { type: Number, require: true, default: 40 },           // 每一行高度
-    dynamicSize: { type: Boolean },                               // 标识列表中的每一行高度不是固定的，但是还是需要提供 size 属性，而且size属性不能与每一行的高度差距太多；
-    disabled: { type: Boolean },                                  // 禁用虚拟滚动
-    width: { type: [String, Number] },                            // 当需要横向滚动是，需要指定内容宽度
-  },
-  emits: {
-    onScroll: (e: Event) => true,
-    onRefScroll: (scroll: typeof Scroll.use.class | null) => true,
-    onPageIndexChange: (data: { pageIndex: number, start: number }) => true,
-  },
-  scopeSlots: {
-    default: (scope: { item: any, index: number, virtualIndex: number }) => {},
-    content: (scope: { data: any[] }) => {},
-  },
-  setup({ props, scopeSlots, event: { emit } }) {
-
-    const { refs, onRef } = useRefs({
-      scroll: Scroll,
-      content: HTMLDivElement,
-    });
-
-    const { virtual } = useVirtualList({ refs, props, emit, });
-
-    const onRefScroll = (scroll: typeof Scroll.use.class | null) => {
-      onRef.scroll(scroll);
-      emit.onRefScroll(scroll);
-    };
-
-    return {
-      refer: {
-        refs,
-      },
-      render: () => {
-        const { list } = virtual.offsetData.value;
-        return (
-          <Scroll scrollX={!!props.width} onScroll={virtual.handler.onScroll} ref={onRefScroll as any} className={virtual.classes.value} disableTransitionWhenScroll>
-            <div className="virtual-list-strut" style={virtual.strutStyles.value}>
-              <div className="virtual-list-content" style={virtual.contentStyles.value} ref={onRef.content}>
-                {scopeSlots.content.isExist() ?
-                  scopeSlots.content({ data: list }, null) :
-                  list.map((node, virtualIndex) =>
-                    scopeSlots.default({ item: node.item, index: node.index, virtualIndex })
-                  )}
-              </div>
-            </div>
-          </Scroll>
-        );
-      }
-    };
-  },
-});
-
-export default VirtualList;
+import './virtual-list.scss';
+import {computed, designComponent, iMouseEvent, iTouchEvent, onBeforeUnmount, useModel, useRefs} from "plain-design-composition";
+import Scroll from "../Scroll";
+import {useVirtualList} from "./useVirtualList";
+import {createVirtualDraggier, iVirtualDraggierData} from "./createVirtualDraggier";
+
+export const VirtualList = designComponent({
+  name: 'virtual-list',
+  inheritPropsType: Scroll,
+  props: {
+    data: { type: Array, require: true, default: [] },            // 要渲染的长数据
+    size: { type: Number, require: true, default: 40 },           // 每一行高度
+    dynamicSize: { type: Boolean },                               // 标识列表中的每一行高度不是固定的，但是还是需要提供 size 属性，而且size属性不能与每一行的高度差距太多；
+    disabled: { type: Boolean },                                  // 禁用虚拟滚动
+    horizontal: { type: Boolean },                                // 启用横向虚拟滚动
+    width: { type: [String, Number] },                            // 纵向虚拟滚动需要横向滚动时，需要指定内容宽度
+    height: { type: [String, Number] },                           // 横向虚拟滚动需要纵向滚动时，需要指定内容高度
+    draggable: { type: Boolean },                                 // 可拖拽
+  },
+  emits: {
+    onUpdateData: (data: any[] | undefined) => true,
+    onScroll: (e: Event) => true,
+    onRefScroll: (scroll: typeof Scroll.use.class | null) => true,
+    onPageIndexChange: (data: { pageIndex: number, startIndex: number, endIndex: number }) => true,
+    onDraggierStart: (virtualDraggierData: iVirtualDraggierData) => true,
+    onDraggierMove: (virtualDraggierData: iVirtualDraggierData) => true,
+    onDraggierEnd: (virtualDraggierData: iVirtualDraggierData) => true,
+    onDraggierTap: (virtualDraggierData: iVirtualDraggierData & { index: number, data: any }) => true,
+  },
+  scopeSlots: {
+    default: (scope: { item: any, index: number, vid: string, vIndex: number }) => {
+    },
+    content: (scope: { data: any[] }) => {
+    },
+  },
+  setup({ props, scopeSlots, event: { emit, on } }) {
+
+    const dataModel = useModel(() => props.data, emit.onUpdateData);
+
+    const { refs, onRef } = useRefs({
+      scroll: Scroll,
+      content: HTMLDivElement,
+    });
+
+    const draggier = computed(() =>
+      props.draggable ?
+        createVirtualDraggier({
+          props,
+          dataModel,
+          getVirtual: () => virtual,
+          getScroll: () => refs.scroll!,
+          onDraggierStart: emit.onDraggierStart,
+          onDraggierMove: emit.onDraggierMove,
+          onDraggierEnd: emit.onDraggierEnd,
+          onDraggierTap: (draggierData) => {
+            const index = draggier.value!.dragStaticState.dragIndex;
+            emit.onDraggierTap({ ...draggierData, index, data: dataModel.value[index] });
+          },
+        }) :
+        undefined
+    );
+
+    onBeforeUnmount(on.onScroll(e => {
+      draggier.value?.emitScroll(e);
+    }));
+
+    const { virtual } = useVirtualList({ dataModel, refs, props, emit });
+
+    const onRefScroll = (scroll: typeof Scroll.use.class | null) => {
+      onRef.scroll(scroll);
+      emit.onRefScroll(scroll);
+    };
+
+    return {
+      refer: {
+        refs,
+        virtual,
+        getItemStyles: (index: number) => draggier.value?.getItemStyles(index),
+        dragStart: (e: iMouseEvent | iTouchEvent) => draggier.value?.start(e)
+      },
+      render: () => {
+        const { list } = virtual.offsetData.value;
+        return (
+          <Scroll
+            scrollX={!!props.width || props.horizontal}
+            scrollY={!!props.height || !props.horizontal}
+            onScroll={virtual.handler.onScroll}
+            ref={onRefScroll as any}
+            className={virtual.classes.value}
+            disableTransitionWhenScroll
+            mutationAttributes={props.dynamicSize}
+          >
+            <div className="virtual-list-strut" style={virtual.strutStyles.value}>
+              <div className="virtual-list-content" style={virtual.contentStyles.value} ref={onRef.content}>
+                {scopeSlots.content.isExist() ?
+                  scopeSlots.content({ data: list }, null) :
+                  list.map((node, vIndex) =>
+                    scopeSlots.default({ item: node.item, index: node.index, vid: node.id, vIndex })
+                  )}
+              </div>
+            </div>
+          </Scroll>
+        );
+      }
+    };
+  },
+});
+
+export default VirtualList;