# Calendar

URL: https://caijiao.org/dayjs/plugin/calendar
Source: docs/dayjs/plugin/calendar.md
Description: Calendar 插件增加了 .calendar API，返回一个显示日历时间的字符串。支持自定义显示格式，如同一天、下一天、上周等情境。

Calendar 增加了 `.calendar` API 返回一个 string 来显示日历时间。

```javascript
var calendar = require("dayjs/plugin/calendar");
dayjs.extend(calendar);

dayjs().calendar(dayjs("2008-01-01"));
dayjs().calendar(null, {
  sameDay: "[Today at] h:mm A", // The same day ( Today at 2:30 AM )
  nextDay: "[Tomorrow at] h:mm A", // The next day ( Tomorrow at 2:30 AM )
  nextWeek: "dddd [at] h:mm A", // The next week ( Sunday at 2:30 AM )
  lastDay: "[Yesterday at] h:mm A", // The day before ( Yesterday at 2:30 AM )
  lastWeek: "[Last] dddd [at] h:mm A", // Last week ( Last Monday at 2:30 AM )
  sameElse: "DD/MM/YYYY", // Everything else ( 17/10/2011 )
});
```