Bricks Schema 中文文档:离屏面板

📄 原始资料 (已截断)  |  展开查看原始 JSON(offcanvas.json){ “$schema”: “https://json-schema.org/draft/2020-12/schema”, “$id”: “bricks://elements/offcanvas”, “schemaVersion”: “2.3”, “type”: “object”, “title”: “Offcanvas”, “description”: “Schema for Bricks Offcanvas element”, “metadata”: { “name”: “offcan…

📄 原始资料 (已截断)  |  展开查看原始 JSON(offcanvas.json)
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "bricks://elements/offcanvas",
  "schemaVersion": "2.3",
  "type": "object",
  "title": "Offcanvas",
  "description": "Schema for Bricks Offcanvas element",
  "metadata": {
    "name": "offcanvas",
    "category": "general",
    "tag": "div",
    "nestable": true
  },
  "settings": {
    "direction": {
      "label": "Direction",
      "options": {
        "top": "Top",
        "right": "Right",
        "bottom": "Bottom",
        "left": "Left",
        "topZh": "顶部",
        "rightZh": "右侧",
        "bottomZh": "底部",
        "leftZh": "左侧"
      },
      "valueSchema": {
        "oneOf": [
          {
            "type": "string",
            "description": "Single selection",
            "descriptionZh": "单选。"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Multiple selection",
            "descriptionZh": "多选。"
          }
        ]
      },
      "controlType": "select",
      "labelZh": "方向"
    },
    "effect": {
      "label": "Effect",
      "options": {
        "slide": "Slide",
        "offset": "Offset",
        "slideZh": "滑动",
        "offsetZh": "偏移"
      },
      "valueSchema": {
        "oneOf": [
          {
            "type": "string",
            "description": "Single selection",
            "descriptionZh": "单选。"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Multiple selection",
            "descriptionZh": "多选。"
          }
        ]
      },
      "controlType": "select",
      "labelZh": "效果"
    },
    "closeOn": {
      "label": "Close on",
      "options": {
        "backdrop": "Backdrop",
        "esc": "ESC (",
        "none": "None",
        "backdropZh": "背景遮罩",
        "escZh": "ESC 键",
        "noneZh": "无"
      },
      "valueSchema": {
        "oneOf": [
          {
            "type": "string",
            "description": "Single selection",
            "descriptionZh": "单选。"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Multiple selection",
            "descriptionZh": "多选。"
          }
        ]
      },
      "controlType": "select",
      "labelZh": "关闭触发"
    },
    "width": {
      "label": "Width",
      "units": true,
      "css": [
        {
          "property": "width",
          "selector": "&[data-direction] .brx-offcanvas-inner"
        }
      ],
      "valueSchema": {
        "oneOf": [
          {
            "type": "string",
            "description": "Value with unit (e.g., \"10px\", \"50%\")",
            "descriptionZh": "带单位的值(例如 \"10px\"、\"50%\")。"
          },
          {
            "type": "number"
          }
        ]
      },
      "controlType": "number",
      "labelZh": "宽度"
    },
    "height": {
      "label": "Height",
      "units": true,
      "css": [
        {
          "property": "height",
          "selector": "&[data-direction] .brx-offcanvas-inner"
        }
      ],
      "valueSchema": {
        "oneOf": [
          {
            "type": "string",
            "description": "Value with unit (e.g., \"10px\", \"50%\")",
            "descriptionZh": "带单位的值(例如 \"10px\"、\"50%\")。"
          },
          {
            "type": "number"
          }
        ]
      },
      "controlType": "number",
      "labelZh": "高度"
    },
    "transitionDuration": {
      "label": "Transition",
      "units": true,
      "css": [
        {
          "property": "transition-duration",
          "selector": ".brx-offcanvas-inner, .brx-offcanvas-backdrop"
        }
      ],
      "valueSchema": {
        "oneOf": [
          {
            "type": "string",
            "description": "Value with unit (e.g., \"10px\", \"50%\")",
            "descriptionZh": "带单位的值(例如 \"10px\"、\"50%\")。"
          },
          {
            "type": "number"
          }
        ]
      },
      "controlType": "number",
      "labelZh": "过渡"
    },
    "transitionTimingFunction": {
      "label": "Transition",
      "css": [
        {
          "property": "transition-timing-function",
          "selector": ".brx-offcanvas-inner, .brx-offcanvas-backdrop"
        }
      ],
      "valueSchema": {
        "type": "string"
      },
      "controlType": "text",
      "labelZh": "过渡"
    },
    "ariaLabel": {
      "label": "aria-label",
      "valueSchema": {
        "type": "string"
      },
      "controlType": "text",
      "labelZh": "aria-label"
    },
    "noScrollBody": {
      "label": "No scroll",
      "valueSchema": {
        "type": "boolean"
      },
      "controlType": "checkbox",
      "labelZh": "禁止滚动"
    },
    "scrollToTop": {
      "label": "Scroll to top",
      "valueSchema": {
        "type": "boolean"
      },
      "controlType": "checkbox",
      "labelZh": "滚动到顶部"
    },
    "noAutoFocus": {
      "label": "Disable auto focus",
      "valueSchema": {
        "type": "boolean"
      },
      "controlType": "checkbox",
      "labelZh": "禁用自动聚焦"
    },
    "openByDefault": {
      "label": "Open on page load",
      "valueSchema": {
        "type": "boolean"
      },
      "controlType": "checkbox",
      "labelZh": "页面加载时打开"
    },
    "_content": {
      "label": "Content",
      "css": [
        {
          "property": "content",
          "value": "%s"
        }
      ],
      "valueSchema": {
        "type": "string"
      },
      "controlType": "text",
      "labelZh": "内容"
    },
    "_margin": {
      "label": "Margin",
      "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": "带方向属性的间距值。"
      },
      "css": [
        {
          "property": "margin"
        }
      ],
      "controlType": "spacing",
      "labelZh": "外边距"
    },
    "_padding": {
      "label": "Padding",
      "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": "带方向属性的间距值。"
      },
      "css": [
        {
          "property": "padding"
        }
      ],
      "controlType": "spacing",
      "labelZh": "内边距"
    },
    "_width": {
      "label": "Width",
      "css": [
        {
          "property": "width"
        }
      ],
      "valueSchema": {
        "oneOf": [
          {
            "type": "string",
        

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

前言

Bricks Offcanvas 元素的 schema。

基本信息

  • 英文名称Offcanvas
  • 中文名称:离屏面板
  • Schema IDbricks://elements/offcanvas
  • Schema 版本2.3
  • 类型object
  • 分类general
  • Tagdiv
  • 内部名称offcanvas

设置项

  • direction — 方向 (select)
  • effect — 效果 (select)
  • closeOn — 关闭触发 (select)
  • width — 宽度 (number)
  • height — 高度 (number)
  • transitionDuration — 过渡 (number)
  • transitionTimingFunction — 过渡 (text)
  • ariaLabel — aria-label (text)
  • noScrollBody — 禁止滚动 (checkbox)
  • scrollToTop — 滚动到顶部 (checkbox)
  • noAutoFocus — 禁用自动聚焦 (checkbox)
  • openByDefault — 页面加载时打开 (checkbox)
  • _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 文档