fix: Add defaultOpenValue support (#23)

* add timePicker defaultOpenValue support

* add test case

Author: zombieJ

src/PanelContext.tsx

@@ -18,6 +18,9 @@ export interface PanelContextProps {
   onSelect?: OnSelect<any>;
   hideRanges?: boolean;
   open?: boolean;
+
+  /** Only used for TimePicker and this is a deprecated prop */
+  defaultOpenValue?: any;
 }
 
 const PanelContext = React.createContext<PanelContextProps>({});

src/Picker.tsx

@@ -14,7 +14,7 @@
 import * as React from 'react';
 import classNames from 'classnames';
 import { AlignType } from 'rc-trigger/lib/interface';
-import { warning } from 'rc-util/lib/warning';
+import warning from 'rc-util/lib/warning';
 import useMergedState from 'rc-util/lib/hooks/useMergedState';
 import PickerPanel, {
   PickerPanelBaseProps,
@@ -104,7 +104,14 @@ export interface PickerDateProps<DateType>
 
 export interface PickerTimeProps<DateType>
   extends PickerSharedProps<DateType>,
-    Omit<OmitPanelProps<PickerPanelTimeProps<DateType>>, 'format'> {}
+    Omit<OmitPanelProps<PickerPanelTimeProps<DateType>>, 'format'> {
+  picker: 'time';
+  /**
+   * @deprecated Please use `defaultValue` directly instead
+   * since `defaultOpenValue` will confuse user of current value status
+   */
+  defaultOpenValue?: DateType;
+}
 
 export type PickerProps<DateType> =
   | PickerBaseProps<DateType>
@@ -143,6 +150,7 @@ function InnerPicker<DateType>(props: PickerProps<DateType>) {
     defaultValue,
     open,
     defaultOpen,
+    defaultOpenValue,
     suffixIcon,
     clearIcon,
     disabled,
@@ -397,6 +405,14 @@ function InnerPicker<DateType>(props: PickerProps<DateType>) {
     );
   }
 
+  // ============================ Warning ============================
+  if (process.env.NODE_ENV !== 'production') {
+    warning(
+      !defaultOpenValue,
+      '`defaultOpenValue` may confuse user for the current value status. Please use `defaultValue` instead.',
+    );
+  }
+
   // ============================ Return =============================
   const onContextSelect = (
     date: DateType,
@@ -418,6 +434,7 @@ function InnerPicker<DateType>(props: PickerProps<DateType>) {
         panelRef: panelDivRef,
         onSelect: onContextSelect,
         open: mergedOpen,
+        defaultOpenValue,
       }}
     >
       <PickerTrigger

src/PickerPanel.tsx

@@ -171,6 +171,7 @@ function PickerPanel<DateType>(props: PickerPanelProps<DateType>) {
     panelRef: panelDivRef,
     onSelect: onContextSelect,
     hideRanges,
+    defaultOpenValue,
   } = panelContext;
 
   const {
@@ -188,6 +189,12 @@ function PickerPanel<DateType>(props: PickerPanelProps<DateType>) {
   const [mergedValue, setInnerValue] = useMergedState(null, {
     value,
     defaultValue,
+    postState: val => {
+      if (!val && defaultOpenValue && picker === 'time') {
+        return defaultOpenValue;
+      }
+      return val;
+    },
   });
 
   // View date control

tests/picker.spec.tsx

@@ -3,6 +3,7 @@ import MockDate from 'mockdate';
 import { act } from 'react-dom/test-utils';
 import { spyElementPrototypes } from 'rc-util/lib/test/domHook';
 import KeyCode from 'rc-util/lib/KeyCode';
+import { resetWarned } from 'rc-util/lib/warning';
 import { PanelMode, PickerMode } from '../src/interface';
 import { mount, getMoment, isSame, MomentPicker } from './util/commonUtil';
 
@@ -557,4 +558,31 @@ describe('Picker.Basic', () => {
     wrapper.find('.rc-picker').simulate('mouseUp');
     expect(inputElement.focus).toHaveBeenCalled();
   });
+
+  it('defaultOpenValue in timePicker', () => {
+    resetWarned();
+    const onChange = jest.fn();
+    const errSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
+
+    const wrapper = mount(
+      <MomentPicker
+        picker="time"
+        defaultOpenValue={getMoment('2000-01-01 00:10:23')}
+        onChange={onChange}
+      />,
+    );
+
+    expect(errSpy).toHaveBeenCalledWith(
+      'Warning: `defaultOpenValue` may confuse user for the current value status. Please use `defaultValue` instead.',
+    );
+
+    wrapper.openPicker();
+    wrapper.find('.rc-picker-ok button').simulate('click');
+
+    expect(
+      isSame(onChange.mock.calls[0][0], '2000-01-01 00:10:23'),
+    ).toBeTruthy();
+
+    errSpy.mockRestore();
+  });
 });