Skip to content

Commit e1b5649

Browse files
authored
fix(docs): display the ui5-popover API correctly (#1064)
FIXES: #1029
1 parent 2b981e2 commit e1b5649

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

packages/main/src/Popover.js

+12-6
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,12 @@ import PopoverCss from "./generated/themes/Popover.css.js";
1515

1616
const arrowSize = 8;
1717

18+
/**
19+
* @public
20+
*/
1821
const metadata = {
1922
tag: "ui5-popover",
20-
properties: /** @lends sap.ui.webcomponents.main.Popover.prototype */ {
23+
properties: /** @lends sap.ui.webcomponents.main.Popover.prototype */ {
2124
/**
2225
* Defines the ID of the HTML Element, which will get the initial focus.
2326
*
@@ -154,7 +157,7 @@ const metadata = {
154157

155158
_maxContentHeight: { type: Integer },
156159
},
157-
slots: {
160+
slots: /** @lends sap.ui.webcomponents.main.Popover.prototype */ {
158161
/**
159162
* Defines the content of the Web Component.
160163
* @type {Node[]}
@@ -187,7 +190,7 @@ const metadata = {
187190
type: HTMLElement,
188191
},
189192
},
190-
events: {
193+
events: /** @lends sap.ui.webcomponents.main.Popover.prototype */ {
191194
/**
192195
* Fired before the component is opened.
193196
*
@@ -297,6 +300,11 @@ class Popover extends UI5Element {
297300
return event.target === this._opener;
298301
}
299302

303+
/**
304+
* Opens the popover.
305+
* @param {HTMLElement} opener the element that the popover is opened by
306+
* @public
307+
*/
300308
openBy(opener) {
301309
if (!opener || this.opened) {
302310
return;
@@ -316,9 +324,7 @@ class Popover extends UI5Element {
316324
}
317325

318326
/**
319-
*
320-
* @param {*} escPressed
321-
* @param {*} preventRegitryUpdate
327+
* Closes the popover.
322328
* @public
323329
*/
324330
close(escPressed = false, preventRegitryUpdate = false) {

0 commit comments

Comments
 (0)