@atlaskit/form 12.6.0 → 12.6.2

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/form
 
+## 12.6.2
+
+### Patch Changes
+
+- [`2f220beaedb7a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/2f220beaedb7a) -
+  Remove unused dependency.
+
+## 12.6.1
+
+### Patch Changes
+
+- [`2e9c49d200b1d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/2e9c49d200b1d) -
+  Added resetFieldState to Form children props
+- Updated dependencies
+
 ## 12.6.0
 
 ### Minor Changes
@@ -299,8 +314,7 @@
   handle `.css` imports correctly.Most bundlers come with built-in support for `.css` imports, so
   you may not need to do anything. If you are using a different bundler, please refer to the
   documentation for that bundler to understand how to handle `.css` imports.For more information on
-  the migration, please refer to [RFC-73 Migrating our components to
-  Compiled
+  the migration, please refer to [RFC-73 Migrating our components to Compiled
   CSS-in-JS](https://community.developer.atlassian.com/t/rfc-73-migrating-our-components-to-compiled-css-in-js/859
 
 ## 10.6.3

package/dist/cjs/form.js

@@ -157,7 +157,7 @@ function Form(props) {
   });
   var childrenContent = function () {
     if (typeof children === 'function') {
-      var result = children.length > 0 ? children({
+      var result = children.length > 0 ? children(_objectSpread({
         formProps: formProps,
         dirty: dirty,
         reset: handleReset,
@@ -170,7 +170,9 @@ function Form(props) {
           return form.getState().values;
         },
         setFieldValue: form.change
-      }) : children();
+      }, (0, _platformFeatureFlags.fg)('platform-form-reset-field-state') && {
+        resetFieldState: form.resetFieldState
+      })) : children();
       return result === undefined ? null : result;
     } else {
       return (0, _platformFeatureFlags.fg)('platform_design-system-team_form-upgrade') ? /*#__PURE__*/_react.default.createElement("form", (0, _extends2.default)({}, formProps, userProvidedFormProps), children) : children;

package/dist/es2019/form.js

@@ -144,7 +144,10 @@ export default function Form(props) {
         disabled: isDisabled,
         getState: () => form.getState(),
         getValues: () => form.getState().values,
-        setFieldValue: form.change
+        setFieldValue: form.change,
+        ...(fg('platform-form-reset-field-state') && {
+          resetFieldState: form.resetFieldState
+        })
       }) : children();
       return result === undefined ? null : result;
     } else {

package/dist/esm/form.js

@@ -147,7 +147,7 @@ export default function Form(props) {
   });
   var childrenContent = function () {
     if (typeof children === 'function') {
-      var result = children.length > 0 ? children({
+      var result = children.length > 0 ? children(_objectSpread({
         formProps: formProps,
         dirty: dirty,
         reset: handleReset,
@@ -160,7 +160,9 @@ export default function Form(props) {
           return form.getState().values;
         },
         setFieldValue: form.change
-      }) : children();
+      }, fg('platform-form-reset-field-state') && {
+        resetFieldState: form.resetFieldState
+      })) : children();
       return result === undefined ? null : result;
     } else {
       return fg('platform_design-system-team_form-upgrade') ? /*#__PURE__*/React.createElement("form", _extends({}, formProps, userProvidedFormProps), children) : children;

package/dist/types/form.d.ts

@@ -33,6 +33,7 @@ type FormChildrenArgs<FormValues> = {
     getState: () => FormState<FormValues>;
     getValues: () => FormValues;
     setFieldValue: (name: string, value: any) => void;
+    resetFieldState?: (name: string) => void;
     reset: (initialValues?: FormValues) => void;
 };
 type ExcludeReservedFormProps = {

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

@@ -33,6 +33,7 @@ type FormChildrenArgs<FormValues> = {
     getState: () => FormState<FormValues>;
     getValues: () => FormValues;
     setFieldValue: (name: string, value: any) => void;
+    resetFieldState?: (name: string) => void;
     reset: (initialValues?: FormValues) => void;
 };
 type ExcludeReservedFormProps = {

package/offerings.json

@@ -0,0 +1,40 @@
+[
+	{
+		"name": "Form",
+		"package": "@atlaskit/form",
+		"import": {
+			"name": "Form",
+			"package": "@atlaskit/form",
+			"type": "default"
+		},
+		"keywords": ["form", "validation", "field", "input", "submit", "state"],
+		"categories": ["form"],
+		"shortDescription": "A component for building forms with validation and state management.",
+		"status": "general-availability",
+		"accessibilityGuidelines": [
+			"Provide clear labels for all form fields",
+			"Use appropriate error messaging",
+			"Ensure keyboard navigation between fields",
+			"Mark required fields clearly",
+			"Provide helpful validation feedback"
+		],
+		"usageGuidelines": [
+			"Use for complex forms with validation",
+			"Provide clear field labels and instructions",
+			"Use single column layout for better comprehension",
+			"Mark required fields with asterisk (*)",
+			"Provide specific error messages"
+		],
+		"contentGuidelines": [
+			"Use clear, concise labels",
+			"Write helpful placeholder text",
+			"Provide specific error messages",
+			"Use consistent terminology",
+			"Always include a visible label (exception: search fields)",
+			"Match field length to intended content length"
+		],
+		"examples": {
+			"basic": "./examples/ai/form.tsx"
+		}
+	}
+]

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/form",
-	"version": "12.6.0",
+	"version": "12.6.2",
 	"description": "A form allows users to input information.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -28,10 +28,9 @@
 		"@atlaskit/css": "^0.14.0",
 		"@atlaskit/ds-lib": "^5.0.0",
 		"@atlaskit/heading": "^5.2.0",
-		"@atlaskit/icon": "^28.1.0",
+		"@atlaskit/icon": "^28.2.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/primitives": "^14.14.0",
-		"@atlaskit/theme": "^21.0.0",
 		"@atlaskit/tokens": "^6.3.0",
 		"@babel/runtime": "^7.0.0",
 		"final-form": "^4.20.3",
@@ -50,14 +49,14 @@
 		"@atlaskit/checkbox": "^17.1.0",
 		"@atlaskit/codemod-utils": "^4.2.0",
 		"@atlaskit/datetime-picker": "^17.0.0",
-		"@atlaskit/docs": "^11.0.0",
+		"@atlaskit/docs": "^11.1.0",
 		"@atlaskit/link": "^3.2.0",
 		"@atlaskit/lozenge": "^13.0.0",
 		"@atlaskit/modal-dialog": "^14.3.0",
 		"@atlaskit/radio": "^8.3.0",
 		"@atlaskit/range": "^9.2.0",
 		"@atlaskit/section-message": "^8.7.0",
-		"@atlaskit/select": "^21.2.0",
+		"@atlaskit/select": "^21.3.0",
 		"@atlaskit/textarea": "^8.0.0",
 		"@atlaskit/textfield": "^8.0.0",
 		"@atlaskit/toggle": "^15.1.0",
@@ -122,6 +121,9 @@
 		},
 		"platform-form-field-error-focus": {
 			"type": "boolean"
+		},
+		"platform-form-reset-field-state": {
+			"type": "boolean"
 		}
 	}
 }