Add Datetime Picker to form and update Grafana dependencies for compo…

…nents package (#38) * Add Datetime Picker to form * Prepare components release 1.9.0
VolkovLabs · Apr 25, 2024 · 7d8e219 · 7d8e219
1 parent 176c1b9
commit 7d8e219
Show file tree

Hide file tree

Showing 11 changed files with 635 additions and 747 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/components/CHANGELOG.md b/packages/components/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Change Log
 
+## 1.9.0 (2024-04-05)
+
+### Features
+
+- Add Datetime Picker to form and update Grafana dependencies for components package (#38)
+
 ## 1.8.2 (2024-04-18)
 
 ### Bugfixes

diff --git a/packages/components/package.json b/packages/components/package.json
@@ -2,8 +2,8 @@
   "author": "Volkov Labs",
   "dependencies": {
     "@emotion/css": "^11.11.2",
-    "@grafana/data": "^10.2.1",
-    "@grafana/ui": "^10.2.1",
+    "@grafana/data": "^10.4.2",
+    "@grafana/ui": "^10.4.2",
     "classnames": "^2.5.1",
     "rc-slider": "^10.5.0",
     "rc-tooltip": "^6.2.0"
@@ -86,5 +86,5 @@
     "typecheck": "tsc --emitDeclarationOnly false --noEmit"
   },
   "types": "dist/index.d.ts",
-  "version": "1.8.2"
+  "version": "1.9.0"
 }
diff --git a/packages/components/src/__mocks__/@grafana/ui.tsx b/packages/components/src/__mocks__/@grafana/ui.tsx
@@ -1,4 +1,4 @@
-import { SelectableValue } from '@grafana/data';
+import { dateTime, SelectableValue } from '@grafana/data';
 import React from 'react';
 
 const actual = jest.requireActual('@grafana/ui');
@@ -89,8 +89,26 @@ const Select = jest.fn(
   )
 );
 
+/**
+ * Mock DatetimePicker component
+ */
+const DateTimePicker = jest.fn(({ onChange, ...restProps }) => {
+  return (
+    <input
+      data-testid={restProps['data-testid']}
+      value={restProps.date.toISOString()}
+      onChange={(event) => {
+        if (onChange) {
+          onChange(dateTime(event.target.value));
+        }
+      }}
+    />
+  );
+});
+
 module.exports = {
   ...actual,
   ColorPicker,
   Select,
+  DateTimePicker,
 };
diff --git a/packages/components/src/components/Form/Form.story.tsx b/packages/components/src/components/Form/Form.story.tsx
@@ -33,6 +33,7 @@ const meta = {
         radio: string;
         groupField1: string;
         groupField2: string;
+        datetime: string;
       }>((builder) =>
         builder
           .addSlider({
@@ -114,13 +115,20 @@ const meta = {
               row: 'group',
             },
           })
+          .addDateTimePicker({
+            path: 'datetime',
+            label: 'Datetime',
+            defaultValue: new Date().toISOString(),
+            min: new Date().toISOString(),
+            showSeconds: false,
+          })
       );
 
       return <Form {...args} fields={form.fields} value={form.value} />;
     };
 
     return (
-      <div style={{ width: 600 }}>
+      <div style={{ width: 600, padding: '20px' }}>
         <Preview />
       </div>
     );

diff --git a/packages/components/src/components/Form/Form.test.tsx b/packages/components/src/components/Form/Form.test.tsx
@@ -272,6 +272,13 @@ describe('Form', () => {
         defaultValue: '#123',
         newValue: '#222',
       },
+      {
+        name: 'datetime picker',
+        path: 'datetime',
+        getField: selectors.fieldDatetime,
+        defaultValue: new Date('2022-02-01T02:02:00').toISOString(),
+        newValue: new Date('2023-02-02T02:02:00').toISOString(),
+      },
     ])(
       'Should render $name inline field',
       async ({ path, getField, defaultValue, newValue, expectedValue = newValue }) => {
@@ -287,6 +294,7 @@ describe('Form', () => {
               name: string;
               age: number;
             };
+            datetime: string;
           }>({
             variant: 'inline',
             getForm: (builder) =>
@@ -363,7 +371,11 @@ describe('Form', () => {
                           row: '1,',
                         },
                       })
-                ),
+                )
+                .addDateTimePicker({
+                  path: 'datetime',
+                  defaultValue: new Date('2022-02-01T02:02:00').toISOString(),
+                }),
           })
         );
 

diff --git a/packages/components/src/components/Form/Form.tsx b/packages/components/src/components/Form/Form.tsx
@@ -1,6 +1,8 @@
+import { dateTime } from '@grafana/data';
 import {
   CollapsableSection,
   ColorPicker,
+  DateTimePicker,
   Field,
   InlineField,
   InlineFieldRow,
@@ -281,6 +283,23 @@ export const Form = <TValue extends object>({
       );
     }
 
+    if (field.type === FormFieldType.DATETIME_PICKER) {
+      return (
+        <FieldComponent {...fieldProps}>
+          <DateTimePicker
+            minDate={field.min ? new Date(field.min) : undefined}
+            maxDate={field.max ? new Date(field.max) : undefined}
+            showSeconds={field.showSeconds}
+            date={dateTime(field.value)}
+            onChange={(value) => {
+              field.onChange(value.toISOString());
+            }}
+            data-testid={TEST_IDS.form.fieldDatetime()}
+          />
+        </FieldComponent>
+      );
+    }
+
     if (field.type === FormFieldType.RADIO) {
       return (
         <FieldComponent {...fieldProps} data-testid={TEST_IDS.form.fieldRadio(field.fullPath)}>

diff --git a/packages/components/src/constants/tests.ts b/packages/components/src/constants/tests.ts
@@ -13,6 +13,11 @@ export const TEST_IDS = {
     fieldNumberInput: (name: unknown) => `data-testid form field-number-input-${name}`,
     fieldColor: (name: unknown) => `data-testid form field-color-${name}`,
     fieldInput: (name: unknown) => `data-testid form field-input-${name}`,
+    /**
+     * We should use default value for date-time-picker without data-testid prefix
+     * https://github.com/grafana/grafana/blob/f43762f39abad43f99b85cbcff6ca30c56f9d75f/packages/grafana-ui/src/components/DateTimePickers/DateTimePicker/DateTimePicker.tsx#L249
+     */
+    fieldDatetime: () => `data-testid date-time-input`,
     fieldRadio: (name: unknown) => `data-testid form field-radio-${name}`,
   },
 };
diff --git a/packages/components/src/types/form-builder.ts b/packages/components/src/types/form-builder.ts
@@ -237,6 +237,29 @@ export interface NumberInputOptions<TObject extends object, TValue> extends Base
   step?: number;
 }
 
+export interface DateTimePickerOptions<TObject extends object, TValue> extends BaseOptions<TObject, TValue> {
+  /**
+   * Min
+   *
+   * @type {string}
+   */
+  min?: string;
+
+  /**
+   * Max
+   *
+   * @type {string}
+   */
+  max?: string;
+
+  /**
+   * Show seconds
+   *
+   * @type {boolean}
+   */
+  showSeconds?: boolean;
+}
+
 export interface GroupOptions<TObject extends object, TValue extends object> {
   /**
    * Path
@@ -271,6 +294,7 @@ export enum FormFieldType {
   INPUT = 'input',
   NUMBER_INPUT = 'numberInput',
   RANGE_SLIDER = 'rangeSlider',
+  DATETIME_PICKER = 'datetimePicker',
 }
 
 /**
@@ -301,6 +325,9 @@ export type FormField<TObject extends object> =
   | ({
       type: FormFieldType.NUMBER_INPUT;
     } & NumberInputOptions<TObject, TObject[keyof TObject]>)
+  | ({
+      type: FormFieldType.DATETIME_PICKER;
+    } & DateTimePickerOptions<TObject, TObject[keyof TObject]>)
   | ({
       type: FormFieldType.GROUP;
     } & GroupOptions<TObject, IsObject<TObject[keyof TObject]>>)
@@ -357,6 +384,11 @@ export type RenderFormField<TObject extends object> =
           value: number;
           onChange: (value: number) => void;
         } & NumberInputOptions<TObject, TObject[keyof TObject]>)
+      | ({
+          type: FormFieldType.DATETIME_PICKER;
+          value: string;
+          onChange: (value: string) => void;
+        } & DateTimePickerOptions<TObject, TObject[keyof TObject]>)
     ) & {
       showIf: () => boolean;
       disableIf: () => boolean;

diff --git a/packages/components/src/utils/form-builder.test.ts b/packages/components/src/utils/form-builder.test.ts
@@ -100,6 +100,16 @@ describe('Form Builder', () => {
     expect(form.getValue().color).toEqual('#123');
   });
 
+  it('Should add datetime picker field', () => {
+    const date = new Date('2022-02-02');
+    const form = new FormBuilder<{ datetime: string }>({ path: '', label: '' }).addDateTimePicker({
+      path: 'datetime',
+      defaultValue: date.toISOString(),
+    });
+
+    expect(form.getValue().datetime).toEqual(date.toISOString());
+  });
+
   it('Should add custom field', () => {
     const form = new FormBuilder<{ custom: string }>({ path: '', label: '' }).addCustom({
       path: 'custom',

diff --git a/packages/components/src/utils/form-builder.ts b/packages/components/src/utils/form-builder.ts
@@ -1,6 +1,7 @@
 import {
   ColorOptions,
   CustomOptions,
+  DateTimePickerOptions,
   FormField,
   FormFieldType,
   HiddenOptions,
@@ -165,6 +166,17 @@ export class FormBuilder<TObject extends object> {
     });
   }
 
+  /**
+   * Add Date Time Picker Field
+   * @param options
+   */
+  addDateTimePicker<TOptions extends DateTimePickerOptions<TObject, TObject[TOptions['path']]>>(options: TOptions) {
+    return this.addField({
+      ...options,
+      type: FormFieldType.DATETIME_PICKER,
+    });
+  }
+
   /**
    * Add Custom Field
    * @param options