@atlaskit/editor-core 187.38.5 → 187.39.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/editor-core
 
+## 187.39.0
+
+### Minor Changes
+
+- [`985ecca5c88`](https://bitbucket.org/atlassian/atlassian-frontend/commits/985ecca5c88) - Add new editor plugin action for the selection plugin, which allows other plugins to control the visibility of the gap cursor
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 187.38.5
 
 ### Patch Changes

package/dist/cjs/plugins/selection/index.js

@@ -8,17 +8,29 @@ exports.selectionPlugin = exports.default = void 0;
 var _selectionMain = require("./pm-plugins/selection-main");
 var _keymap = _interopRequireDefault(require("./pm-plugins/keymap"));
 var _gapCursorMain = _interopRequireDefault(require("./pm-plugins/gap-cursor-main"));
+var _gapCursorPluginKey = require("./pm-plugins/gap-cursor-plugin-key");
 var _gapCursorKeymap = _interopRequireDefault(require("./pm-plugins/gap-cursor-keymap"));
-var selectionPlugin = function selectionPlugin(_ref) {
-  var options = _ref.config;
+var displayGapCursor = function displayGapCursor(toggle) {
+  return function (_ref) {
+    var tr = _ref.tr;
+    return tr.setMeta(_gapCursorPluginKey.gapCursorPluginKey, {
+      displayGapCursor: toggle
+    });
+  };
+};
+var selectionPlugin = function selectionPlugin(_ref2) {
+  var options = _ref2.config;
   return {
     name: 'selection',
+    commands: {
+      displayGapCursor: displayGapCursor
+    },
     pmPlugins: function pmPlugins() {
       return [{
         name: 'selection',
-        plugin: function plugin(_ref2) {
-          var dispatch = _ref2.dispatch,
-            dispatchAnalyticsEvent = _ref2.dispatchAnalyticsEvent;
+        plugin: function plugin(_ref3) {
+          var dispatch = _ref3.dispatch,
+            dispatchAnalyticsEvent = _ref3.dispatchAnalyticsEvent;
           return (0, _selectionMain.createPlugin)(dispatch, dispatchAnalyticsEvent, options);
         }
       }, {

package/dist/cjs/plugins/selection/pm-plugins/gap-cursor-main.js

@@ -20,10 +20,20 @@ var plugin = new _safePlugin.SafePlugin({
   key: _gapCursorPluginKey.gapCursorPluginKey,
   state: {
     init: function init() {
-      return false;
+      return {
+        selectionIsGapCursor: false,
+        displayGapCursor: true
+      };
     },
-    apply: function apply(_tr, _pluginState, _oldState, newState) {
-      return newState.selection instanceof _selection.GapCursorSelection;
+    apply: function apply(tr, pluginState, _oldState, newState) {
+      var _meta$displayGapCurso;
+      var meta = tr.getMeta(_gapCursorPluginKey.gapCursorPluginKey);
+      var selectionIsGapCursor = newState.selection instanceof _selection.GapCursorSelection;
+      return {
+        selectionIsGapCursor: selectionIsGapCursor,
+        // only attempt to hide gap cursor if selection is gap cursor
+        displayGapCursor: selectionIsGapCursor ? (_meta$displayGapCurso = meta === null || meta === void 0 ? void 0 : meta.displayGapCursor) !== null && _meta$displayGapCurso !== void 0 ? _meta$displayGapCurso : pluginState.displayGapCursor : true
+      };
     }
   },
   view: function view(_view) {
@@ -40,9 +50,10 @@ var plugin = new _safePlugin.SafePlugin({
     }
     return {
       update: function update(view) {
-        var pluginState = _gapCursorPluginKey.gapCursorPluginKey.getState(view.state);
+        var _gapCursorPluginKey$g = _gapCursorPluginKey.gapCursorPluginKey.getState(view.state),
+          selectionIsGapCursor = _gapCursorPluginKey$g.selectionIsGapCursor;
         /**
-         * Starting with prosemirror-view 1.19.4, cursor wrapper that previousely was hiding cursor doesn't exist:
+         * Starting with prosemirror-view 1.19.4, cursor wrapper that previously was hiding cursor doesn't exist:
          * https://github.com/ProseMirror/prosemirror-view/commit/4a56bc7b7e61e96ef879d1dae1014ede0fc09e43
          *
          * Because it was causing issues with RTL: https://github.com/ProseMirror/prosemirror/issues/948
@@ -52,15 +63,17 @@ var plugin = new _safePlugin.SafePlugin({
          *
          * Browser support is pretty good: https://caniuse.com/#feat=css-caret-color
          */
-        view.dom.classList.toggle(_styles.hideCaretModifier, pluginState);
+        view.dom.classList.toggle(_styles.hideCaretModifier, selectionIsGapCursor);
       }
     };
   },
   props: {
-    decorations: function decorations(_ref) {
-      var doc = _ref.doc,
-        selection = _ref.selection;
-      if (selection instanceof _selection.GapCursorSelection) {
+    decorations: function decorations(editorState) {
+      var doc = editorState.doc,
+        selection = editorState.selection;
+      var _gapCursorPluginKey$g2 = _gapCursorPluginKey.gapCursorPluginKey.getState(editorState),
+        displayGapCursor = _gapCursorPluginKey$g2.displayGapCursor;
+      if (selection instanceof _selection.GapCursorSelection && displayGapCursor) {
         var $from = selection.$from,
           side = selection.side;
 

package/dist/cjs/version-wrapper.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = "@atlaskit/editor-core";
 exports.name = name;
-var version = "187.38.5";
+var version = "187.39.0";
 exports.version = version;
 var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');

package/dist/es2019/plugins/selection/index.js

@@ -1,11 +1,22 @@
 import { createPlugin } from './pm-plugins/selection-main';
 import selectionKeymapPlugin from './pm-plugins/keymap';
 import gapCursorPlugin from './pm-plugins/gap-cursor-main';
+import { gapCursorPluginKey } from './pm-plugins/gap-cursor-plugin-key';
 import gapCursorKeymapPlugin from './pm-plugins/gap-cursor-keymap';
+const displayGapCursor = toggle => ({
+  tr
+}) => {
+  return tr.setMeta(gapCursorPluginKey, {
+    displayGapCursor: toggle
+  });
+};
 export const selectionPlugin = ({
   config: options
 }) => ({
   name: 'selection',
+  commands: {
+    displayGapCursor
+  },
   pmPlugins() {
     return [{
       name: 'selection',

package/dist/es2019/plugins/selection/pm-plugins/gap-cursor-main.js

@@ -13,9 +13,19 @@ import { gapCursorPluginKey } from './gap-cursor-plugin-key';
 const plugin = new SafePlugin({
   key: gapCursorPluginKey,
   state: {
-    init: () => false,
-    apply: (_tr, _pluginState, _oldState, newState) => {
-      return newState.selection instanceof GapCursorSelection;
+    init: () => ({
+      selectionIsGapCursor: false,
+      displayGapCursor: true
+    }),
+    apply: (tr, pluginState, _oldState, newState) => {
+      var _meta$displayGapCurso;
+      const meta = tr.getMeta(gapCursorPluginKey);
+      const selectionIsGapCursor = newState.selection instanceof GapCursorSelection;
+      return {
+        selectionIsGapCursor,
+        // only attempt to hide gap cursor if selection is gap cursor
+        displayGapCursor: selectionIsGapCursor ? (_meta$displayGapCurso = meta === null || meta === void 0 ? void 0 : meta.displayGapCursor) !== null && _meta$displayGapCurso !== void 0 ? _meta$displayGapCurso : pluginState.displayGapCursor : true
+      };
     }
   },
   view: view => {
@@ -32,9 +42,11 @@ const plugin = new SafePlugin({
     }
     return {
       update(view) {
-        const pluginState = gapCursorPluginKey.getState(view.state);
+        const {
+          selectionIsGapCursor
+        } = gapCursorPluginKey.getState(view.state);
         /**
-         * Starting with prosemirror-view 1.19.4, cursor wrapper that previousely was hiding cursor doesn't exist:
+         * Starting with prosemirror-view 1.19.4, cursor wrapper that previously was hiding cursor doesn't exist:
          * https://github.com/ProseMirror/prosemirror-view/commit/4a56bc7b7e61e96ef879d1dae1014ede0fc09e43
          *
          * Because it was causing issues with RTL: https://github.com/ProseMirror/prosemirror/issues/948
@@ -44,16 +56,20 @@ const plugin = new SafePlugin({
          *
          * Browser support is pretty good: https://caniuse.com/#feat=css-caret-color
          */
-        view.dom.classList.toggle(hideCaretModifier, pluginState);
+        view.dom.classList.toggle(hideCaretModifier, selectionIsGapCursor);
       }
     };
   },
   props: {
-    decorations: ({
-      doc,
-      selection
-    }) => {
-      if (selection instanceof GapCursorSelection) {
+    decorations: editorState => {
+      const {
+        doc,
+        selection
+      } = editorState;
+      const {
+        displayGapCursor
+      } = gapCursorPluginKey.getState(editorState);
+      if (selection instanceof GapCursorSelection && displayGapCursor) {
         const {
           $from,
           side

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/editor-core";
-export const version = "187.38.5";
+export const version = "187.39.0";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/plugins/selection/index.js

@@ -1,17 +1,29 @@
 import { createPlugin } from './pm-plugins/selection-main';
 import selectionKeymapPlugin from './pm-plugins/keymap';
 import gapCursorPlugin from './pm-plugins/gap-cursor-main';
+import { gapCursorPluginKey } from './pm-plugins/gap-cursor-plugin-key';
 import gapCursorKeymapPlugin from './pm-plugins/gap-cursor-keymap';
-export var selectionPlugin = function selectionPlugin(_ref) {
-  var options = _ref.config;
+var displayGapCursor = function displayGapCursor(toggle) {
+  return function (_ref) {
+    var tr = _ref.tr;
+    return tr.setMeta(gapCursorPluginKey, {
+      displayGapCursor: toggle
+    });
+  };
+};
+export var selectionPlugin = function selectionPlugin(_ref2) {
+  var options = _ref2.config;
   return {
     name: 'selection',
+    commands: {
+      displayGapCursor: displayGapCursor
+    },
     pmPlugins: function pmPlugins() {
       return [{
         name: 'selection',
-        plugin: function plugin(_ref2) {
-          var dispatch = _ref2.dispatch,
-            dispatchAnalyticsEvent = _ref2.dispatchAnalyticsEvent;
+        plugin: function plugin(_ref3) {
+          var dispatch = _ref3.dispatch,
+            dispatchAnalyticsEvent = _ref3.dispatchAnalyticsEvent;
           return createPlugin(dispatch, dispatchAnalyticsEvent, options);
         }
       }, {

package/dist/esm/plugins/selection/pm-plugins/gap-cursor-main.js

@@ -14,10 +14,20 @@ var plugin = new SafePlugin({
   key: gapCursorPluginKey,
   state: {
     init: function init() {
-      return false;
+      return {
+        selectionIsGapCursor: false,
+        displayGapCursor: true
+      };
     },
-    apply: function apply(_tr, _pluginState, _oldState, newState) {
-      return newState.selection instanceof GapCursorSelection;
+    apply: function apply(tr, pluginState, _oldState, newState) {
+      var _meta$displayGapCurso;
+      var meta = tr.getMeta(gapCursorPluginKey);
+      var selectionIsGapCursor = newState.selection instanceof GapCursorSelection;
+      return {
+        selectionIsGapCursor: selectionIsGapCursor,
+        // only attempt to hide gap cursor if selection is gap cursor
+        displayGapCursor: selectionIsGapCursor ? (_meta$displayGapCurso = meta === null || meta === void 0 ? void 0 : meta.displayGapCursor) !== null && _meta$displayGapCurso !== void 0 ? _meta$displayGapCurso : pluginState.displayGapCursor : true
+      };
     }
   },
   view: function view(_view) {
@@ -34,9 +44,10 @@ var plugin = new SafePlugin({
     }
     return {
       update: function update(view) {
-        var pluginState = gapCursorPluginKey.getState(view.state);
+        var _gapCursorPluginKey$g = gapCursorPluginKey.getState(view.state),
+          selectionIsGapCursor = _gapCursorPluginKey$g.selectionIsGapCursor;
         /**
-         * Starting with prosemirror-view 1.19.4, cursor wrapper that previousely was hiding cursor doesn't exist:
+         * Starting with prosemirror-view 1.19.4, cursor wrapper that previously was hiding cursor doesn't exist:
          * https://github.com/ProseMirror/prosemirror-view/commit/4a56bc7b7e61e96ef879d1dae1014ede0fc09e43
          *
          * Because it was causing issues with RTL: https://github.com/ProseMirror/prosemirror/issues/948
@@ -46,15 +57,17 @@ var plugin = new SafePlugin({
          *
          * Browser support is pretty good: https://caniuse.com/#feat=css-caret-color
          */
-        view.dom.classList.toggle(hideCaretModifier, pluginState);
+        view.dom.classList.toggle(hideCaretModifier, selectionIsGapCursor);
       }
     };
   },
   props: {
-    decorations: function decorations(_ref) {
-      var doc = _ref.doc,
-        selection = _ref.selection;
-      if (selection instanceof GapCursorSelection) {
+    decorations: function decorations(editorState) {
+      var doc = editorState.doc,
+        selection = editorState.selection;
+      var _gapCursorPluginKey$g2 = gapCursorPluginKey.getState(editorState),
+        displayGapCursor = _gapCursorPluginKey$g2.displayGapCursor;
+      if (selection instanceof GapCursorSelection && displayGapCursor) {
         var $from = selection.$from,
           side = selection.side;
 

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/editor-core";
-export var version = "187.38.5";
+export var version = "187.39.0";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/types/labs/next/presets/default.d.ts

@@ -61,6 +61,9 @@ export declare function createDefaultPreset(options: EditorPresetProps & Default
     };
 }, CodeBlockOptions>, import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"selection", {
     pluginConfiguration: SelectionPluginOptions | undefined;
+    commands: {
+        displayGapCursor: (toggle: boolean) => import("@atlaskit/editor-common/types").EditorCommand;
+    };
 }, SelectionPluginOptions | undefined>, import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"floatingToolbar", {
     dependencies: [import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"featureFlags", {
         pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
@@ -213,6 +216,9 @@ export declare function useDefaultPreset(props: EditorPresetProps & DefaultPrese
     };
 }, CodeBlockOptions>, import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"selection", {
     pluginConfiguration: SelectionPluginOptions | undefined;
+    commands: {
+        displayGapCursor: (toggle: boolean) => import("@atlaskit/editor-common/types").EditorCommand;
+    };
 }, SelectionPluginOptions | undefined>, import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"floatingToolbar", {
     dependencies: [import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"featureFlags", {
         pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;

package/dist/types/plugins/selection/index.d.ts

@@ -1,6 +1,10 @@
-import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { EditorCommand, NextEditorPlugin } from '@atlaskit/editor-common/types';
 import type { SelectionPluginOptions } from './types';
-export declare const selectionPlugin: NextEditorPlugin<'selection', {
+type SelectionPlugin = NextEditorPlugin<'selection', {
     pluginConfiguration: SelectionPluginOptions | undefined;
+    commands: {
+        displayGapCursor: (toggle: boolean) => EditorCommand;
+    };
 }>;
+export declare const selectionPlugin: SelectionPlugin;
 export default selectionPlugin;

package/dist/types/plugins/selection/pm-plugins/gap-cursor-main.d.ts

@@ -1,3 +1,6 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-declare const plugin: SafePlugin<boolean>;
+declare const plugin: SafePlugin<{
+    selectionIsGapCursor: boolean;
+    displayGapCursor: boolean;
+}>;
 export default plugin;

package/dist/types-ts4.5/labs/next/presets/default.d.ts

@@ -84,6 +84,9 @@ export declare function createDefaultPreset(options: EditorPresetProps & Default
     }, CodeBlockOptions>,
     import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"selection", {
         pluginConfiguration: SelectionPluginOptions | undefined;
+        commands: {
+            displayGapCursor: (toggle: boolean) => import("@atlaskit/editor-common/types").EditorCommand;
+        };
     }, SelectionPluginOptions | undefined>,
     import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"floatingToolbar", {
         dependencies: [
@@ -290,6 +293,9 @@ export declare function useDefaultPreset(props: EditorPresetProps & DefaultPrese
     }, CodeBlockOptions>,
     import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"selection", {
         pluginConfiguration: SelectionPluginOptions | undefined;
+        commands: {
+            displayGapCursor: (toggle: boolean) => import("@atlaskit/editor-common/types").EditorCommand;
+        };
     }, SelectionPluginOptions | undefined>,
     import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"floatingToolbar", {
         dependencies: [

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

@@ -1,6 +1,10 @@
-import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { EditorCommand, NextEditorPlugin } from '@atlaskit/editor-common/types';
 import type { SelectionPluginOptions } from './types';
-export declare const selectionPlugin: NextEditorPlugin<'selection', {
+type SelectionPlugin = NextEditorPlugin<'selection', {
     pluginConfiguration: SelectionPluginOptions | undefined;
+    commands: {
+        displayGapCursor: (toggle: boolean) => EditorCommand;
+    };
 }>;
+export declare const selectionPlugin: SelectionPlugin;
 export default selectionPlugin;

package/dist/types-ts4.5/plugins/selection/pm-plugins/gap-cursor-main.d.ts

@@ -1,3 +1,6 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-declare const plugin: SafePlugin<boolean>;
+declare const plugin: SafePlugin<{
+    selectionIsGapCursor: boolean;
+    displayGapCursor: boolean;
+}>;
 export default plugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-core",
-  "version": "187.38.5",
+  "version": "187.39.0",
   "description": "A package contains Atlassian editor core functionality",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -78,7 +78,7 @@
     "@atlaskit/editor-plugin-list": "^1.2.0",
     "@atlaskit/editor-plugin-placeholder": "^0.1.0",
     "@atlaskit/editor-plugin-rule": "^0.1.0",
-    "@atlaskit/editor-plugin-table": "^2.12.0",
+    "@atlaskit/editor-plugin-table": "^2.13.0",
     "@atlaskit/editor-plugin-text-formatting": "^0.4.0",
     "@atlaskit/editor-plugin-type-ahead": "^0.3.0",
     "@atlaskit/editor-plugin-unsupported-content": "^0.2.0",
@@ -118,7 +118,7 @@
     "@atlaskit/textfield": "^5.6.0",
     "@atlaskit/theme": "^12.6.0",
     "@atlaskit/toggle": "^12.6.0",
-    "@atlaskit/tokens": "^1.20.0",
+    "@atlaskit/tokens": "^1.21.0",
     "@atlaskit/tooltip": "^17.8.0",
     "@atlaskit/width-detector": "^4.1.0",
     "@babel/runtime": "^7.0.0",
@@ -152,7 +152,7 @@
     "@atlaskit/collab-provider": "9.12.1",
     "@atlaskit/dropdown-menu": "^11.13.0",
     "@atlaskit/editor-extension-dropbox": "^0.4.0",
-    "@atlaskit/editor-plugin-table": "^2.12.0",
+    "@atlaskit/editor-plugin-table": "^2.13.0",
     "@atlaskit/flag": "^15.2.0",
     "@atlaskit/icon-object": "^6.3.0",
     "@atlaskit/inline-dialog": "^13.6.0",