@atlaskit/editor-plugin-table 2.1.4 → 2.1.6

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

@@ -0,0 +1,104 @@
+## API Report File for "@atlaskit/editor-plugin-table"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
+import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+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 { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import { TableLayout } from '@atlaskit/adf-schema';
+import type { widthPlugin } from '@atlaskit/editor-plugin-width';
+
+// @public (undocumented)
+type InsertTableAction = (analyticsPayload: AnalyticsEventPayload) => Command;
+
+// @public (undocumented)
+type PermittedLayoutsDescriptor = 'all' | TableLayout[];
+
+// @public (undocumented)
+interface PluginConfig {
+    // (undocumented)
+    advanced?: boolean;
+    // (undocumented)
+    allowAddColumnWithCustomStep?: boolean;
+    // (undocumented)
+    allowBackgroundColor?: boolean;
+    // (undocumented)
+    allowCellOptionsInFloatingToolbar?: boolean;
+    // (undocumented)
+    allowCollapse?: boolean;
+    // (undocumented)
+    allowColumnResizing?: boolean;
+    // (undocumented)
+    allowColumnSorting?: boolean;
+    // (undocumented)
+    allowControls?: boolean;
+    // (undocumented)
+    allowDistributeColumns?: boolean;
+    // (undocumented)
+    allowHeaderColumn?: boolean;
+    // (undocumented)
+    allowHeaderRow?: boolean;
+    // (undocumented)
+    allowMergeCells?: boolean;
+    // (undocumented)
+    allowNumberColumn?: boolean;
+    // (undocumented)
+    initialRenderOptimization?: boolean;
+    // (undocumented)
+    isHeaderRowRequired?: boolean;
+    // (undocumented)
+    mouseMoveOptimization?: boolean;
+    // (undocumented)
+    permittedLayouts?: PermittedLayoutsDescriptor;
+    // (undocumented)
+    stickyHeaders?: boolean;
+    // (undocumented)
+    stickyHeadersOptimization?: boolean;
+    // (undocumented)
+    tableCellOptimization?: boolean;
+    // (undocumented)
+    tableOverflowShadowsOptimization?: boolean;
+    // (undocumented)
+    tableRenderOptimization?: boolean;
+}
+
+// @public (undocumented)
+interface TablePluginOptions {
+    // (undocumented)
+    allowContextualMenu?: boolean;
+    // (undocumented)
+    breakoutEnabled?: boolean;
+    // (undocumented)
+    editorSelectionAPI?: EditorSelectionAPI;
+    // (undocumented)
+    fullWidthEnabled?: boolean;
+    // (undocumented)
+    getEditorFeatureFlags?: GetEditorFeatureFlags;
+    // (undocumented)
+    tableOptions: PluginConfig;
+    // (undocumented)
+    wasFullWidthEnabled?: boolean;
+}
+
+// @public (undocumented)
+export const tablesPlugin: NextEditorPlugin<'table', {
+    pluginConfiguration: TablePluginOptions | undefined;
+    actions: {
+        insertTable: InsertTableAction;
+    };
+    dependencies: [
+    typeof analyticsPlugin,
+    typeof contentInsertionPlugin,
+    typeof widthPlugin
+    ];
+}>;
+
+// (No @packageDocumentation comment for this package)
+
+```