Skip to content

docs(plugin-view): README 的 13 个 schema 示例按 ObjectView 真读的键面重写#5101

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
yinlianghui merged 1 commit into from
Aug 18, 2026
Merged

docs(plugin-view): README 的 13 个 schema 示例按 ObjectView 真读的键面重写 #5101

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
40 changes: 40 additions & 0 deletions .changeset/plugin-view-readme-real-schema-keys.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
---
'@object-ui/plugin-view': patch
---

The plugin-view README now documents the keys `ObjectView` actually reads, so a
copied example renders instead of coming up empty.

Every untyped schema literal in the README was written against a key vocabulary
`ObjectViewSchema` does not declare and `ObjectView` does not read. The object
name was spelled `object` — the real key is `objectName`, and it is the only
required key besides `type` — so a copied example left the component with no
object to query. Three "view modes" were organized around a `viewMode` key that
exists nowhere, and `fields`, `mode`, `recordId`, `fieldConfig`, `nestedFields`,
`tabs`, `searchable`, `sortable`, `filters` and `enableDelete` were documented
the same way. None of it failed loudly: `ObjectViewSchema` extends a base schema
carrying a `[key: string]: any` index signature, so excess-property checking is
defeated on this type, and the blocks carried no type annotation to trip even
the one assertion that does bite.

The thirteen affected blocks are rewritten against the declared surface, each
one measured against the renderer before being written: `defaultViewType` (plus
`listViews` / `defaultListView`) for the list type, `layout` with its
drawer/modal/page record surface for what the README called form and detail
views, `table` and `form` for grid and form configuration, `operations`
booleans and `onNavigate` in place of the `onCreate` / `onUpdate` / `onDelete` /
`onSubmit` callbacks that were never part of this contract, and the `show*`
toolbar toggles. Examples now carry `ObjectViewSchema` annotations, which makes
a missing `objectName` a compile error in all fifteen of them.

Three structural facts are stated outright rather than left to be inferred:
`dataSource` is a required prop of `ObjectViewProps` and not a schema key, so
putting it in the schema does nothing; create/edit/read are internal states of
one record surface rather than authored modes, which is why `ObjectViewSchema`
omits `mode` from its `form` block; and `ObjectView` forwards a fixed list of
keys out of `table` and `form` rather than passing those objects through, so the
README now names exactly which ones — including that page size is `table.pageSize`
on this path, the spelling the component forwards.

The `ViewSwitcher`, `FilterUI` and `SortUI` sections are untouched: their keys
were checked against the registered `inputs` and already matched.
Loading