@atlaskit/editor-core 204.2.0 → 204.3.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-core
 
+## 204.3.0
+
+### Minor Changes
+
+- [#117777](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/117777)
+  [`6d31e7761757c`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6d31e7761757c) -
+  [ux] ED-26722 Update header area spacing to avoid layout shift when hiding top toolbar
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 204.2.0
 
 ### Minor Changes

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

@@ -109,8 +109,13 @@ var FullPageEditor = exports.FullPageEditor = function FullPageEditor(props) {
   }
   var popupsBoundariesElement = props.popupsBoundariesElement || (scrollContentContainerRef === null || scrollContentContainerRef === void 0 || (_scrollContentContain = scrollContentContainerRef.current) === null || _scrollContentContain === void 0 ? void 0 : _scrollContentContain.containerArea) || undefined;
   return (0, _react2.jsx)(_ui.ContextPanelWidthProvider, null, (0, _react2.jsx)("div", {
+    css: [
     // eslint-disable-next-line @atlaskit/ui-styling-standard/no-imported-style-values, @atlaskit/design-system/consistent-css-prop-usage -- Ignored via go/DSP-18766
-    css: _StyledComponents.fullPageEditorWrapper
+    _StyledComponents.fullPageEditorWrapper, isEditorToolbarHidden && (0, _experiments.editorExperiment)('platform_editor_controls', 'variant1', {
+      exposure: true
+    }) &&
+    // eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage, @atlaskit/ui-styling-standard/no-imported-style-values
+    _StyledComponents.primaryToolbarReservedSpace]
     // eslint-disable-next-line @atlaskit/ui-styling-standard/no-classname-prop -- Ignored via go/DSP-18766
     ,
     className: "akEditor",

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

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.FullPageContentArea = exports.EDITOR_CONTAINER = exports.CONTENT_AREA_TEST_ID = void 0;
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _react = _interopRequireWildcard(require("react"));
 var _react2 = require("@emotion/react");
 var _reactIntlNext = require("react-intl-next");
@@ -81,11 +82,14 @@ var Content = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
     editorView: props.editorView,
     editorDisabled: props.disabled
   }, (0, _react2.jsx)("div", {
-    // eslint-disable-next-line @atlaskit/ui-styling-standard/no-imported-style-values, @atlaskit/design-system/consistent-css-prop-usage -- Ignored via go/DSP-18766
-    css: (0, _StyledComponents.editorContentAreaStyle)({
+    css: [].concat((0, _toConsumableArray2.default)((0, _StyledComponents.editorContentAreaStyle)({
       fullWidthMode: fullWidthMode,
       layoutMaxWidth: theme.layoutMaxWidth
-    }),
+    })), [(0, _experiments.editorExperiment)('platform_editor_controls', 'variant1', {
+      exposure: true
+    }) &&
+    // eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage, @atlaskit/ui-styling-standard/no-imported-style-values
+    _StyledComponents.contentAreaReducedHeaderSpace]),
     role: "region",
     "aria-label": props.intl.formatMessage(_messages.fullPageMessages.editableContentLabel),
     ref: contentAreaRef

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

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.sidebarArea = exports.fullPageEditorWrapper = exports.editorContentGutterStyle = exports.editorContentAreaStyle = exports.editorContentAreaHideContainer = exports.contentAreaWrapper = exports.contentAreaHeightNoToolbar = exports.contentArea = exports.ScrollContainer = void 0;
+exports.sidebarArea = exports.primaryToolbarReservedSpace = exports.fullPageEditorWrapper = exports.editorContentGutterStyle = exports.editorContentAreaStyle = exports.editorContentAreaHideContainer = exports.contentAreaWrapper = exports.contentAreaReducedHeaderSpace = exports.contentAreaHeightNoToolbar = exports.contentArea = exports.ScrollContainer = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _react = require("@emotion/react");
 var _adfSchema = require("@atlaskit/adf-schema");
@@ -220,4 +220,19 @@ var editorContentGutterStyle = exports.editorContentGutterStyle = function edito
     // eslint-disable-next-line @atlaskit/ui-styling-standard/no-imported-style-values, @atlaskit/ui-styling-standard/no-unsafe-values -- Ignored via go/DSP-18766
     padding: padding
   });
-};
+};
+
+// An additional padding applied at the top of the page reserving space when the primary toolbar is hidden
+// which is used to avoid layout shift when the toolbar is toggled under the editor controls feature
+// eslint-disable-next-line @atlaskit/ui-styling-standard/no-exported-styles -- Ignored via go/DSP-18766
+var primaryToolbarReservedSpace = exports.primaryToolbarReservedSpace = (0, _react.css)({
+  // extra 1px to account for the bottom border on the toolbar
+  paddingTop: "calc(".concat("var(--ds-space-500, 40px)", " + 1px)")
+});
+
+// A reduced top padding to be applied to the content area to compensate for the reserved space at the top
+// of the page when the primary toolbar is hidden under the editor controls feature
+// eslint-disable-next-line @atlaskit/ui-styling-standard/no-exported-styles -- Ignored via go/DSP-18766
+var contentAreaReducedHeaderSpace = exports.contentAreaReducedHeaderSpace = (0, _react.css)({
+  paddingTop: "var(--ds-space-400, 32px)"
+});

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 = "204.2.0";
+var version = exports.version = "204.3.0";

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

@@ -13,7 +13,7 @@ import { useSharedPluginStateSelector } from '@atlaskit/editor-common/use-shared
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { FullPageContentArea } from './FullPageContentArea';
 import { FullPageToolbar } from './FullPageToolbar';
-import { fullPageEditorWrapper } from './StyledComponents';
+import { fullPageEditorWrapper, primaryToolbarReservedSpace } from './StyledComponents';
 const useShowKeyline = contentAreaRef => {
   const [showKeyline, setShowKeyline] = useState(false);
   useEffect(() => {
@@ -93,8 +93,13 @@ export const FullPageEditor = props => {
   }
   const popupsBoundariesElement = props.popupsBoundariesElement || (scrollContentContainerRef === null || scrollContentContainerRef === void 0 ? void 0 : (_scrollContentContain = scrollContentContainerRef.current) === null || _scrollContentContain === void 0 ? void 0 : _scrollContentContain.containerArea) || undefined;
   return jsx(ContextPanelWidthProvider, null, jsx("div", {
+    css: [
     // eslint-disable-next-line @atlaskit/ui-styling-standard/no-imported-style-values, @atlaskit/design-system/consistent-css-prop-usage -- Ignored via go/DSP-18766
-    css: fullPageEditorWrapper
+    fullPageEditorWrapper, isEditorToolbarHidden && editorExperiment('platform_editor_controls', 'variant1', {
+      exposure: true
+    }) &&
+    // eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage, @atlaskit/ui-styling-standard/no-imported-style-values
+    primaryToolbarReservedSpace]
     // eslint-disable-next-line @atlaskit/ui-styling-standard/no-classname-prop -- Ignored via go/DSP-18766
     ,
     className: "akEditor",

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

@@ -16,7 +16,7 @@ import ClickAreaBlock from '../../Addon/ClickAreaBlock';
 import { contentComponentClickWrapper } from '../../Addon/ClickAreaBlock/contentComponentWrapper';
 import { ContextPanel } from '../../ContextPanel';
 import PluginSlot from '../../PluginSlot';
-import { contentArea, contentAreaHeightNoToolbar, contentAreaWrapper, editorContentAreaStyle, editorContentGutterStyle, ScrollContainer, sidebarArea } from './StyledComponents';
+import { contentArea, contentAreaHeightNoToolbar, contentAreaReducedHeaderSpace, contentAreaWrapper, editorContentAreaStyle, editorContentGutterStyle, ScrollContainer, sidebarArea } from './StyledComponents';
 export const CONTENT_AREA_TEST_ID = 'ak-editor-fp-content-area';
 export const EDITOR_CONTAINER = 'ak-editor-container';
 const Content = /*#__PURE__*/React.forwardRef((props, ref) => {
@@ -68,11 +68,16 @@ const Content = /*#__PURE__*/React.forwardRef((props, ref) => {
     editorView: props.editorView,
     editorDisabled: props.disabled
   }, jsx("div", {
+    css: [
     // eslint-disable-next-line @atlaskit/ui-styling-standard/no-imported-style-values, @atlaskit/design-system/consistent-css-prop-usage -- Ignored via go/DSP-18766
-    css: editorContentAreaStyle({
+    ...editorContentAreaStyle({
       fullWidthMode,
       layoutMaxWidth: theme.layoutMaxWidth
-    }),
+    }), editorExperiment('platform_editor_controls', 'variant1', {
+      exposure: true
+    }) &&
+    // eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage, @atlaskit/ui-styling-standard/no-imported-style-values
+    contentAreaReducedHeaderSpace],
     role: "region",
     "aria-label": props.intl.formatMessage(messages.editableContentLabel),
     ref: contentAreaRef

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

@@ -3,7 +3,7 @@ import { css } from '@emotion/react';
 import { decisionListSelector, taskListSelector } from '@atlaskit/adf-schema';
 import { tableFullPageEditorStyles } from '@atlaskit/editor-plugins/table/ui/common-styles';
 import { tableMarginFullWidthMode } from '@atlaskit/editor-plugins/table/ui/consts';
-import { akEditorFullWidthLayoutWidth, akEditorGutterPaddingDynamic, akEditorSwoopCubicBezier, akLayoutGutterOffset, FULL_PAGE_EDITOR_TOOLBAR_HEIGHT } from '@atlaskit/editor-shared-styles';
+import { FULL_PAGE_EDITOR_TOOLBAR_HEIGHT, akEditorFullWidthLayoutWidth, akEditorGutterPaddingDynamic, akEditorSwoopCubicBezier, akLayoutGutterOffset } from '@atlaskit/editor-shared-styles';
 import { scrollbarStyles } from '@atlaskit/editor-shared-styles/scrollbar';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { createEditorContentStyle } from '../../ContentStyles';
@@ -210,4 +210,19 @@ export const editorContentGutterStyle = () => {
     // eslint-disable-next-line @atlaskit/ui-styling-standard/no-imported-style-values, @atlaskit/ui-styling-standard/no-unsafe-values -- Ignored via go/DSP-18766
     padding: padding
   });
-};
+};
+
+// An additional padding applied at the top of the page reserving space when the primary toolbar is hidden
+// which is used to avoid layout shift when the toolbar is toggled under the editor controls feature
+// eslint-disable-next-line @atlaskit/ui-styling-standard/no-exported-styles -- Ignored via go/DSP-18766
+export const primaryToolbarReservedSpace = css({
+  // extra 1px to account for the bottom border on the toolbar
+  paddingTop: `calc(${"var(--ds-space-500, 40px)"} + 1px)`
+});
+
+// A reduced top padding to be applied to the content area to compensate for the reserved space at the top
+// of the page when the primary toolbar is hidden under the editor controls feature
+// eslint-disable-next-line @atlaskit/ui-styling-standard/no-exported-styles -- Ignored via go/DSP-18766
+export const contentAreaReducedHeaderSpace = css({
+  paddingTop: "var(--ds-space-400, 32px)"
+});

package/dist/es2019/version-wrapper.js

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

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

@@ -14,7 +14,7 @@ import { useSharedPluginStateSelector } from '@atlaskit/editor-common/use-shared
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { FullPageContentArea } from './FullPageContentArea';
 import { FullPageToolbar } from './FullPageToolbar';
-import { fullPageEditorWrapper } from './StyledComponents';
+import { fullPageEditorWrapper, primaryToolbarReservedSpace } from './StyledComponents';
 var useShowKeyline = function useShowKeyline(contentAreaRef) {
   var _useState = useState(false),
     _useState2 = _slicedToArray(_useState, 2),
@@ -98,8 +98,13 @@ export var FullPageEditor = function FullPageEditor(props) {
   }
   var popupsBoundariesElement = props.popupsBoundariesElement || (scrollContentContainerRef === null || scrollContentContainerRef === void 0 || (_scrollContentContain = scrollContentContainerRef.current) === null || _scrollContentContain === void 0 ? void 0 : _scrollContentContain.containerArea) || undefined;
   return jsx(ContextPanelWidthProvider, null, jsx("div", {
+    css: [
     // eslint-disable-next-line @atlaskit/ui-styling-standard/no-imported-style-values, @atlaskit/design-system/consistent-css-prop-usage -- Ignored via go/DSP-18766
-    css: fullPageEditorWrapper
+    fullPageEditorWrapper, isEditorToolbarHidden && editorExperiment('platform_editor_controls', 'variant1', {
+      exposure: true
+    }) &&
+    // eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage, @atlaskit/ui-styling-standard/no-imported-style-values
+    primaryToolbarReservedSpace]
     // eslint-disable-next-line @atlaskit/ui-styling-standard/no-classname-prop -- Ignored via go/DSP-18766
     ,
     className: "akEditor",

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

@@ -1,3 +1,4 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 /**
  * @jsxRuntime classic
  * @jsx jsx
@@ -16,7 +17,7 @@ import ClickAreaBlock from '../../Addon/ClickAreaBlock';
 import { contentComponentClickWrapper } from '../../Addon/ClickAreaBlock/contentComponentWrapper';
 import { ContextPanel } from '../../ContextPanel';
 import PluginSlot from '../../PluginSlot';
-import { contentArea, contentAreaHeightNoToolbar, contentAreaWrapper, editorContentAreaStyle, editorContentGutterStyle, ScrollContainer, sidebarArea } from './StyledComponents';
+import { contentArea, contentAreaHeightNoToolbar, contentAreaReducedHeaderSpace, contentAreaWrapper, editorContentAreaStyle, editorContentGutterStyle, ScrollContainer, sidebarArea } from './StyledComponents';
 export var CONTENT_AREA_TEST_ID = 'ak-editor-fp-content-area';
 export var EDITOR_CONTAINER = 'ak-editor-container';
 var Content = /*#__PURE__*/React.forwardRef(function (props, ref) {
@@ -70,11 +71,14 @@ var Content = /*#__PURE__*/React.forwardRef(function (props, ref) {
     editorView: props.editorView,
     editorDisabled: props.disabled
   }, jsx("div", {
-    // eslint-disable-next-line @atlaskit/ui-styling-standard/no-imported-style-values, @atlaskit/design-system/consistent-css-prop-usage -- Ignored via go/DSP-18766
-    css: editorContentAreaStyle({
+    css: [].concat(_toConsumableArray(editorContentAreaStyle({
       fullWidthMode: fullWidthMode,
       layoutMaxWidth: theme.layoutMaxWidth
-    }),
+    })), [editorExperiment('platform_editor_controls', 'variant1', {
+      exposure: true
+    }) &&
+    // eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage, @atlaskit/ui-styling-standard/no-imported-style-values
+    contentAreaReducedHeaderSpace]),
     role: "region",
     "aria-label": props.intl.formatMessage(messages.editableContentLabel),
     ref: contentAreaRef

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

@@ -4,7 +4,7 @@ import { css } from '@emotion/react';
 import { decisionListSelector, taskListSelector } from '@atlaskit/adf-schema';
 import { tableFullPageEditorStyles } from '@atlaskit/editor-plugins/table/ui/common-styles';
 import { tableMarginFullWidthMode } from '@atlaskit/editor-plugins/table/ui/consts';
-import { akEditorFullWidthLayoutWidth, akEditorGutterPaddingDynamic, akEditorSwoopCubicBezier, akLayoutGutterOffset, FULL_PAGE_EDITOR_TOOLBAR_HEIGHT } from '@atlaskit/editor-shared-styles';
+import { FULL_PAGE_EDITOR_TOOLBAR_HEIGHT, akEditorFullWidthLayoutWidth, akEditorGutterPaddingDynamic, akEditorSwoopCubicBezier, akLayoutGutterOffset } from '@atlaskit/editor-shared-styles';
 import { scrollbarStyles } from '@atlaskit/editor-shared-styles/scrollbar';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { createEditorContentStyle } from '../../ContentStyles';
@@ -213,4 +213,19 @@ export var editorContentGutterStyle = function editorContentGutterStyle() {
     // eslint-disable-next-line @atlaskit/ui-styling-standard/no-imported-style-values, @atlaskit/ui-styling-standard/no-unsafe-values -- Ignored via go/DSP-18766
     padding: padding
   });
-};
+};
+
+// An additional padding applied at the top of the page reserving space when the primary toolbar is hidden
+// which is used to avoid layout shift when the toolbar is toggled under the editor controls feature
+// eslint-disable-next-line @atlaskit/ui-styling-standard/no-exported-styles -- Ignored via go/DSP-18766
+export var primaryToolbarReservedSpace = css({
+  // extra 1px to account for the bottom border on the toolbar
+  paddingTop: "calc(".concat("var(--ds-space-500, 40px)", " + 1px)")
+});
+
+// A reduced top padding to be applied to the content area to compensate for the reserved space at the top
+// of the page when the primary toolbar is hidden under the editor controls feature
+// eslint-disable-next-line @atlaskit/ui-styling-standard/no-exported-styles -- Ignored via go/DSP-18766
+export var contentAreaReducedHeaderSpace = css({
+  paddingTop: "var(--ds-space-400, 32px)"
+});

package/dist/esm/version-wrapper.js

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

package/dist/types/editor-appearances/FullPageEditor.d.ts

@@ -1,8 +1,9 @@
 import React from 'react';
+import EditorActions from '../actions';
 import { type EditorNextProps } from '../types/editor-props';
 export type FullPageEditorProps = Pick<EditorNextProps, 'preset' | 'defaultValue' | 'disabled' | 'mentionProvider' | 'performanceTracking' | 'contextIdentifierProvider' | 'searchProvider' | 'activityProvider' | 'annotationProviders' | 'collabEditProvider' | 'collabEdit' | 'taskDecisionProvider' | 'extensionProviders' | 'shouldFocus' | 'quickInsert' | 'secondaryToolbarComponents' | 'featureFlags' | 'primaryToolbarComponents' | 'contextPanel' | 'contentComponents' | 'primaryToolbarIconBefore' | 'sanitizePrivateContent' | '__livePage'> & {
     onChange?: () => void;
-    onEditorReady?: () => void;
+    onEditorReady?: (editorActions: EditorActions) => void;
     appearance: 'full-page' | 'full-width';
 };
 /**

package/dist/types/ui/Appearance/FullPage/StyledComponents.d.ts

@@ -18,3 +18,5 @@ export declare const editorContentAreaStyle: ({ layoutMaxWidth, fullWidthMode, }
     fullWidthMode: boolean;
 }) => (false | import("@emotion/react").SerializedStyles)[];
 export declare const editorContentGutterStyle: () => import("@emotion/react").SerializedStyles;
+export declare const primaryToolbarReservedSpace: import("@emotion/react").SerializedStyles;
+export declare const contentAreaReducedHeaderSpace: import("@emotion/react").SerializedStyles;

package/dist/types-ts4.5/editor-appearances/FullPageEditor.d.ts

@@ -1,8 +1,9 @@
 import React from 'react';
+import EditorActions from '../actions';
 import { type EditorNextProps } from '../types/editor-props';
 export type FullPageEditorProps = Pick<EditorNextProps, 'preset' | 'defaultValue' | 'disabled' | 'mentionProvider' | 'performanceTracking' | 'contextIdentifierProvider' | 'searchProvider' | 'activityProvider' | 'annotationProviders' | 'collabEditProvider' | 'collabEdit' | 'taskDecisionProvider' | 'extensionProviders' | 'shouldFocus' | 'quickInsert' | 'secondaryToolbarComponents' | 'featureFlags' | 'primaryToolbarComponents' | 'contextPanel' | 'contentComponents' | 'primaryToolbarIconBefore' | 'sanitizePrivateContent' | '__livePage'> & {
     onChange?: () => void;
-    onEditorReady?: () => void;
+    onEditorReady?: (editorActions: EditorActions) => void;
     appearance: 'full-page' | 'full-width';
 };
 /**

package/dist/types-ts4.5/ui/Appearance/FullPage/StyledComponents.d.ts

@@ -18,3 +18,5 @@ export declare const editorContentAreaStyle: ({ layoutMaxWidth, fullWidthMode, }
     fullWidthMode: boolean;
 }) => (false | import("@emotion/react").SerializedStyles)[];
 export declare const editorContentGutterStyle: () => import("@emotion/react").SerializedStyles;
+export declare const primaryToolbarReservedSpace: import("@emotion/react").SerializedStyles;
+export declare const contentAreaReducedHeaderSpace: import("@emotion/react").SerializedStyles;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "204.2.0",
+	"version": "204.3.0",
 	"description": "A package contains Atlassian editor core functionality",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -50,7 +50,7 @@
 		"@atlaskit/editor-plugin-quick-insert": "2.0.0",
 		"@atlaskit/editor-plugins": "^8.0.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
-		"@atlaskit/editor-shared-styles": "^3.3.0",
+		"@atlaskit/editor-shared-styles": "^3.4.0",
 		"@atlaskit/emoji": "^68.0.0",
 		"@atlaskit/icon": "^24.1.0",
 		"@atlaskit/media-card": "^79.0.0",