Home
Wiki
Home
Wiki
  1. 2. Components
  • Back to home
  • 1. Themes
  • Vs Code
    • Getting Started
  • Kitchenware
    • Layout
      • New Layout
      • Legacy Layout
    • Components
      • Announcement
      • Banner Carousel
      • Banner With Products Carousel
      • Blog Category List
      • Blog List
      • Brand List
      • Brands Carousel
      • Breadcrumb
      • Call To Action
      • Cart
      • Categories List
      • Change Password
      • Checkout
      • Cookie Manager
      • Filter list
      • Footer
      • Forgot Password
      • Form
      • Hero Carousel
      • Icon Block
      • Invitation
      • Last Visited Products
      • Layout
      • Login
      • Map
      • Nav Bar
      • Offer
      • Product Attachments
      • Product Attributes
      • Product Documentation
      • Product Expected
      • Product Modal
      • Products Block
      • Products Carousel
      • Product Single
      • Profile
      • Quote
      • Register
      • Related Products
      • Search
      • Stores
      • Subscribe Newsletter
      • Text with Image
      • Top Bar
      • Video
    • Reusables
      • Getting Started
    • Assets
      • Getting Started
    • SDK
      • Products
        • _findProductsByCategory
        • _findProductsByIds
        • _findProductsByTitle
        • _findProductsByFilter
        • _findProductsByCriteria
        • _findProductsAndCalculate
        • _findProductsThenCalculate
        • _getProductAttributeSet
        • _setLastVisited
      • Categories
        • _findCategoryTreeById
        • _findCategoriesByIds
        • _findCategoryByAlias
        • _findCategoryTreeByAlias
        • _getCategoryContent
      • Collections
        • _getCollectionContent
        • _findCollectionsByIds
        • _findCollectionsByIdsThenCalculate
      • Brands
        • _getBrandContent
        • _findBrandsByIds
      • Cart
        • _addToCartMulti
        • _addToCart
        • _setCart
        • _clearCart
        • _setCartListener
        • _removeFromCart
        • _calculateCart
      • Checkout
        • _startCheckout
        • _updateCheckout
        • _completeCheckout
      • Shopping Lists
        • _getShoppingLists
        • _updateShoppingList
        • _createShoppingList
        • _deleteShoppingList
        • _getShoppingListByAlias
      • Navigation
        • _getFooterMenu
        • _getHeaderMenu
      • Users
        • _getUserById
      • Utils
        • _calculateCurrency
        • _getCurrencySymbol
        • _getCulture
        • _subscribeToNewsletter
        • _findUnitsByIds
  • Noir
    • 0. Introduction
    • 6. FAQ
    • 1. Structure
      • _Overview
      • LayoutA.liquid
      • ComponentsList.liquid
      • Metas.liquid
      • CssVariables.liquid
      • Json.liquid
      • GoogleTagManager.liquid
      • StagingButton.liquid
    • 2. Components
      • _Overview
      • Announcement
      • BannerCarousel
      • BlogCategoryList
      • BlogList
      • BrandList
      • Breadcrumb
      • Cart
      • CategoriesList
      • ChangePassword
      • Checkout
      • CookieManager
      • FilterList
      • Footer
      • ForgotPassword
      • Form
      • IconBlock
      • Invitation
      • LastVisitedProducts
      • Login
      • Map
      • NavBar
      • ProductAttachments
      • ProductAttributes
      • ProductComparison
      • ProductDocumentation
      • ProductMixList
      • ProductsBlock
      • ProductsCarousel
      • ProductSingle
      • Profile
      • Quote
      • Register
      • RelatedProducts
      • SingleBlog
      • Stores
      • TextWithImage
      • ThankYouPage
      • TopBar
      • Wishlist
    • 3. Reusables
      • _Overview
      • Addresses
      • AddressForm
      • AnnouncementModal
      • BackToTop
      • BillingRetail
      • Company
      • General
      • Login
      • LoginModal
      • MonthlyTransactions
      • Orders
      • Payment
      • ProductAttachments
      • ProductAttributes
      • ProductComparisonButton
      • ProductComparisonFloatingButton
      • ProductGridItem
      • ProductListItem
      • ProductModal
      • ProfileInfo
      • PromptModal
      • Quotes
      • Register
      • Services
      • Shipping
      • ShoppingLists
      • ShoppingListsButton
      • ShoppingListsNavbar
      • Toast
      • Transactions
      • Users
      • VariantContent
      • WishlistButton
    • 4. Assets
      • Fonts
      • Images
      • Templates
      • Javascript
        • _Overview
        • theme.js
      • Css - Scss
        • _Overview
        • ThemeClasses
    • 5. SDK
      • _Overview
      • LiquidGlobals
      • ServicesSDK
  1. 2. Components

BrandList

Purpose#

The BrandList component renders a list of brands as:
a responsive Swiper slider (when enableSlider = true), or
a static list/grid-like presentation (when enableSlider = false)
It optionally shows:
a header title
a “Show all brands” button linking to /brands
Each brand links to:
/brand/<alias>

Inputs (model contract)#

Model shape (storefront example)#

{
  "showAllBrandsButton": false,
  "enableSlider": false,
  "brands": [
    {
      "name": "Sample brand name",
      "alias": "sample-brand-alias",
      "mediaItem": {
        "id": "Image Id",
        "link": "https://example.com/sample",
        "mediaType": "Image"
      }
    },
    ...
  ],
  "name": "BrandList",
  "view": "Default",
  "section": "SectionA",
  "settings": {
    "showAllBrandsButton": false,
    "enableSlider": false,
    "id": "Component Id",
    "section": "SectionA",
    "type": "NoirBrandList",
    "name": "BrandList",
    "configuredInContentApi": true,
    "view": "Default",
    "displayName": "",
    "cssClass": "(UNDEFINED)"
  },
  "translations": {
    "showAllBrands": "Sample translation",
    "clickToLearnMoreAbout": "Sample translation",
    "previous": "Sample translation",
    "...": "..."
  }
}

Required fields#

settings.id
Used for:
wrapper id: comp-{{ id }}
swiper container id: brands-carousel-{{ id }}
nav button class suffixes: swiper-button-next-{{ id }}, swiper-button-prev-{{ id }}
brands[]
Component renders only when brands exists and brands.length > 0.

Optional fields#

settings.cssClass
Applied to wrapper only when non-empty and not (UNDEFINED).
settings.header (string)
If present, shown as the section headline.
settings.alignment (string enum)
Affects header alignment classes:
Left (default)
Center
Right
settings.enableSlider (boolean)
If true, Swiper is initialized and next/prev buttons are rendered.
settings.showAllBrandsButton (boolean)
If true, renders a CTA button linking to /brands.

JavaScript#

Global object#

The component exposes a global object:
It’s triggered from the template via Alpine x-init:
x-init="brandlistdefault.swiperInit('{{ id }}', {{ enableSlider }})"
This component does not return Alpine reactive state; it only uses Alpine as a “run-on-mount” hook.

swiperInit(id, enableSlider)#

Initializes Swiper for the BrandList carousel when enableSlider is enabled.
It targets #brands-carousel-<id>, wires optional navigation/pagination elements (when present), and applies responsive breakpoints for slides-per-view.

Dependencies#

Swiper (CSS + JS)
Alpine.js (only for x-init, not for reactive state)

Notes#

If brands[] is empty or missing, the component renders nothing.
If enableSlider is true but Swiper isn’t loaded, the list will not behave as a slider.
Brands without mediaItem.link will use the no-image fallback; depending on mode, the brand name may also appear as text in the card.

Extras#

Template behavior (Liquid + Alpine)#

Header#

If settings.header exists, it prints a title (uppercase).
Alignment is controlled by settings.alignment.

Slider initialization#

If settings.enableSlider is true, Swiper initialization is triggered via:
x-init="brandlistdefault.swiperInit('{{ id }}', {{ enableSlider }})"

Navigation buttons#

If slider is enabled:
renders prev/next buttons
each button includes screen-reader text from translations (previous, next)

“Show all brands” button#

If settings.showAllBrandsButton is true:
renders a CTA linking to /brands
button text comes from translations.showAllBrands
Modified at 2026-05-12 06:45:15
Previous
BlogList
Next
Breadcrumb
Built with