shopware/frontends - composables

Set of Vue.js composition functions that can be used in any Vue.js project. They provide state management, UI logic and data fetching and are the base for all guides in our building section.

Features

• createShopwareContext method to create a Vue 3 plugin to install
• State management
• Logic for UI
• Communication with Store-API via api-client package

Setup

Install npm packages (composables & api-client):

# Using pnpm
pnpm add @shopware/composables @shopware/api-client @shopware/api-gen

# Using yarn
yarn add @shopware/composables @shopware/api-client @shopware/api-gen

# Using npm
npm i @shopware/composables @shopware/api-client @shopware/api-gen

Now generate your types ysing the CLI:

pnpm shopware-api-gen generate --apiType=store

Initialize the api-client instance:

import { createAPIClient } from "@shopware/api-client";
import type { operations } from "#shopware";

export const apiClient = createAPIClient<operations>({
  baseURL: "https://your-api-instance.com",
  accessToken: "your-sales-channel-access-token",
});

// and then provide it in the Vue app
app.provide("apiClient", apiClient);

Now, we can create a Vue 3 plugin to install a Shopware context in an app:

import { createShopwareContext } from "@shopware/composables";

// app variable in type of App
const shopwareContext = createShopwareContext(app, {
  devStorefrontUrl: "https://your-sales-channel-configured-domain.com",
});
// register a plugin in a Vue instance
app.use(shopwareContext);

Exclude @shopware/composables package from pre-building process:

// vite.config.js or .ts
...
optimizeDeps: {
  exclude: ["@shopware/composables"],
},
...

The example does not provide the session handling and that means you need to do few additional steps if you need to keep your session after the page reload (see the chapter below with 🍪)

Basic usage

Now you can use any composable function in your setup function:

<script setup>
    import { useUser, useSessionContext } from "@shopware/composables/dist";

    const { login } = useUser();
    const { refreshSessionContext, sessionContext } = useSessionContext();
    refreshSessionContext();
</script>
<template>
    <pre>{{ sessionContext }}</pre>
    <button @click="login({
        username: "some-user",
        password: "secret-passwd"
    })">
        Try to login!
    </button>
</template>

Session persistence with 🍪

By default, the API-Client is stateless, but accepts an optional context token as a parameter while initializing an instance. In order to keep a session, install some cookie parser to work with cookies easier:

# Using pnpm
pnpm add js-cookie

# Using yarn
yarn add js-cookie

# Using npm
npm i js-cookie

Let's get back to the step where the api-client was initialized:

import { createAPIClient } from "@shopware/api-client";
import Cookies from "js-cookie";
import type { operations } from "#shopware";

const shopwareEndpoint = "https://demo-frontends.shopware.store/store-api";

export const apiClient = createAPIClient<operations>({
  baseURL: shopwareEndpoint,
  accessToken: "SWSCBHFSNTVMAWNZDNFKSHLAYW",
  contextToken: Cookies.get("sw-context-token"),
});

apiClient.hook("onContextChanged", (newContextToken) => {
  Cookies.set("sw-context-token", newContextToken, {
    expires: 365, // days
    path: "/",
    sameSite: "lax",
    secure: shopwareEndpoint.startsWith("https://"),
  });
});

Thanks to this, the session will be kept to the corresponding sw-context-token saved in the cookie, so it can be reachable also in the SSR. Check the example to see it in action:

TypeScript support

All composable functions are fully typed with TypeScript and they are registed globally in Nuxt.js application, so the type hinting will help you to work with all of them.

Links

• 📘 Documentation

• 👥 Community Discord (#composable-frontend)

Changelog

Full changelog for stable version is available here

Latest changes: 1.10.0

Minor Changes

• #2098 a44d871 Thanks @mdanilowicz! - Enhanced the useSyncWishlist composable by exposing the limit, products, and isLoading properties, allowing better control and monitoring of the wishlist state. Similarly, updated useWishlist to also expose limit, products, and isLoading properties for both local and synced wishlists, providing a consistent API and improved state handling for wishlist management.

• #1997 e43d9b7 Thanks @mdanilowicz! - Added consts SUBSRIBE_KEY and UNSUBSCRIBE_KEY for newsletter status in useNewsletter composable

• #1974 7fe2ef9 Thanks @mkucmus! - Use proper associations format within useDefaultOrderAssociations (no redundant nesting).

  Returned value is in type of Schemas["Criteria"]['associations'] now:

  const { loadOrders } = useCustomerOrders();
  
  loadOrders({
    // ... other parameters
    associations: useDefaultOrderAssociations(),
  });

• #2176 c647baf Thanks @mkucmus! - - Add initialListing parameter to useListing composable for SSR data hydration

  • Update createCategoryListingContext to accept initial listing data
  • Maintain backward compatibility with existing implementations

• #1959 c77daa6 Thanks @patzick! - Updated default types to Shopware 6.7

Patch Changes

• 87771c3 Thanks @mkucmus! - add nested media entity association explicitly

• #1985 2cbda25 Thanks @mkucmus! - Change isInWishlist property type to ComputedRef within useProductWishlist composable.

• Updated dependencies [22ff62e, 2cbda25, 70dcf95, 56cd178, e1fae3e, c647baf, c77daa6]:

  • @shopware/[email protected]
  • @shopware/[email protected]