Components / primitive
Select
Chooses one value from a labelled list of options.
Generated from @oods/foundry 0.10.1
- Categories
- primitive
- Contexts
- form
- Readiness
proven-in-generated-apps
Playground
Documented example select-controlled : choose Basic, basic emitted once.
The render follows the page's theme switch: light, dark or high contrast. Both frameworks render the same example.
Events it emits: change, update. Use either render above, and each event shows here with the framework that sent it.
Code
The documented example. HTML is the markup the React component renders for it, which @oods/component-styles styles.
import { Select } from '@oods/components-react';
import '@oods/component-styles/css';
const options = [
{
"value": "basic",
"label": "Basic"
},
{
"value": "pro",
"label": "Pro"
}
];
export function Example() {
return (
<Select
id="plan"
label="Plan"
value="pro"
options={options}
/>
);
}Props, slots and events
Contract version 1.1.0. Types are from the React declarations in @oods/components-react.
| Prop | Type | Required | Documented example |
|---|---|---|---|
id | string | yes | plan |
label | ReactNode | yes | Plan |
value | string | number | readonly string[] | undefined | no | pro |
default | string | number | readonly string[] | undefined | no | |
placeholder | string | undefined | no | |
required | boolean | undefined | no | |
disabled | boolean | undefined | no | |
options | readonly SelectOption[] | undefined | no | [{"value":"basic","label":"Basic"},{"value":"pro","label":"Pro"}] |
help | ReactNode | no | |
validation | FieldValidation | undefined | no |
Slots
label, option, help, validation
Events
change, update
States
unselected, selected, disabled, invalid
Accessibility
- Role
combobox- How it gets its name
labelonselect
Keyboard
| Key | What it does |
|---|---|
| Tab | Move focus to the named native control |
Obligations in the contract
- Native select semantics
- Label and descriptions are associated
- Placeholder is an explicit empty-value option
Native select only; no custom combobox claim.
Tokens
The token roles this component reads.
input.backgroundinput.borderinput.textinput.focusfield.message
Readiness
The evidence recorded for this component, with its label.
proven-in-generated-apps: catalog_list gives this label when generated React and Vue apps in the runtime sweep that ships with this version both use the component. That sweep was measured on the published 0.4.1, not on this version.
| Evidence | React | Vue |
|---|---|---|
| state | implemented-evidence-complete | implemented-evidence-complete |
| versioned contract | passed | passed |
| target implementation | passed | passed |
| package export | passed | passed |
| public declaration | passed | passed |
| dependency closure | passed | passed |
| framework scenario | passed | passed |
| accessibility | verified | verified |
| interaction | verified | verified |
| visual themes | verified | verified |
Use your own
You can replace this component with your own React or Vue component. Map it, and generated code imports yours at the exact version you name. A contract report, run in a real browser, lists what your component met, what it didn't, and what wasn't checked.
The component_map call, with the parts in angle brackets yours to fill:
{
"action": "create",
"apply": true,
"externalSystem": "<your design system>",
"externalComponent": "<YourSelect>",
"oodsTraits": [
"<trait names>"
],
"substitution": {
"component": "Select",
"react": {
"package": "<your-package>/react",
"version": "<exact version>",
"export": "<YourSelect>"
},
"vue": {
"package": "<your-package>/vue",
"version": "<exact version>",
"export": "<YourSelect>"
}
}
} How this page was made
Generated at build from the published data, each source with the hash of what was read. The page's manifest.
- Contract:
@oods/component-contracts@0.10.1 componentContracts.Selectsha256:4a1505a56b1d… - Documented example:
@oods/component-contracts@0.10.1 sharedScenarios select-controlledsha256:763b8e9deefd… - Catalog entry (catalog_list):
generated/0.10.1/system/catalog.json Selectsha256:f04379348a0c… - React readiness:
@oods/components-react@0.10.1 readiness Selectsha256:cc2655858b23… - Vue readiness:
@oods/components-vue@0.10.1 readiness Selectsha256:e66afbe11740… - Prop types:
generated/0.10.1/components/prop-types.json Selectsha256:7c2590d1bae3…