Forms

ListBox

Presents a visible single- or multi-select option list.

View preview API reference View in Figma

FrameworksAstro · React · Elements

Registry commandlumen add ListBox

InteractionEnhanced runtime

Design sourceLinked component node

See it and copy it

Framework example

Choose Astro, React, or Elements to compare native usage against the shared visual output. Each example assumes the framework-level setup is already complete.

Team members

View ListBox code

Framework usage

Switch targets to compare the adapter code. This live preview runs the Astro example. React and Elements use their own behavior APIs; complete the matching framework setup before copying an example.

---
import { ListBox } from '@santi020k/lumen-astro'
---

<ListBox
  label="Team members"
  multiple
  name="members"
  options={[
    { label: 'Amina', section: 'Design', value: 'amina' },
    { label: 'Luca', section: 'Design', value: 'luca' },
    { label: 'Theo', section: 'Engineering', value: 'theo' }
  ]}
  value={['amina']}
/>

import { ListBox } from '@santi020k/lumen-react'

export const Example = () => (
  <>
    <ListBox
      label="Team members"
      multiple
      name="members"
      options={[
        { label: 'Amina', section: 'Design', value: 'amina' },
        { label: 'Luca', section: 'Design', value: 'luca' },
        { label: 'Theo', section: 'Engineering', value: 'theo' }
      ]}
      value={['amina']}
    />
  </>
)

<script type="module">
  import { defineLumenElements } from '@santi020k/lumen-elements/define'

  defineLumenElements()
</script>

<lumen-list-box
  label="Team members"
  multiple
  name="members"
  options={[
    { label: 'Amina', section: 'Design', value: 'amina' },
    { label: 'Luca', section: 'Design', value: 'luca' },
    { label: 'Theo', section: 'Engineering', value: 'theo' }
  ]}
  value={['amina']}></lumen-list-box>

Edit ListBox in browser

Choose your target

Add this component

Choose the package for your runtime. All adapters share the Lumen stylesheet. Use the matching registry command when you want a local wrapper for that framework.

pnpm add @santi020k/lumen-astro

pnpm add @santi020k/lumen-astro

lumen add ListBox

lumen add ListBox

pnpm add @santi020k/lumen-react

pnpm add @santi020k/lumen-react

lumen add ListBox --target react

lumen add ListBox --target react

pnpm add @santi020k/lumen-elements

pnpm add @santi020k/lumen-elements

lumen add ListBox --target elements

lumen add ListBox --target elements

API reference

Lumen-specific props and runtime attributes for the Astro primitive. Use the framework differences above and the copyable examples for React composition and Elements attributes; the public adapter types define their supported contracts.

Attribute	Values	Default	Description
empty-message, data-selection-follows-focus	string, boolean string	"No options available", "false"	Sets the Elements empty-state text and optionally commits selection as keyboard focus moves.
aria-label, required	string, boolean	-	Names the Elements visible list and marks its generated select required. For other label or feedback associations, author a native select child and put required and ARIA attributes on that select.
label, aria-label, aria-labelledby	string	-	Names the single accessible visible list. External labels targeting or wrapping the native select also name it; explicit ARIA names take precedence.
required, aria-invalid, aria-describedby, aria-errormessage	native select attributes	-	Forwarded to the visible list. Required single selection stays invalid until a choice is made; native validation focuses the list. Consumer aria-invalid wins.
onFocus, onBlur	React select focus event handlers	-	Fire once when focus enters or leaves the visible list, with the native HTMLSelectElement event target and form name.
options	Array<string \| { label, value, disabled?, section? }>	[]	Defines options and optional accessible sections.
value	string \| string[]	-	Controls the selected value or values.
multiple	boolean	false	Allows more than one selected value while preserving native form submission.
loading	boolean	false	Marks the collection busy and disables selection while options load.
emptyMessage	string	"No options available"	Labels the empty collection state.
selectionFollowsFocus	boolean	false	Selects each enabled option as keyboard focus moves instead of waiting for Space or Enter.
class, className	string	""	Merges custom classes with the generated ui-* root classes.
...native attributes	HTML attributes	-	Forwards standard attributes to the root element unless the component consumes them.

Keyboard interactions

Keyboard behavior provided by the Astro UIPrimitives runtime for this component.

Key	Action
Arrow Down / Arrow Up	Moves the active option, skipping disabled options.
Home / End	Moves to the first or last enabled option.
Space / Enter	Selects or toggles the active option.
Type characters	Moves to the first enabled option whose label matches the typed prefix.

Framework example

Add this component

API reference

Keyboard interactions

Help improve ListBox