Skip to content

docs(plugins): qualify FormField to the copy plugin-form.mdx describes#6185

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

docs(plugins): qualify FormField to the copy plugin-form.mdx describes #6185

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
13 changes: 8 additions & 5 deletions content/docs/plugins/plugin-form.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,11 +48,14 @@ npm install @object-ui/plugin-form

### Form Field

`FormField` is declared once, in `@object-ui/types`
(`packages/types/src/form.ts`) — this page does not redeclare it, because a
locally written `interface` compiles no matter how far it has drifted from the
real one. It has **23 declared keys**, and `name` is the only **required** one:
`type` and `label` are both optional.
`FormField` here means the one declared by `@object-ui/types`
(`packages/types/src/form.ts`) — `@objectstack/spec` ships its own copy of this
name (`json-schema/ui/FormField.json`) with a different key set, so read this
table against the `@object-ui/types` copy rather than the same-named schema in
the spec. This page does not redeclare it, because a locally written
`interface` compiles no matter how far it has drifted from the real one. It
has **23 declared keys**, and `name` is the only **required** one: `type` and
`label` are both optional.

| Key | Type | What it does |
| --- | --- | --- |
Expand Down