@atlaskit/editor-plugin-placeholder 7.2.2 → 7.2.4

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-plugin-placeholder
 
+## 7.2.4
+
+### Patch Changes
+
+- [`4a4392c5bdf9d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/4a4392c5bdf9d) -
+  [EDITOR-4807] fg cleanup platform_editor_placeholder_plugin_tidying
+- Updated dependencies
+
+## 7.2.3
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 7.2.2
 
 ### Patch Changes

package/dist/cjs/placeholderPlugin.js

@@ -9,25 +9,18 @@ exports.pluginKey = exports.placeholderPlugin = exports.EMPTY_PARAGRAPH_TIMEOUT_
 require("./placeholderPlugin.compiled.css");
 var _runtime = require("@compiled/react/runtime");
 var _react = _interopRequireDefault(require("react"));
+var _document = require("@atlaskit/editor-common/utils/document");
 var _state = require("@atlaskit/editor-prosemirror/state");
-var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _compiled = require("@atlaskit/primitives/compiled");
 var _spinner = _interopRequireDefault(require("@atlaskit/spinner/spinner"));
 var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _main = _interopRequireDefault(require("./pm-plugins/main"));
-var _placeholderPluginLegacy = require("./pm-plugins/placeholderPluginLegacy");
 var EMPTY_PARAGRAPH_TIMEOUT_DELAY = exports.EMPTY_PARAGRAPH_TIMEOUT_DELAY = 2000; // Delay before showing placeholder on empty paragraph
 
 var pluginKey = exports.pluginKey = new _state.PluginKey('placeholderPlugin');
 var placeholderPlugin = exports.placeholderPlugin = function placeholderPlugin(_ref) {
   var options = _ref.config,
     api = _ref.api;
-  if (!(0, _platformFeatureFlags.fg)('platform_editor_placeholder_plugin_tidying')) {
-    return (0, _placeholderPluginLegacy.placeholderPluginLegacy)({
-      config: options,
-      api: api
-    });
-  }
   var currentPlaceholder = options === null || options === void 0 ? void 0 : options.placeholder;
   return {
     name: 'placeholder',
@@ -71,10 +64,25 @@ var placeholderPlugin = exports.placeholderPlugin = function placeholderPlugin(_
       }];
     },
     contentComponent: (0, _expValEquals.expValEquals)('confluence_load_editor_title_on_transition', 'contentPlaceholder', true) ? function (params) {
-      var _params$editorView;
+      var _params$editorView, _params$editorView2;
+      // If loading spinner is explicitly disabled (e.g., for DiffEditor/version history), skip
+      if ((options === null || options === void 0 ? void 0 : options.enableLoadingSpinner) === false) {
+        return null;
+      }
+      var doc = (_params$editorView = params.editorView) === null || _params$editorView === void 0 ? void 0 : _params$editorView.state.doc;
+
       // @ts-ignore fix which needs follow up to use standard apis
-      var collabEditPluginState = (_params$editorView = params.editorView) === null || _params$editorView === void 0 || (_params$editorView = _params$editorView.state) === null || _params$editorView === void 0 ? void 0 : _params$editorView.collabEditPlugin$;
+      var collabEditPluginState = (_params$editorView2 = params.editorView) === null || _params$editorView2 === void 0 || (_params$editorView2 = _params$editorView2.state) === null || _params$editorView2 === void 0 ? void 0 : _params$editorView2.collabEditPlugin$;
       if (collabEditPluginState && collabEditPluginState.isReady !== true) {
+        if (doc && !(0, _document.isEmptyDocument)(doc)) {
+          // If we have a document, and it's not empty - we should not show a loading component
+          return null;
+        }
+
+        // In this scenario
+        // - the collab plugin exists - but we don't have a "initial/placeholder" document
+        // - and the collab plugin is not yet ready
+        // So we show a placeholder spinner to indicate the content is still loading
         return /*#__PURE__*/_react.default.createElement(_compiled.Box, {
           xcss: spinnerContainerStyles.spinnerContainer
         }, /*#__PURE__*/_react.default.createElement(_spinner.default, {

package/dist/es2019/placeholderPlugin.js

@@ -2,13 +2,12 @@
 import "./placeholderPlugin.compiled.css";
 import { ax, ix } from "@compiled/react/runtime";
 import React from 'react';
+import { isEmptyDocument } from '@atlaskit/editor-common/utils/document';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { fg } from '@atlaskit/platform-feature-flags';
 import { Box } from '@atlaskit/primitives/compiled';
 import Spinner from '@atlaskit/spinner/spinner';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import createPlugin from './pm-plugins/main';
-import { placeholderPluginLegacy } from './pm-plugins/placeholderPluginLegacy';
 export const EMPTY_PARAGRAPH_TIMEOUT_DELAY = 2000; // Delay before showing placeholder on empty paragraph
 
 export const pluginKey = new PluginKey('placeholderPlugin');
@@ -16,12 +15,6 @@ export const placeholderPlugin = ({
   config: options,
   api
 }) => {
-  if (!fg('platform_editor_placeholder_plugin_tidying')) {
-    return placeholderPluginLegacy({
-      config: options,
-      api
-    });
-  }
   let currentPlaceholder = options === null || options === void 0 ? void 0 : options.placeholder;
   return {
     name: 'placeholder',
@@ -61,10 +54,25 @@ export const placeholderPlugin = ({
       }];
     },
     contentComponent: expValEquals('confluence_load_editor_title_on_transition', 'contentPlaceholder', true) ? params => {
-      var _params$editorView, _params$editorView$st;
+      var _params$editorView, _params$editorView2, _params$editorView2$s;
+      // If loading spinner is explicitly disabled (e.g., for DiffEditor/version history), skip
+      if ((options === null || options === void 0 ? void 0 : options.enableLoadingSpinner) === false) {
+        return null;
+      }
+      const doc = (_params$editorView = params.editorView) === null || _params$editorView === void 0 ? void 0 : _params$editorView.state.doc;
+
       // @ts-ignore fix which needs follow up to use standard apis
-      const collabEditPluginState = (_params$editorView = params.editorView) === null || _params$editorView === void 0 ? void 0 : (_params$editorView$st = _params$editorView.state) === null || _params$editorView$st === void 0 ? void 0 : _params$editorView$st.collabEditPlugin$;
+      const collabEditPluginState = (_params$editorView2 = params.editorView) === null || _params$editorView2 === void 0 ? void 0 : (_params$editorView2$s = _params$editorView2.state) === null || _params$editorView2$s === void 0 ? void 0 : _params$editorView2$s.collabEditPlugin$;
       if (collabEditPluginState && collabEditPluginState.isReady !== true) {
+        if (doc && !isEmptyDocument(doc)) {
+          // If we have a document, and it's not empty - we should not show a loading component
+          return null;
+        }
+
+        // In this scenario
+        // - the collab plugin exists - but we don't have a "initial/placeholder" document
+        // - and the collab plugin is not yet ready
+        // So we show a placeholder spinner to indicate the content is still loading
         return /*#__PURE__*/React.createElement(Box, {
           xcss: spinnerContainerStyles.spinnerContainer
         }, /*#__PURE__*/React.createElement(Spinner, {

package/dist/esm/placeholderPlugin.js

@@ -2,25 +2,18 @@
 import "./placeholderPlugin.compiled.css";
 import { ax, ix } from "@compiled/react/runtime";
 import React from 'react';
+import { isEmptyDocument } from '@atlaskit/editor-common/utils/document';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { fg } from '@atlaskit/platform-feature-flags';
 import { Box } from '@atlaskit/primitives/compiled';
 import Spinner from '@atlaskit/spinner/spinner';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import createPlugin from './pm-plugins/main';
-import { placeholderPluginLegacy } from './pm-plugins/placeholderPluginLegacy';
 export var EMPTY_PARAGRAPH_TIMEOUT_DELAY = 2000; // Delay before showing placeholder on empty paragraph
 
 export var pluginKey = new PluginKey('placeholderPlugin');
 export var placeholderPlugin = function placeholderPlugin(_ref) {
   var options = _ref.config,
     api = _ref.api;
-  if (!fg('platform_editor_placeholder_plugin_tidying')) {
-    return placeholderPluginLegacy({
-      config: options,
-      api: api
-    });
-  }
   var currentPlaceholder = options === null || options === void 0 ? void 0 : options.placeholder;
   return {
     name: 'placeholder',
@@ -64,10 +57,25 @@ export var placeholderPlugin = function placeholderPlugin(_ref) {
       }];
     },
     contentComponent: expValEquals('confluence_load_editor_title_on_transition', 'contentPlaceholder', true) ? function (params) {
-      var _params$editorView;
+      var _params$editorView, _params$editorView2;
+      // If loading spinner is explicitly disabled (e.g., for DiffEditor/version history), skip
+      if ((options === null || options === void 0 ? void 0 : options.enableLoadingSpinner) === false) {
+        return null;
+      }
+      var doc = (_params$editorView = params.editorView) === null || _params$editorView === void 0 ? void 0 : _params$editorView.state.doc;
+
       // @ts-ignore fix which needs follow up to use standard apis
-      var collabEditPluginState = (_params$editorView = params.editorView) === null || _params$editorView === void 0 || (_params$editorView = _params$editorView.state) === null || _params$editorView === void 0 ? void 0 : _params$editorView.collabEditPlugin$;
+      var collabEditPluginState = (_params$editorView2 = params.editorView) === null || _params$editorView2 === void 0 || (_params$editorView2 = _params$editorView2.state) === null || _params$editorView2 === void 0 ? void 0 : _params$editorView2.collabEditPlugin$;
       if (collabEditPluginState && collabEditPluginState.isReady !== true) {
+        if (doc && !isEmptyDocument(doc)) {
+          // If we have a document, and it's not empty - we should not show a loading component
+          return null;
+        }
+
+        // In this scenario
+        // - the collab plugin exists - but we don't have a "initial/placeholder" document
+        // - and the collab plugin is not yet ready
+        // So we show a placeholder spinner to indicate the content is still loading
         return /*#__PURE__*/React.createElement(Box, {
           xcss: spinnerContainerStyles.spinnerContainer
         }, /*#__PURE__*/React.createElement(Spinner, {

package/dist/types/placeholderPluginType.d.ts

@@ -6,6 +6,7 @@ import type { ShowDiffPlugin } from '@atlaskit/editor-plugin-show-diff';
 import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
 export interface PlaceholderPluginOptions {
     emptyLinePlaceholder?: string;
+    enableLoadingSpinner?: boolean;
     placeholder?: string;
     placeholderADF?: DocNode;
     placeholderBracketHint?: string;

package/dist/types-ts4.5/placeholderPluginType.d.ts

@@ -6,6 +6,7 @@ import type { ShowDiffPlugin } from '@atlaskit/editor-plugin-show-diff';
 import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
 export interface PlaceholderPluginOptions {
     emptyLinePlaceholder?: string;
+    enableLoadingSpinner?: boolean;
     placeholder?: string;
     placeholderADF?: DocNode;
     placeholderBracketHint?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-placeholder",
-	"version": "7.2.2",
+	"version": "7.2.4",
 	"description": "Placeholder plugin for @atlaskit/editor-core.",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -27,7 +27,7 @@
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-utils": "^19.26.0",
+		"@atlaskit/adf-utils": "^19.27.0",
 		"@atlaskit/css": "^0.19.0",
 		"@atlaskit/editor-plugin-composition": "^6.0.0",
 		"@atlaskit/editor-plugin-focus": "^6.0.0",
@@ -37,12 +37,12 @@
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/primitives": "^17.1.0",
 		"@atlaskit/spinner": "^19.0.0",
-		"@atlaskit/tmp-editor-statsig": "^16.23.0",
-		"@atlaskit/tokens": "^10.0.0",
+		"@atlaskit/tmp-editor-statsig": "^17.2.0",
+		"@atlaskit/tokens": "^10.1.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^111.8.0",
+		"@atlaskit/editor-common": "^111.9.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
@@ -57,9 +57,6 @@
 		"platform_editor_ai_aifc_patch_ga_blockers": {
 			"type": "boolean"
 		},
-		"platform_editor_placeholder_plugin_tidying": {
-			"type": "boolean"
-		},
 		"platform_editor_ai_aifc_adf_placeholder": {
 			"type": "boolean"
 		}