Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.
TypeScript boardcollaborationdocdocxexceloffce365officepdfpptpptxpresentationsdksheetslidesspreadsheetuniverwordwordprocessorworkspacexlsx
feat(design): add year/month dropdowns to Calendar (#7088)
白熱3a46f88f5be1
diff --git a/packages/design/src/components/calendar/Calendar.tsx b/packages/design/src/components/calendar/Calendar.tsxindex 89725e1e93..31805cd411 100644--- a/packages/design/src/components/calendar/Calendar.tsx+++ b/packages/design/src/components/calendar/Calendar.tsx@@ -18,8 +18,16 @@ import type { ButtonHTMLAttributes } from 'react';import { MoreRightIcon } from '@univerjs/icons';import { useContext, useMemo, useState } from 'react';import { clsx } from '../../helper/clsx';+import { Button } from '../button/Button';import { ConfigContext } from '../config-provider/ConfigProvider';+import { DropdownMenu } from '../dropdown-menu/DropdownMenu';+import { Dropdown } from '../dropdown/Dropdown';import { TimeInput } from '../time-input/TimeInput';+import { VirtualList } from '../virtual-list';++const DEFAULT_YEAR_RANGE = 100;+const YEAR_ITEM_HEIGHT = 32;+const YEAR_LIST_HEIGHT = 224;function getDaysInMonth(year: number, month: number) {return new Date(year, month + 1, 0).getDate();@@ -59,7 +67,13 @@ export function Calendar(props: ICalendarProps) {const { locale } = useContext(ConfigContext);- const { year, weekDays, months } = locale?.Calendar as {+ const { ariaLabels, year, weekDays, months } = locale?.Calendar as {+ ariaLabels: {+ previousMonth: string;+ nextMonth: string;+ selectYear: string;+ selectMonth: string;+ };year: string;weekDays: string[];months: string[];@@ -68,6 +82,7 @@ export function Calendar(props: ICalendarProps) {const today = new Date();const [currentYear, setCurrentYear] = useState((value ?? today).getFullYear());const [currentMonth, setCurrentMonth] = useState((value ?? today).getMonth());+ const [yearDropdownOpen, setYearDropdownOpen] = useState(false);function prevMonth() {setCurrentMonth((prev) => {@@ -89,6 +104,38 @@ export function Calendar(props: ICalendarProps) {});}+ function handleChangeMonth(month: string) {+ setCurrentMonth(Number(month));+ }++ function handleChangeYear(year: number) {+ setCurrentYear(year);+ setYearDropdownOpen(false);+ }++ const yearOptions = useMemo(() => {+ const startYear = min?.getFullYear() ?? currentYear - DEFAULT_YEAR_RANGE;+ const endYear = max?.getFullYear() ?? currentYear + DEFAULT_YEAR_RANGE;++ return Array.from(+ { length: Math.max(0, endYear - startYear + 1) },+ (_, index) => ({ year: startYear + index })+ );+ }, [currentYear, max, min]);++ const currentYearIndex = Math.max(0, yearOptions.findIndex((item) => item.year === currentYear));++ const monthMenuItems = useMemo(() => [{+ type: 'radio' as const,+ value: String(currentMonth),+ hideIndicator: true,+ options: months.map((month, index) => ({+ label: month,+ value: String(index),+ })),+ onSelect: handleChangeMonth,+ }], [currentMonth, months]);+const daysInMonth = getDaysInMonth(currentYear, currentMonth);const firstDay = getFirstDayOfWeek(currentYear, currentMonth);@@ -159,22 +206,76 @@ export function Calendar(props: ICalendarProps) {univer-text-lg univer-text-gray-500dark:!univer-text-gray-200`}- aria-label="Previous Month"+ aria-label={ariaLabels.previousMonth}onClick={prevMonth}><MoreRightIcon className="univer-rotate-180" /></DayButton>- <span className="univer-flex univer-gap-0.5 univer-text-sm univer-font-medium">- <span>{currentYear}</span>- <span>{year}</span>- <span>{months[currentMonth]}</span>+ <span className="univer-flex univer-items-center univer-gap-0.5 univer-text-sm univer-font-medium">+ <Dropdown+ align="center"+ className="univer-w-24 univer-p-1.5"+ open={yearDropdownOpen}+ overlay={(+ <VirtualList+ className="univer-rounded"+ data={yearOptions}+ height={YEAR_LIST_HEIGHT}+ initialScrollIndex={currentYearIndex}+ itemHeight={YEAR_ITEM_HEIGHT}+ itemKey="year"+ >+ {(item) => (+ <button+ className={clsx(`+ univer-flex univer-h-8 univer-w-full univer-items-center univer-justify-center+ univer-rounded univer-border-none univer-bg-transparent univer-px-2+ univer-text-sm univer-text-gray-900 univer-transition-colors+ hover:univer-bg-gray-100+ dark:!univer-text-white+ dark:hover:!univer-bg-gray-600+ `, {+ 'univer-bg-gray-200 dark:!univer-bg-gray-500': item.year === currentYear,+ })}+ type="button"+ onClick={() => handleChangeYear(item.year)}+ >+ {item.year}+ </button>+ )}+ </VirtualList>+ )}+ onOpenChange={setYearDropdownOpen}+ >+ <Button+ variant="text"+ type="button"+ aria-label={ariaLabels.selectYear}+ >+ {currentYear}+ {year}+ </Button>+ </Dropdown>+ <DropdownMenu+ align="center"+ className="univer-max-h-80 univer-min-w-28 univer-overflow-auto"+ items={monthMenuItems}+ >+ <Button+ variant="text"+ type="button"+ aria-label={ariaLabels.selectMonth}+ >+ {months[currentMonth]}+ </Button>+ </DropdownMenu></span><DayButtonclassName={`univer-text-lg univer-text-gray-500dark:!univer-text-gray-200`}- aria-label="Next Month"+ aria-label={ariaLabels.nextMonth}onClick={nextMonth}><MoreRightIcon />diff --git a/packages/design/src/components/calendar/__tests__/index.spec.tsx b/packages/design/src/components/calendar/__tests__/index.spec.tsxindex 63297e7e76..5e09c4c101 100644--- a/packages/design/src/components/calendar/__tests__/index.spec.tsx+++ b/packages/design/src/components/calendar/__tests__/index.spec.tsx@@ -15,7 +15,7 @@*/import { cleanup, fireEvent, render } from '@testing-library/react';-import { afterEach, describe, expect, it, vi } from 'vitest';+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';import enUS from '../../../locale/en-US';import { ConfigProvider } from '../../config-provider/ConfigProvider';import { Calendar } from '../Calendar';@@ -26,6 +26,10 @@ afterEach(cleanup);describe('Calendar', () => {const onChange = vi.fn();+ beforeEach(() => {+ onChange.mockClear();+ });+function renderCalendar(props = {}) {const date = new Date(2023, 7, 15);return render(@@ -73,13 +77,62 @@ describe('Calendar', () => {</ConfigProvider>);- fireEvent.click(getByLabelText('Previous Month'));+ fireEvent.click(getByLabelText(enUS.design.Calendar.ariaLabels.previousMonth));expect(getByText('2022')).toBeInTheDocument();- fireEvent.click(getByLabelText('Next Month'));+ fireEvent.click(getByLabelText(enUS.design.Calendar.ariaLabels.nextMonth));expect(getByText('2023')).toBeInTheDocument();});+ it('should select a month from the month menu without changing value immediately', () => {+ const { getByLabelText, getByRole, getByText } = renderCalendar();++ fireEvent.pointerDown(getByLabelText(enUS.design.Calendar.ariaLabels.selectMonth));+ fireEvent.click(getByRole('menuitemradio', { name: enUS.design.Calendar.months[10] }));++ expect(getByText(enUS.design.Calendar.months[10])).toBeInTheDocument();+ expect(onChange).not.toHaveBeenCalled();++ fireEvent.click(getByText('20'));++ expect(onChange).toHaveBeenCalledTimes(1);+ const calledDate = onChange.mock.calls[0][0];+ expect(calledDate.getFullYear()).toBe(2023);+ expect(calledDate.getMonth()).toBe(10);+ expect(calledDate.getDate()).toBe(20);+ });++ it('should select a year from the year menu without changing value immediately', () => {+ const { getByLabelText, getByText } = renderCalendar();++ fireEvent.click(getByLabelText(enUS.design.Calendar.ariaLabels.selectYear));+ fireEvent.click(getByText('2030'));++ expect(getByText('2030')).toBeInTheDocument();+ expect(onChange).not.toHaveBeenCalled();++ fireEvent.click(getByText('20'));++ expect(onChange).toHaveBeenCalledTimes(1);+ const calledDate = onChange.mock.calls[0][0];+ expect(calledDate.getFullYear()).toBe(2030);+ expect(calledDate.getMonth()).toBe(7);+ expect(calledDate.getDate()).toBe(20);+ });++ it('should limit selectable years by min and max', () => {+ const min = new Date(2022, 0, 1);+ const max = new Date(2024, 11, 31);+ const { getByLabelText, queryByText } = renderCalendar({ min, max });++ fireEvent.click(getByLabelText(enUS.design.Calendar.ariaLabels.selectYear));++ expect(queryByText('2021')).not.toBeInTheDocument();+ expect(queryByText('2022')).toBeInTheDocument();+ expect(queryByText('2024')).toBeInTheDocument();+ expect(queryByText('2025')).not.toBeInTheDocument();+ });+it('should disable out-of-range days and propagate time changes', () => {const min = new Date(2023, 7, 10, 0, 0, 0);const max = new Date(2023, 7, 20, 23, 59, 59);diff --git a/packages/design/src/components/virtual-list/VirtualList.tsx b/packages/design/src/components/virtual-list/VirtualList.tsxindex b56b6ddeea..fb79a75254 100644--- a/packages/design/src/components/virtual-list/VirtualList.tsx+++ b/packages/design/src/components/virtual-list/VirtualList.tsx@@ -15,7 +15,7 @@*/import type { CSSProperties, Key, ReactNode } from 'react';-import { useState } from 'react';+import { useEffect, useRef, useState } from 'react';export interface IVirtualListProps<T extends object> {data: T[];@@ -23,14 +23,26 @@ export interface IVirtualListProps<T extends object> {children: (item: T, index: number) => ReactNode;height?: number;itemHeight?: number;+ initialScrollIndex?: number;overscan?: number;className?: string;style?: CSSProperties;}export function VirtualList<T extends object>(props: IVirtualListProps<T>) {- const { data, itemKey, children, height, itemHeight, overscan = 2, className, style } = props;- const [scrollTop, setScrollTop] = useState(0);+ const { data, itemKey, children, height, itemHeight, initialScrollIndex = 0, overscan = 2, className, style } = props;+ const initialScrollTop = height && itemHeight ? initialScrollIndex * itemHeight : 0;+ const scrollerRef = useRef<HTMLDivElement>(null);+ const [scrollTop, setScrollTop] = useState(initialScrollTop);++ useEffect(() => {+ const scroller = scrollerRef.current;+ if (!scroller || !height || !itemHeight) return;++ const nextScrollTop = initialScrollIndex * itemHeight;+ scroller.scrollTop = nextScrollTop;+ setScrollTop(nextScrollTop);+ }, [height, initialScrollIndex, itemHeight]);if (!height || !itemHeight || itemHeight <= 0) {return (@@ -57,6 +69,7 @@ export function VirtualList<T extends object>(props: IVirtualListProps<T>) {return (<div+ ref={scrollerRef}className={className}style={{...style,diff --git a/packages/design/src/components/virtual-list/__tests__/index.spec.tsx b/packages/design/src/components/virtual-list/__tests__/index.spec.tsxindex f21e2d53bd..95c6a88213 100644--- a/packages/design/src/components/virtual-list/__tests__/index.spec.tsx+++ b/packages/design/src/components/virtual-list/__tests__/index.spec.tsx@@ -57,4 +57,24 @@ describe('VirtualList', () => {expect(scroller.textContent).toContain('Item 10');});++ it('should render from the initial scroll index', () => {+ const { container } = render(+ <VirtualList+ data={data}+ itemKey="id"+ height={40}+ initialScrollIndex={10}+ itemHeight={10}+ overscan={1}+ >+ {(item) => <span>{item.label}</span>}+ </VirtualList>+ );++ const scroller = container.firstElementChild as HTMLDivElement;++ expect(scroller.textContent).toContain('Item 9');+ expect(scroller.textContent).toContain('Item 10');+ });});diff --git a/packages/design/src/locale/ar-SA.ts b/packages/design/src/locale/ar-SA.tsindex ad0b10231a..9be5f5aa87 100644--- a/packages/design/src/locale/ar-SA.ts+++ b/packages/design/src/locale/ar-SA.ts@@ -42,6 +42,12 @@ const locale: typeof enUS = {'نوفمبر','ديسمبر',],+ ariaLabels: {+ previousMonth: 'الشهر السابق',+ nextMonth: 'الشهر التالي',+ selectYear: 'اختر السنة',+ selectMonth: 'اختر الشهر',+ },},Select: {empty: 'لا شيء',diff --git a/packages/design/src/locale/ca-ES.ts b/packages/design/src/locale/ca-ES.tsindex 5afb3f266a..4250f2771b 100644--- a/packages/design/src/locale/ca-ES.ts+++ b/packages/design/src/locale/ca-ES.ts@@ -42,6 +42,12 @@ const locale: typeof enUS = {'novembre','desembre',],+ ariaLabels: {+ previousMonth: 'Mes anterior',+ nextMonth: 'Mes següent',+ selectYear: 'Selecciona l\'any',+ selectMonth: 'Selecciona el mes',+ },},Select: {empty: 'Cap',diff --git a/packages/design/src/locale/de-DE.ts b/packages/design/src/locale/de-DE.tsindex 924f44791a..66de40d0a0 100644--- a/packages/design/src/locale/de-DE.ts+++ b/packages/design/src/locale/de-DE.ts@@ -42,6 +42,12 @@ const locale: typeof enUS = {'Nov','Dez',],+ ariaLabels: {+ previousMonth: 'Vorheriger Monat',+ nextMonth: 'Nächster Monat',+ selectYear: 'Jahr auswählen',+ selectMonth: 'Monat auswählen',+ },},Select: {empty: 'Keine',diff --git a/packages/design/src/locale/en-US.ts b/packages/design/src/locale/en-US.tsindex 81a9162885..c222b0ee52 100644--- a/packages/design/src/locale/en-US.ts+++ b/packages/design/src/locale/en-US.ts@@ -40,6 +40,12 @@ const locale = {'Nov','Dec',],+ ariaLabels: {+ previousMonth: 'Previous month',+ nextMonth: 'Next month',+ selectYear: 'Select year',+ selectMonth: 'Select month',+ },},Select: {empty: 'None',diff --git a/packages/design/src/locale/es-ES.ts b/packages/design/src/locale/es-ES.tsindex f4b4289f86..d2bf2b6f5d 100644--- a/packages/design/src/locale/es-ES.ts+++ b/packages/design/src/locale/es-ES.ts@@ -42,6 +42,12 @@ const locale: typeof enUS = {'Novembre','Desembre',],+ ariaLabels: {+ previousMonth: 'Mes anterior',+ nextMonth: 'Mes siguiente',+ selectYear: 'Seleccionar año',+ selectMonth: 'Seleccionar mes',+ },},Select: {empty: 'Cap',diff --git a/packages/design/src/locale/fa-IR.ts b/packages/design/src/locale/fa-IR.tsindex d089409f56..09da413d0a 100644--- a/packages/design/src/locale/fa-IR.ts+++ b/packages/design/src/locale/fa-IR.ts@@ -42,6 +42,12 @@ const locale: typeof enUS = {'بهمن','اسفند',],+ ariaLabels: {+ previousMonth: 'ماه قبل',+ nextMonth: 'ماه بعد',+ selectYear: 'انتخاب سال',+ selectMonth: 'انتخاب ماه',+ },},Select: {empty: 'هیچکدام',diff --git a/packages/design/src/locale/fr-FR.ts b/packages/design/src/locale/fr-FR.tsindex 4abb551737..dcb5112f51 100644--- a/packages/design/src/locale/fr-FR.ts+++ b/packages/design/src/locale/fr-FR.ts@@ -42,6 +42,12 @@ const locale: typeof enUS = {'Novembre','Décembre',],+ ariaLabels: {+ previousMonth: 'Mois précédent',+ nextMonth: 'Mois suivant',+ selectYear: 'Sélectionner l\'année',+ selectMonth: 'Sélectionner le mois',+ },},Select: {empty: 'Aucun',diff --git a/packages/design/src/locale/id-ID.ts b/packages/design/src/locale/id-ID.tsindex c35cac8805..7029272b58 100644--- a/packages/design/src/locale/id-ID.ts+++ b/packages/design/src/locale/id-ID.ts@@ -42,6 +42,12 @@ const locale: typeof enUS = {'Nov','Des',],+ ariaLabels: {+ previousMonth: 'Bulan sebelumnya',+ nextMonth: 'Bulan berikutnya',+ selectYear: 'Pilih tahun',+ selectMonth: 'Pilih bulan',+ },},Select: {empty: 'Tidak ada',diff --git a/packages/design/src/locale/it-IT.ts b/packages/design/src/locale/it-IT.tsindex 4aae4f24b8..832f55322a 100644--- a/packages/design/src/locale/it-IT.ts+++ b/packages/design/src/locale/it-IT.ts@@ -42,6 +42,12 @@ const locale: typeof enUS = {'Nov','Dic',],+ ariaLabels: {+ previousMonth: 'Mese precedente',+ nextMonth: 'Mese successivo',+ selectYear: 'Seleziona anno',+ selectMonth: 'Seleziona mese',+ },},Select: {empty: 'Nessuno',diff --git a/packages/design/src/locale/ja-JP.ts b/packages/design/src/locale/ja-JP.tsindex 6d95c02aa0..45113e0c06 100644--- a/packages/design/src/locale/ja-JP.ts+++ b/packages/design/src/locale/ja-JP.ts@@ -42,6 +42,12 @@ const locale: typeof enUS = {'11月','12月',],+ ariaLabels: {+ previousMonth: '前の月',+ nextMonth: '次の月',+ selectYear: '年を選択',+ selectMonth: '月を選択',+ },},Select: {empty: '該当なし',diff --git a/packages/design/src/locale/ko-KR.ts b/packages/design/src/locale/ko-KR.tsindex ff1039e986..e3e0ee0662 100644--- a/packages/design/src/locale/ko-KR.ts+++ b/packages/design/src/locale/ko-KR.ts@@ -42,6 +42,12 @@ const locale: typeof enUS = {'11월','12월',],+ ariaLabels: {+ previousMonth: '이전 달',+ nextMonth: '다음 달',+ selectYear: '연도 선택',+ selectMonth: '월 선택',+ },},Select: {empty: '없음',diff --git a/packages/design/src/locale/pl-PL.ts b/packages/design/src/locale/pl-PL.tsindex 159adbe4e0..0f3efb0d1c 100644--- a/packages/design/src/locale/pl-PL.ts+++ b/packages/design/src/locale/pl-PL.ts@@ -42,6 +42,12 @@ const locale: typeof enUS = {'lis','gru',],+ ariaLabels: {+ previousMonth: 'Poprzedni miesiąc',+ nextMonth: 'Następny miesiąc',+ selectYear: 'Wybierz rok',+ selectMonth: 'Wybierz miesiąc',+ },},Select: {empty: 'Brak',diff --git a/packages/design/src/locale/pt-BR.ts b/packages/design/src/locale/pt-BR.tsindex fd0904d162..c9e97c044a 100644--- a/packages/design/src/locale/pt-BR.ts+++ b/packages/design/src/locale/pt-BR.ts@@ -42,6 +42,12 @@ const locale: typeof enUS = {'Nov','Dez',],+ ariaLabels: {+ previousMonth: 'Mês anterior',+ nextMonth: 'Próximo mês',+ selectYear: 'Selecionar ano',+ selectMonth: 'Selecionar mês',+ },},Select: {empty: 'Nenhum',diff --git a/packages/design/src/locale/ru-RU.ts b/packages/design/src/locale/ru-RU.tsindex 555556f1dc..efaa1d95ed 100644--- a/packages/design/src/locale/ru-RU.ts+++ b/packages/design/src/locale/ru-RU.ts@@ -45,6 +45,12 @@ const locale: typeof enUS = {'Ноябрь','Декабрь',],+ ariaLabels: {+ previousMonth: 'Предыдущий месяц',+ nextMonth: 'Следующий месяц',+ selectYear: 'Выбрать год',+ selectMonth: 'Выбрать месяц',+ },},ColorPicker: {more: 'Больше цветов',diff --git a/packages/design/src/locale/sk-SK.ts b/packages/design/src/locale/sk-SK.tsindex 80638f278f..fb2ac583d0 100644--- a/packages/design/src/locale/sk-SK.ts+++ b/packages/design/src/locale/sk-SK.ts@@ -42,6 +42,12 @@ const locale: typeof enUS = {'Nov','Dec',],+ ariaLabels: {+ previousMonth: 'Predchádzajúci mesiac',+ nextMonth: 'Nasledujúci mesiac',+ selectYear: 'Vybrať rok',+ selectMonth: 'Vybrať mesiac',+ },},Select: {empty: 'Žiadne',diff --git a/packages/design/src/locale/vi-VN.ts b/packages/design/src/locale/vi-VN.tsindex 685d50b94e..06d44a17bd 100644--- a/packages/design/src/locale/vi-VN.ts+++ b/packages/design/src/locale/vi-VN.ts@@ -42,6 +42,12 @@ const locale: typeof enUS = {'Tháng 11','Tháng 12',],+ ariaLabels: {+ previousMonth: 'Tháng trước',+ nextMonth: 'Tháng sau',+ selectYear: 'Chọn năm',+ selectMonth: 'Chọn tháng',+ },},Select: {empty: 'Không có',diff --git a/packages/design/src/locale/zh-CN.ts b/packages/design/src/locale/zh-CN.tsindex 3f65b8b497..98089ad542 100644--- a/packages/design/src/locale/zh-CN.ts+++ b/packages/design/src/locale/zh-CN.ts@@ -42,6 +42,12 @@ const locale: typeof enUS = {'十一月','十二月',],+ ariaLabels: {+ previousMonth: '上个月',+ nextMonth: '下个月',+ selectYear: '选择年份',+ selectMonth: '选择月份',+ },},Select: {empty: '无',diff --git a/packages/design/src/locale/zh-HK.ts b/packages/design/src/locale/zh-HK.tsindex e3c8a88e0c..1d8cdacfe2 100644--- a/packages/design/src/locale/zh-HK.ts+++ b/packages/design/src/locale/zh-HK.ts@@ -42,6 +42,12 @@ const locale: typeof enUS = {'十一月','十二月',],+ ariaLabels: {+ previousMonth: '上一個月',+ nextMonth: '下一個月',+ selectYear: '選擇年份',+ selectMonth: '選擇月份',+ },},Select: {empty: '無',diff --git a/packages/design/src/locale/zh-TW.ts b/packages/design/src/locale/zh-TW.tsindex e3c8a88e0c..1d8cdacfe2 100644--- a/packages/design/src/locale/zh-TW.ts+++ b/packages/design/src/locale/zh-TW.ts@@ -42,6 +42,12 @@ const locale: typeof enUS = {'十一月','十二月',],+ ariaLabels: {+ previousMonth: '上一個月',+ nextMonth: '下一個月',+ selectYear: '選擇年份',+ selectMonth: '選擇月份',+ },},Select: {empty: '無',