import { SyntheticEvent } from 'react';
import { SerializableProperty } from '../../serializers';
export type UseLoadPropertiesResults = {
    properties: SerializableProperty[];
    previousProperties: SerializableProperty[];
    onLoadMore: (e: SyntheticEvent) => void;
    onLoadPrevious: (e: SyntheticEvent) => void;
    loadingNextProperties: boolean;
    loadingPreviousProperties: boolean;
    hasNextPage?: boolean;
    hasPreviousPage?: boolean;
    nextPageSearchUrl: string;
    previousPageSearchUrl: string;
};
export type UseLoadPropertiesProps = {
    fragment: string[];
    channel: string;
    county?: string;
    location?: string;
    pageSize: number;
    postcode?: string;
    branch?: string;
    sortOrder?: string;
};
/**
 * Used to render properties, loading state, a load more handler for property results
 * and a hasNextPage state to be used to conditionally render the load more button.
 *
 * Due to search engines' inability to crawl successive search pages when using
 * "Load More" functionality, the `onLoadMore` handler should be applied to a
 * NextJS `Link` component instead of an HTML `<button>`.
 * `nextPageSearchUrl` is provided to add as an `href` of the `Link`, allowing
 * search engines to crawl subsequent search pages. `onLoadMore` will call
 * `e?.preventDefault()` to avoid navigation by the `Link`, instead runnning the
 * fetch request for more properties asynchronously.
 *
 *
 * @example
 * ```tsx
 * const { properties, onLoadMore, loadingNextProperties, hasNextPage, nextPageSearchUrl } = useLoadProperties({
 *   fragment,
 *   channel,
 *   county,
 *   location,
 *   page,
 *   pageSize,
 * });
 *
 * ...
 *
 * <Link href={nextPageSearchUrl} onClick={onLoadMore}>
 *   Load More Properties
 * </Link>
 * ```
 */
export default function useLoadProperties({ fragment, channel, county, location, pageSize, postcode, branch, sortOrder, }: UseLoadPropertiesProps): UseLoadPropertiesResults;
//# sourceMappingURL=use-load-properties.d.ts.map