chore: add description for opened to the jsdoc (#2305)

This commit is contained in:
gerjanvangeest 2024-06-24 11:39:52 +02:00 committed by GitHub
parent b2d7d9b4a4
commit e4efb6dc03
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -26,9 +26,16 @@ export const OverlayMixinImplementation = superclass =>
constructor() { constructor() {
super(); super();
/**
* If you add the opened attribute a dialog will be opened on page load. The invoker can be left out
* in case the user does not need to be able to reopen the dialog.
*/
this.opened = false; this.opened = false;
/** @type {Partial<OverlayConfig>} */ /**
* Configure the many options of the `OverlayController`
* @type {Partial<OverlayConfig>}
*/
this.config = {}; this.config = {};
/** @type {EventListener} */ /** @type {EventListener} */