package.dist.components.combobox.use-combobox.d.cts Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of react Show documentation

A collection of unstyled, accessible UI components for React, utilizing state machines for seamless interaction.

The newest version!

import { PropTypes } from '@zag-js/react';
import { Optional } from '../../types';
import { CollectionItem, ListCollection } from '../collection';
import * as combobox from '@zag-js/combobox';
export interface UseComboboxProps extends Optional, 'dir' | 'getRootNode' | 'collection' | 'open.controlled'>, 'id'> {
    /**
     * The initial open state of the combobox when it is first rendered.
     * Use when you do not need to control its open state.
     */
    defaultOpen?: combobox.Context['open'];
    /**
     * The initial value of the combobox when it is first rendered.
     * Use when you do not need to control the state of the combobox.
     */
    defaultValue?: combobox.Context['value'];
    /**
     * The collection of items
     */
    collection: ListCollection;
}
export interface UseComboboxReturn extends combobox.Api {
}
export declare const useCombobox: (props: UseComboboxProps) => UseComboboxReturn;