@visa/nova-react/use-listbox/index.d.ts

Visa Product Design System Nova React library

/**
 *              Copyright (c) 2025 Visa, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 **/
import { KeyboardEvent, MutableRefObject } from 'react';
import { FocusableHTMLElement } from '../types';
type UseListboxOptions<HTMLElementType> = {
    /** Auto select (not compatible with multi-select listbox) */
    autoSelect?: boolean;
    /** Default selected elements */
    defaultSelected?: number | number[];
    /** Ref for the tab elements */
    ref?: MutableRefObject<(HTMLElementType | null)[]>;
};
/**
 * @docs {@link https://design.visa.com/react/hooks/use-listbox | See Docs}
 * @description This hook is used to manage the selected state and keyboard navigation of listbox component.
 * @related listbox
 * @vgar TODO
 * @wcag TODO
 */
export declare const useListbox: {
    <HTMLElementType extends FocusableHTMLElement = HTMLLIElement>(useListboxOptions?: UseListboxOptions<HTMLElementType>): {
        /** Function that returns true if index is selected */
        isIndexSelected: (index: number) => boolean;
        /** Get tab index for tab key navigation */
        getTabIndex: (index: number, disabled?: boolean) => 0 | -1;
        /** Function that handles on key down for navigation */
        onKeyNavigation: (e: KeyboardEvent) => void;
        /** Ref object to use if ref isn't supplied in props */
        ref: MutableRefObject<(HTMLElementType | null)[]>;
        /** Index of the selected listbox  */
        selectedIndex: number | number[];
        /** Indices of the selected listbox(s) */
        selectedIndices: number | number[];
        /** Function that toggles selected state of listbox */
        toggleIndexSelected: (index: number) => void;
    };
    displayName: string;
    defaultProps: {
        autoSelect: boolean;
        defaultSelected: number;
    };
};
export default useListbox;