Skip to content

Commit f902ec4

Browse files
authored
chore: api and docs improvements (#11179)
1 parent 876d629 commit f902ec4

File tree

7 files changed

+13
-51
lines changed

7 files changed

+13
-51
lines changed

packages/fiori/src/ShellBarItem.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,10 @@ class ShellBarItem extends UI5Element {
8181
* - **hasPopup**: Indicates the availability and type of interactive popup element,
8282
* such as menu or dialog, that can be triggered by the button.
8383
*
84+
* - **controls**: Identifies the element (or elements) whose contents
85+
* or presence are controlled by the component.
86+
* Accepts a lowercase string value, referencing the ID of the element it controls.
87+
*
8488
* @default {}
8589
* @public
8690
* @since 2.9.0

packages/main/src/MultiComboBox.ts

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -645,15 +645,6 @@ class MultiComboBox extends UI5Element implements IFormInputElement {
645645
this.selectedItems = this._getItems().filter((item, idx, allItems) => MultiComboBox._groupItemFilter(item, ++idx, allItems, selectedItems) || selectedItems.indexOf(item) !== -1);
646646
}
647647

648-
/**
649-
* Indicates whether the dropdown is open. True if the dropdown is open, false otherwise.
650-
* @default false
651-
* @public
652-
*/
653-
get isOpen(): boolean {
654-
return this.open;
655-
}
656-
657648
get _showAllItemsButtonPressed(): boolean {
658649
return this.filterSelected;
659650
}

packages/main/src/Select.ts

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,17 +93,18 @@ type SelectLiveChangeEventDetail = {
9393
*
9494
* There are two main usages of the `ui5-select>`.
9595
*
96-
* 1. With Option (`ui5-option`) web component:
96+
* - With Option (`ui5-option`) web component:
9797
*
9898
* The available options of the Select are defined by using the Option component.
9999
* The Option comes with predefined design and layout, including `icon`, `text` and `additional-text`.
100100
*
101-
* 2. With OptionCustom (`ui5-option-custom`) web component.
101+
* - With OptionCustom (`ui5-option-custom`) web component.
102102
*
103103
* Options with custom content are defined by using the OptionCustom component
104104
* The OptionCustom component comes with no predefined layout and it expects consumers to define it.
105105
*
106106
* ### Keyboard Handling
107+
*
107108
* The `ui5-select` provides advanced keyboard handling.
108109
*
109110
* - [F4] / [Alt] + [Up] / [Alt] + [Down] / [Space] or [Enter] - Opens/closes the drop-down.
@@ -114,6 +115,7 @@ type SelectLiveChangeEventDetail = {
114115
* - [End] - Navigates to the last option
115116
*
116117
* ### ES6 Module Import
118+
*
117119
* `import "@ui5/webcomponents/dist/Select";`
118120
*
119121
* `import "@ui5/webcomponents/dist/Option";`
@@ -216,14 +218,17 @@ class Select extends UI5Element implements IFormInputElement {
216218

217219
/**
218220
* Defines the icon, displayed as graphical element within the component.
221+
* When set, the component will display the icon only - the selected option's text,
222+
* the Select's "label" slot (if present) and the dropdown arrow won't be displayed.
223+
*
219224
* The SAP-icons font provides numerous options.
220225
*
221226
* Example:
222227
* See all the available icons within the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).
223228
*
224229
* **Note:** When using this property with a valid icon, Select will be rendered as icon only button and the label and the default arrow down won't be visible.
225230
* @default undefined
226-
* @public
231+
* @private
227232
*/
228233
@property()
229234
icon?: string;

packages/website/docs/_components_pages/main/Select/Select.mdx

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ import Basic from "../../../_samples/main/Select/Basic/Basic.md";
66
import States from "../../../_samples/main/Select/States/States.md";
77
import AdditionalText from "../../../_samples/main/Select/AdditionalText/AdditionalText.md";
88
import CustomOptions from "../../../_samples/main/Select/CustomOptions/CustomOptions.md";
9-
import IconOnly from "../../../_samples/main/Select/IconOnly/IconOnly.md";
109

1110
<%COMPONENT_OVERVIEW%>
1211

@@ -32,9 +31,4 @@ Options can dispplay additional text.
3231
### Custom Options
3332
You can define completely custom options via the ui5-option-custom (providing custom content) component.
3433

35-
<CustomOptions />
36-
37-
### Icon only
38-
You can define select as icon only with the help of its icon property.
39-
40-
<IconOnly />
34+
<CustomOptions />

packages/website/docs/_samples/main/Select/IconOnly/IconOnly.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

packages/website/docs/_samples/main/Select/IconOnly/main.js

Lines changed: 0 additions & 4 deletions
This file was deleted.

packages/website/docs/_samples/main/Select/IconOnly/sample.html

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)