Skip to content

docs(skill): 补充自动状态进度条 & detail.stageField:false 开关 #2453

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

Closed
baozhoutao wants to merge 1 commit into from
Closed

docs(skill): 补充自动状态进度条 & detail.stageField:false 开关 #2453

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
29 changes: 29 additions & 0 deletions skills/objectstack-ui/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -709,6 +709,35 @@ export const LeadDetailPage = definePage({
});
```

> **Auto-synthesized detail pages & the status path.** When an object has **no
> authored record page**, ObjectUI synthesizes a default detail page and
> auto-detects a status field to drive a top `record:path` stepper. The stage
> hint lives in the object def's `detail` block (`object.zod.ts` — a
> `.passthrough()` block documented as "Detail-page UI hints consumed by
> @object-ui/plugin-detail synth"). Detection precedence (`detectStatusField`):
> (0) `detail.stageField === false | null` → explicit opt-out, no path;
> (1) `detail.stageField` is a field name → use it; (2) else first field named
> `status` / `stage` / `state` / `phase`; (3) else first field whose `type` is
> `status` / `stage`; (4) else no path.
>
> **Opt out with `detail: { stageField: false }`.** Many objects carry a
> `status` *select* that is a **non-linear** picklist (e.g. 正常 / 暂停 / 作废),
> not an ordered pipeline — rendering it as an ordered stepper is wrong:
>
> ```typescript
> ObjectSchema.create({
> name: 'production_plan',
> detail: { stageField: false }, // suppress the auto status path
> fields: { status: Field.select({ options: [...] }) /* … */ },
> });
> ```
>
> **Put it under `detail`, not top-level.** `ObjectSchema.create()` rejects
> unknown *top-level* keys (a bare `stageField:` fails to compile and is rejected
> at build). The `detail` block is `.passthrough()`, so author-facing synth hints
> like `stageField` belong there. Use `detail: { stageField: 'my_field' }` to
> pick which field drives the path.

> **Variable substitution** — `{first_name}`, `{current_user.first_name}`,
> `{current_quarter_start}` etc. resolve from the page's `variables` block,
> the bound record, and the runtime context. Declare `variables: [...]` at
Expand Down