Skip to content

SectionModel

SectionModel = object

Defined in: packages/schema/src/model.ts:786

A titled group of fields on the record page; see The record page.

fields: string[]

Defined in: packages/schema/src/model.ts:792

The fields it shows, in order.


optional help?: string

Defined in: packages/schema/src/model.ts:794

A line under the title.


optional helpWhen?: HelpWhen

Defined in: packages/schema/src/model.ts:796

When help shows: always, or only while the record is edited; the view’s helpWhen when omitted.


kind: "section"

Defined in: packages/schema/src/model.ts:788

A titled group of fields in the main column, editable where the user may write.


optional presentation?: SectionPresentation

Defined in: packages/schema/src/model.ts:801

facts shows the read view’s fields as a row of key facts, each value under its field’s icon, instead of label/value rows; the form edits them as any section’s.


title: string

Defined in: packages/schema/src/model.ts:790

The section’s title.


optional when?: RecordWhen

Defined in: packages/schema/src/model.ts:803

Whether it shows on the form, the read view or both, or a condition on the saved record that it shows while it holds.