@atlaskit/editor-plugin-table 7.16.1 → 7.16.3

package/dist/types-ts4.5/nodeviews/table.d.ts

@@ -32,5 +32,5 @@ export default class TableView extends ReactNodeView<Props> {
     }): boolean;
     destroy(): void;
 }
-export declare const createTableView: (node: PmNode, view: EditorView, getPos: getPosHandler, portalProviderAPI: LegacyPortalProviderAPI | PortalProviderAPI, eventDispatcher: EventDispatcher, getEditorContainerWidth: GetEditorContainerWidth, getEditorFeatureFlags: GetEditorFeatureFlags, dispatchAnalyticsEvent: DispatchAnalyticsEvent, pluginInjectionApi?: PluginInjectionAPI) => NodeView;
+export declare const createTableView: (node: PmNode, view: EditorView, getPos: getPosHandler, portalProviderAPI: LegacyPortalProviderAPI | PortalProviderAPI, eventDispatcher: EventDispatcher, getEditorContainerWidth: GetEditorContainerWidth, getEditorFeatureFlags: GetEditorFeatureFlags, dispatchAnalyticsEvent: DispatchAnalyticsEvent, pluginInjectionApi?: PluginInjectionAPI, isTableAlignmentEnabled?: boolean) => NodeView;
 export {};

package/dist/types-ts4.5/nodeviews/types.d.ts

@@ -12,6 +12,7 @@ export type TableOptions = {
     isTableResizingEnabled?: boolean;
     isDragAndDropEnabled?: boolean;
     isTableScalingEnabled?: boolean;
+    isTableAlignmentEnabled?: boolean;
 };
 export interface Props {
     node: PmNode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-table",
-  "version": "7.16.1",
+  "version": "7.16.3",
   "description": "Table plugin for the @atlaskit/editor",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -29,7 +29,7 @@
   },
   "dependencies": {
     "@atlaskit/adf-schema": "^36.8.0",
-    "@atlaskit/button": "^17.14.0",
+    "@atlaskit/button": "^17.15.0",
     "@atlaskit/custom-steps": "^0.2.0",
     "@atlaskit/editor-common": "^80.4.0",
     "@atlaskit/editor-palette": "1.6.0",
@@ -43,16 +43,16 @@
     "@atlaskit/editor-prosemirror": "4.0.1",
     "@atlaskit/editor-shared-styles": "^2.11.0",
     "@atlaskit/editor-tables": "^2.7.0",
-    "@atlaskit/icon": "^22.2.0",
+    "@atlaskit/icon": "^22.3.0",
     "@atlaskit/menu": "^2.3.0",
     "@atlaskit/platform-feature-flags": "^0.2.1",
     "@atlaskit/pragmatic-drag-and-drop": "^1.1.0",
     "@atlaskit/pragmatic-drag-and-drop-auto-scroll": "^1.3.0",
     "@atlaskit/pragmatic-drag-and-drop-hitbox": "^1.0.0",
-    "@atlaskit/primitives": "^6.2.0",
+    "@atlaskit/primitives": "^6.3.0",
     "@atlaskit/theme": "^12.8.0",
     "@atlaskit/toggle": "^13.1.0",
-    "@atlaskit/tokens": "^1.48.0",
+    "@atlaskit/tokens": "^1.49.0",
     "@atlaskit/tooltip": "^18.4.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",

package/src/commands/insert.ts

@@ -1,14 +1,12 @@
 // #region Imports
 import { AddColumnStep } from '@atlaskit/custom-steps';
-import type {
-  EditorAnalyticsAPI,
-  INPUT_METHOD,
-} from '@atlaskit/editor-common/analytics';
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import {
   ACTION,
   ACTION_SUBJECT,
   ACTION_SUBJECT_ID,
   EVENT_TYPE,
+  INPUT_METHOD,
   TABLE_OVERFLOW_CHANGE_TRIGGER,
 } from '@atlaskit/editor-common/analytics';
 import type { Command, EditorCommand } from '@atlaskit/editor-common/types';
@@ -203,22 +201,32 @@ export const insertRow =
     return true;
   };
 
-export const createTable =
-  (
-    isTableScalingEnabled?: boolean,
-    isFullWidthModeEnabled?: boolean,
-  ): Command =>
-  (state, dispatch) => {
-    const table = createTableWithWidth(
-      isTableScalingEnabled,
-      isFullWidthModeEnabled,
-    )(state.schema);
+export const createTable = (
+  isTableScalingEnabled?: boolean,
+  isFullWidthModeEnabled?: boolean,
+  editorAnalyticsAPI?: EditorAnalyticsAPI | undefined | null,
+): Command => (state, dispatch) => {
+  const table = createTableWithWidth(
+    isTableScalingEnabled,
+    isFullWidthModeEnabled,
+  )(state.schema);
 
-    if (dispatch) {
-      dispatch(safeInsert(table)(state.tr).scrollIntoView());
+  if (dispatch) {
+    const tr = safeInsert(table)(state.tr).scrollIntoView();
+    if (editorAnalyticsAPI) {
+      editorAnalyticsAPI?.attachAnalyticsEvent({
+          action: ACTION.INSERTED,
+          actionSubject: ACTION_SUBJECT.DOCUMENT,
+          actionSubjectId: ACTION_SUBJECT_ID.TABLE,
+          attributes: { inputMethod: INPUT_METHOD.SHORTCUT },
+          eventType: EVENT_TYPE.TRACK,
+      })(tr);
     }
-    return true;
-  };
+    dispatch(tr);
+  }
+  
+  return true;
+}
 
 export const insertTableWithSize =
   (

package/src/nodeviews/TableComponent.tsx

@@ -104,6 +104,7 @@ export interface ComponentProps {
   isMediaFullscreen?: boolean;
   isDragAndDropEnabled?: boolean;
   isTableScalingEnabled?: boolean;
+  isTableAlignmentEnabled?: boolean;
   tableActive: boolean;
   ordering?: TableColumnOrdering;
   isResizing?: boolean;
@@ -687,6 +688,7 @@ class TableComponent extends React.Component<ComponentProps, TableState> {
       isDragAndDropEnabled,
       getEditorFeatureFlags,
       isTableScalingEnabled, // here we can use options.isTableScalingEnabled
+      isTableAlignmentEnabled
     } = this.props;
 
     let {
@@ -820,6 +822,7 @@ class TableComponent extends React.Component<ComponentProps, TableState> {
         isResizing={isResizing}
         isTableScalingEnabled={isTableScalingEnabled}
         isWholeTableInDanger={isWholeTableInDanger}
+        isTableAlignmentEnabled={isTableAlignmentEnabled}
       >
         <div
           className={ClassName.TABLE_STICKY_SENTINEL_TOP}

package/src/nodeviews/TableComponentWithSharedState.tsx

@@ -106,6 +106,7 @@ export const TableComponentWithSharedState = ({
       isHeaderColumnEnabled={isHeaderColumnEnabled}
       isDragAndDropEnabled={options?.isDragAndDropEnabled}
       isTableScalingEnabled={options?.isTableScalingEnabled}
+      isTableAlignmentEnabled={options?.isTableAlignmentEnabled}
       tableActive={tableActive}
       ordering={ordering}
       isResizing={isResizing}

package/src/nodeviews/TableContainer.tsx

@@ -1,5 +1,11 @@
 import type { PropsWithChildren } from 'react';
-import React, { forwardRef, useCallback, useRef, useState } from 'react';
+import React, {
+  forwardRef,
+  useCallback,
+  useMemo,
+  useRef,
+  useState,
+} from 'react';
 
 import classNames from 'classnames';
 
@@ -50,6 +56,57 @@ export const InnerContainer = forwardRef<
   );
 });
 
+const centerAlignStyle = { display: 'flex', justifyContent: 'center' };
+
+const leftAlignStyle = { display: 'flex', justifyContent: 'flex-start' };
+
+type AlignmentTableContainerProps = {
+  node: PMNode;
+};
+
+const AlignmentTableContainer = ({
+  node,
+  children,
+}: PropsWithChildren<AlignmentTableContainerProps>) => {
+  const alignment = node.attrs.layout;
+
+  const style = useMemo(() => {
+    return alignment === 'align-start' ? leftAlignStyle : centerAlignStyle;
+  }, [alignment]);
+
+  return (
+    <div data-testid="table-alignment-container" style={style}>
+      {children}
+    </div>
+  );
+};
+
+const AlignmentTableContainerWrapper = ({
+  isTableAlignmentEnabled,
+  node,
+  children,
+}: PropsWithChildren<
+  AlignmentTableContainerProps & { isTableAlignmentEnabled?: boolean }
+>) => {
+  if (!isTableAlignmentEnabled) {
+    return (
+      <div
+        data-testid="table-alignment-container"
+        style={{
+          display: 'flex',
+          justifyContent: 'center',
+        }}
+      >
+        {children}
+      </div>
+    );
+  }
+
+  return (
+    <AlignmentTableContainer node={node}>{children}</AlignmentTableContainer>
+  );
+};
+
 type ResizableTableContainerProps = {
   containerWidth: number;
   node: PMNode;
@@ -59,9 +116,11 @@ type ResizableTableContainerProps = {
   tableRef: HTMLTableElement;
   isResizing?: boolean;
   pluginInjectionApi?: PluginInjectionAPI;
-  isTableScalingEnabled?: boolean;
   tableWrapperHeight?: number;
   isWholeTableInDanger?: boolean;
+
+  isTableScalingEnabled?: boolean;
+  isTableAlignmentEnabled?: boolean;
 };
 
 export const ResizableTableContainer = React.memo(
@@ -75,9 +134,10 @@ export const ResizableTableContainer = React.memo(
     tableRef,
     isResizing,
     pluginInjectionApi,
-    isTableScalingEnabled,
     tableWrapperHeight,
     isWholeTableInDanger,
+    isTableScalingEnabled,
+    isTableAlignmentEnabled,
   }: PropsWithChildren<ResizableTableContainerProps>) => {
     const containerRef = useRef<HTMLDivElement | null>(null);
     const tableWidthRef = useRef<number>(akEditorDefaultLayoutWidth);
@@ -194,6 +254,7 @@ export const ResizableTableContainer = React.memo(
       displayGuideline,
       attachAnalyticsEvent,
       displayGapCursor,
+      isTableAlignmentEnabled,
       isTableScalingEnabled,
       isWholeTableInDanger,
       pluginInjectionApi,
@@ -204,11 +265,9 @@ export const ResizableTableContainer = React.memo(
     const isLivePageViewMode = editorViewModeState?.mode === 'view';
 
     return (
-      <div
-        style={{
-          display: 'flex',
-          justifyContent: 'center',
-        }}
+      <AlignmentTableContainerWrapper
+        isTableAlignmentEnabled={isTableAlignmentEnabled}
+        node={node}
       >
         <div
           style={{
@@ -237,7 +296,7 @@ export const ResizableTableContainer = React.memo(
             </TableResizer>
           )}
         </div>
-      </div>
+      </AlignmentTableContainerWrapper>
     );
   },
 );
@@ -246,16 +305,18 @@ type TableContainerProps = {
   node: PMNode;
   className: string;
   containerWidth: EditorContainerWidth;
-  isTableResizingEnabled: boolean | undefined;
   editorView: EditorView;
   getPos: () => number | undefined;
   tableRef: HTMLTableElement;
   isNested: boolean;
   isResizing?: boolean;
   pluginInjectionApi?: PluginInjectionAPI;
-  isTableScalingEnabled?: boolean;
   tableWrapperHeight?: number;
   isWholeTableInDanger?: boolean;
+
+  isTableResizingEnabled: boolean | undefined;
+  isTableScalingEnabled?: boolean;
+  isTableAlignmentEnabled?: boolean;
 };
 
 export const TableContainer = ({
@@ -263,7 +324,6 @@ export const TableContainer = ({
   node,
   className,
   containerWidth: { width: editorWidth },
-  isTableResizingEnabled,
   editorView,
   getPos,
   tableRef,
@@ -271,8 +331,10 @@ export const TableContainer = ({
   tableWrapperHeight,
   isResizing,
   pluginInjectionApi,
-  isTableScalingEnabled,
   isWholeTableInDanger,
+  isTableResizingEnabled,
+  isTableScalingEnabled,
+  isTableAlignmentEnabled,
 }: PropsWithChildren<TableContainerProps>) => {
   if (isTableResizingEnabled && !isNested) {
     return (
@@ -288,6 +350,7 @@ export const TableContainer = ({
         pluginInjectionApi={pluginInjectionApi}
         isTableScalingEnabled={isTableScalingEnabled}
         isWholeTableInDanger={isWholeTableInDanger}
+        isTableAlignmentEnabled={isTableAlignmentEnabled}
       >
         {children}
       </ResizableTableContainer>

package/src/nodeviews/TableResizer.tsx

@@ -48,6 +48,7 @@ import {
   TABLE_HIGHLIGHT_TOLERANCE,
   TABLE_SNAP_GAP,
 } from '../ui/consts';
+import { normaliseAlignment } from '../utils/alignment';
 import {
   generateResizedPayload,
   generateResizeFrameRatePayloads,
@@ -79,6 +80,7 @@ interface TableResizerProps {
   displayGapCursor: (toggle: boolean) => boolean;
   pluginInjectionApi?: PluginInjectionAPI;
   isTableScalingEnabled?: boolean;
+  isTableAlignmentEnabled?: boolean;
   isWholeTableInDanger?: boolean;
 }
 
@@ -169,6 +171,7 @@ export const TableResizer = ({
   attachAnalyticsEvent,
   displayGapCursor,
   isTableScalingEnabled,
+  isTableAlignmentEnabled,
   isWholeTableInDanger,
   pluginInjectionApi,
 }: PropsWithChildren<TableResizerImprovementProps>) => {
@@ -594,6 +597,13 @@ export const TableResizer = ({
     }
   }, [width]);
 
+  const resizeRatio =
+    !isTableAlignmentEnabled ||
+    (isTableAlignmentEnabled &&
+      normaliseAlignment(node.attrs.layout) === 'center')
+      ? 2
+      : 1;
+
   return (
     <>
       <ResizerNext
@@ -606,7 +616,7 @@ export const TableResizer = ({
         handleResizeStart={handleResizeStart}
         handleResize={scheduleResize}
         handleResizeStop={handleResizeStop}
-        resizeRatio={2}
+        resizeRatio={resizeRatio}
         minWidth={resizerMinWidth}
         maxWidth={maxWidth}
         snapGap={TABLE_SNAP_GAP}

package/src/nodeviews/table.tsx

@@ -292,7 +292,8 @@ export default class TableView extends ReactNodeView<Props> {
               isHeaderRowEnabled={pluginState!.isHeaderRowEnabled}
               isHeaderColumnEnabled={pluginState!.isHeaderColumnEnabled}
               isDragAndDropEnabled={pluginState!.isDragAndDropEnabled}
-              isTableScalingEnabled={props.options?.isTableScalingEnabled} // this.options?.isTableScalingEnabled sams as TableOptions.isTableScalingEnabled same as pluginState.isTableScalingEnabled
+              isTableScalingEnabled={props.options?.isTableScalingEnabled} // this.options?.isTableScalingEnabled same as TableOptions.isTableScalingEnabled same as pluginState.isTableScalingEnabled
+              isTableAlignmentEnabled={props.options?.isTableAlignmentEnabled}
               tableActive={tableActive}
               ordering={pluginState!.ordering as TableColumnOrdering}
               isResizing={isResizing}
@@ -391,6 +392,7 @@ export const createTableView = (
   getEditorFeatureFlags: GetEditorFeatureFlags,
   dispatchAnalyticsEvent: DispatchAnalyticsEvent,
   pluginInjectionApi?: PluginInjectionAPI,
+  isTableAlignmentEnabled?: boolean,
 ): NodeView => {
   const {
     pluginConfig,
@@ -417,6 +419,7 @@ export const createTableView = (
       isTableResizingEnabled,
       isDragAndDropEnabled,
       isTableScalingEnabled, // same as options.isTableScalingEnabled
+      isTableAlignmentEnabled
     },
     getEditorContainerWidth,
     getEditorFeatureFlags,

package/src/nodeviews/types.ts

@@ -17,6 +17,7 @@ export type TableOptions = {
   isTableResizingEnabled?: boolean;
   isDragAndDropEnabled?: boolean;
   isTableScalingEnabled?: boolean;
+  isTableAlignmentEnabled?: boolean;
 };
 
 export interface Props {

package/src/plugin.tsx

@@ -212,7 +212,13 @@ const tablesPlugin: TablePlugin = ({ config: options, api }) => {
 
               options: {
                 selectNodeInserted: false,
-                analyticsPayload,
+                analyticsPayload: {
+                  ...analyticsPayload,
+                  attributes: {
+                    ...analyticsPayload.attributes,
+                    localId: node.attrs.localId,
+                  },
+                },
               },
             }) ?? false
           );
@@ -638,17 +644,21 @@ const tablesPlugin: TablePlugin = ({ config: options, api }) => {
             // see comment on tablesPlugin.getSharedState on usage
             const tableState = api?.table?.sharedState.currentState();
 
-            const tr = insert(
-              createTableWithWidth(
-                options?.isTableScalingEnabled,
-                tableState?.isFullWidthModeEnabled,
-              )(state.schema),
-            );
+            const tableNode = createTableWithWidth(
+              options?.isTableScalingEnabled,
+              tableState?.isFullWidthModeEnabled,
+            )(state.schema);
+
+            const tr = insert(tableNode);
+
             editorAnalyticsAPI?.attachAnalyticsEvent({
               action: ACTION.INSERTED,
               actionSubject: ACTION_SUBJECT.DOCUMENT,
               actionSubjectId: ACTION_SUBJECT_ID.TABLE,
-              attributes: { inputMethod: INPUT_METHOD.QUICK_INSERT },
+              attributes: {
+                inputMethod: INPUT_METHOD.QUICK_INSERT,
+                localId: tableNode.attrs.localId,
+              },
               eventType: EVENT_TYPE.TRACK,
             })(tr);
             return tr;

package/src/pm-plugins/keymap.ts

@@ -1,13 +1,7 @@
 import type { IntlShape } from 'react-intl-next/src/types';
 
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import {
-  ACTION,
-  ACTION_SUBJECT,
-  ACTION_SUBJECT_ID,
-  EVENT_TYPE,
-  INPUT_METHOD,
-} from '@atlaskit/editor-common/analytics';
+import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import {
   addColumnAfter,
   addColumnBefore,
@@ -37,7 +31,7 @@ import { chainCommands } from '@atlaskit/editor-prosemirror/commands';
 import { keymap } from '@atlaskit/editor-prosemirror/keymap';
 import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 
-import { createTable, goToNextCell, moveCursorBackward } from '../commands';
+import { goToNextCell, moveCursorBackward } from '../commands';
 import {
   addRowAroundSelection,
   changeColumnWidthByStepWithAnalytics,
@@ -53,25 +47,10 @@ import {
 import {
   addColumnAfter as addColumnAfterCommand,
   addColumnBefore as addColumnBeforeCommand,
+  createTable,
 } from '../commands/insert';
 import { moveSourceWithAnalyticsViaShortcut } from '../pm-plugins/drag-and-drop/commands-with-analytics';
 import type { PluginInjectionAPIWithA11y } from '../types';
-import { withEditorAnalyticsAPI } from '../utils/analytics';
-
-const createTableWithAnalytics = (
-  isTableScalingEnabled: boolean,
-  isFullWidthModeEnabled: boolean,
-  editorAnalyticsAPI: EditorAnalyticsAPI | undefined | null,
-) =>
-  withEditorAnalyticsAPI({
-    action: ACTION.INSERTED,
-    actionSubject: ACTION_SUBJECT.DOCUMENT,
-    actionSubjectId: ACTION_SUBJECT_ID.TABLE,
-    attributes: { inputMethod: INPUT_METHOD.SHORTCUT },
-    eventType: EVENT_TYPE.TRACK,
-  })(editorAnalyticsAPI)(
-    createTable(isTableScalingEnabled, isFullWidthModeEnabled),
-  );
 
 export function keymapPlugin(
   getEditorContainerWidth: GetEditorContainerWidth,
@@ -99,7 +78,7 @@ export function keymapPlugin(
   );
   bindKeymapWithCommand(
     toggleTable.common!,
-    createTableWithAnalytics(
+    createTable(
       isTableScalingEnabled,
       !!isFullWidthEnabled,
       editorAnalyticsAPI,

package/src/pm-plugins/main.ts

@@ -411,6 +411,7 @@ export const createPlugin = (
             getEditorFeatureFlags,
             dispatchAnalyticsEvent,
             pluginInjectionApi,
+            isTableAlignmentEnabled,
           ),
         tableRow: (node, view, getPos) =>
           new TableRow(node, view, getPos, eventDispatcher),