Bricks Schema 中文文档：目录

标签TAGS:

2026年8月30日

📄 原始资料（已截断） | 展开查看原始 JSON（post-toc.json）{ “$schema”: “https://json-schema.org/draft/2020-12/schema”, “$id”: “bricks://elements/post-toc”, “schemaVersion”: “2.3”, “type”: “object”, “title”: “Table of contents”, “description”: “Schema for Bricks Table of contents element”, “metadata”: { “…

📄 原始资料（已截断） | 展开查看原始 JSON（post-toc.json）

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "bricks://elements/post-toc",
  "schemaVersion": "2.3",
  "type": "object",
  "title": "Table of contents",
  "description": "Schema for Bricks Table of contents element",
  "metadata": {
    "name": "post-toc",
    "category": "single",
    "tag": "div",
    "nestable": false
  },
  "settings": {
    "contentSelector": {
      "label": "Content selector",
      "valueSchema": {
        "type": "string"
      },
      "controlType": "text",
      "labelZh": "内容选择器"
    },
    "headingSelectors": {
      "label": "Heading selectors",
      "valueSchema": {
        "type": "string"
      },
      "controlType": "text",
      "labelZh": "标题选择器"
    },
    "ignoreSelector": {
      "label": "Ignore selector",
      "valueSchema": {
        "type": "string"
      },
      "controlType": "text",
      "labelZh": "忽略选择器"
    },
    "collapseInactive": {
      "label": "Collapse inactive",
      "valueSchema": {
        "type": "boolean"
      },
      "controlType": "checkbox",
      "labelZh": "折叠未激活项"
    },
    "noWrap": {
      "label": "No wrap",
      "valueSchema": {
        "type": "boolean"
      },
      "controlType": "checkbox",
      "labelZh": "不换行"
    },
    "sticky": {
      "label": "Sticky",
      "valueSchema": {
        "type": "boolean"
      },
      "controlType": "checkbox",
      "labelZh": "粘性"
    },
    "stickyTop": {
      "label": "Top",
      "units": true,
      "css": [
        {
          "property": "top",
          "selector": "&[data-sticky]"
        }
      ],
      "hasRequired": true,
      "valueSchema": {
        "oneOf": [
          {
            "type": "string",
            "description": "Value with unit (e.g., \"10px\", \"50%\")",
            "descriptionZh": "带单位的值（例如 \"10px\"、\"50%\"）。"
          },
          {
            "type": "number"
          }
        ]
      },
      "controlType": "number",
      "labelZh": "顶部"
    },
    "headingsOffset": {
      "label": "Headings offset",
      "valueSchema": {
        "oneOf": [
          {
            "type": "string",
            "description": "Value with unit (e.g., \"10px\", \"50%\")",
            "descriptionZh": "带单位的值（例如 \"10px\"、\"50%\"）。"
          },
          {
            "type": "number"
          }
        ]
      },
      "controlType": "number",
      "labelZh": "标题偏移"
    },
    "itemPadding": {
      "label": "Padding",
      "css": [
        {
          "property": "padding",
          "selector": ".toc-list-item"
        }
      ],
      "valueSchema": {
        "type": "object",
        "description": "Spacing value with directional properties",
        "properties": {
          "top": {
            "type": "string",
            "description": "Top spacing value with unit",
            "descriptionZh": "顶部间距值（带单位）。"
          },
          "right": {
            "type": "string",
            "description": "Right spacing value with unit",
            "descriptionZh": "右侧间距值（带单位）。"
          },
          "bottom": {
            "type": "string",
            "description": "Bottom spacing value with unit",
            "descriptionZh": "底部间距值（带单位）。"
          },
          "left": {
            "type": "string",
            "description": "Left spacing value with unit",
            "descriptionZh": "左侧间距值（带单位）。"
          }
        },
        "additionalProperties": false,
        "descriptionZh": "带方向属性的间距值。"
      },
      "controlType": "spacing",
      "labelZh": "内边距"
    },
    "itemBorder": {
      "label": "Border",
      "css": [
        {
          "property": "border",
          "selector": ".toc-link::before"
        }
      ],
      "valueSchema": {
        "type": "object",
        "description": "Border settings",
        "properties": {
          "width": {
            "type": "object",
            "description": "Spacing value with directional properties",
            "properties": {
              "top": {
                "type": "string",
                "description": "Top spacing value with unit",
                "descriptionZh": "顶部间距值（带单位）。"
              },
              "right": {
                "type": "string",
                "description": "Right spacing value with unit",
                "descriptionZh": "右侧间距值（带单位）。"
              },
              "bottom": {
                "type": "string",
                "description": "Bottom spacing value with unit",
                "descriptionZh": "底部间距值（带单位）。"
              },
              "left": {
                "type": "string",
                "description": "Left spacing value with unit",
                "descriptionZh": "左侧间距值（带单位）。"
              }
            },
            "additionalProperties": false,
            "descriptionZh": "带方向属性的间距值。"
          },
          "style": {
            "type": "string",
            "enum": [
              "none",
              "solid",
              "dashed",
              "dotted",
              "double",
              "groove",
              "ridge",
              "inset",
              "outset"
            ]
          },
          "color": {
            "description": "Color value in various formats",
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "hex": {
                    "type": "string",
                    "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
                  }
                },
                "required": [
                  "hex"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "rgb": {
                    "type": "string",
                    "pattern": "^rgba?\\("
                  }
                },
                "required": [
                  "rgb"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "hsl": {
                    "type": "string",
                    "pattern": "^hsla?\\("
                  }
                },
                "required": [
                  "hsl"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "raw": {
                    "type": "string",
                    "description": "Raw color value or CSS variable",
                    "descriptionZh": "原始颜色值或 CSS 变量。"
                  }
                },
                "required": [
                  "raw"
                ]
              }
            ],
            "descriptionZh": "各种格式的颜色值。"
          },
          "radius": {
            "type": "object",
            "description": "Spacing value with directional properties",
            "properties": {
              "top": {
                "type": "string",
                "description": "Top spacing value with unit",
                "descriptionZh": "顶部间距值（带单位）。"
              },
              "right": {
                "type": "string",
                "description": "Right spacing value with unit",
                "descriptionZh": "右侧间距值（带单位）。"
              },
              "bottom": {
                "type": "string",
                "description": "Bottom spacing value with unit",
                "descriptionZh": "底部间距值（带单位）。"
              },
              "left": {
                "type": "string",
                "description": "Left spacing value with unit",
                "descriptionZh": "左侧间距值（带单位）。"
              }
            },
            "additionalProperties": false,
            "descriptionZh": "带方向属性的间距值。"
          }
        },
        "descriptionZh": "边框设置。"
      },
      "controlType": "border",
      "labelZh": "边框"
    },
    "itemTypography": {
      "label": "Typography",
      "css": [
        {
          "property": "font",
          "selector": ".toc-link"
        }
      ],
      "valueSchema": {
        "type": "object",
  

... (内容过长已截断，完整 JSON 见原始文件)

前言

Bricks Table of contents 元素的 schema。

基本信息

英文名称：Table of contents
中文名称：目录
Schema ID：bricks://elements/post-toc
Schema 版本：2.3
类型：object
分类：single
Tag：div
内部名称：post-toc

设置项

contentSelector — 内容选择器 (text)
headingSelectors — 标题选择器 (text)
ignoreSelector — 忽略选择器 (text)
collapseInactive — 折叠未激活项 (checkbox)
noWrap — 不换行 (checkbox)
sticky — 粘性 (checkbox)
stickyTop — 顶部 (number)
headingsOffset — 标题偏移 (number)
itemPadding — 内边距 (spacing)
itemBorder — 边框 (border)
itemTypography — 排版 (typography)
itemBorderActive — 边框 (border)
itemTypographyActive — 排版 (typography)
_content — 内容 (text)
_margin — 外边距 (spacing)
_padding — 内边距 (spacing)
_width — 宽度 (number)
_widthMin — 最小宽度 (number)
_widthMax — 最大宽度 (number)
_height — 高度 (number)
_heightMin — 最小高度 (number)
_heightMax — 最大高度 (number)
_aspectRatio — 宽高比 (text)
_position — 位置 (select)
_top — 顶部 (number)
_right — 右侧 (number)
_bottom — 底部 (number)
_left — 左侧 (number)
_zIndex — Z 索引 (number)
_order — 顺序 (number)
_display — 显示 (select)
_visibility — 可见性 (select)
_overflow — 溢出 (text)
_opacity — 不透明度 (number)
_cursor — 光标 (select)
_isolation — 隔离 (select)
_mixBlendMode — 混合模式 (select)
_pointerEvents — 指针事件 (text)
_perspective — 透视 (number)
_perspectiveOrigin — 透视原点 (text)
_gridItemJustifySelf — 自身水平对齐 (align-items)
_flexDirection — 方向 (direction)
_alignSelf — 自身对齐 (align-items)
_justifyContent — 主轴对齐 (justify-content)
_alignItems — 交叉轴对齐 (align-items)
_gap — 间距 (number)
_flexGrow — 放大比例 (number)
_flexShrink — 缩小比例 (number)
_flexBasis — 伸缩基准 (text)
_useMasonry — %s 布局 (checkbox)
_masonryColumn — 列数 (number)
_masonryGutter — 间距 (number)
_masonryHorizontalOrder — 水平顺序 (checkbox)
_masonryTransitionDuration — 过渡 (number)
_masonryTransitionMode — 显现动画 (select)
_typography — _typography (typography)
_background — _background (background)
_shapeDividers — 自定义形状 (repeater)
_gradient — _gradient (gradient)
_border — 边框 (border)
_boxShadow — 盒子阴影 (box-shadow)
_transform — 变换 (transform)
_transformOrigin — 变换原点 (text)
_motionElementParallax — 元素视差 (checkbox)
_motionElementParallaxSpeedX — 水平速度 (number)
_motionElementParallaxSpeedY — 垂直速度 (number)
_motionBackgroundParallax — 背景视差 (checkbox)
_motionBackgroundParallaxSpeed — 背景速度 (number)
_motionStartVisiblePercent — 视差起点 (number)
_cssCustom — 自定义 CSS (code)
_cssClasses — CSS 类 (text)
_cssId — CSS ID (text)
_cssFilters — CSS 滤镜 (filters)
_cssTransition — 过渡 (text)
_attributes — 姓名 (repeater)
_scrollSnapType — 类型 (select)
_scrollSnapAlign — 对齐 (select)
_scrollSnapStop — 停止 (select)

补充说明

更多细节可参考 Bricks 官方 Academy 文档。