@atlaskit/editor-plugin-expand 0.1.0

package/dist/es2019/nodeviews/index.js

@@ -0,0 +1,484 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import React from 'react';
+import ReactDOM from 'react-dom';
+import { keyName } from 'w3c-keyname';
+import { GapCursorSelection, RelativeSelectionPos, Side } from '@atlaskit/editor-common/selection';
+import { expandClassNames } from '@atlaskit/editor-common/styles';
+import { expandMessages } from '@atlaskit/editor-common/ui';
+import { closestElement, isEmptyNode } from '@atlaskit/editor-common/utils';
+import { DOMSerializer } from '@atlaskit/editor-prosemirror/model';
+import { NodeSelection, Selection } from '@atlaskit/editor-prosemirror/state';
+import { deleteExpandAtPos, setSelectionInsideExpand, toggleExpandExpanded, updateExpandTitle } from '../commands';
+import { ExpandIconButton } from '../ui/ExpandIconButton';
+function buildExpandClassName(type, expanded) {
+  return `${expandClassNames.prefix} ${expandClassNames.type(type)} ${expanded ? expandClassNames.expanded : ''}`;
+}
+const toDOM = (node, intl) => ['div', {
+  // prettier-ignore
+  'class': buildExpandClassName(node.type.name, node.attrs.__expanded),
+  'data-node-type': node.type.name,
+  'data-title': node.attrs.title
+}, ['div', {
+  // prettier-ignore
+  'class': expandClassNames.titleContainer,
+  contenteditable: 'false',
+  // Element gains access to focus events.
+  // This is needed to prevent PM gaining access
+  // on interacting with our controls.
+  tabindex: '-1'
+},
+// prettier-ignore
+['div', {
+  'class': expandClassNames.icon
+}], ['div', {
+  // prettier-ignore
+  'class': expandClassNames.inputContainer
+}, ['input', {
+  // prettier-ignore
+  'class': expandClassNames.titleInput,
+  value: node.attrs.title,
+  placeholder: intl && intl.formatMessage(expandMessages.expandPlaceholderText) || expandMessages.expandPlaceholderText.defaultMessage,
+  type: 'text'
+}]]],
+// prettier-ignore
+['div', {
+  'class': expandClassNames.content
+}, 0]];
+export class ExpandNodeView {
+  constructor(node, view, getPos, getIntl, isMobile, featureFlags, selectNearNode, api) {
+    _defineProperty(this, "allowInteractiveExpand", true);
+    _defineProperty(this, "isMobile", false);
+    _defineProperty(this, "focusTitle", () => {
+      if (this.input) {
+        const {
+          state,
+          dispatch
+        } = this.view;
+        if (this.selectNearNode) {
+          const tr = this.selectNearNode({
+            selectionRelativeToNode: RelativeSelectionPos.Start
+          })(state);
+          if (dispatch) {
+            dispatch(tr);
+          }
+        }
+        const pos = this.getPos();
+        if (typeof pos === 'number') {
+          setSelectionInsideExpand(pos)(state, dispatch, this.view);
+        }
+        this.input.focus();
+      }
+    });
+    _defineProperty(this, "handleIconKeyDown", event => {
+      switch (keyName(event)) {
+        case 'Tab':
+          event.preventDefault();
+          this.focusTitle();
+          break;
+        case 'Enter':
+          event.preventDefault();
+          this.handleClick(event);
+          break;
+      }
+    });
+    _defineProperty(this, "isAllowInteractiveExpandEnabled", () => {
+      return this.featureFlags && !!this.featureFlags.interactiveExpand;
+    });
+    _defineProperty(this, "handleClick", event => {
+      const pos = this.getPos();
+      if (typeof pos !== 'number') {
+        return;
+      }
+      const target = event.target;
+      const {
+        state,
+        dispatch
+      } = this.view;
+      if (closestElement(target, `.${expandClassNames.icon}`)) {
+        var _this$api, _this$api$analytics;
+        if (!this.isAllowInteractiveExpandEnabled()) {
+          return;
+        }
+        event.stopPropagation();
+
+        // We blur the editorView, to prevent any keyboard showing on mobile
+        // When we're interacting with the expand toggle
+        if (this.view.dom instanceof HTMLElement) {
+          this.view.dom.blur();
+        }
+        toggleExpandExpanded((_this$api = this.api) === null || _this$api === void 0 ? void 0 : (_this$api$analytics = _this$api.analytics) === null || _this$api$analytics === void 0 ? void 0 : _this$api$analytics.actions)(pos, this.node.type)(state, dispatch);
+        return;
+      }
+      if (target === this.input) {
+        event.stopPropagation();
+        this.focusTitle();
+        return;
+      }
+    });
+    _defineProperty(this, "handleInput", event => {
+      const pos = this.getPos();
+      if (typeof pos !== 'number') {
+        return;
+      }
+      const target = event.target;
+      if (target === this.input) {
+        event.stopPropagation();
+        const {
+          state,
+          dispatch
+        } = this.view;
+        updateExpandTitle(target.value, pos, this.node.type)(state, dispatch);
+      }
+    });
+    _defineProperty(this, "handleFocus", event => {
+      event.stopImmediatePropagation();
+    });
+    _defineProperty(this, "handleTitleKeydown", event => {
+      switch (keyName(event)) {
+        case 'Enter':
+          this.toggleExpand();
+          break;
+        case 'Tab':
+        case 'ArrowDown':
+          this.moveToOutsideOfTitle(event);
+          break;
+        case 'ArrowRight':
+          this.handleArrowRightFromTitle(event);
+          break;
+        case 'ArrowLeft':
+          this.handleArrowLeftFromTitle(event);
+          break;
+        case 'ArrowUp':
+          this.setLeftGapCursor(event);
+          break;
+        case 'Backspace':
+          this.deleteExpand(event);
+          break;
+      }
+    });
+    _defineProperty(this, "deleteExpand", event => {
+      if (!this.input) {
+        return;
+      }
+      const pos = this.getPos();
+      if (typeof pos !== 'number') {
+        return;
+      }
+      const {
+        selectionStart,
+        selectionEnd
+      } = this.input;
+      if (selectionStart !== selectionEnd || selectionStart !== 0) {
+        return;
+      }
+      const {
+        state
+      } = this.view;
+      const expandNode = this.node;
+      if (expandNode && isEmptyNode(state.schema)(expandNode)) {
+        var _this$api2, _this$api2$analytics;
+        deleteExpandAtPos((_this$api2 = this.api) === null || _this$api2 === void 0 ? void 0 : (_this$api2$analytics = _this$api2.analytics) === null || _this$api2$analytics === void 0 ? void 0 : _this$api2$analytics.actions)(pos, expandNode)(state, this.view.dispatch);
+      }
+    });
+    _defineProperty(this, "toggleExpand", () => {
+      const pos = this.getPos();
+      if (typeof pos !== 'number') {
+        return;
+      }
+      if (this.isAllowInteractiveExpandEnabled()) {
+        var _this$api3, _this$api3$analytics;
+        const {
+          state,
+          dispatch
+        } = this.view;
+        toggleExpandExpanded((_this$api3 = this.api) === null || _this$api3 === void 0 ? void 0 : (_this$api3$analytics = _this$api3.analytics) === null || _this$api3$analytics === void 0 ? void 0 : _this$api3$analytics.actions)(pos, this.node.type)(state, dispatch);
+      }
+    });
+    _defineProperty(this, "moveToOutsideOfTitle", event => {
+      event.preventDefault();
+      const {
+        state,
+        dispatch
+      } = this.view;
+      const expandPos = this.getPos();
+      if (typeof expandPos !== 'number') {
+        return;
+      }
+      let pos = expandPos;
+      if (this.isCollapsed()) {
+        pos = expandPos + this.node.nodeSize;
+      }
+      const resolvedPos = state.doc.resolve(pos);
+      if (!resolvedPos) {
+        return;
+      }
+      if (this.isCollapsed() && resolvedPos.nodeAfter && ['expand', 'nestedExpand'].indexOf(resolvedPos.nodeAfter.type.name) > -1) {
+        return this.setRightGapCursor(event);
+      }
+      const sel = Selection.findFrom(resolvedPos, 1, true);
+      if (sel) {
+        // If the input has focus, ProseMirror doesn't
+        // Give PM focus back before changing our selection
+        this.view.focus();
+        dispatch(state.tr.setSelection(sel));
+      }
+    });
+    _defineProperty(this, "isCollapsed", () => {
+      return !this.node.attrs.__expanded;
+    });
+    _defineProperty(this, "setRightGapCursor", event => {
+      if (!this.input) {
+        return;
+      }
+      const pos = this.getPos();
+      if (typeof pos !== 'number') {
+        return;
+      }
+      const {
+        value,
+        selectionStart,
+        selectionEnd
+      } = this.input;
+      if (selectionStart === selectionEnd && selectionStart === value.length) {
+        const {
+          state,
+          dispatch
+        } = this.view;
+        event.preventDefault();
+        this.view.focus();
+        dispatch(state.tr.setSelection(new GapCursorSelection(state.doc.resolve(this.node.nodeSize + pos), Side.RIGHT)));
+      }
+    });
+    _defineProperty(this, "setLeftGapCursor", event => {
+      if (!this.input) {
+        return;
+      }
+      const pos = this.getPos();
+      if (typeof pos !== 'number') {
+        return;
+      }
+      const {
+        selectionStart,
+        selectionEnd
+      } = this.input;
+      if (selectionStart === selectionEnd && selectionStart === 0) {
+        event.preventDefault();
+        const {
+          state,
+          dispatch
+        } = this.view;
+        this.view.focus();
+        dispatch(state.tr.setSelection(new GapCursorSelection(state.doc.resolve(pos), Side.LEFT)));
+      }
+    });
+    _defineProperty(this, "handleArrowRightFromTitle", event => {
+      if (!this.input || !this.selectNearNode) {
+        return;
+      }
+      const pos = this.getPos();
+      if (typeof pos !== 'number') {
+        return;
+      }
+      const {
+        value,
+        selectionStart,
+        selectionEnd
+      } = this.input;
+      if (selectionStart === selectionEnd && selectionStart === value.length) {
+        event.preventDefault();
+        const {
+          state,
+          dispatch
+        } = this.view;
+        this.view.focus();
+        const tr = this.selectNearNode({
+          selectionRelativeToNode: RelativeSelectionPos.End,
+          selection: NodeSelection.create(state.doc, pos)
+        })(state);
+        if (dispatch) {
+          dispatch(tr);
+        }
+      }
+    });
+    _defineProperty(this, "handleArrowLeftFromTitle", event => {
+      if (!this.input || !this.selectNearNode) {
+        return;
+      }
+      const pos = this.getPos();
+      if (typeof pos !== 'number') {
+        return;
+      }
+      const {
+        selectionStart,
+        selectionEnd
+      } = this.input;
+      if (selectionStart === selectionEnd && selectionStart === 0) {
+        var _this$api4, _this$api4$selection;
+        event.preventDefault();
+        const {
+          state,
+          dispatch
+        } = this.view;
+        this.view.focus();
+        const selectionSharedState = ((_this$api4 = this.api) === null || _this$api4 === void 0 ? void 0 : (_this$api4$selection = _this$api4.selection) === null || _this$api4$selection === void 0 ? void 0 : _this$api4$selection.sharedState.currentState()) || {};
+        // selectionRelativeToNode is undefined when user clicked to select node, then hit left to get focus in title
+        // This is a special case where we want to bypass node selection and jump straight to gap cursor
+        if ((selectionSharedState === null || selectionSharedState === void 0 ? void 0 : selectionSharedState.selectionRelativeToNode) === undefined) {
+          const tr = this.selectNearNode({
+            selectionRelativeToNode: undefined,
+            selection: new GapCursorSelection(state.doc.resolve(pos), Side.LEFT)
+          })(state);
+          if (dispatch) {
+            dispatch(tr);
+          }
+        } else {
+          const tr = this.selectNearNode({
+            selectionRelativeToNode: RelativeSelectionPos.Start,
+            selection: NodeSelection.create(state.doc, pos)
+          })(state);
+          if (dispatch) {
+            dispatch(tr);
+          }
+        }
+      }
+    });
+    this.selectNearNode = selectNearNode;
+    this.intl = getIntl();
+    const {
+      dom,
+      contentDOM
+    } = DOMSerializer.renderSpec(document, toDOM(node, this.intl));
+    this.getPos = getPos;
+    this.view = view;
+    this.node = node;
+    this.dom = dom;
+    this.contentDOM = contentDOM;
+    this.isMobile = isMobile;
+    this.featureFlags = featureFlags;
+    this.api = api;
+    this.icon = this.dom.querySelector(`.${expandClassNames.icon}`);
+    this.input = this.dom.querySelector(`.${expandClassNames.titleInput}`);
+    this.titleContainer = this.dom.querySelector(`.${expandClassNames.titleContainer}`);
+    this.content = this.dom.querySelector(`.${expandClassNames.content}`);
+    this.renderIcon(this.intl);
+    this.initHandlers();
+  }
+  initHandlers() {
+    if (this.dom) {
+      // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+      this.dom.addEventListener('click', this.handleClick);
+      // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+      this.dom.addEventListener('input', this.handleInput);
+    }
+    if (this.input) {
+      // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+      this.input.addEventListener('keydown', this.handleTitleKeydown);
+    }
+    if (this.titleContainer) {
+      // If the user interacts in our title bar (either toggle or input)
+      // Prevent ProseMirror from getting a focus event (causes weird selection issues).
+      // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+      this.titleContainer.addEventListener('focus', this.handleFocus);
+    }
+    if (this.icon) {
+      // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+      this.icon.addEventListener('keydown', this.handleIconKeyDown);
+    }
+  }
+  renderIcon(intl, node) {
+    if (!this.icon) {
+      return;
+    }
+    const {
+      __expanded
+    } = node && node.attrs || this.node.attrs;
+    ReactDOM.render( /*#__PURE__*/React.createElement(ExpandIconButton, {
+      intl: intl,
+      allowInteractiveExpand: this.isAllowInteractiveExpandEnabled(),
+      expanded: __expanded
+    }), this.icon);
+  }
+  stopEvent(event) {
+    const target = event.target;
+    return target === this.input || target === this.icon || !!closestElement(target, `.${expandClassNames.icon}`);
+  }
+  ignoreMutation(mutationRecord) {
+    // ME-1931: Mobile relies on composition which creates dom mutations. If we ignore them, prosemirror
+    // does not recognise the changes and reverts them.
+    if (this.isMobile && (mutationRecord.type === 'characterData' || mutationRecord.type === 'childList')) {
+      return false;
+    }
+    if (mutationRecord.type === 'selection') {
+      return false;
+    }
+    return true;
+  }
+  update(node, _decorations) {
+    if (this.node.type === node.type) {
+      if (this.node.attrs.__expanded !== node.attrs.__expanded) {
+        // Instead of re-rendering the view on an expand toggle
+        // we toggle a class name to hide the content and animate the chevron.
+        if (this.dom) {
+          this.dom.classList.toggle(expandClassNames.expanded);
+          this.renderIcon(this && this.intl, node);
+        }
+        if (this.content) {
+          // Disallow interaction/selection inside when collapsed.
+          this.content.setAttribute('contenteditable', node.attrs.__expanded);
+        }
+      }
+
+      // During a collab session the title doesn't sync with other users
+      // since we're intentionally being less aggressive about re-rendering.
+      // We also apply a rAF to avoid abrupt continuous replacement of the title.
+      window.requestAnimationFrame(() => {
+        if (this.input && this.node.attrs.title !== this.input.value) {
+          this.input.value = this.node.attrs.title;
+        }
+      });
+      this.node = node;
+      return true;
+    }
+    return false;
+  }
+  destroy() {
+    if (this.dom) {
+      // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+      this.dom.removeEventListener('click', this.handleClick);
+      // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+      this.dom.removeEventListener('input', this.handleInput);
+    }
+    if (this.input) {
+      // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+      this.input.removeEventListener('keydown', this.handleTitleKeydown);
+    }
+    if (this.titleContainer) {
+      // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+      this.titleContainer.removeEventListener('focus', this.handleFocus);
+    }
+    if (this.icon) {
+      // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+      this.icon.removeEventListener('keydown', this.handleIconKeyDown);
+      ReactDOM.unmountComponentAtNode(this.icon);
+    }
+
+    // @ts-ignore - [unblock prosemirror bump] reset non optional prop to undefined to clear reference
+    this.dom = undefined;
+    this.contentDOM = undefined;
+    this.icon = undefined;
+    this.input = undefined;
+    this.titleContainer = undefined;
+    this.content = undefined;
+  }
+}
+export default function ({
+  getIntl,
+  isMobile,
+  featureFlags,
+  api
+}) {
+  return (node, view, getPos) => {
+    var _api$selection, _api$selection$action;
+    return new ExpandNodeView(node, view, getPos, getIntl, isMobile, featureFlags, api === null || api === void 0 ? void 0 : (_api$selection = api.selection) === null || _api$selection === void 0 ? void 0 : (_api$selection$action = _api$selection.actions) === null || _api$selection$action === void 0 ? void 0 : _api$selection$action.selectNearNode, api);
+  };
+}

package/dist/es2019/plugin.js

@@ -0,0 +1,86 @@
+import React from 'react';
+import { expand, nestedExpand } from '@atlaskit/adf-schema';
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import { toolbarInsertBlockMessages as messages } from '@atlaskit/editor-common/messages';
+import { IconExpand } from '@atlaskit/editor-common/quick-insert';
+import { createWrapSelectionTransaction } from '@atlaskit/editor-common/utils';
+import { createExpandNode, insertExpand } from './commands';
+import { expandKeymap } from './pm-plugins/keymap';
+import { createPlugin } from './pm-plugins/main';
+import { getToolbarConfig } from './toolbar';
+export const expandPlugin = ({
+  config: options = {},
+  api
+}) => {
+  var _api$featureFlags, _api$analytics;
+  const featureFlags = (api === null || api === void 0 ? void 0 : (_api$featureFlags = api.featureFlags) === null || _api$featureFlags === void 0 ? void 0 : _api$featureFlags.sharedState.currentState()) || {};
+  return {
+    name: 'expand',
+    nodes() {
+      return [{
+        name: 'expand',
+        node: expand
+      }, {
+        name: 'nestedExpand',
+        node: nestedExpand
+      }];
+    },
+    actions: {
+      insertExpand: insertExpand(api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions)
+    },
+    pmPlugins() {
+      return [{
+        name: 'expand',
+        plugin: ({
+          dispatch,
+          getIntl
+        }) => {
+          return createPlugin(dispatch, getIntl, options.appearance, options.useLongPressSelection, featureFlags, api);
+        }
+      }, {
+        name: 'expandKeymap',
+        plugin: () => expandKeymap(api)
+      }];
+    },
+    pluginsOptions: {
+      floatingToolbar: getToolbarConfig(api),
+      quickInsert: ({
+        formatMessage
+      }) => {
+        if (options && options.allowInsertion !== true) {
+          return [];
+        }
+        return [{
+          id: 'expand',
+          title: formatMessage(messages.expand),
+          description: formatMessage(messages.expandDescription),
+          keywords: ['accordion', 'collapse'],
+          priority: 600,
+          icon: () => /*#__PURE__*/React.createElement(IconExpand, null),
+          action(insert, state) {
+            var _api$analytics2;
+            const node = createExpandNode(state);
+            if (!node) {
+              return false;
+            }
+            const tr = state.selection.empty ? insert(node) : createWrapSelectionTransaction({
+              state,
+              type: node.type
+            });
+            api === null || api === void 0 ? void 0 : (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions.attachAnalyticsEvent({
+              action: ACTION.INSERTED,
+              actionSubject: ACTION_SUBJECT.DOCUMENT,
+              actionSubjectId: node.type === state.schema.nodes.nestedExpand ? ACTION_SUBJECT_ID.NESTED_EXPAND : ACTION_SUBJECT_ID.EXPAND,
+              attributes: {
+                inputMethod: INPUT_METHOD.QUICK_INSERT
+              },
+              eventType: EVENT_TYPE.TRACK
+            })(tr);
+            return tr;
+          }
+        }];
+      }
+    }
+  };
+};
+export { pluginKey } from './pm-plugins/plugin-factory';