react-instantsearch/dist/es/widgets/CompareBar.d.ts

⚡ Lightning-fast search for React, by Algolia

import React from 'react';
import type { CompareBarClassNames, CompareBarItemComponentProps, CompareBarTranslations } from 'instantsearch-ui-components';
import type { UseCompareProps } from 'react-instantsearch-core';
export type CompareBarProps = UseCompareProps & {
    /**
     * CSS classes to add to the widget elements.
     */
    classNames?: Partial<CompareBarClassNames>;
    /**
     * Translations for the widget's texts.
     */
    translations?: Partial<CompareBarTranslations>;
    /**
     * Custom renderer for a selected item's label.
     */
    itemComponent?: (props: CompareBarItemComponentProps) => JSX.Element;
};
/**
 * Renders the comparison selection bar: the records picked for comparison,
 * a clear-selection action, and the "Compare" call-to-action that opens the
 * `<Chat>` widget with the comparison message.
 *
 * Select records from your own UI (e.g. a "Compare" button in your hit
 * component) with `useCompare().toggleItem(hit)` — the selection is shared
 * with this widget.
 */
export declare function CompareBar({ classNames, translations, itemComponent, ...props }: CompareBarProps): React.JSX.Element;