使用区块构建页面

本页内容

blocks 字段存储一个有序的页面组合。每一项都会记录区块类型、保留的 schema 版本、稳定的 key,以及该版本所声明的字段。编辑者在内容编辑器中添加区块并调整顺序。Astro 路由会把每种区块类型映射到一个组件。

定义区块类型

请在使用区块类型的集合字段之前先定义区块类型。种子会保留每一个编号版本以及当前生效的 currentVersion 指针。

下面的种子定义了 Hero 和 Feature grid 区块,然后让它们可用于 Pages 的 layout 字段:

{
  "$schema": "https://emdashcms.com/seed.schema.json",
  "version": "1",
  "blockTypes": [
    {
      "slug": "hero",
      "label": "Hero",
      "description": "A heading, body text and an image",
      "icon": "sparkle",
      "category": "Layout",
      "currentVersion": 1,
      "versions": [
        {
          "version": 1,
          "fields": [
            { "slug": "heading", "label": "Heading", "type": "string", "required": true },
            { "slug": "body", "label": "Body", "type": "portableText" },
            { "slug": "image", "label": "Image", "type": "image" },
            { "slug": "link_label", "label": "Link label", "type": "string" },
            { "slug": "link_url", "label": "Link URL", "type": "url" }
          ]
        }
      ]
    },
    {
      "slug": "feature_grid",
      "label": "Feature grid",
      "description": "A heading and a grid of features",
      "icon": "squares-four",
      "category": "Layout",
      "currentVersion": 1,
      "versions": [
        {
          "version": 1,
          "fields": [
            { "slug": "heading", "label": "Heading", "type": "string" },
            {
              "slug": "items",
              "label": "Items",
              "type": "repeater",
              "validation": {
                "subFields": [
                  { "slug": "title", "label": "Title", "type": "string", "required": true },
                  { "slug": "description", "label": "Description", "type": "text" }
                ]
              }
            }
          ]
        }
      ]
    }
  ],
  "collections": [
    {
      "slug": "pages",
      "label": "Pages",
      "fields": [
        { "slug": "title", "label": "Title", "type": "string", "required": true },
        {
          "slug": "layout",
          "label": "Layout",
          "type": "blocks",
          "validation": {
            "allowedTypes": ["hero", "feature_grid"],
            "maxItems": 20
          }
        }
      ]
    }
  ]
}

区块选择器按 allowedTypes 的顺序列出区块类型,并按 category 分组,同时显示每个类型的 description 和 icon。请将 icon 设置为 Phosphor 图标的名称,例如 sparkle 或 chart-bar;编辑者在内容编辑器中也会在每个区块上看到它。没有图标,或名称与 Phosphor 图标不匹配的区块类型,会显示通用的区块图标。

如果你之后移除了某个允许的类型,EmDash 会把它移到由服务器管理的 retiredTypes 列表中。现有区块仍然可以编辑,但编辑者无法添加或复制该类型。

为编辑器布局命名字段

内容编辑器中展开的区块会先显示其内容:文本、富文本、照片和列表,每项都位于各自标签之下。接着是设置,以标签位于值旁边的行显示,最后是一个 Advanced 行。编辑器根据字段的类型和 slug(而非标签)来放置每个字段,并按原样显示每个标签。以下约定会改变字段的位置:

  • 链接字段。 url 字段,或 slug 以 _url、_link 或 _href 结尾的 string 字段,会得到一个设置行。
  • 按钮。 名为 {base}_label、{base}_text 或 {base} 的 string 字段,与名为 {base}_url、{base}_link 或 {base}_href 的链接字段共用一行。该行采用文本字段的标签。在上面的 Hero 中,link_label 和 link_url 共用一行,标签为“Link label”。
  • 图注。 名为 {image}_caption 的 string 字段位于名为 {image} 的 image 字段之下,例如 photo 之下的 photo_caption。
  • 区段 ID。 名为 anchor_id 的字段放在 Advanced 行中。
  • 标题。 slug 中含有 headline、heading、title 或 statement 这些词的第一个 string 或 text 字段,会以更大的字号显示,作为区块的标题。slug 中含有 label、eyebrow、kicker 或 tag 这些词的字段永远不会成为标题。slug 会在下划线处拆分为单词,因此 section_heading 符合条件,而 subheadline 不符合。没有字段匹配时,区块的第一个 string 或 text 字段就是标题,除非它的 slug 含有上述被排除的词。

区块内的 repeater 字段根据其子字段确定形态:

  • 输入式列表。 恰好只有一个子字段、且类型为 string 或 url 的列表,会把每一项显示为带项目符号的一行。按 Enter 会添加一行,粘贴多行文本则每行添加一项。客户名称列表就符合这种形态。
  • 表格。 子字段最多三个、每个类型都是 string、url、number、integer、select 或 image,且 image 至多一个的列表,会每项显示一行、每个子字段显示一列。包含数值和标签的统计列表就符合这种形态。
  • 可展开项。 其他所有列表都会把每一项显示为一行,展开后可编辑其子字段。展开的项按上述规则排布其子字段,只是没有子字段会被绘制为标题或放入 Advanced 行,照片会得到一个设置行,{image}_caption 则是普通的文本字段。

一项的标题是它的第一个既不是链接字段也不是按钮文本的 string 子字段,否则是它的第一个 text 子字段。折叠的项显示其标题,后面最多跟着它的其他两个 string 值。如果这些值都为空,则改为显示它的第一个其他 text 值的开头。在上面的 Feature grid 中,items 显示为以 title 作为标题的可展开项。给表格形态的区块类型添加第四个子字段或一个 text 子字段,会让该列表变成可展开项。

这些规则是尽力而为的布局提示,在后续版本中可能会变化。它们只影响编辑器排布表单的方式,不符合其中任何一条的字段会单独占一行。

创建 Astro 组件

每个组件都会接收 value、index 和 blockKey。该值包含 _type、_version 和 _key,因此当区块 schema 演进时,组件可以收窄保留的版本。

Hero 组件从已存储的区块中读取所有要显示的值:

---
import { sanitizeHref } from "emdash";
import { Image, PortableText, type BlockComponentProps } from "emdash/ui";
import type { PageLayoutBlock } from "../../../emdash-env";

type HeroBlock = Extract<PageLayoutBlock, { _type: "hero" }>;
type Props = BlockComponentProps<HeroBlock>;

const { value } = Astro.props;
---

<section class="hero">
  <div>
    <h1>{value.heading}</h1>
    {value.body && <PortableText value={value.body} />}
    {value.link_url && <a href={sanitizeHref(value.link_url)}>{value.link_label}</a>}
  </div>
  {value.image && <Image image={value.image} />}
</section>

请为每个允许的类型创建一个组件。组件控制标记和样式;区块的值提供内容和媒体。

渲染页面组合

使用 defineBlockComponents,要求为生成的字段联合类型中的每个 _type 都提供一个组件。然后在页面路由中把该映射传给 <Blocks>。

---
import { decodeSlug, getEmDashEntry } from "emdash";
import { Blocks, defineBlockComponents } from "emdash/ui";
import type { PageLayoutBlock } from "../../../emdash-env";
import FeatureGrid from "../../components/blocks/FeatureGrid.astro";
import Hero from "../../components/blocks/Hero.astro";

const slug = decodeSlug(Astro.params.slug);
if (!slug) return Astro.rewrite("/404");

const { entry: page, cacheHint } = await getEmDashEntry("pages", slug);
if (!page) return Astro.rewrite("/404");
Astro.cache.set(cacheHint);

const components = defineBlockComponents<PageLayoutBlock>({
  hero: Hero,
  feature_grid: FeatureGrid,
});
---

<Blocks value={page.data.layout} components={components} />

<Blocks> 不会执行任何内容、schema、媒体或网络查询。它按存储的顺序渲染所提供的数组。当某个区块组件需要其他数据时,它可以执行显式的应用程序查询。

处理缺失的组件

在开发期间,未映射的类型会生成一个可见的占位符和一条控制台警告。占位符会显示 _type 的名称,但不会打印已存储的区块值。

在生产环境中,未映射的类型会在提供了 fallback 组件时渲染该组件,否则不渲染任何输出:

---
import MissingBlock from "../../components/blocks/MissingBlock.astro";
---

<Blocks value={page.data.layout} components={components} fallback={MissingBlock} />

在启用或激活生产内容所使用的区块类型之前,请先发布渲染器的支持。

修改区块 schema

兼容的更改会修订当前生效的版本。添加可选字段、添加默认值或放宽校验,都会保持相同的版本号。已存储的区块会在下次写入时获得默认值。

破坏性更改会创建一个未激活的版本。移除字段、更改字段类型、添加必填字段或收紧校验,都属于破坏性更改。

  1. 通过 schema API 或 MCP 创建破坏性版本。让它保持未激活状态。

  2. 更新渲染器,使其同时处理保留的版本和新版本。部署渲染器。

  3. 激活新版本。激活之后,新区块会使用它。

  4. 使用 migrateBlocks: true 显式迁移已存储的区块。在更改 _version 及其特定于版本的字段时,保留每个区块的 _key。

旧版本仍然可用于修订、草稿、媒体追踪和已存储的内容。区块类型和保留的版本没有硬删除操作。

支持的嵌套字段

区块定义支持 string、text、url、number、integer、boolean、datetime、select、multiSelect、portableText、image、file 和 repeater。

区块定义内部不支持引用、JSON、slug、嵌套区块、自定义小部件、物理索引、唯一性以及按子字段的本地化。blocks 字段本身不能设为必填、唯一、可搜索、可索引,也不能指定自定义字段小部件。

有关确切的字段校验和已存储值的规则,请参阅 blocks 字段参考。有关种子冲突和导出行为,请参阅 Seed 文件。