Class: CStore
frontend.CStore
CStore - CromwellCMS Online Store module. Helps to manage shopping cart, convert currency.
Table of contents#
Constructors#
Properties#
Methods#
- addToCart
- addToCompare
- addToViewedItems
- addToWishlist
- applyCouponCodes
- applyProductVariants
- clearCart
- clearComparisonList
- clearViewedItems
- clearWishlist
- convertPrice
- getActiveCurrencySymbol
- getActiveCurrencyTag
- getCart
- getCartTotal
- getCompare
- getCoupons
- getDefaultCurrencyTag
- getPrice
- getPriceWithCurrency
- getViewedItems
- getWishlist
- hasSameQntInCart
- isInCart
- isInCompare
- isInViewedItems
- isInWishlist
- onCartUpdate
- onCompareUpdate
- onViewedItemsUpdate
- onWishlistUpdate
- removeFromCart
- removeFromCompare
- removeFromWishlist
- removeOnCartUpdate
- removeOnCompareUpdate
- removeOnViewedItemsUpdate
- removeOnWishlistUpdate
- saveCart
- saveViewedItems
- setActiveCurrency
- setApiClient
- setCoupons
- updateCart
- updateComparisonList
- updateQntInCart
- updateViewedItems
- updateWishlist
Constructors#
constructor#
• new CStore(local?, apiClient?)
Parameters#
| Name | Type |
|---|---|
local? | boolean |
apiClient? | TApiClient |
Defined in#
system/core/frontend/src/helpers/CStore.ts:66
Properties#
allowedVariantKeysToOverwrite#
• allowedVariantKeysToOverwrite: (keyof TBasePageEntity | "name" | "description" | "mainImage" | "descriptionDelta" | "price" | "oldPrice" | "sku" | "images" | "stockAmount" | "manageStock" | "stockStatus" | "attributes" | "categories" | "rating" | "reviews" | "variants" | "mainCategoryId")[]
What properties of a product variant can overwrite on apply.
Defined in#
system/core/frontend/src/helpers/CStore.ts:560
Methods#
addToCart#
â–¸ addToCart(product, attributes?): TCStoreOperationResult & { missingAttributes?: TAttribute[] }
Parameters#
| Name | Type |
|---|---|
product | TStoreListItem |
attributes? | TAttribute[] |
Returns#
TCStoreOperationResult & { missingAttributes?: TAttribute[] }
Defined in#
system/core/frontend/src/helpers/CStore.ts:228
addToCompare#
â–¸ addToCompare(product): TCStoreOperationResult
Parameters#
| Name | Type |
|---|---|
product | TStoreListItem |
Returns#
Defined in#
system/core/frontend/src/helpers/CStore.ts:322
addToViewedItems#
â–¸ addToViewedItems(item): TCStoreOperationResult
Parameters#
| Name | Type |
|---|---|
item | TStoreListItem |
Returns#
Defined in#
system/core/frontend/src/helpers/CStore.ts:352
addToWishlist#
â–¸ addToWishlist(product): TCStoreOperationResult
Parameters#
| Name | Type |
|---|---|
product | TStoreListItem |
Returns#
Defined in#
system/core/frontend/src/helpers/CStore.ts:296
applyCouponCodes#
â–¸ applyCouponCodes(codes?): Promise<undefined | TCoupon[]>
Parameters#
| Name | Type |
|---|---|
codes? | null | string[] |
Returns#
Promise<undefined | TCoupon[]>
Defined in#
system/core/frontend/src/helpers/CStore.ts:611
applyProductVariants#
â–¸ applyProductVariants(product, checkedAttrs?): TProduct
Applies all ProductVariants from values of checked attributes
Parameters#
| Name | Type |
|---|---|
product | TProduct |
checkedAttrs? | Record<string, (string | number)[]> |
Returns#
TProduct
Defined in#
system/core/frontend/src/helpers/CStore.ts:566
clearCart#
â–¸ clearCart(): void
Returns#
void
Defined in#
system/core/frontend/src/helpers/CStore.ts:452
clearComparisonList#
â–¸ clearComparisonList(): void
Returns#
void
Defined in#
system/core/frontend/src/helpers/CStore.ts:460
clearViewedItems#
â–¸ clearViewedItems(): void
Returns#
void
Defined in#
system/core/frontend/src/helpers/CStore.ts:464
clearWishlist#
â–¸ clearWishlist(): void
Returns#
void
Defined in#
system/core/frontend/src/helpers/CStore.ts:456
convertPrice#
â–¸ convertPrice(price, from, to): string | number
Parameters#
| Name | Type |
|---|---|
price | string | number |
from | string |
to | string |
Returns#
string | number
Defined in#
system/core/frontend/src/helpers/CStore.ts:712
getActiveCurrencySymbol#
â–¸ getActiveCurrencySymbol(): string
Returns#
string
Defined in#
system/core/frontend/src/helpers/CStore.ts:741
getActiveCurrencyTag#
â–¸ getActiveCurrencyTag(): undefined | string
Returns#
undefined | string
Defined in#
system/core/frontend/src/helpers/CStore.ts:726
getCart#
â–¸ getCart(): TStoreListItem[]
Returns#
TStoreListItem[]
Defined in#
system/core/frontend/src/helpers/CStore.ts:206
getCartTotal#
â–¸ getCartTotal(customCart?): Object
Parameters#
| Name | Type |
|---|---|
customCart? | TStoreListItem[] |
Returns#
Object
| Name | Type |
|---|---|
amount | number |
coupons | TCoupon[] |
total | number |
totalOld | number |
Defined in#
system/core/frontend/src/helpers/CStore.ts:469
getCompare#
â–¸ getCompare(): TStoreListItem[]
Returns#
TStoreListItem[]
Defined in#
system/core/frontend/src/helpers/CStore.ts:313
getCoupons#
â–¸ getCoupons(): TCoupon[]
Returns#
TCoupon[]
Defined in#
system/core/frontend/src/helpers/CStore.ts:652
getDefaultCurrencyTag#
â–¸ getDefaultCurrencyTag(): undefined | string
Returns#
undefined | string
Defined in#
system/core/frontend/src/helpers/CStore.ts:661
getPrice#
â–¸ getPrice(price): string
Returns string of a price converted to active currency
Parameters#
| Name | Type |
|---|---|
price | any |
Returns#
string
Defined in#
system/core/frontend/src/helpers/CStore.ts:672
getPriceWithCurrency#
â–¸ getPriceWithCurrency(price, position?): string
Returns price converted to an active currency (picked by user or default) with a symbol of this active currency. Expects input price to be in default currency of the store
Parameters#
| Name | Type |
|---|---|
price | any |
position? | "before" | "after" |
Returns#
string
Defined in#
system/core/frontend/src/helpers/CStore.ts:691
getViewedItems#
â–¸ getViewedItems(): TStoreListItem[]
Returns#
TStoreListItem[]
Defined in#
system/core/frontend/src/helpers/CStore.ts:339
getWishlist#
â–¸ getWishlist(): TStoreListItem[]
Returns#
TStoreListItem[]
Defined in#
system/core/frontend/src/helpers/CStore.ts:287
hasSameQntInCart#
â–¸ hasSameQntInCart(item): boolean
Parameters#
| Name | Type |
|---|---|
item | TStoreListItem |
Returns#
boolean
Defined in#
system/core/frontend/src/helpers/CStore.ts:219
isInCart#
â–¸ isInCart(item): boolean
Parameters#
| Name | Type |
|---|---|
item | TStoreListItem |
Returns#
boolean
Defined in#
system/core/frontend/src/helpers/CStore.ts:214
isInCompare#
â–¸ isInCompare(item): boolean
Parameters#
| Name | Type |
|---|---|
item | TStoreListItem |
Returns#
boolean
Defined in#
system/core/frontend/src/helpers/CStore.ts:317
isInViewedItems#
â–¸ isInViewedItems(item): boolean
Parameters#
| Name | Type |
|---|---|
item | TStoreListItem |
Returns#
boolean
Defined in#
system/core/frontend/src/helpers/CStore.ts:347
isInWishlist#
â–¸ isInWishlist(item): boolean
Parameters#
| Name | Type |
|---|---|
item | TStoreListItem |
Returns#
boolean
Defined in#
system/core/frontend/src/helpers/CStore.ts:291
onCartUpdate#
â–¸ onCartUpdate(cb, id?): string
Parameters#
| Name | Type |
|---|---|
cb | (cart: TStoreListItem[]) => any |
id? | string |
Returns#
string
Defined in#
system/core/frontend/src/helpers/CStore.ts:277
onCompareUpdate#
â–¸ onCompareUpdate(cb, id?): string
Parameters#
| Name | Type |
|---|---|
cb | (cart: TStoreListItem[]) => any |
id? | string |
Returns#
string
Defined in#
system/core/frontend/src/helpers/CStore.ts:330
onViewedItemsUpdate#
â–¸ onViewedItemsUpdate(cb, id?): string
Parameters#
| Name | Type |
|---|---|
cb | (cart: TStoreListItem[]) => any |
id? | string |
Returns#
string
Defined in#
system/core/frontend/src/helpers/CStore.ts:356
onWishlistUpdate#
â–¸ onWishlistUpdate(cb, id?): string
Parameters#
| Name | Type |
|---|---|
cb | (cart: TStoreListItem[]) => any |
id? | string |
Returns#
string
Defined in#
system/core/frontend/src/helpers/CStore.ts:304
removeFromCart#
â–¸ removeFromCart(product): TCStoreOperationResult
Parameters#
| Name | Type |
|---|---|
product | TStoreListItem |
Returns#
Defined in#
system/core/frontend/src/helpers/CStore.ts:273
removeFromCompare#
â–¸ removeFromCompare(product): TCStoreOperationResult
Parameters#
| Name | Type |
|---|---|
product | TStoreListItem |
Returns#
Defined in#
system/core/frontend/src/helpers/CStore.ts:326
removeFromWishlist#
â–¸ removeFromWishlist(product): TCStoreOperationResult
Parameters#
| Name | Type |
|---|---|
product | TStoreListItem |
Returns#
Defined in#
system/core/frontend/src/helpers/CStore.ts:300
removeOnCartUpdate#
â–¸ removeOnCartUpdate(id): void
Parameters#
| Name | Type |
|---|---|
id | string |
Returns#
void
Defined in#
system/core/frontend/src/helpers/CStore.ts:281
removeOnCompareUpdate#
â–¸ removeOnCompareUpdate(id): void
Parameters#
| Name | Type |
|---|---|
id | string |
Returns#
void
Defined in#
system/core/frontend/src/helpers/CStore.ts:334
removeOnViewedItemsUpdate#
â–¸ removeOnViewedItemsUpdate(id): void
Parameters#
| Name | Type |
|---|---|
id | string |
Returns#
void
Defined in#
system/core/frontend/src/helpers/CStore.ts:360
removeOnWishlistUpdate#
â–¸ removeOnWishlistUpdate(id): void
Parameters#
| Name | Type |
|---|---|
id | string |
Returns#
void
Defined in#
system/core/frontend/src/helpers/CStore.ts:308
saveCart#
â–¸ saveCart(cart): void
Parameters#
| Name | Type |
|---|---|
cart | TStoreListItem[] |
Returns#
void
Defined in#
system/core/frontend/src/helpers/CStore.ts:210
saveViewedItems#
â–¸ saveViewedItems(items): void
Parameters#
| Name | Type |
|---|---|
items | TStoreListItem[] |
Returns#
void
Defined in#
system/core/frontend/src/helpers/CStore.ts:343
setActiveCurrency#
â–¸ setActiveCurrency(currency): void
Parameters#
| Name | Type |
|---|---|
currency | string |
Returns#
void
Defined in#
system/core/frontend/src/helpers/CStore.ts:748
setApiClient#
â–¸ setApiClient(client): void
Parameters#
| Name | Type |
|---|---|
client | TApiClient |
Returns#
void
Defined in#
system/core/frontend/src/helpers/CStore.ts:73
setCoupons#
â–¸ setCoupons(coupons): void
Parameters#
| Name | Type |
|---|---|
coupons | TCoupon[] |
Returns#
void
Defined in#
system/core/frontend/src/helpers/CStore.ts:648
updateCart#
â–¸ updateCart(): Promise<void>
Returns#
Promise<void>
Defined in#
system/core/frontend/src/helpers/CStore.ts:435
updateComparisonList#
â–¸ updateComparisonList(): Promise<void>
Returns#
Promise<void>
Defined in#
system/core/frontend/src/helpers/CStore.ts:443
updateQntInCart#
â–¸ updateQntInCart(item): void
Parameters#
| Name | Type |
|---|---|
item | TStoreListItem |
Returns#
void
Defined in#
system/core/frontend/src/helpers/CStore.ts:260
updateViewedItems#
â–¸ updateViewedItems(): Promise<void>
Returns#
Promise<void>
Defined in#
system/core/frontend/src/helpers/CStore.ts:447
updateWishlist#
â–¸ updateWishlist(): Promise<void>
Returns#
Promise<void>