Home > @shopware-pwa/composables > IUseListing

IUseListing interface

Listing interface, can be used to display category products, search products or any other Shopware search interface (ex. orders with pagination)

Signature:

export interface IUseListing<ELEMENTS_TYPE> 

Properties

Property	Type	Description
changeCurrentPage	(pageNumber?: number | string) => Promise<void>
changeCurrentSortingOrder	(order: string | string[]) => Promise<void>
getAvailableFilters	ComputedRef<ListingFilter[]>
getCurrentFilters	ComputedRef<any>
getCurrentListing	ComputedRef<Partial<ListingResult<ELEMENTS_TYPE>> | null>
getCurrentPage	ComputedRef<string | number>
getCurrentSortingOrder	ComputedRef<string | undefined>
getElements	ComputedRef<ELEMENTS_TYPE[]>
getInitialListing	ComputedRef<ListingResult<ELEMENTS_TYPE> | null>
getLimit	ComputedRef<number>
getSortingOrders	ComputedRef<Sort[] | { key: string; label: string; }>
getTotal	ComputedRef<number>
getTotalPagesCount	ComputedRef<number>
initSearch	(criteria: Partial<ShopwareSearchParams>) => Promise<void>
loading	ComputedRef<boolean>
loadingMore	ComputedRef<boolean>
loadMore	() => Promise<void>
search	(criteria: Partial<ShopwareSearchParams>, options?: { preventRouteChange?: boolean; }) => Promise<void>
setInitialListing	(initialListing: Partial<ListingResult<ELEMENTS_TYPE>>) => void