v2.0.0-alpha.1

[adhrinae]

Announcing TOAST UI Calendar v2 🎉

We are happy to be able to show you a new TOAST UI Calendar.

This major update does not include many new features, but we have spent a lot of time rebuilding most of the applications for the modern JavaScript development environment. Thanks to this, we expect that implementing new features and debugging will be easier than the legacy codebase.

What's new

Rebuilt with Preact X

The previous version was written in Vanilla JS and targeted ES5 without Babel. While the codebase was getting bigger, it was getting harder to debug and understand it.

Also, the previous version cannot handle multiple instances in the same document because of its fundamental limitation coming from handlebars.js.

After a lengthy investigation and discussion, we made the decision to use Preact X as the core of the calendar, and rewrite the calendar with it. We expect that the future development with Preact will make us easier to bring new features and fix problems.

However, This changes browser compatibility. It can only support IE11+ though the previous version could support IE9+. And you need to use the separate bundle to support older browsers like IE11, which has a bigger size bundle (about 30% bigger than the normal bundle).

Document Enhancement

Even though All TOAST UI Products have powerful features, It has been hard to provide easy-to-understand and useful documents. As the same as other products,  TOAST UI Calendar needs to have more clear documents for users.

With this release, we wanted to give you better documentation, considering 'How can we make docs easier to read and easier to find what users want. At the very early stage of it, we wrote docs from the bottom and wrapped them using Storybook Docs.

Storybook Docs is only in the midway of this documentation journey. We will embrace other tools for making better documentation of all products in the long term.

⚠️ We wrote the Korean documentation first. For non-Korean speakers, Please be patient until we upload the English documentation as soon as possible.

(🚧 In Development) Server Side Rendering Support

We made progress that making the calendar supports server-side rendering. We hope this is helpful for users using TOAST UI Calendar for their modern frontend development environment.

But there is still room for improvement in this feature. It needs to be tested in the various frameworks or hand-made SSR environments, etc.

For more information, please refer to the renderToString method in the doc.

Others

• The term Schedule is changed to Event. [v2] Please consider using a different term instead of "schedule" #429
• Polished unclear option properties. For more information, check the Option documentation.
• You can now use the nested objects for setting the theme. For more information, check the Theme documentation.

Road to the public release

• We will fix any critical bugs and develop in-development features, and options as our first priority.
• The alpha release doesn't include React & Vue wrapper components. We are going to make them. You can make your own wrapper, though.

How to use the new version & Leaving feedback

You can now use the new calendar, installing the npm package to your project:

# Installing package
npm install @toast-ui/calendar@2.0.0-alpha.1

import Calendar from '@toast-ui/calendar';

const container = document.getElementById('calendar');
const calendar = new Calendar(container);

Please note that the alpha version has many pitfalls.

If you have any questions about the project, leave a question in the 'Q&A' of GitHub Discussion. (But maybe there's an answer in the documentation)

Or create an issue with 2.0 and Bug labels when you found a bug.

---

This discussion was created from the release v2.0.0-alpha.1.