Skip to content

Enhance DatePicker behavior for date range selection and refocus logic #5793

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 18, 2025
Merged

Enhance DatePicker behavior for date range selection and refocus logic #5793

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 13 additions & 15 deletions src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -716,7 +716,17 @@ export class DatePicker extends Component<DatePickerProps, DatePickerState> {
monthSelectedIn?: number,
) => {
if (this.props.readOnly) return;
if (this.props.shouldCloseOnSelect && !this.props.showTimeSelect) {

const { selectsRange, startDate, endDate, swapRange } = this.props;
const isDateSelectionComplete =
!selectsRange ||
(startDate && !endDate && (swapRange || !isDateBefore(date, startDate)));

if (
this.props.shouldCloseOnSelect &&
!this.props.showTimeSelect &&
isDateSelectionComplete
) {
// Preventing onFocus event to fix issue
// https://github.com/Hacker0x01/react-datepicker/issues/628
this.sendFocusBackToInput();
Expand All @@ -730,20 +740,8 @@ export class DatePicker extends Component<DatePickerProps, DatePickerState> {
}
if (!this.props.shouldCloseOnSelect || this.props.showTimeSelect) {
this.setPreSelection(date);
} else if (!this.props.inline) {
if (!this.props.selectsRange) {
this.setOpen(false);
}

const { startDate, endDate } = this.props;

if (
startDate &&
!endDate &&
(this.props.swapRange || !isDateBefore(date, startDate))
) {
this.setOpen(false);
}
} else if (isDateSelectionComplete) {
this.setOpen(false);
}
};

Expand Down
175 changes: 175 additions & 0 deletions src/test/datepicker_test.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4642,4 +4642,179 @@ describe("DatePicker", () => {
);
});
});

describe("Refocus Input", () => {
it("should refocus the date input when a date is selected", async () => {
const selectedDate = newDate("2025-11-01");
const onChangeSpy = jest.fn();
const { container } = render(
<DatePicker
selected={selectedDate}
dateFormat="yyyy-MM-dd"
onChange={onChangeSpy}
/>,
);

const input = safeQuerySelector<HTMLInputElement>(container, "input");
fireEvent.focus(input);

expect(container.querySelector(".react-datepicker")).toBeTruthy();

const newSelectedDateEl = safeQuerySelector(
container,
".react-datepicker__day--002",
);
fireEvent.click(newSelectedDateEl);

await waitFor(() => {
expect(document.activeElement).not.toBe(newSelectedDateEl);
expect(document.activeElement).toBe(input);
});
});

describe("Date Range", () => {
it("should not refocus the input when the endDate is not selected in the Date Range", async () => {
const selectedDate = newDate("2025-11-01");
let startDate, endDate;
const onChangeSpy = jest.fn((dates) => {
[startDate, endDate] = dates;
});

const { container } = render(
<DatePicker
selectsRange
selected={selectedDate}
startDate={startDate}
endDate={endDate}
dateFormat="yyyy-MM-dd"
onChange={onChangeSpy}
/>,
);
const input = safeQuerySelector<HTMLInputElement>(container, "input");
fireEvent.focus(input);

expect(container.querySelector(".react-datepicker")).toBeTruthy();
const newStartDateEl = safeQuerySelector(
container,
".react-datepicker__day--002",
);
fireEvent.click(newStartDateEl);

expect(onChangeSpy).toHaveBeenCalledTimes(1);

await waitFor(() => {
expect(document.activeElement).not.toBe(input);
expect(document.activeElement).toBe(newStartDateEl);
});
});

it("should refocus the input when the endDate is selected in the Date Range (if the end date is after the start date)", async () => {
const selectedDate = newDate("2025-11-01");
let startDate = selectedDate,
endDate;
const onChangeSpy = jest.fn((dates) => {
[startDate, endDate] = dates;
});

const { container } = render(
<DatePicker
selectsRange
selected={selectedDate}
startDate={startDate}
endDate={endDate}
dateFormat="yyyy-MM-dd"
onChange={onChangeSpy}
/>,
);
const input = safeQuerySelector<HTMLInputElement>(container, "input");
fireEvent.focus(input);

expect(container.querySelector(".react-datepicker")).toBeTruthy();
const endDateEl = safeQuerySelector(
container,
".react-datepicker__day--005",
);
fireEvent.click(endDateEl);

expect(onChangeSpy).toHaveBeenCalledTimes(1);

await waitFor(() => {
expect(document.activeElement).toBe(input);
});
});

it("should not refocus the input when the selected endDate is before the startDate", async () => {
const selectedDate = newDate("2025-11-05");
let startDate = selectedDate,
endDate;
const onChangeSpy = jest.fn((dates) => {
[startDate, endDate] = dates;
});

const { container } = render(
<DatePicker
selectsRange
selected={selectedDate}
startDate={startDate}
endDate={endDate}
dateFormat="yyyy-MM-dd"
onChange={onChangeSpy}
/>,
);
const input = safeQuerySelector<HTMLInputElement>(container, "input");
fireEvent.focus(input);

expect(container.querySelector(".react-datepicker")).toBeTruthy();
const endDateEl = safeQuerySelector(
container,
".react-datepicker__day--002",
);
fireEvent.click(endDateEl);

expect(onChangeSpy).toHaveBeenCalledTimes(1);

await waitFor(() => {
expect(document.activeElement).not.toBe(input);
expect(document.activeElement).toBe(endDateEl);
});
});

it('should refocus the input when the selected endDate is before the startDate when the "swapRange" prop is set', async () => {
const selectedDate = newDate("2025-11-05");
let startDate = selectedDate,
endDate;
const onChangeSpy = jest.fn((dates) => {
[startDate, endDate] = dates;
});

const { container } = render(
<DatePicker
selectsRange
swapRange
selected={selectedDate}
startDate={startDate}
endDate={endDate}
dateFormat="yyyy-MM-dd"
onChange={onChangeSpy}
/>,
);
const input = safeQuerySelector<HTMLInputElement>(container, "input");
fireEvent.focus(input);

expect(container.querySelector(".react-datepicker")).toBeTruthy();
const endDateEl = safeQuerySelector(
container,
".react-datepicker__day--002",
);
fireEvent.click(endDateEl);

expect(onChangeSpy).toHaveBeenCalledTimes(1);

await waitFor(() => {
expect(document.activeElement).not.toBe(endDateEl);
expect(document.activeElement).toBe(input);
});
});
});
});
});
Loading