vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-10-04 06:47:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update react-instantsearch-core types (#30382)

Browse Source 
* Update index.d.ts

* Fix lint errors

* Update index.d.ts

* Update index.d.ts

* Update index.d.ts
This commit is contained in:
David Furlong
2018-11-18 09:06:38 -08:00
committed by Pranav Senthilnathan
parent 1d8c20dc7d
commit c9e8f31da3
1 changed files with 23 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/react-instantsearch-core/index.d.ts
Vendored
+23 -3
View File
@@ -2,6 +2,7 @@
// Project: https://community.algolia.com/react-instantsearch/
// Definitions by: Gordon Burgett <https://github.com/gburgett>
// Justin Powell <https://github.com/jpowell>
// David Furlong <https://github.com/davidfurlong>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.9
@@ -171,13 +172,30 @@ export function connectHighlight(Composed: React.ComponentType<any>): React.Comp
*
* https://community.algolia.com/react-instantsearch/connectors/connectHits.html
*/
export function connectHits<TProps extends { hits: THit[]}, THit>(ctor: React.ComponentType<TProps>): ConnectedComponentClass<TProps, {hits?: THit[]}>;
export function connectHits<TProps extends { hits: THit[] }, THit>(ctor: React.ComponentType<TProps>): ConnectedComponentClass<TProps, { hits?: THit[] }>;
export function connectHitsPerPage(Composed: React.ComponentType<any>): React.ComponentClass<any>;
export function connectInfiniteHits(Composed: React.ComponentType<any>): React.ComponentClass<any>;
export interface InfiniteHitsProvided<THit = any> {
/** the records that matched the search */
hits: THit[];
/** a function to toggle the refinement */
refine: (...args: any[]) => any;
/** indicates if there are more pages to load */
hasMore: boolean;
}
/**
* InfiniteHits connector provides the logic to create connected components that will render an continuous list of results retrieved from Algolia.
* This connector provides a function to load more results.
*
* https://community.algolia.com/react-instantsearch/connectors/connectInfiniteHits.html
*/
export function connectInfiniteHits(Composed: React.ComponentType<InfiniteHitsProvided>): React.ComponentClass;
export function connectInfiniteHits<TProps extends Partial<InfiniteHitsProvided<THit>>, THit>(ctor: React.ComponentType<TProps>): ConnectedComponentClass<TProps, InfiniteHitsProvided<THit>>;
export interface MenuProvided {
items: Array<{count: number, isRefined: boolean, label: string, value: string}>;
items: Array<{ count: number, isRefined: boolean, label: string, value: string }>;
currentRefinement: string;
refine: (...args: any[]) => any;
createURL: (...args: any[]) => any;
@@ -256,6 +274,8 @@ export interface RefinementListProvided {
searchForItems: (...args: any[]) => any;
/** a boolean that says if the items props contains facet values from the global search or from the search inside items. */
isFromSearch: boolean;
/** a boolean that says whether you can currently refine */
canRefine: boolean;
}
export interface RefinementListExposed {
/** the name of the attribute in the record */