shadcn-ui/ui 日期范围选择器中应用按钮的实现技巧

问题背景

在使用 shadcn-ui/ui 的日期范围选择器组件时，开发者经常需要实现一个"应用"按钮来确认日期选择。这个功能看似简单，但在实际实现过程中会遇到一些技术难点。

常见错误实现方式

许多开发者会直接使用 Calendar 组件的 footer 属性来添加应用按钮，代码如下：

<Calendar
  mode="range"
  selected={date}
  onSelect={setDate}
  footer={
    <div className="flex justify-end">
      <Button size="sm" variant="outline">Apply</Button>
    </div>
  }
/>

这种实现方式会导致按钮被渲染两次，因为 footer 属性实际上是 react-day-picker 库的一个特性，它会为每个日历视图都添加指定的页脚内容。

正确解决方案

正确的做法是在 PopoverContent 组件中添加按钮，而不是直接放在 Calendar 组件中。以下是完整的实现方案：

1. 首先需要维护两个状态：

   • 一个用于存储当前已确认的日期范围
   • 一个用于存储临时选择的日期范围

2. 实现应用和取消逻辑：

   • 应用时将临时日期同步到正式日期状态
   • 取消时重置临时日期为正式日期

3. 将按钮放置在 PopoverContent 底部，而不是 Calendar 内部

完整代码示例

import { useState } from "react"
import { format } from "date-fns"
import { DateRange } from "react-day-picker"
import { Button } from "@/components/ui/button"
import { Calendar } from "@/components/ui/calendar"
import { Popover, PopoverTrigger, PopoverContent } from "@/components/ui/popover"

export function DateRangePicker() {
  const [date, setDate] = useState<DateRange | undefined>()
  const [tempDate, setTempDate] = useState<DateRange | undefined>()
  const [isOpen, setIsOpen] = useState(false)

  const handleApply = () => {
    setDate(tempDate)
    setIsOpen(false)
  }

  const handleCancel = () => {
    setTempDate(date)
    setIsOpen(false)
  }

  return (
    <Popover open={isOpen} onOpenChange={setIsOpen}>
      <PopoverTrigger asChild>
        <Button variant="outline">
          {date?.from ? (
            date.to ? (
              <>
                {format(date.from, "LLL dd, y")} – {format(date.to, "LLL dd, y")}
              </>
            ) : (
              format(date.from, "LLL dd, y")
            )
          ) : (
            "Pick a date range"
          )}
        </Button>
      </PopoverTrigger>

      <PopoverContent className="w-auto p-0" align="start">
        <Calendar
          mode="range"
          selected={tempDate}
          onSelect={setTempDate}
          numberOfMonths={2}
          initialFocus
        />

        <div className="p-3 border-t border-border flex justify-end gap-2">
          <Button variant="outline" onClick={handleCancel}>
            Cancel
          </Button>
          <Button onClick={handleApply}>
            Apply
          </Button>
        </div>
      </PopoverContent>
    </Popover>
  )
}

技术要点解析

1. 状态管理：使用两个独立的状态分别存储临时选择和已确认的日期范围，确保用户可以取消操作。

2. Popover控制：通过 isOpen 状态显式控制弹出层的显示/隐藏，确保日期选择完成后能正确关闭。

3. UI布局：将操作按钮放在 PopoverContent 底部，使用 border-t 添加顶部边框，与日历内容形成视觉分隔。

4. 日期格式化：使用 date-fns 的 format 函数将日期对象格式化为易读的字符串。

最佳实践建议

1. 对于需要确认操作的复杂表单组件，都应该考虑使用临时状态来存储用户输入。

2. 弹出层组件的内容布局应该保持简洁，将操作按钮放在底部是常见的UI模式。

3. 日期范围选择器应该清楚地显示当前选中的范围，格式化的日期字符串要易于理解。

4. 考虑添加键盘快捷键支持，比如按ESC键取消选择，Enter键确认选择。

通过这种实现方式，开发者可以构建出用户体验良好的日期范围选择器，既保留了原生组件的功能，又增加了确认操作的交互流程。