@atlaskit/editor-core 223.0.3 → 223.0.4

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-core
 
+## 223.0.4
+
+### Patch Changes
+
+- [`9df0d15ebfb51`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/9df0d15ebfb51) -
+  Add aria-readonly during SSR only for editor view mode, and use the configured mode when plugin
+  state is unavailable.
+- Updated dependencies
+
 ## 223.0.3
 
 ### Patch Changes

package/dist/cjs/create-editor/ReactEditorView.js

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.ReactEditorView = ReactEditorView;
 exports.default = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
@@ -34,6 +35,7 @@ var _view = require("@atlaskit/editor-prosemirror/view");
 var _editorSsrRenderer = require("@atlaskit/editor-ssr-renderer");
 var _createSsrEditorState = require("@atlaskit/editor-ssr-renderer/create-ssr-editor-state");
 var _createSsrPmPlugins = require("@atlaskit/editor-ssr-renderer/create-ssr-pm-plugins");
+var _isExperimentEnabled = require("@atlaskit/platform-feature-experiments/is-experiment-enabled");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _customData = require("@atlaskit/react-ufo/custom-data");
 var _interactionIdContext = require("@atlaskit/react-ufo/interaction-id-context");
@@ -1047,6 +1049,7 @@ function ReactEditorView(props) {
   // In separate memo, because some props like `props.intl` that need only for rendering
   // changes many times, but we don't want to process plugins and ADF document for each unnecessary changes.
   var ssrDeps = (0, _react.useMemo)(function () {
+    var _pluginInjectionAPI$c4;
     if (!(0, _coreUtils.isSSR)()) {
       return null;
     }
@@ -1067,6 +1070,8 @@ function ReactEditorView(props) {
       return buildDoc(schema);
     };
     var doc = (0, _ssrMeasures.profileSSROperation)("".concat(SSR_TRACE_SEGMENT_NAME, "/buildDoc"), doBuildDoc, onSSRMeasure);
+    var isViewMode = ((_pluginInjectionAPI$c4 = pluginInjectionAPI.current.api()) === null || _pluginInjectionAPI$c4 === void 0 || (_pluginInjectionAPI$c4 = _pluginInjectionAPI$c4.editorViewMode) === null || _pluginInjectionAPI$c4 === void 0 || (_pluginInjectionAPI$c4 = _pluginInjectionAPI$c4.sharedState.currentState()) === null || _pluginInjectionAPI$c4 === void 0 ? void 0 : _pluginInjectionAPI$c4.mode) === 'view';
+    var ariaReadonly = isViewMode && (0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_viewmode_aria_readonly_a11y') ? 'true' : undefined;
 
     // When the platform_editor_ssr_toolbar_optimistic is on, we create SSR-safe PM plugins and EditorState
     // HERE in ssrDeps — before any children render — so that FullPageToolbarNext can read correct
@@ -1096,6 +1101,7 @@ function ReactEditorView(props) {
         plugins: plugins,
         schema: schema,
         doc: doc,
+        ariaReadonly: ariaReadonly,
         ssrPMPlugins: ssrPMPlugins,
         ssrEditorState: ssrState
       };
@@ -1104,6 +1110,7 @@ function ReactEditorView(props) {
       plugins: plugins,
       schema: schema,
       doc: doc,
+      ariaReadonly: ariaReadonly,
       ssrPMPlugins: undefined,
       ssrEditorState: undefined
     };
@@ -1148,7 +1155,7 @@ function ReactEditorView(props) {
     if (!ssrDeps) {
       return null;
     }
-    return /*#__PURE__*/_react.default.createElement(_editorSsrRenderer.EditorSSRRenderer, {
+    return /*#__PURE__*/_react.default.createElement(_editorSsrRenderer.EditorSSRRenderer, (0, _extends2.default)({
       intl: props.intl,
       doc: ssrDeps.doc,
       schema: ssrDeps.schema,
@@ -1161,7 +1168,11 @@ function ReactEditorView(props) {
       key: "ProseMirror",
       "aria-label": assistiveLabel || (isPageAppearance ? props.intl.formatMessage(_messages.editorMessages.fullPageEditorAssistiveLabel) : props.intl.formatMessage(_messages.editorMessages.editorAssistiveLabel)),
       id: EDIT_AREA_ID,
-      "aria-describedby": assistiveDescribedBy,
+      "aria-describedby": assistiveDescribedBy
+      // eslint-disable-next-line react/jsx-props-no-spreading -- aria-readonly must be omitted unless view mode is confirmed
+    }, ssrDeps.ariaReadonly === 'true' ? {
+      'aria-readonly': 'true'
+    } : {}, {
       "data-editor-id": editorId.current,
       onSSRMeasure: onSSRMeasure,
       prebuiltPMPlugins: ssrDeps.ssrPMPlugins,
@@ -1176,7 +1187,7 @@ function ReactEditorView(props) {
           oldEditorState: undefined
         });
       }
-    });
+    }));
   }, [ssrDeps, props.intl, props.portalProviderAPI, assistiveLabel, isPageAppearance, assistiveDescribedBy, onSSRMeasure, handleSsrEditorStateChanged]);
   var editor = (0, _react.useMemo)(function () {
     // SSR editor will be available only in SSR environment,

package/dist/cjs/version-wrapper.js

@@ -6,4 +6,4 @@ Object.defineProperty(exports, "__esModule", {
 exports.version = exports.name = void 0;
 var name = exports.name = "@atlaskit/editor-core";
 // eslint-disable-next-line @atlaskit/volt-strict-mode/no-multiple-exports
-var version = exports.version = "223.0.2";
+var version = exports.version = "223.0.3";

package/dist/es2019/create-editor/ReactEditorView.js

@@ -1,3 +1,4 @@
+import _extends from "@babel/runtime/helpers/extends";
 import React, { useCallback, useLayoutEffect, useMemo, useRef, useState, useEffect } from 'react';
 import { injectIntl } from 'react-intl';
 // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead
@@ -23,6 +24,7 @@ import { EditorView } from '@atlaskit/editor-prosemirror/view';
 import { EditorSSRRenderer } from '@atlaskit/editor-ssr-renderer';
 import { createSSREditorState } from '@atlaskit/editor-ssr-renderer/create-ssr-editor-state';
 import { createSSRPMPlugins } from '@atlaskit/editor-ssr-renderer/create-ssr-pm-plugins';
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { addUFOCustomData } from '@atlaskit/react-ufo/custom-data';
 import { getInteractionId } from '@atlaskit/react-ufo/interaction-id-context';
@@ -976,6 +978,7 @@ export function ReactEditorView(props) {
   // In separate memo, because some props like `props.intl` that need only for rendering
   // changes many times, but we don't want to process plugins and ADF document for each unnecessary changes.
   const ssrDeps = useMemo(() => {
+    var _pluginInjectionAPI$c8, _pluginInjectionAPI$c9, _pluginInjectionAPI$c0;
     if (!isSSR()) {
       return null;
     }
@@ -990,6 +993,8 @@ export function ReactEditorView(props) {
     const schema = profileSSROperation(`${SSR_TRACE_SEGMENT_NAME}/createSchema`, doCreateSchema, onSSRMeasure);
     const doBuildDoc = () => buildDoc(schema);
     const doc = profileSSROperation(`${SSR_TRACE_SEGMENT_NAME}/buildDoc`, doBuildDoc, onSSRMeasure);
+    const isViewMode = ((_pluginInjectionAPI$c8 = pluginInjectionAPI.current.api()) === null || _pluginInjectionAPI$c8 === void 0 ? void 0 : (_pluginInjectionAPI$c9 = _pluginInjectionAPI$c8.editorViewMode) === null || _pluginInjectionAPI$c9 === void 0 ? void 0 : (_pluginInjectionAPI$c0 = _pluginInjectionAPI$c9.sharedState.currentState()) === null || _pluginInjectionAPI$c0 === void 0 ? void 0 : _pluginInjectionAPI$c0.mode) === 'view';
+    const ariaReadonly = isViewMode && isExperimentEnabled('platform_editor_viewmode_aria_readonly_a11y') ? 'true' : undefined;
 
     // When the platform_editor_ssr_toolbar_optimistic is on, we create SSR-safe PM plugins and EditorState
     // HERE in ssrDeps — before any children render — so that FullPageToolbarNext can read correct
@@ -1013,6 +1018,7 @@ export function ReactEditorView(props) {
         plugins,
         schema,
         doc,
+        ariaReadonly,
         ssrPMPlugins,
         ssrEditorState: ssrState
       };
@@ -1021,6 +1027,7 @@ export function ReactEditorView(props) {
       plugins,
       schema,
       doc,
+      ariaReadonly,
       ssrPMPlugins: undefined,
       ssrEditorState: undefined
     };
@@ -1064,7 +1071,7 @@ export function ReactEditorView(props) {
     if (!ssrDeps) {
       return null;
     }
-    return /*#__PURE__*/React.createElement(EditorSSRRenderer, {
+    return /*#__PURE__*/React.createElement(EditorSSRRenderer, _extends({
       intl: props.intl,
       doc: ssrDeps.doc,
       schema: ssrDeps.schema,
@@ -1077,7 +1084,11 @@ export function ReactEditorView(props) {
       key: "ProseMirror",
       "aria-label": assistiveLabel || (isPageAppearance ? props.intl.formatMessage(editorMessages.fullPageEditorAssistiveLabel) : props.intl.formatMessage(editorMessages.editorAssistiveLabel)),
       id: EDIT_AREA_ID,
-      "aria-describedby": assistiveDescribedBy,
+      "aria-describedby": assistiveDescribedBy
+      // eslint-disable-next-line react/jsx-props-no-spreading -- aria-readonly must be omitted unless view mode is confirmed
+    }, ssrDeps.ariaReadonly === 'true' ? {
+      'aria-readonly': 'true'
+    } : {}, {
       "data-editor-id": editorId.current,
       onSSRMeasure: onSSRMeasure,
       prebuiltPMPlugins: ssrDeps.ssrPMPlugins,
@@ -1092,7 +1103,7 @@ export function ReactEditorView(props) {
           oldEditorState: undefined
         });
       }
-    });
+    }));
   }, [ssrDeps, props.intl, props.portalProviderAPI, assistiveLabel, isPageAppearance, assistiveDescribedBy, onSSRMeasure, handleSsrEditorStateChanged]);
   const editor = useMemo(() => {
     // SSR editor will be available only in SSR environment,

package/dist/es2019/version-wrapper.js

@@ -1,3 +1,3 @@
 export const name = "@atlaskit/editor-core";
 // eslint-disable-next-line @atlaskit/volt-strict-mode/no-multiple-exports
-export const version = "223.0.2";
+export const version = "223.0.3";

package/dist/esm/create-editor/ReactEditorView.js

@@ -1,3 +1,4 @@
+import _extends from "@babel/runtime/helpers/extends";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
@@ -31,6 +32,7 @@ import { EditorView } from '@atlaskit/editor-prosemirror/view';
 import { EditorSSRRenderer } from '@atlaskit/editor-ssr-renderer';
 import { createSSREditorState } from '@atlaskit/editor-ssr-renderer/create-ssr-editor-state';
 import { createSSRPMPlugins } from '@atlaskit/editor-ssr-renderer/create-ssr-pm-plugins';
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { addUFOCustomData } from '@atlaskit/react-ufo/custom-data';
 import { getInteractionId } from '@atlaskit/react-ufo/interaction-id-context';
@@ -1038,6 +1040,7 @@ export function ReactEditorView(props) {
   // In separate memo, because some props like `props.intl` that need only for rendering
   // changes many times, but we don't want to process plugins and ADF document for each unnecessary changes.
   var ssrDeps = useMemo(function () {
+    var _pluginInjectionAPI$c4;
     if (!isSSR()) {
       return null;
     }
@@ -1058,6 +1061,8 @@ export function ReactEditorView(props) {
       return buildDoc(schema);
     };
     var doc = profileSSROperation("".concat(SSR_TRACE_SEGMENT_NAME, "/buildDoc"), doBuildDoc, onSSRMeasure);
+    var isViewMode = ((_pluginInjectionAPI$c4 = pluginInjectionAPI.current.api()) === null || _pluginInjectionAPI$c4 === void 0 || (_pluginInjectionAPI$c4 = _pluginInjectionAPI$c4.editorViewMode) === null || _pluginInjectionAPI$c4 === void 0 || (_pluginInjectionAPI$c4 = _pluginInjectionAPI$c4.sharedState.currentState()) === null || _pluginInjectionAPI$c4 === void 0 ? void 0 : _pluginInjectionAPI$c4.mode) === 'view';
+    var ariaReadonly = isViewMode && isExperimentEnabled('platform_editor_viewmode_aria_readonly_a11y') ? 'true' : undefined;
 
     // When the platform_editor_ssr_toolbar_optimistic is on, we create SSR-safe PM plugins and EditorState
     // HERE in ssrDeps — before any children render — so that FullPageToolbarNext can read correct
@@ -1087,6 +1092,7 @@ export function ReactEditorView(props) {
         plugins: plugins,
         schema: schema,
         doc: doc,
+        ariaReadonly: ariaReadonly,
         ssrPMPlugins: ssrPMPlugins,
         ssrEditorState: ssrState
       };
@@ -1095,6 +1101,7 @@ export function ReactEditorView(props) {
       plugins: plugins,
       schema: schema,
       doc: doc,
+      ariaReadonly: ariaReadonly,
       ssrPMPlugins: undefined,
       ssrEditorState: undefined
     };
@@ -1139,7 +1146,7 @@ export function ReactEditorView(props) {
     if (!ssrDeps) {
       return null;
     }
-    return /*#__PURE__*/React.createElement(EditorSSRRenderer, {
+    return /*#__PURE__*/React.createElement(EditorSSRRenderer, _extends({
       intl: props.intl,
       doc: ssrDeps.doc,
       schema: ssrDeps.schema,
@@ -1152,7 +1159,11 @@ export function ReactEditorView(props) {
       key: "ProseMirror",
       "aria-label": assistiveLabel || (isPageAppearance ? props.intl.formatMessage(editorMessages.fullPageEditorAssistiveLabel) : props.intl.formatMessage(editorMessages.editorAssistiveLabel)),
       id: EDIT_AREA_ID,
-      "aria-describedby": assistiveDescribedBy,
+      "aria-describedby": assistiveDescribedBy
+      // eslint-disable-next-line react/jsx-props-no-spreading -- aria-readonly must be omitted unless view mode is confirmed
+    }, ssrDeps.ariaReadonly === 'true' ? {
+      'aria-readonly': 'true'
+    } : {}, {
       "data-editor-id": editorId.current,
       onSSRMeasure: onSSRMeasure,
       prebuiltPMPlugins: ssrDeps.ssrPMPlugins,
@@ -1167,7 +1178,7 @@ export function ReactEditorView(props) {
           oldEditorState: undefined
         });
       }
-    });
+    }));
   }, [ssrDeps, props.intl, props.portalProviderAPI, assistiveLabel, isPageAppearance, assistiveDescribedBy, onSSRMeasure, handleSsrEditorStateChanged]);
   var editor = useMemo(function () {
     // SSR editor will be available only in SSR environment,

package/dist/esm/version-wrapper.js

@@ -1,3 +1,3 @@
 export var name = "@atlaskit/editor-core";
 // eslint-disable-next-line @atlaskit/volt-strict-mode/no-multiple-exports
-export var version = "223.0.2";
+export var version = "223.0.3";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "223.0.3",
+	"version": "223.0.4",
 	"description": "A package contains Atlassian editor core functionality",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"