@atlaskit/form 14.4.0 → 15.0.1

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @atlaskit/form
 
+## 15.0.1
+
+### Patch Changes
+
+- [`1f2184e410650`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/1f2184e410650) -
+  Updates internal useEffect depenedency array to include isRequired. This fixes an issue where
+  validation was not rerun when the prop was dynamically updated.
+- Updated dependencies
+
+## 15.0.0
+
+### Major Changes
+
+- [`903d3e8f3b8ad`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/903d3e8f3b8ad) -
+  Removes `aria-required` from use directly on field. It is automatically applied via `fieldProps`
+  when using `isRequired`, so this change is purely to ensure people appropriately apply
+  accessibility props to their fields without the false sense of security of an invalid use of
+  `aria-required`.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 14.4.0
 
 ### Minor Changes

package/dist/cjs/field.js

@@ -14,6 +14,7 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _react = _interopRequireWildcard(require("react"));
 var _useId = require("@atlaskit/ds-lib/use-id");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _fieldIdContext = require("./field-id-context");
 var _form = require("./form");
 var _label = require("./label");
@@ -121,6 +122,7 @@ function Field(props) {
     state = _useState2[0],
     setState = _useState2[1];
   var latestStateRef = usePreviousRef(state);
+  var isRequiredDependency = (0, _platformFeatureFlags.fg)('platform_dst_form_fix_isrequired_effect') ? props.isRequired : undefined;
   (0, _react.useEffect)(function () {
     function fieldStateToMeta() {
       var value = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -229,7 +231,7 @@ function Field(props) {
       }
     });
     return unregister;
-  }, [latestPropsRef, latestStateRef, registerField, props.name, isDefaultValueChanged]);
+  }, [latestPropsRef, latestStateRef, registerField, props.name, isRequiredDependency, isDefaultValueChanged]);
   var uid = (0, _useId.useId)();
   var fieldId = (0, _react.useMemo)(function () {
     return props.id ? props.id : "".concat(props.name, "-").concat(uid);

package/dist/es2019/field.js

@@ -3,6 +3,7 @@ import "./field.compiled.css";
 import { ax, ix } from "@compiled/react/runtime";
 import React, { useContext, useEffect, useMemo, useRef, useState } from 'react';
 import { useId } from '@atlaskit/ds-lib/use-id';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { FieldId } from './field-id-context';
 import { FormContext, IsDisabledContext } from './form';
 import { Label } from './label';
@@ -104,6 +105,7 @@ export default function Field(props) {
     }
   });
   const latestStateRef = usePreviousRef(state);
+  const isRequiredDependency = fg('platform_dst_form_fix_isrequired_effect') ? props.isRequired : undefined;
   useEffect(() => {
     function fieldStateToMeta(value = {}) {
       return {
@@ -211,7 +213,7 @@ export default function Field(props) {
       }
     });
     return unregister;
-  }, [latestPropsRef, latestStateRef, registerField, props.name, isDefaultValueChanged]);
+  }, [latestPropsRef, latestStateRef, registerField, props.name, isRequiredDependency, isDefaultValueChanged]);
   const uid = useId();
   const fieldId = useMemo(() => {
     return props.id ? props.id : `${props.name}-${uid}`;

package/dist/esm/field.js

@@ -8,6 +8,7 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import React, { useContext, useEffect, useMemo, useRef, useState } from 'react';
 import { useId } from '@atlaskit/ds-lib/use-id';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { FieldId } from './field-id-context';
 import { FormContext, IsDisabledContext } from './form';
 import { Label } from './label';
@@ -112,6 +113,7 @@ export default function Field(props) {
     state = _useState2[0],
     setState = _useState2[1];
   var latestStateRef = usePreviousRef(state);
+  var isRequiredDependency = fg('platform_dst_form_fix_isrequired_effect') ? props.isRequired : undefined;
   useEffect(function () {
     function fieldStateToMeta() {
       var value = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -220,7 +222,7 @@ export default function Field(props) {
       }
     });
     return unregister;
-  }, [latestPropsRef, latestStateRef, registerField, props.name, isDefaultValueChanged]);
+  }, [latestPropsRef, latestStateRef, registerField, props.name, isRequiredDependency, isDefaultValueChanged]);
   var uid = useId();
   var fieldId = useMemo(function () {
     return props.id ? props.id : "".concat(props.name, "-").concat(uid);

package/dist/types/field.d.ts

@@ -97,6 +97,10 @@ export type FieldComponentProps<FieldValue, Element extends SupportedElements> =
      * A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests
      */
     testId?: string;
+    /**
+     * The `aria-required` prop is disallowed. It is automatically applied when using `isRequired` via `fieldProps`.
+     */
+    'aria-required'?: never;
 };
 export default function Field<FieldValue = string, Element extends SupportedElements = HTMLInputElement>(props: FieldComponentProps<FieldValue, Element>): JSX.Element;
 export {};

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

@@ -97,6 +97,10 @@ export type FieldComponentProps<FieldValue, Element extends SupportedElements> =
      * A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests
      */
     testId?: string;
+    /**
+     * The `aria-required` prop is disallowed. It is automatically applied when using `isRequired` via `fieldProps`.
+     */
+    'aria-required'?: never;
 };
 export default function Field<FieldValue = string, Element extends SupportedElements = HTMLInputElement>(props: FieldComponentProps<FieldValue, Element>): JSX.Element;
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@atlaskit/form",
-	"version": "14.4.0",
-	"description": "A form allows users to input information.",
+	"version": "15.0.1",
+	"description": "A form allows people to input information.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
 	},
@@ -25,13 +25,13 @@
 		}
 	},
 	"dependencies": {
-		"@atlaskit/css": "^0.17.0",
+		"@atlaskit/css": "^0.18.0",
 		"@atlaskit/ds-lib": "^5.3.0",
 		"@atlaskit/heading": "^5.2.0",
-		"@atlaskit/icon": "^29.0.0",
+		"@atlaskit/icon": "^29.2.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/primitives": "^16.4.0",
-		"@atlaskit/tokens": "^8.4.0",
+		"@atlaskit/tokens": "^8.6.0",
 		"@atlaskit/visually-hidden": "^3.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.18.6",
@@ -47,23 +47,24 @@
 		"@af/integration-testing": "workspace:^",
 		"@af/visual-regression": "workspace:^",
 		"@atlaskit/banner": "^14.0.0",
-		"@atlaskit/button": "^23.7.0",
+		"@atlaskit/button": "^23.8.0",
 		"@atlaskit/checkbox": "^17.2.0",
 		"@atlaskit/codemod-utils": "^4.2.0",
 		"@atlaskit/datetime-picker": "^17.2.0",
 		"@atlaskit/docs": "^11.2.0",
 		"@atlaskit/link": "^3.2.0",
-		"@atlaskit/lozenge": "^13.1.0",
-		"@atlaskit/modal-dialog": "^14.8.0",
+		"@atlaskit/lozenge": "^13.2.0",
+		"@atlaskit/modal-dialog": "^14.9.0",
 		"@atlaskit/radio": "^8.3.0",
 		"@atlaskit/range": "^9.3.0",
-		"@atlaskit/section-message": "^8.10.0",
-		"@atlaskit/select": "^21.5.0",
+		"@atlaskit/section-message": "^8.11.0",
+		"@atlaskit/select": "^21.6.0",
 		"@atlaskit/textarea": "^8.2.0",
 		"@atlaskit/textfield": "^8.2.0",
 		"@atlaskit/toggle": "^15.2.0",
 		"@atlassian/feature-flags-test-utils": "^1.0.0",
 		"@atlassian/ssr-tests": "workspace:^",
+		"@atlassian/testing-library": "^0.4.0",
 		"@testing-library/react": "^13.4.0",
 		"@testing-library/react-hooks": "^8.0.1",
 		"@testing-library/user-event": "^14.4.3",
@@ -117,6 +118,9 @@
 		},
 		"platform-form-reset-field-state": {
 			"type": "boolean"
+		},
+		"platform_dst_form_fix_isrequired_effect": {
+			"type": "boolean"
 		}
 	}
 }