Skip to content

Commit 3487329

Browse files
committed
update Select
1 parent 9e40119 commit 3487329

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

packages/main/src/webComponents/Select/SelectDescription.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
## Usage
2+
3+
There are two main usages of the `Select`.
4+
5+
1. With Option (`Option`) web component:
6+
The available options of the Select are defined by using the Option component. The Option comes with predefined design and layout, including `icon`, `text` and `additional-text`.
7+
2. With SelectMenu (`SelectMenu`) and SelectMenuOption (`SelectMenuOption`) web components:
8+
The SelectMenu can be used as alternative to define the Select's dropdown and can be used via the `menu` property of the Select to reference SelectMenu by its ID. The component gives the possibility to customize the Select's dropdown by slotting entirely custom options (via the SelectMenuOption component) and adding custom styles. **Note:** SelectMenu is a popover and placing it top-level in the HTML page is recommended, because some page styles (for example transitions) can misplace the SelectMenu.
9+
110
## Keyboard Handling
211

312
The `Select` provides advanced keyboard handling.

packages/main/src/webComponents/Select/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ export interface SelectPropTypes extends SelectAttributes, Omit<CommonProps, 'on
126126
}
127127

128128
/**
129-
* The `Select` component is used to create a drop-down list. The items inside the `Select` define the available options by using the `Option` component.
129+
* The `Select` component is used to create a drop-down list.
130130
*
131131
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
132132
*

0 commit comments

Comments
 (0)