Matarialize中文技术社区-Material UI 框架之 Date Calendar 组件详解

Material UI 框架之 Date Calendar 组件详解

smartzeng 2024-10-25 22:20:33

207 Date Calendar 专栏

Material UI 的 Date Calendar 组件是一个独立的日历组件，适用于需要只显示日历而不需要输入字段的场景，例如选择器、事件视图、数据展示等。它提供了灵活的日期选择、显示范围控制、以及与其他组件的便捷集成。本文将深入介绍 Date Calendar 组件的使用，详细解析其所有属性和方法，结合多种示例帮助开发者理解其用法。

1. 基本用法

1.1 安装依赖

首先确保已安装 Material UI 的核心包以及日期选择器包：

npm install @mui/material @mui/x-date-pickers date-fns

1.2 引入和使用 Date Calendar 组件

基础用法示例：

import React, { useState } from 'react';
import { LocalizationProvider } from '@mui/x-date-pickers/LocalizationProvider';
import { DateCalendar } from '@mui/x-date-pickers/DateCalendar';
import { AdapterDateFns } from '@mui/x-date-pickers/AdapterDateFns';

export default function BasicDateCalendar() {
  const [selectedDate, setSelectedDate] = useState(null);

  return (
    <LocalizationProvider dateAdapter={AdapterDateFns}>
      <DateCalendar
        value={selectedDate}
        onChange={(newValue) => setSelectedDate(newValue)}
      />
    </LocalizationProvider>
  );
}

在这个基本示例中：

LocalizationProvider 提供了日期库的适配器，这里使用 AdapterDateFns 来支持 date-fns。
DateCalendar 组件显示日历，并允许用户选择日期，选中的日期通过 value 和 onChange 属性进行管理。

2. 主要属性详解

2.1 `value` 和 `onChange`

value：当前选中的日期，通常是 Date 对象或 null。
onChange：当用户选择日期时的回调函数，接收新的日期值作为参数。

<DateCalendar
  value={selectedDate}
  onChange={(newValue) => setSelectedDate(newValue)}
/>

通过这些属性，你可以控制和监听用户的日期选择行为。

2.2 `minDate` 和 `maxDate`

minDate：限制用户可选择的最小日期。
maxDate：限制用户可选择的最大日期。

<DateCalendar
  value={selectedDate}
  onChange={(newValue) => setSelectedDate(newValue)}
  minDate={new Date('2023-01-01')}
  maxDate={new Date('2023-12-31')}
/>

在此示例中，用户只能选择 2023 年范围内的日期。

2.3 `disablePast` 和 `disableFuture`

disablePast：禁用所有过去的日期。
disableFuture：禁用所有未来的日期。

<DateCalendar
  value={selectedDate}
  onChange={(newValue) => setSelectedDate(newValue)}
  disablePast
/>

设置 disablePast 可以限制用户只能选择当前日期及未来日期。

2.4 `shouldDisableDate`

shouldDisableDate：自定义禁用某些特定日期的函数，返回 true 即禁用该日期。

<DateCalendar
  value={selectedDate}
  onChange={(newValue) => setSelectedDate(newValue)}
  shouldDisableDate={(date) => date.getDay() === 0 || date.getDay() === 6} // 禁用周末
/>

在该示例中，shouldDisableDate 禁用了所有周末日期，适用于限制工作日选择的场景。

2.5 `defaultCalendarMonth`

defaultCalendarMonth：设置日历默认显示的月份。

<DateCalendar
  value={selectedDate}
  onChange={(newValue) => setSelectedDate(newValue)}
  defaultCalendarMonth={new Date('2023-06-01')}
/>

此示例中，日历会默认显示 2023 年 6 月。

2.6 `disableHighlightToday`

disableHighlightToday：禁用高亮显示当前日期。

<DateCalendar
  value={selectedDate}
  onChange={(newValue) => setSelectedDate(newValue)}
  disableHighlightToday
/>

通过设置 disableHighlightToday，可以取消当前日期的高亮效果。

3. 高级用法：国际化和自定义适配器

3.1 国际化支持

通过 LocalizationProvider 的 locale 属性可以实现日期显示的国际化。以下示例将 DateCalendar 设置为中文：

import { zhCN } from 'date-fns/locale';

export default function ChineseDateCalendar() {
  const [selectedDate, setSelectedDate] = useState(null);

  return (
    <LocalizationProvider dateAdapter={AdapterDateFns} locale={zhCN}>
      <DateCalendar
        value={selectedDate}
        onChange={(newValue) => setSelectedDate(newValue)}
      />
    </LocalizationProvider>
  );
}

此示例中，DateCalendar 会显示为中文格式，更适合中文用户的需求。

3.2 使用 Moment.js 适配器

可以使用 Moment.js 作为日期库适配器：

import { AdapterMoment } from '@mui/x-date-pickers/AdapterMoment';

export default function MomentDateCalendar() {
  const [selectedDate, setSelectedDate] = useState(null);

  return (
    <LocalizationProvider dateAdapter={AdapterMoment}>
      <DateCalendar
        value={selectedDate}
        onChange={(newValue) => setSelectedDate(newValue)}
      />
    </LocalizationProvider>
  );
}

4. 结合其他组件的使用

4.1 与表单组合

DateCalendar 可以与其他表单组件一起使用。以下是一个简单的表单示例：

import { Button, TextField } from '@mui/material';

export default function DateCalendarForm() {
  const [selectedDate, setSelectedDate] = useState(null);

  const handleSubmit = (event) => {
    event.preventDefault();
    alert(`Selected Date: ${selectedDate}`);
  };

  return (
    <form onSubmit={handleSubmit}>
      <LocalizationProvider dateAdapter={AdapterDateFns}>
        <DateCalendar
          value={selectedDate}
          onChange={(newValue) => setSelectedDate(newValue)}
        />
      </LocalizationProvider>
      <Button type="submit" variant="contained" color="primary">
        Submit
      </Button>
    </form>
  );
}

此示例中，DateCalendar 作为表单中的一个字段，与 Button 提交按钮一起构成表单布局。

4.2 与 Grid 布局结合

结合 Grid 布局组件，可以创建响应式布局：

import Grid from '@mui/material/Grid';

export default function DateCalendarWithGrid() {
  const [startDate, setStartDate] = useState(null);
  const [endDate, setEndDate] = useState(null);

  return (
    <LocalizationProvider dateAdapter={AdapterDateFns}>
      <Grid container spacing={2}>
        <Grid item xs={6}>
          <DateCalendar
            value={startDate}
            onChange={(newValue) => setStartDate(newValue)}
            label="开始日期"
          />
        </Grid>
        <Grid item xs={6}>
          <DateCalendar
            value={endDate}
            onChange={(newValue) => setEndDate(newValue)}
            label="结束日期"
          />
        </Grid>
      </Grid>
    </LocalizationProvider>
  );
}

在此示例中，通过 Grid 布局，将两个 DateCalendar 组件并列展示，方便选择日期范围。

5. 事件监听与回调

DateCalendar 支持多种事件监听与回调函数，可用于增强用户交互体验。

5.1 `onMonthChange`

当用户切换月份时触发的回调函数：

<DateCalendar
  value={selectedDate}
  onChange={(newValue) => setSelectedDate(newValue)}
  onMonthChange={(newMonth) => console.log("月份已变更:", newMonth)}
/>

5.2 `onYearChange`

当用户切换年份时触发的回调函数：

<DateCalendar
  value={selectedDate}
  onChange={(newValue) => setSelectedDate(newValue)}
  onYearChange={(newYear) => console.log("年份已变更:", newYear)}
/>