CustomSectionModel
CustomSectionModel =
object
Defined in: packages/schema/src/model.ts:717
A project component drawn on the record page where it is listed, in the main column or with sidebar in the
sidebar, under title when it has one. It gets props and reads the record with useLayoutRecord().
Properties
Section titled “Properties”component
Section titled “component”component:
string
Defined in: packages/schema/src/model.ts:721
The component’s name, as protobase.ui.tsx registers it.
kind:
"custom"
Defined in: packages/schema/src/model.ts:719
A custom section.
props?
Section titled “props?”
optionalprops?:Record<string,JsonValue>
Defined in: packages/schema/src/model.ts:725
The plain data the component gets, with field references where it takes a field.
sidebar?
Section titled “sidebar?”
optionalsidebar?:true
Defined in: packages/schema/src/model.ts:727
Drawn as a sidebar card instead of in the main column.
title?
Section titled “title?”
optionaltitle?:string
Defined in: packages/schema/src/model.ts:723
The title over it.
optionalwhen?:ShowWhen
Defined in: packages/schema/src/model.ts:729
Whether it shows on the form, the read view or both.