Configuration (template.json)
Template configuration. Required: the application only loads folders that contain a readable template.json. template-engine.js:68 template-engine.js:74
String values in template.json have <…> tags, "javascript:" and on…= removed before reaching the browser.
The Status column says whether the application reads a key: read (evidence linked), passed through (copied to the browser config but not used there), not read (accepted but ignored — the validator reports these as info). The Templates column counts the installed templates (out of 15) that set the key.
Keys
| Key | Type | Default | Status | Templates | Description |
|---|---|---|---|---|---|
| displayName | string | read | 0/15 | Name shown in the admin template list (GET /api/templates) and stored as the active theme name when an admin switches to this template. template-engine.js:591 server.js:1230 | |
| description | string | read | 0/15 | Description shown in the admin template list when set (falls back to website.description). template-engine.js:592 | |
| version | string | read | 0/15 | Template version. Used for the admin list and the installed-version check when theme.json has no version. template-engine.js:593 server.js:378 | |
| website | object | read | 15/15 | Store identity defaults supplied by the template. server.js:641 | |
| description | string | "" | read | 15/15 | Tagline used for the {DESCRIPTION} placeholder, the <meta name="description"> tag and the browser config when the store record has no description of its own. server.js:652 server.js:755 |
| name | string | "" | not read | 15/15 | Not read by the application — the store name always comes from the store record (pos_setting.store.name). |
| logo | string | "" | not read | 15/15 | Not read by the application. |
| favicon | string | "" | not read | 15/15 | Not read by the application. |
| currency | string | "" | not read | 15/15 | Not read by the application — the currency comes from the store record. |
| language | string | "en" | not read | 15/15 | Not read by the application (the page is always lang="en"). |
| year | string | "" | not read | 15/15 | Not read by the application — {YEAR} is the current year. |
| branding | object | read | 15/15 | Colours, fonts and corner radius. Exposed to the browser as config.branding and converted into CSS custom properties in a <style id="sf-theme-tokens"> tag that core.css / kit.css (and your CSS) can use. store/theme-assets.js:61 server.js:768 | |
| primaryColor | string color | read | 15/15 | Main brand colour. Also the default SweetAlert2 confirm-button colour when script.js sets no buttonColor. Sets the CSS custom property --sf-primary (hex colours only; anything else is ignored).^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$store/theme-assets.js:64 | |
| secondaryColor | string color | read | 15/15 | Secondary colour. Sets the CSS custom property --sf-secondary (hex colours only; anything else is ignored).^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$store/theme-assets.js:65 | |
| accentColor | string color | read | 15/15 | Accent colour. Sets the CSS custom property --sf-accent (hex colours only; anything else is ignored).^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$store/theme-assets.js:66 | |
| textColor | string color | read | 8/15 | Body text colour. Sets the CSS custom property --sf-ink (hex colours only; anything else is ignored).^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$store/theme-assets.js:67 | |
| surfaceColor | string color | read | 0/15 | Card / panel background. Sets the CSS custom property --sf-surface (hex colours only; anything else is ignored).^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$store/theme-assets.js:68 | |
| mutedSurfaceColor | string color | read | 8/15 | Muted background for alternate sections. Sets the CSS custom property --sf-muted-surface (hex colours only; anything else is ignored).^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$store/theme-assets.js:69 | |
| onPrimaryColor | string color | read | 0/15 | Text colour on top of the primary colour. Sets the CSS custom property --sf-on-primary (hex colours only; anything else is ignored).^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$store/theme-assets.js:70 | |
| fontFamily | string font-stack | read | 15/15 | Body font stack. Sets --sf-font-body. Must match ^[A-Za-z0-9 ,'"-]{1,160}$ (no url() or semicolons).^[A-Za-z0-9 ,'"-]{1,160}$store/theme-assets.js:71 | |
| headingFont | string font-stack | read | 9/15 | Heading font stack. Sets --sf-font-heading.^[A-Za-z0-9 ,'"-]{1,160}$store/theme-assets.js:72 | |
| displayFont | string font-stack | read | 5/15 | Display font stack. Sets --sf-font-display.^[A-Za-z0-9 ,'"-]{1,160}$store/theme-assets.js:73 | |
| radius | string | read | 15/15 | Corner radius such as "8px" (1–2 digits + px). Sets --sf-radius.^\d{1,2}px$store/theme-assets.js:74 | |
| home | object | read | 15/15 | Home page switches read by the storefront engine. server.js:769 | |
| showHero | boolean | true | read | 15/15 | Set to false to hide #heroSlider. public/assets/storefront/engine.js:2942 |
| showFeatured | boolean | true | read | 15/15 | Set to false to skip loading featured products into #homeFeaturedGrid. public/assets/storefront/engine.js:1194 |
| showLatestProducts | boolean | true | read | 15/15 | Set to false to skip loading #homeProductsGrid. public/assets/storefront/engine.js:1204 |
| showCategories | boolean | true | read | 15/15 | Set to false to hide #homeCategoriesSection. public/assets/storefront/engine.js:1247 public/assets/storefront/engine.js:1320 |
| showBrands | boolean | true | read | 15/15 | Set to false to hide #homeBrandsSection. public/assets/storefront/engine.js:1262 public/assets/storefront/engine.js:1321 |
| productsPerSection | number | 8 | read | 15/15 | How many products the home grids request. min 1, max 48 public/assets/storefront/engine.js:1195 public/assets/storefront/engine.js:1205 |
| products | object | read | 15/15 | Products page filter switches. server.js:773 | |
| productsPerPage | number | 20 | passed through | 15/15 | Not read by the storefront engine (it always requests 20 per page). |
| showFilters | boolean | true | passed through | 15/15 | Not read by the storefront engine. |
| showBrandFilter | boolean | true | read | 15/15 | Set to false to hide the brand filter (#brandSelect). public/assets/storefront/engine.js:1045 |
| showCategoryFilter | boolean | true | read | 15/15 | Set to false to hide the category filter (#categorySelect). public/assets/storefront/engine.js:1037 |
| showSubcategoryFilter | boolean | true | read | 15/15 | Set to false to hide the subcategory filter (#subcategorySelect). public/assets/storefront/engine.js:1070 |
| shipping | object | read | 15/15 | Delivery options the template allows. The server combines them with the store settings and delivery areas. server.js:313 | |
| enabled | boolean | true | read | 15/15 | Set to false to disable delivery choices entirely. server.js:318 |
| storePickupEnabled | boolean | true | read | 15/15 | Offer "Store Pickup" at checkout. server.js:319 |
| storePickupFee | number | 0 | read | 15/15 | Fee charged for store pickup, in the store currency. min 0 server.js:320 |
| standardDeliveryEnabled | boolean | true | read | 15/15 | Offer delivery to an address (also needs delivery areas in the store data). server.js:314 |
| payment | object | read | 15/15 | Payment switches applied on the server when listing payment methods. server.js:361 | |
| enabled | boolean | true | read | 15/15 | Set to false to disable online payment methods. server.js:363 |
| cashOnDeliveryEnabled | boolean | true | read | 15/15 | Set to false to hide Cash on Delivery. server.js:364 |
| security | object | read | 15/15 | Present in existing templates. Only captcha.minFormTimeMs is passed to the browser config; nothing here is read by engine.js (CAPTCHA is decided by the server). | |
| captcha | object | read | 15/15 | CAPTCHA settings. | |
| enabled | boolean | true | not read | 15/15 | Not read — the browser config always receives enabled:false and the server decides when CAPTCHA is required. |
| login | boolean | true | not read | 15/15 | Not read. |
| registration | boolean | true | not read | 15/15 | Not read. |
| type | string | "server" | not read | 15/15 | Not read. |
| minFormTimeMs | number | 1500 | passed through | 15/15 | Copied to the browser config; not read by engine.js. server.js:787 |
| legal | object | read | 15/15 | Text of the legal pages rendered into #termsContent, #refundContent and #privacyContent. Plain text; blank lines start paragraphs; "{STORE_NAME}" is replaced with the store name. server.js:790 | |
| terms | string multiline | "" | read | 15/15 | Terms & Conditions. public/assets/storefront/engine.js:3034 |
| refundPolicy | string multiline | "" | read | 15/15 | Refund policy. public/assets/storefront/engine.js:3034 |
| privacyPolicy | string multiline | "" | read | 15/15 | Privacy policy. public/assets/storefront/engine.js:3034 |
| social | object | read | 15/15 | Social profile links shown in #footerSocialLinks. Only https:// URLs are rendered; empty values are skipped. public/assets/storefront/engine.js:3049 | |
| string https-url | "" | read | 15/15 | Facebook URL. public/assets/storefront/engine.js:3050 | |
| string https-url | "" | read | 15/15 | Instagram URL. public/assets/storefront/engine.js:3050 | |
| string https-url | "" | read | 15/15 | Twitter URL. public/assets/storefront/engine.js:3050 | |
| x-twitter | string https-url | "" | read | 0/15 | X URL. public/assets/storefront/engine.js:3050 |
| tiktok | string https-url | "" | read | 0/15 | TikTok URL. public/assets/storefront/engine.js:3050 |
| string https-url | "" | read | 15/15 | LinkedIn URL. public/assets/storefront/engine.js:3050 | |
| youtube | string https-url | "" | read | 15/15 | YouTube URL. public/assets/storefront/engine.js:3050 |
| string https-url | "" | read | 0/15 | Pinterest URL. public/assets/storefront/engine.js:3050 | |
| string https-url | "" | read | 0/15 | WhatsApp URL. public/assets/storefront/engine.js:3050 | |
| footer | object | read | 15/15 | Copied to the browser config; engine.js does not read these switches (hide footer parts with your own HTML/CSS). server.js:792 | |
| showSocialLinks | boolean | true | passed through | 15/15 | Not read by engine.js. |
| showPaymentIcons | boolean | true | passed through | 15/15 | Not read by engine.js. |
| showLegalLinks | boolean | true | passed through | 15/15 | Not read by engine.js. |
| features | object | read | 15/15 | Feature switches read by the storefront engine. server.js:795 | |
| wishlist | boolean | true | read | 15/15 | Set to false to remove wishlist buttons from product cards and the product page. public/assets/storefront/engine.js:880 public/assets/storefront/engine.js:1628 |
| featuredProducts | boolean | true | read | 15/15 | Set to false to stop loading featured products. public/assets/storefront/engine.js:1194 |
| shopByCategory | boolean | true | read | 15/15 | Set to false to hide the home category grid. public/assets/storefront/engine.js:1247 |
| shopByBrand | boolean | true | read | 15/15 | Set to false to hide the home brand grid. public/assets/storefront/engine.js:1262 |
| coupons | boolean | true | read | 15/15 | Set to false to hide the coupon box in the cart. public/assets/storefront/engine.js:1893 |
| reviews | boolean | true | passed through | 15/15 | Not read by engine.js. |
| guestCart | boolean | true | passed through | 15/15 | Not read by engine.js. |
| content | object | read | 15/15 | Optional merchandising content. The server validates it (store/theme-assets.js publicContent) and blocks that have no content are hidden by the engine. server.js:801 | |
| announcement | string | "" | read | 15/15 | Text for [data-sf-announcement] / .announcement-bar (max 180 characters). max 180 chars store/theme-assets.js:118 |
| heroSlides | array | read | 15/15 | Replaces the slides inside #heroSlider (max 5). The first .hero-slide in your HTML is used as the slide template. max 5 items store/theme-assets.js:119 public/assets/storefront/engine.js:2958 | |
| eyebrow | string | "" | read | 0/15 | Small text above the title (max 80). max 80 chars read with its list store/theme-assets.js:119 |
| title | string | "" | read | 0/15 | Slide title (required, max 120). Slides without a title are dropped. max 120 chars, required read with its list store/theme-assets.js:119 |
| text | string | "" | read | 0/15 | Paragraph (max 220). max 220 chars read with its list store/theme-assets.js:119 |
| cta | string | "" | read | 0/15 | Button text (max 40). max 40 chars read with its list store/theme-assets.js:119 |
| link | string safe-link | "#products" | read | 0/15 | Button link: a storefront route such as "#products" or a same-site path "/…". Anything else becomes "#products". read with its list store/theme-assets.js:119 |
| image | string safe-image | "" | read | 0/15 | Background image: /image/…, /assets/… or /uploads/… path to a png/jpg/webp/svg/gif. read with its list store/theme-assets.js:119 |
| promotions | array | read | 15/15 | Promotion cards for .promo-banner / .two-col-banner / [data-sf-promo] items (max 6). Without promotions the engine fills these slots with the store's categories. max 6 items store/theme-assets.js:124 public/assets/storefront/engine.js:1358 | |
| eyebrow | string | "" | read | 0/15 | Small text (max 60). max 60 chars read with its list store/theme-assets.js:124 |
| title | string | "" | read | 0/15 | Title (required, max 80). max 80 chars, required read with its list store/theme-assets.js:124 |
| text | string | "" | read | 0/15 | Text (max 160). max 160 chars read with its list store/theme-assets.js:124 |
| cta | string | "" | read | 0/15 | Link text (max 30). max 30 chars read with its list store/theme-assets.js:124 |
| link | string safe-link | "" | read | 0/15 | Storefront route or same-site path. read with its list store/theme-assets.js:124 |
| image | string safe-image | "" | read | 0/15 | /image/…, /assets/… or /uploads/… image path. read with its list store/theme-assets.js:124 |
| category | string | "" | read | 0/15 | Category name: the card links to that category. max 80 chars read with its list store/theme-assets.js:124 |
| usps | array | read | 15/15 | Service highlights for [data-sf-usps] / .usp-strip (max 6). Without them the engine shows facts from the selected store (pickup, delivery, hours, payments, phone). max 6 items store/theme-assets.js:129 public/assets/storefront/engine.js:1402 | |
| icon | string | "check" | read | 0/15 | Font Awesome icon name without "fa-" (e.g. "truck-fast").^[a-z0-9-]{2,40}$read with its list store/theme-assets.js:129 |
| title | string | "" | read | 0/15 | Title (required, max 60). max 60 chars, required read with its list store/theme-assets.js:129 |
| text | string | "" | read | 0/15 | Text (max 120). max 120 chars read with its list store/theme-assets.js:129 |
| testimonials | array | read | 15/15 | Quotes for [data-sf-testimonials] / .testimonial-section (max 8). The section stays hidden when empty: the engine never invents reviews. max 8 items store/theme-assets.js:134 public/assets/storefront/engine.js:1437 | |
| quote | string | "" | read | 0/15 | Quote (required, max 400). max 400 chars, required read with its list store/theme-assets.js:134 |
| name | string | "" | read | 0/15 | Name (required, max 60). max 60 chars, required read with its list store/theme-assets.js:134 |
| role | string | "" | read | 0/15 | Role / location (max 60). max 60 chars read with its list store/theme-assets.js:134 |
| newsletter | boolean | false | read | 15/15 | Show newsletter blocks (.newsletter-section, [data-sf-section="newsletter"], .footer-newsletter). Hidden unless true. store/theme-assets.js:140 public/assets/storefront/engine.js:3056 |
| labels | object | read | 0/15 | Overrides for the words the engine uses (merged over script.js StorefrontTheme.labels). Keys are listed in the Runtime API section. server.js:802 public/assets/storefront/engine.js:85 | |
| assets | object | read | 15/15 | Shared assets loaded by the page head. store/theme-assets.js:80 | |
| kit | boolean | false | read | 15/15 | true loads /assets/storefront/kit.css (the layout kit used by the newer templates). store/theme-assets.js:88 |
| fonts | array | [] | read | 15/15 | Self-hosted fonts to load (keys of /assets/fonts/<key>.css that exist in the application). store/theme-assets.js:81 |
What reaches the browser
The server builds a configuration object for the storefront engine and prints it as script#love-config-json (type="application/json"). Top-level keys: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21 server.js:752