@microsoft/fast-foundation > Combobox

Combobox class

A Combobox Custom HTML Element. Implements the ARIA combobox.

start - Content which can be provided before the input

end - Content which can be provided after the input

control - Used to replace the input element representing the combobox

indicator - The visual indicator representing the expanded state

  • The default slot for the options

control - The wrapper element containing the input area, including start and end

selected-value - The input element representing the selected value

indicator - The element wrapping the indicator slot

listbox - The wrapper for the listbox slotted options

change - Fires a custom 'change' event when the value updates

Signature:

export declare class Combobox extends FormAssociatedCombobox 

Properties

Property Modifiers Type Description
autocomplete ComboboxAutocomplete | undefined The autocomplete attribute.
filteredOptions ListboxOption[] The collection of currently filtered options.
open boolean The open attribute.
options ListboxOption[] The list of options.
placeholder string Sets the placeholder value of the element, generally used to provide a hint to the user.
position SelectPosition The current state of the calculated position of the listbox.
positionAttribute SelectPosition The placement for the listbox when the combobox is open.
value string The value property.

Methods

Method Modifiers Description
connectedCallback()
filterOptions() Filter available options by text value.
positionChanged(prev, next)
setPositioning() Calculate and apply listbox positioning based on available viewport space.