TOAST UI Calendar 入门指南：从安装到基础应用

TOAST UI Calendar 入门指南：从安装到基础应用

tui.calendar 🍞📅A JavaScript calendar that has everything you need. 项目地址: https://gitcode.com/gh_mirrors/tu/tui.calendar

前言

TOAST UI Calendar 是一款功能强大的 JavaScript 日历组件，提供了丰富的日程管理功能和高度可定制化的界面。本文将详细介绍如何从零开始使用 TOAST UI Calendar，包括安装方法、基本配置以及核心功能的使用。

安装方式

1. 包管理器安装（推荐）

使用 npm 进行安装是最简单的方式：

npm install @toast-ui/calendar

安装完成后，可以通过以下方式引入：

// ES6 模块
import Calendar from '@toast-ui/calendar';

// CommonJS
const Calendar = require('@toast-ui/calendar');

2. CDN 引入

对于快速原型开发或简单项目，可以直接通过 CDN 引入：

<link rel="stylesheet" href="https://uicdn.toast.com/calendar/latest/toastui-calendar.min.css" />
<script src="https://uicdn.toast.com/calendar/latest/toastui-calendar.min.js"></script>

3. 源码下载

如果需要特定版本或进行定制开发，可以直接下载源码文件。

基本使用

HTML 结构准备

首先需要准备一个容器元素，建议设置最小高度为 600px：

<div id="calendar" style="height: 600px;"></div>

CSS 引入

确保引入必要的样式文件：

import '@toast-ui/calendar/dist/toastui-calendar.min.css';

初始化日历实例

创建日历实例需要两个参数：容器元素和配置选项。

const calendar = new Calendar('#calendar', {
  defaultView: 'week',  // 默认视图类型
  timezone: {
    zones: [
      {
        timezoneName: 'Asia/Shanghai',
        displayLabel: '上海'
      }
    ]
  },
  calendars: [  // 日历分类
    {
      id: 'personal',
      name: '个人',
      backgroundColor: '#03bd9e'
    }
  ]
});

核心功能详解

1. 日程管理

创建日程非常简单：

calendar.createEvents([
  {
    id: 'meeting-1',
    calendarId: 'work',
    title: '项目会议',
    start: '2023-07-15T14:00:00',
    end: '2023-07-15T15:30:00'
  }
]);

2. 弹出窗口功能

TOAST UI Calendar 提供了内置的日程创建和详情弹出窗口：

// 启用弹出窗口功能
calendar.setOptions({
  useFormPopup: true,    // 日程创建表单
  useDetailPopup: true   // 日程详情查看
});

注意：使用表单弹出窗口需要额外引入日期和时间选择器的 CSS：

import 'tui-date-picker/dist/tui-date-picker.css';
import 'tui-time-picker/dist/tui-time-picker.css';

3. 主题定制

可以通过主题系统自定义日历外观：

calendar.setTheme({
  week: {
    dayGrid: {
      backgroundColor: '#f9f9f9'
    }
  }
});

4. 模板定制

对于需要高度自定义显示的场景，可以使用模板功能：

calendar.setOptions({
  template: {
    time(event) {
      return `<strong>${event.title}</strong>`;
    }
  }
});

5. 事件处理

日历组件提供了丰富的事件系统：

calendar.on('clickEvent', ({ event }) => {
  console.log('点击了日程:', event.title);
});

进阶配置

时区支持

TOAST UI Calendar 支持多时区显示：

timezone: {
  zones: [
    { timezoneName: 'Asia/Shanghai', displayLabel: '上海' },
    { timezoneName: 'America/New_York', displayLabel: '纽约' }
  ]
}

禁用统计收集

默认情况下，组件会收集基本使用统计（仅主机名）。如需禁用：

const calendar = new Calendar('#calendar', {
  usageStatistics: false
});

兼容性说明

对于需要支持 IE11 等老旧浏览器的情况，需要使用特殊版本：

import Calendar from '@toast-ui/calendar/ie11';

结语

TOAST UI Calendar 提供了从简单到复杂的全方位日程管理解决方案。通过本文介绍的基础功能，开发者可以快速构建出功能完善的日历应用。对于更高级的功能和详细配置，建议参考官方文档深入探索。

记住，良好的日历应用不仅需要技术实现，更需要考虑用户体验。合理利用 TOAST UI Calendar 提供的定制功能，可以打造出既美观又实用的日程管理系统。

tui.calendar 🍞📅A JavaScript calendar that has everything you need. 项目地址: https://gitcode.com/gh_mirrors/tu/tui.calendar