App: views
Everything a visitor can open: lists, dashboards, forms and the rest, keyed by address. Preview keys work and may change in any release (status); the rest are stable. All parts.
views: { triage: listView('Triage', 'issue', { query: 'status = backlog or status = ready', show: ['name', 'status', 'priority', 'assignee_id.name'], presentation: queue('name', { lines: ['status', 'priority'] }), filters: ['priority', 'assignee_id'], }), pipeline: listView('Pipeline', 'opportunity', { board: { by: 'stage', primary: 'name' } }),},The key is the view’s address: lowercase letters, digits and hyphens. Every
dashboard and signed-in form must be reachable from nav, home or an embed,
or it is refused as an orphan. A list’s query holds conditions only; its
order is sort, and a tab takes a sort of its own. Query strings are typed
where the App’s schema is registered (the limit).
filters and totals may name a rollup or computed column as they name a
column: filters: ['state', 'spent'] offers a customer’s lifetime spend as a
Min and a Max.
kind |
Helper | What it is |
|---|---|---|
list |
listView(label, table, opts) or listView(table, opts) |
The rows of one resource. Lists |
dashboard |
dashboard(label, sections, opts) |
Sections about whole tables. Dashboards |
landing |
landing(hero, sections, opts) |
The signed-out front page. Public pages |
form |
commandForm(label, command, steps, opts) |
One form over one command. Command forms |
room |
room(label, component, { reads, params }) |
A whole view drawn by a custom component. |
How a list’s rows draw
Section titled “How a list’s rows draw”A view says at most one of presentation, board and split; with none, the
rows are a grid.
| Spelling | Draws |
|---|---|
checklist(primary, checked, { lines? }) |
A card per row with a checkbox. |
queue(primary, { lines?, facts?, badge?, openLabel? }) |
A keyboard-first selection list; bulk actions apply to the selection. |
board: { by, lanes?, order?, swimlanes?, limits?, primary, lines?, sum?, folded? } |
Lanes by one column; cards move by drag, Alt+arrows or ⋯. limits are shown, never enforced. A lane’s head adds up sum (else the card’s money) — “Discovery · 3 · $92.8K” — and folded: ['won', 'lost'] draws closed stages as strips a reader opens. A reference as primary, a line or a footer fact says the record it names: primary: 'sales_order_id'. |
split: { detail?, limit? } |
The list beside the picked record, addressed /inbox/2. |
calendar(date, primary, { end?, lines?, badge? }) |
A month grid; with end, a bar across the days. |
cards(primary, { value?, badge?, icon?, description?, lines?, facts?, image?, media? }) |
A grid of cards; a page’s related list takes the same. |
customList(component, { show }) |
Rows drawn by a custom component. |
Dashboard sections
Section titled “Dashboard sections”| Helper | Says |
|---|---|
metric(title, table, { measure?, query?, compare?, target?, to? }) |
One figure; compare: 'previous period' adds a change. |
chart(title, table, by, { shape?, measure? }) |
line (default), bar, donut, stacked. |
breakdown(title, table, by, { measure?, limit? }) |
Groups as bars, a vocabulary’s in its order. |
matrix(title, table, 'stage, month close_date', opts) |
Two keys as rows and columns. |
rows(title, table, { show, sort?, limit? }) |
Matching rows. |
board(title, table, by, { lanes?, primary?, lines? }) |
Lanes, full width. |
note(text, opts), firstRun(title, steps), activity(title, resources) |
Guidance, a welcome until the tables have rows, recent changes. |
embed(view, { tab?, limit?, interactive? }) |
A list view inside the dashboard. |
Every table section also takes query, over (the date column the window
narrows), windows, icon, title and width (full, two-thirds,
half, third; with a dashboard’s areas, an area instead). A measure is count, sum amount, avg, min, max,
median (PostgreSQL) or arithmetic over them (sum won / sum amount as rate).
| Key | Type | Status | What it does |
|---|---|---|---|
views |
object | Stable | Everything a visitor can open, keyed: the key is the view’s address. Used in examples/apps/tick/app.ts. |
views.*[kind=dashboard].areas
Section titled “views.*[kind=dashboard].areas”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].areas |
array | Stable | The sections placed on a grid: one string per row, the same count of 1 to 4 space-separated cells in each, a cell an area name or . for none. A section names its area; an area that covers two rows spans them, several sections in one area stack, and a narrow screen stacks the areas in reading order. Every section names an area, and areas are not written with an aside. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].aside
Section titled “views.*[kind=dashboard].aside”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].aside |
array | Stable | Sections in an independent context column beside the dashboard’s main flow, drawn as a record page’s aside: a landmark of its own, its lists drawn as names, the main flow’s rows by width beside it and neither column’s height waiting on the other’s. A section whose height lines up with the ones beside it is placed with areas instead; a dashboard says one or the other. |
views.*[kind=dashboard].aside[]
Section titled “views.*[kind=dashboard].aside[]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].aside[] |
Stable | The same keys as views.*[kind=dashboard].sections[]. |
views.*[kind=dashboard].description
Section titled “views.*[kind=dashboard].description”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].description |
string | Stable | Short plain text shown beneath the dashboard heading. It may greet {me.name}; with no name it is left out. Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].favorite
Section titled “views.*[kind=dashboard].favorite”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].favorite |
boolean | Stable | Opt-in: a star on the view, so a reader can keep it in Favorites. |
views.*[kind=dashboard].filters
Section titled “views.*[kind=dashboard].filters”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].filters |
array | Stable | Pick-filters: column names offered as selectors in the control row. A pick narrows every section whose table has the column; a vocabulary column offers its values, a whole single-column reference offers the records it points at, by name. Used in examples/apps/lintel/views.ts. |
views.*[kind=dashboard].from
Section titled “views.*[kind=dashboard].from”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].from |
string | Stable | Default resource for sections that name none; a section’s own from wins. Refused when every section names its own. Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].heading
Section titled “views.*[kind=dashboard].heading”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].heading |
string | Stable | false draws the dashboard without its title (it stays for a screen reader). Otherwise the words over the sections when they are not the label (which the menu and the tab keep): “Hello, {me.name}”. {me.name} is the signed-in reader’s name, said by the server; with none, the label is drawn. Needs auth. One of false. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=dashboard].icon
Section titled “views.*[kind=dashboard].icon”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].icon |
"house" · "tray" · "list" · "list-checks" · "kanban" · "table" · "calendar" · "calendar-check" · "clock" · "chart-bar" · "chart-line" · "chart-pie" · "gauge" · "target" · "flag" · "user" · "users" · "user-circle" · "address-book" · "handshake" · "buildings" · "storefront" · "briefcase" · "package" · "truck" · "car" · "shopping-cart" · "receipt" · "currency-dollar" · "credit-card" · "wallet" · "bank" · "file" · "file-text" · "folder" · "clipboard-text" · "note" · "archive" · "tag" · "ticket" · "star" · "bookmark-simple" · "bell" · "envelope" · "chat-circle" · "phone" · "headset" · "megaphone" · "globe" · "map-pin" · "magnifying-glass" · "gear" · "sliders" · "wrench" · "bug" · "shield-check" · "lock" · "key" · "database" · "stack" · "lightning" · "check-circle" · "warning" · "info" · "cell-signal-low" · "cell-signal-medium" · "cell-signal-high" · "cell-signal-full" · "fire" · "hourglass" · "circle-dashed" · "x-circle" · "plus-circle" · "pencil-simple" · "paper-plane-tilt" · "arrows-left-right" · "arrow-circle-down" · "arrow-circle-up" · "laptop" · "monitor" · "device-mobile" · "printer" · "stethoscope" · "heartbeat" · "heart" · "pill" · "syringe" · "first-aid-kit" · "thermometer" · "flask" · "test-tube" · "microscope" · "bed" · "hospital" · "ambulance" · "tooth" · "eyeglasses" · "wheelchair" · "baby" · "dna" · "brain" · "bandaids" · "hand-heart" · "graduation-cap" · "book-open" · "student" · "chalkboard-teacher" · "factory" · "warehouse" · "house-line" · "plant" · "leaf" · "sun" · "cloud" · "drop" · "airplane" · "bicycle" · "bus" · "train" · "boat" · "hammer" · "toolbox" · "plug" · "lightbulb" · "cube" · "camera" · "image" · "trophy" · "gift" · "coffee" · "fork-knife" · "shopping-bag" · "basket" · "barcode" · "qr-code" · "scales" · "gavel" · "certificate" · "identification-card" · "fingerprint" · "eye" · "link" · "paperclip" · "scissors" · "palette" · "code" · "terminal" · "users-three" · "user-plus" |
Stable | The menu’s mark for this dashboard. One of <appIcon>. Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].kind
Section titled “views.*[kind=dashboard].kind”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].kind |
Stable | One of dashboard. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=dashboard].label
Section titled “views.*[kind=dashboard].label”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].label |
string | Stable |
views.*[kind=dashboard].path
Section titled “views.*[kind=dashboard].path”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].path |
string | Stable | Its address after the App’s (/{app}/{path}?period=…), when not its key. |
views.*[kind=dashboard].realm
Section titled “views.*[kind=dashboard].realm”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].realm |
"tenant" · "platform" |
Stable | The realm it belongs to: a tenant’s (the default) or the platform realm’s, which needs auth.tenancy.platform. One of platform, tenant. |
views.*[kind=dashboard].refresh
Section titled “views.*[kind=dashboard].refresh”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].refresh |
string | Stable | Re-render the screen this often while visible, ‘30 seconds’ (at least 5 seconds). |
views.*[kind=dashboard].roles
Section titled “views.*[kind=dashboard].roles”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].roles |
array | Stable | The roles that may open it: a signed-in reader holding none of them is not served it (not in the menu, ⌘K or search, and its address answers as one that does not exist). Table grants still apply; this only narrows. Each must be declared in auth.roles. |
views.*[kind=dashboard].sections
Section titled “views.*[kind=dashboard].sections”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].sections |
array | Stable |
views.*[kind=dashboard].sections[][kind=*]
Section titled “views.*[kind=dashboard].sections[][kind=*]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].sections[][kind=*].area |
string | Stable | The area of the dashboard’s areas this section is placed in. Sections in one area stack in source order. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=*].from |
string | Stable | The table the section reads. Absent means the dashboard-level table. Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].sections[][kind=*].icon |
"house" · "tray" · "list" · "list-checks" · "kanban" · "table" · "calendar" · "calendar-check" · "clock" · "chart-bar" · "chart-line" · "chart-pie" · "gauge" · "target" · "flag" · "user" · "users" · "user-circle" · "address-book" · "handshake" · "buildings" · "storefront" · "briefcase" · "package" · "truck" · "car" · "shopping-cart" · "receipt" · "currency-dollar" · "credit-card" · "wallet" · "bank" · "file" · "file-text" · "folder" · "clipboard-text" · "note" · "archive" · "tag" · "ticket" · "star" · "bookmark-simple" · "bell" · "envelope" · "chat-circle" · "phone" · "headset" · "megaphone" · "globe" · "map-pin" · "magnifying-glass" · "gear" · "sliders" · "wrench" · "bug" · "shield-check" · "lock" · "key" · "database" · "stack" · "lightning" · "check-circle" · "warning" · "info" · "cell-signal-low" · "cell-signal-medium" · "cell-signal-high" · "cell-signal-full" · "fire" · "hourglass" · "circle-dashed" · "x-circle" · "plus-circle" · "pencil-simple" · "paper-plane-tilt" · "arrows-left-right" · "arrow-circle-down" · "arrow-circle-up" · "laptop" · "monitor" · "device-mobile" · "printer" · "stethoscope" · "heartbeat" · "heart" · "pill" · "syringe" · "first-aid-kit" · "thermometer" · "flask" · "test-tube" · "microscope" · "bed" · "hospital" · "ambulance" · "tooth" · "eyeglasses" · "wheelchair" · "baby" · "dna" · "brain" · "bandaids" · "hand-heart" · "graduation-cap" · "book-open" · "student" · "chalkboard-teacher" · "factory" · "warehouse" · "house-line" · "plant" · "leaf" · "sun" · "cloud" · "drop" · "airplane" · "bicycle" · "bus" · "train" · "boat" · "hammer" · "toolbox" · "plug" · "lightbulb" · "cube" · "camera" · "image" · "trophy" · "gift" · "coffee" · "fork-knife" · "shopping-bag" · "basket" · "barcode" · "qr-code" · "scales" · "gavel" · "certificate" · "identification-card" · "fingerprint" · "eye" · "link" · "paperclip" · "scissors" · "palette" · "code" · "terminal" · "users-three" · "user-plus" |
Stable | A curated mark in the section’s heading row. One of <appIcon>. Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].sections[][kind=*].over |
string | Stable | The date column the dashboard’s time window narrows this section by, stored or computed. Absent means the window passes this section over. Used in examples/apps/lintel/commands/ledger.ts. |
views.*[kind=dashboard].sections[][kind=*].query |
string | Stable | The query language, without the leading table name. |
views.*[kind=dashboard].sections[][kind=*].segment |
string | Stable | One of the table’s segments (resources.<table>.segments), its conditions ANDed with query. Used in examples/apps/tick/app.ts. |
views.*[kind=dashboard].sections[][kind=*].title |
string | Stable | |
views.*[kind=dashboard].sections[][kind=*].width |
"full" · "two-thirds" · "half" · "third" |
Stable | One of full, half, third, two-thirds. Used in examples/apps/tick/app.ts. |
views.*[kind=dashboard].sections[][kind=*].windows |
array | Stable | The section’s own time windows, in the query grammar’s words (“last 7 days”): the reader picks this section’s period in its heading, apart from the dashboard’s window, and the first is where it starts. Needs “over”. Named in the address by the section’s title: ?period.lines-moved-by-day=last-7-days. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=activity]
Section titled “views.*[kind=dashboard].sections[][kind=activity]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].sections[][kind=activity].kind |
Stable | One of activity. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=dashboard].sections[][kind=activity].limit |
integer | Stable | Changes drawn before “Show more”. Default 8. |
views.*[kind=dashboard].sections[][kind=activity].resources |
object | Stable | The resources whose changes the feed lists, each with its mark and its word in the feed where not its noun: { pick_list: { icon: ‘truck’ } }. Used in examples/apps/tick/app.ts. |
views.*[kind=dashboard].sections[][kind=activity].resources.*.icon |
"house" · "tray" · "list" · "list-checks" · "kanban" · "table" · "calendar" · "calendar-check" · "clock" · "chart-bar" · "chart-line" · "chart-pie" · "gauge" · "target" · "flag" · "user" · "users" · "user-circle" · "address-book" · "handshake" · "buildings" · "storefront" · "briefcase" · "package" · "truck" · "car" · "shopping-cart" · "receipt" · "currency-dollar" · "credit-card" · "wallet" · "bank" · "file" · "file-text" · "folder" · "clipboard-text" · "note" · "archive" · "tag" · "ticket" · "star" · "bookmark-simple" · "bell" · "envelope" · "chat-circle" · "phone" · "headset" · "megaphone" · "globe" · "map-pin" · "magnifying-glass" · "gear" · "sliders" · "wrench" · "bug" · "shield-check" · "lock" · "key" · "database" · "stack" · "lightning" · "check-circle" · "warning" · "info" · "cell-signal-low" · "cell-signal-medium" · "cell-signal-high" · "cell-signal-full" · "fire" · "hourglass" · "circle-dashed" · "x-circle" · "plus-circle" · "pencil-simple" · "paper-plane-tilt" · "arrows-left-right" · "arrow-circle-down" · "arrow-circle-up" · "laptop" · "monitor" · "device-mobile" · "printer" · "stethoscope" · "heartbeat" · "heart" · "pill" · "syringe" · "first-aid-kit" · "thermometer" · "flask" · "test-tube" · "microscope" · "bed" · "hospital" · "ambulance" · "tooth" · "eyeglasses" · "wheelchair" · "baby" · "dna" · "brain" · "bandaids" · "hand-heart" · "graduation-cap" · "book-open" · "student" · "chalkboard-teacher" · "factory" · "warehouse" · "house-line" · "plant" · "leaf" · "sun" · "cloud" · "drop" · "airplane" · "bicycle" · "bus" · "train" · "boat" · "hammer" · "toolbox" · "plug" · "lightbulb" · "cube" · "camera" · "image" · "trophy" · "gift" · "coffee" · "fork-knife" · "shopping-bag" · "basket" · "barcode" · "qr-code" · "scales" · "gavel" · "certificate" · "identification-card" · "fingerprint" · "eye" · "link" · "paperclip" · "scissors" · "palette" · "code" · "terminal" · "users-three" · "user-plus" |
Stable | The mark each of its changes wears. One of <appIcon>. Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].sections[][kind=activity].resources.*.label |
string | Stable | Its word in the feed, when not the resource’s noun. |
views.*[kind=dashboard].sections[][kind=board]
Section titled “views.*[kind=dashboard].sections[][kind=board]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].sections[][kind=board].by |
string | Stable | The bare column of the table whose values are its lanes. Used in examples/apps/lintel/commands/maintenance.ts. |
views.*[kind=dashboard].sections[][kind=board].empty |
Stable | hide leaves the board out of the dashboard while it has nothing to draw. One of hide. Used in examples/apps/lintel/pages/maintenance_request.ts. |
|
views.*[kind=dashboard].sections[][kind=board].kind |
Stable | One of board. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=dashboard].sections[][kind=board].lanes |
array | Stable | |
views.*[kind=dashboard].sections[][kind=board].limit |
integer | Stable | |
views.*[kind=dashboard].sections[][kind=board].lines |
array | Stable | Lines beneath the primary, label paths welcome. Needs primary. Used in examples/apps/tick/app.ts. |
views.*[kind=dashboard].sections[][kind=board].primary |
string | Stable | The card’s first line, a column or label path. Absent: the table’s label column, alone. Used in examples/apps/lintel/views.ts. |
views.*[kind=dashboard].sections[][kind=board].sort |
string | Stable | Written like the query bar. |
views.*[kind=dashboard].sections[][kind=branding]
Section titled “views.*[kind=dashboard].sections[][kind=branding]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].sections[][kind=branding].kind |
Stable | One of branding. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=dashboard].sections[][kind=breakdown]
Section titled “views.*[kind=dashboard].sections[][kind=breakdown]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].sections[][kind=breakdown].by |
string | Stable | What to group by — “status”, or “month opened_on”. Used in examples/apps/lintel/commands/maintenance.ts. |
views.*[kind=dashboard].sections[][kind=breakdown].empty |
Stable | hide leaves the section out of the dashboard while it has nothing to draw. One of hide. Used in examples/apps/lintel/pages/maintenance_request.ts. |
|
views.*[kind=dashboard].sections[][kind=breakdown].format |
"percent" · "number" · "money" · "duration" |
Stable | How each figure is said where its measure is not one column’s, as a metric’s: percent (the figure is 0–100, said with %), number, money in the App’s currency, or duration (the figure is seconds, said as “10h 2m”). One of duration, money, number, percent. Used in examples/apps/lintel/resources.ts. |
views.*[kind=dashboard].sections[][kind=breakdown].kind |
Stable | One of breakdown. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=dashboard].sections[][kind=breakdown].limit |
integer | Stable | |
views.*[kind=dashboard].sections[][kind=breakdown].measure |
string | Stable | “count” (default), “sum amount as pipeline”. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=breakdown].notes |
object | Stable | Steps: a line under a step, by the value it counts. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=breakdown].shape |
"bars" · "steps" |
Stable | bars (default): a row per group. steps: a card per value of one column, in its order, joined by arrows. One of bars, steps. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=dashboard].sections[][kind=breakdown].target |
object | Stable | A goal per group, read from another table: each bar is the share of its group’s goal reached, full at the goal, and says it (“60% of $20,000 target”); a group with a goal and nothing measured is at 0%. Used in examples/apps/lintel/commands/leasing.ts. |
views.*[kind=dashboard].sections[][kind=breakdown].target.by |
string | Stable | The goal table’s column whose value matches each group’s key: a quota’s owner. Used in examples/apps/lintel/commands/maintenance.ts. |
views.*[kind=dashboard].sections[][kind=breakdown].target.from |
string | Stable | The resource the goals are read from. Absent means the section’s. Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].sections[][kind=breakdown].target.measure |
string | Stable | The goal’s measure. Absent means the section’s. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=breakdown].target.over |
string | Stable | The goal table’s date column the reader’s window narrows, as the section’s over. Used in examples/apps/lintel/commands/ledger.ts. |
views.*[kind=dashboard].sections[][kind=breakdown].target.query |
string | Stable | The query language, without the leading table name. |
views.*[kind=dashboard].sections[][kind=breakdown].to |
string | Stable | The list view each group opens, narrowed to the group; false keeps the groups text. Absent, the one list view over the table that the reader is served. One of false. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=breakdown].unit |
string | Stable | A word said after each figure (“days”, “/mo”). Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].sections[][kind=chart]
Section titled “views.*[kind=dashboard].sections[][kind=chart]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].sections[][kind=chart].by |
string | Stable | What to group by — a bucketed by (“month opened_on”) for a line, categories for a donut. “auto created_at” picks the unit (day, week, month or quarter) from the window the reader has picked and how the data falls, and says it under the title. Used in examples/apps/lintel/commands/maintenance.ts. |
views.*[kind=dashboard].sections[][kind=chart].curve |
"smooth" · "straight" |
Stable | A line’s curve: smooth draws a monotone curve through the points. One of smooth, straight. |
views.*[kind=dashboard].sections[][kind=chart].empty |
Stable | hide leaves the section out of the dashboard while it has nothing to draw. One of hide. Used in examples/apps/lintel/pages/maintenance_request.ts. |
|
views.*[kind=dashboard].sections[][kind=chart].format |
"percent" · "number" · "money" · "duration" |
Stable | How each figure is said where its measure is not one column’s, as a metric’s: percent (the figure is 0–100, said with %), number, money in the App’s currency, or duration (the figure is seconds, said as “10h 2m”). One of duration, money, number, percent. Used in examples/apps/lintel/resources.ts. |
views.*[kind=dashboard].sections[][kind=chart].height |
number | Stable | The drawing’s height in CSS pixels. Absent means a third of the width, capped. |
views.*[kind=dashboard].sections[][kind=chart].kind |
Stable | One of chart. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=dashboard].sections[][kind=chart].limit |
integer | Stable | |
views.*[kind=dashboard].sections[][kind=chart].measure |
string | Stable | “count” (default), “sum amount as pipeline”. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=chart].shape |
"line" · "bar" · "donut" · "stacked" · "scatter" · "heatmap" · "waterfall" · "treemap" |
Stable | How it draws. A line wants a bucketed by; bars, a bucketed by or categories, one series with the current bar marked; a donut, categories; stacked, a two-key by — a bar for each group of the first key, divided by the second. Further shapes: scatter (one key, x across and measure up), heatmap (a two-key by as shaded cells), waterfall (one key’s rises and falls to a total), treemap (one key’s groups as tiles by size). Default line. One of bar, donut, heatmap, line, scatter, stacked, treemap, waterfall. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=dashboard].sections[][kind=chart].target |
number | Stable | A goal drawn as a rule in the ink on a line or stacked chart, and said beside it; not on a donut. Used in examples/apps/lintel/commands/leasing.ts. |
views.*[kind=dashboard].sections[][kind=chart].to |
string | Stable | The list view each group opens, narrowed to the group; false keeps the groups text. Absent, the one list view over the table that the reader is served. One of false. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=chart].total |
string | Stable | A donut’s words for the figure in its middle, said under it. |
views.*[kind=dashboard].sections[][kind=chart].unit |
string | Stable | A word said after each figure (“days”, “/mo”). Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].sections[][kind=chart].x |
string | Stable | A scatter’s across measure (“sum amount”); measure is its up one. Only on a scatter, which needs it. |
views.*[kind=dashboard].sections[][kind=custom]
Section titled “views.*[kind=dashboard].sections[][kind=custom]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].sections[][kind=custom].component |
object | Stable | An author’s own React module, referenced by path — component(‘id’, { module }) — and placed through a declared kind: a custom section, a value renderer where a display rule stands, an input where a form draws a field, a list view’s rows (customList) or a free-form page (definePage, in pages/<path>.page.tsx). One of <component>. |
views.*[kind=dashboard].sections[][kind=custom].figures |
object | Stable | Named aggregate reads, at most eight; the component receives each as figures.<name>: exact over every row the reader may see, a number with no by, a group for each value with one. |
views.*[kind=dashboard].sections[][kind=custom].figures.*.by |
string | Stable | Group the figure: a column, a path or a period and a date column (status, month opened_on). Used in examples/apps/lintel/commands/maintenance.ts. |
views.*[kind=dashboard].sections[][kind=custom].figures.*.from |
string | Stable | The resource it measures. Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].sections[][kind=custom].figures.*.limit |
integer | Stable | With a by, the most groups returned. Default 100. |
views.*[kind=dashboard].sections[][kind=custom].figures.*.measure |
string | Stable | count, or an aggregate and a column: sum amount, avg amount, min due_on, max due_on. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=custom].figures.*.over |
string | Stable | The date column the dashboard’s time window narrows this figure by. Used in examples/apps/lintel/commands/ledger.ts. |
views.*[kind=dashboard].sections[][kind=custom].figures.*.query |
string | Stable | The query language, without the leading table name. |
views.*[kind=dashboard].sections[][kind=custom].kind |
Stable | One of custom. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=dashboard].sections[][kind=custom].props |
object | Stable | The component’s declared props; each checked against its declaration, defaults filled. |
views.*[kind=dashboard].sections[][kind=custom].rows |
object | Stable | Named reads of rows, at most eight; the component receives each as rows.<name>. Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].sections[][kind=custom].rows.*.from |
string | Stable | The resource its rows come from. Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].sections[][kind=custom].rows.*.limit |
integer | Stable | |
views.*[kind=dashboard].sections[][kind=custom].rows.*.over |
string | Stable | The date column the dashboard’s time window narrows this read by. Used in examples/apps/lintel/commands/ledger.ts. |
views.*[kind=dashboard].sections[][kind=custom].rows.*.query |
string | Stable | The query language, without the leading table name. |
views.*[kind=dashboard].sections[][kind=custom].rows.*.show |
array | Stable | The columns the component reads, label paths welcome; each row carries exactly these. |
views.*[kind=dashboard].sections[][kind=custom].rows.*.sort |
string | Stable | Written like the query bar. |
views.*[kind=dashboard].sections[][kind=find]
Section titled “views.*[kind=dashboard].sections[][kind=find]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].sections[][kind=find].kind |
Stable | One of find. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=dashboard].sections[][kind=find].placeholder |
string | Stable | The box’s words before anything is typed. |
views.*[kind=dashboard].sections[][kind=find].resources |
array | Stable | The resources whose records it finds: [‘article’, ‘catalog_item’]. Used in examples/apps/tick/app.ts. |
views.*[kind=dashboard].sections[][kind=firstRun]
Section titled “views.*[kind=dashboard].sections[][kind=firstRun]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].sections[][kind=firstRun].description |
string | Stable | A sentence under the title. Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].sections[][kind=firstRun].kind |
Stable | One of firstRun. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=dashboard].sections[][kind=firstRun].steps |
array | Stable | |
views.*[kind=dashboard].sections[][kind=firstRun].steps[].description |
string | Stable | A line under the title. Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].sections[][kind=firstRun].steps[].title |
string | Stable | The next action: “Add your first customer”. |
views.*[kind=dashboard].sections[][kind=firstRun].steps[].to |
string | Stable | A list view’s key; the step is done once its table has a row. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=funnel]
Section titled “views.*[kind=dashboard].sections[][kind=funnel]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].sections[][kind=funnel].empty |
Stable | hide leaves the section out of the dashboard while it has nothing to draw. One of hide. Used in examples/apps/lintel/pages/maintenance_request.ts. |
|
views.*[kind=dashboard].sections[][kind=funnel].kind |
Stable | One of funnel. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=dashboard].sections[][kind=funnel].stages |
array | Stable | The stages a row passes in order. A row reaches a stage when it holds the section’s query, every required stage before it and the stage’s own conditions; an optional stage is a side road, counted against the stage before it and not required by the ones after. |
views.*[kind=dashboard].sections[][kind=funnel].stages[].label |
string | object | Stable | The stage as a reader says it (“Submitted”), or a message of the App’s catalogs. Each stage’s label is its own. |
views.*[kind=dashboard].sections[][kind=funnel].stages[].label.args |
object | Stable | Each ICU argument’s column path: { “title”: “thread_id.title” }. |
views.*[kind=dashboard].sections[][kind=funnel].stages[].label.message |
string | Stable | Used in examples/apps/lintel/commands/leasing.ts. |
views.*[kind=dashboard].sections[][kind=funnel].stages[].optional |
Stable | A side road: not required by the stages after it. Never the first stage. One of true. Used in examples/apps/lintel/commands/ledger.ts. |
|
views.*[kind=dashboard].sections[][kind=funnel].stages[].query |
string | Stable | Conditions only, in the query grammar. Absent, every row the funnel holds. |
views.*[kind=dashboard].sections[][kind=funnel].to |
string | Stable | The list view each stage opens, narrowed to the rows that reached it; false keeps the stages text. Absent, the one list view over the table that the reader is served. One of false. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=integrations]
Section titled “views.*[kind=dashboard].sections[][kind=integrations]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].sections[][kind=integrations].kind |
Stable | One of integrations. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=dashboard].sections[][kind=matrix]
Section titled “views.*[kind=dashboard].sections[][kind=matrix]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].sections[][kind=matrix].by |
string | Stable | Two keys — “stage, month close_date”: rows by the first, columns by the second. Used in examples/apps/lintel/commands/maintenance.ts. |
views.*[kind=dashboard].sections[][kind=matrix].empty |
Stable | hide leaves the section out of the dashboard while it has nothing to draw. One of hide. Used in examples/apps/lintel/pages/maintenance_request.ts. |
|
views.*[kind=dashboard].sections[][kind=matrix].format |
"percent" · "number" · "money" · "duration" |
Stable | How each figure is said where its measure is not one column’s, as a metric’s: percent (the figure is 0–100, said with %), number, money in the App’s currency, or duration (the figure is seconds, said as “10h 2m”). One of duration, money, number, percent. Used in examples/apps/lintel/resources.ts. |
views.*[kind=dashboard].sections[][kind=matrix].kind |
Stable | One of matrix. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=dashboard].sections[][kind=matrix].measure |
string | Stable | “count” (default), “sum amount as pipeline”. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=matrix].to |
string | Stable | The list view each group opens, narrowed to the group; false keeps the groups text. Absent, the one list view over the table that the reader is served. One of false. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=matrix].unit |
string | Stable | A word said after each figure (“days”, “/mo”). Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].sections[][kind=metric]
Section titled “views.*[kind=dashboard].sections[][kind=metric]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].sections[][kind=metric].better |
"up" · "down" |
Stable | Which way is good news, so the delta wears good/bad. Absent means neutral. Without “compare” or “over” there is no delta to color. One of down, up. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=metric].compare |
string | Stable | A second query for the same measure; the card shows the delta. The phrase “previous period” derives it from the query’s one “last N days/weeks/months/years” window; with no window in the query and an “over”, it is the period before the window the reader picks. Unsaid on a metric with an “over”, it is “previous period”; with neither an “over” nor a window in the query, “previous period” is refused. |
views.*[kind=dashboard].sections[][kind=metric].format |
"percent" · "number" · "money" · "duration" |
Stable | metric: how the figure is said where its measure is not one column’s: percent (the figure is 0–100, said with %), number, money in the App’s currency, or duration (the figure is seconds, said as “10h 2m”). One of duration, money, number, percent. Used in examples/apps/lintel/resources.ts. |
views.*[kind=dashboard].sections[][kind=metric].kind |
Stable | One of metric. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=dashboard].sections[][kind=metric].measure |
string | Stable | “count” (default), “sum amount as pipeline”, “median amount” (PostgreSQL only), or a computed measure: aggregates and numbers joined by + - * /, “sum won / sum amount as win_rate”. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=metric].spark |
boolean | Stable | Draw the measure’s monthly trend (last 12 months of “over”) inside the card while no window stands; a windowed metric draws its trend across the window unless this is false. Composes with the card’s own query — best on cards whose query carries no time clause, and whose clock points backward (an opened_on, not an open deal’s close_date). |
views.*[kind=dashboard].sections[][kind=metric].target |
number | object | Stable | A goal for the measure: the card draws a meter under the number and says the share reached. A number, or a goal read from data in the metric’s own words: { table, query, measure }. Used in examples/apps/lintel/commands/leasing.ts. |
views.*[kind=dashboard].sections[][kind=metric].target.from |
string | Stable | The resource the goal is read from. Absent means the metric’s. Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].sections[][kind=metric].target.measure |
string | Stable | The goal’s measure. Absent means the metric’s. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=metric].target.query |
string | Stable | The query language, without the leading table name. |
views.*[kind=dashboard].sections[][kind=metric].to |
string | Stable | A list view over the same table that the card opens, narrowed by the metric’s query; the whole card is the link, marked with an arrow. false: the card is a figure read where it stands and opens nothing. One of false. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=metric].unit |
string | Stable | metric: a word said after the figure (“days”, “/mo”). Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].sections[][kind=note]
Section titled “views.*[kind=dashboard].sections[][kind=note]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].sections[][kind=note].action |
object | Stable | Used in examples/apps/lintel/views.ts. |
views.*[kind=dashboard].sections[][kind=note].action.label |
string | Stable | |
views.*[kind=dashboard].sections[][kind=note].action.to |
string | Stable | One of <appTarget>. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=note].eyebrow |
string | Stable | A banner’s short tag over its title. |
views.*[kind=dashboard].sections[][kind=note].image |
object | Stable | A banner’s picture: one row of a file resource, by its record key. Used in examples/apps/lintel/landing.ts. |
views.*[kind=dashboard].sections[][kind=note].image.alt |
string | Stable | Used in examples/apps/lintel/landing.ts. |
views.*[kind=dashboard].sections[][kind=note].image.from |
string | Stable | A resource whose rows are files. Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].sections[][kind=note].image.key |
string | number | Stable | Used in examples/apps/lintel/jobs.ts. |
views.*[kind=dashboard].sections[][kind=note].kind |
Stable | One of note. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=dashboard].sections[][kind=note].text |
string | Stable | The words. Plain text; blank lines separate paragraphs. |
views.*[kind=dashboard].sections[][kind=note].variant |
Stable | The dashboard’s introduction: a ground of its own, a larger title, the action a button, room for a picture. Needs a title. One of banner. |
views.*[kind=dashboard].sections[][kind=rows]
Section titled “views.*[kind=dashboard].sections[][kind=rows]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].sections[][kind=rows].empty |
object | Stable | What the section says while it has no row: what belongs here, and where to start; or hide, which leaves it out of the dashboard while it has none. One of hide. Used in examples/apps/lintel/pages/maintenance_request.ts. |
views.*[kind=dashboard].sections[][kind=rows].empty.action |
object | Stable | Used in examples/apps/lintel/views.ts. |
views.*[kind=dashboard].sections[][kind=rows].empty.action.label |
string | object | Stable | One of <presentationCopy>. |
views.*[kind=dashboard].sections[][kind=rows].empty.action.to |
string | Stable | Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].sections[][kind=rows].empty.description |
string | object | Stable | A sentence under the title. One of <presentationCopy>. Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].sections[][kind=rows].empty.title |
string | object | Stable | One of <presentationCopy>. |
views.*[kind=dashboard].sections[][kind=rows].kind |
Stable | One of rows. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=dashboard].sections[][kind=rows].limit |
integer | Stable | |
views.*[kind=dashboard].sections[][kind=rows].show |
array | Stable | In the dashboard’s aside the rows draw as a list, not a table: the first column names each row, the second is a quiet line under it and the third a value at its end — at most three. |
views.*[kind=dashboard].sections[][kind=rows].sizing |
"fit" · "scroll" |
Stable | Fit available width (default), or preserve content widths with horizontal scrolling. One of fit, scroll. |
views.*[kind=dashboard].sections[][kind=rows].sort |
string | Stable | Written like the query bar. |
views.*[kind=dashboard].sections[][kind=view]
Section titled “views.*[kind=dashboard].sections[][kind=view]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].sections[][kind=view].interactive |
boolean | Stable | The list works as its room does: its search, its filters and, for a reader offered one, its selection with bulk actions. Not in the aside, a board or a calendar. |
views.*[kind=dashboard].sections[][kind=view].kind |
Stable | One of view. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=dashboard].sections[][kind=view].limit |
integer | Stable | Rows; per lane for a board. |
views.*[kind=dashboard].sections[][kind=view].tab |
string | Stable | One of the view’s tab labels; default: its first. |
views.*[kind=dashboard].sections[][kind=view].view |
string | Stable | A list view’s key. Used in examples/apps/lintel/app.ts. |
views.*[kind=dashboard].window
Section titled “views.*[kind=dashboard].window”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].window |
string | Stable | The window the dashboard opens on, one of its windows (“last 30 days”); unsaid, it opens on all time. An address’s ?period= still wins, and a reader’s All time is said ?period=all-time. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=dashboard].windowControl
Section titled “views.*[kind=dashboard].windowControl”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].windowControl |
"segmented" · "button" |
Stable | How the windows are offered: segmented (default), a button each; button, one button saying the dates covered, opening a menu of the windows. One of button, segmented. |
views.*[kind=dashboard].windows
Section titled “views.*[kind=dashboard].windows”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=dashboard].windows |
array | Stable | The time windows offered when any section declares “over”, in the query grammar’s own words. Default: last 30 days / last 90 days / last 12 months. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=form].abandoned
Section titled “views.*[kind=form].abandoned”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].abandoned |
"purge" · "keep" |
Stable | An expired draft: ‘purge’ (the default) removes the root and the rows that point at it; ‘keep’ leaves them for follow-up. One of keep, purge. |
views.*[kind=form].command
Section titled “views.*[kind=form].command”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].command |
string | Stable | A command, by its name in the App’s commands module (defineCommands). The server fills in its input, target and version from the registration; tablewalk-commands.d.ts types the names. Used in examples/apps/lintel/app.ts. |
views.*[kind=form].description
Section titled “views.*[kind=form].description”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].description |
string | Stable | Shown under the heading. Used in examples/apps/lintel/app.ts. |
views.*[kind=form].done
Section titled “views.*[kind=form].done”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].done |
object | Stable | The screen after a submission, beside the reference the handler returned when it returned one. Used in examples/apps/tick/app.ts. |
views.*[kind=form].done.description |
string | Stable | A sentence under the title. Used in examples/apps/lintel/app.ts. |
views.*[kind=form].done.title |
string | Stable |
views.*[kind=form].draft
Section titled “views.*[kind=form].draft”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].draft |
object | Stable | The one root column and the value an unfinished application holds until submit: { status: ‘in_progress’ }. Staff lists hide it by default. Used in examples/apps/lintel/resources.ts. |
views.*[kind=form].icon
Section titled “views.*[kind=form].icon”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].icon |
"house" · "tray" · "list" · "list-checks" · "kanban" · "table" · "calendar" · "calendar-check" · "clock" · "chart-bar" · "chart-line" · "chart-pie" · "gauge" · "target" · "flag" · "user" · "users" · "user-circle" · "address-book" · "handshake" · "buildings" · "storefront" · "briefcase" · "package" · "truck" · "car" · "shopping-cart" · "receipt" · "currency-dollar" · "credit-card" · "wallet" · "bank" · "file" · "file-text" · "folder" · "clipboard-text" · "note" · "archive" · "tag" · "ticket" · "star" · "bookmark-simple" · "bell" · "envelope" · "chat-circle" · "phone" · "headset" · "megaphone" · "globe" · "map-pin" · "magnifying-glass" · "gear" · "sliders" · "wrench" · "bug" · "shield-check" · "lock" · "key" · "database" · "stack" · "lightning" · "check-circle" · "warning" · "info" · "cell-signal-low" · "cell-signal-medium" · "cell-signal-high" · "cell-signal-full" · "fire" · "hourglass" · "circle-dashed" · "x-circle" · "plus-circle" · "pencil-simple" · "paper-plane-tilt" · "arrows-left-right" · "arrow-circle-down" · "arrow-circle-up" · "laptop" · "monitor" · "device-mobile" · "printer" · "stethoscope" · "heartbeat" · "heart" · "pill" · "syringe" · "first-aid-kit" · "thermometer" · "flask" · "test-tube" · "microscope" · "bed" · "hospital" · "ambulance" · "tooth" · "eyeglasses" · "wheelchair" · "baby" · "dna" · "brain" · "bandaids" · "hand-heart" · "graduation-cap" · "book-open" · "student" · "chalkboard-teacher" · "factory" · "warehouse" · "house-line" · "plant" · "leaf" · "sun" · "cloud" · "drop" · "airplane" · "bicycle" · "bus" · "train" · "boat" · "hammer" · "toolbox" · "plug" · "lightbulb" · "cube" · "camera" · "image" · "trophy" · "gift" · "coffee" · "fork-knife" · "shopping-bag" · "basket" · "barcode" · "qr-code" · "scales" · "gavel" · "certificate" · "identification-card" · "fingerprint" · "eye" · "link" · "paperclip" · "scissors" · "palette" · "code" · "terminal" · "users-three" · "user-plus" |
Stable | The menu’s mark for a signed-in form. A public form is in no menu and takes none. One of <appIcon>. Used in examples/apps/lintel/app.ts. |
views.*[kind=form].inputs
Section titled “views.*[kind=form].inputs”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].inputs |
object | Stable | A signed-in form’s input drawn by the App’s own input component (kind ‘input’). An input in a group is named by its path (trade.vin), and in a repeating group stands in every row. Never on a public form. |
views.*[kind=form].inputs.*.kind |
Stable | One of input. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=form].kind
Section titled “views.*[kind=form].kind”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].kind |
Stable | One of form. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=form].label
Section titled “views.*[kind=form].label”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].label |
string | Stable | The form’s heading. |
views.*[kind=form].link
Section titled “views.*[kind=form].link”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].link |
object | Stable | Adding a submitted application to an account on proven control: sameDevice (the browser’s 30-minute claim, spent by a signed-in Yes), statusCheck (a signed-in status check) and/or email (an account’s verified email offers the applications that captured it, each added by a Yes). Needs the form’s statusCheck. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=form].link.at |
string | Stable | Used in examples/apps/lintel/resources.ts. |
views.*[kind=form].link.email |
string | object | Stable | The root’s email column (a step’s input), or { column, verified }: verified is the text column the server stamps with the address the applicant proved with a code in the form, which links without asking. Used in examples/apps/lintel/commands/maintenance.ts. |
views.*[kind=form].link.email.column |
string | Stable | Used in examples/apps/lintel/app.ts. |
views.*[kind=form].link.email.verified |
string | Stable | |
views.*[kind=form].link.owner |
string | Stable | |
views.*[kind=form].link.sameDevice |
object | Stable | |
views.*[kind=form].link.sameDevice.expires |
string | Stable | |
views.*[kind=form].link.sameDevice.token |
string | Stable | |
views.*[kind=form].link.statusCheck |
Stable | One of true. |
|
views.*[kind=form].link.via |
string | Stable |
views.*[kind=form].path
Section titled “views.*[kind=form].path”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].path |
string | Stable | A signed-in form’s address after the App’s, when not its key. A public form is /{app}/form/{key}. |
views.*[kind=form].prefillable
Section titled “views.*[kind=form].prefillable”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].prefillable |
array | Stable | The command’s inputs a link’s address may start filled (?stock_ref=FC-1049): text, number, date or choice inputs, shown, editable and checked like anything typed. A form that names none fills none. Used in examples/apps/lintel/views.ts. |
views.*[kind=form].public
Section titled “views.*[kind=form].public”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].public |
boolean | Stable | Served signed out at /{app}/form/{key} under the public rules: a public command, its pickers over what auth.public reads, never in nav. Absent means signed in. Used in examples/apps/lintel/app.ts. |
views.*[kind=form].realm
Section titled “views.*[kind=form].realm”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].realm |
"tenant" · "platform" |
Stable | The realm it belongs to: a tenant’s (the default) or the platform realm’s, which needs auth.tenancy.platform. One of platform, tenant. |
views.*[kind=form].resume
Section titled “views.*[kind=form].resume”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].resume |
object | Stable | The root row’s columns the platform keeps: the SHA-256 of the applicant’s cookie, the expiry and the saved steps’ ids. Nullable text, a timestamp, nullable text. Used in examples/apps/lintel/resources.ts. |
views.*[kind=form].resume.after |
string | Stable | How long from the first step a draft may be resumed: ‘14 days’ or ‘2 weeks’ (the default is 14 days), a whole number of days, 1 to 90. |
views.*[kind=form].resume.expires |
string | Stable | |
views.*[kind=form].resume.progress |
string | Stable | |
views.*[kind=form].resume.token |
string | Stable |
views.*[kind=form].roles
Section titled “views.*[kind=form].roles”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].roles |
array | Stable | A signed-in form’s: the roles that may open it, within those granted its command. Never on a public form. Each must be declared in auth.roles. |
views.*[kind=form].statusCheck
Section titled “views.*[kind=form].statusCheck”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].statusCheck |
object | Stable | The one sanctioned read of an anonymous application: the random receipt confirmed by one to three values only the applicant knows. Answers a state, never an input. |
views.*[kind=form].statusCheck.alert |
string | Stable | A nullable timestamp column stamped when a submitted application’s receipt locks; a notify rule on the root watching it tells staff. |
views.*[kind=form].statusCheck.confirm |
object | Stable | Used in examples/apps/lintel/resources.ts. |
views.*[kind=form].statusCheck.confirm.*.keyed |
Stable | One of true. |
|
views.*[kind=form].statusCheck.confirm.*.label |
string | Stable | |
views.*[kind=form].statusCheck.receipt |
string | Stable | |
views.*[kind=form].statusCheck.says |
object | Stable | |
views.*[kind=form].statusCheck.show |
array | Stable | |
views.*[kind=form].statusCheck.stepUp |
object | Stable | More after a one-time code to the root’s email column, sent by the config’s email service: the check’s details again with the code, then its show columns for a short session. |
views.*[kind=form].statusCheck.stepUp.email |
string | Stable | Used in examples/apps/lintel/commands/maintenance.ts. |
views.*[kind=form].statusCheck.stepUp.show |
array | Stable |
views.*[kind=form].steps
Section titled “views.*[kind=form].steps”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].steps |
array | Stable | Every command input is asked on exactly one step. Without steps the form is one page. A step that names its own command instead of fields makes the form one saved on every step; then every step names one. |
views.*[kind=form].steps[]
Section titled “views.*[kind=form].steps[]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].steps[].command |
string | Stable | A command, by its name in the App’s commands module (defineCommands). The server fills in its input, target and version from the registration; tablewalk-commands.d.ts types the names. Used in examples/apps/lintel/app.ts. |
views.*[kind=form].steps[].fields |
Stable | Used in examples/apps/tick/app.ts. |
|
views.*[kind=form].steps[].id |
string | Stable | Unique within the form. Absent, the label’s slug, as step() makes it. |
views.*[kind=form].steps[].label |
string | Stable | Static plain text. No row-value interpolation. |
views.*[kind=form].submitLabel
Section titled “views.*[kind=form].submitLabel”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=form].submitLabel |
string | Stable | Used in examples/apps/lintel/views.ts. |
views.*[kind=landing].hero
Section titled “views.*[kind=landing].hero”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=landing].hero |
object | Stable | |
views.*[kind=landing].hero.actions |
array | Stable | Used in examples/apps/tick/app.ts. |
views.*[kind=landing].hero.actions[].intent |
"primary" · "secondary" |
Stable | The first action is primary unless it says otherwise. One of primary, secondary. |
views.*[kind=landing].hero.actions[].label |
string | Stable | |
views.*[kind=landing].hero.actions[].signIn |
Stable | One of true. |
|
views.*[kind=landing].hero.actions[].to |
string | Stable | The key of a public form view this App declares, or of a list or dashboard view whose every table auth.public reads. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=landing].hero.heading |
string | Stable | The page’s one heading. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=landing].hero.highlights |
array | Stable | Up to four short items, one quiet line under the actions. Used in examples/apps/lintel/landing.ts. |
views.*[kind=landing].hero.image |
object | Stable | A wide lead photo: one row of a file resource that auth.public reads, drawn inline. Used in examples/apps/lintel/landing.ts. |
views.*[kind=landing].hero.image.alt |
string | Stable | What the photo shows, for a reader who cannot see it. Used in examples/apps/lintel/landing.ts. |
views.*[kind=landing].hero.image.from |
string | Stable | A resource whose rows are files, named in auth.public.read. Used in examples/apps/lintel/app.ts. |
views.*[kind=landing].hero.image.key |
string | number | Stable | The record key of the row that holds the photo. Used in examples/apps/lintel/jobs.ts. |
views.*[kind=landing].hero.layout |
"split" · "overlay" |
Stable | split: the photo beside the words (the default with an image). overlay: the photo behind them, under a scrim. One of overlay, split. Used in examples/apps/tick/app.ts. |
views.*[kind=landing].hero.search |
object | Stable | The search panel inside the hero: the search section’s keys without its title. Used in examples/apps/tick/app.ts. |
views.*[kind=landing].hero.search.filters |
array | Stable | Used in examples/apps/lintel/views.ts. |
views.*[kind=landing].hero.search.submitLabel |
string | Stable | Used in examples/apps/lintel/views.ts. |
views.*[kind=landing].hero.search.view |
string | Stable | Used in examples/apps/lintel/app.ts. |
views.*[kind=landing].hero.text |
string | Stable |
views.*[kind=landing].kind
Section titled “views.*[kind=landing].kind”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=landing].kind |
Stable | One of landing. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=landing].label
Section titled “views.*[kind=landing].label”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=landing].label |
string | Stable | The browser title; the App’s name when absent. |
views.*[kind=landing].sections
Section titled “views.*[kind=landing].sections”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=landing].sections |
array | Stable |
views.*[kind=landing].sections[][kind=*]
Section titled “views.*[kind=landing].sections[][kind=*]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=landing].sections[][kind=*].title |
string | Stable |
views.*[kind=landing].sections[][kind=callToAction]
Section titled “views.*[kind=landing].sections[][kind=callToAction]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=landing].sections[][kind=callToAction].actions |
array | Stable | Used in examples/apps/tick/app.ts. |
views.*[kind=landing].sections[][kind=callToAction].actions[].intent |
"primary" · "secondary" |
Stable | The first action is primary unless it says otherwise. One of primary, secondary. |
views.*[kind=landing].sections[][kind=callToAction].actions[].label |
string | Stable | |
views.*[kind=landing].sections[][kind=callToAction].actions[].signIn |
Stable | One of true. |
|
views.*[kind=landing].sections[][kind=callToAction].actions[].to |
string | Stable | The key of a public form view this App declares, or of a list or dashboard view whose every table auth.public reads. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=landing].sections[][kind=callToAction].kind |
Stable | One of callToAction. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=landing].sections[][kind=callToAction].text |
string | Stable |
views.*[kind=landing].sections[][kind=contact]
Section titled “views.*[kind=landing].sections[][kind=contact]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=landing].sections[][kind=contact].items |
array | Stable | |
views.*[kind=landing].sections[][kind=contact].items[].href |
string | Stable | https://, mailto: or tel: only — never a relative path, http:, javascript: or data:. Checked at load. |
views.*[kind=landing].sections[][kind=contact].items[].label |
string | Stable | |
views.*[kind=landing].sections[][kind=contact].kind |
Stable | One of contact. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=landing].sections[][kind=faq]
Section titled “views.*[kind=landing].sections[][kind=faq]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=landing].sections[][kind=faq].items |
array | Stable | |
views.*[kind=landing].sections[][kind=faq].items[].answer |
string | Stable | Used in examples/apps/lintel/landing.ts. |
views.*[kind=landing].sections[][kind=faq].items[].question |
string | Stable | Used in examples/apps/lintel/landing.ts. |
views.*[kind=landing].sections[][kind=faq].kind |
Stable | One of faq. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=landing].sections[][kind=features]
Section titled “views.*[kind=landing].sections[][kind=features]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=landing].sections[][kind=features].items |
array | Stable | |
views.*[kind=landing].sections[][kind=features].items[].text |
string | Stable | |
views.*[kind=landing].sections[][kind=features].items[].title |
string | Stable | |
views.*[kind=landing].sections[][kind=features].kind |
Stable | One of features. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=landing].sections[][kind=search]
Section titled “views.*[kind=landing].sections[][kind=search]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=landing].sections[][kind=search].filters |
array | Stable | Columns from the view’s filters. Used in examples/apps/lintel/views.ts. |
views.*[kind=landing].sections[][kind=search].kind |
Stable | One of search. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=landing].sections[][kind=search].submitLabel |
string | Stable | Used in examples/apps/lintel/views.ts. |
views.*[kind=landing].sections[][kind=search].view |
string | Stable | A list view over a resource auth.public reads. Used in examples/apps/lintel/app.ts. |
views.*[kind=landing].sections[][kind=steps]
Section titled “views.*[kind=landing].sections[][kind=steps]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=landing].sections[][kind=steps].items |
array | Stable | |
views.*[kind=landing].sections[][kind=steps].items[].text |
string | Stable | |
views.*[kind=landing].sections[][kind=steps].items[].title |
string | Stable | |
views.*[kind=landing].sections[][kind=steps].kind |
Stable | One of steps. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=landing].sections[][kind=text]
Section titled “views.*[kind=landing].sections[][kind=text]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=landing].sections[][kind=text].kind |
Stable | One of text. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=landing].sections[][kind=text].text |
string | Stable |
views.*[kind=landing].sections[][kind=view]
Section titled “views.*[kind=landing].sections[][kind=view]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=landing].sections[][kind=view].kind |
Stable | One of view. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=landing].sections[][kind=view].limit |
integer | Stable | |
views.*[kind=landing].sections[][kind=view].sort |
string | Stable | One column and a direction, like “listed_on desc”. |
views.*[kind=landing].sections[][kind=view].view |
string | Stable | A list view with a cards presentation, over a resource auth.public reads. Used in examples/apps/lintel/app.ts. |
views.*[kind=list].actions
Section titled “views.*[kind=list].actions”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].actions |
array | Stable | Queue and board only: narrows the resource’s actions by id, in order. Never defines one. Used in examples/apps/tick/app.ts. |
views.*[kind=list].advancedFilters
Section titled “views.*[kind=list].advancedFilters”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].advancedFilters |
boolean | Stable | Opt in to the Advanced action and raw query editor. Hidden by default in App lists; filterBar ‘none’ still hides the whole bar. Default false. |
views.*[kind=list].board
Section titled “views.*[kind=list].board”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].board |
object | Stable | Lanes of cards by one local column; a card moves only through an update that sets exactly that column, judged by its when, or a machine’s command verb that leads there from the card’s state (told the lane where its command asks for the column), run as its button runs it. Used in examples/apps/lintel/views.ts. |
views.*[kind=list].board.by |
string | Stable | Used in examples/apps/lintel/commands/maintenance.ts. |
views.*[kind=list].board.category |
string | Stable | A column whose value is the card’s kind: a chip over the title in the color its display rule’s colors give the value, and the card’s stripe where the look draws one. Used in examples/apps/lintel/commands/maintenance.ts. |
views.*[kind=list].board.folded |
array | Stable | Lane values drawn folded until a reader opens one (a closed stage: won, lost): a narrow strip with its name, count and sum. Remembered per board in the reader’s browser. |
views.*[kind=list].board.footer |
array | Stable | Facts along the card’s foot, each a column with an optional icon; a person stands at the right end. Used in examples/apps/lintel/app.ts. |
views.*[kind=list].board.footer[].column |
string | Stable | Used in examples/apps/lintel/app.ts. |
views.*[kind=list].board.footer[].icon |
"house" · "tray" · "list" · "list-checks" · "kanban" · "table" · "calendar" · "calendar-check" · "clock" · "chart-bar" · "chart-line" · "chart-pie" · "gauge" · "target" · "flag" · "user" · "users" · "user-circle" · "address-book" · "handshake" · "buildings" · "storefront" · "briefcase" · "package" · "truck" · "car" · "shopping-cart" · "receipt" · "currency-dollar" · "credit-card" · "wallet" · "bank" · "file" · "file-text" · "folder" · "clipboard-text" · "note" · "archive" · "tag" · "ticket" · "star" · "bookmark-simple" · "bell" · "envelope" · "chat-circle" · "phone" · "headset" · "megaphone" · "globe" · "map-pin" · "magnifying-glass" · "gear" · "sliders" · "wrench" · "bug" · "shield-check" · "lock" · "key" · "database" · "stack" · "lightning" · "check-circle" · "warning" · "info" · "cell-signal-low" · "cell-signal-medium" · "cell-signal-high" · "cell-signal-full" · "fire" · "hourglass" · "circle-dashed" · "x-circle" · "plus-circle" · "pencil-simple" · "paper-plane-tilt" · "arrows-left-right" · "arrow-circle-down" · "arrow-circle-up" · "laptop" · "monitor" · "device-mobile" · "printer" · "stethoscope" · "heartbeat" · "heart" · "pill" · "syringe" · "first-aid-kit" · "thermometer" · "flask" · "test-tube" · "microscope" · "bed" · "hospital" · "ambulance" · "tooth" · "eyeglasses" · "wheelchair" · "baby" · "dna" · "brain" · "bandaids" · "hand-heart" · "graduation-cap" · "book-open" · "student" · "chalkboard-teacher" · "factory" · "warehouse" · "house-line" · "plant" · "leaf" · "sun" · "cloud" · "drop" · "airplane" · "bicycle" · "bus" · "train" · "boat" · "hammer" · "toolbox" · "plug" · "lightbulb" · "cube" · "camera" · "image" · "trophy" · "gift" · "coffee" · "fork-knife" · "shopping-bag" · "basket" · "barcode" · "qr-code" · "scales" · "gavel" · "certificate" · "identification-card" · "fingerprint" · "eye" · "link" · "paperclip" · "scissors" · "palette" · "code" · "terminal" · "users-three" · "user-plus" |
Stable | A menu mark: one of Phosphor’s icons by its own name (phosphoricons.com, MIT), from the curated set in src/shared/appIcons.ts. One of <appIcon>. Used in examples/apps/lintel/app.ts. |
views.*[kind=list].board.lanes |
array | Stable | |
views.*[kind=list].board.limits |
object | Stable | A lane’s work-in-progress limit by lane value: its head says count / limit and warns past it. Shown, never enforced. |
views.*[kind=list].board.lines |
array | Stable | Used in examples/apps/tick/app.ts. |
views.*[kind=list].board.order |
string | Stable | A numeric column holding each card’s place in its lane; the lanes read in its order, and a reader who may edit it drags a card into place. Used in examples/apps/tick/app.ts. |
views.*[kind=list].board.primary |
string | Stable | The card’s title: a text column, a reference, which says the record it names (sales_order_id titles a parcel by its order), or a one-hop label path like “patient_id.name”. A reference in lines or footer says its record’s name too. Used in examples/apps/lintel/views.ts. |
views.*[kind=list].board.sum |
string | Stable | A numeric column summed in each lane’s head beside its count. Absent, the first money column the card shows is summed; money is said short ($240K), whole in the title. |
views.*[kind=list].board.swimlanes |
string | Stable | A column whose values are rows across the lanes, one per value plus one for none; a card changes row by an ordinary update where the reader may edit the column, and keeps its row, told why, where not. |
views.*[kind=list].count
Section titled “views.*[kind=list].count”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].count |
boolean | Stable | With ui.shell.counts: true counts this list in the menu, false never does. Absent, the list is counted where its condition is work: its machine’s unfinished states, a date at or before today, or the reader (me). Used in examples/apps/lintel/resources.ts. |
views.*[kind=list].density
Section titled “views.*[kind=list].density”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].density |
"comfortable" · "compact" |
Stable | Row height: ‘comfortable’ (default) or ‘compact’, for a list read as a ledger. A reader’s zoom still applies. One of comfortable, compact. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=list].editable
Section titled “views.*[kind=list].editable”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].editable |
array | Stable | Cells edited in place where the reader may write the column (Enter or F2 opens, Enter saves, Esc cancels, Tab saves and moves on), and a selection’s “Set field…”. true offers every shown column the reader may write; a list, only those: shown local columns (a reference shown by its record’s name, owner_id.name, is edited as owner_id, with a picker), never the key, a document, a file’s columns or the resource’s machine column. A grid only, on a resource with access ‘write’. One of true. Used in examples/apps/lintel/views.ts. |
views.*[kind=list].empty
Section titled “views.*[kind=list].empty”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].empty |
object | Stable | Copy for an empty base list, with an optional link to another App list, dashboard or signed-in form. Tabs and filters retain the ordinary no-matches message. Used in examples/apps/lintel/pages/maintenance_request.ts. |
views.*[kind=list].empty.action |
object | Stable | Used in examples/apps/lintel/views.ts. |
views.*[kind=list].empty.action.label |
string | object | Stable | One of <presentationCopy>. |
views.*[kind=list].empty.action.to |
string | Stable | Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=list].empty.description |
string | object | Stable | A sentence under the title. One of <presentationCopy>. Used in examples/apps/lintel/app.ts. |
views.*[kind=list].empty.title |
string | object | Stable | One of <presentationCopy>. |
views.*[kind=list].favorite
Section titled “views.*[kind=list].favorite”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].favorite |
boolean | Stable | Opt-in: a star on the view, so a reader can keep it in Favorites. |
views.*[kind=list].filterBar
Section titled “views.*[kind=list].filterBar”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].filterBar |
"bar" · "rail" · "none" |
Stable | Where the filters sit: bar (the default) above the rows; rail, a rail of facets beside the rows (not beside a split); none hides the filter bar, and tabs remain visible. One of bar, none, rail. Used in examples/apps/tick/app.ts. |
views.*[kind=list].filters
Section titled “views.*[kind=list].filters”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].filters |
array | Stable | Columns offered as quick filter boxes — a rollup or computed column too, a number’s Min and Max (spent). A path up a reference (account_id.industry_id) filters by the record it names, and { has } by the rows that point at it. Empty means none, on purpose. Used in examples/apps/lintel/views.ts. |
views.*[kind=list].filters[]
Section titled “views.*[kind=list].filters[]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].filters[].filter |
string | Stable | A column of those rows, or a path up from them, whose values the filter lists: stage, tag_id. |
views.*[kind=list].filters[].has |
string | Stable | The resource whose rows point at the list’s record: opportunity. |
views.*[kind=list].filters[].segment |
string | Stable | One of their segments, a yes-or-no: { has: ‘opportunity’, segment: ‘open’ } is Has open opportunities. Used in examples/apps/tick/app.ts. |
views.*[kind=list].filters[].via |
string | Stable | Their reference to the record, where they have more than one: account_id. |
views.*[kind=list].from
Section titled “views.*[kind=list].from”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].from |
string | Stable | A logical resource name: bare, or source.name for a secondary source. Used in examples/apps/lintel/app.ts. |
views.*[kind=list].heading
Section titled “views.*[kind=list].heading”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].heading |
Stable | false draws the list without its title; it stays for a screen reader. One of false. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=list].icon
Section titled “views.*[kind=list].icon”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].icon |
"house" · "tray" · "list" · "list-checks" · "kanban" · "table" · "calendar" · "calendar-check" · "clock" · "chart-bar" · "chart-line" · "chart-pie" · "gauge" · "target" · "flag" · "user" · "users" · "user-circle" · "address-book" · "handshake" · "buildings" · "storefront" · "briefcase" · "package" · "truck" · "car" · "shopping-cart" · "receipt" · "currency-dollar" · "credit-card" · "wallet" · "bank" · "file" · "file-text" · "folder" · "clipboard-text" · "note" · "archive" · "tag" · "ticket" · "star" · "bookmark-simple" · "bell" · "envelope" · "chat-circle" · "phone" · "headset" · "megaphone" · "globe" · "map-pin" · "magnifying-glass" · "gear" · "sliders" · "wrench" · "bug" · "shield-check" · "lock" · "key" · "database" · "stack" · "lightning" · "check-circle" · "warning" · "info" · "cell-signal-low" · "cell-signal-medium" · "cell-signal-high" · "cell-signal-full" · "fire" · "hourglass" · "circle-dashed" · "x-circle" · "plus-circle" · "pencil-simple" · "paper-plane-tilt" · "arrows-left-right" · "arrow-circle-down" · "arrow-circle-up" · "laptop" · "monitor" · "device-mobile" · "printer" · "stethoscope" · "heartbeat" · "heart" · "pill" · "syringe" · "first-aid-kit" · "thermometer" · "flask" · "test-tube" · "microscope" · "bed" · "hospital" · "ambulance" · "tooth" · "eyeglasses" · "wheelchair" · "baby" · "dna" · "brain" · "bandaids" · "hand-heart" · "graduation-cap" · "book-open" · "student" · "chalkboard-teacher" · "factory" · "warehouse" · "house-line" · "plant" · "leaf" · "sun" · "cloud" · "drop" · "airplane" · "bicycle" · "bus" · "train" · "boat" · "hammer" · "toolbox" · "plug" · "lightbulb" · "cube" · "camera" · "image" · "trophy" · "gift" · "coffee" · "fork-knife" · "shopping-bag" · "basket" · "barcode" · "qr-code" · "scales" · "gavel" · "certificate" · "identification-card" · "fingerprint" · "eye" · "link" · "paperclip" · "scissors" · "palette" · "code" · "terminal" · "users-three" · "user-plus" |
Stable | The menu’s mark for this view: in the side and top menus, and alone in the icon rail. One of <appIcon>. Used in examples/apps/lintel/app.ts. |
views.*[kind=list].import
Section titled “views.*[kind=list].import”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].import |
boolean | object | Stable | This list’s own CSV import, or false for none where its resource offers one. Used in examples/apps/lintel/resources.ts. |
views.*[kind=list].import.command |
string | Stable | A command, by its name in the App’s commands module (defineCommands). The server fills in its input, target and version from the registration; tablewalk-commands.d.ts types the names. Used in examples/apps/lintel/app.ts. |
views.*[kind=list].import.match |
array | Stable | The resource’s own columns that find the record each row runs on; a reference column is found by the record’s name. |
views.*[kind=list].kind
Section titled “views.*[kind=list].kind”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].kind |
Stable | One of list. Used in examples/apps/lintel/blueprint.ts. |
views.*[kind=list].label
Section titled “views.*[kind=list].label”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].label |
string | object | Stable | One of <presentationCopy>. |
views.*[kind=list].open
Section titled “views.*[kind=list].open”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].open |
"page" · "drawer" · "modal" |
Stable | How rows open: the full page (default), a drawer over the list, or a modal. Not beside a split, which opens its own rows. One of drawer, modal, page. Used in examples/apps/tick/app.ts. |
views.*[kind=list].opens
Section titled “views.*[kind=list].opens”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].opens |
string | Stable | A reference column whose record a row opens, in place of the row itself: a list of a join table such as ticket_watcher opens the ticket each row is about (opens: ‘ticket_id’). A grid only. |
views.*[kind=list].order
Section titled “views.*[kind=list].order”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].order |
string | Stable | A numeric column holding each row’s place: the list reads in its order wherever nothing else sorts it, and a reader who may edit it drags a row into place, presses Alt+↑/↓, or picks a place from the row’s grip. A grid, a checklist, a queue or cards (a board’s is its presentation’s order); not with a sort in query. Used in examples/apps/tick/app.ts. |
views.*[kind=list].path
Section titled “views.*[kind=list].path”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].path |
string | Stable | Its address after the App’s (/{app}/{path}), when not its key. |
views.*[kind=list].presentation
Section titled “views.*[kind=list].presentation”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].presentation |
object | Stable | How the rows draw: a checklist, a queue, a calendar, cards — each a card of one primary column and its lines — or the App’s own component (custom); a board or a split is the list view’s own board or split key. Local readable columns only; none grants writes. Used in examples/apps/tick/app.ts. |
views.*[kind=list].presentation[kind=calendar]
Section titled “views.*[kind=list].presentation[kind=calendar]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].presentation[kind=calendar].backdrop |
object | array | Stable | Shaded spans behind the days, read from another resource through the reader’s own grants (a blackout window): one kind or up to four, each from one date column to another, named by a label column, in a display tone. A span opens its record where its resource has a list the reader can open. |
views.*[kind=list].presentation[kind=calendar].backdrop.from |
string | Stable | Its date (or timestamp) column where a span starts. Used in examples/apps/lintel/app.ts. |
views.*[kind=list].presentation[kind=calendar].backdrop.label |
string | Stable | Its column whose value names a span. |
views.*[kind=list].presentation[kind=calendar].backdrop.resource |
string | Stable | The resource whose rows are the spans, like ‘blackout’. |
views.*[kind=list].presentation[kind=calendar].backdrop.to |
string | Stable | Its date (or timestamp) column holding a span’s last day. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=list].presentation[kind=calendar].backdrop.tone |
"good" · "warn" · "bad" · "info" · "neutral" |
Stable | The span’s shade, in a display tone; absent, the quiet neutral. One of bad, good, info, neutral, warn. Used in examples/apps/lintel/pages/maintenance_request.ts. |
views.*[kind=list].presentation[kind=calendar].backdrop[].from |
string | Stable | Its date (or timestamp) column where a span starts. Used in examples/apps/lintel/app.ts. |
views.*[kind=list].presentation[kind=calendar].backdrop[].label |
string | Stable | Its column whose value names a span. |
views.*[kind=list].presentation[kind=calendar].backdrop[].resource |
string | Stable | The resource whose rows are the spans, like ‘blackout’. |
views.*[kind=list].presentation[kind=calendar].backdrop[].to |
string | Stable | Its date (or timestamp) column holding a span’s last day. Used in examples/apps/lintel/dashboards.ts. |
views.*[kind=list].presentation[kind=calendar].backdrop[].tone |
"good" · "warn" · "bad" · "info" · "neutral" |
Stable | The span’s shade, in a display tone; absent, the quiet neutral. One of bad, good, info, neutral, warn. Used in examples/apps/lintel/pages/maintenance_request.ts. |
views.*[kind=list].presentation[kind=calendar].badge |
string | Stable | A status said as its tone (a dot and its word) from the column’s display map: a local column or one-hop label path. Used in examples/apps/lintel/views.ts. |
views.*[kind=list].presentation[kind=calendar].date |
string | Stable | The date (or timestamp) column a record sits on, or starts on when it has an end. Used in examples/apps/lintel/commands/leasing.ts. |
views.*[kind=list].presentation[kind=calendar].end |
string | Stable | A date column holding the record’s last day: the record is drawn across every day from date to end, continuing across week rows. A move shifts both. |
views.*[kind=list].presentation[kind=calendar].kind |
Stable | One of calendar. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=list].presentation[kind=calendar].lines |
array | Stable | Used in examples/apps/tick/app.ts. |
views.*[kind=list].presentation[kind=calendar].primary |
string | Stable | A local text column or one-hop reference label path like “employee_id.name”. Used in examples/apps/lintel/views.ts. |
views.*[kind=list].presentation[kind=cards]
Section titled “views.*[kind=list].presentation[kind=cards]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].presentation[kind=cards].badge |
string | Stable | Used in examples/apps/lintel/views.ts. |
views.*[kind=list].presentation[kind=cards].description |
string | Stable | A text column said under the title at the card’s full width, without a caption, clamped to three lines. Used in examples/apps/lintel/app.ts. |
views.*[kind=list].presentation[kind=cards].facts |
array | Stable | Up to six values said in one line under the figure, a dot between (“2019 · 85,780 mi · Hybrid”): local columns or one-hop label paths. Used in examples/apps/lintel/pages/lease.ts. |
views.*[kind=list].presentation[kind=cards].facts[].after |
string | object | Stable | |
views.*[kind=list].presentation[kind=cards].facts[].after.many |
string | Stable | Used in examples/apps/lintel/resources.ts. |
views.*[kind=list].presentation[kind=cards].facts[].after.one |
string | Stable | Used in examples/apps/lintel/resources.ts. |
views.*[kind=list].presentation[kind=cards].facts[].before |
string | Stable | |
views.*[kind=list].presentation[kind=cards].facts[].column |
string | Stable | Used in examples/apps/lintel/app.ts. |
views.*[kind=list].presentation[kind=cards].footer |
array | Stable | Up to four values along the card’s foot under a hairline, written as facts are: a catalog item’s price and how long it takes. Used in examples/apps/lintel/app.ts. |
views.*[kind=list].presentation[kind=cards].footer[].after |
string | object | Stable | |
views.*[kind=list].presentation[kind=cards].footer[].after.many |
string | Stable | Used in examples/apps/lintel/resources.ts. |
views.*[kind=list].presentation[kind=cards].footer[].after.one |
string | Stable | Used in examples/apps/lintel/resources.ts. |
views.*[kind=list].presentation[kind=cards].footer[].before |
string | Stable | |
views.*[kind=list].presentation[kind=cards].footer[].column |
string | Stable | Used in examples/apps/lintel/app.ts. |
views.*[kind=list].presentation[kind=cards].icon |
string | Stable | A column whose display rule maps its values to icons: the card wears its value’s icon before the title. Used in examples/apps/lintel/app.ts. |
views.*[kind=list].presentation[kind=cards].image |
string | object | Stable | A text column holding an https:// or /-rooted image address (the row’s own, or one a reference names), or the first file of a related file resource (with of, the referenced record’s). Used in examples/apps/lintel/landing.ts. |
views.*[kind=list].presentation[kind=cards].image.about |
string | Stable | A reference column of the card’s row: the files are the record it names. Used in examples/apps/lintel/views.ts. |
views.*[kind=list].presentation[kind=cards].image.from |
string | Stable | A resource whose rows are files. Used in examples/apps/lintel/app.ts. |
views.*[kind=list].presentation[kind=cards].image.sort |
string | Stable | Which file leads: one column and an optional direction, like “position”. |
views.*[kind=list].presentation[kind=cards].image.whose |
string | Stable | The column of from that names the card’s record. Used in examples/apps/lintel/resources.ts. |
views.*[kind=list].presentation[kind=cards].kind |
Stable | One of cards. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=list].presentation[kind=cards].media |
"cover" · "avatar" · "icon" |
Stable | How the image is framed. Omit or use cover for the existing picture; avatar makes it a circular portrait and falls back to initials from primary. One of avatar, cover, icon. |
views.*[kind=list].presentation[kind=cards].primary |
string | Stable | The card’s title: a text column, or one a reference names (“vehicle_id.title”). Omitted, the record’s name (the resource’s recordLabel). Used in examples/apps/lintel/views.ts. |
views.*[kind=list].presentation[kind=cards].properties |
array | Stable | Up to four values under the title, each under its caption: a local column or a one-hop label path (“dealer_id.name”). Used in examples/apps/lintel/views.ts. |
views.*[kind=list].presentation[kind=cards].value |
string | Stable | One prominent figure, the row’s own or one a reference names (“vehicle_id.price”), read through that table’s grants. Used in examples/apps/lintel/commands/ledger.ts. |
views.*[kind=list].presentation[kind=checklist]
Section titled “views.*[kind=list].presentation[kind=checklist]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].presentation[kind=checklist].checked |
string | Stable | |
views.*[kind=list].presentation[kind=checklist].kind |
Stable | One of checklist. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=list].presentation[kind=checklist].lines |
array | Stable | Used in examples/apps/tick/app.ts. |
views.*[kind=list].presentation[kind=checklist].primary |
string | Stable | Used in examples/apps/lintel/views.ts. |
views.*[kind=list].presentation[kind=custom]
Section titled “views.*[kind=list].presentation[kind=custom]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].presentation[kind=custom].component |
Stable | One of <component>. |
|
views.*[kind=list].presentation[kind=custom].component.kind |
Stable | One of list. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=list].presentation[kind=custom].kind |
Stable | One of custom. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=list].presentation[kind=custom].props |
object | Stable | The component’s props, checked against its declaration. |
views.*[kind=list].presentation[kind=custom].show |
array | Stable | The columns the component reads, label paths welcome. |
views.*[kind=list].presentation[kind=gantt]
Section titled “views.*[kind=list].presentation[kind=gantt]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].presentation[kind=gantt].by |
string | Preview | Used in examples/apps/lintel/commands/maintenance.ts. |
views.*[kind=list].presentation[kind=gantt].end |
string | Preview | |
views.*[kind=list].presentation[kind=gantt].kind |
Preview | One of gantt. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=list].presentation[kind=gantt].primary |
string | Preview | Used in examples/apps/lintel/views.ts. |
views.*[kind=list].presentation[kind=gantt].progress |
string | Preview | |
views.*[kind=list].presentation[kind=gantt].start |
string | Preview | Used in examples/apps/lintel/late-fees.ts. |
views.*[kind=list].presentation[kind=queue]
Section titled “views.*[kind=list].presentation[kind=queue]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].presentation[kind=queue].badge |
string | Stable | An optional status cue, dressed by the column’s display tones. Used in examples/apps/lintel/views.ts. |
views.*[kind=list].presentation[kind=queue].kind |
Stable | One of queue. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=list].presentation[kind=queue].lines |
array | Stable | Used in examples/apps/tick/app.ts. |
views.*[kind=list].presentation[kind=queue].openLabel |
string | Stable | The row-opening call to action; omitted uses Open. Used in examples/apps/lintel/views.ts. |
views.*[kind=list].presentation[kind=queue].primary |
string | Stable | Used in examples/apps/lintel/views.ts. |
views.*[kind=list].presentation[kind=queue].properties |
array | Stable | Up to six captioned values under the title: local columns or one-hop label paths. Used in examples/apps/lintel/views.ts. |
views.*[kind=list].presentation[kind=tree]
Section titled “views.*[kind=list].presentation[kind=tree]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].presentation[kind=tree].kind |
Stable | One of tree. Used in examples/apps/lintel/blueprint.ts. |
|
views.*[kind=list].presentation[kind=tree].lines |
array | Stable | Used in examples/apps/tick/app.ts. |
views.*[kind=list].presentation[kind=tree].parent |
string | Stable | |
views.*[kind=list].presentation[kind=tree].primary |
string | Stable | Used in examples/apps/lintel/views.ts. |
views.*[kind=list].query
Section titled “views.*[kind=list].query”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].query |
string | Stable | Standing conditions; tabs refine on top. |
views.*[kind=list].quickAdd
Section titled “views.*[kind=list].quickAdd”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].quickAdd |
boolean | Stable | Inline the resource’s New form above the rows. Used in examples/apps/tick/app.ts. |
views.*[kind=list].realm
Section titled “views.*[kind=list].realm”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].realm |
"tenant" · "platform" |
Stable | The realm it belongs to: a tenant’s (the default) or the platform realm’s, which needs auth.tenancy.platform. One of platform, tenant. |
views.*[kind=list].roles
Section titled “views.*[kind=list].roles”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].roles |
array | Stable | The roles that may open it: a signed-in reader holding none of them is not served it (not in the menu, ⌘K or search, and its address answers as one that does not exist). Table grants still apply; this only narrows. Each must be declared in auth.roles. |
views.*[kind=list].rowActions
Section titled “views.*[kind=list].rowActions”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].rowActions |
boolean | Stable | A ⋯ menu at the end of each row with the record’s own actions, as its page offers them. A grid only. Used in examples/apps/lintel/views.ts. |
views.*[kind=list].segment
Section titled “views.*[kind=list].segment”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].segment |
string | Stable | One of the table’s segments (resources.<table>.segments), its conditions ANDed with query. Used in examples/apps/tick/app.ts. |
views.*[kind=list].shortcuts
Section titled “views.*[kind=list].shortcuts”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].shortcuts |
object | Stable | A split’s single keys: a key (one lowercase letter or digit, not J or K) to the id of an action of the picked record. Each shows beside its verb, and works only while focus is not in an input. |
views.*[kind=list].show
Section titled “views.*[kind=list].show”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].show |
array | Stable | Columns, in order: a column or a dotted label path. Captions are the resource’s labels. |
views.*[kind=list].sizing
Section titled “views.*[kind=list].sizing”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].sizing |
"fit" · "scroll" |
Stable | Fit available width (default), or preserve content widths with horizontal scrolling. One of fit, scroll. |
views.*[kind=list].sort
Section titled “views.*[kind=list].sort”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].sort |
string | array | Stable | The list’s order, written like the query bar: “created_on desc” is how it reads when nothing else says one. Two to eight named orders are a Sort menu beside the filters, the first of them the order the list opens in; a chosen one is the query’s own sort clause, so the address keeps it. The opening order is kept out of the bar, as order is. A tab’s sort clause wins over it, and the menu over both. Not beside order or a sort in query, and not on a board or a calendar. |
views.*[kind=list].sort[]
Section titled “views.*[kind=list].sort[]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].sort[].label |
string | Stable | |
views.*[kind=list].sort[].sort |
string | Stable |
views.*[kind=list].split
Section titled “views.*[kind=list].split”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].split |
object | Stable | The view’s own list — its show, query, tabs and filter bar — beside one selected record, headed by the resource’s noun. No hooks, persistence, or component registry. Used in examples/apps/lintel/views.ts. |
views.*[kind=list].split.detail |
array | Stable | Columns for the split workspace: a column or a label path. Presentation only; it grants no access. Used in examples/apps/lintel/pages/maintenance_request.ts. |
views.*[kind=list].split.limit |
integer | Stable | The list’s page size. |
views.*[kind=list].split.row |
object | Stable | How a row reads in the list beside the record, in the queue’s vocabulary: a title, up to two lines, captioned properties, a status badge and an avatar. Absent, the list is the plain grid. Used in examples/apps/lintel/views.ts. |
views.*[kind=list].split.row.avatar |
string | Stable | A name or person drawn as an avatar of initials before the row. Used in examples/apps/lintel/resources.ts. |
views.*[kind=list].split.row.badge |
string | Stable | A status said as its tone, from the column’s display map. Used in examples/apps/lintel/views.ts. |
views.*[kind=list].split.row.lines |
array | Stable | Used in examples/apps/tick/app.ts. |
views.*[kind=list].split.row.primary |
string | Stable | A local column or a one-hop reference label path. Used in examples/apps/lintel/views.ts. |
views.*[kind=list].split.row.properties |
array | Stable | Used in examples/apps/lintel/views.ts. |
views.*[kind=list].suggest
Section titled “views.*[kind=list].suggest”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].suggest |
object | Stable | A text filter (one of filters) to the text columns whose values it suggests as the reader types, like { “title”: [“make”, “model”] }. |
views.*[kind=list].tabs
Section titled “views.*[kind=list].tabs”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].tabs |
array | Stable | Tabs over the rows: a segment of the table by name, a segment with its own sort, or every row ({ label }). A tab’s label and address are its segment’s. Used in examples/apps/tick/app.ts. |
views.*[kind=list].tabs[]
Section titled “views.*[kind=list].tabs[]”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].tabs[].label |
string | Stable | |
views.*[kind=list].tabs[].segment |
string | Stable | Used in examples/apps/tick/app.ts. |
views.*[kind=list].tabs[].sort |
string | Stable | The order this tab reads in, as the query bar writes one (“scheduled_at”, “created_on desc”); wins over the view’s own sort. |
views.*[kind=list].totals
Section titled “views.*[kind=list].totals”| Key | Type | Status | What it does |
|---|---|---|---|
views.*[kind=list].totals |
array | Stable | Numeric columns, rollups or computed numbers summed in a footer row, over everything the list’s conditions match, not just the page. A grid only. Used in examples/apps/lintel/views.ts. |