Skip to content
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

fix(blade): focus on selected date by default in datepicker #2567

Merged
merged 6 commits into from
Mar 12, 2025
Merged

fix(blade): focus on selected date by default in datepicker #2567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
44c6d84
fix: focus on selected value by default
tewarig Mar 9, 2025
16ef72b
chore: add changeset
tewarig Mar 9, 2025
4666e26
fix: update
tewarig Mar 10, 2025
2c3bd83
chore: update value
tewarig Mar 10, 2025
a001647
refactor: logic of autoSelection
tewarig Mar 11, 2025
b82c1eb
chore: added interection test
tewarig Mar 11, 2025
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
5 changes: 5 additions & 0 deletions .changeset/wet-beds-sparkle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@razorpay/blade': patch
---

fix(blade): focus on selected date by default in datepicker
20 changes: 17 additions & 3 deletions packages/blade/src/components/DatePicker/Calendar.web.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/* eslint-disable @typescript-eslint/explicit-function-return-type */
import dayjs from 'dayjs';
import React from 'react';
import type { CalendarLevel } from '@mantine/dates';
import type { CalendarLevel, DatesRangeValue } from '@mantine/dates';
import { useDatesContext, DatePicker } from '@mantine/dates';
import type { CalendarProps, DateSelectionType, PickerType, DateValue } from './types';
import { CalendarHeader } from './CalendarHeader';
Expand All @@ -29,12 +29,14 @@ const Calendar = <Type extends DateSelectionType>({
onPrevious,
presets,
showLevelChangeLink,
oldValue,
...props
}: CalendarProps<Type> & {
date?: Date;
defaultDate?: Date;
onDateChange?: (date: DateValue) => void;
showLevelChangeLink?: boolean;
oldValue: DatesRangeValue | null;
}): React.ReactElement => {
const isRange = selectionType === 'range';

Expand Down Expand Up @@ -64,7 +66,19 @@ const Calendar = <Type extends DateSelectionType>({

const dateContext = useDatesContext();
const isMobile = useIsMobile();
const currentDate = _date ?? shiftTimezone('add', new Date());
const currentDate = React.useMemo(() => {
Copy link
Member

Choose a reason for hiding this comment

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

Can you explain whats happening here? the date prop as is should work?

Copy link
Contributor Author

@tewarig tewarig Mar 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

We are already using dateProp. Currently, _date is passed to Date.
Whenever the user clicks on the next month/year, we update _date, and the date picker focuses on _date.

I modified this logic slightly:

  1. If _date exists, focus on it.
  2. Otherwise, focus on oldValue.
  3. If oldValue is also unavailable, focus on currentDate.

Copy link
Member

Choose a reason for hiding this comment

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

what is oldValue?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's the last applied value in the date picker.
Whenever you click/select any value on the date picker, its value changes. But if you click on Cancel, we revert back to the older value using oldValue. When you click on Apply, we save the applied value in oldValue to retrieve it next time.

if (_date) {
return _date;
}
const isRangeSelection = Array.isArray(oldValue);
if (isRangeSelection && oldValue[0]) {
return oldValue[0];
}
if (!isRangeSelection && oldValue) {
return oldValue;
}
return shiftTimezone('add', new Date());
}, [_date, oldValue]);
const numberOfColumns = isMobile || !isRange ? 1 : 2;
const columnsToScroll = numberOfColumns;

Expand Down Expand Up @@ -133,7 +147,7 @@ const Calendar = <Type extends DateSelectionType>({
<DatePicker
withCellSpacing={false}
type={isRange ? 'range' : 'default'}
date={_date}
date={currentDate}
locale={dateContext.locale}
level={level}
onDateChange={setDate}
Expand Down
1 change: 1 addition & 0 deletions packages/blade/src/components/DatePicker/DatePicker.web.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,7 @@ const DatePicker = <Type extends DateSelectionType = 'single'>({
setPicker(() => picker);
forceRerender();
}}
oldValue={oldValue}
/>
{isMobile ? null : (
<CalendarFooter
Expand Down
73 changes: 73 additions & 0 deletions packages/blade/src/components/DatePicker/__tests__/DatePicker.test.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -464,6 +464,79 @@ Localization.play = async () => {
await expect(queryByText('रवि')).toBeVisible();
};

export const DatePickerSingleAutoFocus: StoryFn<
typeof DatePickerComponent
> = (): React.ReactElement => {
return <DatePickerComponent selectionType="single" accessibilityLabel="Select Date" />;
};

DatePickerSingleAutoFocus.play = async () => {
const { getByRole, queryByText, getByLabelText } = within(document.body);
const nextYear = dayjs().add(1, 'year').year();
const selectedDate = `22 January ${nextYear}`;
const input = getByRole('combobox', { name: /Select Date/i });
await userEvent.click(input);
await sleep(400);
await expect(queryByText('Sun')).toBeVisible();
await userEvent.tab();
await userEvent.tab();
const month = getByRole('button', { name: /Change month/i });
await expect(month).toHaveFocus();
await userEvent.click(month);
const year = getByRole('button', { name: /Change decade/i });
await userEvent.click(year);
getByRole('button', { name: /previous/i }).focus();
await userEvent.tab();
await userEvent.tab();
await sleep(400);
await expect(getByRole('button', { name: dayjs().format('YYYY') })).toHaveFocus();
await userEvent.keyboard('{ArrowRight}');
await userEvent.keyboard('{Enter}');
await sleep(400);
await userEvent.keyboard('{Enter}');
await sleep(400);
const january = getByRole('button', { name: /Jan/i });
await userEvent.click(january);
const date = getByRole('button', { name: selectedDate });
await userEvent.click(date);
const applyButton = getByRole('button', { name: /Apply/i });
await userEvent.click(applyButton);
await sleep(400);
await userEvent.click(input);
await sleep(400);
await expect(getByLabelText(selectedDate)).not.toBeNull();
};

export const DatePickerRangeSelectAutoFocus: StoryFn<
typeof DatePickerComponent
> = (): React.ReactElement => {
return (
<DatePickerComponent selectionType="range" label={{ start: 'Start Date', end: 'End Date' }} />
);
};

DatePickerRangeSelectAutoFocus.play = async () => {
const { getByRole, getByLabelText } = within(document.body);
const startInput = getByRole('combobox', { name: /Start Date/i });
const selectedEndDate = dayjs().subtract(1, 'M').format('DD MMMM YYYY');
const selectedStartDate = dayjs().subtract(1, 'M').subtract(1, 'd').format('DD MMMM YYYY');
await userEvent.click(startInput);
await sleep(400);
const previousButton = getByRole('button', { name: /previous/i });
await userEvent.click(previousButton);
const startDateButton = getByRole('button', { name: selectedStartDate });
await userEvent.click(startDateButton);
const endDateButton = getByRole('button', { name: selectedEndDate });
await userEvent.click(endDateButton);
const applyButton = getByRole('button', { name: /Apply/i });
await userEvent.click(applyButton);
await sleep(400);
await userEvent.click(startInput);
await sleep(400);
await expect(getByLabelText(selectedStartDate)).not.toBeNull();
await expect(getByLabelText(selectedEndDate)).not.toBeNull();
};

export default {
title: 'Components/Interaction Tests/DatePicker',
component: DatePickerComponent,
Expand Down
Loading