docs(components): name the overlay/feedback node slots at their declared type#7107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-warren merged 1 commit into from
Sep 1, 2026
Merged

docs(components): name the overlay/feedback node slots at their declared type #7107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions .changeset/7082-overlay-node-slot-doc-type-names.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
---
---

Docs only, publishes nothing: six component pages spelled a node slot
`ComponentSchema`, a real shipped export (`packages/types/src/blocks.ts`) that
is **not** a node slot — it is the concrete `type: 'component'` block. The keys
carry `SchemaNode` (`packages/types/src/base.ts`), which also admits
`string | number | boolean | null | undefined`. A reader who looked the
published name up found a narrow, unrelated type.

Every row is re-derived from its own declaration on `2c3cd1b`, per page — not
by a string replace, because the declarations disagree with each other on
whether the array form is admitted.

| page row before | declaration on `main` | page after |
| --- | --- | --- |
| `AlertDialogSchema.trigger: ComponentSchema` | `trigger?: SchemaNode` (`overlay.ts:91`) | `SchemaNode` |
| `ContextMenuSchema.trigger?: ComponentSchema` | `trigger?: SchemaNode \| SchemaNode[]` (`overlay.ts:486`) | `SchemaNode \| SchemaNode[]` |
| `HoverCardSchema.trigger: ComponentSchema` | `trigger: SchemaNode` (`overlay.ts:296`) | `SchemaNode` |
| `HoverCardSchema.content: ComponentSchema` | `content: SchemaNode \| SchemaNode[]` (`overlay.ts:292`) | `SchemaNode \| SchemaNode[]` |
| `DropdownMenuSchema.trigger: ComponentSchema` | `trigger: SchemaNode` (`overlay.ts:433`) | `SchemaNode` |
| `SheetSchema.trigger: ComponentSchema` | `trigger?: SchemaNode` (`overlay.ts:150`) | `SchemaNode` |
| `SheetSchema.content: ComponentSchema` | `content?: SchemaNode \| SchemaNode[]` (`overlay.ts:146`) | `SchemaNode \| SchemaNode[]` |

**`dropdown-menu` stays singular on purpose.** Its Zod mirror
(`zod/overlay.zod.ts:176`), its sibling `ContextMenuSchema`, and its own shipped
`defaultProps` (`renderers/overlay/dropdown-menu.tsx:130`) all use the array
form, and the published TS type refuses it. Which side is right is objectui#7081,
open and awaiting a maintainer decision on a published-type widening. Publishing
the array form here would have put a claim in the docs that the shipped type
rejects and pre-empted that ruling; the page therefore follows the type an
author's editor reads. The incoherence is real, and it *is* #7081.

**Two of the nine rows the card named are NOT renamed**, because no honest
docs-only edit resolves them, and both are filed instead:

- `AlertDialogSchema.actions?: ComponentSchema[]` — declared on neither the TS
interface (`overlay.ts:78-127`) nor the mirror (`zod/overlay.zod.ts:42-55`),
and read by nothing. Renaming it would have kept a phantom key alive under a
second wrong type.
- `EmptySchema.action?: ComponentSchema` — declared on neither
(`feedback.ts:210-224`, `zod/feedback.zod.ts:120-125`), but *read* by the
shipped renderer through a cast (`renderers/feedback/empty.tsx`), which
requires `typeof === 'object'`. `SchemaNode` admits `string | number |
boolean`, so publishing it there would have been a new false claim, not a
correction.

Requiredness is likewise left alone and filed: `AlertDialogSchema.trigger`,
`SheetSchema.trigger` and `SheetSchema.content` are declared optional and
published required. That is objectui#7073's defect class, already fixed by it on
`context-menu.mdx`, and is out of this card's fence.

`packages/types/src/__tests__/overlay-node-slot-doc-types-7082.test.ts` pins the
result, and this is a page where the pin is the only evidence there is: all
these rows sit in `plaintext` fences, `check:doc-snippets` compiles
`ts`/`tsx`/`typescript` only and `check:doc-types` reads only the `type` string
literals, so no gate parses them (objectui#5250, objectui#5867). A green CI run
here says "nothing else broke", not "the correction is right".

The pin's authority is the **TS declaration**, not the Zod mirror — the one
deliberate departure from the objectui#6347 model, because on this tree the two
disagree on four `trigger` rows and pinning against the mirror would have
published #7081's answer. Its type-level leg is compiled by
`packages/types/tsconfig.test.json`, so widening `DropdownMenuSchema.trigger`
turns it red and whoever lands #7081 is told this page owes an update. The two
undeclared rows and the three requiredness divergences are pinned as
divergences, so a fix on either side of any of them also turns it red.

No fence moved: each page holds one `plaintext` fence marker pair before and
after, so objectui#5867's shrink-only declared population is unchanged. No
declaration, mirror, renderer or fixture was edited.

Part of objectui#7082.
2 changes: 1 addition & 1 deletion content/docs/components/overlay/alert-dialog.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ interface AlertDialogSchema {
description: string; // Dialog description

// Trigger
trigger: ComponentSchema; // Component that triggers the dialog
trigger: SchemaNode; // Component that triggers the dialog

// Actions
actions?: ComponentSchema[]; // Action buttons
Expand Down
4 changes: 2 additions & 2 deletions content/docs/components/overlay/context-menu.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,8 @@ type ContextMenuItem = ContextMenuCommandItem | ContextMenuDividerItem;

interface ContextMenuSchema {
type: 'context-menu';
trigger?: ComponentSchema; // Trigger element — a placeholder renders when absent
items: ContextMenuItem[]; // Menu items
trigger?: SchemaNode | SchemaNode[]; // Trigger element — a placeholder renders when absent
items: ContextMenuItem[]; // Menu items
className?: string;
}
```
Expand Down
2 changes: 1 addition & 1 deletion content/docs/components/overlay/dropdown-menu.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ type DropdownMenuItem = DropdownMenuCommandItem | DropdownMenuDividerItem;

interface DropdownMenuSchema {
type: 'dropdown-menu';
trigger: ComponentSchema; // Trigger component
trigger: SchemaNode; // Trigger component
items: DropdownMenuItem[]; // Menu items

// Styling
Expand Down
8 changes: 4 additions & 4 deletions content/docs/components/overlay/hover-card.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,12 +14,12 @@ The Hover Card component displays rich content when hovering over an element.
```plaintext
interface HoverCardSchema {
type: 'hover-card';
trigger: ComponentSchema; // Trigger element
content: ComponentSchema; // Card content
trigger: SchemaNode; // Trigger element
content: SchemaNode | SchemaNode[]; // Card content
side?: 'top' | 'right' | 'bottom' | 'left';
align?: 'start' | 'center' | 'end';
openDelay?: number; // Delay before opening (ms)
closeDelay?: number; // Delay before closing (ms)
openDelay?: number; // Delay before opening (ms)
closeDelay?: number; // Delay before closing (ms)
className?: string;
}
```
8 changes: 4 additions & 4 deletions content/docs/components/overlay/sheet.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,10 @@ The Sheet component displays content in a panel that slides in from the edge of
```plaintext
interface SheetSchema {
type: 'sheet';
trigger: ComponentSchema; // Trigger component
title?: string; // Sheet title
description?: string; // Sheet description
content: ComponentSchema; // Sheet content
trigger: SchemaNode; // Trigger component
title?: string; // Sheet title
description?: string; // Sheet description
content: SchemaNode | SchemaNode[]; // Sheet content
side?: 'left' | 'right' | 'top' | 'bottom';
className?: string;
}
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
docs(components): name the overlay/feedback node slots at their declared type#7107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-warren
merged 1 commit into

from

Sep 1, 2026
 Merged


docs(components): name the overlay/feedback node slots at their declared type
#7107
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


73 changes: 73 additions & 0 deletions
.changeset/7082-overlay-node-slot-doc-type-names.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
---
---

Docs only, publishes nothing: six component pages spelled a node slot
`ComponentSchema`, a real shipped export (`packages/types/src/blocks.ts`) that
is **not** a node slot — it is the concrete `type: 'component'` block. The keys
carry `SchemaNode` (`packages/types/src/base.ts`), which also admits
`string | number | boolean | null | undefined`. A reader who looked the
published name up found a narrow, unrelated type.

Every row is re-derived from its own declaration on `2c3cd1b`, per page — not
by a string replace, because the declarations disagree with each other on
whether the array form is admitted.

| page row before | declaration on `main` | page after |
| --- | --- | --- |
| `AlertDialogSchema.trigger: ComponentSchema` | `trigger?: SchemaNode` (`overlay.ts:91`) | `SchemaNode` |
| `ContextMenuSchema.trigger?: ComponentSchema` | `trigger?: SchemaNode \| SchemaNode[]` (`overlay.ts:486`) | `SchemaNode \| SchemaNode[]` |
| `HoverCardSchema.trigger: ComponentSchema` | `trigger: SchemaNode` (`overlay.ts:296`) | `SchemaNode` |
| `HoverCardSchema.content: ComponentSchema` | `content: SchemaNode \| SchemaNode[]` (`overlay.ts:292`) | `SchemaNode \| SchemaNode[]` |
| `DropdownMenuSchema.trigger: ComponentSchema` | `trigger: SchemaNode` (`overlay.ts:433`) | `SchemaNode` |
| `SheetSchema.trigger: ComponentSchema` | `trigger?: SchemaNode` (`overlay.ts:150`) | `SchemaNode` |
| `SheetSchema.content: ComponentSchema` | `content?: SchemaNode \| SchemaNode[]` (`overlay.ts:146`) | `SchemaNode \| SchemaNode[]` |

**`dropdown-menu` stays singular on purpose.** Its Zod mirror
(`zod/overlay.zod.ts:176`), its sibling `ContextMenuSchema`, and its own shipped
`defaultProps` (`renderers/overlay/dropdown-menu.tsx:130`) all use the array
form, and the published TS type refuses it. Which side is right is objectui#7081,
open and awaiting a maintainer decision on a published-type widening. Publishing
the array form here would have put a claim in the docs that the shipped type
rejects and pre-empted that ruling; the page therefore follows the type an
author's editor reads. The incoherence is real, and it *is* #7081.

**Two of the nine rows the card named are NOT renamed**, because no honest
docs-only edit resolves them, and both are filed instead:

- `AlertDialogSchema.actions?: ComponentSchema[]` — declared on neither the TS
 interface (`overlay.ts:78-127`) nor the mirror (`zod/overlay.zod.ts:42-55`),
 and read by nothing. Renaming it would have kept a phantom key alive under a
 second wrong type.
- `EmptySchema.action?: ComponentSchema` — declared on neither
 (`feedback.ts:210-224`, `zod/feedback.zod.ts:120-125`), but *read* by the
 shipped renderer through a cast (`renderers/feedback/empty.tsx`), which
 requires `typeof === 'object'`. `SchemaNode` admits `string | number |
 boolean`, so publishing it there would have been a new false claim, not a
 correction.

Requiredness is likewise left alone and filed: `AlertDialogSchema.trigger`,
`SheetSchema.trigger` and `SheetSchema.content` are declared optional and
published required. That is objectui#7073's defect class, already fixed by it on
`context-menu.mdx`, and is out of this card's fence.

`packages/types/src/__tests__/overlay-node-slot-doc-types-7082.test.ts` pins the
result, and this is a page where the pin is the only evidence there is: all
these rows sit in `plaintext` fences, `check:doc-snippets` compiles
`ts`/`tsx`/`typescript` only and `check:doc-types` reads only the `type` string
literals, so no gate parses them (objectui#5250, objectui#5867). A green CI run
here says "nothing else broke", not "the correction is right".

The pin's authority is the **TS declaration**, not the Zod mirror — the one
deliberate departure from the objectui#6347 model, because on this tree the two
disagree on four `trigger` rows and pinning against the mirror would have
published #7081's answer. Its type-level leg is compiled by
`packages/types/tsconfig.test.json`, so widening `DropdownMenuSchema.trigger`
turns it red and whoever lands #7081 is told this page owes an update. The two
undeclared rows and the three requiredness divergences are pinned as
divergences, so a fix on either side of any of them also turns it red.

No fence moved: each page holds one `plaintext` fence marker pair before and
after, so objectui#5867's shrink-only declared population is unchanged. No
declaration, mirror, renderer or fixture was edited.

Part of objectui#7082.

2 changes: 1 addition & 1 deletion
content/docs/components/overlay/alert-dialog.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ interface AlertDialogSchema {
 description: string; // Dialog description

 // Trigger
 trigger: ComponentSchema; // Component that triggers the dialog
 trigger: SchemaNode;  // Component that triggers the dialog

 // Actions
 actions?: ComponentSchema[]; // Action buttons
Expand Down

4 changes: 2 additions & 2 deletions
content/docs/components/overlay/context-menu.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,8 @@ type ContextMenuItem = ContextMenuCommandItem | ContextMenuDividerItem;

interface ContextMenuSchema {
 type: 'context-menu';
 trigger?: ComponentSchema;  // Trigger element — a placeholder renders when absent
 items: ContextMenuItem[]; // Menu items
 trigger?: SchemaNode | SchemaNode[]; // Trigger element — a placeholder renders when absent
 items: ContextMenuItem[]; // Menu items
 className?: string;
}
```
Expand Down

2 changes: 1 addition & 1 deletion
content/docs/components/overlay/dropdown-menu.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ type DropdownMenuItem = DropdownMenuCommandItem | DropdownMenuDividerItem;

interface DropdownMenuSchema {
 type: 'dropdown-menu';
 trigger: ComponentSchema; // Trigger component
 trigger: SchemaNode;  // Trigger component
 items: DropdownMenuItem[]; // Menu items

 // Styling
Expand Down

8 changes: 4 additions & 4 deletions
content/docs/components/overlay/hover-card.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,12 +14,12 @@ The Hover Card component displays rich content when hovering over an element.
```plaintext
interface HoverCardSchema {
 type: 'hover-card';
 trigger: ComponentSchema; // Trigger element
 content: ComponentSchema;  // Card content
 trigger: SchemaNode;  // Trigger element
 content: SchemaNode | SchemaNode[]; // Card content
 side?: 'top' | 'right' | 'bottom' | 'left';
 align?: 'start' | 'center' | 'end';
 openDelay?: number; // Delay before opening (ms)
 closeDelay?: number; // Delay before closing (ms)
 openDelay?: number; // Delay before opening (ms)
 closeDelay?: number; // Delay before closing (ms)
 className?: string;
}
```

8 changes: 4 additions & 4 deletions
content/docs/components/overlay/sheet.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,10 @@ The Sheet component displays content in a panel that slides in from the edge of
```plaintext
interface SheetSchema {
 type: 'sheet';
 trigger: ComponentSchema; // Trigger component
 title?: string; // Sheet title
 description?: string; // Sheet description
 content: ComponentSchema;  // Sheet content
 trigger: SchemaNode;  // Trigger component
 title?: string; // Sheet title
 description?: string; // Sheet description
 content: SchemaNode | SchemaNode[]; // Sheet content
 side?: 'left' | 'right' | 'top' | 'bottom';
 className?: string;
}
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(components): name the overlay/feedback node slots at their declared type#7107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-warren
merged 1 commit into

from

Sep 1, 2026
 Merged


docs(components): name the overlay/feedback node slots at their declared type
#7107
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


73 changes: 73 additions & 0 deletions
.changeset/7082-overlay-node-slot-doc-type-names.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
---
---

Docs only, publishes nothing: six component pages spelled a node slot
`ComponentSchema`, a real shipped export (`packages/types/src/blocks.ts`) that
is **not** a node slot — it is the concrete `type: 'component'` block. The keys
carry `SchemaNode` (`packages/types/src/base.ts`), which also admits
`string | number | boolean | null | undefined`. A reader who looked the
published name up found a narrow, unrelated type.

Every row is re-derived from its own declaration on `2c3cd1b`, per page — not
by a string replace, because the declarations disagree with each other on
whether the array form is admitted.

| page row before | declaration on `main` | page after |
| --- | --- | --- |
| `AlertDialogSchema.trigger: ComponentSchema` | `trigger?: SchemaNode` (`overlay.ts:91`) | `SchemaNode` |
| `ContextMenuSchema.trigger?: ComponentSchema` | `trigger?: SchemaNode \| SchemaNode[]` (`overlay.ts:486`) | `SchemaNode \| SchemaNode[]` |
| `HoverCardSchema.trigger: ComponentSchema` | `trigger: SchemaNode` (`overlay.ts:296`) | `SchemaNode` |
| `HoverCardSchema.content: ComponentSchema` | `content: SchemaNode \| SchemaNode[]` (`overlay.ts:292`) | `SchemaNode \| SchemaNode[]` |
| `DropdownMenuSchema.trigger: ComponentSchema` | `trigger: SchemaNode` (`overlay.ts:433`) | `SchemaNode` |
| `SheetSchema.trigger: ComponentSchema` | `trigger?: SchemaNode` (`overlay.ts:150`) | `SchemaNode` |
| `SheetSchema.content: ComponentSchema` | `content?: SchemaNode \| SchemaNode[]` (`overlay.ts:146`) | `SchemaNode \| SchemaNode[]` |

**`dropdown-menu` stays singular on purpose.** Its Zod mirror
(`zod/overlay.zod.ts:176`), its sibling `ContextMenuSchema`, and its own shipped
`defaultProps` (`renderers/overlay/dropdown-menu.tsx:130`) all use the array
form, and the published TS type refuses it. Which side is right is objectui#7081,
open and awaiting a maintainer decision on a published-type widening. Publishing
the array form here would have put a claim in the docs that the shipped type
rejects and pre-empted that ruling; the page therefore follows the type an
author's editor reads. The incoherence is real, and it *is* #7081.

**Two of the nine rows the card named are NOT renamed**, because no honest
docs-only edit resolves them, and both are filed instead:

- `AlertDialogSchema.actions?: ComponentSchema[]` — declared on neither the TS
 interface (`overlay.ts:78-127`) nor the mirror (`zod/overlay.zod.ts:42-55`),
 and read by nothing. Renaming it would have kept a phantom key alive under a
 second wrong type.
- `EmptySchema.action?: ComponentSchema` — declared on neither
 (`feedback.ts:210-224`, `zod/feedback.zod.ts:120-125`), but *read* by the
 shipped renderer through a cast (`renderers/feedback/empty.tsx`), which
 requires `typeof === 'object'`. `SchemaNode` admits `string | number |
 boolean`, so publishing it there would have been a new false claim, not a
 correction.

Requiredness is likewise left alone and filed: `AlertDialogSchema.trigger`,
`SheetSchema.trigger` and `SheetSchema.content` are declared optional and
published required. That is objectui#7073's defect class, already fixed by it on
`context-menu.mdx`, and is out of this card's fence.

`packages/types/src/__tests__/overlay-node-slot-doc-types-7082.test.ts` pins the
result, and this is a page where the pin is the only evidence there is: all
these rows sit in `plaintext` fences, `check:doc-snippets` compiles
`ts`/`tsx`/`typescript` only and `check:doc-types` reads only the `type` string
literals, so no gate parses them (objectui#5250, objectui#5867). A green CI run
here says "nothing else broke", not "the correction is right".

The pin's authority is the **TS declaration**, not the Zod mirror — the one
deliberate departure from the objectui#6347 model, because on this tree the two
disagree on four `trigger` rows and pinning against the mirror would have
published #7081's answer. Its type-level leg is compiled by
`packages/types/tsconfig.test.json`, so widening `DropdownMenuSchema.trigger`
turns it red and whoever lands #7081 is told this page owes an update. The two
undeclared rows and the three requiredness divergences are pinned as
divergences, so a fix on either side of any of them also turns it red.

No fence moved: each page holds one `plaintext` fence marker pair before and
after, so objectui#5867's shrink-only declared population is unchanged. No
declaration, mirror, renderer or fixture was edited.

Part of objectui#7082.

2 changes: 1 addition & 1 deletion
content/docs/components/overlay/alert-dialog.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ interface AlertDialogSchema {
 description: string; // Dialog description

 // Trigger
 trigger: ComponentSchema; // Component that triggers the dialog
 trigger: SchemaNode;  // Component that triggers the dialog

 // Actions
 actions?: ComponentSchema[]; // Action buttons
Expand Down

4 changes: 2 additions & 2 deletions
content/docs/components/overlay/context-menu.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,8 @@ type ContextMenuItem = ContextMenuCommandItem | ContextMenuDividerItem;

interface ContextMenuSchema {
 type: 'context-menu';
 trigger?: ComponentSchema;  // Trigger element — a placeholder renders when absent
 items: ContextMenuItem[]; // Menu items
 trigger?: SchemaNode | SchemaNode[]; // Trigger element — a placeholder renders when absent
 items: ContextMenuItem[]; // Menu items
 className?: string;
}
```
Expand Down

2 changes: 1 addition & 1 deletion
content/docs/components/overlay/dropdown-menu.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ type DropdownMenuItem = DropdownMenuCommandItem | DropdownMenuDividerItem;

interface DropdownMenuSchema {
 type: 'dropdown-menu';
 trigger: ComponentSchema; // Trigger component
 trigger: SchemaNode;  // Trigger component
 items: DropdownMenuItem[]; // Menu items

 // Styling
Expand Down

8 changes: 4 additions & 4 deletions
content/docs/components/overlay/hover-card.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,12 +14,12 @@ The Hover Card component displays rich content when hovering over an element.
```plaintext
interface HoverCardSchema {
 type: 'hover-card';
 trigger: ComponentSchema; // Trigger element
 content: ComponentSchema;  // Card content
 trigger: SchemaNode;  // Trigger element
 content: SchemaNode | SchemaNode[]; // Card content
 side?: 'top' | 'right' | 'bottom' | 'left';
 align?: 'start' | 'center' | 'end';
 openDelay?: number; // Delay before opening (ms)
 closeDelay?: number; // Delay before closing (ms)
 openDelay?: number; // Delay before opening (ms)
 closeDelay?: number; // Delay before closing (ms)
 className?: string;
}
```

8 changes: 4 additions & 4 deletions
content/docs/components/overlay/sheet.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,10 @@ The Sheet component displays content in a panel that slides in from the edge of
```plaintext
interface SheetSchema {
 type: 'sheet';
 trigger: ComponentSchema; // Trigger component
 title?: string; // Sheet title
 description?: string; // Sheet description
 content: ComponentSchema;  // Sheet content
 trigger: SchemaNode;  // Trigger component
 title?: string; // Sheet title
 description?: string; // Sheet description
 content: SchemaNode | SchemaNode[]; // Sheet content
 side?: 'left' | 'right' | 'top' | 'bottom';
 className?: string;
}
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(components): name the overlay/feedback node slots at their declared type#7107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-warren
merged 1 commit into

from

Sep 1, 2026
 Merged


docs(components): name the overlay/feedback node slots at their declared type
#7107
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


73 changes: 73 additions & 0 deletions
.changeset/7082-overlay-node-slot-doc-type-names.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
---
---

Docs only, publishes nothing: six component pages spelled a node slot
`ComponentSchema`, a real shipped export (`packages/types/src/blocks.ts`) that
is **not** a node slot — it is the concrete `type: 'component'` block. The keys
carry `SchemaNode` (`packages/types/src/base.ts`), which also admits
`string | number | boolean | null | undefined`. A reader who looked the
published name up found a narrow, unrelated type.

Every row is re-derived from its own declaration on `2c3cd1b`, per page — not
by a string replace, because the declarations disagree with each other on
whether the array form is admitted.

| page row before | declaration on `main` | page after |
| --- | --- | --- |
| `AlertDialogSchema.trigger: ComponentSchema` | `trigger?: SchemaNode` (`overlay.ts:91`) | `SchemaNode` |
| `ContextMenuSchema.trigger?: ComponentSchema` | `trigger?: SchemaNode \| SchemaNode[]` (`overlay.ts:486`) | `SchemaNode \| SchemaNode[]` |
| `HoverCardSchema.trigger: ComponentSchema` | `trigger: SchemaNode` (`overlay.ts:296`) | `SchemaNode` |
| `HoverCardSchema.content: ComponentSchema` | `content: SchemaNode \| SchemaNode[]` (`overlay.ts:292`) | `SchemaNode \| SchemaNode[]` |
| `DropdownMenuSchema.trigger: ComponentSchema` | `trigger: SchemaNode` (`overlay.ts:433`) | `SchemaNode` |
| `SheetSchema.trigger: ComponentSchema` | `trigger?: SchemaNode` (`overlay.ts:150`) | `SchemaNode` |
| `SheetSchema.content: ComponentSchema` | `content?: SchemaNode \| SchemaNode[]` (`overlay.ts:146`) | `SchemaNode \| SchemaNode[]` |

**`dropdown-menu` stays singular on purpose.** Its Zod mirror
(`zod/overlay.zod.ts:176`), its sibling `ContextMenuSchema`, and its own shipped
`defaultProps` (`renderers/overlay/dropdown-menu.tsx:130`) all use the array
form, and the published TS type refuses it. Which side is right is objectui#7081,
open and awaiting a maintainer decision on a published-type widening. Publishing
the array form here would have put a claim in the docs that the shipped type
rejects and pre-empted that ruling; the page therefore follows the type an
author's editor reads. The incoherence is real, and it *is* #7081.

**Two of the nine rows the card named are NOT renamed**, because no honest
docs-only edit resolves them, and both are filed instead:

- `AlertDialogSchema.actions?: ComponentSchema[]` — declared on neither the TS
 interface (`overlay.ts:78-127`) nor the mirror (`zod/overlay.zod.ts:42-55`),
 and read by nothing. Renaming it would have kept a phantom key alive under a
 second wrong type.
- `EmptySchema.action?: ComponentSchema` — declared on neither
 (`feedback.ts:210-224`, `zod/feedback.zod.ts:120-125`), but *read* by the
 shipped renderer through a cast (`renderers/feedback/empty.tsx`), which
 requires `typeof === 'object'`. `SchemaNode` admits `string | number |
 boolean`, so publishing it there would have been a new false claim, not a
 correction.

Requiredness is likewise left alone and filed: `AlertDialogSchema.trigger`,
`SheetSchema.trigger` and `SheetSchema.content` are declared optional and
published required. That is objectui#7073's defect class, already fixed by it on
`context-menu.mdx`, and is out of this card's fence.

`packages/types/src/__tests__/overlay-node-slot-doc-types-7082.test.ts` pins the
result, and this is a page where the pin is the only evidence there is: all
these rows sit in `plaintext` fences, `check:doc-snippets` compiles
`ts`/`tsx`/`typescript` only and `check:doc-types` reads only the `type` string
literals, so no gate parses them (objectui#5250, objectui#5867). A green CI run
here says "nothing else broke", not "the correction is right".

The pin's authority is the **TS declaration**, not the Zod mirror — the one
deliberate departure from the objectui#6347 model, because on this tree the two
disagree on four `trigger` rows and pinning against the mirror would have
published #7081's answer. Its type-level leg is compiled by
`packages/types/tsconfig.test.json`, so widening `DropdownMenuSchema.trigger`
turns it red and whoever lands #7081 is told this page owes an update. The two
undeclared rows and the three requiredness divergences are pinned as
divergences, so a fix on either side of any of them also turns it red.

No fence moved: each page holds one `plaintext` fence marker pair before and
after, so objectui#5867's shrink-only declared population is unchanged. No
declaration, mirror, renderer or fixture was edited.

Part of objectui#7082.

2 changes: 1 addition & 1 deletion
content/docs/components/overlay/alert-dialog.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ interface AlertDialogSchema {
 description: string; // Dialog description

 // Trigger
 trigger: ComponentSchema; // Component that triggers the dialog
 trigger: SchemaNode;  // Component that triggers the dialog

 // Actions
 actions?: ComponentSchema[]; // Action buttons
Expand Down

4 changes: 2 additions & 2 deletions
content/docs/components/overlay/context-menu.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,8 @@ type ContextMenuItem = ContextMenuCommandItem | ContextMenuDividerItem;

interface ContextMenuSchema {
 type: 'context-menu';
 trigger?: ComponentSchema;  // Trigger element — a placeholder renders when absent
 items: ContextMenuItem[]; // Menu items
 trigger?: SchemaNode | SchemaNode[]; // Trigger element — a placeholder renders when absent
 items: ContextMenuItem[]; // Menu items
 className?: string;
}
```
Expand Down

2 changes: 1 addition & 1 deletion
content/docs/components/overlay/dropdown-menu.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ type DropdownMenuItem = DropdownMenuCommandItem | DropdownMenuDividerItem;

interface DropdownMenuSchema {
 type: 'dropdown-menu';
 trigger: ComponentSchema; // Trigger component
 trigger: SchemaNode;  // Trigger component
 items: DropdownMenuItem[]; // Menu items

 // Styling
Expand Down

8 changes: 4 additions & 4 deletions
content/docs/components/overlay/hover-card.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,12 +14,12 @@ The Hover Card component displays rich content when hovering over an element.
```plaintext
interface HoverCardSchema {
 type: 'hover-card';
 trigger: ComponentSchema; // Trigger element
 content: ComponentSchema;  // Card content
 trigger: SchemaNode;  // Trigger element
 content: SchemaNode | SchemaNode[]; // Card content
 side?: 'top' | 'right' | 'bottom' | 'left';
 align?: 'start' | 'center' | 'end';
 openDelay?: number; // Delay before opening (ms)
 closeDelay?: number; // Delay before closing (ms)
 openDelay?: number; // Delay before opening (ms)
 closeDelay?: number; // Delay before closing (ms)
 className?: string;
}
```

8 changes: 4 additions & 4 deletions
content/docs/components/overlay/sheet.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,10 @@ The Sheet component displays content in a panel that slides in from the edge of
```plaintext
interface SheetSchema {
 type: 'sheet';
 trigger: ComponentSchema; // Trigger component
 title?: string; // Sheet title
 description?: string; // Sheet description
 content: ComponentSchema;  // Sheet content
 trigger: SchemaNode;  // Trigger component
 title?: string; // Sheet title
 description?: string; // Sheet description
 content: SchemaNode | SchemaNode[]; // Sheet content
 side?: 'left' | 'right' | 'top' | 'bottom';
 className?: string;
}
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
docs(components): name the overlay/feedback node slots at their declared type#7107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-warren
merged 1 commit into

from

Sep 1, 2026
 Merged


docs(components): name the overlay/feedback node slots at their declared type
#7107
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


73 changes: 73 additions & 0 deletions
.changeset/7082-overlay-node-slot-doc-type-names.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
---
---

Docs only, publishes nothing: six component pages spelled a node slot
`ComponentSchema`, a real shipped export (`packages/types/src/blocks.ts`) that
is **not** a node slot — it is the concrete `type: 'component'` block. The keys
carry `SchemaNode` (`packages/types/src/base.ts`), which also admits
`string | number | boolean | null | undefined`. A reader who looked the
published name up found a narrow, unrelated type.

Every row is re-derived from its own declaration on `2c3cd1b`, per page — not
by a string replace, because the declarations disagree with each other on
whether the array form is admitted.

| page row before | declaration on `main` | page after |
| --- | --- | --- |
| `AlertDialogSchema.trigger: ComponentSchema` | `trigger?: SchemaNode` (`overlay.ts:91`) | `SchemaNode` |
| `ContextMenuSchema.trigger?: ComponentSchema` | `trigger?: SchemaNode \| SchemaNode[]` (`overlay.ts:486`) | `SchemaNode \| SchemaNode[]` |
| `HoverCardSchema.trigger: ComponentSchema` | `trigger: SchemaNode` (`overlay.ts:296`) | `SchemaNode` |
| `HoverCardSchema.content: ComponentSchema` | `content: SchemaNode \| SchemaNode[]` (`overlay.ts:292`) | `SchemaNode \| SchemaNode[]` |
| `DropdownMenuSchema.trigger: ComponentSchema` | `trigger: SchemaNode` (`overlay.ts:433`) | `SchemaNode` |
| `SheetSchema.trigger: ComponentSchema` | `trigger?: SchemaNode` (`overlay.ts:150`) | `SchemaNode` |
| `SheetSchema.content: ComponentSchema` | `content?: SchemaNode \| SchemaNode[]` (`overlay.ts:146`) | `SchemaNode \| SchemaNode[]` |

**`dropdown-menu` stays singular on purpose.** Its Zod mirror
(`zod/overlay.zod.ts:176`), its sibling `ContextMenuSchema`, and its own shipped
`defaultProps` (`renderers/overlay/dropdown-menu.tsx:130`) all use the array
form, and the published TS type refuses it. Which side is right is objectui#7081,
open and awaiting a maintainer decision on a published-type widening. Publishing
the array form here would have put a claim in the docs that the shipped type
rejects and pre-empted that ruling; the page therefore follows the type an
author's editor reads. The incoherence is real, and it *is* #7081.

**Two of the nine rows the card named are NOT renamed**, because no honest
docs-only edit resolves them, and both are filed instead:

- `AlertDialogSchema.actions?: ComponentSchema[]` — declared on neither the TS
 interface (`overlay.ts:78-127`) nor the mirror (`zod/overlay.zod.ts:42-55`),
 and read by nothing. Renaming it would have kept a phantom key alive under a
 second wrong type.
- `EmptySchema.action?: ComponentSchema` — declared on neither
 (`feedback.ts:210-224`, `zod/feedback.zod.ts:120-125`), but *read* by the
 shipped renderer through a cast (`renderers/feedback/empty.tsx`), which
 requires `typeof === 'object'`. `SchemaNode` admits `string | number |
 boolean`, so publishing it there would have been a new false claim, not a
 correction.

Requiredness is likewise left alone and filed: `AlertDialogSchema.trigger`,
`SheetSchema.trigger` and `SheetSchema.content` are declared optional and
published required. That is objectui#7073's defect class, already fixed by it on
`context-menu.mdx`, and is out of this card's fence.

`packages/types/src/__tests__/overlay-node-slot-doc-types-7082.test.ts` pins the
result, and this is a page where the pin is the only evidence there is: all
these rows sit in `plaintext` fences, `check:doc-snippets` compiles
`ts`/`tsx`/`typescript` only and `check:doc-types` reads only the `type` string
literals, so no gate parses them (objectui#5250, objectui#5867). A green CI run
here says "nothing else broke", not "the correction is right".

The pin's authority is the **TS declaration**, not the Zod mirror — the one
deliberate departure from the objectui#6347 model, because on this tree the two
disagree on four `trigger` rows and pinning against the mirror would have
published #7081's answer. Its type-level leg is compiled by
`packages/types/tsconfig.test.json`, so widening `DropdownMenuSchema.trigger`
turns it red and whoever lands #7081 is told this page owes an update. The two
undeclared rows and the three requiredness divergences are pinned as
divergences, so a fix on either side of any of them also turns it red.

No fence moved: each page holds one `plaintext` fence marker pair before and
after, so objectui#5867's shrink-only declared population is unchanged. No
declaration, mirror, renderer or fixture was edited.

Part of objectui#7082.

2 changes: 1 addition & 1 deletion
content/docs/components/overlay/alert-dialog.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ interface AlertDialogSchema {
 description: string; // Dialog description

 // Trigger
 trigger: ComponentSchema; // Component that triggers the dialog
 trigger: SchemaNode;  // Component that triggers the dialog

 // Actions
 actions?: ComponentSchema[]; // Action buttons
Expand Down

4 changes: 2 additions & 2 deletions
content/docs/components/overlay/context-menu.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,8 @@ type ContextMenuItem = ContextMenuCommandItem | ContextMenuDividerItem;

interface ContextMenuSchema {
 type: 'context-menu';
 trigger?: ComponentSchema;  // Trigger element — a placeholder renders when absent
 items: ContextMenuItem[]; // Menu items
 trigger?: SchemaNode | SchemaNode[]; // Trigger element — a placeholder renders when absent
 items: ContextMenuItem[]; // Menu items
 className?: string;
}
```
Expand Down

2 changes: 1 addition & 1 deletion
content/docs/components/overlay/dropdown-menu.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ type DropdownMenuItem = DropdownMenuCommandItem | DropdownMenuDividerItem;

interface DropdownMenuSchema {
 type: 'dropdown-menu';
 trigger: ComponentSchema; // Trigger component
 trigger: SchemaNode;  // Trigger component
 items: DropdownMenuItem[]; // Menu items

 // Styling
Expand Down

8 changes: 4 additions & 4 deletions
content/docs/components/overlay/hover-card.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,12 +14,12 @@ The Hover Card component displays rich content when hovering over an element.
```plaintext
interface HoverCardSchema {
 type: 'hover-card';
 trigger: ComponentSchema; // Trigger element
 content: ComponentSchema;  // Card content
 trigger: SchemaNode;  // Trigger element
 content: SchemaNode | SchemaNode[]; // Card content
 side?: 'top' | 'right' | 'bottom' | 'left';
 align?: 'start' | 'center' | 'end';
 openDelay?: number; // Delay before opening (ms)
 closeDelay?: number; // Delay before closing (ms)
 openDelay?: number; // Delay before opening (ms)
 closeDelay?: number; // Delay before closing (ms)
 className?: string;
}
```

8 changes: 4 additions & 4 deletions
content/docs/components/overlay/sheet.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,10 @@ The Sheet component displays content in a panel that slides in from the edge of
```plaintext
interface SheetSchema {
 type: 'sheet';
 trigger: ComponentSchema; // Trigger component
 title?: string; // Sheet title
 description?: string; // Sheet description
 content: ComponentSchema;  // Sheet content
 trigger: SchemaNode;  // Trigger component
 title?: string; // Sheet title
 description?: string; // Sheet description
 content: SchemaNode | SchemaNode[]; // Sheet content
 side?: 'left' | 'right' | 'top' | 'bottom';
 className?: string;
}
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(components): name the overlay/feedback node slots at their declared type#7107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-warren
merged 1 commit into

from

Sep 1, 2026
 Merged


docs(components): name the overlay/feedback node slots at their declared type
#7107
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


73 changes: 73 additions & 0 deletions
.changeset/7082-overlay-node-slot-doc-type-names.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
---
---

Docs only, publishes nothing: six component pages spelled a node slot
`ComponentSchema`, a real shipped export (`packages/types/src/blocks.ts`) that
is **not** a node slot — it is the concrete `type: 'component'` block. The keys
carry `SchemaNode` (`packages/types/src/base.ts`), which also admits
`string | number | boolean | null | undefined`. A reader who looked the
published name up found a narrow, unrelated type.

Every row is re-derived from its own declaration on `2c3cd1b`, per page — not
by a string replace, because the declarations disagree with each other on
whether the array form is admitted.

| page row before | declaration on `main` | page after |
| --- | --- | --- |
| `AlertDialogSchema.trigger: ComponentSchema` | `trigger?: SchemaNode` (`overlay.ts:91`) | `SchemaNode` |
| `ContextMenuSchema.trigger?: ComponentSchema` | `trigger?: SchemaNode \| SchemaNode[]` (`overlay.ts:486`) | `SchemaNode \| SchemaNode[]` |
| `HoverCardSchema.trigger: ComponentSchema` | `trigger: SchemaNode` (`overlay.ts:296`) | `SchemaNode` |
| `HoverCardSchema.content: ComponentSchema` | `content: SchemaNode \| SchemaNode[]` (`overlay.ts:292`) | `SchemaNode \| SchemaNode[]` |
| `DropdownMenuSchema.trigger: ComponentSchema` | `trigger: SchemaNode` (`overlay.ts:433`) | `SchemaNode` |
| `SheetSchema.trigger: ComponentSchema` | `trigger?: SchemaNode` (`overlay.ts:150`) | `SchemaNode` |
| `SheetSchema.content: ComponentSchema` | `content?: SchemaNode \| SchemaNode[]` (`overlay.ts:146`) | `SchemaNode \| SchemaNode[]` |

**`dropdown-menu` stays singular on purpose.** Its Zod mirror
(`zod/overlay.zod.ts:176`), its sibling `ContextMenuSchema`, and its own shipped
`defaultProps` (`renderers/overlay/dropdown-menu.tsx:130`) all use the array
form, and the published TS type refuses it. Which side is right is objectui#7081,
open and awaiting a maintainer decision on a published-type widening. Publishing
the array form here would have put a claim in the docs that the shipped type
rejects and pre-empted that ruling; the page therefore follows the type an
author's editor reads. The incoherence is real, and it *is* #7081.

**Two of the nine rows the card named are NOT renamed**, because no honest
docs-only edit resolves them, and both are filed instead:

- `AlertDialogSchema.actions?: ComponentSchema[]` — declared on neither the TS
 interface (`overlay.ts:78-127`) nor the mirror (`zod/overlay.zod.ts:42-55`),
 and read by nothing. Renaming it would have kept a phantom key alive under a
 second wrong type.
- `EmptySchema.action?: ComponentSchema` — declared on neither
 (`feedback.ts:210-224`, `zod/feedback.zod.ts:120-125`), but *read* by the
 shipped renderer through a cast (`renderers/feedback/empty.tsx`), which
 requires `typeof === 'object'`. `SchemaNode` admits `string | number |
 boolean`, so publishing it there would have been a new false claim, not a
 correction.

Requiredness is likewise left alone and filed: `AlertDialogSchema.trigger`,
`SheetSchema.trigger` and `SheetSchema.content` are declared optional and
published required. That is objectui#7073's defect class, already fixed by it on
`context-menu.mdx`, and is out of this card's fence.

`packages/types/src/__tests__/overlay-node-slot-doc-types-7082.test.ts` pins the
result, and this is a page where the pin is the only evidence there is: all
these rows sit in `plaintext` fences, `check:doc-snippets` compiles
`ts`/`tsx`/`typescript` only and `check:doc-types` reads only the `type` string
literals, so no gate parses them (objectui#5250, objectui#5867). A green CI run
here says "nothing else broke", not "the correction is right".

The pin's authority is the **TS declaration**, not the Zod mirror — the one
deliberate departure from the objectui#6347 model, because on this tree the two
disagree on four `trigger` rows and pinning against the mirror would have
published #7081's answer. Its type-level leg is compiled by
`packages/types/tsconfig.test.json`, so widening `DropdownMenuSchema.trigger`
turns it red and whoever lands #7081 is told this page owes an update. The two
undeclared rows and the three requiredness divergences are pinned as
divergences, so a fix on either side of any of them also turns it red.

No fence moved: each page holds one `plaintext` fence marker pair before and
after, so objectui#5867's shrink-only declared population is unchanged. No
declaration, mirror, renderer or fixture was edited.

Part of objectui#7082.

2 changes: 1 addition & 1 deletion
content/docs/components/overlay/alert-dialog.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ interface AlertDialogSchema {
 description: string; // Dialog description

 // Trigger
 trigger: ComponentSchema; // Component that triggers the dialog
 trigger: SchemaNode;  // Component that triggers the dialog

 // Actions
 actions?: ComponentSchema[]; // Action buttons
Expand Down

4 changes: 2 additions & 2 deletions
content/docs/components/overlay/context-menu.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,8 @@ type ContextMenuItem = ContextMenuCommandItem | ContextMenuDividerItem;

interface ContextMenuSchema {
 type: 'context-menu';
 trigger?: ComponentSchema;  // Trigger element — a placeholder renders when absent
 items: ContextMenuItem[]; // Menu items
 trigger?: SchemaNode | SchemaNode[]; // Trigger element — a placeholder renders when absent
 items: ContextMenuItem[]; // Menu items
 className?: string;
}
```
Expand Down

2 changes: 1 addition & 1 deletion
content/docs/components/overlay/dropdown-menu.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ type DropdownMenuItem = DropdownMenuCommandItem | DropdownMenuDividerItem;

interface DropdownMenuSchema {
 type: 'dropdown-menu';
 trigger: ComponentSchema; // Trigger component
 trigger: SchemaNode;  // Trigger component
 items: DropdownMenuItem[]; // Menu items

 // Styling
Expand Down

8 changes: 4 additions & 4 deletions
content/docs/components/overlay/hover-card.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,12 +14,12 @@ The Hover Card component displays rich content when hovering over an element.
```plaintext
interface HoverCardSchema {
 type: 'hover-card';
 trigger: ComponentSchema; // Trigger element
 content: ComponentSchema;  // Card content
 trigger: SchemaNode;  // Trigger element
 content: SchemaNode | SchemaNode[]; // Card content
 side?: 'top' | 'right' | 'bottom' | 'left';
 align?: 'start' | 'center' | 'end';
 openDelay?: number; // Delay before opening (ms)
 closeDelay?: number; // Delay before closing (ms)
 openDelay?: number; // Delay before opening (ms)
 closeDelay?: number; // Delay before closing (ms)
 className?: string;
}
```

8 changes: 4 additions & 4 deletions
content/docs/components/overlay/sheet.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,10 @@ The Sheet component displays content in a panel that slides in from the edge of
```plaintext
interface SheetSchema {
 type: 'sheet';
 trigger: ComponentSchema; // Trigger component
 title?: string; // Sheet title
 description?: string; // Sheet description
 content: ComponentSchema;  // Sheet content
 trigger: SchemaNode;  // Trigger component
 title?: string; // Sheet title
 description?: string; // Sheet description
 content: SchemaNode | SchemaNode[]; // Sheet content
 side?: 'left' | 'right' | 'top' | 'bottom';
 className?: string;
}
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(components): name the overlay/feedback node slots at their declared type#7107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-warren
merged 1 commit into

from

Sep 1, 2026
 Merged


docs(components): name the overlay/feedback node slots at their declared type
#7107
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


73 changes: 73 additions & 0 deletions
.changeset/7082-overlay-node-slot-doc-type-names.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
---
---

Docs only, publishes nothing: six component pages spelled a node slot
`ComponentSchema`, a real shipped export (`packages/types/src/blocks.ts`) that
is **not** a node slot — it is the concrete `type: 'component'` block. The keys
carry `SchemaNode` (`packages/types/src/base.ts`), which also admits
`string | number | boolean | null | undefined`. A reader who looked the
published name up found a narrow, unrelated type.

Every row is re-derived from its own declaration on `2c3cd1b`, per page — not
by a string replace, because the declarations disagree with each other on
whether the array form is admitted.

| page row before | declaration on `main` | page after |
| --- | --- | --- |
| `AlertDialogSchema.trigger: ComponentSchema` | `trigger?: SchemaNode` (`overlay.ts:91`) | `SchemaNode` |
| `ContextMenuSchema.trigger?: ComponentSchema` | `trigger?: SchemaNode \| SchemaNode[]` (`overlay.ts:486`) | `SchemaNode \| SchemaNode[]` |
| `HoverCardSchema.trigger: ComponentSchema` | `trigger: SchemaNode` (`overlay.ts:296`) | `SchemaNode` |
| `HoverCardSchema.content: ComponentSchema` | `content: SchemaNode \| SchemaNode[]` (`overlay.ts:292`) | `SchemaNode \| SchemaNode[]` |
| `DropdownMenuSchema.trigger: ComponentSchema` | `trigger: SchemaNode` (`overlay.ts:433`) | `SchemaNode` |
| `SheetSchema.trigger: ComponentSchema` | `trigger?: SchemaNode` (`overlay.ts:150`) | `SchemaNode` |
| `SheetSchema.content: ComponentSchema` | `content?: SchemaNode \| SchemaNode[]` (`overlay.ts:146`) | `SchemaNode \| SchemaNode[]` |

**`dropdown-menu` stays singular on purpose.** Its Zod mirror
(`zod/overlay.zod.ts:176`), its sibling `ContextMenuSchema`, and its own shipped
`defaultProps` (`renderers/overlay/dropdown-menu.tsx:130`) all use the array
form, and the published TS type refuses it. Which side is right is objectui#7081,
open and awaiting a maintainer decision on a published-type widening. Publishing
the array form here would have put a claim in the docs that the shipped type
rejects and pre-empted that ruling; the page therefore follows the type an
author's editor reads. The incoherence is real, and it *is* #7081.

**Two of the nine rows the card named are NOT renamed**, because no honest
docs-only edit resolves them, and both are filed instead:

- `AlertDialogSchema.actions?: ComponentSchema[]` — declared on neither the TS
 interface (`overlay.ts:78-127`) nor the mirror (`zod/overlay.zod.ts:42-55`),
 and read by nothing. Renaming it would have kept a phantom key alive under a
 second wrong type.
- `EmptySchema.action?: ComponentSchema` — declared on neither
 (`feedback.ts:210-224`, `zod/feedback.zod.ts:120-125`), but *read* by the
 shipped renderer through a cast (`renderers/feedback/empty.tsx`), which
 requires `typeof === 'object'`. `SchemaNode` admits `string | number |
 boolean`, so publishing it there would have been a new false claim, not a
 correction.

Requiredness is likewise left alone and filed: `AlertDialogSchema.trigger`,
`SheetSchema.trigger` and `SheetSchema.content` are declared optional and
published required. That is objectui#7073's defect class, already fixed by it on
`context-menu.mdx`, and is out of this card's fence.

`packages/types/src/__tests__/overlay-node-slot-doc-types-7082.test.ts` pins the
result, and this is a page where the pin is the only evidence there is: all
these rows sit in `plaintext` fences, `check:doc-snippets` compiles
`ts`/`tsx`/`typescript` only and `check:doc-types` reads only the `type` string
literals, so no gate parses them (objectui#5250, objectui#5867). A green CI run
here says "nothing else broke", not "the correction is right".

The pin's authority is the **TS declaration**, not the Zod mirror — the one
deliberate departure from the objectui#6347 model, because on this tree the two
disagree on four `trigger` rows and pinning against the mirror would have
published #7081's answer. Its type-level leg is compiled by
`packages/types/tsconfig.test.json`, so widening `DropdownMenuSchema.trigger`
turns it red and whoever lands #7081 is told this page owes an update. The two
undeclared rows and the three requiredness divergences are pinned as
divergences, so a fix on either side of any of them also turns it red.

No fence moved: each page holds one `plaintext` fence marker pair before and
after, so objectui#5867's shrink-only declared population is unchanged. No
declaration, mirror, renderer or fixture was edited.

Part of objectui#7082.

2 changes: 1 addition & 1 deletion
content/docs/components/overlay/alert-dialog.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ interface AlertDialogSchema {
 description: string; // Dialog description

 // Trigger
 trigger: ComponentSchema; // Component that triggers the dialog
 trigger: SchemaNode;  // Component that triggers the dialog

 // Actions
 actions?: ComponentSchema[]; // Action buttons
Expand Down

4 changes: 2 additions & 2 deletions
content/docs/components/overlay/context-menu.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,8 @@ type ContextMenuItem = ContextMenuCommandItem | ContextMenuDividerItem;

interface ContextMenuSchema {
 type: 'context-menu';
 trigger?: ComponentSchema;  // Trigger element — a placeholder renders when absent
 items: ContextMenuItem[]; // Menu items
 trigger?: SchemaNode | SchemaNode[]; // Trigger element — a placeholder renders when absent
 items: ContextMenuItem[]; // Menu items
 className?: string;
}
```
Expand Down

2 changes: 1 addition & 1 deletion
content/docs/components/overlay/dropdown-menu.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ type DropdownMenuItem = DropdownMenuCommandItem | DropdownMenuDividerItem;

interface DropdownMenuSchema {
 type: 'dropdown-menu';
 trigger: ComponentSchema; // Trigger component
 trigger: SchemaNode;  // Trigger component
 items: DropdownMenuItem[]; // Menu items

 // Styling
Expand Down

8 changes: 4 additions & 4 deletions
content/docs/components/overlay/hover-card.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,12 +14,12 @@ The Hover Card component displays rich content when hovering over an element.
```plaintext
interface HoverCardSchema {
 type: 'hover-card';
 trigger: ComponentSchema; // Trigger element
 content: ComponentSchema;  // Card content
 trigger: SchemaNode;  // Trigger element
 content: SchemaNode | SchemaNode[]; // Card content
 side?: 'top' | 'right' | 'bottom' | 'left';
 align?: 'start' | 'center' | 'end';
 openDelay?: number; // Delay before opening (ms)
 closeDelay?: number; // Delay before closing (ms)
 openDelay?: number; // Delay before opening (ms)
 closeDelay?: number; // Delay before closing (ms)
 className?: string;
}
```

8 changes: 4 additions & 4 deletions
content/docs/components/overlay/sheet.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,10 @@ The Sheet component displays content in a panel that slides in from the edge of
```plaintext
interface SheetSchema {
 type: 'sheet';
 trigger: ComponentSchema; // Trigger component
 title?: string; // Sheet title
 description?: string; // Sheet description
 content: ComponentSchema;  // Sheet content
 trigger: SchemaNode;  // Trigger component
 title?: string; // Sheet title
 description?: string; // Sheet description
 content: SchemaNode | SchemaNode[]; // Sheet content
 side?: 'left' | 'right' | 'top' | 'bottom';
 className?: string;
}
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
docs(components): name the overlay/feedback node slots at their declared type#7107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-warren
merged 1 commit into

from

Sep 1, 2026
 Merged


docs(components): name the overlay/feedback node slots at their declared type
#7107
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


73 changes: 73 additions & 0 deletions
.changeset/7082-overlay-node-slot-doc-type-names.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
---
---

Docs only, publishes nothing: six component pages spelled a node slot
`ComponentSchema`, a real shipped export (`packages/types/src/blocks.ts`) that
is **not** a node slot — it is the concrete `type: 'component'` block. The keys
carry `SchemaNode` (`packages/types/src/base.ts`), which also admits
`string | number | boolean | null | undefined`. A reader who looked the
published name up found a narrow, unrelated type.

Every row is re-derived from its own declaration on `2c3cd1b`, per page — not
by a string replace, because the declarations disagree with each other on
whether the array form is admitted.

| page row before | declaration on `main` | page after |
| --- | --- | --- |
| `AlertDialogSchema.trigger: ComponentSchema` | `trigger?: SchemaNode` (`overlay.ts:91`) | `SchemaNode` |
| `ContextMenuSchema.trigger?: ComponentSchema` | `trigger?: SchemaNode \| SchemaNode[]` (`overlay.ts:486`) | `SchemaNode \| SchemaNode[]` |
| `HoverCardSchema.trigger: ComponentSchema` | `trigger: SchemaNode` (`overlay.ts:296`) | `SchemaNode` |
| `HoverCardSchema.content: ComponentSchema` | `content: SchemaNode \| SchemaNode[]` (`overlay.ts:292`) | `SchemaNode \| SchemaNode[]` |
| `DropdownMenuSchema.trigger: ComponentSchema` | `trigger: SchemaNode` (`overlay.ts:433`) | `SchemaNode` |
| `SheetSchema.trigger: ComponentSchema` | `trigger?: SchemaNode` (`overlay.ts:150`) | `SchemaNode` |
| `SheetSchema.content: ComponentSchema` | `content?: SchemaNode \| SchemaNode[]` (`overlay.ts:146`) | `SchemaNode \| SchemaNode[]` |

**`dropdown-menu` stays singular on purpose.** Its Zod mirror
(`zod/overlay.zod.ts:176`), its sibling `ContextMenuSchema`, and its own shipped
`defaultProps` (`renderers/overlay/dropdown-menu.tsx:130`) all use the array
form, and the published TS type refuses it. Which side is right is objectui#7081,
open and awaiting a maintainer decision on a published-type widening. Publishing
the array form here would have put a claim in the docs that the shipped type
rejects and pre-empted that ruling; the page therefore follows the type an
author's editor reads. The incoherence is real, and it *is* #7081.

**Two of the nine rows the card named are NOT renamed**, because no honest
docs-only edit resolves them, and both are filed instead:

- `AlertDialogSchema.actions?: ComponentSchema[]` — declared on neither the TS
 interface (`overlay.ts:78-127`) nor the mirror (`zod/overlay.zod.ts:42-55`),
 and read by nothing. Renaming it would have kept a phantom key alive under a
 second wrong type.
- `EmptySchema.action?: ComponentSchema` — declared on neither
 (`feedback.ts:210-224`, `zod/feedback.zod.ts:120-125`), but *read* by the
 shipped renderer through a cast (`renderers/feedback/empty.tsx`), which
 requires `typeof === 'object'`. `SchemaNode` admits `string | number |
 boolean`, so publishing it there would have been a new false claim, not a
 correction.

Requiredness is likewise left alone and filed: `AlertDialogSchema.trigger`,
`SheetSchema.trigger` and `SheetSchema.content` are declared optional and
published required. That is objectui#7073's defect class, already fixed by it on
`context-menu.mdx`, and is out of this card's fence.

`packages/types/src/__tests__/overlay-node-slot-doc-types-7082.test.ts` pins the
result, and this is a page where the pin is the only evidence there is: all
these rows sit in `plaintext` fences, `check:doc-snippets` compiles
`ts`/`tsx`/`typescript` only and `check:doc-types` reads only the `type` string
literals, so no gate parses them (objectui#5250, objectui#5867). A green CI run
here says "nothing else broke", not "the correction is right".

The pin's authority is the **TS declaration**, not the Zod mirror — the one
deliberate departure from the objectui#6347 model, because on this tree the two
disagree on four `trigger` rows and pinning against the mirror would have
published #7081's answer. Its type-level leg is compiled by
`packages/types/tsconfig.test.json`, so widening `DropdownMenuSchema.trigger`
turns it red and whoever lands #7081 is told this page owes an update. The two
undeclared rows and the three requiredness divergences are pinned as
divergences, so a fix on either side of any of them also turns it red.

No fence moved: each page holds one `plaintext` fence marker pair before and
after, so objectui#5867's shrink-only declared population is unchanged. No
declaration, mirror, renderer or fixture was edited.

Part of objectui#7082.

2 changes: 1 addition & 1 deletion
content/docs/components/overlay/alert-dialog.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ interface AlertDialogSchema {
 description: string; // Dialog description

 // Trigger
 trigger: ComponentSchema; // Component that triggers the dialog
 trigger: SchemaNode;  // Component that triggers the dialog

 // Actions
 actions?: ComponentSchema[]; // Action buttons
Expand Down

4 changes: 2 additions & 2 deletions
content/docs/components/overlay/context-menu.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,8 @@ type ContextMenuItem = ContextMenuCommandItem | ContextMenuDividerItem;

interface ContextMenuSchema {
 type: 'context-menu';
 trigger?: ComponentSchema;  // Trigger element — a placeholder renders when absent
 items: ContextMenuItem[]; // Menu items
 trigger?: SchemaNode | SchemaNode[]; // Trigger element — a placeholder renders when absent
 items: ContextMenuItem[]; // Menu items
 className?: string;
}
```
Expand Down

2 changes: 1 addition & 1 deletion
content/docs/components/overlay/dropdown-menu.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ type DropdownMenuItem = DropdownMenuCommandItem | DropdownMenuDividerItem;

interface DropdownMenuSchema {
 type: 'dropdown-menu';
 trigger: ComponentSchema; // Trigger component
 trigger: SchemaNode;  // Trigger component
 items: DropdownMenuItem[]; // Menu items

 // Styling
Expand Down

8 changes: 4 additions & 4 deletions
content/docs/components/overlay/hover-card.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,12 +14,12 @@ The Hover Card component displays rich content when hovering over an element.
```plaintext
interface HoverCardSchema {
 type: 'hover-card';
 trigger: ComponentSchema; // Trigger element
 content: ComponentSchema;  // Card content
 trigger: SchemaNode;  // Trigger element
 content: SchemaNode | SchemaNode[]; // Card content
 side?: 'top' | 'right' | 'bottom' | 'left';
 align?: 'start' | 'center' | 'end';
 openDelay?: number; // Delay before opening (ms)
 closeDelay?: number; // Delay before closing (ms)
 openDelay?: number; // Delay before opening (ms)
 closeDelay?: number; // Delay before closing (ms)
 className?: string;
}
```

8 changes: 4 additions & 4 deletions
content/docs/components/overlay/sheet.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,10 @@ The Sheet component displays content in a panel that slides in from the edge of
```plaintext
interface SheetSchema {
 type: 'sheet';
 trigger: ComponentSchema; // Trigger component
 title?: string; // Sheet title
 description?: string; // Sheet description
 content: ComponentSchema;  // Sheet content
 trigger: SchemaNode;  // Trigger component
 title?: string; // Sheet title
 description?: string; // Sheet description
 content: SchemaNode | SchemaNode[]; // Sheet content
 side?: 'left' | 'right' | 'top' | 'bottom';
 className?: string;
}
Expand Down
Loading
Loading