@atlaskit/editor-plugin-layout/dist/es2019/pm-plugins/resizing.js

Layout plugin for @atlaskit/editor-core

import { isSSR } from '@atlaskit/editor-common/core-utils';
import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
import { DOMSerializer } from '@atlaskit/editor-prosemirror/model';
import { PluginKey } from '@atlaskit/editor-prosemirror/state';
import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
import { LayoutSectionView } from '../nodeviews';
import { LayoutSectionView as LayoutSectionViewVanilla } from '../nodeviews/layoutSectionView';
export const pluginKey = new PluginKey('layoutResizingPlugin');

/**
 * Minimal node view for layoutColumn that delegates all DOM serialization to the
 * NodeSpec's own toDOM, but overrides ignoreMutation to suppress style attribute
 * mutations from ProseMirror's MutationObserver.
 *
 * This is necessary so that direct inline style mutations during column drag
 * (e.g. setting flex-basis to give real-time visual feedback without dispatching
 * PM transactions) are not "corrected" back by ProseMirror's DOM reconciliation.
 */
const isLayoutElementLike = element => {
  if (isSSR()) {
    // In SSR environments, `HTMLElement` is undefined globally so a plain
    // `instanceof HTMLElement` check is always `false`. That makes the
    // `DOMSerializer.renderSpec(...)` result get rejected by the guard below and
    // the NodeView falls back to a bare `<div>`, losing every schema-defined
    // attribute (`data-layout-column`, `style="flex-basis:..."`,
    // `data-column-width`, plus the inner `<div data-layout-content="true">`
    // wrapper) and breaking the layout's flex sizing in SSR output.
    //
    // To unblock SSR without changing CSR semantics, we gate the check:
    // - In SSR, use a duck-typed check that mirrors `safe-plugin`'s `isHTMLElement`.
    // - Everywhere else, keep the original `instanceof HTMLElement` check exactly
    //   as it was so we don't accidentally widen acceptance in CSR.
    if (element === null || element === undefined) {
      return false;
    }
    return typeof element === 'object' && 'innerHTML' in element && 'style' in element && 'classList' in element;
  }
  return element instanceof HTMLElement;
};
class LayoutColumnView {
  constructor(node, view, getPos) {
    // Use the NodeSpec's own toDOM to produce the correct DOM structure and attributes.
    const nodeType = view.state.schema.nodes[node.type.name];

    // Fallback: create a plain div so PM always has a valid DOM node to work with.
    // This path should never be reached in practice — layoutColumn always has a toDOM.
    if (!nodeType.spec.toDOM) {
      const fallbackDiv = document.createElement('div');
      this.dom = fallbackDiv;
      this.contentDOM = fallbackDiv;
      return;
    }
    const {
      dom,
      contentDOM
    } = DOMSerializer.renderSpec(document, nodeType.spec.toDOM(node));
    if (!isLayoutElementLike(dom) || !isLayoutElementLike(contentDOM)) {
      const fallbackDiv = document.createElement('div');
      this.dom = fallbackDiv;
      this.contentDOM = fallbackDiv;
      return;
    }
    this.dom = dom;
    this.contentDOM = contentDOM;

    // Stamp the column's index within its parent section onto the DOM element so that
    // column-resize-divider can query columns by index rather than relying on positional
    // order of [data-layout-column] elements (which could break if the DOM structure changes).
    const pos = getPos();
    if (pos !== undefined) {
      const $pos = view.state.doc.resolve(pos);
      this.dom.setAttribute('data-layout-column-index', String($pos.index()));
    }
  }
  ignoreMutation(mutation) {
    // Ignore style attribute mutations — these are direct DOM writes during column drag
    // (setting flex-basis for real-time resize feedback). Without this, PM's
    // MutationObserver would immediately revert our style changes.
    return mutation.type === 'attributes' && mutation.attributeName === 'style';
  }
}
export default ((options, pluginInjectionApi, portalProviderAPI, eventDispatcher, intl) => new SafePlugin({
  key: pluginKey,
  props: {
    nodeViews: {
      layoutSection: (node, view, getPos) => {
        // Both experiments are required: the vanilla view renders no React, so it
        // cannot mount the <LayoutBreakoutResizer> that LayoutSectionView.render()
        // returns. That resizer is only redundant once
        // `platform_editor_breakout_resizing` is on (render() returns null and
        // breakout resizing is handled by the pragmatic resizer in
        // editor-plugin-breakout). Taking the vanilla path while that experiment is
        // off would silently remove the breakout drag handles.
        if (expValEquals('platform_editor_breakout_resizing', 'isEnabled', true) && isExperimentEnabled('platform_editor_vanilla_node_views_phase1')) {
          return new LayoutSectionViewVanilla(node);
        }
        return new LayoutSectionView({
          node,
          view,
          getPos,
          portalProviderAPI,
          eventDispatcher,
          pluginInjectionApi,
          options,
          intl
        }).init();
      },
      layoutColumn: (node, view, getPos) => new LayoutColumnView(node, view, getPos)
    }
  }
}));