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

Decorations plugin for @atlaskit/editor-core

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

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

> 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 { Command } from '@atlaskit/editor-common/types';
import { Decoration } from '@atlaskit/editor-prosemirror/view';
import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
import { NodeType } from '@atlaskit/editor-prosemirror/model';

// @public (undocumented)
export type DecorationsPlugin = NextEditorPlugin<
	'decorations',
	{
		sharedState: DecorationState;
		actions: {
			hoverDecoration: HoverDecorationHandler;
			removeDecoration: typeof removeDecoration;
		};
	}
>;

// @public
export const decorationsPlugin: DecorationsPlugin;

// @public (undocumented)
export type DecorationState = {
	decoration?: Decoration;
};

// @public (undocumented)
const hoverDecoration: (
	nodeType: Array<NodeType> | NodeType,
	add: boolean,
	className?: string,
) => Command;

// @public (undocumented)
export type HoverDecorationHandler = typeof hoverDecoration;

// @public (undocumented)
const removeDecoration: Command;

// (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-->