import type { SendEventForHits, BindEventForHits } from '../../lib/utils'; import type { TransformItems, Connector, Hit, WidgetRenderState, BaseHit, Unmounter, Renderer, IndexRenderState } from '../../types'; import type { Banner, SearchResults } from 'algoliasearch-helper'; export type HitsRenderState = BaseHit> = { /** * The matched hits from Algolia API. * @deprecated use `items` instead */ hits: Array>; /** * The matched hits from Algolia API. */ items: Array>; /** * The response from the Algolia API. */ results?: SearchResults>; /** * The banner to display above the hits. */ banner?: Banner; /** * Sends an event to the Insights middleware. */ sendEvent: SendEventForHits; /** * Returns a string for the `data-insights-event` attribute for the Insights middleware */ bindEvent: BindEventForHits; }; export type HitsConnectorParams = BaseHit> = { /** * Whether to escape HTML tags from hits string values. * * @default true */ escapeHTML?: boolean; /** * Function to transform the items passed to the templates. */ transformItems?: TransformItems>; }; export type HitsWidgetDescription = BaseHit> = { $$type: 'ais.hits'; renderState: HitsRenderState; indexRenderState: { hits: WidgetRenderState, HitsConnectorParams>; }; }; export type HitsConnector = BaseHit> = Connector, HitsConnectorParams>; declare const _default: (renderFn: Renderer, unmountFn?: Unmounter) => = BaseHit>(widgetParams: TWidgetParams & HitsConnectorParams) => { $$type: "ais.hits"; init(initOptions: import("../../types").InitOptions): void; render(renderOptions: import("../../types").RenderOptions): void; getRenderState(renderState: { answers?: WidgetRenderState | undefined; autocomplete?: WidgetRenderState | undefined; breadcrumb?: { [rootAttribute: string]: WidgetRenderState; } | undefined; chat?: WidgetRenderState>, import("../chat/connectChat").ChatConnectorParams>> | undefined; clearRefinements?: WidgetRenderState | undefined; compare?: WidgetRenderState | undefined; configure?: WidgetRenderState | undefined; currentRefinements?: WidgetRenderState | undefined; feeds?: import("../feeds/connectFeeds").FeedsRenderState | undefined; geoSearch?: WidgetRenderState, import("../geo-search/connectGeoSearch").GeoSearchConnectorParams> | undefined; hierarchicalMenu?: { [rootAttribute: string]: WidgetRenderState; } | undefined; hits?: WidgetRenderState, HitsConnectorParams> | undefined; hitsPerPage?: WidgetRenderState | undefined; infiniteHits?: WidgetRenderState, import("../infinite-hits/connectInfiniteHits").InfiniteHitsConnectorParams> | undefined; menu?: { [attribute: string]: WidgetRenderState; } | undefined; numericMenu?: { [attribute: string]: WidgetRenderState; } | undefined; pagination?: WidgetRenderState | undefined; poweredBy?: WidgetRenderState | undefined; queryRules?: WidgetRenderState | undefined; range?: { [attribute: string]: WidgetRenderState; } | undefined; ratingMenu?: { [attribute: string]: WidgetRenderState; } | undefined; refinementList?: { [attribute: string]: WidgetRenderState; } | undefined; relevantSort?: WidgetRenderState | undefined; searchBox?: WidgetRenderState | undefined; sortBy?: WidgetRenderState | undefined; stats?: WidgetRenderState | undefined; toggleRefinement?: { [attribute: string]: WidgetRenderState; } | undefined; voiceSearch?: WidgetRenderState | undefined; analytics?: WidgetRenderState, import("../../widgets/analytics/analytics").AnalyticsWidgetParams> | undefined; places?: WidgetRenderState, import("../../widgets/places/places").PlacesWidgetParams> | undefined; }, renderOptions: import("../../types").InitOptions | import("../../types").RenderOptions): IndexRenderState & HitsWidgetDescription["indexRenderState"]; getWidgetRenderState({ results, helper, instantSearchInstance }: import("../../types").InitOptions | import("../../types").RenderOptions): { hits: never[]; items: never[]; results: undefined; banner: undefined; sendEvent: SendEventForHits; bindEvent: BindEventForHits; widgetParams: TWidgetParams & HitsConnectorParams; } | { hits: Hit[] | Hit[]; items: Hit[] | Hit[]; results: SearchResults; banner: Banner | undefined; sendEvent: SendEventForHits; bindEvent: BindEventForHits; widgetParams: TWidgetParams & HitsConnectorParams; }; dispose({ state }: import("../../types").DisposeOptions): import("algoliasearch-helper").SearchParameters; getWidgetSearchParameters(state: import("algoliasearch-helper").SearchParameters, _uiState: { uiState: { query?: string | undefined; configure?: import("algoliasearch-helper").PlainSearchParameters | undefined; geoSearch?: { boundingBox: string; } | undefined; hierarchicalMenu?: { [rootAttribute: string]: string[]; } | undefined; hitsPerPage?: number | undefined; page?: number | undefined; menu?: { [attribute: string]: string; } | undefined; numericMenu?: { [attribute: string]: string; } | undefined; range?: { [attribute: string]: string; } | undefined; ratingMenu?: { [attribute: string]: number | undefined; } | undefined; refinementList?: { [attribute: string]: string[]; } | undefined; relevantSort?: number | undefined; sortBy?: string | undefined; toggle?: { [attribute: string]: boolean; } | undefined; places?: { query: string; position: string; } | undefined; }; }): import("algoliasearch-helper").SearchParameters; }; export default _default;