| Property | Type |
|---|
filtersPrefix | string |
| Property | Type |
|---|
autoImports? | boolean |
| Property | Type |
|---|
defaultSortingKey? | string |
sortingOptions | MaybeRefOrGetter<SelectedSort> |
| Property | Type |
|---|
fetchingKey | string |
fetchingOptions | Partial<{ immediate: boolean; lazy: boolean; }> |
params | Ref<Omit<FetchProductsByCategoryParams, "category">> |
| Property | Type | Description |
|---|
appliedAttributeValues | ComputedRef<AppliedAttributeValues> | A computed property that returns a record mapping attribute keys to arrays of numbers representing selected values for each attribute. |
appliedBooleanValues | ComputedRef<AppliedBooleanValues> | A computed property that returns a record mapping attribute keys to their boolean values for boolean filters. |
appliedFilter | ComputedRef<ProductSearchQuery> | A computed property returning a ProductSearchQuery object based on the route's query parameters. |
appliedFiltersCount | ComputedRef<number> | A computed property that returns the total count of applied filters. Counts minPrice/maxPrice as one and counts each attribute filter separately. |
areFiltersApplied | ComputedRef<boolean> | A computed property that returns true if any filters are currently applied, otherwise false. |
| Property | Type | Description |
|---|
canonicalLink | ComputedRef<CanonicalLink> | A computed canonical link. |
categoryBreadcrumbSchema | ComputedRef<[] | WithContext<...>> | A computed breadcrumb schema. |
robots | ComputedRef<string> | A computed robots. Value can be index,follow or noindex,follow. |
title | ComputedRef<string> | A computed string that is constructed from breadcrumb values. |
| Property | Type | Description |
|---|
isDefaultSortSelected | ComputedRef<boolean> | Indicating if the default sort is selected. |
selectedSort | ComputedRef<undefined | SelectedSort> | The currently selected sorting option. |
sortLinks | ComputedRef<SortLink> | Links with updated query parameters for each sorting option. |
| Name | Type |
|---|
key | string |
label | string |
| Name | Type |
|---|
to | RouteLocationRaw |
| Name | Type | Description |
|---|
availableFilters | ComputedRef<...> | Returns computed available filters. |
filteredProductCount | ComputedRef<...> | Returns the count of the products which the applied filter returns. |
| Name | Type | Description |
|---|
pagination | ComputedRef<...> | A computed object containing pagination details for the product list. |
paginationOffset | ComputedRef<...> | - |
products | ComputedRef<...> | A computed array of products in the specified category. |
totalProductsCount | ComputedRef<...> | A computed offset for the current page based on the pagination data. |
| Name | Type | Default value |
|---|
by | "new" | APISortOption.DATE_ADDED |
direction | "desc" | APISortOrder.DESCENDING |
key | string | 'date_newest' |
| Name | Type | Default value |
|---|
by | "price" | APISortOption.PRICE |
direction | "asc" | APISortOrder.ASCENDING |
key | string | 'price_asc' |
| Name | Type | Default value |
|---|
by | "price" | APISortOption.PRICE |
direction | "desc" | APISortOrder.DESCENDING |
key | string | 'price_desc' |
| Name | Type | Default value |
|---|
by | "reduction" | APISortOption.REDUCTION |
direction | "desc" | APISortOrder.DESCENDING |
key | string | 'reduction_desc' |
| Name | Type | Default value |
|---|
direction | "desc" | APISortOrder.DESCENDING |
key | string | 'top_seller' |
sortingKey | string | 'scayle:v1:balanced-offerings' |
| Type Parameter | Default type |
|---|
DataT | ShopCategory |
PickKeys extends KeysOf<DataT> | KeysOf<DataT> |
DefaultT | null |
| Parameter | Type | Default value |
|---|
__namedParameters | Partial<{ options: UseRpcOptions<..., ..., ..., ...>; params: MaybeRefOrGetter<...>; }> | {} |
key | string | 'useAllShopCategoriesForId' |
UseRpcReturn<"getAllShopCategoriesForId", DataT, PickKeys, DefaultT>
Composable to manage applied filters based on route query parameters.
| Parameter | Type | Description |
|---|
route | RouteLocationNormalizedLoadedGeneric | Route object to handle the queries. |
options | AppliedFiltersOptions | Configuration options for applied filters. |
UseAppliedFiltersReturn
An object containing reactive data and computed properties for managing applied filters:
Composable to manage filters based on current category ID and route query parameters.
- An object containing reactive data, computed properties and async RPC call for managing filters:
Composable for handling product listing SEO data.
| Parameter | Type | Description |
|---|
breadcrumbs | MaybeRefOrGetter<BreadcrumbItem> | Breadcrumb items. |
route | RouteLocationNormalizedLoadedGeneric | The route object to handle queries. |
params | UrlParams | URL data for constructing the canonical link. |
isDefaultSortSelected | MaybeRefOrGetter<boolean> | If the default sort is applied on the listing. |
UseProductListingSeoDataReturn
An object containing reactive data and computed properties for managing SEO data.
Custom composable to handle product list sorting.
| Parameter | Type | Description |
|---|
route | RouteLocationNormalizedLoadedGeneric | Route object to handle the queries and path. |
options | ProductListSortOptions | Options for configuring the sorting behavior. |
UseProductListSortReturn
Computed properties and methods related to sorting
Composable to fetch and manage products by category with configurable options.
An object containing reactive data and computed properties for managing products by category.
