@atlaskit/editor-plugin-table/report.api.md

Table plugin for the @atlaskit/editor

<!-- API Report Version: 2.3 -->

## API Report File for "@atlaskit/editor-plugin-table"

> Do not edit this file. This report is auto-generated using
> [API Extractor](https://api-extractor.com/).
> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)

### Table of contents

- [Main Entry Types](#main-entry-types)
- [Peer Dependencies](#peer-dependencies)

### Main Entry Types

<!--SECTION START: Main Entry Types-->

```ts
import type { 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 { GetEditorFeatureFlags } from '@atlaskit/editor-common/types';
import type { GuidelinePlugin } from '@atlaskit/editor-plugin-guideline';
import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
import type { SelectionPlugin } from '@atlaskit/editor-plugin-selection';
import type { 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)
	isHeaderRowRequired?: boolean;
	// (undocumented)
	permittedLayouts?: PermittedLayoutsDescriptor;
	// (undocumented)
	stickyHeaders?: boolean;
}

// @public (undocumented)
export type TablePlugin = NextEditorPlugin<
	'table',
	{
		pluginConfiguration: TablePluginOptions | undefined;
		actions: {
			insertTable: InsertTableAction;
		};
		dependencies: [
			AnalyticsPlugin,
			ContentInsertionPlugin,
			WidthPlugin,
			GuidelinePlugin,
			SelectionPlugin,
		];
	}
>;

// @public (undocumented)
interface TablePluginOptions {
	// (undocumented)
	allowContextualMenu?: boolean;
	// (undocumented)
	breakoutEnabled?: boolean;
	// (undocumented)
	dragAndDropEnabled?: boolean;
	// (undocumented)
	fullWidthEnabled?: boolean;
	// (undocumented)
	getEditorFeatureFlags?: GetEditorFeatureFlags;
	// (undocumented)
	tableOptions: PluginConfig;
	// (undocumented)
	tableResizingEnabled?: boolean;
	// (undocumented)
	wasFullWidthEnabled?: boolean;
}

// @public
export const tablesPlugin: TablePlugin;

// (No @packageDocumentation comment for this package)
```

<!--SECTION END: Main Entry Types-->

### Peer Dependencies

<!--SECTION START: Peer Dependencies-->

```json
{
	"react": "^16.8.0",
	"react-dom": "^16.8.0",
	"react-intl-next": "npm:react-intl@^5.18.1"
}
```

<!--SECTION END: Peer Dependencies-->