Typescript declarations

[jonastahl]

Hi,
started working on a typescript declaration file.
Wanted to use this discussion to ask about small impurities I found/will find, without opening an Issue for everything.

Starting of with the props disableDays and selectedDate.
Both of them are supposed to take Strings and Dates according to the props definition file.
Can the string only have the format 'YYYY-MM-DD'? (Would be nice for typing)
Passing a Date don't seem to work for me for both of them. Is this wanted behaviour?

The general idea is still to leave the core library in JavaScript, right?
(If you intend moving to TypeScript, I would currently have spare time to help you converting if wished.)

(Aand the documenation does not work currently)

[antoniandre]

Hi @jonastahl, great to hear that you're starting the type definitions!
First off, what do mean by the documentation does not work currently?

Isn't it working for you at https://antoniandre.github.io/vue-cal ?

Could it be a caching issue?

---

Regarding TS, let's first answer about the intention, then I'll update the code to align with it :)

• both disableDays and selectedDate accept both JS Date and formatted dates as exactly "YYYY-MM-DD".
• the core library will stay in JavaScript

Cheers!

[antoniandre]

• disableDays now accepts both JS dates, and formatted dates like "YYYY-MM-DD".
• selectedDate and viewDate were already accepting both correctly
• Note that unlike in v4, the selectedDate is different from the viewDate, which allows more scenarios :)

[jonastahl]

Hi @jonastahl, great to hear that you're starting the type definitions! First off, what do mean by the documentation does not work currently?

Isn't it working for you at https://antoniandre.github.io/vue-cal ?

I see only tested it in Firefox (Desktop & Mobile). Here the site seems get stuck in some infinite loop and does not fully load. (Only on the Home page)
But it works in Chromium

[jonastahl]

• transitions does it work?
• weekNumbers accepts Boolean and String. What's meant by String?
• timeFormat does not seem to do anything

[antoniandre]

• I deleted the transitions prop and moved it to a CSS var (you can try it in the last example of the exemples > view section)
• weekNumbers should only accept Boolean, I corrected it.

I'll release the doc and a new version soon, but for now the latest code is pushed in main, if you run the doc locally you'll have it.

Thanks for your feedback, it helps me review some aspects that could be improved 👍

[jonastahl]

@event-dropped: in my test it returns event and originalEvent. In the documentation is event, oldDate, newDate, oldSchedule, newSchedule
Whats the intended behaviour?

[antoniandre]

Everything was released a few days ago, but I am continuously improving the documentation for accuracy and fixing bugs.

[jonastahl]

@antoniandre Is there a reason why @view-change does not emit a Vue Cal View object?

And a small type difference, in both objects Vue Cal View and the one emitted by @view-change:
events is not an array, but an Object with Date String -> event[]

[xontik]

Hi ! @jonastahl do you have some early version of this types definitions ?

[jonastahl]

Yes, I have an early version. I haven't looked into it for a while due to time issues.
You can find the file here: https://github.com/jonastahl/vue-cal/blob/main/src/types/vue-cal.d.ts
For props it worked, but the Vue Typescript documentation for Slots and Emits is quite bad. Also the Jetbrains VueJs Plugin actually gives worse auto-completion when working with it. This all made it a bit frustrating to work on it.

Nevertheless i gonna look into it again in 2 or 3 weeks. Feel free to reach out to me how well it works for you currently :)

[xontik]

Works alright for me thanks for the hardwork, here a PR for dates types : jonastahl#1

[antoniandre]

Great work @jonastahl! And nice addition @xontik! :)
Thanks guys, this is a great start for TS support! And we can always improve and maintain later :)
Now released in RC 33.