@flowgram-vue/free-snap-plugin 0.2.0

package/src/type.ts

@@ -0,0 +1,98 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+import type { WorkflowNodeEntity } from '@flowgram-vue/free-layout-core';
+import type { Rectangle } from '@flowgram-vue/utils';
+
+export interface SnapNodeRect {
+  id: string;
+  rect: Rectangle;
+  entity: WorkflowNodeEntity;
+}
+
+export interface SnapLine {
+  x?: number;
+  y?: number;
+  sourceNodeId: string;
+}
+
+export interface SnapHorizontalLine extends SnapLine {
+  y: number;
+}
+
+export interface SnapVerticalLine extends SnapLine {
+  x: number;
+}
+
+export interface SnapMidHorizontalLine extends SnapLine {
+  y: number;
+}
+
+export interface SnapMidVerticalLine extends SnapLine {
+  x: number;
+}
+
+export interface SnapLines {
+  horizontal: SnapHorizontalLine[];
+  vertical: SnapVerticalLine[];
+  midHorizontal: SnapMidHorizontalLine[];
+  midVertical: SnapMidVerticalLine[];
+}
+
+export interface SnapEdgeLines {
+  top?: SnapHorizontalLine;
+  bottom?: SnapHorizontalLine;
+  left?: SnapVerticalLine;
+  right?: SnapVerticalLine;
+  midHorizontal?: SnapMidHorizontalLine;
+  midVertical?: SnapMidVerticalLine;
+}
+
+export interface AlignRect {
+  rect: Rectangle;
+  sourceNodeId: string;
+}
+
+export interface AlignRects {
+  top: AlignRect[];
+  bottom: AlignRect[];
+  left: AlignRect[];
+  right: AlignRect[];
+}
+
+export interface AlignSpacing {
+  top?: number;
+  bottom?: number;
+  left?: number;
+  right?: number;
+  midHorizontal?: number;
+  midVertical?: number;
+}
+
+export interface SnapEvent {
+  snapEdgeLines: SnapEdgeLines;
+  snapRect: Rectangle;
+  alignRects: AlignRects;
+  alignSpacing: AlignSpacing;
+}
+
+export interface WorkflowSnapServiceOptions {
+  edgeThreshold: number;
+  gridSize: number;
+  enableGridSnapping: boolean;
+  enableEdgeSnapping: boolean;
+  enableMultiSnapping: boolean;
+  enableOnlyViewportSnapping: boolean;
+}
+
+export interface WorkflowSnapLayerOptions {
+  edgeColor: string;
+  alignColor: string;
+  edgeLineWidth: number;
+  alignLineWidth: number;
+  alignCrossWidth: number;
+}
+
+export type FreeSnapPluginOptions = Partial<WorkflowSnapServiceOptions & WorkflowSnapLayerOptions>;

package/src/utils.ts

@@ -0,0 +1,44 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+import { Epsilon } from './constant';
+
+/** 检查浮点数 a 是否等于 b */
+export const isEqual = (a: number | undefined, b: number | undefined): boolean => {
+  if (a === undefined || b === undefined) {
+    return false;
+  }
+  // 检查 a 和 b 的差的绝对值是否小于 Epsilon
+  return Math.abs(a - b) < Epsilon;
+};
+
+/** 检查浮点数 a 是否小于 b */
+export const isLessThan = (a: number | undefined, b: number | undefined): boolean => {
+  if (a === undefined || b === undefined) {
+    return false;
+  }
+  // 检查 a 是否显著小于 b
+  return b - a > Epsilon;
+};
+
+/** 检查浮点数 a 是否大于 b */
+export const isGreaterThan = (a: number | undefined, b: number | undefined): boolean => {
+  if (a === undefined || b === undefined) {
+    return false;
+  }
+  return a - b > Epsilon;
+};
+
+/** 检查浮点数 a 是否小于等于 b */
+export const isLessThanOrEqual = (a: number | undefined, b: number | undefined): boolean =>
+  isEqual(a, b) || isLessThan(a, b);
+
+/** 检查浮点数 a 是否大于等于 b */
+export const isGreaterThanOrEqual = (a: number | undefined, b: number | undefined): boolean =>
+  isEqual(a, b) || isGreaterThan(a, b);
+
+/** 检查值是否是数字类型 */
+export const isNumber = (value: unknown): value is number =>
+  typeof value === 'number' && !isNaN(value);