@atlaskit/datetime-picker 13.11.2 → 14.0.0

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

@@ -4,12 +4,48 @@ import { type DropdownIndicatorProps, type OptionType, type SelectProps } from '
 export type Appearance = 'default' | 'subtle' | 'none';
 export type Spacing = 'compact' | 'default';
 type Combine<First, Second> = Omit<First, keyof Second> & Second;
+/**
+ * Props to apply to the select. These include all of [the props from our
+ * `Select` component](/components/select). For the following properties, use
+ * the top-level prop alternatives:
+ *
+ * - `aria-describedby`, use `aria-describedby` prop
+ * - `aria-label`, use `label` prop
+ * - `inputId`, use `id` prop
+ * - `placeholder`, use `placeholder` prop
+ *
+ * Example:
+ *
+ * ```tsx
+ * // Don't do this
+ * <DatePicker selectProps={{
+ *   'aria-describedby': 'helper-id'
+ * }} />
+ *
+ * // Do this
+ * <DatePicker aria-describedby="helper-id" />
+ * ```
+ */
+export type DateTimePickerSelectProps = Combine<SelectProps<OptionType>, {
+    /**
+     * Use the `aria-describedby` prop on the picker..
+     */
+    'aria-describedby'?: never;
+    /**
+     * Use the `label` prop on the picker..
+     */
+    'aria-label'?: never;
+    /**
+     * Use the `id` prop on the picker.`.
+     */
+    inputId?: never;
+    /**
+     * Use the `placeholder` prop on the picker.
+     */
+    placeholder?: never;
+}>;
 interface PickerSelectProps {
-    /**
-     * Props to apply to the select. These include all of [the props from our
-     * `Select` component](/components/select).
-     */
-    selectProps?: Combine<SelectProps<OptionType>, {}>;
+    selectProps?: DateTimePickerSelectProps;
 }
 export interface DatePickerBaseProps extends WithAnalyticsEventsProps, PickerSelectProps {
     /**
@@ -298,8 +334,8 @@ export interface DateTimePickerBaseProps extends WithAnalyticsEventsProps {
     /**
      * Used to associate accessible descriptions to both the date and time
      * picker. If you want to associate individual accessible descriptions, this
-     * should be done through the `datePickerSelectProps` and
-     * `timePickerSelectProps`.
+     * should be done through the `aria-describedby` props on the
+     * `datePickerProps` and `timePickerProps`.
      */
     'aria-describedby'?: string;
     /**
@@ -345,18 +381,10 @@ export interface DateTimePickerBaseProps extends WithAnalyticsEventsProps {
      * The ISO time that should be used as the input value.
      */
     value?: string;
-    /**
-     * Set if users can edit the input, allowing them to add custom times.
-     */
-    timeIsEditable?: boolean;
     /**
      * Set if the picker has an invalid value.
      */
     isInvalid?: boolean;
-    /**
-     * Format the date with a string that is accepted by [date-fns's format function](https://date-fns.org/v1.29.0/docs/format).
-     */
-    dateFormat?: string;
     /**
      * Props applied to the `DatePicker`.
      */
@@ -373,22 +401,6 @@ export interface DateTimePickerBaseProps extends WithAnalyticsEventsProps {
         timeValue: string;
         zoneValue: string;
     };
-    /**
-     * [Select props](/components/select) to pass onto the `DatePicker` component's `Select`. This can be used to set options such as placeholder text.
-     */
-    datePickerSelectProps?: SelectProps<any>;
-    /**
-     * [Select props](/components/select) to pass onto the `TimePicker` component's `Select`. This can be used to set options such as placeholder text.
-     */
-    timePickerSelectProps?: SelectProps<any>;
-    /**
-     * The times shown by the `TimePicker`.
-     */
-    times?: Array<string>;
-    /**
-     * The format that times are displayed in. Values should be those accepted by [date-fns's format function](https://date-fns.org/v1.29.0/docs/format).
-     */
-    timeFormat?: string;
     /**
      * The spacing for the select control.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/datetime-picker",
-	"version": "13.11.2",
+	"version": "14.0.0",
 	"description": "A date time picker allows the user to select an associated date and time.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -42,17 +42,16 @@
 		"@atlaskit/analytics-next": "^10.1.0",
 		"@atlaskit/calendar": "^14.5.0",
 		"@atlaskit/ds-lib": "^2.5.0",
-		"@atlaskit/icon": "^22.13.0",
+		"@atlaskit/icon": "^22.14.0",
 		"@atlaskit/layering": "^0.4.0",
 		"@atlaskit/locale": "^2.8.0",
 		"@atlaskit/popper": "^6.2.0",
 		"@atlaskit/select": "^17.15.0",
 		"@atlaskit/theme": "^13.0.0",
-		"@atlaskit/tokens": "^1.58.0",
+		"@atlaskit/tokens": "^1.59.0",
 		"@babel/runtime": "^7.0.0",
 		"@emotion/react": "^11.7.1",
-		"date-fns": "^2.17.0",
-		"lodash": "^4.17.21"
+		"date-fns": "^2.17.0"
 	},
 	"peerDependencies": {
 		"react": "^16.8.0 || ^17.0.0 || ^18.0.0"
@@ -62,6 +61,7 @@
 		"@af/integration-testing": "*",
 		"@af/visual-regression": "*",
 		"@atlaskit/button": "^20.1.0",
+		"@atlaskit/codemod-utils": "4.2.4",
 		"@atlaskit/docs": "*",
 		"@atlaskit/form": "^10.5.0",
 		"@atlaskit/modal-dialog": "^12.15.0",
@@ -77,6 +77,7 @@
 		"@testing-library/user-event": "^14.4.3",
 		"@types/testing-library__jest-dom": "^5.14.5",
 		"jest-in-case": "^1.0.2",
+		"jscodeshift": "^0.13.0",
 		"moment": "^2.29.2",
 		"react-dom": "^16.8.0",
 		"react-lorem-component": "^0.13.0",