Release notes¶

23.12.2024¶

Styles documentations changes

We have updated documentations for: * pagination styles

09.12.2024¶

Webcomponent events

We have added documentations for events emitted from the Event Bus as well as the custom DOM events along with all the objects and models that they use.

We have also updated the documentation for all webcomponents that utilize these events, adding details about which events are being dispatched or listened to.

We have also added missing documentations for the following webcomponents along with their events usage:

Javascript models

We have moved all of the models documentations to one separate place to make them easier to organize and find.

Besides moving them all we have added a few missing models that are being used across the application:

We have also updated a few models:

We have also rearranged some of them to different subdirectories so that they are easier to find.

JS API documentation changes

We have also updated JS APIs in terms of utilized Event Bus events.

02.12.2024¶

GPSR in ObjectApi

We have added the GPSR elements in Product in ObjectApi:

25.11.2024¶

Module documentations changes

We have updated a documentation for the loyalty-program module specifying what it does more adequately.

We have added a new module documentation for roster_product_recommendation.

Styles documentations changes

We have added a new documentation for Loyalty Program Modal styles.

We have updated documentations for:

Macro documentations changes

We have added documentations for loyalty-program-modal macro.

We have also added a missing macro documentation for color_variant_option.

We have updated documentations for:

Webcomponent documentations changes

We have added a new documentation for the loyalty-program-points webcomponent.

We have also added missing webcomponents for variants which can be found under following links:

We have also moved product_variants webcomponent documentation to its respectful directory and it can now be found under this link.

We have also updated and moved the h-accordion webcomponent to its respectful directory and it can now be found here.

We have also added missing documentations for accordion subwebcomponents:

We have also added three more missing documentations for webcomponents:

18.11.2024¶

New field in Theme System Configuration

We have added a new field viewTransition in Theme System Configuration.

07.11.2024¶

JS API documentation changes

We have improved the JS API index page.

04.11.2024¶

Module documentations changes

We have updated a documentation for the contact-info module specifying what it does more adequately.

Styles documentations changes

We have added a new documentation for Contact Info Modal styles.

28.10.2024¶

New field in CountryShippingCost object added

We have added a new field in CountryShippingCost in ObjectApi.

New field in BasketSettings object added

We have added new field showConfirmationMessage in BasketSettings in ObjectApi.

07.10.2024¶

Numbers syncer - sve element

We added a new sve element Numbers syncer. - Numbers syncer

New fields in ShopInfo object added

We have added two new fields in ShopInfo in ObjectApi: id and version.

30.09.2024¶

New option for Header element in SVE

We have added new option computers_and_tablet for header icon parameter.

16.09.2024¶

New layout in SVE available

We unlocked a new layout in SVE: "Store disabled" page.

26.08.2024¶

JS Api documentation changes

We improved all descriptions for the examples of the Flash Messenger API methods making them easier to understand.

Busses

We have added a documentation for buses - a communication mechanism for handling events and messages used in Storefront.

The documentation is divided into four parts:

Buses main page explaining what buses are
Command Bus page dedicated for the command bus
Event Bus dedicated for the event bus
Query Bus dedicated for the query bus

We have also added documentations for methods used in each bus as well as objects that will help use them correctly.

19.08.2024¶

New fields in ShopInfo object added

We have added new fields in ShopInfo in ObjectApi.

05.08.2024¶

getShopOffInformation method added in ObjectApi

We have added a new method getShopOffInformation in ObjectApi.

Language-Selector & Country-Selector

We have added two new selectors: countrySelector and languageSelector

29.07.2024¶

JS API documentations changes

We have added a new JS API documentation for the Product Ask Questions API as well as documentations for its methods, models and objects.

We have also updated a JS API documentation for the Flash Messenger API as well as documentations for its methods.

We have also renamed t-flash-message-dto object documentation to t-flash-message-options.

We have also added a missing object documentation for t-flash-messenger.

Macro documentations changes

We have added documentations for product_ask_questions_form macro and product_ask_questions_modal_form macro.

We have updated a documentation for control_textarea macro adding a controlValidators attribute to make the validators the same as in the control_input macro.

It's a breaking change. If you have used any validator attributes in the control_textarea macro they won't work anymore. You should change those attributes according to the examples in the documentation page

Module documentations changes

We have updated a documentation for the product_ask_questions module specifying what it does more adequately.

Styles documentations changes

We have added a new documentation for Product Ask Questions Modal styles.

Webcomponent documentations changes

We have added a new documentation for the product-ask-questions webcomponent.

22.07.2024¶

Returned value on Product.category in ObjectApi has changed

In situation when main category is inactive on product, Product.category will return NULL instead of Category object. More information on Product object.

Returned value of method getCategory() in ObjectApi has changed

In situation when category is inactive, method getCategory() will return NULL instead of Category object. More information on getCategory method.

15.07.2024¶

getCountry method added in ObjectApi

We have added a new method getCountry in ObjectApi.

getLocale method added in ObjectApi

We have added a new method getLocale in ObjectApi.

UsersSettings.isFullRegistrationMode - removed

UsersSettings.isFullRegistrationMode property has been removed.

08.07.2024¶

Object Api

We have added a new fields in SpecialOffer object: isPercentage and isAmount. Together they determine how the discount value should be interpreted and applied. They provide a clear indication of whether the discount is a fixed monetary amount or a percentage of the original price, ensuring accurate calculation and application of discounts in various contexts. Documentation you can find in SpecialOffer object.

Device dependent - sve element

We added a new sve element Device dependent.

Device dependent

JS API documentations changes

We have improved the documentation for the Customer Privacy API as well as documentations for its methods.

We have also fixed a typo and renamed a withdrawnConsents method to withdrawConsents.

We have also added a few missing methods:

We have also improved the documentation for the Newsletter Form API and it's now consistent with other documentation files.

24.06.2024¶

UsersSettings.isFullRegistrationMode - DEPRECATED

UsersSettings.isFullRegistrationMode option is deprecated and will be removed in the next version. Full registration is disabled in Storefront.

18.06.2024¶

Logo module

We have fixed the logo module. Now it is possible to use text instead of an image.

10.06.2024¶

New module

We have added a new module: header

Font size - sve element

We added a new sve element Font size.

Font size

06.06.2024¶

JS API documentations changes

We have improved the documentation for the Recaptcha API as well as documentations for its methods.

We have also improved the documentation for the Rate And Review API as well as documentations for its methods. We have also added a few missing methods and updated the hasAlreadyVoted method which is now called hasBeenReviewed

Macro documentations changes

We have updated a documentation file for the image macro. From now on it also takes <picture> tag attributes.

13.05.2024¶

Skin style system configuration

We have added new setting to skin style configuration: productTileHeight. Full documentation.

08.05.2024¶

JS API documentations changes

We have added a new model documentation for the BundleItem model.

Macro documentations changes

We have updated documentations for:

adding various things related to bundles to them.

Module documentations changes

We have updated documentations for:

making sure that all the linked reference pages are correct.

Styles documentations changes

We have updated documentations for:

adding missing subclasses to them.

We have also renamed bundle-product-item-tile documentation to product-bundle-item-tile.

We have also added a new documentation for grid styles and updated its reference in a bunch of module and macro documentations that should now work correctly.

Webcomponent documentations changes

We have updated documentations for:

making sure they are up to date.

We have also renamed loyalty-add-to-basket documentation to loyalty-buy-button and updated it accordingly.

We have also added a new documentation for buy-button webcomponent and product-variants webcomponent.

06.05.2024¶

getCategories method added in ObjectApi

We have added a new method getCategories in ObjectApi.

Skin style system configuration

We changed element names in skin style configuration.

From	To
primaryColors500	primaryColor
secondaryColors500	secondaryColor
neutralColors500	neutralColor

19.04.2024¶

Macros documentations changes

Docmuentation to product_variants macro has been updated.

25.04.2024¶

JS API documentations changes

We have added a new JS API documentation for the Storefront Settings API as well as documentations for its methods, models and objects.

We have also moved documentation for TLocaleIsoUnderscore from the objects of the translations api to global locale objects and it now can be found here. We have updated all places where it was used respectively.

We have also added two new documentactions for locale objects: TCurrencyIsoCode and TLocaleOptions.

18.04.2024¶

JS API documentations changes

We have added a new JS API documentation for the Resolution Detector API as well as documentations for its methods and models.

15.04.2024¶

Producer selector - sve element

We added a new sve element Producer selector.

Producer selector

09.04.2024¶

Category selector - sve element

We added a new sve element Category selector.

Category selector

01.04.2024 - 05.04.2024¶

JS API documentations changes

We have added a new JS API documentation for the Search API as well as documentations for its models and objects. We have also improved the documentation for the Translations API also adding its models and objects and describing more specificly what can be done with this API.

We have also added a few global models and objects that are being used used across JS APIs to make viewing the data coming from the API requests easier. Those are:

Address object has also been moved to the models and became an Address model.

25.03.2024 - 29.03.2024¶

New macros

We have added the photo_slider macro that provides more flexibility to the usage of the photo slider. photo_slider module has also been updated and is now using the new macro.

11.03.2024 - 15.03.2024¶

Inactive product/bundle

We added new context layout Inactive product/bundle.

04.03.2024 - 08.03.2024¶

Skin style system configuration

We have added new settings to skin style configuration: btnColorPrimary, secondaryButtonStyle, btnBgColorSecondary, btnColorSecondary, textColorOnTheButton, btnColorOutline. Full documentation.
We changed name of setting btnBorderWidth to btnBorderWidthOutline.

New modules

We have added new module related to product bundles: bundle_items

New macros

We have added new macros that allow for better usage flexibility: product_producer, product_short_description, product_quantity and product_availability. Their modules have been updated respectively.
We have added a new macro related to bundles: product_bundle_item_tile.

New webcomponents

We have added new webcomponents related to product bundles: bundle-item and product-bundles

New styles documentation

We have added new styles documentation related to bundles: Bundle Items and Bundle Product Item Tile

19.02.2024 - 23.02.2024¶

Object Api

We have added a new field in Product object: promotingImage. It contains ProductImage object of an image linked with default variant - if it is in special offer, a product main image otherwise. Documentation you can find in Product object.

12.02.2024 - 16.02.2024¶

Object Api

We have changed the type of the returned object for the loyaltyProductsListUrl property from Url to LoyaltyProductsListUrl in getShopUrls method and added a LoyaltyProductsListUrl object to the getUrl method.

Product options in Bundle Item element

We added 2 new fields in BundleItem object: stockProductOptions and notStockProductOptions. Documentation you can find in BundleItem object.

Url to loyalty product page

We added a new field in the Product object: loyaltyUrl. Documentation you can find in LoyaltyProductUrl object.

Product quantity and availability

We added two new macros: product_availability and product_quantity that will now be used by the product_quantity_and_availability module but can also be rendered separately.

Product title

We have updated the set options parameter name to bundle product_title_tag_group macro for better clarity, aligning it more closely with its intended purpose. We also modified the product_title module giving it the ability to display bundle tags properly.

29.01.2024 - 02.02.2024¶

Loyalty Program

We added a documentation for the Loyalty Program and getLoyaltyProgramSettings method.

18.12.2023 - 22.12.2023¶

JS API documentation

We improved a documentation for the Favourites API and its methods.

04.12.2023 - 08.12.2023¶

Theme documentation

We added a missing layout theme documentation.

Theme development documentation has been refactored to improve its readability.

27.11.2023 - 01.12.2023¶

Styling documentation

We added a missing macro documentation for Grid Spacing.

20.11.2023 - 24.11.2023¶

Macro documentation

We have added a few missing documentations:

Some of the documentations have been refactored to improve their readability:

Some of the links across the following documentations have been updated:

Modules documentation

We have added a missing documentation for Modules development.

Some of the links across the following documentations have been updated:

Styling documentation

Some of the links across the following documentations have been updated:

Theme documentation

We have added a missing documentation for a Theme layout.

Webcomponents documentation

Some of the links across the following documentations have been updated:

Documentation link tree

Module links

Some of the links have been renamed to resemble their purpose more and be easier to navigate:

Bottom menu (all links in the footer) -> Footer group
Side menu (selected links in the footer) -> Footer groups
Menu (links in the header) -> Main navigation
Search engine -> Search
Consents -> Customer privacy
Image -> Picture
Slider -> Photo slider
Rich content -> Wysiwyg
Selected blog articles (slider) -> Blog articles slider
Files to download -> Blog article files
Tag name (page title) -> Blog tag list title
Article comments -> Blog article comments
List of blog articles -> Blog articles list
Tag cloud -> Blog articles list tags
Blog categories -> Blog articles list categories
Articles category (page title) -> Blog category list title
Category name (page title) -> List category title
Category description (top) -> List category description
Category description (bottom) -> List category additional description
Collection name (page title) -> List collection title
Collection description (top) -> List collection description
Collection description (bottom) -> List collection additional description
Page title -> List new title
Page title -> List producer title
Vendor's description -> List producer description
Page title -> List promotions title
List of products -> List context products
Sum of products -> List number of products
New products -> Roster new products
Products on sale -> Roster product promotions
Bestsellers roster -> Roster product bestsellers
Collection (selected from the list) -> Roster product collection
Products of the day -> Roster products of the day
Product name (page title) -> Product title
Product features -> Product attributes
Vendor -> Product producer
Related products -> Product related
Shipping time -> Product shipping time
Files to download -> Product files
Product image gallery -> Product gallery
Prices -> Product prices
Product reviews -> Product review
Add to cart/Wishlist -> Product actions
Quantity and availability -> Product quantity and availability
Wishlist -> Favourites button

Macro links

product_file documentacion has been removed as the macro no longer exists.

JS Api links

FormApi has been removed as it no longer exists.

All other documentations were reorganised alphabetically.

JS Features links

The entire section has been removed as it no longer exists.

Styling links

A link to Article documentation has been updated and now is correct.

06.11.2023 - 10.11.2023¶

Macro documentation

We added a few missing macro documentations:

Some of the documentations were refactored to improve their readability:

23.10.2023 - 04.11.2023¶

Introduction

Shoper documentation introduction has been added.

Macro documentation

We added a few missing macro documentations:

Some of the documentations were refactored to improve their readability:

We also renamed a few macros and reworked their documentations as the ones listed above:

base_price -> price_base
special_offer_price -> price_special

Modules documentation

We added a missing module reference in the Modules introduction.

We fixed broken links in product_variants documentation.

Object Api documentation

Object Api introduction has been refactored to improve readability.

All of the Object Api objects documentations were refactored to improve their readability.

Product's special-offer documentation has been also renamed to variant-special-offer

Theme documentation

Theme introduction has been refactored to improve readability.

Webcomponents documentation

Form management introduction has been refactored to improve readability.

Following webcomponent documentations were reorganised or modified to improve readability and consistency across them:

Contact form:

contact-form

Customer privacy:

Form:

Icons:

h-icon

Menu:

s-menu

Pagination:

pagination-page-number

Product:

Rate and review:

product-rating-form

Surfaces:

Utils:

h-portal