Home > @vue-storefront/core

# core package

Core Vue Storefront 2 library.

# Remarks

The @vue-storefront/core library is a core of the whole Vue Storefront 2 application. It defines common interfaces for all eCommerce integrations, factories for creating composables, logger, SSR helpers and more.

# Enumerations

Enumeration Description
AgnosticOrderStatus

# Functions

Function Description
renderContentFactory(factoryParams)
sharedRef(value, key)
sharedRef(key, _)
track(id)
useCategoryFactory(factoryParams)
useContentFactory(factoryParams)
useForgotPasswordFactory(factoryParams)
useProductFactory(factoryParams)
useReviewFactory(factoryParams)
useSearchFactory(factoryParams)
useStoreFactory(factoryParams)
useUserOrderFactory(factoryParams)
wrap(element)

# Interfaces

Interface Description
AfterCallParams
AgnosticAddress
AgnosticAttribute
AgnosticBreadcrumb
AgnosticCategoryTree
AgnosticCountry
AgnosticCoupon
AgnosticCurrency
AgnosticDiscount
AgnosticFacet
AgnosticFacetSearchParams
AgnosticFilter
AgnosticGeoLocation
AgnosticGroupedFacet
AgnosticLocale
AgnosticMediaGalleryItem
AgnosticPagination
AgnosticPrice
AgnosticProductReview
AgnosticRateCount
AgnosticSort
AgnosticSortByOption
AgnosticStore
AgnosticTotals
ApiClientConfig
ApiClientExtension
ApiClientExtensionHooks
ApiClientFactory
ApiClientFactoryParams
ApiInstance
BeforeCallParams
CallHookParams
CartGetters
CategoryGetters
CheckoutGetters
Composable
Context
FacetSearchResult
FacetsGetters
FactoryParams
ForgotPasswordGetters
HookParams
Integration
IntegrationContext
MiddlewareConfig
ProductGetters
ProductsSearchParams
RenderComponent
ReviewGetters
UseBilling
UseBillingErrors
UseBillingParams
UseCart
UseCartErrors
UseCartFactoryParams
UseCategory
UseCategoryErrors
UseCategoryFactoryParams
UseCheckout
UseCompare
UseContent
UseContentErrors
UseContentFactoryParams
UseFacet
UseFacetErrors
UseFacetFactoryParams
UseForgotPassword
UseForgotPasswordErrors
UseForgotPasswordFactoryParams
UseMakeOrder
UseMakeOrderErrors
UseMakeOrderFactoryParams
UseProduct
UseProductErrors
UseProductFactoryParams
UserBillingGetters
UseReview
UseReviewErrors
UseReviewFactoryParams
UserGetters
UserOrderGetters
UserShippingGetters
UseSearch
UseSearchErrors
UseSearchFactoryParams
UseSearchGetters
UseShipping
UseShippingErrors
UseShippingParams
UseShippingProvider
UseShippingProviderErrors
UseShippingProviderParams
UseStore
UseStoreErrors
UseStoreFactoryChangeParamArguments
UseStoreFactoryLoadParamArguments
UseStoreFactoryParams
UseStoreGetters
UseStoreInterface
UseUser
UseUserAddress
UseUserBilling
UseUserBillingErrors
UseUserBillingFactoryParams
UseUserErrors
UseUserFactoryParams
UseUserLoginParams
UseUserOrder
UseUserOrderErrors
UseUserOrderFactoryParams
UseUserOrderSearchParams
UseUserRegisterParams
UseUserShipping
UseUserShippingErrors
UseUserShippingFactoryParams
UseWishlist
UseWishlistErrors
UseWishlistFactoryParams
VSFLogger
WishlistGetters

# Variables

Variable Description
apiClientFactory
configureContext
configureFactoryParams
configureSSR
generateContext
integrationPlugin
Logger
mask
onSSR
registerLogger
useBillingFactory
useCartFactory
useFacetFactory
useMakeOrderFactory
useShippingFactory
useShippingProviderFactory
useUserBillingFactory
useUserFactory
useUserShippingFactory
useVSFContext
useWishlistFactory
VSF_COUNTRY_COOKIE Default name of the cookie storing active country code
VSF_CURRENCY_COOKIE Default name of the cookie storing active currency code
VSF_LOCALE_COOKIE Default name of the cookie storing active localization code
VSF_STORE_COOKIE Default name of the cookie storing active store code
vsfRef

# Type Aliases

Type Alias Description
AfterCallArgs
ApiClientMethod
ApiClientMethods
BeforeCallArgs
ComposableFunctionArgs
ComputedProperty
ContextedPlatformApi
CreateApiClientFn
CreateApiProxyFn
CustomQuery
CustomQueryFn
IntegrationsSection
PlatformApi
RenderContentFactoryParams