@atlaskit/form 12.6.2 → 12.7.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/form
 
+## 12.7.0
+
+### Minor Changes
+
+- [`edef4ab21e5c5`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/edef4ab21e5c5) -
+  We are testing a new streamlined implementation of the field component behind a feature flag. If
+  this fix is successful it will be available in a later release.
+
 ## 12.6.2
 
 ### Patch Changes

package/dist/cjs/field.js

@@ -8,16 +8,17 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = Field;
 require("./field.compiled.css");
-var _react = _interopRequireWildcard(require("react"));
-var React = _react;
 var _runtime = require("@compiled/react/runtime");
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 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");
+var _messages = require("./messages");
 var _requiredAsterisk = _interopRequireDefault(require("./required-asterisk"));
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof3(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
@@ -67,6 +68,11 @@ function isShallowEqual(previousValue, currentValue) {
 }
 function Field(props) {
   var _getCurrentValue;
+  var _props$children = props.children,
+    children = _props$children === void 0 ? function () {
+      return null;
+    } : _props$children,
+    component = props.component;
   var _useContext = (0, _react.useContext)(_form.FormContext),
     registerField = _useContext.registerField,
     getCurrentValue = _useContext.getCurrentValue;
@@ -248,16 +254,18 @@ function Field(props) {
     'aria-labelledby': "".concat(fieldId, "-label"),
     id: fieldId
   });
-  return /*#__PURE__*/React.createElement("div", {
+  return /*#__PURE__*/_react.default.createElement("div", {
     "data-testid": props.testId,
     className: (0, _runtime.ax)(["_1pfhu2gc"])
-  }, props.label && /*#__PURE__*/React.createElement(_label.Label, {
+  }, props.label && /*#__PURE__*/_react.default.createElement(_label.Label, {
     htmlFor: fieldId,
     id: "".concat(fieldId, "-label"),
     testId: props.testId && "".concat(props.testId, "--label")
-  }, props.label, props.isRequired && /*#__PURE__*/React.createElement(_requiredAsterisk.default, null), props.elementAfterLabel), /*#__PURE__*/React.createElement(_fieldIdContext.FieldId.Provider, {
+  }, props.label, props.isRequired && /*#__PURE__*/_react.default.createElement(_requiredAsterisk.default, null), props.elementAfterLabel), /*#__PURE__*/_react.default.createElement(_fieldIdContext.FieldId.Provider, {
     value: fieldId
-  }, props.children({
+  }, component && (0, _platformFeatureFlags.fg)('platform_design-system-team_field-upgrade') ? /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, component && component({
+    fieldProps: extendedFieldProps
+  }), /*#__PURE__*/_react.default.createElement(_messages.MessageWrapper, null, props.helperMessage && /*#__PURE__*/_react.default.createElement(_messages.HelperMessage, null, props.helperMessage), state.error && /*#__PURE__*/_react.default.createElement(_messages.ErrorMessage, null, props.errorMessage || state.error), state.meta.touched && state.valid && props.validMessage && /*#__PURE__*/_react.default.createElement(_messages.ValidMessage, null, props.validMessage))) : children({
     fieldProps: extendedFieldProps,
     error: state.error,
     valid: state.valid,

package/dist/es2019/field.js

@@ -1,12 +1,13 @@
 /* field.tsx generated by @compiled/babel-plugin v0.36.1 */
 import "./field.compiled.css";
-import * as React from 'react';
 import { ax, ix } from "@compiled/react/runtime";
-import { useContext, useEffect, useMemo, useRef, useState } from 'react';
+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';
+import { ErrorMessage, HelperMessage, MessageWrapper, ValidMessage } from './messages';
 import RequiredAsterisk from './required-asterisk';
 const fieldWrapperStyles = null;
 function isEvent(event) {
@@ -53,6 +54,10 @@ function isShallowEqual(previousValue, currentValue) {
 }
 export default function Field(props) {
   var _getCurrentValue;
+  const {
+    children = () => null,
+    component
+  } = props;
   const {
     registerField,
     getCurrentValue
@@ -241,7 +246,9 @@ export default function Field(props) {
     testId: props.testId && `${props.testId}--label`
   }, props.label, props.isRequired && /*#__PURE__*/React.createElement(RequiredAsterisk, null), props.elementAfterLabel), /*#__PURE__*/React.createElement(FieldId.Provider, {
     value: fieldId
-  }, props.children({
+  }, component && fg('platform_design-system-team_field-upgrade') ? /*#__PURE__*/React.createElement(React.Fragment, null, component && component({
+    fieldProps: extendedFieldProps
+  }), /*#__PURE__*/React.createElement(MessageWrapper, null, props.helperMessage && /*#__PURE__*/React.createElement(HelperMessage, null, props.helperMessage), state.error && /*#__PURE__*/React.createElement(ErrorMessage, null, props.errorMessage || state.error), state.meta.touched && state.valid && props.validMessage && /*#__PURE__*/React.createElement(ValidMessage, null, props.validMessage))) : children({
     fieldProps: extendedFieldProps,
     error: state.error,
     valid: state.valid,

package/dist/esm/field.js

@@ -3,15 +3,16 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _typeof from "@babel/runtime/helpers/typeof";
 import "./field.compiled.css";
-import * as React from 'react';
 import { ax, ix } from "@compiled/react/runtime";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 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 { useContext, useEffect, useMemo, useRef, useState } from 'react';
+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';
+import { ErrorMessage, HelperMessage, MessageWrapper, ValidMessage } from './messages';
 import RequiredAsterisk from './required-asterisk';
 var fieldWrapperStyles = null;
 function isEvent(event) {
@@ -58,6 +59,11 @@ function isShallowEqual(previousValue, currentValue) {
 }
 export default function Field(props) {
   var _getCurrentValue;
+  var _props$children = props.children,
+    children = _props$children === void 0 ? function () {
+      return null;
+    } : _props$children,
+    component = props.component;
   var _useContext = useContext(FormContext),
     registerField = _useContext.registerField,
     getCurrentValue = _useContext.getCurrentValue;
@@ -248,7 +254,9 @@ export default function Field(props) {
     testId: props.testId && "".concat(props.testId, "--label")
   }, props.label, props.isRequired && /*#__PURE__*/React.createElement(RequiredAsterisk, null), props.elementAfterLabel), /*#__PURE__*/React.createElement(FieldId.Provider, {
     value: fieldId
-  }, props.children({
+  }, component && fg('platform_design-system-team_field-upgrade') ? /*#__PURE__*/React.createElement(React.Fragment, null, component && component({
+    fieldProps: extendedFieldProps
+  }), /*#__PURE__*/React.createElement(MessageWrapper, null, props.helperMessage && /*#__PURE__*/React.createElement(HelperMessage, null, props.helperMessage), state.error && /*#__PURE__*/React.createElement(ErrorMessage, null, props.errorMessage || state.error), state.meta.touched && state.valid && props.validMessage && /*#__PURE__*/React.createElement(ValidMessage, null, props.validMessage))) : children({
     fieldProps: extendedFieldProps,
     error: state.error,
     valid: state.valid,

package/dist/types/field.d.ts

@@ -29,16 +29,34 @@ export interface Meta {
     submitError?: boolean;
     validating?: boolean;
 }
-export interface FieldComponentProps<FieldValue, Element extends SupportedElements> {
+export type FieldComponentProps<FieldValue, Element extends SupportedElements> = {
     /**
-     * Content to render in the field. This is a function that is called with props for the field component and other information about the field.
+     * Content to render in the field. This is a function that is called with props for the field component and other information about the field. This cannot be used at the same time as the `component` prop.
      */
-    children: (args: {
+    children?: (args: {
         fieldProps: FieldProps<FieldValue, Element>;
         error?: string;
         valid: boolean;
         meta: Meta;
     }) => ReactNode;
+    /**
+     * Content to render in the field. This will be rendered with the `*Message` props. This cannot be used at the same time as the `children` prop.
+     */
+    component?: (args: {
+        fieldProps: FieldProps<FieldValue, Element>;
+    }) => ReactNode;
+    /**
+     * Renders a `HelperMessage` with the provided content when using the `component` prop.
+     */
+    helperMessage?: ReactNode;
+    /**
+     * Renders an `ErrorMessage` with the provided content when using the `component` prop.
+     */
+    errorMessage?: ReactNode;
+    /**
+     * Renders a `ValidMessage` with the provided content when using the `component` prop.
+     */
+    validMessage?: ReactNode;
     /**
      * Sets the default value of the field. If a function is provided, it is called with the current default value of the field.
      */
@@ -79,6 +97,6 @@ export interface FieldComponentProps<FieldValue, Element extends SupportedElemen
      * 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;
-}
+};
 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

@@ -29,16 +29,34 @@ export interface Meta {
     submitError?: boolean;
     validating?: boolean;
 }
-export interface FieldComponentProps<FieldValue, Element extends SupportedElements> {
+export type FieldComponentProps<FieldValue, Element extends SupportedElements> = {
     /**
-     * Content to render in the field. This is a function that is called with props for the field component and other information about the field.
+     * Content to render in the field. This is a function that is called with props for the field component and other information about the field. This cannot be used at the same time as the `component` prop.
      */
-    children: (args: {
+    children?: (args: {
         fieldProps: FieldProps<FieldValue, Element>;
         error?: string;
         valid: boolean;
         meta: Meta;
     }) => ReactNode;
+    /**
+     * Content to render in the field. This will be rendered with the `*Message` props. This cannot be used at the same time as the `children` prop.
+     */
+    component?: (args: {
+        fieldProps: FieldProps<FieldValue, Element>;
+    }) => ReactNode;
+    /**
+     * Renders a `HelperMessage` with the provided content when using the `component` prop.
+     */
+    helperMessage?: ReactNode;
+    /**
+     * Renders an `ErrorMessage` with the provided content when using the `component` prop.
+     */
+    errorMessage?: ReactNode;
+    /**
+     * Renders a `ValidMessage` with the provided content when using the `component` prop.
+     */
+    validMessage?: ReactNode;
     /**
      * Sets the default value of the field. If a function is provided, it is called with the current default value of the field.
      */
@@ -79,6 +97,6 @@ export interface FieldComponentProps<FieldValue, Element extends SupportedElemen
      * 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;
-}
+};
 export default function Field<FieldValue = string, Element extends SupportedElements = HTMLInputElement>(props: FieldComponentProps<FieldValue, Element>): JSX.Element;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/form",
-	"version": "12.6.2",
+	"version": "12.7.0",
 	"description": "A form allows users to input information.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -116,6 +116,9 @@
 		"platform_design-system-team_form-upgrade": {
 			"type": "boolean"
 		},
+		"platform_design-system-team_field-upgrade": {
+			"type": "boolean"
+		},
 		"platform_design-system-team_checkbox-field-spread": {
 			"type": "boolean"
 		},