Skip to content

docs(formulas): pin the raw predicate example to the object-field layer#11672

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

docs(formulas): pin the raw predicate example to the object-field layer #11672

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
24 changes: 19 additions & 5 deletions content/docs/data-modeling/formulas.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -272,12 +272,26 @@ Building the string by hand with `+` would also work, but CEL throws on

### Predicate (visibility, read-only, conditional required)

A conditional-rule predicate binds whatever its **layer** binds, and `visibleWhen`
is one key spelled on layers that do not share a scope — object field, per-option,
form-view field, page component, flow screen. So write the enclosing structure:
the `fields:` **map** below is what says *object field*, the layer on which a
predicate binds `record` (plus `previous`, and `parent` on a master-detail line
item) and nothing else. A bare `{ name, type, visibleWhen }` fragment names no
layer, so neither a reader nor `os build` can tell which scope it is written
against.

```ts
{
name: 'rating',
type: 'select',
visibleWhen: P`record.status == 'qualified'`,
}
ObjectSchema.create({
name: 'opportunity',
fields: {
// Raw (non-factory) spelling — the map key is the field name.
rating: {
type: 'select',
visibleWhen: P`record.status == 'qualified'`,
},
},
})

Field.text({
visibleWhen: P`record.type == 'business'`,
Expand Down
Loading