@atlaskit/form 8.8.7 → 8.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # @atlaskit/form
2
2
 
3
+ ## 8.9.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [`824851f3580`](https://bitbucket.org/atlassian/atlassian-frontend/commits/824851f3580) - [ux] Gives added affordance to sighted users to get information on meaning of asterisk symbol on required fields.
8
+
9
+ ### Patch Changes
10
+
11
+ - [`2e01c9c74b5`](https://bitbucket.org/atlassian/atlassian-frontend/commits/2e01c9c74b5) - DUMMY remove before merging to master; dupe adf-schema via adf-utils
12
+
13
+ ## 8.8.8
14
+
15
+ ### Patch Changes
16
+
17
+ - [`e0460d5d989`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e0460d5d989) - Usages of `process` are now guarded by a `typeof` check.
18
+
3
19
  ## 8.8.7
4
20
 
5
21
  ### Patch Changes
package/dist/cjs/field.js CHANGED
@@ -13,22 +13,16 @@ var _react = require("react");
13
13
  var _react2 = require("@emotion/react");
14
14
  var _reactUid = require("react-uid");
15
15
  var _tinyInvariant = _interopRequireDefault(require("tiny-invariant"));
16
- var _colors = require("@atlaskit/theme/colors");
17
16
  var _constants = require("@atlaskit/theme/constants");
18
17
  var _form = require("./form");
19
18
  var _label = _interopRequireDefault(require("./label"));
19
+ var _requiredAsterisk = _interopRequireDefault(require("./required-asterisk"));
20
20
  function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
21
- function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
21
+ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; } /** @jsx jsx */
22
22
  var gridSize = (0, _constants.gridSize)();
23
- var fontFamily = (0, _constants.fontFamily)();
24
23
  var fieldWrapperStyles = (0, _react2.css)({
25
24
  marginTop: gridSize
26
25
  });
27
- var requiredIndicatorStyles = (0, _react2.css)({
28
- paddingLeft: "".concat(gridSize / 4, "px"),
29
- color: "var(--ds-text-danger, ".concat(_colors.R400, ")"),
30
- fontFamily: fontFamily
31
- });
32
26
  function isEvent(event) {
33
27
  return Boolean(event && event.target);
34
28
  }
@@ -122,7 +116,7 @@ function Field(props) {
122
116
  setState = _useState2[1];
123
117
  var latestStateRef = usePreviousRef(state);
124
118
  (0, _react.useEffect)(function () {
125
- if (process.env.NODE_ENV !== 'production' && !process.env.CI) {
119
+ if (typeof process !== 'undefined' && process.env.NODE_ENV !== 'production' && !process.env.CI) {
126
120
  (0, _tinyInvariant.default)(latestPropsRef.current.name, '@atlaskit/form: Field components have a required name prop');
127
121
  }
128
122
  function fieldStateToMeta() {
@@ -265,10 +259,7 @@ function Field(props) {
265
259
  }, props.label && (0, _react2.jsx)(_label.default, {
266
260
  htmlFor: fieldId,
267
261
  id: "".concat(fieldId, "-label")
268
- }, props.label, props.isRequired && (0, _react2.jsx)("span", {
269
- css: requiredIndicatorStyles,
270
- "aria-hidden": "true"
271
- }, "*"), props.elementAfterLabel), (0, _react2.jsx)(FieldId.Provider, {
262
+ }, props.label, props.isRequired && (0, _react2.jsx)(_requiredAsterisk.default, null), props.elementAfterLabel), (0, _react2.jsx)(FieldId.Provider, {
272
263
  value: fieldId
273
264
  }, props.children({
274
265
  fieldProps: extendedFieldProps,
package/dist/cjs/index.js CHANGED
@@ -64,6 +64,12 @@ Object.defineProperty(exports, "RangeField", {
64
64
  return _rangeField.default;
65
65
  }
66
66
  });
67
+ Object.defineProperty(exports, "RequiredAsterisk", {
68
+ enumerable: true,
69
+ get: function get() {
70
+ return _requiredAsterisk.default;
71
+ }
72
+ });
67
73
  Object.defineProperty(exports, "ValidMessage", {
68
74
  enumerable: true,
69
75
  get: function get() {
@@ -85,4 +91,5 @@ var _checkboxField = _interopRequireDefault(require("./checkbox-field"));
85
91
  var _rangeField = _interopRequireDefault(require("./range-field"));
86
92
  var _label = _interopRequireDefault(require("./label"));
87
93
  var _messages = require("./messages");
88
- var _fieldset = _interopRequireDefault(require("./fieldset"));
94
+ var _fieldset = _interopRequireDefault(require("./fieldset"));
95
+ var _requiredAsterisk = _interopRequireDefault(require("./required-asterisk"));
@@ -16,6 +16,14 @@ var _typography = require("@atlaskit/theme/typography");
16
16
  var _field = require("./field");
17
17
  /** @jsx jsx */
18
18
 
19
+ /**
20
+ * API for the internal `<Message />` component. This is not public API.
21
+ */
22
+
23
+ /**
24
+ * Public API of the various message components.
25
+ */
26
+
19
27
  var gridSize = (0, _constants.gridSize)();
20
28
  var fontFamily = (0, _constants.fontFamily)();
21
29
 
@@ -0,0 +1,25 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = RequiredAsterisk;
7
+ var _react = require("@emotion/react");
8
+ var _colors = require("@atlaskit/theme/colors");
9
+ var _constants = require("@atlaskit/theme/constants");
10
+ /** @jsx jsx */
11
+
12
+ var gridSize = (0, _constants.gridSize)();
13
+ var fontFamily = (0, _constants.fontFamily)();
14
+ var requiredIndicatorStyles = (0, _react.css)({
15
+ paddingLeft: "".concat(gridSize / 4, "px"),
16
+ color: "var(--ds-text-danger, ".concat(_colors.R400, ")"),
17
+ fontFamily: fontFamily
18
+ });
19
+ function RequiredAsterisk() {
20
+ return (0, _react.jsx)("span", {
21
+ css: requiredIndicatorStyles,
22
+ "aria-hidden": "true",
23
+ title: "required"
24
+ }, "*");
25
+ }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/form",
3
- "version": "8.8.7",
3
+ "version": "8.9.0",
4
4
  "sideEffects": false
5
5
  }
@@ -3,20 +3,14 @@ import { createContext, useContext, useEffect, useMemo, useRef, useState } from
3
3
  import { css, jsx } from '@emotion/react';
4
4
  import { uid } from 'react-uid';
5
5
  import invariant from 'tiny-invariant';
6
- import { R400 } from '@atlaskit/theme/colors';
7
- import { fontFamily as getFontFamily, gridSize as getGridSize } from '@atlaskit/theme/constants';
6
+ import { gridSize as getGridSize } from '@atlaskit/theme/constants';
8
7
  import { FormContext, IsDisabledContext } from './form';
9
8
  import Label from './label';
9
+ import RequiredAsterisk from './required-asterisk';
10
10
  const gridSize = getGridSize();
11
- const fontFamily = getFontFamily();
12
11
  const fieldWrapperStyles = css({
13
12
  marginTop: gridSize
14
13
  });
15
- const requiredIndicatorStyles = css({
16
- paddingLeft: `${gridSize / 4}px`,
17
- color: `var(--ds-text-danger, ${R400})`,
18
- fontFamily
19
- });
20
14
  function isEvent(event) {
21
15
  return Boolean(event && event.target);
22
16
  }
@@ -107,7 +101,7 @@ export default function Field(props) {
107
101
  });
108
102
  const latestStateRef = usePreviousRef(state);
109
103
  useEffect(() => {
110
- if (process.env.NODE_ENV !== 'production' && !process.env.CI) {
104
+ if (typeof process !== 'undefined' && process.env.NODE_ENV !== 'production' && !process.env.CI) {
111
105
  invariant(latestPropsRef.current.name, '@atlaskit/form: Field components have a required name prop');
112
106
  }
113
107
  function fieldStateToMeta(value = {}) {
@@ -248,10 +242,7 @@ export default function Field(props) {
248
242
  }, props.label && jsx(Label, {
249
243
  htmlFor: fieldId,
250
244
  id: `${fieldId}-label`
251
- }, props.label, props.isRequired && jsx("span", {
252
- css: requiredIndicatorStyles,
253
- "aria-hidden": "true"
254
- }, "*"), props.elementAfterLabel), jsx(FieldId.Provider, {
245
+ }, props.label, props.isRequired && jsx(RequiredAsterisk, null), props.elementAfterLabel), jsx(FieldId.Provider, {
255
246
  value: fieldId
256
247
  }, props.children({
257
248
  fieldProps: extendedFieldProps,
@@ -8,4 +8,5 @@ export { default as RangeField } from './range-field';
8
8
  export { default as Label } from './label';
9
9
  export { HelperMessage, ErrorMessage, ValidMessage } from './messages';
10
10
  export { default as Fieldset } from './fieldset';
11
+ export { default as RequiredAsterisk } from './required-asterisk';
11
12
  // eslint-disable-next-line import/no-unresolved
@@ -9,6 +9,15 @@ import { useGlobalTheme } from '@atlaskit/theme/components';
9
9
  import { fontFamily as getFontFamily, gridSize as getGridSize } from '@atlaskit/theme/constants';
10
10
  import { h200 } from '@atlaskit/theme/typography';
11
11
  import { FieldId } from './field';
12
+
13
+ /**
14
+ * API for the internal `<Message />` component. This is not public API.
15
+ */
16
+
17
+ /**
18
+ * Public API of the various message components.
19
+ */
20
+
12
21
  const gridSize = getGridSize();
13
22
  const fontFamily = getFontFamily();
14
23
 
@@ -0,0 +1,18 @@
1
+ /** @jsx jsx */
2
+ import { css, jsx } from '@emotion/react';
3
+ import { R400 } from '@atlaskit/theme/colors';
4
+ import { fontFamily as getFontFamily, gridSize as getGridSize } from '@atlaskit/theme/constants';
5
+ const gridSize = getGridSize();
6
+ const fontFamily = getFontFamily();
7
+ const requiredIndicatorStyles = css({
8
+ paddingLeft: `${gridSize / 4}px`,
9
+ color: `var(--ds-text-danger, ${R400})`,
10
+ fontFamily
11
+ });
12
+ export default function RequiredAsterisk() {
13
+ return jsx("span", {
14
+ css: requiredIndicatorStyles,
15
+ "aria-hidden": "true",
16
+ title: "required"
17
+ }, "*");
18
+ }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/form",
3
- "version": "8.8.7",
3
+ "version": "8.9.0",
4
4
  "sideEffects": false
5
5
  }
package/dist/esm/field.js CHANGED
@@ -8,20 +8,14 @@ import { createContext, useContext, useEffect, useMemo, useRef, useState } from
8
8
  import { css, jsx } from '@emotion/react';
9
9
  import { uid } from 'react-uid';
10
10
  import invariant from 'tiny-invariant';
11
- import { R400 } from '@atlaskit/theme/colors';
12
- import { fontFamily as getFontFamily, gridSize as getGridSize } from '@atlaskit/theme/constants';
11
+ import { gridSize as getGridSize } from '@atlaskit/theme/constants';
13
12
  import { FormContext, IsDisabledContext } from './form';
14
13
  import Label from './label';
14
+ import RequiredAsterisk from './required-asterisk';
15
15
  var gridSize = getGridSize();
16
- var fontFamily = getFontFamily();
17
16
  var fieldWrapperStyles = css({
18
17
  marginTop: gridSize
19
18
  });
20
- var requiredIndicatorStyles = css({
21
- paddingLeft: "".concat(gridSize / 4, "px"),
22
- color: "var(--ds-text-danger, ".concat(R400, ")"),
23
- fontFamily: fontFamily
24
- });
25
19
  function isEvent(event) {
26
20
  return Boolean(event && event.target);
27
21
  }
@@ -114,7 +108,7 @@ export default function Field(props) {
114
108
  setState = _useState2[1];
115
109
  var latestStateRef = usePreviousRef(state);
116
110
  useEffect(function () {
117
- if (process.env.NODE_ENV !== 'production' && !process.env.CI) {
111
+ if (typeof process !== 'undefined' && process.env.NODE_ENV !== 'production' && !process.env.CI) {
118
112
  invariant(latestPropsRef.current.name, '@atlaskit/form: Field components have a required name prop');
119
113
  }
120
114
  function fieldStateToMeta() {
@@ -257,10 +251,7 @@ export default function Field(props) {
257
251
  }, props.label && jsx(Label, {
258
252
  htmlFor: fieldId,
259
253
  id: "".concat(fieldId, "-label")
260
- }, props.label, props.isRequired && jsx("span", {
261
- css: requiredIndicatorStyles,
262
- "aria-hidden": "true"
263
- }, "*"), props.elementAfterLabel), jsx(FieldId.Provider, {
254
+ }, props.label, props.isRequired && jsx(RequiredAsterisk, null), props.elementAfterLabel), jsx(FieldId.Provider, {
264
255
  value: fieldId
265
256
  }, props.children({
266
257
  fieldProps: extendedFieldProps,
package/dist/esm/index.js CHANGED
@@ -8,4 +8,5 @@ export { default as RangeField } from './range-field';
8
8
  export { default as Label } from './label';
9
9
  export { HelperMessage, ErrorMessage, ValidMessage } from './messages';
10
10
  export { default as Fieldset } from './fieldset';
11
+ export { default as RequiredAsterisk } from './required-asterisk';
11
12
  // eslint-disable-next-line import/no-unresolved
@@ -9,6 +9,15 @@ import { useGlobalTheme } from '@atlaskit/theme/components';
9
9
  import { fontFamily as getFontFamily, gridSize as getGridSize } from '@atlaskit/theme/constants';
10
10
  import { h200 } from '@atlaskit/theme/typography';
11
11
  import { FieldId } from './field';
12
+
13
+ /**
14
+ * API for the internal `<Message />` component. This is not public API.
15
+ */
16
+
17
+ /**
18
+ * Public API of the various message components.
19
+ */
20
+
12
21
  var gridSize = getGridSize();
13
22
  var fontFamily = getFontFamily();
14
23
 
@@ -0,0 +1,18 @@
1
+ /** @jsx jsx */
2
+ import { css, jsx } from '@emotion/react';
3
+ import { R400 } from '@atlaskit/theme/colors';
4
+ import { fontFamily as getFontFamily, gridSize as getGridSize } from '@atlaskit/theme/constants';
5
+ var gridSize = getGridSize();
6
+ var fontFamily = getFontFamily();
7
+ var requiredIndicatorStyles = css({
8
+ paddingLeft: "".concat(gridSize / 4, "px"),
9
+ color: "var(--ds-text-danger, ".concat(R400, ")"),
10
+ fontFamily: fontFamily
11
+ });
12
+ export default function RequiredAsterisk() {
13
+ return jsx("span", {
14
+ css: requiredIndicatorStyles,
15
+ "aria-hidden": "true",
16
+ title: "required"
17
+ }, "*");
18
+ }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/form",
3
- "version": "8.8.7",
3
+ "version": "8.9.0",
4
4
  "sideEffects": false
5
5
  }
@@ -13,4 +13,5 @@ export { default as Label } from './label';
13
13
  export type { LabelProps } from './label';
14
14
  export { HelperMessage, ErrorMessage, ValidMessage } from './messages';
15
15
  export { default as Fieldset } from './fieldset';
16
+ export { default as RequiredAsterisk } from './required-asterisk';
16
17
  export type { OnSubmitHandler, FormApi } from './types';
@@ -0,0 +1,3 @@
1
+ /** @jsx jsx */
2
+ import { jsx } from '@emotion/react';
3
+ export default function RequiredAsterisk(): jsx.JSX.Element;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/form",
3
- "version": "8.8.7",
3
+ "version": "8.9.0",
4
4
  "description": "A form allows users to input information.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -39,7 +39,7 @@
39
39
  "homepage": "https://atlassian.design/components/form/",
40
40
  "dependencies": {
41
41
  "@atlaskit/icon": "^21.11.0",
42
- "@atlaskit/theme": "^12.3.0",
42
+ "@atlaskit/theme": "^12.4.0",
43
43
  "@atlaskit/tokens": "^1.2.0",
44
44
  "@babel/runtime": "^7.0.0",
45
45
  "@emotion/react": "^11.7.1",
package/report.api.md CHANGED
@@ -278,6 +278,9 @@ export interface RangeFieldProps {
278
278
  // @public (undocumented)
279
279
  type RangeProps = Omit<FieldProps<number>, 'isInvalid' | 'isRequired'>;
280
280
 
281
+ // @public (undocumented)
282
+ export function RequiredAsterisk(): jsx.JSX.Element;
283
+
281
284
  // @public (undocumented)
282
285
  type SupportedElements =
283
286
  | HTMLInputElement