# Badges

<figure><img src="/files/81Q6OzNSY7Nq6OJwhbGf" alt=""><figcaption></figcaption></figure>

## Overview

A customizable product badges block that displays various types of informational badges for products. The block can show sold out status, savings information, low stock alerts, custom product tags, and metafield-based badges. Badges can be displayed as plain text or styled badge elements with extensive customization options for positioning, colors, and layout.

## Common use cases

* Display sold out badges for unavailable products
* Show savings badges with percentage or amount saved
* Display low stock alerts when inventory is below threshold
* Use product tags prefixed with "badge\_" to create custom badges
* Configure metafield badges for custom product attributes like "Featured", "New", or "Limited Edition"
* Use overlay positioning for product images to create eye-catching promotional badges
* Set appropriate stock thresholds based on your inventory management needs

## Block settings

### General

| Setting                | Description                                                                         | Options                   |
| ---------------------- | ----------------------------------------------------------------------------------- | ------------------------- |
| Show advanced settings | Reveals enable color difference, vertical alignment, enable overlay, and visibility | Checkbox (default: false) |

### Content

| Setting             | Description                                                                                  | Options                                          |
| ------------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------ |
| Product             | Select the product to display badges for                                                     | Product picker                                   |
| Show sold out badge | Displays a badge when the product is sold out                                                | Checkbox (default: false)                        |
| Savings badge       | Type of savings badge to display                                                             | <p>• None<br>• Percent (default)<br>• Amount</p> |
| Stock threshold     | Minimum stock level to trigger low stock badge (0 = never show)                              | Number input                                     |
| Metafield badges    | Comma-separated list of metafield namespace.key pairs (e.g., "custom.badge,custom.featured") | Text input                                       |

### Spacing

| Setting                   | Description                               | Options                   |
| ------------------------- | ----------------------------------------- | ------------------------- |
| Enable horizontal padding | Adds horizontal padding around the badges | Checkbox (default: false) |
| Enable top padding        | Adds top padding around the badges        | Checkbox (default: false) |
| Enable bottom padding     | Adds bottom padding around the badges     | Checkbox (default: false) |

### Color

| Setting                 | Description                                               | Options                                                                                                                                                                                                                              |
| ----------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Color scheme            | Controls the background color scheme for badges           | <p>• Body (default)<br>• Neutral<br>• Accent 1<br>• Accent 2<br>• Accent 3<br>• Shade 1<br>• Shade 2<br>• Shade 3<br>• Primary<br>• Secondary<br>• Tertiary<br>• Blur<br>• Transparent<br><br>Visible when display type is badge</p> |
| Color border            | Controls the border color for badges                      | <p>• Body<br>• Subtle (default)<br>• Strong<br>• Primary<br>• Secondary<br>• Tertiary<br>• None<br><br>Visible when display type is badge</p>                                                                                        |
| Color text              | Controls the text color                                   | <p>• Default (default)<br>• Alternative<br>• Primary<br>• Secondary<br>• Tertiary<br>• Neutral<br>• Shade</p>                                                                                                                        |
| Enable color difference | Uses mix-blend-difference for better visibility on images | <p>Checkbox (default: false)<br><br>Visible when <strong>Show advanced settings</strong> is on</p>                                                                                                                                   |

### Style

| Setting      | Description                | Options                                                                                                                                                           |
| ------------ | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Display type | How badges are displayed   | <p>• Text<br>• Badge (default)</p>                                                                                                                                |
| Font family  | Font family for badge text | <p>• Standard (default)<br>• Heading<br>• Subheading<br>• Accent</p>                                                                                              |
| Font size    | Font size for badge text   | <p>• Smaller<br>• Small<br>• Default (default)<br>• Big<br>• Bigger<br>• Heading 1<br>• Heading 2<br>• Heading 3<br>• Heading 4<br>• Heading 5<br>• Heading 6</p> |

### Layout

| Setting              | Description                                         | Options                                                                                                                                                                                          |
| -------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Horizontal alignment | Controls horizontal alignment of the badges         | <p>• Left (default)<br>• Center<br>• Right</p>                                                                                                                                                   |
| Vertical alignment   | Controls vertical alignment when overlay is enabled | <p>• Top (default)<br>• Bottom<br><br>Visible when enable overlay is true</p><p><br><br>Visible when <strong>Enable overlay</strong> is on and <strong>Show advanced settings</strong> is on</p> |
| Enable overlay       | Positions badges as an overlay on product images    | <p>Checkbox (default: false)<br><br>Visible when <strong>Show advanced settings</strong> is on</p>                                                                                               |

### Display

| Setting    | Description                        | Options                                                                                                                            |
| ---------- | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| Visibility | Controls when the block is visible | <p>• All (default)<br>• Mobile only<br>• Desktop only</p><p><br><br>Visible when <strong>Show advanced settings</strong> is on</p> |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.brickspacelab.com/slab/content/blocks/products/badges.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
