React.Aria.Combobox

newtype UseComboBox hooks

Constructors

• UseComboBox hooks

type AriaComboBoxPropsRequired :: Type -> Row Type -> Row Typetype AriaComboBoxPropsRequired a r = (children :: a -> JSX, inputRef :: Ref (Nullable Node), listBoxRef :: Ref (Nullable Node), popoverRef :: Ref (Nullable Node) | r)

type AriaComboBoxPropsOptional :: Type -> Row Typetype AriaComboBoxPropsOptional a = (allowsCustomValue :: Boolean, autoFocus :: Boolean, buttonRef :: Ref (Nullable Node), defaultInputValue :: String, defaultItems :: Array a, defaultSelectedKey :: String, description :: JSX, disabledKeys :: Array String, disallowEmptySelection :: Boolean, errorMessage :: JSX, id :: String, inputValue :: String, isDisabled :: Boolean, isReadOnly :: Boolean, isRequired :: Boolean, items :: Array a, label :: JSX, menuTrigger :: MenuTriggerAction, onBlur :: EventHandler, onFocus :: EventHandler, onFocusChange :: EffectFn1 Boolean Unit, onInputChange :: EffectFn1 String Unit, onKeyDown :: EventHandler, onKeyUp :: EventHandler, onOpenChange :: EffectFn2 Boolean String Unit, onSelectionChange :: EffectFn1 String Unit, placeholder :: String, selectedKey :: String, shouldFocusWrap :: Boolean, validationState :: ValidationState)

type UseComboBoxState = { close :: Effect Unit, collection :: Array Node, commit :: Effect Unit, disabledKeys :: JSSet String, focusStrategy :: FocusStrategy, inputValue :: String, isFocused :: Boolean, isOpen :: Boolean, open :: EffectFn2 (Nullable FocusStrategy) MenuTriggerAction Unit, revert :: Effect Unit, selectedItem :: Node, selectedKey :: String, selectionManager :: SelectionManager, setFocused :: EffectFn1 Boolean Unit, setInputValue :: EffectFn1 String Unit, setSelectedKey :: EffectFn1 String Unit, toggle :: EffectFn2 (Nullable FocusStrategy) MenuTriggerAction Unit }

type SelectionManager = { canSelectItem :: EffectFn1 String Unit, childFocusStrategy :: FocusStrategy, clearSelection :: Effect Unit, disallowEmptySelection :: Boolean, extendSelection :: EffectFn1 String Unit, firstSelectedKey :: Nullable String, focusedKey :: String, isEmpty :: Boolean, isFocused :: Boolean, isSelectAll :: Boolean, isSelected :: EffectFn1 String Boolean, isSelectionEqual :: EffectFn1 (JSSet String) Unit, lastSelectedKey :: Nullable String, rawSelection :: Selection, replaceSelection :: EffectFn1 String Unit, select :: EffectFn2 String SyntheticEvent Unit, selectAll :: Effect Unit, selectedKeys :: JSSet String, selectionBehavior :: SelectionBehaviour, selectionMode :: SelectionMode, setFocused :: EffectFn1 Boolean Unit, setFocusedKey :: EffectFn2 String FocusStrategy Unit, setSelectedKeys :: EffectFn1 (Array String) Unit, setSelectionBehavior :: EffectFn1 SelectionBehaviour Unit, toggleSelectAll :: Effect Unit, toggleSelection :: EffectFn1 String Unit }

type ComboBoxAria = { comboBoxProps :: { "data-isComboBox" :: Boolean } }

useComboBoxImpl :: forall props state. EffectFn2 props state ComboBoxAria

useComboBox :: forall a props props_. Union props props_ (AriaComboBoxPropsOptional a) => Record (AriaComboBoxPropsRequired a props) -> UseComboBoxState -> Hook UseComboBox ComboBoxAria