Backstage
    Preparing search index...

    Interface SearchAutocompleteProps

    interface SearchAutocompleteProps {
        "aria-label"?: string;
        "aria-labelledby"?: string;
        children?: ReactNode;
        className?: string;
        defaultOpen?: boolean;
        inputValue?: string;
        isLoading?: boolean;
        onInputChange?: (value: string) => void;
        placeholder?: string;
        popoverPlacement?: Placement;
        popoverWidth?: string;
        size?: "small" | "medium" | Partial<Record<Breakpoint, "small" | "medium">>;
        style?: CSSProperties;
    }

    Hierarchy (View Summary)

    Index

    Properties

    aria-label? aria-labelledby? children? className? defaultOpen? inputValue? isLoading? onInputChange? placeholder? popoverPlacement? popoverWidth? size? style?

    Properties

    "aria-label"?: string

    Accessible label for the search input.

    "aria-labelledby"?: string

    ID of the element that labels the search input.

    children?: ReactNode

    The result items to render inside the autocomplete.

    className?: string
    defaultOpen?: boolean

    Whether the results popover is open by default.

    inputValue?: string

    The current value of the search input (controlled).

    isLoading?: boolean

    Whether results are currently loading. When true, displays a loading indicator and announces the loading state to screen readers.

    onInputChange?: (value: string) => void

    Handler called when the search input value changes.

    placeholder?: string

    The placeholder text for the search input.

    popoverPlacement?: Placement

    Placement of the results popover relative to the input.

    'bottom start'
    popoverWidth?: string

    Width of the results popover. Accepts any CSS width value. When not set, the popover matches the input width.

    size?: "small" | "medium" | Partial<Record<Breakpoint, "small" | "medium">>

    The size of the search input.

    'small'
    style?: CSSProperties

    Settings

    Member Visibility

    On This Page

    Properties