https://github.com/distributive-network/tui-calendar.react-calendar
A fork of a React.js wrapper for ToastUI 's tui-calendar
https://github.com/distributive-network/tui-calendar.react-calendar
Last synced: 3 months ago
JSON representation
A fork of a React.js wrapper for ToastUI 's tui-calendar
- Host: GitHub
- URL: https://github.com/distributive-network/tui-calendar.react-calendar
- Owner: Distributive-Network
- License: mit
- Created: 2021-07-09T15:36:56.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-06-20T15:21:52.000Z (almost 3 years ago)
- Last Synced: 2025-01-10T19:47:54.780Z (4 months ago)
- Language: JavaScript
- Size: 451 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# TOAST UI Calendar for React
> This is a React component wrapping [TOAST UI Calendar](https://github.com/nhn/tui.calendar).
[](https://github.com/nhn/toast-ui.react-calendar/releases/latest)
[](https://www.npmjs.com/package/@toast-ui/react-calendar)
[](https://github.com/nhn/toast-ui.react-calendar/blob/master/LICENSE)
[](https://github.com/nhn/toast-ui.react-calendar/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
[](https://github.com/nhn)
## 🚩 Table of Contents
* [Collect statistics on the use of open source](#collect-statistics-on-the-use-of-open-source)
* [Install](#-install)
* [Using npm](#using-npm)
* [Usage](#-usage)
* [Import](#Import)
* [Props](#props)
* [Instance Methods](#Instance-Methods)
* [Getting the root element](#Getting-the-root-element)
* [Event](#event)
* [Pull Request Steps](#-pull-request-steps)
* [Documents](#-documents)
* [Contributing](#-contributing)
* [License](#-license)
## Collect statistics on the use of open source
React Wrapper of 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 `usageStatistics` props like the example below.
```js
```
Or, include `tui-code-snippet.js` (**v1.4.0** or **later**) and then immediately write the options as follows:
```js
tui.usageStatistics = false;
```
## 💾 Install
### Using npm
```sh
npm install --save @toast-ui/react-calendar
```
## 📊 Usage
We provide a [simple example](https://codesandbox.io/s/toast-uireact-calendar-82fi9) and you can start right away.
### Import
You can use Toast UI Calendar for React as a ECMAScript module or a CommonJS module. As this module does not contain CSS files, you should import `tui-calendar.css` from `tui-calendar/dist` manually.
* Using ECMAScript module
```js
import Calendar from '@toast-ui/react-calendar';
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';
```
* Using CommonJS module
```js
var Calendar = require('@toast-ui/react-calendar');
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');
```
### Props
We are supported in the form of props for [Options of TOAST UI Calendar](https://nhn.github.io/tui.calendar/latest/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.
```js
const myTheme = {
// Theme object to extends default dark theme.
};
const MyComponent = () => (
${
schedule.title
}`;
},
milestoneTitle() {
return 'Milestone';
},
allday(schedule) {
return `${schedule.title}`;
},
alldayTitle() {
return 'All Day';
}
}}
theme={myTheme}
timezones={[
{
timezoneOffset: 540,
displayLabel: 'GMT+09:00',
tooltip: 'Seoul'
},
{
timezoneOffset: -420,
displayLabel: 'GMT-08:00',
tooltip: 'Los Angeles'
}
]}
useDetailPopup
useCreationPopup
view={selectedView} // You can also set the `defaultView` option.
week={{
showTimezoneCollapseButton: true,
timezonesCollapsed: true
}}
/>
);
```
#### Theme
Write own theme object. [Link - See "themeConfig"](https://nhn.github.io/tui.calendar/latest/themeConfig)
### Instance Methods
For using [instance methods of TOAST UI Calendar](https://nhn.github.io/tui.calendar/latest/Calendar), first thing to do is creating Refs of wrapper component using [`createRef()`](https://reactjs.org/docs/refs-and-the-dom.html#creating-refs). But the wrapper component does not provide a way to call instance methods of TOAST UI Calendar directly. Instead, you can call `getInstance()` method of the wrapper component to get the instance, and call the methods on it.
```js
const calendarOptions = {
// sort of option properties.
};
class MyComponent extends React.Component {
calendarRef = React.createRef();
handleClickNextButton = () => {
const calendarInstance = this.calendarRef.current.getInstance();
calendarInstance.next();
};
render() {
return (
<>
Go next!
>
);
}
}
```
### Getting the root element
An instance of the wrapper component also provides a handy method for getting the root element. If you want to manipulate the root element directly, you can call `getRootElement` to get the element.
```js
class MyComponent extends React.Component {
calendarRef = React.createRef();
handleClickButton = () => {
this.calendarRef.current.getRootElement().classList.add('calendar-root');
};
render() {
return (
<>
Click!
>
);
}
}
```
### Event
[All the events of TOAST UI Calendar](https://nhn.github.io/tui.calendar/latest/Calendar#event-afterRenderSchedule) are supported in the form of `on[EventName]` props. The first letter of each event name should be capitalized. For example, for using `mousedown` event you can use `onMousedown` prop like the example below.
```js
class MyComponent extends React.Component {
handleClickDayname = (ev) => {
// view : week, day
console.group('onClickDayname');
console.log(ev.date);
console.groupEnd();
};
render() {
return (
);
}
}
```
## 🔧 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/{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](https://github.com/nhn/toast-ui.react-calendar/blob/master/CODE_OF_CONDUCT.md)
* [Contributing guideline](https://github.com/nhn/toast-ui.react-calendar/blob/master/CONTRIBUTING.md)
* [Commit convention](https://github.com/nhn/toast-ui.react-calendar/blob/master/docs/COMMIT_MESSAGE_CONVENTION.md)
## 📜 License
This software is licensed under the [MIT](./LICENSE) © [NHN.](https://github.com/nhn)