@atlaskit/form 10.5.2 → 10.5.3

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/form
 
+## 10.5.3
+
+### Patch Changes
+
+- [`34d8c0a75098e`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/34d8c0a75098e) -
+  [ux] accessibility improvements to the error validation
+
 ## 10.5.2
 
 ### Patch Changes

package/dist/cjs/entry-points/messages.js

@@ -15,6 +15,12 @@ Object.defineProperty(exports, "HelperMessage", {
     return _messages.HelperMessage;
   }
 });
+Object.defineProperty(exports, "MessageWrapper", {
+  enumerable: true,
+  get: function get() {
+    return _messages.MessageWrapper;
+  }
+});
 Object.defineProperty(exports, "ValidMessage", {
   enumerable: true,
   get: function get() {

package/dist/cjs/index.js

@@ -64,6 +64,12 @@ Object.defineProperty(exports, "Legend", {
     return _label.Legend;
   }
 });
+Object.defineProperty(exports, "MessageWrapper", {
+  enumerable: true,
+  get: function get() {
+    return _messages.MessageWrapper;
+  }
+});
 Object.defineProperty(exports, "RangeField", {
   enumerable: true,
   get: function get() {

package/dist/cjs/messages.js

@@ -4,8 +4,10 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.ValidMessage = exports.HelperMessage = exports.ErrorMessage = void 0;
-var _react = require("@emotion/react");
+exports.ValidMessage = exports.MessageWrapperContext = exports.MessageWrapper = exports.HelperMessage = exports.ErrorMessage = void 0;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _react = require("react");
+var _react2 = require("@emotion/react");
 var _success = _interopRequireDefault(require("@atlaskit/icon/glyph/editor/success"));
 var _error = _interopRequireDefault(require("@atlaskit/icon/glyph/error"));
 var _colors = require("@atlaskit/theme/colors");
@@ -25,7 +27,7 @@ var _fieldIdContext = require("./field-id-context");
  * Public API of the various message components.
  */
 
-var messageStyles = (0, _react.css)({
+var messageStyles = (0, _react2.css)({
   display: 'flex',
   justifyContent: 'baseline',
   gap: "var(--ds-space-050, 4px)",
@@ -33,31 +35,31 @@ var messageStyles = (0, _react.css)({
   marginBlockStart: "var(--ds-space-050, 4px)"
 });
 var messageAppearanceStyles = {
-  default: (0, _react.css)({
+  default: (0, _react2.css)({
     color: "var(--ds-text-subtlest, ".concat(_colors.N200, ")")
   }),
-  error: (0, _react.css)({
+  error: (0, _react2.css)({
     color: "var(--ds-text-danger, #AE2A19)"
   }),
-  valid: (0, _react.css)({
+  valid: (0, _react2.css)({
     color: "var(--ds-text-success, #216E4E)"
   })
 };
-var iconWrapperStyles = (0, _react.css)({
+var iconWrapperStyles = (0, _react2.css)({
   display: 'flex'
 });
 var IconWrapper = function IconWrapper(_ref) {
   var children = _ref.children;
-  return (0, _react.jsx)("span", {
+  return (0, _react2.jsx)("span", {
     css: iconWrapperStyles
   }, children);
 };
 var messageIcons = {
-  error: (0, _react.jsx)(_error.default, {
+  error: (0, _react2.jsx)(_error.default, {
     size: "small",
     label: "error"
   }),
-  valid: (0, _react.jsx)(_success.default, {
+  valid: (0, _react2.jsx)(_success.default, {
     size: "small",
     label: "success"
   })
@@ -69,6 +71,18 @@ var Message = function Message(_ref2) {
     fieldId = _ref2.fieldId,
     testId = _ref2.testId;
   var icon = messageIcons[appearance];
+  var messageRef = (0, _react.useRef)(null);
+  var _useState = (0, _react.useState)(false),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    hasMessageWrapper = _useState2[0],
+    setHasMessageWrapper = _useState2[1];
+  var _useContext = (0, _react.useContext)(MessageWrapperContext),
+    isWrapper = _useContext.isWrapper;
+  (0, _react.useEffect)(function () {
+    if (messageRef.current) {
+      setHasMessageWrapper(isWrapper);
+    }
+  }, [isWrapper]);
 
   /**
    * The wrapping span is necessary to preserve spaces between children.
@@ -78,13 +92,16 @@ var Message = function Message(_ref2) {
    * If the child is just a string, this is not required and we can use one
    * less DOM element.
    */
-  var content = typeof children === 'string' ? children : (0, _react.jsx)("span", null, children);
-  return (0, _react.jsx)("div", {
+  var content = typeof children === 'string' ? children : (0, _react2.jsx)("span", null, children);
+  return (0, _react2.jsx)("div", {
     css: [messageStyles, messageAppearanceStyles[appearance]],
     "data-testid": testId,
     id: fieldId,
-    "aria-live": "polite"
-  }, icon && (0, _react.jsx)(IconWrapper, null, icon), content);
+    ref: messageRef
+    // For backwards compatability, if there is a wrapper, aria-live is not needed
+    ,
+    "aria-live": !hasMessageWrapper ? 'polite' : undefined
+  }, icon && (0, _react2.jsx)(IconWrapper, null, icon), content);
 };
 
 /**
@@ -97,8 +114,8 @@ var Message = function Message(_ref2) {
 var HelperMessage = exports.HelperMessage = function HelperMessage(_ref3) {
   var children = _ref3.children,
     testId = _ref3.testId;
-  return (0, _react.jsx)(_fieldIdContext.FieldId.Consumer, null, function (fieldId) {
-    return (0, _react.jsx)(Message, {
+  return (0, _react2.jsx)(_fieldIdContext.FieldId.Consumer, null, function (fieldId) {
+    return (0, _react2.jsx)(Message, {
       fieldId: fieldId ? "".concat(fieldId, "-helper") : undefined,
       testId: testId
     }, children);
@@ -115,8 +132,8 @@ var HelperMessage = exports.HelperMessage = function HelperMessage(_ref3) {
 var ErrorMessage = exports.ErrorMessage = function ErrorMessage(_ref4) {
   var children = _ref4.children,
     testId = _ref4.testId;
-  return (0, _react.jsx)(_fieldIdContext.FieldId.Consumer, null, function (fieldId) {
-    return (0, _react.jsx)(Message, {
+  return (0, _react2.jsx)(_fieldIdContext.FieldId.Consumer, null, function (fieldId) {
+    return (0, _react2.jsx)(Message, {
       appearance: "error",
       fieldId: fieldId ? "".concat(fieldId, "-error") : undefined,
       testId: testId
@@ -134,11 +151,43 @@ var ErrorMessage = exports.ErrorMessage = function ErrorMessage(_ref4) {
 var ValidMessage = exports.ValidMessage = function ValidMessage(_ref5) {
   var children = _ref5.children,
     testId = _ref5.testId;
-  return (0, _react.jsx)(_fieldIdContext.FieldId.Consumer, null, function (fieldId) {
-    return (0, _react.jsx)(Message, {
+  return (0, _react2.jsx)(_fieldIdContext.FieldId.Consumer, null, function (fieldId) {
+    return (0, _react2.jsx)(Message, {
       appearance: "valid",
       fieldId: fieldId ? "".concat(fieldId, "-valid") : undefined,
       testId: testId
     }, children);
   });
+};
+
+/**
+ * __Message wrapper context__
+ *
+ * A message wrapper context allows the children to check
+ * if it is contained within the MessageWrapper.
+ */
+var MessageWrapperContext = exports.MessageWrapperContext = /*#__PURE__*/(0, _react.createContext)({
+  isWrapper: false
+});
+
+/**
+ * __Message wrapper __
+ *
+ * A message wrapper is used to allow assistive technologies, like screen readers, to announce error or
+ * valid messages. This must be loaded into the DOM before the
+ * ErrorMessage, ValidMessage is loaded. Otherwise, assistive technologies
+ * may not render the message.
+ *
+ */
+var MessageWrapper = exports.MessageWrapper = function MessageWrapper(_ref6) {
+  var children = _ref6.children;
+  var contextValue = {
+    isWrapper: true
+  };
+  return (0, _react2.jsx)(MessageWrapperContext.Provider, {
+    value: contextValue
+  }, (0, _react2.jsx)("div", {
+    "aria-live": "polite",
+    "data-testid": "message-wrapper"
+  }, children));
 };

package/dist/es2019/entry-points/messages.js

@@ -1 +1 @@
-export { HelperMessage, ErrorMessage, ValidMessage } from '../messages';
+export { HelperMessage, ErrorMessage, MessageWrapper, ValidMessage } from '../messages';

package/dist/es2019/index.js

@@ -6,7 +6,7 @@ export { default as Field } from './field';
 export { default as CheckboxField } from './checkbox-field';
 export { default as RangeField } from './range-field';
 export { Label, Legend } from './label';
-export { HelperMessage, ErrorMessage, ValidMessage } from './messages';
+export { HelperMessage, ErrorMessage, MessageWrapper, ValidMessage } from './messages';
 export { default as Fieldset } from './fieldset';
 export { default as RequiredAsterisk } from './required-asterisk';
 // eslint-disable-next-line import/no-unresolved

package/dist/es2019/messages.js

@@ -3,6 +3,8 @@
  * @jsx jsx
  */
 
+import { createContext, useContext, useEffect, useRef, useState } from 'react';
+
 // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 import { css, jsx } from '@emotion/react';
 import SuccessIcon from '@atlaskit/icon/glyph/editor/success';
@@ -63,6 +65,16 @@ const Message = ({
   testId
 }) => {
   const icon = messageIcons[appearance];
+  const messageRef = useRef(null);
+  const [hasMessageWrapper, setHasMessageWrapper] = useState(false);
+  const {
+    isWrapper
+  } = useContext(MessageWrapperContext);
+  useEffect(() => {
+    if (messageRef.current) {
+      setHasMessageWrapper(isWrapper);
+    }
+  }, [isWrapper]);
 
   /**
    * The wrapping span is necessary to preserve spaces between children.
@@ -77,7 +89,10 @@ const Message = ({
     css: [messageStyles, messageAppearanceStyles[appearance]],
     "data-testid": testId,
     id: fieldId,
-    "aria-live": "polite"
+    ref: messageRef
+    // For backwards compatability, if there is a wrapper, aria-live is not needed
+    ,
+    "aria-live": !hasMessageWrapper ? 'polite' : undefined
   }, icon && jsx(IconWrapper, null, icon), content);
 };
 
@@ -126,4 +141,37 @@ export const ValidMessage = ({
   appearance: "valid",
   fieldId: fieldId ? `${fieldId}-valid` : undefined,
   testId: testId
-}, children));
+}, children));
+
+/**
+ * __Message wrapper context__
+ *
+ * A message wrapper context allows the children to check
+ * if it is contained within the MessageWrapper.
+ */
+export const MessageWrapperContext = /*#__PURE__*/createContext({
+  isWrapper: false
+});
+
+/**
+ * __Message wrapper __
+ *
+ * A message wrapper is used to allow assistive technologies, like screen readers, to announce error or
+ * valid messages. This must be loaded into the DOM before the
+ * ErrorMessage, ValidMessage is loaded. Otherwise, assistive technologies
+ * may not render the message.
+ *
+ */
+export const MessageWrapper = ({
+  children
+}) => {
+  const contextValue = {
+    isWrapper: true
+  };
+  return jsx(MessageWrapperContext.Provider, {
+    value: contextValue
+  }, jsx("div", {
+    "aria-live": "polite",
+    "data-testid": "message-wrapper"
+  }, children));
+};

package/dist/esm/entry-points/messages.js

@@ -1 +1 @@
-export { HelperMessage, ErrorMessage, ValidMessage } from '../messages';
+export { HelperMessage, ErrorMessage, MessageWrapper, ValidMessage } from '../messages';

package/dist/esm/index.js

@@ -6,7 +6,7 @@ export { default as Field } from './field';
 export { default as CheckboxField } from './checkbox-field';
 export { default as RangeField } from './range-field';
 export { Label, Legend } from './label';
-export { HelperMessage, ErrorMessage, ValidMessage } from './messages';
+export { HelperMessage, ErrorMessage, MessageWrapper, ValidMessage } from './messages';
 export { default as Fieldset } from './fieldset';
 export { default as RequiredAsterisk } from './required-asterisk';
 // eslint-disable-next-line import/no-unresolved

package/dist/esm/messages.js

@@ -1,8 +1,11 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 /**
  * @jsxRuntime classic
  * @jsx jsx
  */
 
+import { createContext, useContext, useEffect, useRef, useState } from 'react';
+
 // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 import { css, jsx } from '@emotion/react';
 import SuccessIcon from '@atlaskit/icon/glyph/editor/success';
@@ -62,6 +65,18 @@ var Message = function Message(_ref2) {
     fieldId = _ref2.fieldId,
     testId = _ref2.testId;
   var icon = messageIcons[appearance];
+  var messageRef = useRef(null);
+  var _useState = useState(false),
+    _useState2 = _slicedToArray(_useState, 2),
+    hasMessageWrapper = _useState2[0],
+    setHasMessageWrapper = _useState2[1];
+  var _useContext = useContext(MessageWrapperContext),
+    isWrapper = _useContext.isWrapper;
+  useEffect(function () {
+    if (messageRef.current) {
+      setHasMessageWrapper(isWrapper);
+    }
+  }, [isWrapper]);
 
   /**
    * The wrapping span is necessary to preserve spaces between children.
@@ -76,7 +91,10 @@ var Message = function Message(_ref2) {
     css: [messageStyles, messageAppearanceStyles[appearance]],
     "data-testid": testId,
     id: fieldId,
-    "aria-live": "polite"
+    ref: messageRef
+    // For backwards compatability, if there is a wrapper, aria-live is not needed
+    ,
+    "aria-live": !hasMessageWrapper ? 'polite' : undefined
   }, icon && jsx(IconWrapper, null, icon), content);
 };
 
@@ -134,4 +152,36 @@ export var ValidMessage = function ValidMessage(_ref5) {
       testId: testId
     }, children);
   });
+};
+
+/**
+ * __Message wrapper context__
+ *
+ * A message wrapper context allows the children to check
+ * if it is contained within the MessageWrapper.
+ */
+export var MessageWrapperContext = /*#__PURE__*/createContext({
+  isWrapper: false
+});
+
+/**
+ * __Message wrapper __
+ *
+ * A message wrapper is used to allow assistive technologies, like screen readers, to announce error or
+ * valid messages. This must be loaded into the DOM before the
+ * ErrorMessage, ValidMessage is loaded. Otherwise, assistive technologies
+ * may not render the message.
+ *
+ */
+export var MessageWrapper = function MessageWrapper(_ref6) {
+  var children = _ref6.children;
+  var contextValue = {
+    isWrapper: true
+  };
+  return jsx(MessageWrapperContext.Provider, {
+    value: contextValue
+  }, jsx("div", {
+    "aria-live": "polite",
+    "data-testid": "message-wrapper"
+  }, children));
 };

package/dist/types/entry-points/messages.d.ts

@@ -1 +1 @@
-export { HelperMessage, ErrorMessage, ValidMessage } from '../messages';
+export { HelperMessage, ErrorMessage, MessageWrapper, ValidMessage } from '../messages';

package/dist/types/index.d.ts

@@ -11,7 +11,7 @@ export { default as RangeField } from './range-field';
 export type { RangeFieldProps } from './range-field';
 export { Label, Legend } from './label';
 export type { LabelProps, LegendProps } from './label';
-export { HelperMessage, ErrorMessage, ValidMessage } from './messages';
+export { HelperMessage, ErrorMessage, MessageWrapper, ValidMessage } from './messages';
 export { default as Fieldset } from './fieldset';
 export { default as RequiredAsterisk } from './required-asterisk';
 export type { OnSubmitHandler, FormApi } from './types';

package/dist/types/messages.d.ts

@@ -53,4 +53,23 @@ export declare const ErrorMessage: ({ children, testId }: MessageProps) => jsx.J
  *
  */
 export declare const ValidMessage: ({ children, testId }: MessageProps) => jsx.JSX.Element;
+/**
+ * __Message wrapper context__
+ *
+ * A message wrapper context allows the children to check
+ * if it is contained within the MessageWrapper.
+ */
+export declare const MessageWrapperContext: import("react").Context<{
+    isWrapper: boolean;
+}>;
+/**
+ * __Message wrapper __
+ *
+ * A message wrapper is used to allow assistive technologies, like screen readers, to announce error or
+ * valid messages. This must be loaded into the DOM before the
+ * ErrorMessage, ValidMessage is loaded. Otherwise, assistive technologies
+ * may not render the message.
+ *
+ */
+export declare const MessageWrapper: ({ children }: MessageProps) => jsx.JSX.Element;
 export {};

package/dist/types-ts4.5/entry-points/messages.d.ts

@@ -1 +1 @@
-export { HelperMessage, ErrorMessage, ValidMessage } from '../messages';
+export { HelperMessage, ErrorMessage, MessageWrapper, ValidMessage } from '../messages';

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

@@ -11,7 +11,7 @@ export { default as RangeField } from './range-field';
 export type { RangeFieldProps } from './range-field';
 export { Label, Legend } from './label';
 export type { LabelProps, LegendProps } from './label';
-export { HelperMessage, ErrorMessage, ValidMessage } from './messages';
+export { HelperMessage, ErrorMessage, MessageWrapper, ValidMessage } from './messages';
 export { default as Fieldset } from './fieldset';
 export { default as RequiredAsterisk } from './required-asterisk';
 export type { OnSubmitHandler, FormApi } from './types';

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

@@ -53,4 +53,23 @@ export declare const ErrorMessage: ({ children, testId }: MessageProps) => jsx.J
  *
  */
 export declare const ValidMessage: ({ children, testId }: MessageProps) => jsx.JSX.Element;
+/**
+ * __Message wrapper context__
+ *
+ * A message wrapper context allows the children to check
+ * if it is contained within the MessageWrapper.
+ */
+export declare const MessageWrapperContext: import("react").Context<{
+    isWrapper: boolean;
+}>;
+/**
+ * __Message wrapper __
+ *
+ * A message wrapper is used to allow assistive technologies, like screen readers, to announce error or
+ * valid messages. This must be loaded into the DOM before the
+ * ErrorMessage, ValidMessage is loaded. Otherwise, assistive technologies
+ * may not render the message.
+ *
+ */
+export declare const MessageWrapper: ({ children }: MessageProps) => jsx.JSX.Element;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/form",
-	"version": "10.5.2",
+	"version": "10.5.3",
 	"description": "A form allows users to input information.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -29,7 +29,7 @@
 	},
 	"dependencies": {
 		"@atlaskit/heading": "^2.4.0",
-		"@atlaskit/icon": "^22.12.0",
+		"@atlaskit/icon": "^22.13.0",
 		"@atlaskit/primitives": "^12.0.0",
 		"@atlaskit/theme": "^13.0.0",
 		"@atlaskit/tokens": "^1.58.0",
@@ -49,7 +49,7 @@
 		"@af/integration-testing": "*",
 		"@af/visual-regression": "*",
 		"@atlaskit/banner": "^12.5.0",
-		"@atlaskit/button": "^19.2.0",
+		"@atlaskit/button": "^20.0.0",
 		"@atlaskit/checkbox": "^13.7.0",
 		"@atlaskit/ds-lib": "^2.4.0",
 		"@atlaskit/modal-dialog": "^12.15.0",