@atlaskit/editor-core 210.1.5 → 210.1.6

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-core
 
+## 210.1.6
+
+### Patch Changes
+
+- [`4bc05c9f87780`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/4bc05c9f87780) -
+  [ux] Fix toolbar blink CLS regression
+- Updated dependencies
+
 ## 210.1.5
 
 ### Patch Changes

package/dist/cjs/ui/Appearance/FullPage/FullPage.js

@@ -118,10 +118,6 @@ var FullPageEditor = exports.FullPageEditor = function FullPageEditor(props) {
   var toolbarDocking = (0, _useSharedPluginStateSelector.useSharedPluginStateSelector)(editorAPI, 'selectionToolbar.toolbarDocking', {
     disabled: (0, _platformFeatureFlags.fg)('platform_editor_use_preferences_plugin')
   });
-  var _ref3 = (0, _useSharedPluginStateSelector.useSharedPluginStateSelector)(editorAPI, 'userPreferences.preferences', {
-      disabled: !(0, _platformFeatureFlags.fg)('platform_editor_use_preferences_plugin')
-    }) || {},
-    toolbarDockingPosition = _ref3.toolbarDockingPosition;
   if (!(0, _platformFeatureFlags.fg)('platform_editor_use_preferences_plugin')) {
     if (!toolbarDocking) {
       var _editorAPI$selectionT, _editorAPI$selectionT2;
@@ -132,6 +128,21 @@ var FullPageEditor = exports.FullPageEditor = function FullPageEditor(props) {
       toolbarDocking = (_editorAPI$selectionT = editorAPI === null || editorAPI === void 0 || (_editorAPI$selectionT2 = editorAPI.selectionToolbar) === null || _editorAPI$selectionT2 === void 0 || (_editorAPI$selectionT2 = _editorAPI$selectionT2.sharedState.currentState()) === null || _editorAPI$selectionT2 === void 0 ? void 0 : _editorAPI$selectionT2.toolbarDocking) !== null && _editorAPI$selectionT !== void 0 ? _editorAPI$selectionT : defaultDocking;
     }
   }
+  var _ref3 = (0, _useSharedPluginStateSelector.useSharedPluginStateSelector)(editorAPI, 'userPreferences.preferences', {
+      disabled: !(0, _platformFeatureFlags.fg)('platform_editor_use_preferences_plugin')
+    }) || {},
+    toolbarDockingPosition = _ref3.toolbarDockingPosition;
+  if ((0, _platformFeatureFlags.fg)('platform_editor_use_preferences_plugin')) {
+    if (!toolbarDockingPosition) {
+      var _editorAPI$userPrefer, _editorAPI$userPrefer2;
+      // This is a workaround for the rendering issue with the selection toolbar
+      // when using useSharedPluginStateWithSelector the state is not yet
+      // available when the editor is first loaded.
+      // This causes the toolbar to blink creating a layout shift.
+      var defaultDockingPosition = props.__livePage ? 'none' : 'top';
+      toolbarDockingPosition = (_editorAPI$userPrefer = editorAPI === null || editorAPI === void 0 || (_editorAPI$userPrefer2 = editorAPI.userPreferences) === null || _editorAPI$userPrefer2 === void 0 || (_editorAPI$userPrefer2 = _editorAPI$userPrefer2.actions.getUserPreferences()) === null || _editorAPI$userPrefer2 === void 0 ? void 0 : _editorAPI$userPrefer2.toolbarDockingPosition) !== null && _editorAPI$userPrefer !== void 0 ? _editorAPI$userPrefer : defaultDockingPosition;
+    }
+  }
   var primaryToolbarComponents = props.primaryToolbarComponents;
   if (Array.isArray(primaryToolbarState === null || primaryToolbarState === void 0 ? void 0 : primaryToolbarState.components) && Array.isArray(primaryToolbarComponents)) {
     primaryToolbarComponents = primaryToolbarState.components.concat(primaryToolbarComponents);

package/dist/cjs/version-wrapper.js

@@ -5,4 +5,4 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = exports.name = void 0;
 var name = exports.name = "@atlaskit/editor-core";
-var version = exports.version = "210.1.4";
+var version = exports.version = "210.1.5";

package/dist/es2019/ui/Appearance/FullPage/FullPage.js

@@ -86,7 +86,7 @@ const useFullPageEditorPluginsStates = sharedPluginStateHookMigratorFactory(plug
   };
 });
 export const FullPageEditor = props => {
-  var _scrollContentContain, _scrollContentContain2, _scrollContentContain3, _wrapperElementRef$cu;
+  var _scrollContentContain, _toolbarDockingPositi, _scrollContentContain2, _scrollContentContain3, _wrapperElementRef$cu;
   const wrapperElementRef = useMemo(() => props.innerRef, [props.innerRef]);
   const scrollContentContainerRef = useRef(null);
   const showKeyline = useShowKeyline(scrollContentContainerRef);
@@ -102,11 +102,6 @@ export const FullPageEditor = props => {
   let toolbarDocking = useSharedPluginStateSelector(editorAPI, 'selectionToolbar.toolbarDocking', {
     disabled: fg('platform_editor_use_preferences_plugin')
   });
-  const {
-    toolbarDockingPosition
-  } = useSharedPluginStateSelector(editorAPI, 'userPreferences.preferences', {
-    disabled: !fg('platform_editor_use_preferences_plugin')
-  }) || {};
   if (!fg('platform_editor_use_preferences_plugin')) {
     if (!toolbarDocking) {
       var _editorAPI$selectionT, _editorAPI$selectionT2, _editorAPI$selectionT3;
@@ -117,6 +112,22 @@ export const FullPageEditor = props => {
       toolbarDocking = (_editorAPI$selectionT = editorAPI === null || editorAPI === void 0 ? void 0 : (_editorAPI$selectionT2 = editorAPI.selectionToolbar) === null || _editorAPI$selectionT2 === void 0 ? void 0 : (_editorAPI$selectionT3 = _editorAPI$selectionT2.sharedState.currentState()) === null || _editorAPI$selectionT3 === void 0 ? void 0 : _editorAPI$selectionT3.toolbarDocking) !== null && _editorAPI$selectionT !== void 0 ? _editorAPI$selectionT : defaultDocking;
     }
   }
+  let {
+    toolbarDockingPosition
+  } = useSharedPluginStateSelector(editorAPI, 'userPreferences.preferences', {
+    disabled: !fg('platform_editor_use_preferences_plugin')
+  }) || {};
+  if (fg('platform_editor_use_preferences_plugin')) {
+    if (!toolbarDockingPosition) {
+      var _editorAPI$userPrefer, _editorAPI$userPrefer2, _editorAPI$userPrefer3;
+      // This is a workaround for the rendering issue with the selection toolbar
+      // when using useSharedPluginStateWithSelector the state is not yet
+      // available when the editor is first loaded.
+      // This causes the toolbar to blink creating a layout shift.
+      const defaultDockingPosition = props.__livePage ? 'none' : 'top';
+      toolbarDockingPosition = (_editorAPI$userPrefer = editorAPI === null || editorAPI === void 0 ? void 0 : (_editorAPI$userPrefer2 = editorAPI.userPreferences) === null || _editorAPI$userPrefer2 === void 0 ? void 0 : (_editorAPI$userPrefer3 = _editorAPI$userPrefer2.actions.getUserPreferences()) === null || _editorAPI$userPrefer3 === void 0 ? void 0 : _editorAPI$userPrefer3.toolbarDockingPosition) !== null && _editorAPI$userPrefer !== void 0 ? _editorAPI$userPrefer : defaultDockingPosition;
+    }
+  }
   let primaryToolbarComponents = props.primaryToolbarComponents;
   if (Array.isArray(primaryToolbarState === null || primaryToolbarState === void 0 ? void 0 : primaryToolbarState.components) && Array.isArray(primaryToolbarComponents)) {
     primaryToolbarComponents = primaryToolbarState.components.concat(primaryToolbarComponents);
@@ -162,7 +173,7 @@ export const FullPageEditor = props => {
   }, !isEditorToolbarHidden && (expValEquals('platform_editor_toolbar_aifc', 'isEnabled', true) ? jsx(IntlProvider, {
     locale: "en"
   }, jsx(FullPageToolbarNext, {
-    toolbarDockingPosition: toolbarDockingPosition !== null && toolbarDockingPosition !== void 0 ? toolbarDockingPosition : toolbarDocking,
+    toolbarDockingPosition: (_toolbarDockingPositi = toolbarDockingPosition) !== null && _toolbarDockingPositi !== void 0 ? _toolbarDockingPositi : toolbarDocking,
     beforeIcon: props.primaryToolbarIconBefore,
     editorAPI: editorAPI,
     editorView: props.editorView,

package/dist/es2019/version-wrapper.js

@@ -1,2 +1,2 @@
 export const name = "@atlaskit/editor-core";
-export const version = "210.1.4";
+export const version = "210.1.5";

package/dist/esm/ui/Appearance/FullPage/FullPage.js

@@ -108,10 +108,6 @@ export var FullPageEditor = function FullPageEditor(props) {
   var toolbarDocking = useSharedPluginStateSelector(editorAPI, 'selectionToolbar.toolbarDocking', {
     disabled: fg('platform_editor_use_preferences_plugin')
   });
-  var _ref3 = useSharedPluginStateSelector(editorAPI, 'userPreferences.preferences', {
-      disabled: !fg('platform_editor_use_preferences_plugin')
-    }) || {},
-    toolbarDockingPosition = _ref3.toolbarDockingPosition;
   if (!fg('platform_editor_use_preferences_plugin')) {
     if (!toolbarDocking) {
       var _editorAPI$selectionT, _editorAPI$selectionT2;
@@ -122,6 +118,21 @@ export var FullPageEditor = function FullPageEditor(props) {
       toolbarDocking = (_editorAPI$selectionT = editorAPI === null || editorAPI === void 0 || (_editorAPI$selectionT2 = editorAPI.selectionToolbar) === null || _editorAPI$selectionT2 === void 0 || (_editorAPI$selectionT2 = _editorAPI$selectionT2.sharedState.currentState()) === null || _editorAPI$selectionT2 === void 0 ? void 0 : _editorAPI$selectionT2.toolbarDocking) !== null && _editorAPI$selectionT !== void 0 ? _editorAPI$selectionT : defaultDocking;
     }
   }
+  var _ref3 = useSharedPluginStateSelector(editorAPI, 'userPreferences.preferences', {
+      disabled: !fg('platform_editor_use_preferences_plugin')
+    }) || {},
+    toolbarDockingPosition = _ref3.toolbarDockingPosition;
+  if (fg('platform_editor_use_preferences_plugin')) {
+    if (!toolbarDockingPosition) {
+      var _editorAPI$userPrefer, _editorAPI$userPrefer2;
+      // This is a workaround for the rendering issue with the selection toolbar
+      // when using useSharedPluginStateWithSelector the state is not yet
+      // available when the editor is first loaded.
+      // This causes the toolbar to blink creating a layout shift.
+      var defaultDockingPosition = props.__livePage ? 'none' : 'top';
+      toolbarDockingPosition = (_editorAPI$userPrefer = editorAPI === null || editorAPI === void 0 || (_editorAPI$userPrefer2 = editorAPI.userPreferences) === null || _editorAPI$userPrefer2 === void 0 || (_editorAPI$userPrefer2 = _editorAPI$userPrefer2.actions.getUserPreferences()) === null || _editorAPI$userPrefer2 === void 0 ? void 0 : _editorAPI$userPrefer2.toolbarDockingPosition) !== null && _editorAPI$userPrefer !== void 0 ? _editorAPI$userPrefer : defaultDockingPosition;
+    }
+  }
   var primaryToolbarComponents = props.primaryToolbarComponents;
   if (Array.isArray(primaryToolbarState === null || primaryToolbarState === void 0 ? void 0 : primaryToolbarState.components) && Array.isArray(primaryToolbarComponents)) {
     primaryToolbarComponents = primaryToolbarState.components.concat(primaryToolbarComponents);

package/dist/esm/version-wrapper.js

@@ -1,2 +1,2 @@
 export var name = "@atlaskit/editor-core";
-export var version = "210.1.4";
+export var version = "210.1.5";

package/dist/types/create-editor/create-universal-preset.d.ts

@@ -554,6 +554,7 @@ export declare function createUniversalPreset({ props, prevProps, initialPluginC
     pluginConfiguration: import("@atlaskit/editor-plugin-user-preferences").UserPreferencesPluginOptions;
     actions: {
         updateUserPreference: (key: import("packages/editor/editor-plugin-user-preferences/dist/types/userPreferencesPluginType").PrefKey, value: import("@atlaskit/editor-common/user-preferences").ResolvedUserPreferences[import("packages/editor/editor-plugin-user-preferences/dist/types/userPreferencesPluginType").PrefKey]) => import("@atlaskit/editor-common/types").EditorCommand;
+        getUserPreferences: () => import("@atlaskit/editor-common/user-preferences").ResolvedUserPreferences | undefined;
     };
     sharedState: import("@atlaskit/editor-plugin-user-preferences").UserPreferencesSharedState;
     dependencies: [import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-plugins/analytics").AnalyticsPlugin>];

package/dist/types/presets/universal.d.ts

@@ -612,6 +612,7 @@ export default function createUniversalPresetInternal({ appearance, props, featu
     pluginConfiguration: import("@atlaskit/editor-plugin-user-preferences").UserPreferencesPluginOptions;
     actions: {
         updateUserPreference: (key: import("packages/editor/editor-plugin-user-preferences/dist/types/userPreferencesPluginType").PrefKey, value: import("@atlaskit/editor-common/user-preferences").ResolvedUserPreferences[import("packages/editor/editor-plugin-user-preferences/dist/types/userPreferencesPluginType").PrefKey]) => import("@atlaskit/editor-common/types").EditorCommand;
+        getUserPreferences: () => import("@atlaskit/editor-common/user-preferences").ResolvedUserPreferences | undefined;
     };
     sharedState: import("@atlaskit/editor-plugin-user-preferences").UserPreferencesSharedState;
     dependencies: [import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-plugins/analytics").AnalyticsPlugin>];

package/dist/types/presets/useUniversalPreset.d.ts

@@ -554,6 +554,7 @@ export default function useUniversalPreset({ props, initialPluginConfiguration }
     pluginConfiguration: import("@atlaskit/editor-plugin-user-preferences").UserPreferencesPluginOptions;
     actions: {
         updateUserPreference: (key: import("packages/editor/editor-plugin-user-preferences/dist/types/userPreferencesPluginType").PrefKey, value: import("@atlaskit/editor-common/user-preferences").ResolvedUserPreferences[import("packages/editor/editor-plugin-user-preferences/dist/types/userPreferencesPluginType").PrefKey]) => import("@atlaskit/editor-common/types").EditorCommand;
+        getUserPreferences: () => import("@atlaskit/editor-common/user-preferences").ResolvedUserPreferences | undefined;
     };
     sharedState: import("@atlaskit/editor-plugin-user-preferences").UserPreferencesSharedState;
     dependencies: [import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-plugins/analytics").AnalyticsPlugin>];

package/dist/types-ts4.5/create-editor/create-universal-preset.d.ts

@@ -788,6 +788,7 @@ export declare function createUniversalPreset({ props, prevProps, initialPluginC
         pluginConfiguration: import("@atlaskit/editor-plugin-user-preferences").UserPreferencesPluginOptions;
         actions: {
             updateUserPreference: (key: import("packages/editor/editor-plugin-user-preferences/dist/types/userPreferencesPluginType").PrefKey, value: import("@atlaskit/editor-common/user-preferences").ResolvedUserPreferences[import("packages/editor/editor-plugin-user-preferences/dist/types/userPreferencesPluginType").PrefKey]) => import("@atlaskit/editor-common/types").EditorCommand;
+            getUserPreferences: () => import("@atlaskit/editor-common/user-preferences").ResolvedUserPreferences | undefined;
         };
         sharedState: import("@atlaskit/editor-plugin-user-preferences").UserPreferencesSharedState;
         dependencies: [

package/dist/types-ts4.5/presets/universal.d.ts

@@ -846,6 +846,7 @@ export default function createUniversalPresetInternal({ appearance, props, featu
         pluginConfiguration: import("@atlaskit/editor-plugin-user-preferences").UserPreferencesPluginOptions;
         actions: {
             updateUserPreference: (key: import("packages/editor/editor-plugin-user-preferences/dist/types/userPreferencesPluginType").PrefKey, value: import("@atlaskit/editor-common/user-preferences").ResolvedUserPreferences[import("packages/editor/editor-plugin-user-preferences/dist/types/userPreferencesPluginType").PrefKey]) => import("@atlaskit/editor-common/types").EditorCommand;
+            getUserPreferences: () => import("@atlaskit/editor-common/user-preferences").ResolvedUserPreferences | undefined;
         };
         sharedState: import("@atlaskit/editor-plugin-user-preferences").UserPreferencesSharedState;
         dependencies: [

package/dist/types-ts4.5/presets/useUniversalPreset.d.ts

@@ -788,6 +788,7 @@ export default function useUniversalPreset({ props, initialPluginConfiguration }
         pluginConfiguration: import("@atlaskit/editor-plugin-user-preferences").UserPreferencesPluginOptions;
         actions: {
             updateUserPreference: (key: import("packages/editor/editor-plugin-user-preferences/dist/types/userPreferencesPluginType").PrefKey, value: import("@atlaskit/editor-common/user-preferences").ResolvedUserPreferences[import("packages/editor/editor-plugin-user-preferences/dist/types/userPreferencesPluginType").PrefKey]) => import("@atlaskit/editor-common/types").EditorCommand;
+            getUserPreferences: () => import("@atlaskit/editor-common/user-preferences").ResolvedUserPreferences | undefined;
         };
         sharedState: import("@atlaskit/editor-plugin-user-preferences").UserPreferencesSharedState;
         dependencies: [

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "210.1.5",
+	"version": "210.1.6",
 	"description": "A package contains Atlassian editor core functionality",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -110,7 +110,6 @@
 		"@atlaskit/synchrony-test-helpers": "workspace:^",
 		"@atlaskit/toggle": "^15.1.0",
 		"@atlaskit/util-data-test": "^18.1.0",
-		"@atlaskit/visual-regression": "workspace:^",
 		"@atlassian/adf-schema-json": "^1.31.0",
 		"@atlassian/feature-flags-test-utils": "^0.3.0",
 		"@atlassian/search-provider": "^4.0.0",