Topic: API documentation for Angular Bootstrap calendar incorrect
In the "Angular Calendar - API" https://mdbootstrap.com/plugins/angular/full-calendar/#docsTabsAPI
Under the Outputs section, it lists the events you can hook up to - the examples of the last 3 listChanged, monthChanged, and weekChanged are incorrect. They list $event as the only parameter, except these 3 require more parameters (and of different types).
FREE CONSULTATION
Hire our experts to build a dedicated project. We'll analyze your business requirements, for free.
Status
Opened
Specification of the issue
- ForumUser: Free
- Premium support: No
- Technology: MDB Angular
- MDB Version: 10.0.0
- Device: NA
- Browser: NA
- OS: NA
- Provided sample code: No
- Provided link: Yes
Arkadiusz Idzikowski staff commented 3 years ago
Can you provide more details about the problem here? These events return an object, the code in this section is just an example of using the method that is standard for angular events.
TradesTek free commented 3 years ago
It's pretty much as stated - the API documentation is incorrect, if you follow the link
https://mdbootstrap.com/plugins/angular/full-calendar/#docsTabsAPI
you will see the example for monthChanged is (monthChanged)="onMonthChange($event)" but the onMonthChange event expects 3 parameters as per: EventEmitter<{index: number, month: string, year: number}>
There are 2 other identical mistakes in the same section.
It looks like simple overzealous copy pasting while generating the API doco.