@atlaskit/editor-plugin-selection-toolbar 11.1.3 → 11.2.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @atlaskit/editor-plugin-selection-toolbar
 
+## 11.2.0
+
+### Minor Changes
+
+- [`5184c3aa86e89`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5184c3aa86e89) -
+  Pin the primary toolbar to the top while in Markdown Mode source or preview view, where the
+  floating toolbar would be useless (no PM selection to anchor to). Behind the new
+  `platform_editor_toolbar_mode_override` feature gate.
+  - `editor-plugin-toolbar`: adds `commands.setContextualFormattingModeOverride` and a
+    `contextualFormattingModeOverride` field on shared state. Any plugin can compose the command
+    onto its own transaction to push a runtime override.
+  - `editor-plugin-markdown-mode`: pushes the override on `setView` and on initial mount; uses the
+    current view to short-circuit `useIsToolbarDockedToTop` so the in-toolbar toggle renders in the
+    correct slot.
+  - `editor-plugin-selection-toolbar`: `PinButton` hides when the override forces `'always-pinned'`
+    (the toggle is meaningless in that state).
+  - `editor-core` (`FullPage.tsx`, `FullPageToolbarNext.tsx`): the primary-toolbar mount gate
+    consults the runtime override so the toolbar still mounts when the override is
+    `'always-pinned'`, even if the user's docking preference is `'none'`.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 11.1.3
 
 ### Patch Changes

package/dist/cjs/ui/PinButton.js

@@ -7,15 +7,27 @@ Object.defineProperty(exports, "__esModule", {
 exports.PinButton = void 0;
 var _react = _interopRequireDefault(require("react"));
 var _reactIntl = require("react-intl");
+var _hooks = require("@atlaskit/editor-common/hooks");
 var _messages = require("@atlaskit/editor-common/messages");
 var _toolbar = require("@atlaskit/editor-common/toolbar");
 var _editorToolbar = require("@atlaskit/editor-toolbar");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var PinButton = exports.PinButton = function PinButton(_ref) {
   var api = _ref.api;
   var intl = (0, _reactIntl.useIntl)();
   var message = intl.formatMessage(_messages.selectionToolbarMessages.toolbarPositionPinedAtTop);
   var _useEditorToolbar = (0, _toolbar.useEditorToolbar)(),
     isDisabled = _useEditorToolbar.isOffline;
+  // Pin/unpin is meaningless when a runtime override forces `'always-pinned'`
+  // (e.g. Markdown Mode source / preview view). Subscribe so we re-render and
+  // hide ourselves on flip.
+  var runtimeOverride = (0, _hooks.useSharedPluginStateWithSelector)(api, ['toolbar'], function (states) {
+    var _states$toolbarState;
+    return (_states$toolbarState = states.toolbarState) === null || _states$toolbarState === void 0 ? void 0 : _states$toolbarState.contextualFormattingModeOverride;
+  });
+  if (runtimeOverride === 'always-pinned' && (0, _platformFeatureFlags.fg)('platform_editor_toolbar_mode_override')) {
+    return null;
+  }
   var onClick = function onClick() {
     var _api$userPreferences;
     if (!api || isDisabled) {

package/dist/es2019/ui/PinButton.js

@@ -1,8 +1,10 @@
 import React from 'react';
 import { useIntl } from 'react-intl';
+import { useSharedPluginStateWithSelector } from '@atlaskit/editor-common/hooks';
 import { selectionToolbarMessages } from '@atlaskit/editor-common/messages';
 import { useEditorToolbar } from '@atlaskit/editor-common/toolbar';
 import { PinnedIcon, ToolbarButton, ToolbarTooltip } from '@atlaskit/editor-toolbar';
+import { fg } from '@atlaskit/platform-feature-flags';
 export const PinButton = ({
   api
 }) => {
@@ -11,6 +13,16 @@ export const PinButton = ({
   const {
     isOffline: isDisabled
   } = useEditorToolbar();
+  // Pin/unpin is meaningless when a runtime override forces `'always-pinned'`
+  // (e.g. Markdown Mode source / preview view). Subscribe so we re-render and
+  // hide ourselves on flip.
+  const runtimeOverride = useSharedPluginStateWithSelector(api, ['toolbar'], states => {
+    var _states$toolbarState;
+    return (_states$toolbarState = states.toolbarState) === null || _states$toolbarState === void 0 ? void 0 : _states$toolbarState.contextualFormattingModeOverride;
+  });
+  if (runtimeOverride === 'always-pinned' && fg('platform_editor_toolbar_mode_override')) {
+    return null;
+  }
   const onClick = () => {
     var _api$userPreferences;
     if (!api || isDisabled) {

package/dist/esm/ui/PinButton.js

@@ -1,14 +1,26 @@
 import React from 'react';
 import { useIntl } from 'react-intl';
+import { useSharedPluginStateWithSelector } from '@atlaskit/editor-common/hooks';
 import { selectionToolbarMessages } from '@atlaskit/editor-common/messages';
 import { useEditorToolbar } from '@atlaskit/editor-common/toolbar';
 import { PinnedIcon, ToolbarButton, ToolbarTooltip } from '@atlaskit/editor-toolbar';
+import { fg } from '@atlaskit/platform-feature-flags';
 export var PinButton = function PinButton(_ref) {
   var api = _ref.api;
   var intl = useIntl();
   var message = intl.formatMessage(selectionToolbarMessages.toolbarPositionPinedAtTop);
   var _useEditorToolbar = useEditorToolbar(),
     isDisabled = _useEditorToolbar.isOffline;
+  // Pin/unpin is meaningless when a runtime override forces `'always-pinned'`
+  // (e.g. Markdown Mode source / preview view). Subscribe so we re-render and
+  // hide ourselves on flip.
+  var runtimeOverride = useSharedPluginStateWithSelector(api, ['toolbar'], function (states) {
+    var _states$toolbarState;
+    return (_states$toolbarState = states.toolbarState) === null || _states$toolbarState === void 0 ? void 0 : _states$toolbarState.contextualFormattingModeOverride;
+  });
+  if (runtimeOverride === 'always-pinned' && fg('platform_editor_toolbar_mode_override')) {
+    return null;
+  }
   var onClick = function onClick() {
     var _api$userPreferences;
     if (!api || isDisabled) {

package/dist/types/ui/PinButton.d.ts

@@ -3,4 +3,4 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { SelectionToolbarPlugin } from '../selectionToolbarPluginType';
 export declare const PinButton: ({ api, }: {
     api?: ExtractInjectionAPI<SelectionToolbarPlugin>;
-}) => React.JSX.Element;
+}) => React.JSX.Element | null;

package/dist/types-ts4.5/ui/PinButton.d.ts

@@ -3,4 +3,4 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { SelectionToolbarPlugin } from '../selectionToolbarPluginType';
 export declare const PinButton: ({ api, }: {
     api?: ExtractInjectionAPI<SelectionToolbarPlugin>;
-}) => React.JSX.Element;
+}) => React.JSX.Element | null;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-selection-toolbar",
-	"version": "11.1.3",
+	"version": "11.2.0",
 	"description": "@atlaskit/editor-plugin-selection-toolbar for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -35,7 +35,7 @@
 		"@atlaskit/editor-plugin-connectivity": "^10.0.0",
 		"@atlaskit/editor-plugin-editor-viewmode": "^12.0.0",
 		"@atlaskit/editor-plugin-primary-toolbar": "^11.0.0",
-		"@atlaskit/editor-plugin-toolbar": "^7.0.0",
+		"@atlaskit/editor-plugin-toolbar": "^7.1.0",
 		"@atlaskit/editor-plugin-user-intent": "^8.1.0",
 		"@atlaskit/editor-plugin-user-preferences": "^8.1.0",
 		"@atlaskit/editor-prosemirror": "^7.3.0",
@@ -45,13 +45,13 @@
 		"@atlaskit/icon-lab": "^6.7.0",
 		"@atlaskit/menu": "^8.5.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^77.0.0",
+		"@atlaskit/tmp-editor-statsig": "^77.3.0",
 		"@atlaskit/tokens": "^13.0.0",
 		"@babel/runtime": "^7.0.0",
 		"bind-event-listener": "^3.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^114.20.0",
+		"@atlaskit/editor-common": "^114.26.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"
@@ -95,6 +95,9 @@
 		}
 	},
 	"platform-feature-flags": {
+		"platform_editor_toolbar_mode_override": {
+			"type": "boolean"
+		},
 		"platform_editor_user_preferences_provider_update": {
 			"type": "boolean"
 		},