Skip to main content

​
Overview

The Description Box Component provides a flexible way to display textual content across multiple QR Code categories.
It supports rich text descriptions while maintaining consistent formatting through the cardStyle reference, allowing customization of layout, background, and spacing. Use this component to include short summaries, product overviews, or event descriptions below the main content.

​
Properties

PropertyTypeRequiredDescription
textstring✅ YesThe main description text to display. Must be at least 10 characters long.
cardStyleobjectNoReference to the Card Style Component for customizing background, padding, and borders.

​
Used In Categories

This component is used in the following QR Code categories:

​
Example Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {},
  "title": "Description box component",
  "description": "Validate description box component",
  "type": "object",
  "required": [
    "text"
  ],
  "additionalProperties": false,
  "properties": {
    "text": {
      "type": "string",
      "minLength": 10
    },
    "cardStyle": {
      "$ref": "style/card.json"
    }
  }
}

​
Notes

  • The text property must contain at least 10 characters to ensure valid descriptive content.
  • The cardStyle reference supports customization for visual consistency across sections.
  • Avoid using HTML inside the text field — use plain or formatted Markdown text if supported by the category.