@atlaskit/datetime-picker 12.3.12 → 12.3.13

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/datetime-picker
 
+## 12.3.13
+
+### Patch Changes
+
+- [`c71b0ac8222`](https://bitbucket.org/atlassian/atlassian-frontend/commits/c71b0ac8222) - [ux] Add default label to time picker element of datetime picker. Update documentation for more accessible examples and guidelines.
+
 ## 12.3.12
 
 ### Patch Changes

package/dist/cjs/components/date-picker.js

@@ -36,7 +36,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } } /* eslint-disable @repo/internal/react/use-noop */ /** @jsx jsx */ // eslint-disable-next-line no-restricted-imports
 var packageName = "@atlaskit/datetime-picker";
-var packageVersion = "12.3.12";
+var packageVersion = "12.3.13";
 
 /* eslint-disable react/no-unused-prop-types */
 

package/dist/cjs/components/date-time-picker.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = exports.DateTimePickerWithoutAnalytics = void 0;
+exports.timePickerDefaultAriaLabel = exports.default = exports.datePickerDefaultAriaLabel = exports.DateTimePickerWithoutAnalytics = void 0;
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
@@ -31,7 +31,7 @@ function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Re
 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; }
 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; } /* eslint-disable @repo/internal/react/use-noop */ /** @jsx jsx */ // eslint-disable-next-line no-restricted-imports
 var packageName = "@atlaskit/datetime-picker";
-var packageVersion = "12.3.12";
+var packageVersion = "12.3.13";
 
 /* eslint-disable react/no-unused-prop-types */
 
@@ -155,6 +155,11 @@ var dateTimePickerDefaultProps = {
   // Not including a default prop for value as it will
   // Make the component a controlled component
 };
+
+var datePickerDefaultAriaLabel = 'Date';
+exports.datePickerDefaultAriaLabel = datePickerDefaultAriaLabel;
+var timePickerDefaultAriaLabel = 'Time';
+exports.timePickerDefaultAriaLabel = timePickerDefaultAriaLabel;
 var DateTimePicker = /*#__PURE__*/function (_React$Component) {
   (0, _inherits2.default)(DateTimePicker, _React$Component);
   var _super = _createSuper(DateTimePicker);
@@ -271,7 +276,8 @@ var DateTimePicker = /*#__PURE__*/function (_React$Component) {
         times = _this$props.times,
         timeFormat = _this$props.timeFormat,
         locale = _this$props.locale,
-        testId = _this$props.testId;
+        testId = _this$props.testId,
+        ariaLabelledBy = _this$props['aria-labelledby'];
       var _this$getSafeState = this.getSafeState(),
         isFocused = _this$getSafeState.isFocused,
         value = _this$getSafeState.value,
@@ -290,9 +296,11 @@ var DateTimePicker = /*#__PURE__*/function (_React$Component) {
       var _timePickerSelectProp = timePickerSelectProps.styles,
         timePickerStyles = _timePickerSelectProp === void 0 ? {} : _timePickerSelectProp;
       var mergedDatePickerSelectProps = _objectSpread(_objectSpread({}, datePickerSelectProps), {}, {
+        'aria-label': datePickerSelectProps['aria-label'] || datePickerDefaultAriaLabel,
         styles: (0, _select.mergeStyles)(styles, datePickerStyles)
       });
       var mergedTimePickerSelectProps = _objectSpread(_objectSpread({}, timePickerSelectProps), {}, {
+        'aria-label': timePickerSelectProps['aria-label'] || timePickerDefaultAriaLabel,
         styles: (0, _select.mergeStyles)(styles, timePickerStyles)
       });
 
@@ -303,6 +311,8 @@ var DateTimePicker = /*#__PURE__*/function (_React$Component) {
       return (0, _react2.jsx)("div", (0, _extends2.default)({
         css: [baseContainerStyles, isDisabled && isDisabledStyles, isFocused && isFocusedStyles, bothProps.appearance === 'subtle' && (isFocused ? subtleFocusedBgStyles : subtleBgStyles), isFocused && isFocusedBorderStyles, bothProps.isInvalid && isInvalidBorderStyles, notFocusedOrIsDisabled && (bothProps.isInvalid ? isInvalidHoverStyles : hoverStyles), bothProps.appearance === 'none' && noBgStyles]
       }, innerProps, {
+        role: "group",
+        "aria-labelledby": ariaLabelledBy,
         "data-testid": testId
       }), (0, _react2.jsx)("input", {
         name: name,

package/dist/cjs/components/time-picker.js

@@ -38,7 +38,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 var packageName = "@atlaskit/datetime-picker";
-var packageVersion = "12.3.12";
+var packageVersion = "12.3.13";
 
 /* eslint-disable react/no-unused-prop-types */
 

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/datetime-picker",
-	"version": "12.3.12",
+	"version": "12.3.13",
 	"sideEffects": false
 }

package/dist/es2019/components/date-picker.js

@@ -18,7 +18,7 @@ import { defaultDateFormat, EmptyComponent, padToTwo, placeholderDatetime } from
 import FixedLayer from '../internal/fixed-layer';
 import { convertTokens } from './utils';
 const packageName = "@atlaskit/datetime-picker";
-const packageVersion = "12.3.12";
+const packageVersion = "12.3.13";
 
 /* eslint-disable react/no-unused-prop-types */
 

package/dist/es2019/components/date-time-picker.js

@@ -17,7 +17,7 @@ import DatePicker from './date-picker';
 import TimePicker from './time-picker';
 import { convertTokens } from './utils';
 const packageName = "@atlaskit/datetime-picker";
-const packageVersion = "12.3.12";
+const packageVersion = "12.3.13";
 
 /* eslint-disable react/no-unused-prop-types */
 
@@ -141,6 +141,8 @@ const dateTimePickerDefaultProps = {
   // Make the component a controlled component
 };
 
+export const datePickerDefaultAriaLabel = 'Date';
+export const timePickerDefaultAriaLabel = 'Time';
 class DateTimePicker extends React.Component {
   constructor(...args) {
     super(...args);
@@ -254,7 +256,8 @@ class DateTimePicker extends React.Component {
       times,
       timeFormat,
       locale,
-      testId
+      testId,
+      'aria-labelledby': ariaLabelledBy
     } = this.props;
     const {
       isFocused,
@@ -278,10 +281,12 @@ class DateTimePicker extends React.Component {
     } = timePickerSelectProps;
     const mergedDatePickerSelectProps = {
       ...datePickerSelectProps,
+      'aria-label': datePickerSelectProps['aria-label'] || datePickerDefaultAriaLabel,
       styles: mergeStyles(styles, datePickerStyles)
     };
     const mergedTimePickerSelectProps = {
       ...timePickerSelectProps,
+      'aria-label': timePickerSelectProps['aria-label'] || timePickerDefaultAriaLabel,
       styles: mergeStyles(styles, timePickerStyles)
     };
 
@@ -292,6 +297,8 @@ class DateTimePicker extends React.Component {
     return jsx("div", _extends({
       css: [baseContainerStyles, isDisabled && isDisabledStyles, isFocused && isFocusedStyles, bothProps.appearance === 'subtle' && (isFocused ? subtleFocusedBgStyles : subtleBgStyles), isFocused && isFocusedBorderStyles, bothProps.isInvalid && isInvalidBorderStyles, notFocusedOrIsDisabled && (bothProps.isInvalid ? isInvalidHoverStyles : hoverStyles), bothProps.appearance === 'none' && noBgStyles]
     }, innerProps, {
+      role: "group",
+      "aria-labelledby": ariaLabelledBy,
       "data-testid": testId
     }), jsx("input", {
       name: name,

package/dist/es2019/components/time-picker.js

@@ -16,7 +16,7 @@ import FixedLayer from '../internal/fixed-layer';
 import parseTime from '../internal/parse-time';
 import { convertTokens } from './utils';
 const packageName = "@atlaskit/datetime-picker";
-const packageVersion = "12.3.12";
+const packageVersion = "12.3.13";
 
 /* eslint-disable react/no-unused-prop-types */
 

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/datetime-picker",
-	"version": "12.3.12",
+	"version": "12.3.13",
 	"sideEffects": false
 }

package/dist/esm/components/date-picker.js

@@ -29,7 +29,7 @@ import { defaultDateFormat, EmptyComponent, padToTwo, placeholderDatetime } from
 import FixedLayer from '../internal/fixed-layer';
 import { convertTokens } from './utils';
 var packageName = "@atlaskit/datetime-picker";
-var packageVersion = "12.3.12";
+var packageVersion = "12.3.13";
 
 /* eslint-disable react/no-unused-prop-types */
 

package/dist/esm/components/date-time-picker.js

@@ -27,7 +27,7 @@ import DatePicker from './date-picker';
 import TimePicker from './time-picker';
 import { convertTokens } from './utils';
 var packageName = "@atlaskit/datetime-picker";
-var packageVersion = "12.3.12";
+var packageVersion = "12.3.13";
 
 /* eslint-disable react/no-unused-prop-types */
 
@@ -151,6 +151,9 @@ var dateTimePickerDefaultProps = {
   // Not including a default prop for value as it will
   // Make the component a controlled component
 };
+
+export var datePickerDefaultAriaLabel = 'Date';
+export var timePickerDefaultAriaLabel = 'Time';
 var DateTimePicker = /*#__PURE__*/function (_React$Component) {
   _inherits(DateTimePicker, _React$Component);
   var _super = _createSuper(DateTimePicker);
@@ -267,7 +270,8 @@ var DateTimePicker = /*#__PURE__*/function (_React$Component) {
         times = _this$props.times,
         timeFormat = _this$props.timeFormat,
         locale = _this$props.locale,
-        testId = _this$props.testId;
+        testId = _this$props.testId,
+        ariaLabelledBy = _this$props['aria-labelledby'];
       var _this$getSafeState = this.getSafeState(),
         isFocused = _this$getSafeState.isFocused,
         value = _this$getSafeState.value,
@@ -286,9 +290,11 @@ var DateTimePicker = /*#__PURE__*/function (_React$Component) {
       var _timePickerSelectProp = timePickerSelectProps.styles,
         timePickerStyles = _timePickerSelectProp === void 0 ? {} : _timePickerSelectProp;
       var mergedDatePickerSelectProps = _objectSpread(_objectSpread({}, datePickerSelectProps), {}, {
+        'aria-label': datePickerSelectProps['aria-label'] || datePickerDefaultAriaLabel,
         styles: mergeStyles(styles, datePickerStyles)
       });
       var mergedTimePickerSelectProps = _objectSpread(_objectSpread({}, timePickerSelectProps), {}, {
+        'aria-label': timePickerSelectProps['aria-label'] || timePickerDefaultAriaLabel,
         styles: mergeStyles(styles, timePickerStyles)
       });
 
@@ -299,6 +305,8 @@ var DateTimePicker = /*#__PURE__*/function (_React$Component) {
       return jsx("div", _extends({
         css: [baseContainerStyles, isDisabled && isDisabledStyles, isFocused && isFocusedStyles, bothProps.appearance === 'subtle' && (isFocused ? subtleFocusedBgStyles : subtleBgStyles), isFocused && isFocusedBorderStyles, bothProps.isInvalid && isInvalidBorderStyles, notFocusedOrIsDisabled && (bothProps.isInvalid ? isInvalidHoverStyles : hoverStyles), bothProps.appearance === 'none' && noBgStyles]
       }, innerProps, {
+        role: "group",
+        "aria-labelledby": ariaLabelledBy,
         "data-testid": testId
       }), jsx("input", {
         name: name,

package/dist/esm/components/time-picker.js

@@ -29,7 +29,7 @@ import FixedLayer from '../internal/fixed-layer';
 import parseTime from '../internal/parse-time';
 import { convertTokens } from './utils';
 var packageName = "@atlaskit/datetime-picker";
-var packageVersion = "12.3.12";
+var packageVersion = "12.3.13";
 
 /* eslint-disable react/no-unused-prop-types */
 

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/datetime-picker",
-	"version": "12.3.12",
+	"version": "12.3.13",
 	"sideEffects": false
 }

package/dist/types/components/date-time-picker.d.ts

@@ -26,6 +26,11 @@ export interface DateTimePickerBaseProps extends WithAnalyticsEventsProps {
      * Keep this in mind when needing to refer to the ID. This will be fixed in an upcoming release.
      */
     id?: string;
+    /**
+     * The ID of the element that labels the datetime picker field. This will
+     * label the element that groups both the datepicker and the timepicker.
+     */
+    'aria-labelledby'?: string;
     /**
      * Props to apply to the container. *
      */
@@ -145,6 +150,8 @@ declare const dateTimePickerDefaultProps: {
     spacing: string;
     locale: string;
 };
+export declare const datePickerDefaultAriaLabel = "Date";
+export declare const timePickerDefaultAriaLabel = "Time";
 declare class DateTimePicker extends React.Component<DateTimePickerProps, State> {
     static defaultProps: {
         appearance: string;
@@ -194,7 +201,7 @@ declare class DateTimePicker extends React.Component<DateTimePickerProps, State>
     render(): jsx.JSX.Element;
 }
 export { DateTimePicker as DateTimePickerWithoutAnalytics };
-declare const _default: React.ForwardRefExoticComponent<Pick<Pick<Omit<DateTimePickerProps, keyof WithAnalyticsEventsProps>, "testId" | "value" | "dateFormat" | "timeFormat" | "parseValue"> & Partial<Pick<Omit<DateTimePickerProps, keyof WithAnalyticsEventsProps>, "times" | "appearance" | "autoFocus" | "defaultValue" | "id" | "innerProps" | "isDisabled" | "name" | "onBlur" | "onChange" | "onFocus" | "spacing" | "isInvalid" | "locale" | "timeIsEditable" | "datePickerProps" | "timePickerProps" | "datePickerSelectProps" | "timePickerSelectProps">> & Partial<Pick<{
+declare const _default: React.ForwardRefExoticComponent<Pick<Pick<Omit<DateTimePickerProps, keyof WithAnalyticsEventsProps>, "testId" | "value" | "dateFormat" | "aria-labelledby" | "timeFormat" | "parseValue"> & Partial<Pick<Omit<DateTimePickerProps, keyof WithAnalyticsEventsProps>, "times" | "appearance" | "autoFocus" | "defaultValue" | "id" | "innerProps" | "isDisabled" | "name" | "onBlur" | "onChange" | "onFocus" | "spacing" | "isInvalid" | "locale" | "timeIsEditable" | "datePickerProps" | "timePickerProps" | "datePickerSelectProps" | "timePickerSelectProps">> & Partial<Pick<{
     appearance: string;
     autoFocus: boolean;
     isDisabled: boolean;
@@ -214,5 +221,5 @@ declare const _default: React.ForwardRefExoticComponent<Pick<Pick<Omit<DateTimeP
     times: string[];
     spacing: string;
     locale: string;
-}, never>> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "times" | "testId" | "appearance" | "autoFocus" | "defaultValue" | "id" | "innerProps" | "isDisabled" | "name" | "onBlur" | "onChange" | "onFocus" | "spacing" | "value" | "isInvalid" | "dateFormat" | "locale" | "key" | "analyticsContext" | "timeIsEditable" | "timeFormat" | "datePickerProps" | "timePickerProps" | "parseValue" | "datePickerSelectProps" | "timePickerSelectProps"> & React.RefAttributes<any>>;
+}, never>> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "times" | "testId" | "appearance" | "autoFocus" | "defaultValue" | "id" | "innerProps" | "isDisabled" | "name" | "onBlur" | "onChange" | "onFocus" | "spacing" | "value" | "isInvalid" | "dateFormat" | "locale" | "key" | "analyticsContext" | "aria-labelledby" | "timeIsEditable" | "timeFormat" | "datePickerProps" | "timePickerProps" | "parseValue" | "datePickerSelectProps" | "timePickerSelectProps"> & React.RefAttributes<any>>;
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/datetime-picker",
-  "version": "12.3.12",
+  "version": "12.3.13",
   "description": "A date time picker allows the user to select an associated date and time.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -45,8 +45,8 @@
   "devDependencies": {
     "@atlaskit/button": "^16.6.0",
     "@atlaskit/docs": "*",
-    "@atlaskit/field-base": "^15.0.5",
-    "@atlaskit/form": "^8.9.0",
+    "@atlaskit/field-base": "^15.1.0",
+    "@atlaskit/form": "^8.10.0",
     "@atlaskit/modal-dialog": "^12.4.0",
     "@atlaskit/popup": "^1.5.0",
     "@atlaskit/range": "^7.0.0",
@@ -63,6 +63,7 @@
     "@types/testing-library__jest-dom": "^5.14.5",
     "moment": "^2.29.2",
     "react-dom": "^16.8.0",
+    "react-intl-next": "npm:react-intl@^5.18.1",
     "react-lorem-component": "^0.13.0",
     "react-test-renderer": "^16.8.0",
     "typescript": "4.5.5"