@atlaskit/editor-plugin-block-menu 25.0.0 → 25.1.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/editor-plugin-block-menu
 
+## 25.1.0
+
+### Minor Changes
+
+- [`a4adb021ec6f2`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/a4adb021ec6f2) -
+  Add `enableCopyLinkToSelection` block menu option (default `false`) so the "Copy link" item and
+  its keyboard shortcut are opt-in per editor preset, and enable it for Confluence presets. The
+  option is only respected behind the `platform_editor_block_menu_copy_link_opt_in` feature gate
+
+### Patch Changes
+
+- Updated dependencies
+
+## 25.0.1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 25.0.0
 
 ### Patch Changes

package/dist/cjs/pm-plugins/keymap.js

@@ -6,16 +6,15 @@ Object.defineProperty(exports, "__esModule", {
 exports.keymapPlugin = keymapPlugin;
 var _keymaps = require("@atlaskit/editor-common/keymaps");
 var _selection = require("@atlaskit/editor-common/selection");
-var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _blockMenuPluginType = require("../blockMenuPluginType");
 var _main = require("../pm-plugins/main");
 var _copyLink = require("../ui/utils/copyLink");
+var _isCopyLinkEnabled = require("./utils/isCopyLinkEnabled");
 function keymapPlugin(api, config) {
   var list = {};
   var copyLinkToBlockCommand = function copyLinkToBlockCommand(state, dispatch) {
     var _api$blockControls, _node$attrs;
-    // Check if feature flag is enabled
-    if (!(0, _fg.fg)('platform_editor_adf_with_localid')) {
+    if (!(0, _isCopyLinkEnabled.isCopyLinkEnabled)(config)) {
       return false;
     }
 

package/dist/cjs/pm-plugins/utils/isCopyLinkEnabled.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isCopyLinkEnabled = void 0;
+var _fg = require("@atlaskit/platform-feature-flags/fg");
+/**
+ * Whether the "Copy link" block menu item and its keyboard shortcut are available.
+ *
+ * Copy link only works when blocks have localIds, so it is opt-in per editor preset via
+ * `enableCopyLinkToSelection`. While `platform_editor_block_menu_copy_link_opt_in` is off, the previous
+ * behaviour is kept and `enableCopyLinkToSelection` is ignored.
+ */
+var isCopyLinkEnabled = exports.isCopyLinkEnabled = function isCopyLinkEnabled(config) {
+  if (!(0, _fg.fg)('platform_editor_adf_with_localid')) {
+    return false;
+  }
+  if ((0, _fg.fg)('platform_editor_block_menu_copy_link_opt_in')) {
+    return Boolean(config === null || config === void 0 ? void 0 : config.enableCopyLinkToSelection);
+  }
+  return true;
+};

package/dist/cjs/ui/copy-link.js

@@ -15,9 +15,9 @@ var _keymaps = require("@atlaskit/editor-common/keymaps");
 var _messages = require("@atlaskit/editor-common/messages");
 var _editorToolbar = require("@atlaskit/editor-toolbar");
 var _link = _interopRequireDefault(require("@atlaskit/icon/core/link"));
-var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _blockMenuPluginType = require("../blockMenuPluginType");
 var _main = require("../pm-plugins/main");
+var _isCopyLinkEnabled = require("../pm-plugins/utils/isCopyLinkEnabled");
 var _blockMenuProvider = require("./block-menu-provider");
 var _consts = require("./consts");
 var _copyLink = require("./utils/copyLink");
@@ -84,9 +84,7 @@ var CopyLinkDropdownItemContent = function CopyLinkDropdownItemContent(_ref) {
       }
     });
   }, [api, blockLinkHashPrefix, getLinkPath, onDropdownOpenChanged, selection]);
-
-  // Hide copy link when `platform_editor_adf_with_localid` feature flag is off
-  if (!(0, _fg.fg)('platform_editor_adf_with_localid')) {
+  if (!(0, _isCopyLinkEnabled.isCopyLinkEnabled)(config)) {
     return null;
   }
   return /*#__PURE__*/_react.default.createElement(_editorToolbar.ToolbarDropdownItem, {

package/dist/es2019/pm-plugins/keymap.js

@@ -1,15 +1,14 @@
 import { bindKeymapWithCommand, copyLinkToBlock, keymap } from '@atlaskit/editor-common/keymaps';
 import { expandSelectionToBlockRange } from '@atlaskit/editor-common/selection';
-import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { FLAG_ID } from '../blockMenuPluginType';
 import { blockMenuPluginKey } from '../pm-plugins/main';
 import { copyLink } from '../ui/utils/copyLink';
+import { isCopyLinkEnabled } from './utils/isCopyLinkEnabled';
 export function keymapPlugin(api, config) {
   const list = {};
   const copyLinkToBlockCommand = (state, dispatch) => {
     var _api$blockControls, _api$blockControls$sh, _node$attrs;
-    // Check if feature flag is enabled
-    if (!fg('platform_editor_adf_with_localid')) {
+    if (!isCopyLinkEnabled(config)) {
       return false;
     }
 

package/dist/es2019/pm-plugins/utils/isCopyLinkEnabled.js

@@ -0,0 +1,17 @@
+import { fg } from '@atlaskit/platform-feature-flags/fg';
+/**
+ * Whether the "Copy link" block menu item and its keyboard shortcut are available.
+ *
+ * Copy link only works when blocks have localIds, so it is opt-in per editor preset via
+ * `enableCopyLinkToSelection`. While `platform_editor_block_menu_copy_link_opt_in` is off, the previous
+ * behaviour is kept and `enableCopyLinkToSelection` is ignored.
+ */
+export const isCopyLinkEnabled = config => {
+  if (!fg('platform_editor_adf_with_localid')) {
+    return false;
+  }
+  if (fg('platform_editor_block_menu_copy_link_opt_in')) {
+    return Boolean(config === null || config === void 0 ? void 0 : config.enableCopyLinkToSelection);
+  }
+  return true;
+};

package/dist/es2019/ui/copy-link.js

@@ -7,9 +7,9 @@ import { copyLinkToBlock, formatShortcut } from '@atlaskit/editor-common/keymaps
 import { blockMenuMessages as messages } from '@atlaskit/editor-common/messages';
 import { ToolbarDropdownItem, ToolbarKeyboardShortcutHint } from '@atlaskit/editor-toolbar';
 import LinkIcon from '@atlaskit/icon/core/link';
-import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { FLAG_ID } from '../blockMenuPluginType';
 import { blockMenuPluginKey } from '../pm-plugins/main';
+import { isCopyLinkEnabled } from '../pm-plugins/utils/isCopyLinkEnabled';
 import { useBlockMenu } from './block-menu-provider';
 import { BLOCK_MENU_ITEM_NAME } from './consts';
 import { copyLink } from './utils/copyLink';
@@ -83,9 +83,7 @@ const CopyLinkDropdownItemContent = ({
       }
     });
   }, [api, blockLinkHashPrefix, getLinkPath, onDropdownOpenChanged, selection]);
-
-  // Hide copy link when `platform_editor_adf_with_localid` feature flag is off
-  if (!fg('platform_editor_adf_with_localid')) {
+  if (!isCopyLinkEnabled(config)) {
     return null;
   }
   return /*#__PURE__*/React.createElement(ToolbarDropdownItem, {

package/dist/esm/pm-plugins/keymap.js

@@ -1,15 +1,14 @@
 import { bindKeymapWithCommand, copyLinkToBlock, keymap } from '@atlaskit/editor-common/keymaps';
 import { expandSelectionToBlockRange } from '@atlaskit/editor-common/selection';
-import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { FLAG_ID } from '../blockMenuPluginType';
 import { blockMenuPluginKey } from '../pm-plugins/main';
 import { copyLink } from '../ui/utils/copyLink';
+import { isCopyLinkEnabled } from './utils/isCopyLinkEnabled';
 export function keymapPlugin(api, config) {
   var list = {};
   var copyLinkToBlockCommand = function copyLinkToBlockCommand(state, dispatch) {
     var _api$blockControls, _node$attrs;
-    // Check if feature flag is enabled
-    if (!fg('platform_editor_adf_with_localid')) {
+    if (!isCopyLinkEnabled(config)) {
       return false;
     }
 

package/dist/esm/pm-plugins/utils/isCopyLinkEnabled.js

@@ -0,0 +1,17 @@
+import { fg } from '@atlaskit/platform-feature-flags/fg';
+/**
+ * Whether the "Copy link" block menu item and its keyboard shortcut are available.
+ *
+ * Copy link only works when blocks have localIds, so it is opt-in per editor preset via
+ * `enableCopyLinkToSelection`. While `platform_editor_block_menu_copy_link_opt_in` is off, the previous
+ * behaviour is kept and `enableCopyLinkToSelection` is ignored.
+ */
+export var isCopyLinkEnabled = function isCopyLinkEnabled(config) {
+  if (!fg('platform_editor_adf_with_localid')) {
+    return false;
+  }
+  if (fg('platform_editor_block_menu_copy_link_opt_in')) {
+    return Boolean(config === null || config === void 0 ? void 0 : config.enableCopyLinkToSelection);
+  }
+  return true;
+};

package/dist/esm/ui/copy-link.js

@@ -7,9 +7,9 @@ import { copyLinkToBlock, formatShortcut } from '@atlaskit/editor-common/keymaps
 import { blockMenuMessages as messages } from '@atlaskit/editor-common/messages';
 import { ToolbarDropdownItem, ToolbarKeyboardShortcutHint } from '@atlaskit/editor-toolbar';
 import LinkIcon from '@atlaskit/icon/core/link';
-import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { FLAG_ID } from '../blockMenuPluginType';
 import { blockMenuPluginKey } from '../pm-plugins/main';
+import { isCopyLinkEnabled } from '../pm-plugins/utils/isCopyLinkEnabled';
 import { useBlockMenu } from './block-menu-provider';
 import { BLOCK_MENU_ITEM_NAME } from './consts';
 import { copyLink } from './utils/copyLink';
@@ -75,9 +75,7 @@ var CopyLinkDropdownItemContent = function CopyLinkDropdownItemContent(_ref) {
       }
     });
   }, [api, blockLinkHashPrefix, getLinkPath, onDropdownOpenChanged, selection]);
-
-  // Hide copy link when `platform_editor_adf_with_localid` feature flag is off
-  if (!fg('platform_editor_adf_with_localid')) {
+  if (!isCopyLinkEnabled(config)) {
     return null;
   }
   return /*#__PURE__*/React.createElement(ToolbarDropdownItem, {

package/dist/types/blockMenuPluginType.d.ts

@@ -39,6 +39,15 @@ export type BlockMenuPluginOptions = {
      * Default value from DEFAULT_BLOCK_LINK_HASH_PREFIX in @atlaskit/editor-common/block-menu
      */
     blockLinkHashPrefix?: string;
+    /**
+     * When true, shows the "Copy link" block menu item and enables its keyboard shortcut.
+     *
+     * Copy link requires blocks to have localIds (e.g. via `@atlaskit/editor-plugin-local-id`)
+     * and the product to handle block link hashes in the URL, so it is opt-in.
+     * Only respected when `platform_editor_block_menu_copy_link_opt_in` is enabled.
+     * @default false
+     */
+    enableCopyLinkToSelection?: boolean;
     /**
      * Optional function to retrieve the current link path for the editor context.
      * @returns The current link path as a string, or null if no path is available

package/dist/types/pm-plugins/utils/isCopyLinkEnabled.d.ts

@@ -0,0 +1,9 @@
+import type { BlockMenuPluginOptions } from '../../blockMenuPluginType';
+/**
+ * Whether the "Copy link" block menu item and its keyboard shortcut are available.
+ *
+ * Copy link only works when blocks have localIds, so it is opt-in per editor preset via
+ * `enableCopyLinkToSelection`. While `platform_editor_block_menu_copy_link_opt_in` is off, the previous
+ * behaviour is kept and `enableCopyLinkToSelection` is ignored.
+ */
+export declare const isCopyLinkEnabled: (config: BlockMenuPluginOptions | undefined) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-block-menu",
-	"version": "25.0.0",
+	"version": "25.1.0",
 	"description": "BlockMenu plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -33,7 +33,7 @@
 		"@atlaskit/editor-plugin-selection": "^26.0.0",
 		"@atlaskit/editor-plugin-user-intent": "^24.0.0",
 		"@atlaskit/editor-prosemirror": "^9.0.0",
-		"@atlaskit/editor-shared-styles": "^4.3.0",
+		"@atlaskit/editor-shared-styles": "^4.4.0",
 		"@atlaskit/editor-tables": "^3.2.0",
 		"@atlaskit/editor-toolbar": "^2.8.0",
 		"@atlaskit/flag": "^19.0.0",
@@ -42,14 +42,14 @@
 		"@atlaskit/platform-feature-flags": "^2.2.0",
 		"@atlaskit/primitives": "^22.5.0",
 		"@atlaskit/prosemirror-history": "^1.3.0",
-		"@atlaskit/tmp-editor-statsig": "^227.0.0",
+		"@atlaskit/tmp-editor-statsig": "^229.0.0",
 		"@atlaskit/tokens": "^20.4.0",
 		"@babel/runtime": "^7.0.0",
 		"bind-event-listener": "^3.0.0",
 		"memoize-one": "^6.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^130.0.0",
+		"@atlaskit/editor-common": "^130.3.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"
 	},
@@ -57,6 +57,9 @@
 		"platform_editor_adf_with_localid": {
 			"type": "boolean"
 		},
+		"platform_editor_block_menu_copy_link_opt_in": {
+			"type": "boolean"
+		},
 		"cc_blocks_changeboarding": {
 			"type": "boolean"
 		},