@atlaskit/editor-plugin-decorations 0.1.0

package/CHANGELOG.md

@@ -0,0 +1 @@
+# @atlaskit/editor-plugin-decorations

package/LICENSE.md

@@ -0,0 +1,13 @@
+Copyright 2023 Atlassian Pty Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,7 @@
+# EditorPluginDecorations
+
+Decorations plugin for @atlaskit/editor-core
+
+## Usage
+
+`import { decorationsPlugin } from '@atlaskit/editor-plugin-decorations';`

package/dist/cjs/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "decorationsPlugin", {
+  enumerable: true,
+  get: function get() {
+    return _plugin.decorationsPlugin;
+  }
+});
+var _plugin = require("./plugin");

package/dist/cjs/plugin.js

@@ -0,0 +1,36 @@
+"use strict";
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.decorationsPlugin = void 0;
+var _pmPlugin = _interopRequireWildcard(require("./pm-plugin"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+var decorationsPlugin = function decorationsPlugin() {
+  return {
+    name: 'decorations',
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'decorationPlugin',
+        plugin: function plugin() {
+          return (0, _pmPlugin.default)();
+        }
+      }];
+    },
+    actions: {
+      hoverDecoration: _pmPlugin.hoverDecoration,
+      removeDecoration: _pmPlugin.removeDecoration
+    },
+    getSharedState: function getSharedState(editorState) {
+      if (!editorState) {
+        return {
+          decoration: undefined
+        };
+      }
+      return _pmPlugin.decorationStateKey.getState(editorState);
+    }
+  };
+};
+exports.decorationsPlugin = decorationsPlugin;

package/dist/cjs/pm-plugin.js

@@ -0,0 +1,125 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.removeDecoration = exports.hoverDecoration = exports.default = exports.decorationStateKey = exports.ACTIONS = void 0;
+var _prosemirrorState = require("prosemirror-state");
+var _prosemirrorUtils = require("prosemirror-utils");
+var _prosemirrorView = require("prosemirror-view");
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var decorationStateKey = new _prosemirrorState.PluginKey('decorationPlugin');
+exports.decorationStateKey = decorationStateKey;
+var ACTIONS = /*#__PURE__*/function (ACTIONS) {
+  ACTIONS[ACTIONS["DECORATION_ADD"] = 0] = "DECORATION_ADD";
+  ACTIONS[ACTIONS["DECORATION_REMOVE"] = 1] = "DECORATION_REMOVE";
+  return ACTIONS;
+}({});
+exports.ACTIONS = ACTIONS;
+var removeDecoration = function removeDecoration(state, dispatch) {
+  var tr = state.tr;
+  if (dispatch) {
+    dispatch(tr.setMeta(decorationStateKey, {
+      action: ACTIONS.DECORATION_REMOVE
+    }));
+    return true;
+  }
+  return false;
+};
+exports.removeDecoration = removeDecoration;
+var hoverDecoration = function hoverDecoration(nodeType, add) {
+  var className = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 'danger';
+  return function (state, dispatch) {
+    var from;
+    var parentNode;
+    if (state.selection instanceof _prosemirrorState.NodeSelection) {
+      var selectedNode = state.selection.node;
+      var nodeTypes = Array.isArray(nodeType) ? nodeType : [nodeType];
+      var isNodeTypeMatching = nodeTypes.indexOf(selectedNode.type) > -1;
+      // This adds danger styling if the selected node is the one that requires
+      // the decoration to be added, e.g. if a layout is selected and the user
+      // hovers over the layout's delete button.
+      if (isNodeTypeMatching) {
+        from = state.selection.from;
+        parentNode = selectedNode;
+      }
+    }
+
+    // This adds danger styling if the selection is not a node selection, OR if
+    // the selected node is a child of the one that requires the decoration to
+    // be added, e.g. if a decision item is selected inside a layout and the
+    // user hovers over the layout's delete button.
+    var foundParentNode = (0, _prosemirrorUtils.findParentNodeOfType)(nodeType)(state.selection);
+    if (from === undefined && foundParentNode) {
+      from = foundParentNode.pos;
+      parentNode = foundParentNode.node;
+    }
+
+    // Note: can't use !from as from could be 0, which is falsy but valid
+    if (from === undefined || parentNode === undefined) {
+      return false;
+    }
+    if (dispatch) {
+      dispatch(state.tr.setMeta(decorationStateKey, {
+        action: add ? ACTIONS.DECORATION_ADD : ACTIONS.DECORATION_REMOVE,
+        data: _prosemirrorView.Decoration.node(from, from + parentNode.nodeSize, {
+          class: className
+        }, {
+          key: 'decorationNode'
+        })
+      }).setMeta('addToHistory', false));
+    }
+    return true;
+  };
+};
+exports.hoverDecoration = hoverDecoration;
+var _default = function _default() {
+  return new _safePlugin.SafePlugin({
+    key: decorationStateKey,
+    state: {
+      init: function init() {
+        return {
+          decoration: undefined
+        };
+      },
+      apply: function apply(tr, pluginState) {
+        if (pluginState.decoration) {
+          var mapResult = tr.mapping.mapResult(pluginState.decoration.from);
+          if (mapResult.deleted) {
+            pluginState = {
+              decoration: undefined
+            };
+          }
+        }
+        var meta = tr.getMeta(decorationStateKey);
+        if (!meta) {
+          return pluginState;
+        }
+        switch (meta.action) {
+          case ACTIONS.DECORATION_ADD:
+            return {
+              decoration: meta.data
+            };
+          case ACTIONS.DECORATION_REMOVE:
+            return {
+              decoration: undefined
+            };
+          default:
+            return pluginState;
+        }
+      }
+    },
+    props: {
+      decorations: function decorations(state) {
+        var doc = state.doc;
+        var _ref = decorationStateKey.getState(state),
+          decoration = _ref.decoration;
+        if (decoration) {
+          return _prosemirrorView.DecorationSet.create(doc, [decoration]);
+        }
+        return null;
+      }
+    }
+  });
+};
+exports.default = _default;

package/dist/cjs/version.json

@@ -0,0 +1,5 @@
+{
+	"name": "@atlaskit/editor-plugin-decorations",
+	"version": "0.1.0",
+	"sideEffects": false
+}

package/dist/es2019/index.js

@@ -0,0 +1 @@
+export { decorationsPlugin } from './plugin';

package/dist/es2019/plugin.js

@@ -0,0 +1,22 @@
+import decorationPlugin, { decorationStateKey, hoverDecoration, removeDecoration } from './pm-plugin';
+export const decorationsPlugin = () => ({
+  name: 'decorations',
+  pmPlugins() {
+    return [{
+      name: 'decorationPlugin',
+      plugin: () => decorationPlugin()
+    }];
+  },
+  actions: {
+    hoverDecoration,
+    removeDecoration
+  },
+  getSharedState(editorState) {
+    if (!editorState) {
+      return {
+        decoration: undefined
+      };
+    }
+    return decorationStateKey.getState(editorState);
+  }
+});

package/dist/es2019/pm-plugin.js

@@ -0,0 +1,114 @@
+import { NodeSelection, PluginKey } from 'prosemirror-state';
+import { findParentNodeOfType } from 'prosemirror-utils';
+import { Decoration, DecorationSet } from 'prosemirror-view';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+export const decorationStateKey = new PluginKey('decorationPlugin');
+export let ACTIONS = /*#__PURE__*/function (ACTIONS) {
+  ACTIONS[ACTIONS["DECORATION_ADD"] = 0] = "DECORATION_ADD";
+  ACTIONS[ACTIONS["DECORATION_REMOVE"] = 1] = "DECORATION_REMOVE";
+  return ACTIONS;
+}({});
+export const removeDecoration = (state, dispatch) => {
+  const {
+    tr
+  } = state;
+  if (dispatch) {
+    dispatch(tr.setMeta(decorationStateKey, {
+      action: ACTIONS.DECORATION_REMOVE
+    }));
+    return true;
+  }
+  return false;
+};
+export const hoverDecoration = (nodeType, add, className = 'danger') => (state, dispatch) => {
+  let from;
+  let parentNode;
+  if (state.selection instanceof NodeSelection) {
+    const selectedNode = state.selection.node;
+    const nodeTypes = Array.isArray(nodeType) ? nodeType : [nodeType];
+    const isNodeTypeMatching = nodeTypes.indexOf(selectedNode.type) > -1;
+    // This adds danger styling if the selected node is the one that requires
+    // the decoration to be added, e.g. if a layout is selected and the user
+    // hovers over the layout's delete button.
+    if (isNodeTypeMatching) {
+      from = state.selection.from;
+      parentNode = selectedNode;
+    }
+  }
+
+  // This adds danger styling if the selection is not a node selection, OR if
+  // the selected node is a child of the one that requires the decoration to
+  // be added, e.g. if a decision item is selected inside a layout and the
+  // user hovers over the layout's delete button.
+  const foundParentNode = findParentNodeOfType(nodeType)(state.selection);
+  if (from === undefined && foundParentNode) {
+    from = foundParentNode.pos;
+    parentNode = foundParentNode.node;
+  }
+
+  // Note: can't use !from as from could be 0, which is falsy but valid
+  if (from === undefined || parentNode === undefined) {
+    return false;
+  }
+  if (dispatch) {
+    dispatch(state.tr.setMeta(decorationStateKey, {
+      action: add ? ACTIONS.DECORATION_ADD : ACTIONS.DECORATION_REMOVE,
+      data: Decoration.node(from, from + parentNode.nodeSize, {
+        class: className
+      }, {
+        key: 'decorationNode'
+      })
+    }).setMeta('addToHistory', false));
+  }
+  return true;
+};
+export default (() => {
+  return new SafePlugin({
+    key: decorationStateKey,
+    state: {
+      init: () => ({
+        decoration: undefined
+      }),
+      apply(tr, pluginState) {
+        if (pluginState.decoration) {
+          const mapResult = tr.mapping.mapResult(pluginState.decoration.from);
+          if (mapResult.deleted) {
+            pluginState = {
+              decoration: undefined
+            };
+          }
+        }
+        const meta = tr.getMeta(decorationStateKey);
+        if (!meta) {
+          return pluginState;
+        }
+        switch (meta.action) {
+          case ACTIONS.DECORATION_ADD:
+            return {
+              decoration: meta.data
+            };
+          case ACTIONS.DECORATION_REMOVE:
+            return {
+              decoration: undefined
+            };
+          default:
+            return pluginState;
+        }
+      }
+    },
+    props: {
+      decorations(state) {
+        const {
+          doc
+        } = state;
+        const {
+          decoration
+        } = decorationStateKey.getState(state);
+        if (decoration) {
+          return DecorationSet.create(doc, [decoration]);
+        }
+        return null;
+      }
+    }
+  });
+});

package/dist/es2019/version.json

@@ -0,0 +1,5 @@
+{
+	"name": "@atlaskit/editor-plugin-decorations",
+	"version": "0.1.0",
+	"sideEffects": false
+}

package/dist/esm/index.js

@@ -0,0 +1 @@
+export { decorationsPlugin } from './plugin';

package/dist/esm/plugin.js

@@ -0,0 +1,26 @@
+import decorationPlugin, { decorationStateKey, hoverDecoration, removeDecoration } from './pm-plugin';
+export var decorationsPlugin = function decorationsPlugin() {
+  return {
+    name: 'decorations',
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'decorationPlugin',
+        plugin: function plugin() {
+          return decorationPlugin();
+        }
+      }];
+    },
+    actions: {
+      hoverDecoration: hoverDecoration,
+      removeDecoration: removeDecoration
+    },
+    getSharedState: function getSharedState(editorState) {
+      if (!editorState) {
+        return {
+          decoration: undefined
+        };
+      }
+      return decorationStateKey.getState(editorState);
+    }
+  };
+};

package/dist/esm/pm-plugin.js

@@ -0,0 +1,114 @@
+import { NodeSelection, PluginKey } from 'prosemirror-state';
+import { findParentNodeOfType } from 'prosemirror-utils';
+import { Decoration, DecorationSet } from 'prosemirror-view';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+export var decorationStateKey = new PluginKey('decorationPlugin');
+export var ACTIONS = /*#__PURE__*/function (ACTIONS) {
+  ACTIONS[ACTIONS["DECORATION_ADD"] = 0] = "DECORATION_ADD";
+  ACTIONS[ACTIONS["DECORATION_REMOVE"] = 1] = "DECORATION_REMOVE";
+  return ACTIONS;
+}({});
+export var removeDecoration = function removeDecoration(state, dispatch) {
+  var tr = state.tr;
+  if (dispatch) {
+    dispatch(tr.setMeta(decorationStateKey, {
+      action: ACTIONS.DECORATION_REMOVE
+    }));
+    return true;
+  }
+  return false;
+};
+export var hoverDecoration = function hoverDecoration(nodeType, add) {
+  var className = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 'danger';
+  return function (state, dispatch) {
+    var from;
+    var parentNode;
+    if (state.selection instanceof NodeSelection) {
+      var selectedNode = state.selection.node;
+      var nodeTypes = Array.isArray(nodeType) ? nodeType : [nodeType];
+      var isNodeTypeMatching = nodeTypes.indexOf(selectedNode.type) > -1;
+      // This adds danger styling if the selected node is the one that requires
+      // the decoration to be added, e.g. if a layout is selected and the user
+      // hovers over the layout's delete button.
+      if (isNodeTypeMatching) {
+        from = state.selection.from;
+        parentNode = selectedNode;
+      }
+    }
+
+    // This adds danger styling if the selection is not a node selection, OR if
+    // the selected node is a child of the one that requires the decoration to
+    // be added, e.g. if a decision item is selected inside a layout and the
+    // user hovers over the layout's delete button.
+    var foundParentNode = findParentNodeOfType(nodeType)(state.selection);
+    if (from === undefined && foundParentNode) {
+      from = foundParentNode.pos;
+      parentNode = foundParentNode.node;
+    }
+
+    // Note: can't use !from as from could be 0, which is falsy but valid
+    if (from === undefined || parentNode === undefined) {
+      return false;
+    }
+    if (dispatch) {
+      dispatch(state.tr.setMeta(decorationStateKey, {
+        action: add ? ACTIONS.DECORATION_ADD : ACTIONS.DECORATION_REMOVE,
+        data: Decoration.node(from, from + parentNode.nodeSize, {
+          class: className
+        }, {
+          key: 'decorationNode'
+        })
+      }).setMeta('addToHistory', false));
+    }
+    return true;
+  };
+};
+export default (function () {
+  return new SafePlugin({
+    key: decorationStateKey,
+    state: {
+      init: function init() {
+        return {
+          decoration: undefined
+        };
+      },
+      apply: function apply(tr, pluginState) {
+        if (pluginState.decoration) {
+          var mapResult = tr.mapping.mapResult(pluginState.decoration.from);
+          if (mapResult.deleted) {
+            pluginState = {
+              decoration: undefined
+            };
+          }
+        }
+        var meta = tr.getMeta(decorationStateKey);
+        if (!meta) {
+          return pluginState;
+        }
+        switch (meta.action) {
+          case ACTIONS.DECORATION_ADD:
+            return {
+              decoration: meta.data
+            };
+          case ACTIONS.DECORATION_REMOVE:
+            return {
+              decoration: undefined
+            };
+          default:
+            return pluginState;
+        }
+      }
+    },
+    props: {
+      decorations: function decorations(state) {
+        var doc = state.doc;
+        var _ref = decorationStateKey.getState(state),
+          decoration = _ref.decoration;
+        if (decoration) {
+          return DecorationSet.create(doc, [decoration]);
+        }
+        return null;
+      }
+    }
+  });
+});

package/dist/esm/version.json

@@ -0,0 +1,5 @@
+{
+	"name": "@atlaskit/editor-plugin-decorations",
+	"version": "0.1.0",
+	"sideEffects": false
+}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export { decorationsPlugin } from './plugin';
+export type { HoverDecorationHandler, DecorationState } from './pm-plugin';

package/dist/types/plugin.d.ts

@@ -0,0 +1,9 @@
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import { DecorationState, HoverDecorationHandler, removeDecoration } from './pm-plugin';
+export declare const decorationsPlugin: NextEditorPlugin<'decorations', {
+    sharedState: DecorationState;
+    actions: {
+        hoverDecoration: HoverDecorationHandler;
+        removeDecoration: typeof removeDecoration;
+    };
+}>;

package/dist/types/pm-plugin.d.ts

@@ -0,0 +1,19 @@
+import { NodeType } from 'prosemirror-model';
+import { PluginKey } from 'prosemirror-state';
+import { Decoration } from 'prosemirror-view';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { Command } from '@atlaskit/editor-common/types';
+export declare const decorationStateKey: PluginKey<any, any>;
+export declare enum ACTIONS {
+    DECORATION_ADD = 0,
+    DECORATION_REMOVE = 1
+}
+export declare const removeDecoration: Command;
+export declare const hoverDecoration: (nodeType: NodeType | Array<NodeType>, add: boolean, className?: string) => Command;
+export type DecorationState = {
+    decoration?: Decoration;
+};
+type HoverDecorationHandler = typeof hoverDecoration;
+export type { HoverDecorationHandler };
+declare const _default: () => SafePlugin<DecorationState, any>;
+export default _default;

package/dist/types-ts4.5/index.d.ts

@@ -0,0 +1,2 @@
+export { decorationsPlugin } from './plugin';
+export type { HoverDecorationHandler, DecorationState } from './pm-plugin';

package/dist/types-ts4.5/plugin.d.ts

@@ -0,0 +1,9 @@
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import { DecorationState, HoverDecorationHandler, removeDecoration } from './pm-plugin';
+export declare const decorationsPlugin: NextEditorPlugin<'decorations', {
+    sharedState: DecorationState;
+    actions: {
+        hoverDecoration: HoverDecorationHandler;
+        removeDecoration: typeof removeDecoration;
+    };
+}>;

package/dist/types-ts4.5/pm-plugin.d.ts

@@ -0,0 +1,19 @@
+import { NodeType } from 'prosemirror-model';
+import { PluginKey } from 'prosemirror-state';
+import { Decoration } from 'prosemirror-view';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { Command } from '@atlaskit/editor-common/types';
+export declare const decorationStateKey: PluginKey<any, any>;
+export declare enum ACTIONS {
+    DECORATION_ADD = 0,
+    DECORATION_REMOVE = 1
+}
+export declare const removeDecoration: Command;
+export declare const hoverDecoration: (nodeType: NodeType | Array<NodeType>, add: boolean, className?: string) => Command;
+export type DecorationState = {
+    decoration?: Decoration;
+};
+type HoverDecorationHandler = typeof hoverDecoration;
+export type { HoverDecorationHandler };
+declare const _default: () => SafePlugin<DecorationState, any>;
+export default _default;

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@atlaskit/editor-plugin-decorations",
+  "version": "0.1.0",
+  "description": "Decorations plugin for @atlaskit/editor-core",
+  "author": "Atlassian Pty Ltd",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "atlassian": {
+    "team": "Editor",
+    "releaseModel": "scheduled"
+  },
+  "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "module:es2019": "dist/es2019/index.js",
+  "types": "dist/types/index.d.ts",
+  "sideEffects": false,
+  "atlaskit:src": "src/index.ts",
+  "af:exports": {
+    ".": "./src/index.ts"
+  },
+  "dependencies": {
+    "@atlaskit/editor-common": "^74.3.0",
+    "@babel/runtime": "^7.0.0",
+    "prosemirror-model": "1.16.0",
+    "prosemirror-state": "1.3.4",
+    "prosemirror-utils": "^1.0.0-0",
+    "prosemirror-view": "1.23.7"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0"
+  },
+  "devDependencies": {
+    "@atlaskit/docs": "*",
+    "@atlaskit/editor-core": "^185.0.0",
+    "@atlaskit/editor-test-helpers": "^18.2.0",
+    "@atlaskit/ssr": "*",
+    "@atlaskit/visual-regression": "*",
+    "@atlaskit/webdriver-runner": "*",
+    "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
+    "@testing-library/react": "^12.1.5",
+    "react-dom": "^16.8.0",
+    "typescript": "~4.9.5",
+    "wait-for-expect": "^1.2.0"
+  },
+  "techstack": {
+    "@atlassian/frontend": {
+      "import-structure": [
+        "atlassian-conventions"
+      ],
+      "circular-dependencies": [
+        "file-and-folder-level"
+      ]
+    },
+    "@repo/internal": {
+      "dom-events": "use-bind-event-listener",
+      "analytics": [
+        "analytics-next"
+      ],
+      "design-tokens": [
+        "color"
+      ],
+      "theming": [
+        "react-context"
+      ],
+      "ui-components": [
+        "lite-mode"
+      ],
+      "deprecation": [
+        "no-deprecated-imports"
+      ],
+      "styling": [
+        "static",
+        "emotion"
+      ]
+    }
+  },
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
+}

package/report.api.md

@@ -0,0 +1,68 @@
+<!-- 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 'prosemirror-view';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import { NodeType } from 'prosemirror-model';
+
+// @public (undocumented)
+export const decorationsPlugin: NextEditorPlugin<
+  'decorations',
+  {
+    sharedState: DecorationState;
+    actions: {
+      hoverDecoration: HoverDecorationHandler;
+      removeDecoration: typeof removeDecoration;
+    };
+  }
+>;
+
+// @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-->