@atlaskit/form 8.7.1 → 8.8.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/form
 
+## 8.8.0
+
+### Minor Changes
+
+- [`f2d39d67a70`](https://bitbucket.org/atlassian/atlassian-frontend/commits/f2d39d67a70) - Fixed the issue where field's value was reset on the component re-mount.
+
 ## 8.7.1
 
 ### Patch Changes

package/dist/cjs/field.js

@@ -93,9 +93,22 @@ function isShallowEqual(previousValue, currentValue) {
 }
 
 function Field(props) {
-  var registerField = (0, _react.useContext)(_form.FormContext);
+  var _getCurrentValue;
+
+  var _useContext = (0, _react.useContext)(_form.FormContext),
+      registerField = _useContext.registerField,
+      getCurrentValue = _useContext.getCurrentValue;
+
   var isDisabled = (0, _react.useContext)(_form.IsDisabledContext) || props.isDisabled || false;
   var defaultValue = isFunction(props.defaultValue) ? props.defaultValue() : props.defaultValue;
+  var latestPropsRef = usePreviousRef(props);
+  /**
+   * HACK: defaultValue can potentially be an array or object which cannot be
+   * passed directly into a `useEffect` dependency array, since it will trigger
+   * the hook every time.
+   */
+
+  var isDefaultValueChanged = !isShallowEqual(latestPropsRef.current.defaultValue, props.defaultValue);
 
   var _useState = (0, _react.useState)({
     fieldProps: {
@@ -108,9 +121,13 @@ function Field(props) {
        * prop types defined defaultValue as required, so inside the component it was not
        * valid for defaultValue to be undefined. We need to suppress the error
        * after changing defaultValue to explictly be an optional prop.
+       * If default value has changed we are using new default value.
+       * Otherwise we need to check if we already have value for this field
+       * (because we are using changing key prop to re-run field level validation, and that
+       * cause the component re-mounting) to not override the actual value with the default value.
        */
       // @ts-ignore
-      value: defaultValue
+      value: isDefaultValueChanged ? defaultValue : (_getCurrentValue = getCurrentValue(props.name)) !== null && _getCurrentValue !== void 0 ? _getCurrentValue : defaultValue
     },
     error: undefined,
     valid: false,
@@ -130,15 +147,7 @@ function Field(props) {
       state = _useState2[0],
       setState = _useState2[1];
 
-  var latestPropsRef = usePreviousRef(props);
   var latestStateRef = usePreviousRef(state);
-  /**
-   * HACK: defaultValue can potentially be an array or object which cannot be
-   * passed directly into a `useEffect` dependency array, since it will trigger
-   * the hook every time.
-   */
-
-  var hasDefaultValueChanged = isShallowEqual(latestPropsRef.current.defaultValue, props.defaultValue);
   (0, _react.useEffect)(function () {
     if (process.env.NODE_ENV !== 'production' && !process.env.CI) {
       (0, _tinyInvariant.default)(latestPropsRef.current.name, '@atlaskit/form: Field components have a required name prop');
@@ -159,8 +168,18 @@ function Field(props) {
       };
     }
 
-    var unregister = registerField(latestPropsRef.current.name, // @ts-ignore
-    latestPropsRef.current.defaultValue, function (fieldState) {
+    var unregister = registerField(latestPropsRef.current.name,
+    /**
+     * Similar as for setting initial state value.
+     * Additionally we are checking if the default value is a function,
+     * it is used in checkbox fields, where fields with same name and
+     * defaultIsChecked should create array of values. In this situation we can't
+     * override the default value on re-registering, but also we don't need to change
+     * the key prop to re-run validation.
+     */
+    // @ts-ignore
+    isDefaultValueChanged || // @ts-ignore
+    isFunction(latestPropsRef.current.defaultValue) ? latestPropsRef.current.defaultValue : latestStateRef.current.fieldProps.value, function (fieldState) {
       /**
        * Do not update dirtySinceLastSubmit until submission has finished.
        */
@@ -248,7 +267,7 @@ function Field(props) {
       }
     });
     return unregister;
-  }, [latestPropsRef, latestStateRef, registerField, props.name, hasDefaultValueChanged]);
+  }, [latestPropsRef, latestStateRef, registerField, props.name, isDefaultValueChanged]);
   var fieldId = (0, _react.useMemo)( // eslint-disable-next-line @repo/internal/react/disallow-unstable-values
   function () {
     return props.id ? props.id : "".concat(props.name, "-").concat((0, _reactUid.uid)({

package/dist/cjs/form.js

@@ -29,8 +29,13 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
  *
  * A form context creates a context for the field values and allows them to be accessed by the children.
  */
-var FormContext = /*#__PURE__*/(0, _react.createContext)(function () {
-  return function () {};
+var FormContext = /*#__PURE__*/(0, _react.createContext)({
+  registerField: function registerField() {
+    return function () {};
+  },
+  getCurrentValue: function getCurrentValue() {
+    return undefined;
+  }
 });
 /**
  * __Is disabled context__
@@ -143,8 +148,23 @@ function Form(props) {
       children = props.children;
   var dirty = state.dirty,
       submitting = state.submitting;
+  /**
+   * This method is needed in FormContext to use it on the field level
+   * to check the current value of the field in case of the component re-mounting.
+   */
+
+  var getCurrentValue = (0, _react.useCallback)(function (name) {
+    var formState = form.getState();
+    return (formState === null || formState === void 0 ? void 0 : formState.values[name]) || undefined;
+  }, [form]);
+  var FormContextValue = (0, _react.useMemo)(function () {
+    return {
+      registerField: registerField,
+      getCurrentValue: getCurrentValue
+    };
+  }, [registerField, getCurrentValue]);
   return /*#__PURE__*/_react.default.createElement(FormContext.Provider, {
-    value: registerField
+    value: FormContextValue
   }, /*#__PURE__*/_react.default.createElement(IsDisabledContext.Provider, {
     value: isDisabled
   }, children({

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/form",
-	"version": "8.7.1",
+	"version": "8.8.0",
 	"sideEffects": false
 }

package/dist/es2019/field.js

@@ -65,9 +65,22 @@ function isShallowEqual(previousValue, currentValue) {
 }
 
 export default function Field(props) {
-  const registerField = useContext(FormContext);
+  var _getCurrentValue;
+
+  const {
+    registerField,
+    getCurrentValue
+  } = useContext(FormContext);
   const isDisabled = useContext(IsDisabledContext) || props.isDisabled || false;
   const defaultValue = isFunction(props.defaultValue) ? props.defaultValue() : props.defaultValue;
+  const latestPropsRef = usePreviousRef(props);
+  /**
+   * HACK: defaultValue can potentially be an array or object which cannot be
+   * passed directly into a `useEffect` dependency array, since it will trigger
+   * the hook every time.
+   */
+
+  const isDefaultValueChanged = !isShallowEqual(latestPropsRef.current.defaultValue, props.defaultValue);
   const [state, setState] = useState({
     fieldProps: {
       onChange: () => {},
@@ -79,9 +92,13 @@ export default function Field(props) {
        * prop types defined defaultValue as required, so inside the component it was not
        * valid for defaultValue to be undefined. We need to suppress the error
        * after changing defaultValue to explictly be an optional prop.
+       * If default value has changed we are using new default value.
+       * Otherwise we need to check if we already have value for this field
+       * (because we are using changing key prop to re-run field level validation, and that
+       * cause the component re-mounting) to not override the actual value with the default value.
        */
       // @ts-ignore
-      value: defaultValue
+      value: isDefaultValueChanged ? defaultValue : (_getCurrentValue = getCurrentValue(props.name)) !== null && _getCurrentValue !== void 0 ? _getCurrentValue : defaultValue
     },
     error: undefined,
     valid: false,
@@ -97,15 +114,7 @@ export default function Field(props) {
       submitError: undefined
     }
   });
-  const latestPropsRef = usePreviousRef(props);
   const latestStateRef = usePreviousRef(state);
-  /**
-   * HACK: defaultValue can potentially be an array or object which cannot be
-   * passed directly into a `useEffect` dependency array, since it will trigger
-   * the hook every time.
-   */
-
-  const hasDefaultValueChanged = isShallowEqual(latestPropsRef.current.defaultValue, props.defaultValue);
   useEffect(() => {
     if (process.env.NODE_ENV !== 'production' && !process.env.CI) {
       invariant(latestPropsRef.current.name, '@atlaskit/form: Field components have a required name prop');
@@ -125,8 +134,18 @@ export default function Field(props) {
       };
     }
 
-    const unregister = registerField(latestPropsRef.current.name, // @ts-ignore
-    latestPropsRef.current.defaultValue, fieldState => {
+    const unregister = registerField(latestPropsRef.current.name,
+    /**
+     * Similar as for setting initial state value.
+     * Additionally we are checking if the default value is a function,
+     * it is used in checkbox fields, where fields with same name and
+     * defaultIsChecked should create array of values. In this situation we can't
+     * override the default value on re-registering, but also we don't need to change
+     * the key prop to re-run validation.
+     */
+    // @ts-ignore
+    isDefaultValueChanged || // @ts-ignore
+    isFunction(latestPropsRef.current.defaultValue) ? latestPropsRef.current.defaultValue : latestStateRef.current.fieldProps.value, fieldState => {
       /**
        * Do not update dirtySinceLastSubmit until submission has finished.
        */
@@ -214,7 +233,7 @@ export default function Field(props) {
       }
     });
     return unregister;
-  }, [latestPropsRef, latestStateRef, registerField, props.name, hasDefaultValueChanged]);
+  }, [latestPropsRef, latestStateRef, registerField, props.name, isDefaultValueChanged]);
   const fieldId = useMemo( // eslint-disable-next-line @repo/internal/react/disallow-unstable-values
   () => props.id ? props.id : `${props.name}-${uid({
     id: props.name

package/dist/es2019/form.js

@@ -1,4 +1,4 @@
-import React, { createContext, useCallback, useEffect, useRef, useState } from 'react';
+import React, { createContext, useCallback, useEffect, useMemo, useRef, useState } from 'react';
 import { createForm } from 'final-form';
 import createDecorator from 'final-form-focus';
 import set from 'lodash/set';
@@ -8,8 +8,11 @@ import set from 'lodash/set';
  *
  * A form context creates a context for the field values and allows them to be accessed by the children.
  */
-export const FormContext = /*#__PURE__*/createContext(function () {
-  return () => {};
+export const FormContext = /*#__PURE__*/createContext({
+  registerField: function () {
+    return () => {};
+  },
+  getCurrentValue: () => undefined
 });
 /**
  * __Is disabled context__
@@ -105,8 +108,23 @@ export default function Form(props) {
     dirty,
     submitting
   } = state;
+  /**
+   * This method is needed in FormContext to use it on the field level
+   * to check the current value of the field in case of the component re-mounting.
+   */
+
+  const getCurrentValue = useCallback(name => {
+    const formState = form.getState();
+    return (formState === null || formState === void 0 ? void 0 : formState.values[name]) || undefined;
+  }, [form]);
+  const FormContextValue = useMemo(() => {
+    return {
+      registerField,
+      getCurrentValue
+    };
+  }, [registerField, getCurrentValue]);
   return /*#__PURE__*/React.createElement(FormContext.Provider, {
-    value: registerField
+    value: FormContextValue
   }, /*#__PURE__*/React.createElement(IsDisabledContext.Provider, {
     value: isDisabled
   }, children({

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/form",
-	"version": "8.7.1",
+	"version": "8.8.0",
 	"sideEffects": false
 }

package/dist/esm/field.js

@@ -73,9 +73,22 @@ function isShallowEqual(previousValue, currentValue) {
 }
 
 export default function Field(props) {
-  var registerField = useContext(FormContext);
+  var _getCurrentValue;
+
+  var _useContext = useContext(FormContext),
+      registerField = _useContext.registerField,
+      getCurrentValue = _useContext.getCurrentValue;
+
   var isDisabled = useContext(IsDisabledContext) || props.isDisabled || false;
   var defaultValue = isFunction(props.defaultValue) ? props.defaultValue() : props.defaultValue;
+  var latestPropsRef = usePreviousRef(props);
+  /**
+   * HACK: defaultValue can potentially be an array or object which cannot be
+   * passed directly into a `useEffect` dependency array, since it will trigger
+   * the hook every time.
+   */
+
+  var isDefaultValueChanged = !isShallowEqual(latestPropsRef.current.defaultValue, props.defaultValue);
 
   var _useState = useState({
     fieldProps: {
@@ -88,9 +101,13 @@ export default function Field(props) {
        * prop types defined defaultValue as required, so inside the component it was not
        * valid for defaultValue to be undefined. We need to suppress the error
        * after changing defaultValue to explictly be an optional prop.
+       * If default value has changed we are using new default value.
+       * Otherwise we need to check if we already have value for this field
+       * (because we are using changing key prop to re-run field level validation, and that
+       * cause the component re-mounting) to not override the actual value with the default value.
        */
       // @ts-ignore
-      value: defaultValue
+      value: isDefaultValueChanged ? defaultValue : (_getCurrentValue = getCurrentValue(props.name)) !== null && _getCurrentValue !== void 0 ? _getCurrentValue : defaultValue
     },
     error: undefined,
     valid: false,
@@ -110,15 +127,7 @@ export default function Field(props) {
       state = _useState2[0],
       setState = _useState2[1];
 
-  var latestPropsRef = usePreviousRef(props);
   var latestStateRef = usePreviousRef(state);
-  /**
-   * HACK: defaultValue can potentially be an array or object which cannot be
-   * passed directly into a `useEffect` dependency array, since it will trigger
-   * the hook every time.
-   */
-
-  var hasDefaultValueChanged = isShallowEqual(latestPropsRef.current.defaultValue, props.defaultValue);
   useEffect(function () {
     if (process.env.NODE_ENV !== 'production' && !process.env.CI) {
       invariant(latestPropsRef.current.name, '@atlaskit/form: Field components have a required name prop');
@@ -139,8 +148,18 @@ export default function Field(props) {
       };
     }
 
-    var unregister = registerField(latestPropsRef.current.name, // @ts-ignore
-    latestPropsRef.current.defaultValue, function (fieldState) {
+    var unregister = registerField(latestPropsRef.current.name,
+    /**
+     * Similar as for setting initial state value.
+     * Additionally we are checking if the default value is a function,
+     * it is used in checkbox fields, where fields with same name and
+     * defaultIsChecked should create array of values. In this situation we can't
+     * override the default value on re-registering, but also we don't need to change
+     * the key prop to re-run validation.
+     */
+    // @ts-ignore
+    isDefaultValueChanged || // @ts-ignore
+    isFunction(latestPropsRef.current.defaultValue) ? latestPropsRef.current.defaultValue : latestStateRef.current.fieldProps.value, function (fieldState) {
       /**
        * Do not update dirtySinceLastSubmit until submission has finished.
        */
@@ -228,7 +247,7 @@ export default function Field(props) {
       }
     });
     return unregister;
-  }, [latestPropsRef, latestStateRef, registerField, props.name, hasDefaultValueChanged]);
+  }, [latestPropsRef, latestStateRef, registerField, props.name, isDefaultValueChanged]);
   var fieldId = useMemo( // eslint-disable-next-line @repo/internal/react/disallow-unstable-values
   function () {
     return props.id ? props.id : "".concat(props.name, "-").concat(uid({

package/dist/esm/form.js

@@ -1,5 +1,5 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
-import React, { createContext, useCallback, useEffect, useRef, useState } from 'react';
+import React, { createContext, useCallback, useEffect, useMemo, useRef, useState } from 'react';
 import { createForm } from 'final-form';
 import createDecorator from 'final-form-focus';
 import set from 'lodash/set';
@@ -9,8 +9,13 @@ import set from 'lodash/set';
  *
  * A form context creates a context for the field values and allows them to be accessed by the children.
  */
-export var FormContext = /*#__PURE__*/createContext(function () {
-  return function () {};
+export var FormContext = /*#__PURE__*/createContext({
+  registerField: function registerField() {
+    return function () {};
+  },
+  getCurrentValue: function getCurrentValue() {
+    return undefined;
+  }
 });
 /**
  * __Is disabled context__
@@ -120,8 +125,23 @@ export default function Form(props) {
       children = props.children;
   var dirty = state.dirty,
       submitting = state.submitting;
+  /**
+   * This method is needed in FormContext to use it on the field level
+   * to check the current value of the field in case of the component re-mounting.
+   */
+
+  var getCurrentValue = useCallback(function (name) {
+    var formState = form.getState();
+    return (formState === null || formState === void 0 ? void 0 : formState.values[name]) || undefined;
+  }, [form]);
+  var FormContextValue = useMemo(function () {
+    return {
+      registerField: registerField,
+      getCurrentValue: getCurrentValue
+    };
+  }, [registerField, getCurrentValue]);
   return /*#__PURE__*/React.createElement(FormContext.Provider, {
-    value: registerField
+    value: FormContextValue
   }, /*#__PURE__*/React.createElement(IsDisabledContext.Provider, {
     value: isDisabled
   }, children({

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/form",
-	"version": "8.7.1",
+	"version": "8.8.0",
 	"sideEffects": false
 }

package/dist/types/form.d.ts

@@ -3,12 +3,16 @@ import { FieldConfig, FieldSubscriber, FieldSubscription, FormState, Unsubscribe
 import { OnSubmitHandler } from './types';
 declare type DefaultValue<FieldValue> = (value?: FieldValue) => FieldValue;
 declare type RegisterField = <FieldValue>(name: string, defaultValue: FieldValue | DefaultValue<FieldValue>, subscriber: FieldSubscriber<FieldValue>, subscription: FieldSubscription, config: FieldConfig<FieldValue>) => Unsubscribe;
+declare type GetCurrentValue = <FormValues>(name: string) => FormValues[keyof FormValues] | undefined;
 /**
  * __Form context__
  *
  * A form context creates a context for the field values and allows them to be accessed by the children.
  */
-export declare const FormContext: React.Context<RegisterField>;
+export declare const FormContext: React.Context<{
+    registerField: RegisterField;
+    getCurrentValue: GetCurrentValue;
+}>;
 /**
  * __Is disabled context__
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/form",
-  "version": "8.7.1",
+  "version": "8.8.0",
   "description": "A form allows users to input information.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -54,7 +54,7 @@
     "react": "^16.8.0"
   },
   "devDependencies": {
-    "@atlaskit/button": "^16.4.0",
+    "@atlaskit/button": "^16.5.0",
     "@atlaskit/calendar": "^12.4.0",
     "@atlaskit/checkbox": "^12.4.0",
     "@atlaskit/datetime-picker": "^12.3.0",
@@ -66,7 +66,7 @@
     "@atlaskit/radio": "^5.4.0",
     "@atlaskit/range": "^7.0.0",
     "@atlaskit/section-message": "^6.3.0",
-    "@atlaskit/select": "^15.7.0",
+    "@atlaskit/select": "^16.0.0",
     "@atlaskit/ssr": "*",
     "@atlaskit/textarea": "^4.5.0",
     "@atlaskit/textfield": "^5.3.0",

package/report.api.md

@@ -1,12 +1,17 @@
+<!-- API Report Version: 2.2 -->
+
 ## API Report File for "@atlaskit/form"
 
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
 
-<!--
-	Generated API Report version: 2.0
--->
+- [Main Entry Types](#main-entry-types)
 
-[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
 
 ```ts
 import { FC } from 'react';
@@ -18,7 +23,7 @@ import { default as React_2 } from 'react';
 import { ReactNode } from 'react';
 
 // @public (undocumented)
-type Align = 'start' | 'end';
+type Align = 'end' | 'start';
 
 // @public
 export const CheckboxField: FC<CheckboxProps>;
@@ -63,22 +68,23 @@ interface FieldComponentProps<FieldValue, Element extends SupportedElements> {
     meta: Meta;
   }) => ReactNode;
   defaultValue?:
-    | FieldValue
-    | ((currentDefaultValue?: FieldValue) => FieldValue);
+    | ((currentDefaultValue?: FieldValue) => FieldValue)
+    | FieldValue;
+  elementAfterLabel?: ReactNode;
   id?: string;
   isDisabled?: boolean;
   isRequired?: boolean;
   label?: ReactNode;
   name: string;
   transform?: (
-    event: FormEvent<Element> | FieldValue,
+    event: FieldValue | FormEvent<Element>,
     current: FieldValue,
   ) => FieldValue;
   validate?: (
     value: FieldValue | undefined,
     formState: Object,
     fieldState: Meta,
-  ) => string | void | Promise<string | void>;
+  ) => Promise<string | void> | string | void;
 }
 
 // @public (undocumented)
@@ -87,7 +93,7 @@ export interface FieldProps<
   Element extends SupportedElements = HTMLInputElement,
 > {
   // (undocumented)
-  'aria-invalid': 'true' | 'false';
+  'aria-invalid': 'false' | 'true';
   // (undocumented)
   'aria-labelledby': string;
   // (undocumented)
@@ -103,7 +109,7 @@ export interface FieldProps<
   // (undocumented)
   onBlur: () => void;
   // (undocumented)
-  onChange: (value: FormEvent<Element> | FieldValue) => void;
+  onChange: (value: FieldValue | FormEvent<Element>) => void;
   // (undocumented)
   onFocus: () => void;
   // (undocumented)
@@ -241,7 +247,7 @@ export type OnSubmitHandler<FormData> = (
   values: FormData,
   form: FormApi<FormData>,
   callback?: (errors?: Record<string, string>) => void,
-) => void | Object | Promise<Object | void>;
+) => Object | Promise<Object | void> | void;
 
 // @public
 export const RangeField: FC<RangeFieldProps>;
@@ -254,7 +260,7 @@ export interface RangeFieldProps {
     error?: string;
     meta: Meta;
   }) => React_2.ReactNode;
-  defaultValue: number | ((currentDefaultValue?: number) => number);
+  defaultValue: ((currentDefaultValue?: number) => number) | number;
   id?: string;
   isDisabled?: boolean;
   label?: ReactNode;
@@ -267,11 +273,13 @@ type RangeProps = Omit<FieldProps<number>, 'isInvalid' | 'isRequired'>;
 // @public (undocumented)
 type SupportedElements =
   | HTMLInputElement
-  | HTMLTextAreaElement
-  | HTMLSelectElement;
+  | HTMLSelectElement
+  | HTMLTextAreaElement;
 
 // @public
 export const ValidMessage: React_2.FC<MessageProps>;
 
 // (No @packageDocumentation comment for this package)
 ```
+
+<!--SECTION END: Main Entry Types-->