Skip to content

Config Schema ​

Full reference of all theme.json fields shipped by DmfGuppyTheme, grouped by area. Admin access: Content → Themes → Guppy Theme → Configure.

Layout & container ​

Container widths ​

FieldTypeDefaultDescription
guppy-container-width-defaulttext1400pxDefault container
guppy-container-width-fluidtext100%Fluid container
guppy-container-width-smtext1230pxSmall container

Container padding ​

BreakpointFieldDefault
XXLguppy-container-default-padding-x-xxl48px
XLguppy-container-default-padding-x-xl48px
LGguppy-container-default-padding-x-lg48px
MDguppy-container-default-padding-x-md48px
SMguppy-container-default-padding-x-sm24px
Mobileguppy-container-default-padding-x-mobile10px

General settings ​

Tab Layout, block General settings:

FieldTypeDefaultEffect
guppy-border-radiustext4pxBase corner radius of the theme (since 2.9.0)
guppy-slider-arrows-roundswitchoffRound slider arrows (since 2.9.0)
guppy-ui-icons-phosphorswitchoffPhosphor glyphs for form and UI controls (since 2.9.0)

Border radius (guppy-border-radius): a px value is converted to rem (4px = 0.25rem), a rem value is used as is, and a value without a unit counts as px (0 gives square corners, 8 equals 8px). An empty field or another unit falls back to 0.25rem. The field sets Bootstrap's $border-radius (--bs-border-radius) for cards, the account menu, .btn-close, gallery thumbnails, filter elements and the other components that use the base radius. The small, large and extra-large radii are derived from it with fixed ratios (×0.6, ×1.5, ×3, ×6), so footer logos and slider arrows follow it too. With the default 4px the output is the same as before 2.9.0. Inputs and buttons keep Input & Button border radius (sw-input-btn-border-radius), product boxes keep the radius of the Guppy Cards tab (guppy-cards-border-radius).

Round slider arrows (guppy-slider-arrows-round): when on, the previous/next and play/pause buttons of the image slider, image gallery and Splide slider elements are circles, regardless of the border radius. Product and cross-selling sliders keep their arrows. When off, the arrows keep the base radius × 2 (rounded squares).

Phosphor icons for form and UI controls (guppy-ui-icons-phosphor): when on, the close button X, the select arrow, the checkbox tick, the accordion arrow and the validation icons of form fields use Phosphor glyphs in the bold weight instead of Bootstrap's glyphs. Colours, sizes and positions stay. Guppy hides the validation icons, so these two only show in a child theme that enables them. Radio dot, indeterminate checkbox, switch knob and the dark colour mode keep Bootstrap's glyphs. The SCSS variables behind it are listed under Theme Variables → Icons.

CMS section padding ​

Adds extra padding controls to Shopping Experience sections, directly in the section settings modal:

FieldTypeDefaultDescription
guppy-cms-section-padding-xtext48pxHorizontal padding
guppy-cms-section-padding-ytext48pxDefault vertical padding
guppy-cms-section-padding-y-2xtext96pxExtra vertical padding (2x)

Section options in the editor:

OptionEffect
Horizontal paddingToggle
Padding top & bottomDefault Y padding
Extra Large (2x)Double Y padding
Padding topTop only (with No spacing option)
Padding bottomBottom only (with No spacing option)

Customise in a child theme:

scss
$guppy-cms-section-padding-x:    32px;
$guppy-cms-section-padding-y:    64px;
$guppy-cms-section-padding-y-2x: 128px;

Header variant ​

FieldTypeOptionsDefault
guppy-headerselectdefault, compact, extended, simpleextended
VariantDescription
defaultShopware default header
compactGuppy default, compact
extendedWith top bar
simpleMinimalist

Header options ​

FieldTypeDefaultEffect
guppy-header-max-heighttext22pxMax logo height
guppy-topbar-background-colorcolor#EEEEEETop bar background colour
guppy-header-skip-to-main-contentboolfalseSkip link to main content
guppy-header-skip-to-main-navboolfalseSkip link to navigation
guppy-header-skip-to-searchboolfalseSkip link to search

Skip links default to on in 3.0.0

Guppy 3.0.0 changes the default of the three skip link fields to true, so the storefront renders skip links with default config, as Shopware core does. Until then the default config renders none. To keep them off after 3.0.0, store false for the three fields now. The theme manager only saves values that changed since the page was loaded, so switch each field on, save, switch it off and save again.

FieldTypeOptionsDefault
guppy-footerselectdefault, guppy-defaultguppy-default
FieldTypeDefaultEffect
guppy-footer-border-top-colortextdefault-borderTop border color
guppy-footer-show-payment-methodsboolfalseShow payment methods
guppy-footer-show-shipping-methodsboolfalseShow shipping methods

Custom fields for shipping / payment methods ​

DmfGuppyTheme registers the custom field set guppy_footer_options:

FieldTypeEffect
guppy_hide_in_footerboolIf active: don't render the method in the footer
guppy_alternative_labeltextOverrides the tooltip name on hover

As of 2.7.12 no longer theme configuration, but the custom field set guppy_social_media_links on the sales_channel entity, which makes the links per sales channel and per language. Every field is of type text and expects the full URL.

FieldPlatform
guppy_social_media_instagram_threadsInstagram Threads
guppy_social_media_instagramInstagram
guppy_social_media_linkedinLinkedIn
guppy_social_media_youtubeYouTube
guppy_social_media_xX (Twitter)
guppy_social_media_facebookFacebook
guppy_social_media_tiktokTikTok
guppy_social_media_xingXing

The former guppy-footer-social-media-* theme fields were removed from theme.json in 2.8.0. For the move and its migration see Footer → Social media links.

Custom section images (1–4) ​

FieldType
guppy-footer-custom-section-image-1media
guppy-footer-custom-section-image-1-linktext
guppy-footer-custom-section-image-2media
guppy-footer-custom-section-image-2-linktext
(up to image 4)…

USP banner ​

As of Guppy 2.8.0 the USP banner no longer lives in the theme configuration but in the DmfUspBanner plugin. The guppy-usp-* settings are gone, and a migration clears their values from the theme configuration.

The banner is maintained in the administration under Content → USP banner, per sales channel and per language. The top bar background colour stays in the theme and is now called guppy-topbar-background-color.

Product cards ​

FieldTypeOptionsDefault
guppy-productcard-configselectdefault, guppy-defaultguppy-default
guppy-productcard-protective-framebool–true
guppy-productcard-image-object-fitselectcontain, covercontain

Product detail ​

Buybox ​

FieldTypeDefaultEffect
guppy-detail-buybox-stylingselectdefaultdefault, border, background
guppy-detail-headline-buyboxbooltrueProduct name in buybox
guppy-detail-buybox-contactboolfalseShow contact info
guppy-detail-buybox-contact-hotlineboolfalseShow hotline
guppy-detail-buybox-hide-quantity-buttonsboolfalseHide quantity buttons
guppy-detail-mobile-title-above-galleryboolfalseProduct title above gallery on mobile
FieldTypeDefaultEffect
guppy-detail-gallery-scrollboolfalseGallery scrolls with content
guppy-detail-display-properties-as-tabboolfalseProperties as a separate tab

Login & register ​

FieldTypeOptionsDefault
guppy-login-registerselectdefault, compactcompact

Deprecated since 2.9.0

guppy-login-register and its tab Login & Register have no effect since 2.7.0: the login and register pages render Shopware's templates whatever the field holds. Since 2.9.0 label and help text say so ("no effect since 2.7.0, removed in 3.0.0"). Guppy 3.0.0 removes the field and the tab, and a migration removes the stored value. Remove theme_config('guppy-login-register') from child theme templates and the field from a child theme's theme.json before then.

The checkout field guppy-checkout was removed in 2.7.0. Since 2.9.0 the migration Migration1792627200RemoveRetiredCheckoutThemeConfigKey also removes its stored value, which some shops still showed as a loose field under "General" in the theme manager. It runs with bin/console plugin:update DmfGuppyTheme.

Badges ​

Basics ​

FieldTypeDefault
guppy-badges-show-outlineboolfalse

New badge ​

FieldTypeDefault
guppy-badges-new-background-colorcolor#22C087
guppy-badges-new-colorcolor#FFFFFF
guppy-badges-new-outline-colorcolor#FFFFFF

Top-seller badge ​

FieldTypeDefault
guppy-badges-top-seller-background-colorcolor#F89C00
guppy-badges-top-seller-colorcolor#FFFFFF
guppy-badges-top-seller-outline-colorcolor#FFFFFF

Discount badge ​

FieldTypeDefault
guppy-badges-discount-background-colorcolor#E10036
guppy-badges-discount-colorcolor#FFFFFF
guppy-badges-discount-outline-colorcolor#FFFFFF

Out-of-stock badge ​

FieldTypeDefault
guppy-badges-show-out-of-stockboolfalse
guppy-badges-out-of-stock-background-colorcolor#EEEEEE
guppy-badges-out-of-stock-colorcolor#303030
guppy-badges-out-of-stock-outline-colorcolor#303030

A product counts as out of stock when its "Closeout" option is enabled and its stock has dropped below the minimum purchase quantity.

When the out-of-stock badge is shown on a product card (because the product is out of stock), it replaces the other badges (new, top-seller, discount) on that card. Products that are not out of stock are unaffected.

Alerts ​

Colors ​

FieldTypeDefaultEffect
guppy-alert-color-successcolor#D3F2E7Success background
guppy-alert-color-success-textselectdarkSuccess text color
guppy-alert-color-infocolor#CEEDFEInfo background
guppy-alert-color-info-textselectdarkInfo text color
guppy-alert-color-warningcolor#FFEFD4Warning background
guppy-alert-color-warning-textselectdarkWarning text color
guppy-alert-color-dangercolor#FDE2E7Danger background
guppy-alert-color-danger-textselectdarkDanger text color

Options ​

FieldTypeDefaultEffect
guppy-alert-alert-outline-activeboolfalseOutline border on alerts

Color system ​

Brand ​

FieldTypeDefaultUse
sw-color-brand-primarycolor#215AFFPrimary
sw-color-brand-secondarycolor#0B1845Secondary

Greyscales ​

FieldDefault
sw-color-gray-100#F9F9F9
sw-color-gray-200#EEEEEE
sw-color-gray-300#BCC1C7
sw-color-gray-400#CED4DA
sw-color-gray-500#ADB5BD
sw-color-gray-600#798490
sw-color-gray-700#495057
sw-color-gray-800#4A545B
sw-color-gray-900#212529

Focus and form field border ​

Block Theme colours, both empty by default:

FieldTypeEmpty meansEffect
guppy-focus-colorcolorprimary colour (sw-color-brand-primary)Keyboard focus indicator (since 2.9.0)
guppy-input-border-colorcolorborder colour (sw-border-color)Border of form fields and dropdown menus (since 2.9.0)

Focus colour (guppy-focus-color): colours the focus outline of Guppy's focus-style() mixin and of buttons, Bootstrap's focus ring (:focus-visible, .form-select, .form-check-input, .nav-link, .pagination, .btn-close), the focus shadow of form fields and buttons and the focus border of form fields, including the header search field. Use it when the primary colour is too light: the focus indicator needs at least 3:1 contrast against adjacent colours (WCAG 1.4.11). The focus shadows of the form validation states keep their success and danger colours.

Form field border (guppy-input-border-color): colours the borders of input fields, selects, checkboxes and radios and dropdown menus (.form-control, .form-select, .form-check-input, .dropdown-menu), and through them the input group addon, the header search buttons, the filter panel toggles and the dropdown dividers, also of the dark dropdown. Use it to reach the 3:1 contrast against the background that WCAG 1.4.11 requires for form controls, without changing the general border colour.

With both fields empty the output is the same as before 2.9.0.

Typography ​

Font sizes ​

FieldTypeDefault
sw-font-size-basetext1rem
sw-h1-font-sizetext32px
sw-h2-font-sizetext24px
sw-h3-font-sizetext20px
sw-h4-font-sizetext18px
sw-h5-font-sizetext16px
sw-h6-font-sizetext15px

Line heights ​

FieldDefault
sw-h1-line-height44px
sw-h2-line-height36px
sw-h3-line-height32px
sw-h4-line-height28px
sw-h5-line-height24px
sw-h6-line-height21px

Visual change in 2.9.0: h6 line height

Before 2.9.0 sw-h6-line-height had no effect, and h6 / .h6 kept Bootstrap's line height of 1.2 (18px). Since 2.9.0 the field applies like the h1 to h5 fields: with the default 21px the line height is 21px from 1200px up and scales fluidly below (about 20.4px at 375px). This shows in the review area of the product detail page and in the "Delete account" dialog of the profile page (only when account deletion is enabled). To keep the old height, set the field to 1.2 × Heading 6 font size (18px with the default 15px). A value stored in the field before now takes effect. The text-only payment and shipping logos in the footer use the same value and change from 21px to 18px.

Secondary text colour ​

FieldTypeDefaultEffect
guppy-text-secondary-colorcoloremptyColour of muted text (since 2.9.0)

Secondary text colour sets Bootstrap's $body-secondary-color (--bs-secondary-color): .text-muted, .text-body-secondary, form help texts (.form-text), figure and table captions, the divider and current item of the breadcrumb, disabled nav links, list group action and disabled items, the toast header and the disabled range thumb. Empty falls back to Text colour (sw-text-color), so the output stays the same. The dark colour mode keeps its own value. Body-size text needs at least 4.5:1 contrast against the background (WCAG 1.4.3).

Buttons & inputs ​

FieldTypeDefaultEffect
sw-input-btn-font-sizetext16pxButton font size
sw-input-btn-border-radiustext4pxButton corner radius
sw-input-btn-font-weightselectnormalButton font weight

Usage in code ​

In Twig ​

twig
{% if theme_config('guppy-header') == 'extended' %}
    {# Extended header logic #}
{% endif %}

In SCSS ​

Theme values are exposed as CSS custom properties:

scss
.custom-component {
    background-color: var(--sw-color-brand-primary);
    font-size: var(--sw-font-size-base);
}