ant-design/components/date-picker/__tests__/RangePicker.test.tsx

import React, { useState } from 'react';
import { CloseCircleFilled } from '@ant-design/icons';
import userEvent from '@testing-library/user-event';
import dayjs from 'dayjs';
import customParseFormat from 'dayjs/plugin/customParseFormat';

import DatePicker from '..';
import { resetWarned } from '../../_util/warning';
import focusTest from '../../../tests/shared/focusTest';
import { render, resetMockDate, screen, setMockDate, waitFor } from '../../../tests/utils';
import enUS from '../locale/en_US';
import { closeCircleByRole, closePicker, expectCloseCircle, openPicker, selectCell } from './utils';

dayjs.extend(customParseFormat);

type RangeValue<DateType extends object> =
  | [DateType | undefined | null, DateType | undefined | null]
  | null;

const { RangePicker } = DatePicker;

describe('RangePicker', () => {
  focusTest(RangePicker, { refFocus: true, blurDelay: 110 });

  beforeEach(() => {
    setMockDate();
  });

  afterEach(() => {
    resetMockDate();
  });

  // issue: https://github.com/ant-design/ant-design/issues/5872
  it('should not throw error when value is reset to `[]`', () => {
    const birthday = dayjs('2000-01-01', 'YYYY-MM-DD');
    const wrapper1 = render(<RangePicker value={[birthday, birthday]} open />);
    const wrapper2 = render(<RangePicker value={[] as unknown as RangeValue<dayjs.Dayjs>} open />);

    expect(() => {
      openPicker(wrapper1);
      selectCell(wrapper1, 3);
      closePicker(wrapper1);

      openPicker(wrapper1, 1);
      selectCell(wrapper1, 5, 1);
      closePicker(wrapper1, 1);

      openPicker(wrapper2);
      selectCell(wrapper2, 3);
      closePicker(wrapper2);

      openPicker(wrapper2, 1);
      selectCell(wrapper2, 5, 1);
      closePicker(wrapper2, 1);
    }).not.toThrow();
  });

  it('customize separator', () => {
    const { container } = render(<RangePicker separator="test" />);
    expect(container.firstChild).toMatchSnapshot();
  });

  it('the left selection is before the right selection', () => {
    let rangePickerValue: dayjs.Dayjs[] = [];
    const Test: React.FC = () => {
      const [value, setValue] = useState<RangeValue<dayjs.Dayjs>>(null);
      return (
        <RangePicker
          value={value}
          mode={['month', 'month']}
          onPanelChange={(v) => {
            setValue(v);
            rangePickerValue = v as dayjs.Dayjs[];
          }}
        />
      );
    };

    const wrapper = render(<Test />);

    openPicker(wrapper);
    selectCell(wrapper, 'Feb');
    openPicker(wrapper, 1);
    selectCell(wrapper, 'May');
    closePicker(wrapper, 1);

    const [start, end] = rangePickerValue;

    expect(start.isBefore(end, 'date')).toBeTruthy();
  });

  // https://github.com/ant-design/ant-design/issues/13302
  describe('in "month" mode, when the left and right panels select the same month', () => {
    it('the cell status is correct', () => {
      let rangePickerValue: dayjs.Dayjs[] = [];
      const Test: React.FC = () => {
        const [value, setValue] = useState<RangeValue<dayjs.Dayjs>>(null!);
        return (
          <RangePicker
            value={value}
            mode={['month', 'month']}
            onPanelChange={(v) => {
              setValue(v);
              rangePickerValue = v as dayjs.Dayjs[];
            }}
          />
        );
      };

      const wrapper = render(<Test />);

      openPicker(wrapper);
      selectCell(wrapper, 'Feb');
      openPicker(wrapper, 1);
      selectCell(wrapper, 'Feb');
      closePicker(wrapper, 1);

      const [start, end] = rangePickerValue;

      expect(start.isSame(end, 'date')).toBeTruthy();
    });
  });

  describe('ranges', () => {
    it('RangePicker support preset ranges with Tags', () => {
      const { container } = render(
        <RangePicker
          open
          ranges={{
            Today: [dayjs(), dayjs()],
            'This Month': [dayjs().startOf('month'), dayjs().endOf('month')],
          }}
        />,
      );
      expect(Array.from(container.children)).toMatchSnapshot();
    });
  });

  it('placeholder', () => {
    const { container } = render(<RangePicker placeholder={undefined} />);
    const inputLists = container.querySelectorAll('input');
    expect(inputLists[0]?.placeholder).toEqual('Start date');
    expect(inputLists[inputLists.length - 1].placeholder).toEqual('End date');
  });

  it('RangePicker picker quarter placeholder', () => {
    const { container } = render(<RangePicker picker="quarter" locale={enUS} />);
    expect(container.querySelectorAll('input')[0]?.placeholder).toEqual('Start quarter');
    expect(container.querySelectorAll('input')[1]?.placeholder).toEqual('End quarter');
  });

  it('legacy dropdownClassName', () => {
    resetWarned();

    const errSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
    const { container } = render(<DatePicker.RangePicker dropdownClassName="legacy" open />);
    expect(errSpy).toHaveBeenCalledWith(
      'Warning: [antd: DatePicker.RangePicker] `dropdownClassName` is deprecated. Please use `popupClassName` instead.',
    );
    expect(container.querySelector('.legacy')).toBeTruthy();

    errSpy.mockRestore();
  });

  it('allows or prohibits clearing as applicable', async () => {
    const somepoint = dayjs('2023-08-01');
    const { rerender } = render(<RangePicker locale={enUS} value={[somepoint, somepoint]} />);

    const { role, options } = closeCircleByRole;
    await userEvent.hover(screen.getByRole(role, options));
    await waitFor(() => expectCloseCircle(true));

    rerender(<RangePicker locale={enUS} value={[somepoint, somepoint]} allowClear={false} />);
    await waitFor(() => expectCloseCircle(false));

    rerender(
      <RangePicker
        locale={enUS}
        value={[somepoint, somepoint]}
        allowClear={{ clearIcon: <CloseCircleFilled /> }}
      />,
    );
    await waitFor(() => expectCloseCircle(true));

    rerender(
      <RangePicker
        locale={enUS}
        value={[somepoint, somepoint]}
        allowClear={{ clearIcon: <div data-testid="custom-clear" /> }}
      />,
    );
    await waitFor(() => expectCloseCircle(false));
    await userEvent.hover(screen.getByTestId('custom-clear'));

    rerender(<RangePicker locale={enUS} value={[somepoint, somepoint]} allowClear={{}} />);
    await waitFor(() => expectCloseCircle(true));
  });
});