@atlaskit/editor-plugin-media 0.3.4 → 0.3.6

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-media
 
+## 0.3.6
+
+### Patch Changes
+
+- [#41747](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/41747) [`8b2001e7bbe`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8b2001e7bbe) - Extend mediaSingle from Component as props were not causing PureComponent to rerender correctly
+
+## 0.3.5
+
+### Patch Changes
+
+- [#40861](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/40861) [`a7e65721b8b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/a7e65721b8b) - ECA11Y-73: Add announcements for the screen reader users when the user types incorrect values in Alt text input field
+
 ## 0.3.4
 
 ### Patch Changes

package/dist/cjs/nodeviews/mediaSingle.js

@@ -47,8 +47,8 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } } /** @jsx jsx */
 // eslint-disable-next-line @repo/internal/react/no-class-components
-var MediaSingleNode = exports.default = /*#__PURE__*/function (_PureComponent) {
-  (0, _inherits2.default)(MediaSingleNode, _PureComponent);
+var MediaSingleNode = exports.default = /*#__PURE__*/function (_Component) {
+  (0, _inherits2.default)(MediaSingleNode, _Component);
   var _super = _createSuper(MediaSingleNode);
   function MediaSingleNode() {
     var _this;
@@ -442,7 +442,7 @@ var MediaSingleNode = exports.default = /*#__PURE__*/function (_PureComponent) {
     }
   }]);
   return MediaSingleNode;
-}(_react.PureComponent);
+}(_react.Component);
 (0, _defineProperty2.default)(MediaSingleNode, "defaultProps", {
   mediaOptions: {}
 });

package/dist/cjs/pm-plugins/alt-text/ui/AltTextEdit.js

@@ -75,7 +75,18 @@ var AltTextEditComponent = exports.AltTextEditComponent = /*#__PURE__*/function
       (0, _commands.updateAltText)(newValue)(view.state, view.dispatch);
     });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "handleOnChange", function (newAltText) {
+      var _this$state;
       var validationErrors = _this.getValidationErrors(newAltText);
+      if (((_this$state = _this.state) === null || _this$state === void 0 || (_this$state = _this$state.validationErrors) === null || _this$state === void 0 ? void 0 : _this$state.length) !== (validationErrors === null || validationErrors === void 0 ? void 0 : validationErrors.length)) {
+        // If number of errors was changed we need to reset attribute to get new SR announcement
+
+        if (_this.errorsListRef) {
+          var _this$errorsListRef;
+          var errorsArea = (_this$errorsListRef = _this.errorsListRef) === null || _this$errorsListRef === void 0 ? void 0 : _this$errorsListRef.current;
+          errorsArea === null || errorsArea === void 0 || errorsArea.removeAttribute('aria-live');
+          errorsArea === null || errorsArea === void 0 || errorsArea.setAttribute('aria-live', 'assertive');
+        }
+      }
       _this.setState({
         showClearTextButton: Boolean(newAltText),
         validationErrors: validationErrors,
@@ -98,6 +109,7 @@ var AltTextEditComponent = exports.AltTextEditComponent = /*#__PURE__*/function
     });
     var createAnalyticsEvent = props.createAnalyticsEvent;
     _this.fireCustomAnalytics = (0, _analytics.fireAnalyticsEvent)(createAnalyticsEvent);
+    _this.errorsListRef = /*#__PURE__*/_react.default.createRef();
     return _this;
   }
   (0, _createClass2.default)(AltTextEditComponent, [{
@@ -144,6 +156,7 @@ var AltTextEditComponent = exports.AltTextEditComponent = /*#__PURE__*/function
           key: index
         }, error);
       });
+      var hasErrors = !!errorsList.length;
       return (0, _react2.jsx)("div", {
         css: container
       }, (0, _react2.jsx)("section", {
@@ -160,7 +173,7 @@ var AltTextEditComponent = exports.AltTextEditComponent = /*#__PURE__*/function
       })), (0, _react2.jsx)(_ui.PanelTextInput, {
         testId: "alt-text-input",
         ariaLabel: formatMessage(_messages.messages.placeholder),
-        describedById: "support-text",
+        describedById: "".concat(hasErrors ? 'errors-list' : '', " support-text"),
         placeholder: formatMessage(_messages.messages.placeholder),
         defaultValue: this.state.lastValue,
         onCancel: this.dispatchCancelEvent,
@@ -168,6 +181,8 @@ var AltTextEditComponent = exports.AltTextEditComponent = /*#__PURE__*/function
         onBlur: this.handleOnBlur,
         onSubmit: this.closeMediaAltTextMenu,
         maxLength: MAX_ALT_TEXT_LENGTH,
+        ariaRequired: true,
+        ariaInvalid: hasErrors,
         autoFocus: true
       }), showClearTextButton && (0, _react2.jsx)("div", {
         css: buttonWrapper
@@ -181,7 +196,10 @@ var AltTextEditComponent = exports.AltTextEditComponent = /*#__PURE__*/function
         })),
         tooltipContent: formatMessage(_messages.messages.clear),
         onClick: this.handleClearText
-      }))), !!errorsList.length && (0, _react2.jsx)("section", {
+      }))), hasErrors && (0, _react2.jsx)("section", {
+        id: "errors-list",
+        ref: this.errorsListRef,
+        "aria-live": "assertive",
         css: validationWrapper
       }, errorsList), (0, _react2.jsx)("p", {
         css: supportText,

package/dist/es2019/nodeviews/mediaSingle.js

@@ -2,7 +2,7 @@ import _extends from "@babel/runtime/helpers/extends";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 /** @jsx jsx */
 
-import React, { PureComponent } from 'react';
+import React, { Component } from 'react';
 import { jsx } from '@emotion/react';
 import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
 import { calcMediaSinglePixelWidth, DEFAULT_IMAGE_HEIGHT, DEFAULT_IMAGE_WIDTH, getMaxWidthForNestedNode, MEDIA_SINGLE_GUTTER_SIZE } from '@atlaskit/editor-common/media-single';
@@ -26,7 +26,7 @@ import { hasPrivateAttrsChanged } from './helpers';
 import { MediaNodeUpdater } from './mediaNodeUpdater';
 import { figureWrapper, MediaSingleNodeSelector } from './styles';
 // eslint-disable-next-line @repo/internal/react/no-class-components
-export default class MediaSingleNode extends PureComponent {
+export default class MediaSingleNode extends Component {
   constructor(...args) {
     super(...args);
     _defineProperty(this, "mediaNodeUpdater", null);

package/dist/es2019/pm-plugins/alt-text/ui/AltTextEdit.js

@@ -93,7 +93,18 @@ export class AltTextEditComponent extends React.Component {
       updateAltText(newValue)(view.state, view.dispatch);
     });
     _defineProperty(this, "handleOnChange", newAltText => {
+      var _this$state, _this$state$validatio;
       const validationErrors = this.getValidationErrors(newAltText);
+      if (((_this$state = this.state) === null || _this$state === void 0 ? void 0 : (_this$state$validatio = _this$state.validationErrors) === null || _this$state$validatio === void 0 ? void 0 : _this$state$validatio.length) !== (validationErrors === null || validationErrors === void 0 ? void 0 : validationErrors.length)) {
+        // If number of errors was changed we need to reset attribute to get new SR announcement
+
+        if (this.errorsListRef) {
+          var _this$errorsListRef;
+          const errorsArea = (_this$errorsListRef = this.errorsListRef) === null || _this$errorsListRef === void 0 ? void 0 : _this$errorsListRef.current;
+          errorsArea === null || errorsArea === void 0 ? void 0 : errorsArea.removeAttribute('aria-live');
+          errorsArea === null || errorsArea === void 0 ? void 0 : errorsArea.setAttribute('aria-live', 'assertive');
+        }
+      }
       this.setState({
         showClearTextButton: Boolean(newAltText),
         validationErrors,
@@ -120,6 +131,7 @@ export class AltTextEditComponent extends React.Component {
       createAnalyticsEvent
     } = props;
     this.fireCustomAnalytics = fireAnalyticsEvent(createAnalyticsEvent);
+    this.errorsListRef = /*#__PURE__*/React.createRef();
   }
   componentDidMount() {
     this.prevValue = this.props.value;
@@ -165,6 +177,7 @@ export class AltTextEditComponent extends React.Component {
         key: index
       }, error);
     });
+    const hasErrors = !!errorsList.length;
     return jsx("div", {
       css: container
     }, jsx("section", {
@@ -181,7 +194,7 @@ export class AltTextEditComponent extends React.Component {
     })), jsx(PanelTextInput, {
       testId: "alt-text-input",
       ariaLabel: formatMessage(messages.placeholder),
-      describedById: "support-text",
+      describedById: `${hasErrors ? 'errors-list' : ''} support-text`,
       placeholder: formatMessage(messages.placeholder),
       defaultValue: this.state.lastValue,
       onCancel: this.dispatchCancelEvent,
@@ -189,6 +202,8 @@ export class AltTextEditComponent extends React.Component {
       onBlur: this.handleOnBlur,
       onSubmit: this.closeMediaAltTextMenu,
       maxLength: MAX_ALT_TEXT_LENGTH,
+      ariaRequired: true,
+      ariaInvalid: hasErrors,
       autoFocus: true
     }), showClearTextButton && jsx("div", {
       css: buttonWrapper
@@ -202,7 +217,10 @@ export class AltTextEditComponent extends React.Component {
       })),
       tooltipContent: formatMessage(messages.clear),
       onClick: this.handleClearText
-    }))), !!errorsList.length && jsx("section", {
+    }))), hasErrors && jsx("section", {
+      id: "errors-list",
+      ref: this.errorsListRef,
+      "aria-live": "assertive",
       css: validationWrapper
     }, errorsList), jsx("p", {
       css: supportText,

package/dist/esm/nodeviews/mediaSingle.js

@@ -15,7 +15,7 @@ function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflec
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 /** @jsx jsx */
 
-import React, { PureComponent } from 'react';
+import React, { Component } from 'react';
 import { jsx } from '@emotion/react';
 import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
 import { calcMediaSinglePixelWidth, DEFAULT_IMAGE_HEIGHT, DEFAULT_IMAGE_WIDTH, getMaxWidthForNestedNode, MEDIA_SINGLE_GUTTER_SIZE } from '@atlaskit/editor-common/media-single';
@@ -39,8 +39,8 @@ import { hasPrivateAttrsChanged } from './helpers';
 import { MediaNodeUpdater } from './mediaNodeUpdater';
 import { figureWrapper, MediaSingleNodeSelector } from './styles';
 // eslint-disable-next-line @repo/internal/react/no-class-components
-var MediaSingleNode = /*#__PURE__*/function (_PureComponent) {
-  _inherits(MediaSingleNode, _PureComponent);
+var MediaSingleNode = /*#__PURE__*/function (_Component) {
+  _inherits(MediaSingleNode, _Component);
   var _super = _createSuper(MediaSingleNode);
   function MediaSingleNode() {
     var _this;
@@ -434,7 +434,7 @@ var MediaSingleNode = /*#__PURE__*/function (_PureComponent) {
     }
   }]);
   return MediaSingleNode;
-}(PureComponent);
+}(Component);
 _defineProperty(MediaSingleNode, "defaultProps", {
   mediaOptions: {}
 });

package/dist/esm/pm-plugins/alt-text/ui/AltTextEdit.js

@@ -72,7 +72,18 @@ export var AltTextEditComponent = /*#__PURE__*/function (_React$Component) {
       updateAltText(newValue)(view.state, view.dispatch);
     });
     _defineProperty(_assertThisInitialized(_this), "handleOnChange", function (newAltText) {
+      var _this$state;
       var validationErrors = _this.getValidationErrors(newAltText);
+      if (((_this$state = _this.state) === null || _this$state === void 0 || (_this$state = _this$state.validationErrors) === null || _this$state === void 0 ? void 0 : _this$state.length) !== (validationErrors === null || validationErrors === void 0 ? void 0 : validationErrors.length)) {
+        // If number of errors was changed we need to reset attribute to get new SR announcement
+
+        if (_this.errorsListRef) {
+          var _this$errorsListRef;
+          var errorsArea = (_this$errorsListRef = _this.errorsListRef) === null || _this$errorsListRef === void 0 ? void 0 : _this$errorsListRef.current;
+          errorsArea === null || errorsArea === void 0 || errorsArea.removeAttribute('aria-live');
+          errorsArea === null || errorsArea === void 0 || errorsArea.setAttribute('aria-live', 'assertive');
+        }
+      }
       _this.setState({
         showClearTextButton: Boolean(newAltText),
         validationErrors: validationErrors,
@@ -95,6 +106,7 @@ export var AltTextEditComponent = /*#__PURE__*/function (_React$Component) {
     });
     var createAnalyticsEvent = props.createAnalyticsEvent;
     _this.fireCustomAnalytics = fireAnalyticsEvent(createAnalyticsEvent);
+    _this.errorsListRef = /*#__PURE__*/React.createRef();
     return _this;
   }
   _createClass(AltTextEditComponent, [{
@@ -141,6 +153,7 @@ export var AltTextEditComponent = /*#__PURE__*/function (_React$Component) {
           key: index
         }, error);
       });
+      var hasErrors = !!errorsList.length;
       return jsx("div", {
         css: container
       }, jsx("section", {
@@ -157,7 +170,7 @@ export var AltTextEditComponent = /*#__PURE__*/function (_React$Component) {
       })), jsx(PanelTextInput, {
         testId: "alt-text-input",
         ariaLabel: formatMessage(messages.placeholder),
-        describedById: "support-text",
+        describedById: "".concat(hasErrors ? 'errors-list' : '', " support-text"),
         placeholder: formatMessage(messages.placeholder),
         defaultValue: this.state.lastValue,
         onCancel: this.dispatchCancelEvent,
@@ -165,6 +178,8 @@ export var AltTextEditComponent = /*#__PURE__*/function (_React$Component) {
         onBlur: this.handleOnBlur,
         onSubmit: this.closeMediaAltTextMenu,
         maxLength: MAX_ALT_TEXT_LENGTH,
+        ariaRequired: true,
+        ariaInvalid: hasErrors,
         autoFocus: true
       }), showClearTextButton && jsx("div", {
         css: buttonWrapper
@@ -178,7 +193,10 @@ export var AltTextEditComponent = /*#__PURE__*/function (_React$Component) {
         })),
         tooltipContent: formatMessage(messages.clear),
         onClick: this.handleClearText
-      }))), !!errorsList.length && jsx("section", {
+      }))), hasErrors && jsx("section", {
+        id: "errors-list",
+        ref: this.errorsListRef,
+        "aria-live": "assertive",
         css: validationWrapper
       }, errorsList), jsx("p", {
         css: supportText,

package/dist/types/nodeviews/mediaSingle.d.ts

@@ -1,6 +1,6 @@
 /** @jsx jsx */
 import type { MouseEvent } from 'react';
-import React, { PureComponent } from 'react';
+import React, { Component } from 'react';
 import { jsx } from '@emotion/react';
 import type { RichMediaLayout as MediaSingleLayout } from '@atlaskit/adf-schema';
 import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
@@ -25,7 +25,7 @@ export interface MediaSingleNodeState {
     contextIdentifierProvider?: ContextIdentifierProvider;
     isCopying: boolean;
 }
-export default class MediaSingleNode extends PureComponent<MediaSingleNodeProps, MediaSingleNodeState> {
+export default class MediaSingleNode extends Component<MediaSingleNodeProps, MediaSingleNodeState> {
     static defaultProps: Partial<MediaSingleNodeProps>;
     static displayName: string;
     mediaNodeUpdater: MediaNodeUpdater | null;

package/dist/types/pm-plugins/alt-text/ui/AltTextEdit.d.ts

@@ -18,6 +18,7 @@ export type AltTextEditComponentState = {
 };
 export declare class AltTextEditComponent extends React.Component<Props, AltTextEditComponentState> {
     private fireCustomAnalytics?;
+    private errorsListRef;
     state: {
         showClearTextButton: boolean;
         validationErrors: string[];

package/dist/types-ts4.5/nodeviews/mediaSingle.d.ts

@@ -1,6 +1,6 @@
 /** @jsx jsx */
 import type { MouseEvent } from 'react';
-import React, { PureComponent } from 'react';
+import React, { Component } from 'react';
 import { jsx } from '@emotion/react';
 import type { RichMediaLayout as MediaSingleLayout } from '@atlaskit/adf-schema';
 import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
@@ -25,7 +25,7 @@ export interface MediaSingleNodeState {
     contextIdentifierProvider?: ContextIdentifierProvider;
     isCopying: boolean;
 }
-export default class MediaSingleNode extends PureComponent<MediaSingleNodeProps, MediaSingleNodeState> {
+export default class MediaSingleNode extends Component<MediaSingleNodeProps, MediaSingleNodeState> {
     static defaultProps: Partial<MediaSingleNodeProps>;
     static displayName: string;
     mediaNodeUpdater: MediaNodeUpdater | null;

package/dist/types-ts4.5/pm-plugins/alt-text/ui/AltTextEdit.d.ts

@@ -18,6 +18,7 @@ export type AltTextEditComponentState = {
 };
 export declare class AltTextEditComponent extends React.Component<Props, AltTextEditComponentState> {
     private fireCustomAnalytics?;
+    private errorsListRef;
     state: {
         showClearTextButton: boolean;
         validationErrors: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-media",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "description": "Media plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -36,7 +36,7 @@
     "@atlaskit/analytics-namespaced-context": "^6.7.0",
     "@atlaskit/analytics-next": "^9.1.0",
     "@atlaskit/button": "^16.10.0",
-    "@atlaskit/editor-common": "^76.10.0",
+    "@atlaskit/editor-common": "^76.11.0",
     "@atlaskit/editor-palette": "1.5.1",
     "@atlaskit/editor-plugin-analytics": "^0.2.0",
     "@atlaskit/editor-plugin-decorations": "^0.2.0",
@@ -62,7 +62,7 @@
     "@atlaskit/platform-feature-flags": "^0.2.0",
     "@atlaskit/textfield": "^5.6.0",
     "@atlaskit/theme": "^12.6.0",
-    "@atlaskit/tokens": "^1.26.0",
+    "@atlaskit/tokens": "^1.27.0",
     "@atlaskit/tooltip": "^17.8.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",