Skip to content
This repository has been archived by the owner on Jul 1, 2022. It is now read-only.

Commit

Permalink
1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jungeun-cho committed Jun 27, 2019
2 parents 4a012ef + b954b89 commit 50e3163
Show file tree
Hide file tree
Showing 9 changed files with 7,260 additions and 6,391 deletions.
38 changes: 20 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# TOAST UI Calendar for Vue

> This is Vue component wrapping [TOAST UI Calendar](https://github.com/nhnent/tui.calendar).
> This is Vue component wrapping [TOAST UI Calendar](https://github.com/nhn/tui.calendar).
[![vue2](https://img.shields.io/badge/vue-2.x-brightgreen.svg)](https://vuejs.org/)
[![github version](https://img.shields.io/github/release/nhnent/toast-ui.vue-calendar.svg)](https://github.com/nhnent/toast-ui.vue-calendar/releases/latest)
[![github version](https://img.shields.io/github/release/nhn/toast-ui.vue-calendar.svg)](https://github.com/nhn/toast-ui.vue-calendar/releases/latest)
[![npm version](https://img.shields.io/npm/v/@toast-ui/vue-calendar.svg)](https://www.npmjs.com/package/@toast-ui/vue-calendar)
[![license](https://img.shields.io/github/license/nhnent/toast-ui.vue-calendar.svg)](https://github.com/nhnent/toast-ui.vue-calendar/blob/master/LICENSE)
[![PRs welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg)](https://github.com/nhnent/toast-ui.vue-calendar/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
[![code with hearth by NHN](https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-NHN-ff1414.svg)](https://github.com/nhnent)
[![license](https://img.shields.io/github/license/nhn/toast-ui.vue-calendar.svg)](https://github.com/nhn/toast-ui.vue-calendar/blob/master/LICENSE)
[![PRs welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg)](https://github.com/nhn/toast-ui.vue-calendar/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
[![code with hearth by NHN](https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-NHN-ff1414.svg)](https://github.com/nhn)

## 🚩 Table of Contents
* [Collect statistics on the use of open source](#collect-statistics-on-the-use-of-open-source)
Expand Down Expand Up @@ -43,7 +43,7 @@ npm install --save @toast-ui/vue-calendar

### Load

You can use Toast UI Calendar for Vue as moudule format or namespace. Also you can use Single File Component (SFC of Vue). When using module format and SFC, you should load `tui-calendar.css` in the script.
You can use Toast UI Calendar for Vue as moudule format or namespace. Also you can use Single File Component (SFC of Vue). When using module format and SFC, you should load `tui-calendar.css` in the script.

* Using Ecmascript module

Expand Down Expand Up @@ -110,7 +110,7 @@ You can use Toast UI Calendar for Vue as moudule format or namespace. Also you c

### Props

We provide props for [Options of Toast UI Calendar](https://nhnent.github.io/tui.calendar/latest/global.html#Options). Each name of props is same options of Toast UI Calendar except `view` is for `defaultView` of option. Additionally you can set schedules using `schedules` of prop.
We provide props for [Options of Toast UI Calendar](https://nhn.github.io/tui.calendar/latest/global.html#Options). Each name of props is same options of Toast UI Calendar except `view` is for `defaultView` of option. Additionally you can set schedules using `schedules` of prop.

| Name | Type | Default | Reactive | Description |
| --- | --- | --- | --- | --- |
Expand All @@ -119,15 +119,17 @@ We provide props for [Options of Toast UI Calendar](https://nhnent.github.io/tui
| view | String | 'week' | O | View of calendar. There are three views, `day`, `week` and `month`. |
| taskView | Boolean, Array | true | O | Show the milestone and task in weekly, daily view. If set `true`, the milestone and task show. If you want to show only the milestone or task, set array like this: `['mileston']` or `['task']`. |
| scheduleView | Boolean, Array | true | O | Show the all day and time grid in weekly, daily view. If set `true`, the all day and time show. If you want to show only the all day or time, set array like this: `['allday']` or `['time']`.|
| theme | Object | {} | O | Customize theme. For more infomation about theme, see [ThemeConfig of Toast UI Calendar](https://nhnent.github.io/tui.calendar/latest/global.html#themeConfig). |
| week | Object | {} | O | Set more for the `week` and `day` view. For more infomation about week, see [WeekOptions of Toast UI Calendar](https://nhnent.github.io/tui.calendar/latest/global.html#WeekOptions). |
| month | Object | {} | O | Set more for the `month` view. For more infomation about month, see [MonthOptions of Toast UI Calendar](https://nhnent.github.io/tui.calendar/latest/global.html#MonthOptions). |
| timezones | Array | [] | O | Set multiple time zones. For more information about timezones, see [Timezone of Toast UI Calendar](https://nhnent.github.io/tui.calendar/latest/global.html#Timezone). |
| theme | Object | {} | O | Customize theme. For more infomation about theme, see [ThemeConfig of Toast UI Calendar](https://nhn.github.io/tui.calendar/latest/global.html#themeConfig). |
| week | Object | {} | O | Set more for the `week` and `day` view. For more infomation about week, see [WeekOptions of Toast UI Calendar](https://nhn.github.io/tui.calendar/latest/global.html#WeekOptions). |
| month | Object | {} | O | Set more for the `month` view. For more infomation about month, see [MonthOptions of Toast UI Calendar](https://nhn.github.io/tui.calendar/latest/global.html#MonthOptions). |
| timezones | Array | [] | O | Set multiple time zones. For more information about timezones, see [Timezone of Toast UI Calendar](https://nhn.github.io/tui.calendar/latest/global.html#Timezone). |
| disableDblClick | Boolean | false | O | Disable double click to create a schedule. |
| disableClick | Boolean | false | O | Whether to use mouse click events as defaults to create schedules. |
| isReadOnly | Boolean | false | O | Set read only mode. If `true`, a user can't create and modify any schedule. |
| template | Object | {} | X | Customize renderer. For more information about template, see [Template of Toast UI Calendar](https://nhnent.github.io/tui.calendar/latest/global.html#Template). |
| template | Object | {} | X | Customize renderer. For more information about template, see [Template of Toast UI Calendar](https://nhn.github.io/tui.calendar/latest/global.html#Template). |
| useCreationPopup | Boolean | true | X | Whether use default creation popup or not. |
| useDetailPopup | Boolean | true | X | Whether use default detail popup or not. |
| usageStatistics | Boolean | true | X | Whether send hostnames to Google Analytics or not. |
#### Example
Expand Down Expand Up @@ -248,7 +250,7 @@ export default {
* clickSchedule : Occurs when click a schedule.
* clickTimezonesCollapseBtn : Occurs when click timezones collapse button. This event works when `timezone` prop has multi timezones and `week` prop has `{ showTimezoneCollapseButton: true }`.
For more information such as the parameters of each event, see [Event of Toast UI Calendar](https://nhnent.github.io/tui.calendar/latest/Calendar.html).
For more information such as the parameters of each event, see [Event of Toast UI Calendar](https://nhn.github.io/tui.calendar/latest/Calendar.html).
#### Example
Expand Down Expand Up @@ -320,7 +322,7 @@ After then you can use methods through `this.$refs`. We provide `getRootElement`
* `invoke`
If you want to more manipulate the Calendar, you can use `invoke` method to call the method of Toast UI Calendar. First argument of `invoke` is name of the method and second argument is parameters of the method. To find out what kind of methods are available, see [method of Toast UI Calendar](https://nhnent.github.io/tui.calendar/latest/).
If you want to more manipulate the Calendar, you can use `invoke` method to call the method of Toast UI Calendar. First argument of `invoke` is name of the method and second argument is parameters of the method. To find out what kind of methods are available, see [method of Toast UI Calendar](https://nhn.github.io/tui.calendar/latest/).
```js
this.$refs.tuiCalendar.invoke('today');
Expand Down Expand Up @@ -355,9 +357,9 @@ 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](https://github.com/nhnent/toast-ui.vue-calendar/blob/master/CODE_OF_CONDUCT.md)
* [Contributing guideline](https://github.com/nhnent/toast-ui.vue-calendar/blob/master/CONTRIBUTING.md)
* [Commit convention](https://github.com/nhnent/toast-ui.vue-calendar/blob/master/docs/COMMIT_MESSAGE_CONVENTION.md)
* [Code of Conduct](https://github.com/nhn/toast-ui.vue-calendar/blob/master/CODE_OF_CONDUCT.md)
* [Contributing guideline](https://github.com/nhn/toast-ui.vue-calendar/blob/master/CONTRIBUTING.md)
* [Commit convention](https://github.com/nhn/toast-ui.vue-calendar/blob/master/docs/COMMIT_MESSAGE_CONVENTION.md)
## 📜 License
This software is licensed under the [MIT](./LICENSE) © [NHN.](https://github.com/nhnent)
This software is licensed under the [MIT](./LICENSE) © [NHN.](https://github.com/nhn)
2 changes: 1 addition & 1 deletion dist/toastui-vue-calendar.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 50e3163

Please sign in to comment.