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

Placeholder plugin for @atlaskit/editor-core.

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

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

> 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 { CompositionPlugin } from '@atlaskit/editor-plugin-composition';
import type { FocusPlugin } from '@atlaskit/editor-plugin-focus';
import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';

// @public (undocumented)
export type PlaceholderPlugin = NextEditorPlugin<
	'placeholder',
	{
		pluginConfiguration: PlaceholderPluginOptions | undefined;
		dependencies: [FocusPlugin, CompositionPlugin, TypeAheadPlugin];
	}
>;

// @public (undocumented)
export const placeholderPlugin: PlaceholderPlugin;

// @public (undocumented)
export interface PlaceholderPluginOptions {
	// (undocumented)
	placeholder?: string;
	// (undocumented)
	placeholderBracketHint?: string;
}

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

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

### Peer Dependencies

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

```json
{
	"react": "^16.8.0"
}
```

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