packages/layout/README.md 的 AppShell 示例传了一个 header prop,而 AppShellProps 没有它 —— 照抄示例头部区永不渲染 #4817

发现于 #4793 的实施(PR 见该单),回传立单。未认领,交 PM 三角。

事实(基线 d44279598 实测)

packages/layout/README.md 的 AppShell 示例:

import { AppShell } from '@object-ui/layout';

<AppShell
  header={<div>Header Content</div>}
  sidebar={<div>Sidebar Content</div>}
>
  <div>Main Content</div>
</AppShell>

AppShellProps(packages/layout/src/AppShell.tsx:25-40)声明的是 sidebar / navbar / children / className / defaultOpen / branding / rightRail —— 没有 header。组件解构(:233-241)是固定键表、无 rest,所以传进去的那个节点被整个丢弃:照抄示例的读者得到一个空的顶部栏,而顶栏内容的真实入口叫 navbar(AppShell.tsx:249 的 {navbar})。

为什么和 #4793 分开立

同一类「幻影 prop」事实,但载体是另一个文件的另一个示例:

• app-shell.mdx 的导航示例 2/3 键错(label/icon 字符串)+ 教了一个被整个丢弃的 header prop + searchEnabled 下必抛 TypeError 的隐患 #4793 = content/docs/layout/app-shell.mdx 的 SidebarNav header={{ logo, title }} / footer={…}(已在其 PR 里修掉);
• 本单 = packages/layout/README.md 的 AppShell header={…}。

#3999 / PR #4792 修的是同一个 README 的 SidebarNav 段落并给它加了钉子(readme-sidebar-nav-example.test.ts),那个钉子的断言面是 SidebarNav 的 fence 与 props 表,够不到上方这个 AppShell 示例 —— 所以它至今没被任何门禁看见。#4793 新加的钉子扫描面明确只覆盖 app-shell.mdx 一页,同样够不到这里。

修法建议(不预设)

把 header= 改成 navbar=(README 是 npm 落地页,示例可直接照抄才有意义)。若顺带想要钉子,readme-sidebar-nav-example.test.ts 里那条「prop 名读自 SidebarNav.tsx 的 interface」的写法可以原样套到 AppShellProps 上;要不要做属于 scope 判断,本单不预设。

参考

• packages/layout/src/AppShell.tsx:25-40(AppShellProps)、:233-241(解构)、:249({navbar})
• app-shell.mdx 的导航示例 2/3 键错(label/icon 字符串)+ 教了一个被整个丢弃的 header prop + searchEnabled 下必抛 TypeError 的隐患 #4793(同类事实,mdx 载体)、packages/layout/README.md 的 SidebarNav 示例三个键全错(label/path/icon 字符串),按它写出的侧边栏无标签、且 NavLink to=undefined #3999 / PR docs(layout): SidebarNav README 示例改回 NavItem 真实形状,补 props 表并钉住 (#3999) #4792(同文件 SidebarNav 段落与其钉子)、finding: app-shell.mdx 的 AppShellProps 声明块漏了 2 个真实 props(branding、rightRail/ADR-0057 P3a),读者从文档看不到它们存在 #4808(同族,app-shell.mdx 的 AppShellProps 声明块漏 props)

Generated by Claude Code