Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/PanelContext.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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>({});
Expand Down
21 changes: 19 additions & 2 deletions src/Picker.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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';
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

picker : 'time' 写错了吧?

文档里里 date | week | month | quarter | year

下面代码给的默认值是 picker = 'date'

而且picker应该是optional的。这里导致了一个issue:
ant-design/ant-design#22955

/**
* @deprecated Please use `defaultValue` directly instead
* since `defaultOpenValue` will confuse user of current value status
*/
defaultOpenValue?: DateType;
}

export type PickerProps<DateType> =
| PickerBaseProps<DateType>
Expand Down Expand Up @@ -143,6 +150,7 @@ function InnerPicker<DateType>(props: PickerProps<DateType>) {
defaultValue,
open,
defaultOpen,
defaultOpenValue,
suffixIcon,
clearIcon,
disabled,
Expand Down Expand Up @@ -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,
Expand All @@ -418,6 +434,7 @@ function InnerPicker<DateType>(props: PickerProps<DateType>) {
panelRef: panelDivRef,
onSelect: onContextSelect,
open: mergedOpen,
defaultOpenValue,
}}
>
<PickerTrigger
Expand Down
7 changes: 7 additions & 0 deletions src/PickerPanel.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ function PickerPanel<DateType>(props: PickerPanelProps<DateType>) {
panelRef: panelDivRef,
onSelect: onContextSelect,
hideRanges,
defaultOpenValue,
} = panelContext;

const {
Expand All @@ -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
Expand Down
28 changes: 28 additions & 0 deletions tests/picker.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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';

Expand Down Expand Up @@ -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();
});
});