@redocly/react-dropdown-aria/dist/utils/types.d.ts

Simple and accessible React dropdown component

import { ReactNode } from 'react';
import { StyleKeys } from './constants';
import { OptionItemProps } from '../components/OptionItem';
export interface ExtraState {
    [key: string]: any;
}
export declare type StyleKey = keyof typeof StyleKeys;
export declare type OptionRendererFunction = (props: OptionItemProps, index: number) => JSX.Element;
export declare type OnOptionClicked = (option: Option, shouldClose?: boolean) => void;
export declare type ItemRenderer = (props: OptionItemProps, index: number) => JSX.Element;
export interface Option {
    ariaLabel?: string;
    className?: string;
    title?: string;
    value: string;
    iconClass?: string;
}
export interface OptionGroup {
    label: string;
    groupOptions: Option[];
}
export declare type DropdownOption = Option | OptionGroup;
export interface DropdownStyleDependantState {
    open: boolean;
    focusedIndex: number;
    dropdownFocused: boolean;
}
export interface DropdownState extends DropdownStyleDependantState {
    searchTerm: string;
}
export interface DropdownProps {
    ariaDescribedBy: string;
    ariaLabel: string;
    ariaLabelledBy: string;
    arrowRenderer: (open: boolean) => ReactNode;
    className: string;
    centerText: boolean;
    contentClassName: string;
    defaultOpen: boolean;
    disabled: boolean;
    height: number;
    hideArrow: boolean;
    id: string;
    maxContentHeight: number;
    openUp: boolean;
    options: DropdownOption[];
    optionItemRenderer: OptionRendererFunction;
    pageKeyTraverseSize: number;
    placeholder: string;
    searchable: boolean;
    value: string;
    selectedValueClassName: string;
    onChange: (option: Option) => void;
    width: number;
}