@jungle-commerce/typesense-react
Version:
React hooks and components for building search interfaces with Typesense
33 lines • 1.23 kB
TypeScript
import { default as React } from 'react';
import { TypesenseSearchClient } from '../core/TypesenseClient';
import { TypesenseConfig } from '../types';
import { CollectionSearchConfig, UseMultiCollectionSearchReturn, UseMultiCollectionSearchOptions } from '../types/multiCollection';
/**
* Context value for multi-collection search
*/
interface MultiCollectionContextValue extends UseMultiCollectionSearchReturn {
client: TypesenseSearchClient;
}
/**
* Props for MultiCollectionProvider
*/
export interface MultiCollectionProviderProps {
/** Child components */
children: React.ReactNode;
/** Typesense configuration or client instance */
config: TypesenseConfig | TypesenseSearchClient;
/** Default collections to search */
defaultCollections?: CollectionSearchConfig[];
/** Hook options */
searchOptions?: UseMultiCollectionSearchOptions;
}
/**
* Provider component for multi-collection search
*/
export declare const MultiCollectionProvider: React.FC<MultiCollectionProviderProps>;
/**
* Hook to use multi-collection search context
*/
export declare function useMultiCollectionContext(): MultiCollectionContextValue;
export {};
//# sourceMappingURL=MultiCollectionProvider.d.ts.map