|
| 1 | +#  |
| 2 | + |
| 3 | +> 🍞📅 A JavaScript schedule calendar that is full featured. Now your service just got the customizable calendar. |
| 4 | +[](https://lerna.js.org/) |
| 5 | +[](https://github.com/nhn/tui.calendar/releases/latest) |
| 6 | +[](https://www.npmjs.com/package/tui-calendar) |
| 7 | +[](https://github.com/nhn/tui.calendar/blob/master/LICENSE) |
| 8 | +[](https://github.com/nhn/tui.project-name/labels/help%20wanted) |
| 9 | +[](https://github.com/nhn) |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | + |
| 14 | +## 📦 Packages |
| 15 | + |
| 16 | +The functionality of TOAST UI Calendar is available when using the Plain JavaScript, React, Vue Component. |
| 17 | + |
| 18 | +- [toast-ui.calendar](https://github.com/nhn/tui.calendar/tree/main/apps/calendar) - Plain JavaScript component implemented by NHN. |
| 19 | +- [toast-ui.vue-calendar](https://github.com/nhn/tui.calendar/tree/main/apps/vue-calendar) - **Vue** wrapper component implemented by NHN. |
| 20 | +- [toast-ui.react-calendar](https://github.com/nhn/tui.calendar/tree/main/apps/react-calendar) - **React** wrapper component implemented by NHN. |
| 21 | + |
| 22 | +## 📙 Documents |
| 23 | + |
| 24 | +* [Getting Started](https://github.com/nhn/tui.calendar/blob/master/docs/getting-started.md) |
| 25 | +* [Tutorials](https://github.com/nhn/tui.calendar/tree/master/docs) |
| 26 | +* [APIs](https://nhn.github.io/tui.calendar/latest/Calendar) |
| 27 | +- [Getting Started](https://github.com/nhn/tui.calendar/blob/main/docs/en/getting-started.md) |
| 28 | +- Tutorials |
| 29 | + - [English](https://github.com/nhn/tui.calendar/blob/main/docs/README.md) |
| 30 | + - [한국어](https://github.com/nhn/tui.calendar/blob/main/docs/ko/README.md) |
| 31 | +- [APIs](https://nhn.github.io/tui.calendar/latest/) |
| 32 | +- v2.0 Migration Guide |
| 33 | + - [English](https://github.com/nhn/tui.calendar/blob/main/docs/v2.0-migration-guide-en.md) |
| 34 | + - [한국어](https://github.com/nhn/tui.calendar/blob/main/docs/v2.0-migration-guide-ko.md) |
| 35 | + |
| 36 | + |
| 37 | +## 😍 Why TOAST UI Calendar? |
| 38 | +### ✨ How Cool: Monthly, Weekly, Daily and Various View Types. |
| 39 | + |
| 40 | +| Monthly | Weekly | |
| 41 | +| --- | --- | |
| 42 | +|  |  | |
| 43 | + |
| 44 | +| Daily | 2 Weeks | |
| 45 | +| --- | --- | |
| 46 | +|  |  | |
| 47 | + |
| 48 | +### Easy to Use: Dragging and Resizing a Schedule |
| 49 | + |
| 50 | +| Dragging | Resizing | |
| 51 | +| --- | --- | |
| 52 | +|  |  | |
| 53 | + |
| 54 | + |
| 55 | +## Ready to Use: Default Popups |
| 56 | + |
| 57 | +| Creation Popup | Detail Popup | |
| 58 | +| --- | --- | |
| 59 | +|  |  | |
| 60 | + |
| 61 | +## 🎨 Features |
| 62 | + |
| 63 | +* Supports various view types: daily, weekly, monthly(6 weeks, 2 weeks, 3 weeks) |
| 64 | +* Supports efficient management of milestone and task schedules |
| 65 | +* Supports the narrow width of weekend |
| 66 | +* Supports changing start day of week |
| 67 | +* Supports customizing the date and schedule information UI(including a header and a footer of grid cell) |
| 68 | +* Supports adjusting a schedule by mouse dragging |
| 69 | +* Supports customizing UI by theme |
| 70 | + |
| 71 | +## 🐾 Examples |
| 72 | + |
| 73 | +* [Basic](https://nhn.github.io/tui.calendar/latest/tutorial-example00-basic) : Example of using default options. |
| 74 | + |
| 75 | +Here are more [examples](https://nhn.github.io/tui.calendar/latest/tutorial-example00-basic) and play with TOAST UI Calendar! |
| 76 | + |
| 77 | +## 🔧 Pull Request Steps |
| 78 | + |
| 79 | +TOAST UI products are open source, so you can create a pull request(PR) after you fix issues. |
| 80 | +Run npm scripts and develop yourself with the following process. |
| 81 | + |
| 82 | +### Setup |
| 83 | + |
| 84 | +Fork `develop` branch into your personal repository. |
| 85 | +Clone it to local computer. Install node modules. |
| 86 | +Before starting development, you should check to haveany errors. |
| 87 | + |
| 88 | +``` sh |
| 89 | +$ git clone https://github.com/{owner}/tui.calendar.git |
| 90 | +$ cd tui.calendar |
| 91 | +$ npm install |
| 92 | +$ npm run test |
| 93 | +``` |
| 94 | + |
| 95 | +### Develop |
| 96 | + |
| 97 | +Let's start development! |
| 98 | +You can see your code is reflected as soon as you saving the codes by running a server. |
| 99 | +Don't miss adding test cases and then make green rights. |
| 100 | + |
| 101 | +#### Run webpack-dev-server |
| 102 | + |
| 103 | +``` sh |
| 104 | +$ npm run serve |
| 105 | +``` |
| 106 | + |
| 107 | +#### Run karma test |
| 108 | + |
| 109 | +``` sh |
| 110 | +$ npm run test |
| 111 | +``` |
| 112 | + |
| 113 | +### Pull Request |
| 114 | + |
| 115 | +Before PR, check to test lastly and then check any errors. |
| 116 | +If it has no error, commit and then push it! |
| 117 | + |
| 118 | +For more information on PR's step, please see links of Contributing section. |
| 119 | + |
| 120 | +## 💬 Contributing |
| 121 | + |
| 122 | +* [Code of Conduct](https://github.com/nhn/tui.calendar/blob/master/CODE_OF_CONDUCT.md) |
| 123 | +* [Contributing guideline](https://github.com/nhn/tui.calendar/blob/master/CONTRIBUTING.md) |
| 124 | +* [Issue guideline](https://github.com/nhn/tui.calendar/blob/master/docs/ISSUE_TEMPLATE.md) |
| 125 | +* [Commit convention](https://github.com/nhn/tui.calendar/blob/main/docs/COMMIT_MESSAGE_CONVENTION.md) |
| 126 | + |
| 127 | +## 🌏 Browser Support |
| 128 | +| <img src="https://user-images.githubusercontent.com/1215767/34348387-a2e64588-ea4d-11e7-8267-a43365103afe.png" alt="Chrome" width="16px" height="16px" /> Chrome | <img src="https://user-images.githubusercontent.com/1215767/34348590-250b3ca2-ea4f-11e7-9efb-da953359321f.png" alt="IE" width="16px" height="16px" /> Internet Explorer | <img src="https://user-images.githubusercontent.com/1215767/34348380-93e77ae8-ea4d-11e7-8696-9a989ddbbbf5.png" alt="Edge" width="16px" height="16px" /> Edge | <img src="https://user-images.githubusercontent.com/1215767/34348394-a981f892-ea4d-11e7-9156-d128d58386b9.png" alt="Safari" width="16px" height="16px" /> Safari | <img src="https://user-images.githubusercontent.com/1215767/34348383-9e7ed492-ea4d-11e7-910c-03b39d52f496.png" alt="Firefox" width="16px" height="16px" /> Firefox | |
| 129 | +| :---------: | :---------: | :---------: | :---------: | :---------: | |
| 130 | +| Latest | 9+ | Latest | Latest | Latest | |
| 131 | + |
| 132 | +## 🔩 Dependency |
| 133 | + |
| 134 | +* [tui-date-picker](https://github.com/nhn/tui.date-picker) >= 3.0.0 is optional. |
| 135 | +* [tui-time-picker](https://github.com/nhn/tui.time-picker) >= 1.0.0 is optional. |
| 136 | + |
| 137 | +## 🍞 TOAST UI Family |
| 138 | +* [TOAST UI Grid](https://github.com/nhn/tui.grid) |
| 139 | +* [TOAST UI Chart](https://github.com/nhn/tui.chart) |
| 140 | +* [TOAST UI Editor](https://github.com/nhn/tui.editor) |
| 141 | +* [TOAST UI Image-Editor](https://github.com/nhn/tui.image-editor) |
| 142 | +* [TOAST UI Components](https://github.com/nhn?q=tui) |
| 143 | + |
| 144 | +## 🚀 Used By |
| 145 | +* [TOAST Dooray! - Collaboration Service (Project, Messenger, Mail, Calendar, Drive, Wiki, Contacts)](https://dooray.com) |
| 146 | +* [NCP - Commerce Platform](https://www.e-ncp.com/) |
| 147 | +* [shopby](https://www.godo.co.kr/shopby/main.gd) |
| 148 | +* [payco-shopping](https://shopping.payco.com/) |
| 149 | +* [iamTeacher](https://teacher.iamservice.net) |
| 150 | +* [linder](https://www.linder.kr) |
| 151 | + |
| 152 | +## 📜 License |
| 153 | + |
| 154 | +This software is licensed under the [MIT](https://github.com/nhn/tui.calendar/blob/master/LICENSE) © [NHN](https://github.com/nhn). |
0 commit comments