@atlaskit/editor-plugin-table 2.1.6 → 2.2.0

package/src/plugins/table/utils/decoration.ts

@@ -1,4 +1,5 @@
 import { Node as PmNode } from 'prosemirror-model';
+// @ts-ignore -- ReadonlyTransaction is a local declaration and will cause a TS2305 error in CCFE typecheck
 import { Selection, Transaction, ReadonlyTransaction } from 'prosemirror-state';
 import { Rect, TableMap } from '@atlaskit/editor-tables/table-map';
 import { ContentNodeWithPos } from 'prosemirror-utils';

package/src/plugins/table/utils/guidelines.ts

@@ -0,0 +1,17 @@
+import type { GuidelineConfig } from '@atlaskit/editor-plugin-guideline';
+import { createFixedGuidelinesFromLengths } from '@atlaskit/editor-common/guideline';
+import {
+  akEditorDefaultLayoutWidth,
+  akEditorWideLayoutWidth,
+  akEditorFullWidthLayoutWidth,
+} from '@atlaskit/editor-shared-styles';
+
+export const defaultGuidelineWidths = [
+  akEditorDefaultLayoutWidth,
+  akEditorWideLayoutWidth,
+  akEditorFullWidthLayoutWidth,
+];
+
+export const defaultGuidelines = createFixedGuidelinesFromLengths(
+  defaultGuidelineWidths,
+) as GuidelineConfig[];

package/src/plugins/table/utils/snapping.ts

@@ -0,0 +1,38 @@
+import type { GuidelineConfig } from '@atlaskit/editor-plugin-guideline';
+
+/**
+ * Returns keys of guidelines that are closest to the table and withthin the snapGap
+ */
+export const findClosestSnap = (
+  currentWidth: number,
+  snapWidths: number[],
+  guidelines: GuidelineConfig[],
+  snapGap: number = 0,
+) => {
+  const closestGapIndex = snapWidths.reduce(
+    (prev, curr, index) =>
+      Math.abs(curr - currentWidth) < Math.abs(snapWidths[prev] - currentWidth)
+        ? index
+        : prev,
+    0,
+  );
+  const gap = Math.abs(snapWidths[closestGapIndex] - currentWidth);
+  if (gap < snapGap) {
+    const snappingWidth = Math.round(snapWidths[closestGapIndex]);
+    const guidelineKeys = guidelines.reduce<string[]>((acc, guideline) => {
+      // NOTE: The snap points are based on the guidelines, however their formatted as a length value whereas the guidelines
+      // are point based. The point base x coords are calculated by halving the lengths. This means we can convert the
+      // point base position to length by simply multiplying by 2.
+      if (Math.round(Math.abs(guideline.position.x) * 2) === snappingWidth) {
+        acc.push(guideline.key);
+      }
+      return acc;
+    }, []);
+
+    return {
+      gap,
+      keys: guidelineKeys,
+    };
+  }
+  return { gap, keys: [] };
+};

package/tmp/api-report-tmp.d.ts

@@ -10,6 +10,7 @@ import type { Command } from '@atlaskit/editor-common/types';
 import type { contentInsertionPlugin } from '@atlaskit/editor-plugin-content-insertion';
 import type { EditorSelectionAPI } from '@atlaskit/editor-common/selection';
 import type { GetEditorFeatureFlags } from '@atlaskit/editor-common/types';
+import type { guidelinePlugin } from '@atlaskit/editor-plugin-guideline';
 import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
 import { TableLayout } from '@atlaskit/adf-schema';
 import type { widthPlugin } from '@atlaskit/editor-plugin-width';
@@ -95,7 +96,8 @@ export const tablesPlugin: NextEditorPlugin<'table', {
     dependencies: [
     typeof analyticsPlugin,
     typeof contentInsertionPlugin,
-    typeof widthPlugin
+    typeof widthPlugin,
+    typeof guidelinePlugin
     ];
 }>;