@atlaskit/editor-plugin-table 17.0.1 → 17.1.0

package/dist/types/nodeviews/TableResizer.d.ts

@@ -7,6 +7,7 @@ import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { PluginInjectionAPI } from '../types';
 interface TableResizerProps {
+    allowFixedColumnWidthOption?: boolean;
     attachAnalyticsEvent: (payload: TableEventPayload) => ((tr: Transaction) => boolean) | undefined;
     containerWidth: number;
     disabled?: boolean;
@@ -18,7 +19,6 @@ interface TableResizerProps {
     isFullWidthModeEnabled?: boolean;
     isTableAlignmentEnabled?: boolean;
     isTableScalingEnabled?: boolean;
-    isTableWithFixedColumnWidthsOptionEnabled?: boolean;
     isWholeTableInDanger?: boolean;
     lineLength: number;
     maxWidth: number | string;
@@ -31,5 +31,5 @@ interface TableResizerProps {
     updateWidth: (width: number) => void;
     width: number;
 }
-export declare const TableResizer: ({ children, width, maxWidth, containerWidth, lineLength, updateWidth, onResizeStop, onResizeStart, editorView, getPos, node, tableRef, displayGuideline, attachAnalyticsEvent, displayGapCursor, isTableScalingEnabled, isTableWithFixedColumnWidthsOptionEnabled, isTableAlignmentEnabled, isWholeTableInDanger, shouldUseIncreasedScalingPercent, pluginInjectionApi, isFullWidthModeEnabled, isCommentEditor, disabled, }: PropsWithChildren<TableResizerProps>) => React.JSX.Element;
+export declare const TableResizer: ({ children, width, maxWidth, containerWidth, lineLength, updateWidth, onResizeStop, onResizeStart, editorView, getPos, node, tableRef, displayGuideline, attachAnalyticsEvent, displayGapCursor, isTableScalingEnabled, allowFixedColumnWidthOption, isTableAlignmentEnabled, isWholeTableInDanger, shouldUseIncreasedScalingPercent, pluginInjectionApi, isFullWidthModeEnabled, isCommentEditor, disabled, }: PropsWithChildren<TableResizerProps>) => React.JSX.Element;
 export {};

package/dist/types/nodeviews/table-node-views.d.ts

@@ -9,6 +9,7 @@ import TableCell from './TableCell';
 import TableRow from './TableRow';
 import TableRowNativeStickyWithFallback from './TableRowNativeStickyWithFallback';
 type TableViewOptions = {
+    allowFixedColumnWidthOption?: boolean;
     dispatchAnalyticsEvent: DispatchAnalyticsEvent;
     eventDispatcher: EventDispatcher;
     getEditorContainerWidth: GetEditorContainerWidth;

package/dist/types/nodeviews/table.d.ts

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

package/dist/types/nodeviews/types.d.ts

@@ -17,6 +17,7 @@ export type TableOptions = {
 export interface Props {
     allowColumnResizing?: boolean;
     allowControls?: boolean;
+    allowFixedColumnWidthOption?: boolean;
     allowTableAlignment?: boolean;
     allowTableResizing?: boolean;
     cellMinWidth?: number;

package/dist/types/pm-plugins/main.d.ts

@@ -5,4 +5,4 @@ import { type PortalProviderAPI } from '@atlaskit/editor-common/portal';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { GetEditorContainerWidth, GetEditorFeatureFlags } from '@atlaskit/editor-common/types';
 import type { PluginConfig, PluginInjectionAPI } from '../types';
-export declare const createPlugin: (dispatchAnalyticsEvent: DispatchAnalyticsEvent, dispatch: Dispatch, portalProviderAPI: PortalProviderAPI, nodeViewPortalProviderAPI: PortalProviderAPI, eventDispatcher: EventDispatcher, pluginConfig: PluginConfig, getEditorContainerWidth: GetEditorContainerWidth, getEditorFeatureFlags: GetEditorFeatureFlags, getIntl: () => IntlShape, fullWidthModeEnabled?: boolean, previousFullWidthModeEnabled?: boolean, dragAndDropEnabled?: boolean, editorAnalyticsAPI?: EditorAnalyticsAPI, pluginInjectionApi?: PluginInjectionAPI, isTableScalingEnabled?: boolean, shouldUseIncreasedScalingPercent?: boolean, isCommentEditor?: boolean, isChromelessEditor?: boolean) => SafePlugin<import("../types").TablePluginState>;
+export declare const createPlugin: (dispatchAnalyticsEvent: DispatchAnalyticsEvent, dispatch: Dispatch, portalProviderAPI: PortalProviderAPI, nodeViewPortalProviderAPI: PortalProviderAPI, eventDispatcher: EventDispatcher, pluginConfig: PluginConfig, getEditorContainerWidth: GetEditorContainerWidth, getEditorFeatureFlags: GetEditorFeatureFlags, getIntl: () => IntlShape, fullWidthModeEnabled?: boolean, previousFullWidthModeEnabled?: boolean, dragAndDropEnabled?: boolean, editorAnalyticsAPI?: EditorAnalyticsAPI, pluginInjectionApi?: PluginInjectionAPI, isTableScalingEnabled?: boolean, shouldUseIncreasedScalingPercent?: boolean, isCommentEditor?: boolean, isChromelessEditor?: boolean, allowFixedColumnWidthOption?: boolean) => SafePlugin<import("../types").TablePluginState>;

package/dist/types/pm-plugins/table-resizing/utils/scale-table.d.ts

@@ -15,6 +15,6 @@ interface ScaleOptions {
     start: number;
 }
 export declare function scaleTableTo(state: ResizeState, maxSize: number): ResizeState;
-export declare const previewScaleTable: (tableRef: HTMLTableElement | null | undefined, options: ScaleOptions, domAtPos: DomAtPos, isTableScalingEnabled?: boolean, isTableWithFixedColumnWidthsOptionEnabled?: boolean, isCommentEditor?: boolean) => void;
+export declare const previewScaleTable: (tableRef: HTMLTableElement | null | undefined, options: ScaleOptions, domAtPos: DomAtPos, isTableScalingEnabled?: boolean, allowFixedColumnWidthOption?: boolean, isCommentEditor?: boolean) => void;
 export declare const scaleTable: (tableRef: HTMLTableElement | null | undefined, options: ScaleOptions, domAtPos: DomAtPos, api: PluginInjectionAPI | undefined | null, isTableScalingEnabledOnCurrentTable?: boolean, shouldUseIncreasedScalingPercent?: boolean, isCommentEditor?: boolean) => (tr: Transaction) => Transaction;
 export {};

package/dist/types/tablePluginType.d.ts

@@ -17,6 +17,12 @@ import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
 import type { PluginConfig, TableSharedState } from './types';
 export interface TablePluginOptions {
     allowContextualMenu?: boolean;
+    /**
+     * Enables the fixed column width option.
+     * When enabled, users can choose to apply fixed widths to table columns and these widths won't scale with viewport changes.
+     * Note: This feature requires ADF schema changes to be supported.
+     */
+    allowFixedColumnWidthOption?: boolean;
     /**
      * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-49683 Internal documentation for deprecation (no external access)}
      * Deprecating this prop to enable drag and drop in tables by default.

package/dist/types/types/index.d.ts

@@ -60,6 +60,7 @@ export interface PluginConfig {
     allowColumnSorting?: boolean;
     allowControls?: boolean;
     allowDistributeColumns?: boolean;
+    allowFixedColumnWidthOption?: boolean;
     allowHeaderColumn?: boolean;
     allowHeaderRow?: boolean;
     allowMergeCells?: boolean;

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

@@ -12,6 +12,7 @@ import type { TableOptions } from './types';
 interface ComponentProps {
     allowColumnResizing?: boolean;
     allowControls?: boolean;
+    allowFixedColumnWidthOption?: boolean;
     allowTableAlignment?: boolean;
     allowTableResizing?: boolean;
     containerWidth: EditorContainerWidth;

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

@@ -10,6 +10,7 @@ type ForwardRef = (node: HTMLElement | null) => any;
 type TableComponentWithSharedStateProps = {
     allowColumnResizing?: boolean;
     allowControls?: boolean;
+    allowFixedColumnWidthOption?: boolean;
     allowTableAlignment?: boolean;
     allowTableResizing?: boolean;
     api?: PluginInjectionAPI;
@@ -25,5 +26,5 @@ type TableComponentWithSharedStateProps = {
 /**
  * Use useSharedPluginState to control re-renders from plugin dependencies
  */
-export declare const TableComponentWithSharedState: ({ view, options, getNode, dispatchAnalyticsEvent, api, getEditorFeatureFlags, eventDispatcher, allowColumnResizing, allowControls, getPos, forwardRef, allowTableAlignment, allowTableResizing, }: TableComponentWithSharedStateProps) => React.JSX.Element;
+export declare const TableComponentWithSharedState: ({ view, options, getNode, dispatchAnalyticsEvent, api, getEditorFeatureFlags, eventDispatcher, allowColumnResizing, allowControls, getPos, forwardRef, allowTableAlignment, allowTableResizing, allowFixedColumnWidthOption, }: TableComponentWithSharedStateProps) => React.JSX.Element;
 export {};

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

@@ -5,6 +5,7 @@ import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { PluginInjectionAPI } from '../types';
 type ResizableTableContainerProps = {
+    allowFixedColumnWidthOption?: boolean;
     className: string;
     containerWidth: number;
     editorView: EditorView;
@@ -14,7 +15,6 @@ type ResizableTableContainerProps = {
     isResizing?: boolean;
     isTableAlignmentEnabled?: boolean;
     isTableScalingEnabled?: boolean;
-    isTableWithFixedColumnWidthsOptionEnabled?: boolean;
     isWholeTableInDanger?: boolean;
     lineLength: number;
     node: PMNode;
@@ -23,8 +23,9 @@ type ResizableTableContainerProps = {
     tableRef: HTMLTableElement;
     tableWrapperHeight?: number;
 };
-export declare const ResizableTableContainer: React.MemoExoticComponent<({ children, className, node, containerWidth, lineLength, editorView, getPos, tableRef, isResizing, pluginInjectionApi, tableWrapperHeight, isWholeTableInDanger, isTableScalingEnabled, isTableWithFixedColumnWidthsOptionEnabled, isTableAlignmentEnabled, shouldUseIncreasedScalingPercent, isCommentEditor, isChromelessEditor, }: PropsWithChildren<ResizableTableContainerProps>) => React.JSX.Element>;
+export declare const ResizableTableContainer: React.MemoExoticComponent<({ children, className, node, containerWidth, lineLength, editorView, getPos, tableRef, isResizing, pluginInjectionApi, tableWrapperHeight, isWholeTableInDanger, isTableScalingEnabled, allowFixedColumnWidthOption, isTableAlignmentEnabled, shouldUseIncreasedScalingPercent, isCommentEditor, isChromelessEditor, }: PropsWithChildren<ResizableTableContainerProps>) => React.JSX.Element>;
 type TableContainerProps = {
+    allowFixedColumnWidthOption?: boolean;
     className: string;
     containerWidth: EditorContainerWidth;
     editorView: EditorView;
@@ -36,7 +37,6 @@ type TableContainerProps = {
     isTableAlignmentEnabled?: boolean;
     isTableResizingEnabled: boolean | undefined;
     isTableScalingEnabled?: boolean;
-    isTableWithFixedColumnWidthsOptionEnabled?: boolean;
     isWholeTableInDanger?: boolean;
     node: PMNode;
     pluginInjectionApi?: PluginInjectionAPI;
@@ -44,5 +44,5 @@ type TableContainerProps = {
     tableRef: HTMLTableElement;
     tableWrapperHeight?: number;
 };
-export declare const TableContainer: ({ children, node, className, containerWidth: { width: editorWidth, lineLength }, editorView, getPos, tableRef, isNested, tableWrapperHeight, isResizing, pluginInjectionApi, isWholeTableInDanger, isTableResizingEnabled, isTableScalingEnabled, isTableWithFixedColumnWidthsOptionEnabled, isTableAlignmentEnabled, shouldUseIncreasedScalingPercent, isCommentEditor, isChromelessEditor, }: PropsWithChildren<TableContainerProps>) => React.JSX.Element;
+export declare const TableContainer: ({ children, node, className, containerWidth: { width: editorWidth, lineLength }, editorView, getPos, tableRef, isNested, tableWrapperHeight, isResizing, pluginInjectionApi, isWholeTableInDanger, isTableResizingEnabled, isTableScalingEnabled, allowFixedColumnWidthOption, isTableAlignmentEnabled, shouldUseIncreasedScalingPercent, isCommentEditor, isChromelessEditor, }: PropsWithChildren<TableContainerProps>) => React.JSX.Element;
 export {};

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

@@ -7,6 +7,7 @@ import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { PluginInjectionAPI } from '../types';
 interface TableResizerProps {
+    allowFixedColumnWidthOption?: boolean;
     attachAnalyticsEvent: (payload: TableEventPayload) => ((tr: Transaction) => boolean) | undefined;
     containerWidth: number;
     disabled?: boolean;
@@ -18,7 +19,6 @@ interface TableResizerProps {
     isFullWidthModeEnabled?: boolean;
     isTableAlignmentEnabled?: boolean;
     isTableScalingEnabled?: boolean;
-    isTableWithFixedColumnWidthsOptionEnabled?: boolean;
     isWholeTableInDanger?: boolean;
     lineLength: number;
     maxWidth: number | string;
@@ -31,5 +31,5 @@ interface TableResizerProps {
     updateWidth: (width: number) => void;
     width: number;
 }
-export declare const TableResizer: ({ children, width, maxWidth, containerWidth, lineLength, updateWidth, onResizeStop, onResizeStart, editorView, getPos, node, tableRef, displayGuideline, attachAnalyticsEvent, displayGapCursor, isTableScalingEnabled, isTableWithFixedColumnWidthsOptionEnabled, isTableAlignmentEnabled, isWholeTableInDanger, shouldUseIncreasedScalingPercent, pluginInjectionApi, isFullWidthModeEnabled, isCommentEditor, disabled, }: PropsWithChildren<TableResizerProps>) => React.JSX.Element;
+export declare const TableResizer: ({ children, width, maxWidth, containerWidth, lineLength, updateWidth, onResizeStop, onResizeStart, editorView, getPos, node, tableRef, displayGuideline, attachAnalyticsEvent, displayGapCursor, isTableScalingEnabled, allowFixedColumnWidthOption, isTableAlignmentEnabled, isWholeTableInDanger, shouldUseIncreasedScalingPercent, pluginInjectionApi, isFullWidthModeEnabled, isCommentEditor, disabled, }: PropsWithChildren<TableResizerProps>) => React.JSX.Element;
 export {};

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

@@ -9,6 +9,7 @@ import TableCell from './TableCell';
 import TableRow from './TableRow';
 import TableRowNativeStickyWithFallback from './TableRowNativeStickyWithFallback';
 type TableViewOptions = {
+    allowFixedColumnWidthOption?: boolean;
     dispatchAnalyticsEvent: DispatchAnalyticsEvent;
     eventDispatcher: EventDispatcher;
     getEditorContainerWidth: GetEditorContainerWidth;

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

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

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

@@ -17,6 +17,7 @@ export type TableOptions = {
 export interface Props {
     allowColumnResizing?: boolean;
     allowControls?: boolean;
+    allowFixedColumnWidthOption?: boolean;
     allowTableAlignment?: boolean;
     allowTableResizing?: boolean;
     cellMinWidth?: number;

package/dist/types-ts4.5/pm-plugins/main.d.ts

@@ -5,4 +5,4 @@ import { type PortalProviderAPI } from '@atlaskit/editor-common/portal';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { GetEditorContainerWidth, GetEditorFeatureFlags } from '@atlaskit/editor-common/types';
 import type { PluginConfig, PluginInjectionAPI } from '../types';
-export declare const createPlugin: (dispatchAnalyticsEvent: DispatchAnalyticsEvent, dispatch: Dispatch, portalProviderAPI: PortalProviderAPI, nodeViewPortalProviderAPI: PortalProviderAPI, eventDispatcher: EventDispatcher, pluginConfig: PluginConfig, getEditorContainerWidth: GetEditorContainerWidth, getEditorFeatureFlags: GetEditorFeatureFlags, getIntl: () => IntlShape, fullWidthModeEnabled?: boolean, previousFullWidthModeEnabled?: boolean, dragAndDropEnabled?: boolean, editorAnalyticsAPI?: EditorAnalyticsAPI, pluginInjectionApi?: PluginInjectionAPI, isTableScalingEnabled?: boolean, shouldUseIncreasedScalingPercent?: boolean, isCommentEditor?: boolean, isChromelessEditor?: boolean) => SafePlugin<import("../types").TablePluginState>;
+export declare const createPlugin: (dispatchAnalyticsEvent: DispatchAnalyticsEvent, dispatch: Dispatch, portalProviderAPI: PortalProviderAPI, nodeViewPortalProviderAPI: PortalProviderAPI, eventDispatcher: EventDispatcher, pluginConfig: PluginConfig, getEditorContainerWidth: GetEditorContainerWidth, getEditorFeatureFlags: GetEditorFeatureFlags, getIntl: () => IntlShape, fullWidthModeEnabled?: boolean, previousFullWidthModeEnabled?: boolean, dragAndDropEnabled?: boolean, editorAnalyticsAPI?: EditorAnalyticsAPI, pluginInjectionApi?: PluginInjectionAPI, isTableScalingEnabled?: boolean, shouldUseIncreasedScalingPercent?: boolean, isCommentEditor?: boolean, isChromelessEditor?: boolean, allowFixedColumnWidthOption?: boolean) => SafePlugin<import("../types").TablePluginState>;

package/dist/types-ts4.5/pm-plugins/table-resizing/utils/scale-table.d.ts

@@ -15,6 +15,6 @@ interface ScaleOptions {
     start: number;
 }
 export declare function scaleTableTo(state: ResizeState, maxSize: number): ResizeState;
-export declare const previewScaleTable: (tableRef: HTMLTableElement | null | undefined, options: ScaleOptions, domAtPos: DomAtPos, isTableScalingEnabled?: boolean, isTableWithFixedColumnWidthsOptionEnabled?: boolean, isCommentEditor?: boolean) => void;
+export declare const previewScaleTable: (tableRef: HTMLTableElement | null | undefined, options: ScaleOptions, domAtPos: DomAtPos, isTableScalingEnabled?: boolean, allowFixedColumnWidthOption?: boolean, isCommentEditor?: boolean) => void;
 export declare const scaleTable: (tableRef: HTMLTableElement | null | undefined, options: ScaleOptions, domAtPos: DomAtPos, api: PluginInjectionAPI | undefined | null, isTableScalingEnabledOnCurrentTable?: boolean, shouldUseIncreasedScalingPercent?: boolean, isCommentEditor?: boolean) => (tr: Transaction) => Transaction;
 export {};

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

@@ -17,6 +17,12 @@ import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
 import type { PluginConfig, TableSharedState } from './types';
 export interface TablePluginOptions {
     allowContextualMenu?: boolean;
+    /**
+     * Enables the fixed column width option.
+     * When enabled, users can choose to apply fixed widths to table columns and these widths won't scale with viewport changes.
+     * Note: This feature requires ADF schema changes to be supported.
+     */
+    allowFixedColumnWidthOption?: boolean;
     /**
      * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-49683 Internal documentation for deprecation (no external access)}
      * Deprecating this prop to enable drag and drop in tables by default.

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

@@ -60,6 +60,7 @@ export interface PluginConfig {
     allowColumnSorting?: boolean;
     allowControls?: boolean;
     allowDistributeColumns?: boolean;
+    allowFixedColumnWidthOption?: boolean;
     allowHeaderColumn?: boolean;
     allowHeaderRow?: boolean;
     allowMergeCells?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-table",
-	"version": "17.0.1",
+	"version": "17.1.0",
 	"description": "Table plugin for the @atlaskit/editor",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -57,7 +57,7 @@
 		"@atlaskit/pragmatic-drag-and-drop-hitbox": "^1.1.0",
 		"@atlaskit/primitives": "^17.1.0",
 		"@atlaskit/theme": "^21.0.0",
-		"@atlaskit/tmp-editor-statsig": "^16.34.0",
+		"@atlaskit/tmp-editor-statsig": "^16.35.0",
 		"@atlaskit/toggle": "^15.2.0",
 		"@atlaskit/tokens": "^10.1.0",
 		"@atlaskit/tooltip": "^20.14.0",
@@ -177,6 +177,9 @@
 		},
 		"platform_editor_enable_table_scaling": {
 			"type": "boolean"
+		},
+		"platform_editor_table_fixed_column_width_prop": {
+			"type": "boolean"
 		}
 	}
 }