headless-combobox

Index

Namespaces

Html Plugins

Type Aliases

ClosedState FocusedState Input ItemStatusDetailed NonEmpty OpenedState Output Plugin SelectedItemListDirection SelectedState UnselectedState

Config The Config<T> represents the configuration needed for the combobox to work with generic items.

Config

Update The Effect<T> represents all the possible effects that can happen to the combobox. You as the user of the library has to implement the side effects

Effect

Update

Event

Model

InputMode SelectMode

Selectors This type represents all the possible states of an item

ItemStatus SelectedItemStatus

Model The Model<T> represents the state of the combobox. This is the data you will be saving in your app.

Model

Update The Msg<T> represents all the possible state transitions that can happen to the combobox.

Msg

Variables

ariaContentDefaults

WAI-ARIA

aria ariaInput ariaInputLabel ariaItem ariaItemList ariaUnselectButton

Functions

ariaSelectedItem chainUpdates clearInputValue defaultDeterministicFilterCacheKeyFn didSelectedItemsChange handleEffects handleEvents initOutput isNavigatingWithKeyboard isNonEmpty removeSelectedItem resetInputValue toFilteredItemsMemoized toHighlightedIndex toItemStatusDetailed toNextHighlightIndex toRenderItems toRenderItemsMemozied toRenderSelectedItems toSearchValue toSelectedItemDirection yieldFilteredItems yieldRenderItemsMemoized yieldRenderSelectedItems yieldSelectedItems

Model The init function returns the initial state of the combobox.

init

Config

initConfig

Selectors Utility function to determine if input is blurred.

isBlurred

Selectors Utility function to determine if the dropdown is closed.

isClosed

Selectors Utility function to determine if input is focused.

isFocused

Selectors Utility function to determine if any item is highlighted.

isHighlighted

Selectors Utility function to determine if an item is highlighted.

isItemHighlighted

Selectors Selector function to determine if an index is selected.

isItemIndexHighlighted

Selectors Utility function to determine if an item is selected.

isItemSelected

Selectors Selector function to determine if an item is selected and highlighted.

isItemSelectedAndHighlighted

Selectors Utility function to determine if the dropdown is opened.

isOpened

Selectors Utility function to determine if any item is selected.

isSelected

Selectors

isSelectedItemFocused isSelectedItemHighlighted

Selectors Utility function to determine if in unselected state

isUnselected

Helpers This helper function converts a keyboard event key property to a message.

keyToMsg

Config The simpleFilter function is a default implementation of the deterministicFilter function.

simpleFilter

Selectors This function returns the value that the input element should have.

toCurrentInputValue

Selectors This function returns the all the filtered items.

toFilteredItems

Selectors This function returns the highlighted item.

toHighlightedItem

Selectors This utility function returns the status of an item.

toItemStatus toSelectedItemStatus

Selectors This function returns the selected item

toSelectedItem toSelectedItems

Selectors This function returns an object of all the returns of all the selectors.

toState

Update The update function is the main function. The update function takes the current state of the combobox and a message and returns the new state of the combobox and effects that need to be run.

update

Selectors This function returns the all the filtered items with their status.

yieldRenderItems

Settings

Member Visibility

Theme

Generated using TypeDoc