From e4efb6dc032cfe2a5fab80f5c28997850b038ed4 Mon Sep 17 00:00:00 2001 From: gerjanvangeest Date: Mon, 24 Jun 2024 11:39:52 +0200 Subject: [PATCH] chore: add description for opened to the jsdoc (#2305) --- packages/ui/components/overlays/src/OverlayMixin.js | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/packages/ui/components/overlays/src/OverlayMixin.js b/packages/ui/components/overlays/src/OverlayMixin.js index a4b4d9ba8..af65f0ff5 100644 --- a/packages/ui/components/overlays/src/OverlayMixin.js +++ b/packages/ui/components/overlays/src/OverlayMixin.js @@ -26,9 +26,16 @@ export const OverlayMixinImplementation = superclass => constructor() { 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; - /** @type {Partial} */ + /** + * Configure the many options of the `OverlayController` + * @type {Partial} + */ this.config = {}; /** @type {EventListener} */