AutoCompleteSuggestionList

Renders the autocomplete list.

Best Practices

  • Keep the list height reasonable so it doesn't obscure the input.
  • Use a consistent header/item design for clarity across triggers.
  • Avoid heavy re-renders by memoizing list components.
  • Use SDK-provided components as a base to preserve behavior.
  • Ensure accessibility for keyboard and screen-reader users.

General Usage

Customize AutoCompleteSuggestionList and pass it via AutoCompleteSuggestionList on Channel.

See Customizing autocomplete suggestions for details.

import {
  Channel,
  AutoCompleteSuggestionList,
  WithComponents,
} from "stream-chat-react-native";

const AutoCompleteSuggestionListComponent = () => (
  <AutoCompleteSuggestionList />
);

<WithComponents
  overrides={{
    AutoCompleteSuggestionList: AutoCompleteSuggestionListComponent,
  }}
>
  <Channel channel={channel} />
</WithComponents>;

Props

PropDescriptionTypeDefault
AutoCompleteSuggestionHeaderRenders the autocomplete suggestion header.ComponentTypeAutoCompleteSuggestionHeader
AutoCompleteSuggestionItemRenders an autocomplete suggestion item.ComponentTypeAutoCompleteSuggestionItem