stream-chat-react/dist/components/ChannelSearch/SearchBar.d.ts

React components to create chat conversations or livestream style chat

import React from 'react';
import type { SearchInputProps } from './SearchInput';
export type AppMenuProps = {
    close?: () => void;
};
export type SearchBarController = {
    /** Called on search input focus */
    activateSearch: () => void;
    /** Clears the search state, removes focus from the search input */
    exitSearch: () => void;
    /** Flag determining whether the search input is focused */
    inputIsFocused: boolean;
    /** Ref object for the input wrapper in the SearchBar */
    searchBarRef: React.RefObject<HTMLDivElement | null>;
};
export type AdditionalSearchBarProps = {
    /** Application menu to be displayed  when clicked on MenuIcon */
    AppMenu?: React.ComponentType<AppMenuProps>;
    /** Custom icon component used to clear the input value on click. Displayed within the search input wrapper. */
    ClearInputIcon?: React.ComponentType;
    /** Custom icon component used to terminate the search UI session on click. */
    ExitSearchIcon?: React.ComponentType;
    /** Custom icon component used to invoke context menu. */
    MenuIcon?: React.ComponentType;
    /** Custom UI component to display the search text input */
    SearchInput?: React.ComponentType<SearchInputProps>;
    /** Custom icon used to indicate search input. */
    SearchInputIcon?: React.ComponentType;
};
export type SearchBarProps = AdditionalSearchBarProps & SearchBarController & SearchInputProps;
export declare const SearchBar: (props: SearchBarProps) => React.JSX.Element;