chore: add JSDoc for custom events [skip ci]

vaadin · Dec 15, 2020 · 5a94f5b · 5a94f5b
1 parent e8c61cd
commit 5a94f5b
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 0 deletions.
diff --git a/src/vaadin-date-picker-light.d.ts b/src/vaadin-date-picker-light.d.ts
@@ -38,6 +38,9 @@ import { DatePickerEventMap } from './interfaces';
  *
  * Note: the `theme` attribute value set on `<vaadin-date-picker-light>`
  * is propagated to the internal themable components listed above.
+ *
+ * @fires {CustomEvent} opened-changed - Fired when the `opened` property changes.
+ * @fires {CustomEvent} value-changed - Fired when the `value` property changes.
  */
 declare class DatePickerLightElement extends ThemableMixin(DatePickerMixin(HTMLElement)) {
   _overlayInitialized: boolean;

diff --git a/src/vaadin-date-picker-light.js b/src/vaadin-date-picker-light.js
@@ -46,6 +46,9 @@ import { DatePickerMixin } from './vaadin-date-picker-mixin.js';
  * Note: the `theme` attribute value set on `<vaadin-date-picker-light>`
  * is propagated to the internal themable components listed above.
  *
+ * @fires {CustomEvent} opened-changed - Fired when the `opened` property changes.
+ * @fires {CustomEvent} value-changed - Fired when the `value` property changes.
+ *
  * @extends HTMLElement
  * @mixes ThemableMixin
  * @mixes DatePickerMixin

diff --git a/src/vaadin-date-picker.d.ts b/src/vaadin-date-picker.d.ts
@@ -80,6 +80,10 @@ import { DatePickerEventMap } from './interfaces';
  *
  * Note: the `theme` attribute value set on `<vaadin-date-picker>` is
  * propagated to the internal themable components listed above.
+ *
+ * @fires {CustomEvent} invalid-changed - Fired when the `invalid` property changes.
+ * @fires {CustomEvent} opened-changed - Fired when the `opened` property changes.
+ * @fires {CustomEvent} value-changed - Fired when the `value` property changes.
  */
 declare class DatePickerElement extends ElementMixin(
   ControlStateMixin(ThemableMixin(DatePickerMixin(GestureEventListeners(HTMLElement))))

diff --git a/src/vaadin-date-picker.js b/src/vaadin-date-picker.js
@@ -86,6 +86,10 @@ import { afterNextRender } from '@polymer/polymer/lib/utils/render-status.js';
  * Note: the `theme` attribute value set on `<vaadin-date-picker>` is
  * propagated to the internal themable components listed above.
  *
+ * @fires {CustomEvent} invalid-changed - Fired when the `invalid` property changes.
+ * @fires {CustomEvent} opened-changed - Fired when the `opened` property changes.
+ * @fires {CustomEvent} value-changed - Fired when the `value` property changes.
+ *
  * @extends HTMLElement
  * @mixes ElementMixin
  * @mixes ControlStateMixin