# tui.calendar
**Repository Path**: strongandyzhang/tui.calendar
## Basic Information
- **Project Name**: tui.calendar
- **Description**: A JavaScript calendar that has everything you need.
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 1
- **Created**: 2020-02-20
- **Last Updated**: 2024-01-30
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# 
> A JavaScript schedule calendar that is full featured. Now your service just got the customizable calendar.
[](https://github.com/nhnent/tui.calendar/releases/latest)
[](https://www.npmjs.com/package/tui-calendar)
[](https://github.com/nhnent/tui.calendar/blob/master/LICENSE)
[](https://github.com/nhnent/tui.project-name/labels/help%20wanted)
[](https://github.com/nhnent)
## Wrappers
* [toast-ui.vue-calendar](https://github.com/nhnent/toast-ui.vue-calendar) **Vue** wrapper component is implemented by NHN Entertainment. Thanks to [@sohee-lee7](https://github.com/sohee-lee7).
* [ngx-tui-dev](https://github.com/brnrds/ngx-tui-dev): **TypeScript** and **Angular 5** wrapper component is being implemented(ref [#82](https://github.com/nhnent/tui.calendar/issues/82)) by [@amanvishnani](https://github.com/amanvishnani) and [@brnrds](https://github.com/brnrds). Thanks for their effort.
* [vue-tui-calendar](https://github.com/lkmadushan/vue-tuicalendar): **Vue** wrapper component is being implemented(ref [#81](https://github.com/nhnent/tui.calendar/issues/81)) by [@lkmadushan](https://github.com/lkmadushan). Thanks for their effort.
* [tui-calendar-react](https://github.com/IniZio/react-tui-calendar): **React** wrapper component is provided(ref #[134](https://github.com/nhnent/tui.calendar/issues/134)) by [@IniZio](https://github.com/IniZio). Thanks for his effort.
## 🚩 Table of Contents
* [Collect statistics on the use of open source](#Collect-statistics-on-the-use-of-open-source)
* [Browser Support](#-browser-support)
* [How Cool: Monthly, Weekly, Daily and Various View Types.](#how-cool-monthly-weekly-daily-and-various-view-types)
* [Easy to Use: Dragging and Resizing a Schedule](#easy-to-use-dragging-and-resizing-a-schedule)
* [Ready to Use: Default Popups](#ready-to-use-default-popups)
* [Features](#-features)
* [Examples](#-examples)
* [Install](#-install)
* [Via Package Manager](#via-package-manager)
* [Via Contents Delivery Network (CDN)](#via-contents-delivery-network-cdn)
* [Download Source Files](#download-source-files)
* [Usage](#-usage)
* [HTML](#html)
* [JavaScript](#javascript)
* [Pull Request Steps](#-pull-request-steps)
* [Setup](#setup)
* [Develop](#develop)
* [Pull Request Steps](#pull-request)
* [Documents](#-documents)
* [Contributing](#-contributing)
* [Dependency](#-dependency)
* [TOAST UI Family](#-toast-ui-family)
* [Used By](#-used-by)
* [License](#-license)
## 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, include tui-code-snippet.js and then immediately write the options as follows:
```js
tui.usageStatistics = false;
```
## 🌏 Browser Support
| 
Chrome | 
Internet Explorer | 
Edge | 
Safari | 
Firefox |
| :---------: | :---------: | :---------: | :---------: | :---------: |
| Yes | +9 | Yes | Yes | Yes |
## How Cool: Monthly, Weekly, Daily and Various View Types.
| Monthly | Weekly |
| --- | --- |
|  |  |
| Daily | 2 Weeks |
| --- | --- |
|  |  |
## Easy to Use: Dragging and Resizing a Schedule
| Dragging | Resizing |
| --- | --- |
|  |  |
## Ready to Use: Default Popups
| Creation Popup | Detail Popup |
| --- | --- |
|  |  |
## 🎨 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](https://nhnent.github.io/tui.calendar/latest/tutorial-example01-basic.html) : 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](https://www.npmjs.com/) and [bower](https://bower.io/).
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](https://nodejs.org) is installed.
#### npm
``` sh
$ npm install --save tui-calendar # Latest version
$ npm install --save tui-calendar@ # Specific version
```
#### bower
``` sh
$ bower install tui-calendar # Latest version
$ bower install tui-calendar# # Specific version
```
### Via Contents Delivery Network (CDN)
TOAST UI products are available over the CDN powered by [TOAST Cloud](https://www.toast.com).
You can use the CDN as below.
```html
```
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
* [Download bundle files](https://github.com/nhnent/tui.calendar/tree/master/dist)
* [Download all sources for each version](https://github.com/nhnent/tui.calendar/releases)
## 🔨 Usage
### HTML
Place a `` where you want TOAST UI Calendar rendered.
```html
...
...
```
### JavaScript
#### Using namespace in browser environment
```javascript
var Calendar = tui.Calendar;
```
#### Using module format in node environment
```javascript
var Calendar = require('tui-calendar'); /* CommonJS */
```
```javascript
import Calendar from 'tui-calendar'; /* ES6 */
```
Then you can create a calendar instance with [options](https://nhnent.github.io/tui.calendar/latest/global.html#Options) to set configuration.
```javascript
var calendar = new Calendar('#calendar', {
defaultView: 'month',
taskView: true,
template: {
monthGridHeader: function(model) {
var date = new Date(model.date);
var template = '' + date.getDate() + '';
return template;
}
}
});
```
Or you can use jquery plugin. You must include jquery before using this jquery plugin.
```js
$('#calendar').tuiCalendar({
defaultView: 'month',
taskView: true,
template: {
monthGridHeader: function(model) {
var date = new Date(model.date);
var template = '' + date.getDate() + '';
return template;
}
}
});
```
## 🔧 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.
``` sh
$ 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
``` sh
$ npm run serve
```
#### Run karma test
``` sh
$ 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.
## 📙 Documents
* [Getting Started](https://github.com/nhnent/tui.calendar/blob/master/docs/getting-started.md)
* [Tutorials](https://github.com/nhnent/tui.calendar/tree/master/docs)
* [APIs](https://nhnent.github.io/tui.calendar/latest/Calendar.html)
You can also see the older versions of API page on the [releases page](https://github.com/nhnent/tui.calendar/releases).
## 💬 Contributing
* [Code of Conduct](https://github.com/nhnent/tui.calendar/blob/master/CODE_OF_CONDUCT.md)
* [Contributing guideline](https://github.com/nhnent/tui.calendar/blob/master/CONTRIBUTING.md)
* [Issue guideline](https://github.com/nhnent/tui.calendar/blob/master/docs/ISSUE_TEMPLATE.md)
* [Commit convention](https://github.com/nhnent/tui.calendar/blob/master/docs/COMMIT_MESSAGE_CONVENTION.md)
## 🔩 Dependency
* [tui-code-snippet](https://github.com/nhnent/tui.code-snippet) >= 1.5.0
* [tui-date-picker](https://github.com/nhnent/tui.date-picker) >= 3.0.0 is optional.
* [tui-time-picker](https://github.com/nhnent/tui.time-picker) >= 1.0.0 is optional.
## 🍞 TOAST UI Family
* [TOAST UI Grid](https://github.com/nhnent/tui.grid)
* [TOAST UI Chart](https://github.com/nhnent/tui.chart)
* [TOAST UI Editor](https://github.com/nhnent/tui.editor)
* [TOAST UI Components](https://github.com/nhnent?q=tui)
## 🚀 Used By
* [TOAST Dooray! - Collaboration Service (Project, Messenger, Mail, Calendar, Drive, Wiki, Contacts)](https://dooray.com)
* [NCP - Commerce Platform](https://www.e-ncp.com/)
## 📜 License
This software is licensed under the [MIT](https://github.com/nhnent/tui.calendar/blob/master/LICENSE) © [NHN Entertainment](https://github.com/nhnent).