Skip to content

Commit

Permalink
docs: more detailed explanation of opener attribute (#8953)
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcusNotheis authored May 14, 2024
1 parent cf9f1c2 commit 11f5cd6
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 2 deletions.
2 changes: 2 additions & 0 deletions packages/main/src/ColorPalettePopover.ts
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,8 @@ class ColorPalettePopover extends UI5Element {

/**
* Defines the ID or DOM Reference of the element that the popover is shown at.
* When using this attribute in a declarative way, you must only use the `id` (as a string) of the element at which you want to show the popover.
* You can only set the `opener` attribute to a DOM Reference when using JavaScript.
* @public
* @default undefined
* @since 1.21.0
Expand Down
4 changes: 3 additions & 1 deletion packages/main/src/Menu.ts
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,9 @@ class Menu extends UI5Element {
loadingDelay!: number;

/**
* Defines the ID or DOM Reference of the element that the menu is shown at
* Defines the ID or DOM Reference of the element at which the menu is shown.
* When using this attribute in a declarative way, you must only use the `id` (as a string) of the element at which you want to show the popover.
* You can only set the `opener` attribute to a DOM Reference when using JavaScript.
* @public
* @default ""
* @since 1.10.0
Expand Down
4 changes: 3 additions & 1 deletion packages/main/src/Popover.ts
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,9 @@ class Popover extends Popup {
}

/**
* Defines the ID or DOM Reference of the element that the popover is shown at
* Defines the ID or DOM Reference of the element at which the popover is shown.
* When using this attribute in a declarative way, you must only use the `id` (as a string) of the element at which you want to show the popover.
* You can only set the `opener` attribute to a DOM Reference when using JavaScript.
* @public
* @default undefined
* @since 1.2.0
Expand Down
2 changes: 2 additions & 0 deletions packages/main/src/Select.ts
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,8 @@ class Select extends UI5Element implements IFormInputElement {
/**
* Defines a reference (ID or DOM element) of component's menu of options
* as alternative to define the select's dropdown.
* When using this attribute in a declarative way, you must only use the `id` (as a string) of the element at which you want to show the menu.
* You can only set the `opener` attribute to a DOM Reference when using JavaScript.
*
* **Note:** Usage of `ui5-select-menu` is recommended.
* @default undefined
Expand Down
2 changes: 2 additions & 0 deletions packages/main/src/Tokenizer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,8 @@ class Tokenizer extends UI5Element {

/**
* Defines the ID or DOM Reference of the element that the menu is shown at
* When using this attribute in a declarative way, you must only use the `id` (as a string) of the element at which you want to show the tokenizer.
* You can only set the `opener` attribute to a DOM Reference when using JavaScript.
* **Note:** Used inside MultiInput and MultiComboBox components.
* @private
* @default ""
Expand Down

0 comments on commit 11f5cd6

Please sign in to comment.