Skip to content
Shopware

useListing

useListing

Category:
Product

Types

ts
export function useListing(params?: {
  listingType: ListingType;
  categoryId?: string;
  defaultSearchCriteria?: operations["searchPage post /search"]["body"];
  initialListing?: Schemas["ProductListingResult"] | null;
}): UseListingReturn

source code

ts
export function createListingComposable({
  searchMethod,
  searchDefaults,
  listingKey,
  initialListing,
}: {
  searchMethod(
    searchParams:
      | operations["readProductListing post /product-listing/{categoryId}"]["body"]
      | operations["searchPage post /search"]["body"],
  ): Promise<Schemas["ProductListingResult"]>;
  searchDefaults: operations["searchPage post /search"]["body"];
  listingKey: string;
  initialListing?: Schemas["ProductListingResult"] | null;
}): UseListingReturn

source code