Skip to content
πŸžπŸ“…A JavaScript calendar that has everything you need.
JavaScript HTML CSS TypeScript
Branch: master
Clone or download

Latest commit

Latest commit 7d3ea6b Feb 25, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist 1.12.11 Feb 5, 2020
docs docs: Removed the issue template that can be written in Korean Jan 29, 2020
examples chore: apply feedback Nov 4, 2019
src refactor: change accessable object's property to util.pick Feb 26, 2020
test chore: fix broken test case Feb 26, 2020
.agignore feat: use tui-full-calendar, demo to examples with additional testcase Jan 18, 2018
.eslintignore chore: apply eslint rule Feb 24, 2016
.eslintrc feat: add "expandable and collapsable" view type to allday panel(reso… Mar 22, 2018
.gitignore chore: add .gitignore static tuidoc Mar 8, 2019
.npmignore chore: Update .npmignore to remove unnecessary files for distribution May 15, 2018
CODE_OF_CONDUCT.md chore: change 'NHN Ent' to 'NHN' Apr 5, 2019
CONTRIBUTING.md chore: rename 'nhn' (#302) Apr 11, 2019
LICENSE chore: apply feedback Apr 5, 2019
README.md fix: resolve security vulnerabiliti for npm audit(fix #405) Sep 23, 2019
bower.json 1.12.11 Feb 5, 2020
demoConfigGenerator.js chore: create generator file for the storybook on the TOAST UI brand … May 16, 2019
index.d.ts 1.12.11 Feb 5, 2020
jsdoc.conf.json chore: rename 'nhn' (#302) Apr 11, 2019
karma.conf.js chore: update karma config for IE11 Sep 6, 2019
package-lock.json chore: update toast-ui.release-notes repository url Dec 30, 2019
package.json 1.12.11 Feb 5, 2020
tsBannerGenerator.js chore: change name TOAST UI Calendar Dec 18, 2018
tslint.json chore: fix any type (#255) Jan 11, 2019
tuidoc.config.json chore: rename 'nhn' (#302) Apr 11, 2019
webpack.config.js chore: Upgrade to Webpack 4 (close #147) Jun 29, 2018

README.md

TOAST UI Calendar

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

GitHub release npm GitHub license PRs welcome code with hearth by NHN

tui-calendar-demo-nhn-corp

🚩 Table of Contents

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 use the options:

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

πŸ“™ Documents

You can also see the older versions of API page on the releases page.

✨ How Cool: Monthly, Weekly, Daily and Various View Types.

Monthly Weekly
image image
Daily 2 Weeks
image image

Easy to Use: Dragging and Resizing a Schedule

Dragging Resizing
image image

Ready to Use: Default Popups

Creation Popup Detail Popup
image image

🎨 Features

  • Supports various view types: daily, weekly, monthly(6 weeks, 2 weeks, 3 weeks)
  • Supports efficient management of milestone and task schedules
  • Supports the narrow width of weekend
  • Supports changing start day of week
  • Supports customizing the date and schedule information UI(including a header and a footer of grid cell)
  • Supports adjusting a schedule by mouse dragging
  • Supports customizing UI by theme

🐾 Examples

  • Basic : Example of using default options.

πŸ’Ύ Install

TOAST UI products can be used by using the package manager or downloading the source directly. However, we highly recommend using the package manager.

Via Package Manager

TOAST UI products are registered in two package managers, npm and bower. You can conveniently install it using the commands provided by each package manager. When using npm, be sure to use it in the environment Node.js is installed.

npm

$ npm install --save tui-calendar # Latest version
$ npm install --save tui-calendar@<version> # Specific version

bower

$ bower install tui-calendar # Latest version
$ bower install tui-calendar#<tag> # Specific version

Via Contents Delivery Network (CDN)

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

You can use the CDN as below.

Insert style sheet files

<link rel="stylesheet" type="text/css" href="https://uicdn.toast.com/tui-calendar/latest/tui-calendar.css" />

<!-- If you use the default popups, use this. -->
<link rel="stylesheet" type="text/css" href="https://uicdn.toast.com/tui.date-picker/latest/tui-date-picker.css" />
<link rel="stylesheet" type="text/css" href="https://uicdn.toast.com/tui.time-picker/latest/tui-time-picker.css" />

Insert JavaScript file

<script src="https://uicdn.toast.com/tui.code-snippet/latest/tui-code-snippet.js"></script>
<script src="https://uicdn.toast.com/tui.dom/v3.0.0/tui-dom.js"></script>
<script src="https://uicdn.toast.com/tui.time-picker/latest/tui-time-picker.min.js"></script>
<script src="https://uicdn.toast.com/tui.date-picker/latest/tui-date-picker.min.js"></script>
<script src="https://uicdn.toast.com/tui-calendar/latest/tui-calendar.js"></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.

tui-calendar/
β”œβ”€ latest/
β”‚  β”œβ”€ tui-calendar.js
β”‚  └─ tui-calendar.min.js
β”‚  └─ tui-calendar.css
β”‚  └─ tui-calendar.min.css
β”œβ”€ v1.0.0/
β”‚  β”œβ”€ ...

Download Source Files

πŸ› Wrappers

πŸ”¨ Usage

HTML

Place a <div></div> where you want TOAST UI Calendar rendered.

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

JavaScript

Using namespace in browser environment

var Calendar = tui.Calendar;

Using module format in node environment

var Calendar = require('tui-calendar'); /* CommonJS */
require("tui-calendar/dist/tui-calendar.css");

// If you use the default popups, use this.
require("tui-date-picker/dist/tui-date-picker.css");
require("tui-time-picker/dist/tui-time-picker.css");
import Calendar from 'tui-calendar'; /* ES6 */
import "tui-calendar/dist/tui-calendar.css";

// If you use the default popups, use this.
import 'tui-date-picker/dist/tui-date-picker.css';
import 'tui-time-picker/dist/tui-time-picker.css';

Then you can create a calendar instance with options to set configuration.

var calendar = new Calendar('#calendar', {
  defaultView: 'month',
  taskView: true,
  template: {
    monthDayname: function(dayname) {
      return '<span class="calendar-week-dayname-name">' + dayname.label + '</span>';
    }
    ...
  }
});

Or you can use jquery plugin. You must include jquery before using this jquery plugin.

$('#calendar').tuiCalendar({
  defaultView: 'month',
  taskView: true,
  template: {
    monthDayname: function(dayname) {
      return '<span class="calendar-week-dayname-name">' + dayname.label + '</span>';
    }
    ...
  }
});

🌏 Browser Support

Chrome Chrome IE Internet Explorer Edge Edge Safari Safari Firefox Firefox
Yes +9 Yes Yes Yes

πŸ”§ 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 develop branch into your personal repository. Clone it to local computer. Install node modules. Before starting development, you should check to haveany errors.

$ git clone https://github.com/{owner}/tui.calendar.git
$ cd tui.calendar
$ npm install
$ npm run test

Develop

Let's start development! You can see your code is reflected as soon as you saving the codes by running a server. Don't miss adding test cases and then make green rights.

Run webpack-dev-server

$ npm run serve

Run karma test

$ npm run test

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

πŸ”© Dependency

🍞 TOAST UI Family

πŸš€ Used By

πŸ“œ License

This software is licensed under the MIT Β© NHN.

You can’t perform that action at this time.