@atlaskit/editor-plugin-placeholder-text/report.api.md

placeholder text plugin for @atlaskit/editor-core

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

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

> 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 { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
import type { EditorState } from '@atlaskit/editor-prosemirror/state';
import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
import type { OptionalPlugin } from '@atlaskit/editor-common/types';
import type { Transaction } from '@atlaskit/editor-prosemirror/state';
import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';

// @public (undocumented)
export interface PlaceholderTextOptions {
	// (undocumented)
	allowInserting?: boolean;
}

// @public (undocumented)
export type PlaceholderTextPlugin = NextEditorPlugin<
	'placeholderText',
	{
		dependencies: [OptionalPlugin<typeof analyticsPlugin>, OptionalPlugin<TypeAheadPlugin>];
		pluginConfiguration: PlaceholderTextOptions;
		sharedState: PlaceholderTextPluginState | undefined;
		actions: {
			showPlaceholderFloatingToolbar: typeof showPlaceholderFloatingToolbar;
		};
	}
>;

// @public (undocumented)
export const placeholderTextPlugin: PlaceholderTextPlugin;

// @public (undocumented)
export interface PlaceholderTextPluginState {
	// (undocumented)
	allowInserting: boolean;
	// (undocumented)
	showInsertPanelAt: null | number;
}

// @public (undocumented)
const showPlaceholderFloatingToolbar: (
	state: EditorState,
	dispatch: (tr: Transaction) => void,
) => boolean;

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

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

### Peer Dependencies

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

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

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