ui/combobox

Types

MenuTrigger

pub type MenuTrigger {
  Input
  Focus
  Manual
}

Constructors

```
Input
```
```
Focus
```
```
Manual
```

Msg

</>

Keyboard messages for combobox component.

pub type Msg {
  Open
  Close
  MoveNext
  MovePrev
  MoveFirst
  MoveLast
  Select
  TypeAhead(String)
  SelectAndClose
  Clear
}

Constructors

```
Open
```
Open the dropdown (ArrowDown, ArrowUp, Alt+ArrowDown, Alt+ArrowUp)
```
Close
```
Close the dropdown (Escape)
```
MoveNext
```
Move to next option (ArrowDown)
```
MovePrev
```
Move to previous option (ArrowUp)
```
MoveFirst
```
Move to first option (Home)
```
MoveLast
```
Move to last option (End)
```
Select
```
Select the currently highlighted option (Enter)
```
TypeAhead(String)
```
Type-ahead search (Character keys)
```
SelectAndClose
```
Select and close (Enter)
```
Clear
```
Clear the input (Escape when open)

Size

</>

pub type Size {
  Small
  Medium
  Large
}

Constructors

```
Small
```
```
Medium
```
```
Large
```

Variant

</>

pub type Variant {
  Default
  Muted
}

Constructors

```
Default
```
```
Muted
```

Values

allows_custom_value

</>

pub fn allows_custom_value() -> attribute.Attribute(a)

aria_activedescendant

</>

pub fn aria_activedescendant(
  id: String,
) -> attribute.Attribute(a)

Attribute to indicate the currently active descendant.

aria_controls

</>

pub fn aria_controls(id: String) -> attribute.Attribute(a)

Attribute to indicate controls relationship.

aria_expanded

</>

pub fn aria_expanded(expanded: Bool) -> attribute.Attribute(a)

Attribute to indicate expanded state.

chevron_icon

</>

pub fn chevron_icon(
  attributes: List(attribute.Attribute(a)),
) -> element.Element(a)

combobox

</>

pub fn combobox(
  attributes: List(attribute.Attribute(a)),
) -> element.Element(a)

disabled

</>

pub fn disabled() -> attribute.Attribute(a)

empty_state

</>

pub fn empty_state(
  attributes: List(attribute.Attribute(a)),
) -> element.Element(a)

input_element_id

</>

pub fn input_element_id() -> String

Get the element ID for the combobox input.

input_field

</>

pub fn input_field(
  attributes: List(attribute.Attribute(a)),
) -> element.Element(a)

invalid

</>

pub fn invalid() -> attribute.Attribute(a)

keymap

</>

pub fn keymap(
  key_event: keyboard.KeyEvent,
  is_open: Bool,
) -> option.Option(Msg)

Keymap for combobox keyboard navigation. Follows WAI-ARIA combobox pattern:

ArrowDown/ArrowUp: Open dropdown and navigate
Alt+ArrowDown/Alt+ArrowUp: Open dropdown
Escape: Close dropdown
Enter: Select highlighted option
Character: Type-ahead search and filter

listbox

</>

pub fn listbox(
  attributes: List(attribute.Attribute(a)),
  children: List(element.Element(a)),
) -> element.Element(a)

listbox_element_id

</>

pub fn listbox_element_id() -> String

Get the element ID for the combobox listbox.

menu_trigger

</>

pub fn menu_trigger(mt: MenuTrigger) -> attribute.Attribute(a)

option

</>

pub fn option(
  attributes: List(attribute.Attribute(a)),
  label: String,
  option_value: String,
) -> element.Element(a)

option_element_id

</>

pub fn option_element_id(index: Int) -> String

Get the element ID for a combobox option at the given index.

option_group

</>

pub fn option_group(
  attributes: List(attribute.Attribute(a)),
  label: String,
  children: List(element.Element(a)),
) -> element.Element(a)

placeholder

</>

pub fn placeholder(placeholder: String) -> attribute.Attribute(a)

required

</>

pub fn required() -> attribute.Attribute(a)

size

</>

pub fn size(s: Size) -> attribute.Attribute(a)

value

</>

pub fn value(val: String) -> attribute.Attribute(a)

variant

</>

pub fn variant(v: Variant) -> attribute.Attribute(a)