@shopware-pwa/helpers-next

shopware/frontends - helpers

Welcome to @shopware-pwa/helpers-next package.

For getting started documentation visit https://frontends.shopware.com/

Documentation specific for this package: helpers

Reusable classes

The helpersCssClasses variable, defined in the cms/layoutClasses.ts helper file, comprises an array of class names utilized within the CMS.

To enhance type support, a union type HelpersCssClasses is defined, which encompasses all class names present in the helpersCssClasses array.

const visibilityMap: Record<CmsVisibility, HelpersCssClasses> = {
  mobile: "max-md:hidden",
  tablet: "md:max-lg:hidden",
  desktop: "lg:hidden",
};

These classes can be integrated into a custom template, thereby ensuring consistency across different packages. For example as a safelist classes in unocss configuration file

import { helpersCssClasses } from "@shopware-pwa/helpers-next";

export default defineConfig({
  safelist: helpersCssClasses,
});

Changelog

Full changelog for stable version is available here

Latest changes: 0.0.0-canary-20240627111835

Major Changes

• #871 1566f7a Thanks @patzick! - Read more about new major release: https://github.com/shopware/frontends/discussions/965

• #1056 c729e70 Thanks @patzick! - Removed deprecations from the package:

  • getProductThumbnailUrl is removed. Use getSmallestThumbnailUrl instead.
  • internal method _debounce is removed.
  • internal method _parseUrlQuery is removed.

Minor Changes

• #857 864616f Thanks @mdanilowicz! - Add isMaintenanceMode to check if backend is available

• #508 a92941e Thanks @mdanilowicz! - Add accessGranted property for the getMedia helper

• #477 487d991 Thanks @mdanilowicz! - Remove "@shopware-pwa/types" dependency and replace it with generic types

• #582 97b5949 Thanks @mdanilowicz! - Export css classes as a separate file

• #545 6664aa2 Thanks @itscark! - Fix visibility classes

Patch Changes

• #524 6b54268 Thanks @BrocksiNet! - added buildUrlPrefix, which perviously was internal helper of the @shopware/cms-base package