Skip to content

docs(ui5-select): promote value property usage in samples #13170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ilhan007 merged 1 commit into from
Feb 27, 2026
+92 −32
Merged

docs(ui5-select): promote value property usage in samples #13170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@ cd packages/main
yarn test:cypress:single cypress/specs/Button.cy.tsx # Single test file
```

### Documentation Website
```bash
cd packages/website
yarn start # Starts Docusaurus on http://localhost:3000
```

### Build & Test Flow

**Build steps** (always run from root folder):
Expand Down
2 changes: 2 additions & 0 deletions packages/main/src/Option.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,10 @@ class Option extends ListItemBase implements IOption {

/**
* Defines the selected state of the component.
*
* @default false
* @public
* @deprecated since 2.20.0, please use the parent Select's `value` property instead.
*/
@property({ type: Boolean })
declare selected: boolean;
Expand Down
7 changes: 7 additions & 0 deletions packages/website/docs/_components_pages/main/Select/Select.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: ../../Select
---

import Basic from "../../../_samples/main/Select/Basic/Basic.md";
import Selection from "../../../_samples/main/Select/Selection/Selection.md";
import States from "../../../_samples/main/Select/States/States.md";
import AdditionalText from "../../../_samples/main/Select/AdditionalText/AdditionalText.md";
import CustomOptions from "../../../_samples/main/Select/CustomOptions/CustomOptions.md";
Expand All @@ -16,6 +17,12 @@ import CustomOptions from "../../../_samples/main/Select/CustomOptions/CustomOpt

## More Samples

### Selection
Use the `value` property on the Select component to control which option is selected.
The value should match the `value` attribute of the desired Option or Option's text.

<Selection />

### States
Select supports several semantic value states, readonly, disabled, etc.

Expand Down
8 changes: 4 additions & 4 deletions packages/website/docs/_samples/main/Select/Basic/sample.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@
<!-- playground-fold-end -->


<ui5-select>
<ui5-option icon="laptop">Desktop</ui5-option>
<ui5-option icon="ipad" selected>Tablet</ui5-option>
<ui5-option icon="iphone">Phone</ui5-option>
<ui5-select value="tablet">
<ui5-option value="desktop" icon="laptop">Desktop</ui5-option>
<ui5-option value="tablet" icon="ipad">Tablet</ui5-option>
<ui5-option value="phone" icon="iphone">Phone</ui5-option>
</ui5-select>

<!-- playground-fold -->
Expand Down
4 changes: 4 additions & 0 deletions packages/website/docs/_samples/main/Select/Selection/Selection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import html from '!!raw-loader!./sample.html';
import js from '!!raw-loader!./main.js';

<Editor html={html} js={js} />
11 changes: 11 additions & 0 deletions packages/website/docs/_samples/main/Select/Selection/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import "@ui5/webcomponents/dist/Select.js";
import "@ui5/webcomponents/dist/Option.js";
import "@ui5/webcomponents/dist/Label.js";
import "@ui5/webcomponents/dist/Text.js";

const select = document.getElementById("countrySelect");
const output = document.getElementById("output");

select.addEventListener("change", (e) => {
output.textContent = e.target.value;
});
30 changes: 30 additions & 0 deletions packages/website/docs/_samples/main/Select/Selection/sample.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<!-- playground-fold -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Sample</title>
</head>
<body style="background-color: var(--sapBackgroundColor); height: 300px">
<!-- playground-fold-end -->

<div>
<ui5-label for="countrySelect">Country:</ui5-label>
<ui5-select id="countrySelect" value="DE">
<ui5-option value="US">United States</ui5-option>
<ui5-option value="DE">Germany</ui5-option>
<ui5-option value="FR">France</ui5-option>
<ui5-option value="UK">United Kingdom</ui5-option>
</ui5-select>
</div>

<div>
<ui5-label>Selected value: <ui5-text id="output">DE</ui5-text></ui5-label>
</div>

<!-- playground-fold -->
<script type="module" src="main.js"></script>
</body>
</html>
<!-- playground-fold-end -->
56 changes: 28 additions & 28 deletions packages/website/docs/_samples/main/Select/States/sample.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,48 +10,48 @@
<!-- playground-fold-end -->


<ui5-select value-state="Positive">
<ui5-option icon="meal" selected>Apple</ui5-option>
<ui5-option icon="meal">Avocado</ui5-option>
<ui5-option icon="meal">Mango</ui5-option>
<ui5-select value-state="Positive" value="apple">
<ui5-option value="apple" icon="meal">Apple</ui5-option>
<ui5-option value="avocado" icon="meal">Avocado</ui5-option>
<ui5-option value="mango" icon="meal">Mango</ui5-option>
</ui5-select>

<ui5-select value-state="Information">
<ui5-option icon="meal" selected>Apple</ui5-option>
<ui5-option icon="meal">Avocado</ui5-option>
<ui5-option icon="meal">Mango</ui5-option>
<ui5-select value-state="Information" value="apple">
<ui5-option value="apple" icon="meal">Apple</ui5-option>
<ui5-option value="avocado" icon="meal">Avocado</ui5-option>
<ui5-option value="mango" icon="meal">Mango</ui5-option>
</ui5-select>

<ui5-select value-state="Critical">
<ui5-option icon="meal" selected>Apple</ui5-option>
<ui5-option icon="meal">Avocado</ui5-option>
<ui5-option icon="meal">Mango</ui5-option>
<ui5-select value-state="Critical" value="apple">
<ui5-option value="apple" icon="meal">Apple</ui5-option>
<ui5-option value="avocado" icon="meal">Avocado</ui5-option>
<ui5-option value="mango" icon="meal">Mango</ui5-option>
</ui5-select>

<ui5-select value-state="Negative">
<ui5-option icon="meal" selected>Apple</ui5-option>
<ui5-option icon="meal">Avocado</ui5-option>
<ui5-option icon="meal">Mango</ui5-option>
<ui5-select value-state="Negative" value="apple">
<ui5-option value="apple" icon="meal">Apple</ui5-option>
<ui5-option value="avocado" icon="meal">Avocado</ui5-option>
<ui5-option value="mango" icon="meal">Mango</ui5-option>
</ui5-select>

<ui5-select value-state="Negative" placeholder="Custom value-state message">
<ui5-option icon="meal" selected>Apple</ui5-option>
<ui5-option icon="meal">Avocado</ui5-option>
<ui5-option icon="meal">Mango</ui5-option>
<ui5-select value-state="Negative" placeholder="Custom value-state message" value="apple">
<ui5-option value="apple" icon="meal">Apple</ui5-option>
<ui5-option value="avocado" icon="meal">Avocado</ui5-option>
<ui5-option value="mango" icon="meal">Mango</ui5-option>

<div slot="valueStateMessage">Please provide valid value</div>
</ui5-select>

<ui5-select readonly>
<ui5-option icon="meal" selected>Apple</ui5-option>
<ui5-option icon="meal">Avocado</ui5-option>
<ui5-option icon="meal">Mango</ui5-option>
<ui5-select readonly value="apple">
<ui5-option value="apple" icon="meal">Apple</ui5-option>
<ui5-option value="avocado" icon="meal">Avocado</ui5-option>
<ui5-option value="mango" icon="meal">Mango</ui5-option>
</ui5-select>

<ui5-select disabled>
<ui5-option icon="meal" selected>Apple</ui5-option>
<ui5-option icon="meal" >Avocado</ui5-option>
<ui5-option icon="meal">Mango</ui5-option>
<ui5-select disabled value="apple">
<ui5-option value="apple" icon="meal">Apple</ui5-option>
<ui5-option value="avocado" icon="meal">Avocado</ui5-option>
<ui5-option value="mango" icon="meal">Mango</ui5-option>
</ui5-select>

<!-- playground-fold -->
Expand Down
Loading