@mui/base/useOption/useOption.types.d.ts

MUI Base is a library of headless ('unstyled') React components and low-level hooks. You gain complete control over your app's CSS and accessibility features.

import { UseListItemRootSlotProps } from '../useList';
export interface SelectOption<Value> {
    value: Value;
    label: React.ReactNode;
    disabled?: boolean;
    ref: React.RefObject<HTMLElement | null>;
    id?: string;
}
export interface UseOptionParameters<Value> {
    disabled: boolean;
    id?: string;
    label: string | React.ReactNode;
    rootRef?: React.Ref<Element>;
    value: Value;
}
export interface UseOptionReturnValue {
    /**
     * If `true`, the option is selected.
     */
    selected: boolean;
    /**
     * If `true`, the option is highlighted.
     */
    highlighted: boolean;
    index: number;
    /**
     * Resolver for the root slot's props.
     * @param externalProps props for the root slot
     * @returns props that should be spread on the root slot
     */
    getRootProps: <ExternalProps extends Record<string, unknown>>(externalProps?: ExternalProps) => UseOptionRootSlotProps<ExternalProps>;
    /**
     * Ref to the root slot DOM node.
     */
    rootRef: React.RefCallback<Element> | null;
}
export type UseOptionRootSlotProps<ExternalProps extends Record<string, unknown> = {}> = UseListItemRootSlotProps<ExternalProps> & {
    ref?: React.RefCallback<Element> | null;
} & ExternalProps;