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

Base plugin for @atlaskit/editor-core

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

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

> 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 { BrowserFreezetracking } from '@atlaskit/editor-common/types';
import type { Command } from '@atlaskit/editor-common/types';
import type { ContextIdentifierProvider } from '@atlaskit/editor-common/provider-factory';
import type { EditorView } from '@atlaskit/editor-prosemirror/view';
import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
import type { InputTracking } from '@atlaskit/editor-common/types';
import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
import type { OptionalPlugin } from '@atlaskit/editor-common/types';

// @public (undocumented)
export type BasePlugin = NextEditorPlugin<
	'base',
	{
		pluginConfiguration: BasePluginOptions | undefined;
		dependencies: [OptionalPlugin<FeatureFlagsPlugin>];
		sharedState: BasePluginState;
		actions: {
			setKeyboardHeight: typeof setKeyboardHeight;
		};
	}
>;

// @public (undocumented)
export const basePlugin: BasePlugin;

// @public (undocumented)
export interface BasePluginOptions {
	// (undocumented)
	allowInlineCursorTarget?: boolean;
	// (undocumented)
	allowScrollGutter?: ScrollGutterPluginOptions;
	// (undocumented)
	browserFreezeTracking?: BrowserFreezetracking;
	// (undocumented)
	inputTracking?: InputTracking;
	// (undocumented)
	ufo?: boolean;
}

// @public (undocumented)
export type BasePluginState = {
	contextIdentifier: ContextIdentifierProvider | undefined;
	keyboardHeight: number | undefined;
};

// @public (undocumented)
export type ScrollGutterPluginOptions = {
	getScrollElement?: (view: EditorView) => HTMLElement | null;
	allowCustomScrollHandler?: boolean;
	persistScrollGutter?: boolean;
	gutterSize?: number;
};

// @public (undocumented)
const setKeyboardHeight: (keyboardHeight: number) => Command;

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

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

### Peer Dependencies

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

```json
{}
```

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