@toast-ui/calendar

A JavaScript calendar that is full featured. Now your service just got the customizable calendar.

🚩 Table of Contents

• 📙 Documents
• Collect statistics on the use of open source
• 💾 Install
  • Using npm
  • Via Contents Delivery Network (CDN)
  • Download Source Files
• 📅 Usage
  • Load
  • Implement
• 🔧 Pull Request Steps
  • Setup
  • Develop
  • Pull Request
• 💬 Contributing
• 📜 License

📙 Documents

• English
• Korean

Collect statistics on the use of open source

TOAST UI Calendar applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI Calendar is used throughout the world. It also serves as important index to determine the future course of projects. location.hostname (e.g. > “ui.toast.com") is to be collected and the sole purpose is nothing but to measure statistics on the usage.

To disable GA, set the usageStatistics option to false:

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

💾 Install

Using npm

npm install --save @toast-ui/calendar

Via Contents Delivery Network (CDN)

TOAST UI products are available over the CDN powered by NHN Cloud.

<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>

<!-- To get bundle file for legacy browser -->
<!-- <script src="https://uicdn.toast.com/calendar /latest/toastui-calendar.ie11.min.js"></script> -->

<!-- Import as es module -->
<!-- <script type="module" src="https:// uicdn.toast.com/calendar/latest/toastui-calendar.mjs"></script> -->

If you want to use a specific version, use the tag name instead of latest in the url's path.

The CDN directory has the following structure.

- uicdn.toast.com/
  ├─ calendar/
  │  ├─ latest
  │  │  ├─ toastui-calendar.css
  │  │  ├─ toastui-calendar.js
  │  │  ├─ toastui-calendar.min.css
  │  │  ├─ toastui-calendar.min.js
  │  │  ├─ toastui-calendar.ie11.js
  │  │  ├─ toastui-calendar.ie11.min.js
  │  │  │  toastui-calendar.mjs
  │  ├─ v2.0.0/

Download Source Files

• Download all sources for each version

📅 Usage

Load

TOAST UI Calendar can be instantiated through the constructor function. There are three ways to access the constructor function depending on the environment.

/* ES6 module in Node.js environment */
import Calendar from '@toast-ui/calendar';
import '@toast-ui/calendar/dist/toastui-calendar.min.css';

/* CommonJS in Node.js environment */
const Calendar = require('@toast-ui/calendar');
require('@toast-ui/calendar/dist/toastui-calendar.min.css');

/* in the browser environment namespace */
const Calendar = tui.Calendar;

Implement

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

const calendar = new Calendar('#calendar', {
  defaultView: 'week',
  template: {
    time(event) {
      const { start, end, title } = event;

      return `<span style="color: white;">${formatTime(start)}~${formatTime(end)} ${title}</span>`;
    },
    allday(event) {
      return `<span style="color: gray;">${event.title}</span>`;
    },
  },
  calendars: [
    {
      id: 'cal1',
      name: 'Personal',
      backgroundColor: '#03bd9e',
    },
    {
      id: 'cal2',
      name: 'Work',
      backgroundColor: '#00a9ff',
    },
  ],
});

🔧 Pull Request Steps

TOAST UI products are open source, so you can create a pull request(PR) after you fix issues. Run npm scripts and develop yourself with the following process.

Setup

Fork main branch into your personal repository. Clone it to local computer. Install node modules. Before starting development, you should check to have any errors.

git clone https://github.com/{your-personal-repo}/[[repo name]].git
cd [[repo name]]
npm install

Develop

Let's start development!

Pull Request

Before PR, check to test lastly and then check any errors. If it has no error, commit and then push it!

For more information on PR's step, please see links of Contributing section.

💬 Contributing

• Code of Conduct
• Contributing Guidelines
• Commit Message Convention

📜 License

This software is licensed under the MIT © NHN Cloud.