@atlaskit/editor-plugin-breakout 0.1.0

package/.eslintrc.js

@@ -0,0 +1,18 @@
+module.exports = {
+  rules: {
+    '@typescript-eslint/no-duplicate-imports': 'error',
+    '@typescript-eslint/no-explicit-any': 'error',
+    '@typescript-eslint/ban-types': [
+      'error',
+      {
+        types: {
+          'React.FC':
+            'Please use types directly on props instead, and explicitly define children if required',
+          'React.FunctionalComponent':
+            'Please use types directly on props instead, and explicitly define children if required',
+        },
+        extendDefaults: false,
+      },
+    ],
+  },
+};

package/CHANGELOG.md

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

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,30 @@
+# Editor plugin breakout
+
+Breakout plugin for @atlaskit/editor-core
+
+**Note:** This component is designed for internal Atlassian development.
+External contributors will be able to use this component but will not be able to submit issues.
+
+## Install
+---
+- **Install** - *yarn add @atlaskit/editor-plugin-breakout*
+- **npm** - [@atlaskit/editor-plugin-breakout](https://www.npmjs.com/package/@atlaskit/editor-plugin-breakout)
+- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-breakout)
+- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-breakout/dist/)
+
+## Usage
+---
+**Internal use only**
+
+@atlaskit/editor-plugin-breakout is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.
+
+Direct use of this component is not supported.
+
+Please see [Atlaskit - Editor plugin breakout](https://atlaskit.atlassian.com/packages/editor/editor-plugin-breakout) for documentation and examples for this package.
+
+## Support
+---
+For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
+## License
+---
+ Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.

package/dist/cjs/commands/remove-breakout.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.removeBreakout = removeBreakout;
+var _state = require("@atlaskit/editor-prosemirror/state");
+var _findBreakoutNode = require("../utils/find-breakout-node");
+function removeBreakout() {
+  return function (state, dispatch) {
+    var node = (0, _findBreakoutNode.findSupportedNodeForBreakout)(state.selection);
+    if (!node) {
+      return false;
+    }
+    var marks = node.node.marks.filter(function (m) {
+      return m.type.name !== 'breakout';
+    });
+    var tr = state.tr.setNodeMarkup(node.pos, node.node.type, node.node.attrs, marks);
+    tr.setMeta('scrollIntoView', false);
+    if (state.selection instanceof _state.NodeSelection) {
+      if (state.selection.$anchor.pos === node.pos) {
+        tr.setSelection(_state.NodeSelection.create(tr.doc, node.pos));
+      }
+    }
+    if (dispatch) {
+      dispatch(tr);
+    }
+    return true;
+  };
+}

package/dist/cjs/commands/set-breakout-mode.js

@@ -0,0 +1,29 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.setBreakoutMode = setBreakoutMode;
+var _state = require("@atlaskit/editor-prosemirror/state");
+var _findBreakoutNode = require("../utils/find-breakout-node");
+function setBreakoutMode(mode) {
+  return function (state, dispatch) {
+    var node = (0, _findBreakoutNode.findSupportedNodeForBreakout)(state.selection);
+    if (!node) {
+      return false;
+    }
+    var tr = state.tr.setNodeMarkup(node.pos, node.node.type, node.node.attrs, [state.schema.marks.breakout.create({
+      mode: mode
+    })]);
+    tr.setMeta('scrollIntoView', false);
+    if (state.selection instanceof _state.NodeSelection) {
+      if (state.selection.$anchor.pos === node.pos) {
+        tr.setSelection(_state.NodeSelection.create(tr.doc, node.pos));
+      }
+    }
+    if (dispatch) {
+      dispatch(tr);
+    }
+    return true;
+  };
+}

package/dist/cjs/index.js

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

package/dist/cjs/plugin-key.js

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.pluginKey = exports.getPluginState = void 0;
+var _state = require("@atlaskit/editor-prosemirror/state");
+var pluginKey = exports.pluginKey = new _state.PluginKey('breakoutPlugin');
+var getPluginState = exports.getPluginState = function getPluginState(state) {
+  return pluginKey.getState(state) || undefined;
+};

package/dist/cjs/plugin.js

@@ -0,0 +1,218 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.breakoutPlugin = void 0;
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _react = _interopRequireDefault(require("react"));
+var _adfSchema = require("@atlaskit/adf-schema");
+var _hooks = require("@atlaskit/editor-common/hooks");
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _styles = require("@atlaskit/editor-common/styles");
+var _utils = require("@atlaskit/editor-common/utils");
+var _editorSharedStyles = require("@atlaskit/editor-shared-styles");
+var _pluginKey = require("./plugin-key");
+var _LayoutButton = _interopRequireDefault(require("./ui/LayoutButton"));
+var _findBreakoutNode = require("./utils/find-breakout-node");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var BreakoutView = /*#__PURE__*/function () {
+  function BreakoutView(
+  /**
+   * Note: this is actually a PMMark -- however our version
+   * of the prosemirror and prosemirror types mean using PMNode
+   * is not problematic.
+   */
+  mark, view, pluginInjectionApi) {
+    var _this = this;
+    (0, _classCallCheck2.default)(this, BreakoutView);
+    (0, _defineProperty2.default)(this, "updateWidth", function (widthState) {
+      // we skip updating the width of breakout nodes if the editorView dom
+      // element was hidden (to avoid breakout width and button thrashing
+      // when an editor is hidden, re-rendered and unhidden).
+      if (widthState === undefined || widthState.width === 0) {
+        return;
+      }
+      var containerStyle = "";
+      var contentStyle = "";
+      var breakoutWidthPx = (0, _utils.calcBreakoutWidthPx)(_this.mark.attrs.mode, widthState.width);
+      if (widthState.lineLength) {
+        if (breakoutWidthPx < widthState.lineLength) {
+          breakoutWidthPx = widthState.lineLength;
+        }
+        containerStyle += "\n        transform: none;\n        display: flex;\n        justify-content: center;\n        ";
+
+        // There is a delay in the animation because widthState is delayed.
+        // When the editor goes full width the animation for the editor
+        // begins and finishes before widthState can update the new dimensions.
+        contentStyle += "\n        min-width: ".concat(breakoutWidthPx, "px;\n        transition: min-width 0.5s ").concat(_editorSharedStyles.akEditorSwoopCubicBezier, ";\n      ");
+      } else {
+        // fallback method
+        // (lineLength is not normally undefined, but might be in e.g. SSR or initial render)
+        //
+        // this approach doesn't work well with position: fixed, so
+        // it breaks things like sticky headers
+        containerStyle += "width: ".concat(breakoutWidthPx, "px; transform: translateX(-50%); margin-left: 50%;");
+      }
+
+      // NOTE: This is a hack to ignore mutation since mark NodeView doesn't support
+      // `ignoreMutation` life-cycle event. @see ED-9947
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      var viewDomObserver = _this.view.domObserver;
+      if (viewDomObserver && _this.view.dom) {
+        viewDomObserver.stop();
+        setTimeout(function () {
+          viewDomObserver.start();
+        }, 0);
+      }
+      if (typeof _this.dom.style.cssText !== 'undefined') {
+        _this.dom.style.cssText = containerStyle;
+        _this.contentDOM.style.cssText = contentStyle;
+      } else {
+        _this.dom.setAttribute('style', containerStyle);
+        _this.contentDOM.setAttribute('style', contentStyle);
+      }
+    });
+    var contentDOM = document.createElement('div');
+    contentDOM.className = _styles.BreakoutCssClassName.BREAKOUT_MARK_DOM;
+    var dom = document.createElement('div');
+    dom.className = _styles.BreakoutCssClassName.BREAKOUT_MARK;
+    dom.setAttribute('data-layout', mark.attrs.mode);
+    dom.appendChild(contentDOM);
+    this.dom = dom;
+    this.mark = mark;
+    this.view = view;
+    this.contentDOM = contentDOM;
+    this.unsubscribe = pluginInjectionApi === null || pluginInjectionApi === void 0 ? void 0 : pluginInjectionApi.width.sharedState.onChange(function (_ref) {
+      var nextSharedState = _ref.nextSharedState;
+      return _this.updateWidth(nextSharedState);
+    });
+    this.updateWidth(pluginInjectionApi === null || pluginInjectionApi === void 0 ? void 0 : pluginInjectionApi.width.sharedState.currentState());
+  }
+  (0, _createClass2.default)(BreakoutView, [{
+    key: "destroy",
+    value:
+    // NOTE: Lifecycle events doesn't work for mark NodeView. So currently this is a no-op.
+    // @see https://github.com/ProseMirror/prosemirror/issues/1082
+    function destroy() {
+      var _this$unsubscribe;
+      (_this$unsubscribe = this.unsubscribe) === null || _this$unsubscribe === void 0 || _this$unsubscribe.call(this);
+    }
+  }]);
+  return BreakoutView;
+}();
+function shouldPluginStateUpdate(newBreakoutNode, currentBreakoutNode) {
+  if (newBreakoutNode && currentBreakoutNode) {
+    return newBreakoutNode !== currentBreakoutNode;
+  }
+  return newBreakoutNode || currentBreakoutNode ? true : false;
+}
+function createPlugin(pluginInjectionApi, _ref2) {
+  var dispatch = _ref2.dispatch;
+  return new _safePlugin.SafePlugin({
+    state: {
+      init: function init() {
+        return {
+          breakoutNode: undefined
+        };
+      },
+      apply: function apply(tr, pluginState) {
+        var breakoutNode = (0, _findBreakoutNode.findSupportedNodeForBreakout)(tr.selection);
+        if (shouldPluginStateUpdate(breakoutNode, pluginState.breakoutNode)) {
+          var nextPluginState = _objectSpread(_objectSpread({}, pluginState), {}, {
+            breakoutNode: breakoutNode
+          });
+          dispatch(_pluginKey.pluginKey, nextPluginState);
+          return nextPluginState;
+        }
+        return pluginState;
+      }
+    },
+    key: _pluginKey.pluginKey,
+    props: {
+      nodeViews: {
+        // Note: When we upgrade to prosemirror 1.27.2 -- we should
+        // move this to markViews.
+        // See the following link for more details:
+        // https://prosemirror.net/docs/ref/#view.EditorProps.nodeViews.
+        breakout: function breakout(mark, view) {
+          return new BreakoutView(mark, view, pluginInjectionApi);
+        }
+      }
+    }
+  });
+}
+var LayoutButtonWrapper = function LayoutButtonWrapper(_ref3) {
+  var _breakoutState$breako, _breakoutState$breako2;
+  var api = _ref3.api,
+    editorView = _ref3.editorView,
+    boundariesElement = _ref3.boundariesElement,
+    scrollableElement = _ref3.scrollableElement,
+    mountPoint = _ref3.mountPoint;
+  // Re-render with `width` (but don't use state) due to https://bitbucket.org/atlassian/%7Bc8e2f021-38d2-46d0-9b7a-b3f7b428f724%7D/pull-requests/24272
+  var _useSharedPluginState = (0, _hooks.useSharedPluginState)(api, ['width', 'breakout']),
+    breakoutState = _useSharedPluginState.breakoutState;
+  return /*#__PURE__*/_react.default.createElement(_LayoutButton.default, {
+    editorView: editorView,
+    mountPoint: mountPoint,
+    boundariesElement: boundariesElement,
+    scrollableElement: scrollableElement,
+    node: (_breakoutState$breako = breakoutState === null || breakoutState === void 0 || (_breakoutState$breako2 = breakoutState.breakoutNode) === null || _breakoutState$breako2 === void 0 ? void 0 : _breakoutState$breako2.node) !== null && _breakoutState$breako !== void 0 ? _breakoutState$breako : null
+  });
+};
+var breakoutPlugin = exports.breakoutPlugin = function breakoutPlugin(_ref4) {
+  var options = _ref4.config,
+    api = _ref4.api;
+  return {
+    name: 'breakout',
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'breakout',
+        plugin: function plugin(props) {
+          return createPlugin(api, props);
+        }
+      }];
+    },
+    marks: function marks() {
+      return [{
+        name: 'breakout',
+        mark: _adfSchema.breakout
+      }];
+    },
+    getSharedState: function getSharedState(editorState) {
+      if (!editorState) {
+        return {
+          breakoutNode: undefined
+        };
+      }
+      var pluginState = _pluginKey.pluginKey.getState(editorState);
+      if (!pluginState) {
+        return {
+          breakoutNode: undefined
+        };
+      }
+      return pluginState;
+    },
+    contentComponent: function contentComponent(_ref5) {
+      var editorView = _ref5.editorView,
+        popupsMountPoint = _ref5.popupsMountPoint,
+        popupsBoundariesElement = _ref5.popupsBoundariesElement,
+        popupsScrollableElement = _ref5.popupsScrollableElement;
+      // This is a bit crappy, but should be resolved once we move to a static schema.
+      if (options && !options.allowBreakoutButton) {
+        return null;
+      }
+      return /*#__PURE__*/_react.default.createElement(LayoutButtonWrapper, {
+        api: api,
+        mountPoint: popupsMountPoint,
+        editorView: editorView,
+        boundariesElement: popupsBoundariesElement,
+        scrollableElement: popupsScrollableElement
+      });
+    }
+  };
+};

package/dist/cjs/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/cjs/ui/LayoutButton.js

@@ -0,0 +1,114 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = require("react");
+var _react2 = require("@emotion/react");
+var _reactIntlNext = require("react-intl-next");
+var _styles = require("@atlaskit/editor-common/styles");
+var _ui = require("@atlaskit/editor-common/ui");
+var _uiMenu = require("@atlaskit/editor-common/ui-menu");
+var _utils = require("@atlaskit/editor-common/utils");
+var _state = require("@atlaskit/editor-prosemirror/state");
+var _utils2 = require("@atlaskit/editor-prosemirror/utils");
+var _collapse = _interopRequireDefault(require("@atlaskit/icon/glyph/editor/collapse"));
+var _expand = _interopRequireDefault(require("@atlaskit/icon/glyph/editor/expand"));
+var _colors = require("@atlaskit/theme/colors");
+var _constants = require("@atlaskit/theme/constants");
+var _removeBreakout = require("../commands/remove-breakout");
+var _setBreakoutMode = require("../commands/set-breakout-mode");
+var _pluginKey = require("../plugin-key");
+var _getBreakoutMode = require("../utils/get-breakout-mode");
+var _isBreakoutMarkAllowed = require("../utils/is-breakout-mark-allowed");
+var _isSupportedNode = require("../utils/is-supported-node");
+/** @jsx jsx */
+
+var toolbarButtonWrapperStyles = (0, _react2.css)({
+  // eslint-disable-next-line @atlaskit/design-system/no-nested-styles
+  '&& button': {
+    background: "var(--ds-background-neutral, ".concat(_colors.N20A, ")"),
+    color: "var(--ds-icon, ".concat(_colors.N300, ")"),
+    ':hover': {
+      background: "var(--ds-background-neutral-hovered, ".concat(_colors.B300, ")"),
+      color: "var(--ds-icon, white)".concat(" !important")
+    }
+  }
+});
+function getBreakoutNodeElement(pluginState, selection, editorView) {
+  if (!pluginState.breakoutNode) {
+    return undefined;
+  }
+  if (selection instanceof _state.NodeSelection && (0, _isSupportedNode.isSupportedNodeForBreakout)(selection.node)) {
+    return (0, _utils2.findDomRefAtPos)(selection.from, editorView.domAtPos.bind(editorView));
+  }
+  return (0, _utils2.findParentDomRefOfType)(pluginState.breakoutNode.node.type, editorView.domAtPos.bind(editorView))(selection);
+}
+var LayoutButton = function LayoutButton(_ref) {
+  var formatMessage = _ref.intl.formatMessage,
+    mountPoint = _ref.mountPoint,
+    boundariesElement = _ref.boundariesElement,
+    scrollableElement = _ref.scrollableElement,
+    editorView = _ref.editorView,
+    node = _ref.node;
+  var handleClick = (0, _react.useCallback)(function (breakoutMode) {
+    var state = editorView.state,
+      dispatch = editorView.dispatch;
+    if (['wide', 'full-width'].indexOf(breakoutMode) !== -1) {
+      (0, _setBreakoutMode.setBreakoutMode)(breakoutMode)(state, dispatch);
+    } else {
+      (0, _removeBreakout.removeBreakout)()(state, dispatch);
+    }
+  }, [editorView]);
+  var state = editorView.state;
+  if (!node || !(0, _isBreakoutMarkAllowed.isBreakoutMarkAllowed)(state)) {
+    return null;
+  }
+  var breakoutMode = (0, _getBreakoutMode.getBreakoutMode)(editorView.state);
+  var titleMessage = (0, _utils.getTitle)(breakoutMode);
+  var title = formatMessage(titleMessage);
+  var nextBreakoutMode = (0, _utils.getNextBreakoutMode)(breakoutMode);
+  var belowOtherPopupsZIndex = _constants.layers.layer() - 1;
+  var pluginState = (0, _pluginKey.getPluginState)(state);
+  if (!pluginState) {
+    return null;
+  }
+  var element = getBreakoutNodeElement(pluginState, state.selection, editorView);
+  if (!element) {
+    return null;
+  }
+  var closestEl = element.querySelector(".".concat(_styles.BreakoutCssClassName.BREAKOUT_MARK_DOM));
+  if (closestEl && closestEl.firstChild) {
+    element = closestEl.firstChild;
+  }
+  return (0, _react2.jsx)(_ui.Popup, {
+    ariaLabel: title,
+    target: element,
+    offset: [5, 0],
+    alignY: "start",
+    alignX: "end",
+    mountTo: mountPoint,
+    boundariesElement: boundariesElement,
+    scrollableElement: scrollableElement,
+    stick: true,
+    forcePlacement: true,
+    zIndex: belowOtherPopupsZIndex
+  }, (0, _react2.jsx)("div", {
+    css: toolbarButtonWrapperStyles
+  }, (0, _react2.jsx)(_uiMenu.ToolbarButton, {
+    title: title,
+    testId: titleMessage.id,
+    onClick: function onClick() {
+      return handleClick(nextBreakoutMode);
+    },
+    iconBefore: breakoutMode === 'full-width' ? (0, _react2.jsx)(_collapse.default, {
+      label: title
+    }) : (0, _react2.jsx)(_expand.default, {
+      label: title
+    })
+  })));
+};
+LayoutButton.displayName = 'LayoutButton';
+var _default = exports.default = (0, _reactIntlNext.injectIntl)(LayoutButton);

package/dist/cjs/utils/find-breakout-node.js

@@ -0,0 +1,42 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.findSupportedNodeForBreakout = findSupportedNodeForBreakout;
+var _state = require("@atlaskit/editor-prosemirror/state");
+var _utils = require("@atlaskit/editor-prosemirror/utils");
+var _isSupportedNode = require("./is-supported-node");
+/**
+ * Find the nearest parent node to the selection that supports breakout, or if the nearest
+ * matching parent node is the doc, return undefined.
+ * For depth, if a node is selected and supports breakout, return the depth of the node.
+ * @param selection Current editor selection
+ */
+function findSupportedNodeForBreakout(selection) {
+  if (selection instanceof _state.NodeSelection) {
+    var supportsBreakout = (0, _isSupportedNode.isSupportedNodeForBreakout)(selection.node);
+    if (supportsBreakout) {
+      return {
+        pos: selection.from,
+        start: selection.from,
+        node: selection.node,
+        // If a selected expand is in a doc, the depth of that expand is 0. Therefore
+        // we don't need to subtract 1 or instantly return false if the depth is 0
+        depth: selection.$anchor.depth
+      };
+    }
+  }
+  var breakoutNode = (0, _utils.findParentNode)(_isSupportedNode.isSupportedNodeForBreakout)(selection);
+  if (!breakoutNode || breakoutNode.depth === 0) {
+    // If this node doesn't exist or the only supporting node is the document
+    // (with depth 0), then we're not inside a node that supports breakout
+    return undefined;
+  }
+  return {
+    node: breakoutNode.node,
+    start: breakoutNode.start,
+    pos: breakoutNode.pos,
+    depth: breakoutNode.depth - 1
+  };
+}

package/dist/cjs/utils/get-breakout-mode.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getBreakoutMode = getBreakoutMode;
+var _findBreakoutNode = require("./find-breakout-node");
+/**
+ * Get the current mode of the breakout at the selection
+ * @param state Current EditorState
+ */
+function getBreakoutMode(state) {
+  var node = (0, _findBreakoutNode.findSupportedNodeForBreakout)(state.selection);
+  if (!node) {
+    return;
+  }
+  var breakoutMark = node.node.marks.find(function (m) {
+    return m.type.name === 'breakout';
+  });
+  if (!breakoutMark) {
+    return;
+  }
+  return breakoutMark.attrs.mode;
+}

package/dist/cjs/utils/is-breakout-mark-allowed.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isBreakoutMarkAllowed = isBreakoutMarkAllowed;
+var _findBreakoutNode = require("./find-breakout-node");
+/**
+ * Check if breakout should be allowed for the current selection. If a node is selected,
+ * can this node be broken out, if text, can the enclosing parent node be broken out.
+ *
+ * Currently breakout of a node is not possible if it's nested in anything but the document, however
+ * this logic supports this changing.
+ */
+function isBreakoutMarkAllowed(state) {
+  if (!state.schema.marks.breakout) {
+    return false;
+  }
+  var supportedNodeParent = (0, _findBreakoutNode.findSupportedNodeForBreakout)(state.selection);
+  if (!supportedNodeParent) {
+    return false;
+  }
+  // At the moment we can only breakout when the depth is 0, ie. doc is the only node
+  // that supports breakout. This *could* change though.
+  var parent = state.selection.$from.node(supportedNodeParent.depth);
+  return parent.type.allowsMarkType(state.schema.marks.breakout);
+}

package/dist/cjs/utils/is-supported-node.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isSupportedNodeForBreakout = isSupportedNodeForBreakout;
+var supportedNodesForBreakout = ['codeBlock', 'layoutSection', 'expand'];
+
+/**
+ * Check if breakout can be applied to a node
+ * @param node Node to check
+ */
+function isSupportedNodeForBreakout(node) {
+  return supportedNodesForBreakout.indexOf(node.type.name) !== -1;
+}

package/dist/es2019/commands/remove-breakout.js

@@ -0,0 +1,22 @@
+import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
+import { findSupportedNodeForBreakout } from '../utils/find-breakout-node';
+export function removeBreakout() {
+  return (state, dispatch) => {
+    const node = findSupportedNodeForBreakout(state.selection);
+    if (!node) {
+      return false;
+    }
+    const marks = node.node.marks.filter(m => m.type.name !== 'breakout');
+    const tr = state.tr.setNodeMarkup(node.pos, node.node.type, node.node.attrs, marks);
+    tr.setMeta('scrollIntoView', false);
+    if (state.selection instanceof NodeSelection) {
+      if (state.selection.$anchor.pos === node.pos) {
+        tr.setSelection(NodeSelection.create(tr.doc, node.pos));
+      }
+    }
+    if (dispatch) {
+      dispatch(tr);
+    }
+    return true;
+  };
+}

package/dist/es2019/commands/set-breakout-mode.js

@@ -0,0 +1,23 @@
+import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
+import { findSupportedNodeForBreakout } from '../utils/find-breakout-node';
+export function setBreakoutMode(mode) {
+  return (state, dispatch) => {
+    const node = findSupportedNodeForBreakout(state.selection);
+    if (!node) {
+      return false;
+    }
+    const tr = state.tr.setNodeMarkup(node.pos, node.node.type, node.node.attrs, [state.schema.marks.breakout.create({
+      mode
+    })]);
+    tr.setMeta('scrollIntoView', false);
+    if (state.selection instanceof NodeSelection) {
+      if (state.selection.$anchor.pos === node.pos) {
+        tr.setSelection(NodeSelection.create(tr.doc, node.pos));
+      }
+    }
+    if (dispatch) {
+      dispatch(tr);
+    }
+    return true;
+  };
+}

package/dist/es2019/index.js

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

package/dist/es2019/plugin-key.js

@@ -0,0 +1,3 @@
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export const pluginKey = new PluginKey('breakoutPlugin');
+export const getPluginState = state => pluginKey.getState(state) || undefined;