@dndbuilder.com/react
Version:
Drag and drop builder for React
27 lines (26 loc) • 1.12 kB
TypeScript
import { IconifyJSON } from 'iconify-icon/dist/iconify-icon.js';
/**
* Interface for useIcons hook parameters
*/
export interface UseIconsParams {
/** The selected icon collection */
collection: string;
/** Number of icons to fetch per page */
pageSize?: number;
/** Optional search text to filter icons by name */
searchText?: string;
}
/**
* Custom hook for fetching icon collections and icons
* @param params Object containing hook parameters
* @returns Object containing collection data, icon data, and loading/error states
*/
export declare function useIcons({ collection, pageSize, searchText }: UseIconsParams): {
data: import('@tanstack/react-query').InfiniteData<IconifyJSON, unknown> | undefined;
isLoading: boolean;
isError: boolean;
fetchNextPage: (options?: import('@tanstack/react-query').FetchNextPageOptions) => Promise<import('@tanstack/react-query').InfiniteQueryObserverResult<import('@tanstack/react-query').InfiniteData<IconifyJSON, unknown>, Error>>;
hasNextPage: boolean;
isFetchingNextPage: boolean;
};
//# sourceMappingURL=use-icons.d.ts.map