@lowdefy/docs-content 7.1.0 → 7.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/content/actions/login.md +1 -1
  2. package/content/actions/posthoginit.md +1 -1
  3. package/content/adapter-reference/mongodbauthadapter.md +2 -2
  4. package/content/agents/agents-introduction.md +41 -1
  5. package/content/callback-reference/auth0logoutcallback.md +1 -1
  6. package/content/concepts/ai-agent-docs.md +116 -108
  7. package/content/concepts/blocks.md +1 -1
  8. package/content/concepts/connections-and-requests.md +8 -8
  9. package/content/concepts/custom-html.md +1 -1
  10. package/content/concepts/dynamic-page-content.md +26 -15
  11. package/content/concepts/events-and-actions.md +24 -0
  12. package/content/concepts/logger.md +1 -1
  13. package/content/concepts/lowdefy-api.md +81 -14
  14. package/content/concepts/lowdefy-schema.md +11 -0
  15. package/content/concepts/mobile-apps.md +110 -0
  16. package/content/concepts/page-and-app-state.md +2 -2
  17. package/content/concepts/theming.md +1 -1
  18. package/content/connections/axioshttp.md +1 -1
  19. package/content/connections/mongodb.md +22 -6
  20. package/content/controls/reject.md +2 -2
  21. package/content/deployment/vercel.md +1 -1
  22. package/content/display-blocks/aggrid.md +1 -1
  23. package/content/display-blocks/search.md +86 -2
  24. package/content/display-blocks/table.md +154 -9
  25. package/content/input-blocks/tableinput.md +12 -4
  26. package/content/input-blocks/tiptapinput.md +3 -2
  27. package/content/input-blocks/tiptapmentioninput.md +3 -2
  28. package/content/migration/v3-to-v4.md +2 -2
  29. package/content/operators/_base64.md +2 -2
  30. package/content/operators/_log.md +1 -1
  31. package/content/operators/_ref.md +6 -6
  32. package/content/plugins/plugins-introduction.md +13 -0
  33. package/content/plugins/posthog.md +1 -1
  34. package/content/provider-reference/auth-js-providers.md +2 -2
  35. package/content/provider-reference/openidconnectprovider.md +1 -1
  36. package/content/reference/cli.md +164 -0
  37. package/content/testing/config-tests.md +2 -2
  38. package/content/tutorial/tutorial-create-page.md +1 -1
  39. package/content/tutorial/tutorial-requests-api.md +1 -1
  40. package/content/tutorial/tutorial-requests-sql.md +1 -1
  41. package/content/tutorial/tutorial-start.md +1 -1
  42. package/content/user-authentication/auth-configuration.md +9 -9
  43. package/content/user-authentication/auth-steps.md +4 -2
  44. package/content/user-authentication/organizations.md +57 -0
  45. package/content/user-authentication/protected-pages-apis.md +4 -4
  46. package/content/user-authentication/roles.md +2 -2
  47. package/content/user-authentication/user-object.md +1 -1
  48. package/content/websockets/websocket-publish.md +1 -1
  49. package/content/websockets/websockets-introduction.md +1 -1
  50. package/index.json +72 -57
  51. package/package.json +2 -2
@@ -225,21 +225,32 @@ policies:
225
225
  state: form
226
226
  ```
227
227
 
228
- | Key | Default | Meaning |
229
- | --------------- | --------- | ----------------------------------------------------------------------------------------------------------- |
230
- | `id` | required | Policy id, referenced by Dynamic blocks and steps. |
231
- | `blocks` | required | Block types the content may use. `Dynamic` cannot be listed. |
232
- | `actions` | `[]` | Action types the content may use. |
233
- | `operators` | `[]` | Client operator names. `_string` allows every `_string` method. `_operator` cannot be listed. |
234
- | `endpoints` | `[]` | Endpoints a `CallAPI` action in the content may call. |
235
- | `requests` | `[]` | Page requests a `Request` action may call. The build checks every page that hosts the policy defines them. |
236
- | `links.pages` | `[]` | Page ids the content may link to. A link by app path, like `/form_submitted`, is matched to its page. |
237
- | `links.origins` | `[]` | Exact origins (`https://example.com`) the content may link to or load from. |
238
- | `state` | none | When set, input block ids, `SetState` keys and `_state` reads must sit under this state path. |
239
- | `html` | `false` | When `false`, no string in the content may contain HTML tag syntax. |
240
- | `limits` | see below | `depth` (10), `blocks` (500), `bytes` (262144) and `actionsPerEvent` (20). They can be raised, not removed. |
241
-
242
- Besides the lists, a policy requires literal values wherever the content names a target: `properties`, `style`, events and action lists; the params of `Link`, `CallAPI`, `Request` and `SetState`; every `_state` key; and every `pageId` and URL. URLs must be app paths or use a listed origin — including image sources, markdown links and CSS `url()`. A block's properties schema marks which properties hold a URL (see [Plugins](/plugins-introduction)), so a URL property is checked whatever it is called, such as `Search` `indexUrl` or `QRCode` `icon`; every value no schema marks, including action params and the properties of blocks that mark none, is checked by its key (`url`, `href`, `src`, ...). URLs are read as the browser reads them, so surrounding spaces and embedded tabs or newlines do not hide one.
228
+ | Key | Default | Meaning |
229
+ | --------------- | --------- | -------------------------------------------------------------------------------------------------------------------- |
230
+ | `id` | required | Policy id, referenced by Dynamic blocks and steps. |
231
+ | `blocks` | required | Block types the content may use. `Dynamic` cannot be listed. |
232
+ | `actions` | `[]` | Action types the content may use. |
233
+ | `operators` | `[]` | Client operator names. `_string` allows every `_string` method. `_operator` cannot be listed. |
234
+ | `endpoints` | `[]` | Endpoints a `CallAPI` action in the content may call. |
235
+ | `requests` | `[]` | Page requests a `Request` action may call. The build checks every page that hosts the policy defines them. |
236
+ | `links.pages` | `[]` | Page ids the content may link to. A link by app path, like `/form_submitted`, is matched to its page. |
237
+ | `links.origins` | `[]` | Exact origins (`https://example.com`) the content may link to or load from. |
238
+ | `state` | none | When set, input block ids, `SetState` keys and `_state` reads must sit under this state path. |
239
+ | `html` | `false` | When `false`, no string may contain HTML tag syntax, except text a block draws as escaped text and data (see below). |
240
+ | `limits` | see below | `depth` (10), `blocks` (500), `bytes` (262144) and `actionsPerEvent` (20). They can be raised, not removed. |
241
+
242
+ Besides the lists, a policy requires literal values wherever the content names a target: `properties`, `style`, events and action lists; the params of `Link`, `CallAPI`, `Request` and `SetState`; every `_state` key; and every `pageId` and URL.
243
+
244
+ The policy checks a value as a URL where it is used as a link or a source: `href`, `src`, `url`, `Link` params, markdown links and CSS `url()`. There it must be an app path or use a listed origin, so `javascript:`, `data:` and off-site links and images are refused. A block's properties schema marks which properties hold a URL (see [Plugins](/plugins-introduction)), so a URL property is checked whatever it is called, such as `Search` `indexUrl` or `QRCode` `icon`; every value no schema marks, including action params and the properties of blocks that mark none, is checked by its key (`url`, `href`, `src`, ...). URLs are read as the browser reads them, so surrounding spaces and embedded tabs or newlines do not hide one.
245
+
246
+ Everywhere else a URL is plain text:
247
+
248
+ - **Text a block draws.** A block's properties schema marks how it draws a string (`textKind`). In a property it draws as HTML, such as a `Descriptions` item value, a `Paragraph` content, an input `title` or a `Selector` option label, a whole URL, a markdown link, a word starting with `//` and (unless the policy allows HTML) a CSS `url()` are words, since nothing there reads them as a link. The `html` rule still applies there, so text a block draws as HTML shows as written only when it is HTML-escaped (`&lt;` for `<`, `&amp;` for `&`). In a property it draws as escaped text, such as a `ControlledList` title, tag syntax is words too. When the policy allows HTML, a link or source attribute (`href`, `src`, `srcset`) in any string not drawn as escaped text is judged as a link or source, as a `url` or `src` property is.
249
+ - **State.** When the policy sets a `state` path, `SetState` values, such as a form's prefill, are data: no block property can read state (properties are literal). A URL or tag syntax in them is text, and only the operator rules apply. Without a `state` path the content may write any page state, so its `SetState` values keep every check. A value bound to an input in the content whose value is an object, such as a rich text editor, an upload or a table input, keeps every check, since those inputs draw parts of their value as markup, links or images. The content may read data state (`SetState` values, and the state of an input whose option values or rows are data) only in a `CallAPI`'s params, an action's `skip`, a `SetState` value, or an `:if` or `:case` condition. A `_state` read of it anywhere else, such as a `DisplayMessage`'s content, fails with `policy.state`. The page around the Dynamic block owns the state under the policy's `state` path: anything there that draws it as HTML or follows it as a link must treat it as untrusted input, whatever the policy's `html` setting.
250
+ - **Option values.** A `Selector` or `MultipleSelector` option `value` beside a `label` is data (`textKind: data`); the `label` is drawn as HTML. An option without a `label` draws its `value` as HTML in its place, so that value keeps every check.
251
+ - **Table cells.** When every column of a `Table` or `TableLight` draws its cell as text (`text`, `email`, `phone`, `number`, `currency`, `percent`, `progress`, `rating`, `date`, `datetime`, `boolean`, `tag`, `tags`, `status` or `json`, or no type), its `data` rows are data. A `url`, `link`, `relation`, `image`, `avatar`, `people`, `html`, `buttons` or `menu` column draws or follows row values, a `cell.colorFrom` reads a row field into a colour, and an `expandable.template` draws row fields as HTML, so their table's rows keep every check.
252
+
253
+ A value no schema marks, such as a `Markdown` content, may be drawn as markdown, a style or a link, so it keeps every check: a whole value counts as a URL when it starts with a scheme the browser loads or runs (`http:`, `https:`, `data:`, `javascript:`, ...) or with two slashes (`//`, or `\\` and the mixed forms, which the browser reads the same way). A reference such as `INC:42` or a format such as `HH:mm` is text.
243
254
 
244
255
  > With `html: false`, an operator that builds strings (`_string`, `_uri`, `_base64`, `_json`) can still assemble HTML at render time from content that passed the check. The build warns when a policy lists one. Leave them out of policies for generated content.
245
256
 
@@ -414,6 +414,30 @@ App event errors are handled like page event errors: the error message is displa
414
414
 
415
415
  The app events config is sent to the browser with the rest of the app config, like `global`, so do not put secrets in it.
416
416
 
417
+ ###### App events on phones
418
+
419
+ > **Experimental.** Phone apps need `config.experimental.mobile: true`. See [Mobile Apps](/mobile-apps).
420
+
421
+ A native shell does not run the root `events`, so they can use web-only actions, like an analytics plugin that has no native version. App events that run on a phone go in `mobile.events`, with the same `onInit` and `onInitAsync` events and the same rules. Every action type in `mobile.events` must have a native version, or the build fails, as on a mobile page.
422
+
423
+ ```yaml
424
+ # lowdefy.yaml
425
+ events:
426
+ onInit:
427
+ - id: analytics
428
+ type: PostHogInit # web only
429
+ mobile:
430
+ events:
431
+ onInit:
432
+ - id: set_user
433
+ type: SetGlobal
434
+ params:
435
+ userName:
436
+ _user: name
437
+ pages:
438
+ # ...
439
+ ```
440
+
417
441
  ## Action types
418
442
 
419
443
  The following actions can be used:
@@ -28,7 +28,7 @@ For client-side error capture, you also need to expose the DSN to the browser:
28
28
  You can customize Sentry behavior using the `logger` configuration in your `lowdefy.yaml`:
29
29
 
30
30
  ```yaml
31
- lowdefy: 7.0.0
31
+ lowdefy: 7.1.0
32
32
 
33
33
  logger:
34
34
  sentry:
@@ -9,6 +9,7 @@ APIs are particularly useful when you need to:
9
9
  - Transform or aggregate data from multiple sources.
10
10
  - Create reusable endpoints that can be called from multiple pages.
11
11
  - Build webhook endpoints for external services.
12
+ - Serve private files at stable links, such as inline images.
12
13
  - Keep sensitive operations and data on the server.
13
14
 
14
15
  ## How Lowdefy APIs Work
@@ -35,12 +36,13 @@ The schema for a Lowdefy API is:
35
36
  - `async: boolean`: **Optional** - Respond with `{ accepted: true }` immediately and run the routine in the background. See [Async Endpoints](#async-endpoints).
36
37
  - `payloadSchema: object`: **Optional** - A JSON Schema every payload sent to this endpoint must match. Declaring it turns validation on for every caller, and it is required before an endpoint can be exposed as an MCP or agent tool. See [Payload Schema](#payload-schema).
37
38
  - `webhook: boolean`: **Optional** - Make this endpoint a third-party webhook receiver — it takes the HTTP request raw instead of the CallAPI envelope. See [Webhook Endpoints](#webhook-endpoints).
39
+ - `link: boolean`: **Optional** - Serve this endpoint at a stable link: a `GET` on `/api/endpoints/<endpointId>/<path>` runs the routine as the signed-in caller and redirects to the URL it returns. See [Link Endpoints](#link-endpoints).
38
40
  - `schedules: array | object`: **Optional** - Cron schedules that run the routine on a timer. See [Scheduled Endpoints](#scheduled-endpoints-cron). Each item is an object with a `cron` expression and an optional `payload` object. With `config.environments` declared, `schedules` can instead be an object keyed by environment name (plus an optional `default`), see [Schedules per environment](#schedules-per-environment).
39
41
 
40
42
  ###### API definition example:
41
43
 
42
44
  ```yaml
43
- lowdefy: '7.0.0'
45
+ lowdefy: '7.1.0'
44
46
 
45
47
  connections:
46
48
  - id: users
@@ -75,7 +77,7 @@ Lowdefy APIs use the same [authorization configuration](/protected-pages-apis) a
75
77
  Unlike requests which are defined on a specific page and inherit the authorization of the page they are defined on, API endpoints can be called from any page in the app. Thus they do not inherit the authorization of the page they are called from, and authorization should be configured separately.
76
78
 
77
79
  ```yaml
78
- lowdefy: '7.0.0'
80
+ lowdefy: '7.1.0'
79
81
 
80
82
  auth:
81
83
  # Configure which APIs require authentication
@@ -127,7 +129,7 @@ Each schedule item has:
127
129
 
128
130
  When a schedule fires, the routine runs as a **system context**: there is no authenticated user, so `_user` is `undefined`. The routine still has full access to connections, requests, operators and secrets — write scheduled routines so they do not depend on a logged-in user. Because cron delivery is best-effort and not retried, design scheduled routines to be idempotent.
129
131
 
130
- To test a scheduled routine locally, run it as a system context with the dev server's `lowdefy_run_endpoint` MCP tool (or `POST /lowdefy-docs/run-endpoint`) with `system: true` — see [Docs for AI Agents](/ai-agent-docs#running-endpoints).
132
+ To test a scheduled routine locally, run it as a system context with the dev server's `lowdefy_run_endpoint` MCP tool with `system: true` — see [Docs for AI Agents](/ai-agent-docs#running-endpoints).
131
133
 
132
134
  See [Deploy with Vercel](/vercel) for how schedules become cron jobs, how to secure them with `CRON_SECRET`, and the applicable plan limits.
133
135
 
@@ -239,6 +241,71 @@ api:
239
241
  - `async: true` also applies to scheduled runs — the cron trigger is acknowledged immediately and the routine runs in the background.
240
242
  - On serverless deployments the background work still runs inside the same function invocation, so it remains bounded by the function's `maxDuration` — see [Deploy with Vercel](/vercel). To run work in a separate invocation with a fresh time budget, use a [detached endpoint call](#detached-endpoint-calls).
241
243
 
244
+ ## Link Endpoints
245
+
246
+ An endpoint with `link: true` serves a file at a URL that does not expire, so a page can save `<img src="/api/endpoints/<endpointId>/<path>">` in rich text or a record and the browser loads it later with the signed-in session. This lets a bucket stay private: the link endpoint checks the caller and redirects to a fresh presigned URL on every load.
247
+
248
+ - A `GET` on `/api/endpoints/<endpointId>/<path>` runs the routine as the session caller. The endpoint's `auth` config applies as on any other endpoint.
249
+ - The payload is `{ path, query }`: `path` is the rest of the URL after the endpoint id, decoded and joined with `/` (it may be empty), and `query` is the URL's query parameters. A [`payloadSchema`](#payload-schema) validates it.
250
+ - Endpoint ids can hold slashes, so the longest link endpoint id the URL starts with wins: with `files` and `files/inline` both declared, `/api/endpoints/files/inline/a.png` runs `files/inline` with path `a.png`.
251
+ - Only an endpoint with `link: true` answers a `GET`, and a `CallAPI` (a `POST`) to a link endpoint is refused as if it did not exist.
252
+ - `link` is allowed on `type: Api` only, and cannot be combined with `webhook` or `async`.
253
+
254
+ ```yaml
255
+ id: files/inline
256
+ type: Api
257
+ link: true
258
+ routine:
259
+ - :if:
260
+ _not:
261
+ _regex:
262
+ pattern: '^log-events/'
263
+ on:
264
+ _payload: path
265
+ :then:
266
+ :reject: Not an inline image.
267
+ :status: 404
268
+ - id: presign
269
+ type: AwsS3PresignedGetObject
270
+ connectionId: files
271
+ properties:
272
+ key:
273
+ _payload: path
274
+ expires: 300
275
+ - :return:
276
+ _step: presign
277
+ ```
278
+
279
+ The endpoint answers:
280
+
281
+ | Outcome | Status | Body |
282
+ | ----------------------------------------------------------------------------------------------- | ----------------------- | ----------------------------------------------------- |
283
+ | The routine returned a URL | `302` to that URL | None |
284
+ | No link endpoint matches the URL | `404` | `{ "error": "Not found." }` |
285
+ | The caller is not signed in and the endpoint is protected | `401` | None |
286
+ | The caller's roles do not allow the endpoint | `403` | None |
287
+ | A [`:reject`](/:reject), also one raised in an endpoint the routine calls | Its `:status`, or `400` | None |
288
+ | A failed [`ValidateSchema` step](#validating-data-as-a-routine-step) (with `throwOnInvalid` on) | `400` | None |
289
+ | The payload does not match the endpoint's `payloadSchema` | `400` | None |
290
+ | The routine returned anything but a URL, or any other error | `500` | `{ "error": "Link failed." }`, nothing from the error |
291
+
292
+ The `:return` must be a non-empty string: an absolute `http` or `https` URL, or a path on the app starting with `/`. Any other value answers `500` and logs a config error naming the endpoint. Every answer carries `Cache-Control: private, no-store`, so a redirect to a short-lived URL is never cached. On an app with auth, a signed-out caller gets `401` for an unknown link id too, so link ids cannot be found by trying them.
293
+
294
+ A link endpoint **must have no side effects**. Any page, email or document that embeds the URL can make the browser send the `GET`, with no click and no confirmation, so the routine should only read and sign. Session cookies are `SameSite=Lax`, so the browser does not send them on an image load from another site: a link embedded in another site's page loads as signed out. Use a `public` link endpoint for a file other sites may embed. Never build the redirect host from the payload: a link that redirects to a host its `path` or `query` names is an open redirect.
295
+
296
+ To save these links from the editor, set `imageSrc` on [`TiptapInput`](/TiptapInput) or [`TiptapMentionInput`](/TiptapMentionInput) to a `_function` that returns the link for the uploaded key:
297
+
298
+ ```yaml
299
+ imageSrc:
300
+ _function:
301
+ __string.concat:
302
+ - /api/endpoints/files/inline/
303
+ - __uri.encode:
304
+ __args: 0.key
305
+ ```
306
+
307
+ Encode the key, so a file name with `#`, `?` or `%` stays one path. The endpoint receives it decoded.
308
+
242
309
  ## Webhook Endpoints
243
310
 
244
311
  An endpoint with `webhook: true` is a receiver for third-party webhooks (AWS SNS, Azure Event Grid, Stripe, GitHub, ...). It is served on the same `POST /api/endpoints/<endpointId>` URL as every other endpoint, but the request is handled raw:
@@ -340,17 +407,17 @@ routine:
340
407
 
341
408
  A webhook endpoint answers with an HTTP status that says how the run ended, so the sender can tell its own mistake from an outage:
342
409
 
343
- | Outcome | Status | Body |
344
- | --- | --- | --- |
345
- | The routine finished | `200` | Its `:return` value, or `{ "ok": true }` when it returned nothing |
346
- | A [`:return`](/:return) with `:content_type: text/plain` | `200` | The returned string as plain text (see [Answering with plain text](#answering-with-plain-text)) |
347
- | A [`:reject`](/:reject) with `:status` | That status (400 to 499) | `:body` as given, or the error body below |
348
- | A [`:reject`](/:reject) without `:status` | `400` | `{ "error": { "code": "rejected", "message": <the reject message> } }`, or `:body` when given |
349
- | A failed [`ValidateSchema` step](#validating-data-as-a-routine-step) (with `throwOnInvalid` on) | `400` | `{ "error": { "code": "invalid_request", "message": <names the failing path> } }` |
350
- | The `verify` request did not pass | `401` | `{ "error": { "code": "unauthorized", "message": "Webhook verification failed." } }` |
351
- | Any other uncaught error | `500` | `{ "error": { "code": "internal_error", "message": "Webhook failed." } }`, with nothing from the error itself |
410
+ | Outcome | Status | Body |
411
+ | ----------------------------------------------------------------------------------------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------- |
412
+ | The routine finished | `200` | Its `:return` value, or `{ "ok": true }` when it returned nothing |
413
+ | A [`:return`](/:return) with `:content_type: text/plain` | `200` | The returned string as plain text (see [Answering with plain text](#answering-with-plain-text)) |
414
+ | A [`:reject`](/:reject) with `:status` | That status (400 to 499) | `:body` as given, or the error body below |
415
+ | A [`:reject`](/:reject) without `:status` | `400` | `{ "error": { "code": "rejected", "message": <the reject message> } }`, or `:body` when given |
416
+ | A failed [`ValidateSchema` step](#validating-data-as-a-routine-step) (with `throwOnInvalid` on) | `400` | `{ "error": { "code": "invalid_request", "message": <names the failing path> } }` |
417
+ | The `verify` request did not pass | `401` | `{ "error": { "code": "unauthorized", "message": "Webhook verification failed." } }` |
418
+ | Any other uncaught error | `500` | `{ "error": { "code": "internal_error", "message": "Webhook failed." } }`, with nothing from the error itself |
352
419
 
353
- A `:reject` or a failed `ValidateSchema` step in an endpoint the routine calls with `CallApi` sets the answer the same way, so the work can live in an `InternalApi` endpoint the webhook calls. `:status` and `:body` are accepted only on a `:reject` in a webhook endpoint or an `InternalApi` endpoint; on any other endpoint they are a build error. An error a `:catch` handles does not change the answer. A `:reject` is never caught, so it always sets it.
420
+ A `:reject` or a failed `ValidateSchema` step in an endpoint the routine calls with `CallApi` sets the answer the same way, so the work can live in an `InternalApi` endpoint the webhook calls. `:status` and `:body` are accepted only on a `:reject` in a webhook endpoint or an `InternalApi` endpoint (and `:status` alone in a [link endpoint](#link-endpoints)); on any other endpoint they are a build error. An error a `:catch` handles does not change the answer. A `:reject` is never caught, so it always sets it.
354
421
 
355
422
  ```yaml
356
423
  id: support-tickets
@@ -1168,7 +1235,7 @@ blocks:
1168
1235
  Here's a comprehensive example showing various features:
1169
1236
 
1170
1237
  ```yaml
1171
- lowdefy: '7.0.0'
1238
+ lowdefy: '7.1.0'
1172
1239
  auth:
1173
1240
  api:
1174
1241
  protected: true
@@ -55,6 +55,8 @@ The config object has the following properties:
55
55
  - `basePath: string`: Set the base path to serve the Lowdefy application from. This will route all pages under `https://example.com/<base-path>/<page-id>` instead of the default `https://example.com/<page-id>`. The basePath value must start with "/".
56
56
  - `homePageId: string`: The id of the page that will load when a visitor navigates to the home route, in other words, when the visitor navigates to `yourdomain.com` or `yourdomain.com/`. The home page cannot have placeholders in its [`path`](/page-paths).
57
57
  - `dependencyTracking: boolean`: Defaults to `true`. The browser re-evaluates only the blocks whose inputs changed (the state paths, requests and globals their operators read) instead of every block on the page after each change. Set to `false` to evaluate every block on every update, as earlier versions did.
58
+ - `experimental: object`: Opt in to features that are not yet stable. An experimental feature may change, or be removed, in a minor release. The build fails on a key it does not know.
59
+ - `mobile: boolean`: Build the `mobile` section, so the app runs as a native iOS and Android app, and allow `offline` on requests. Defaults to `false`. See [Mobile Apps](/mobile-apps).
58
60
  - `requestTimeout: number`: Maximum time in milliseconds a request may run before the server returns a timeout. This protects against requests that hang on an upstream call (database, SMTP, an external API) running all the way to the host's function limit — important on serverless platforms that bill by execution duration. Defaults to `30000` (30 seconds). Set to `0` to disable. Agent streaming routes are exempt, since they are long-lived by design.
59
61
  - `security: object`: Opt-in browser security settings. See [Security](#security) below.
60
62
  - `contentSecurityPolicy: boolean | object`: Send a Content-Security-Policy header with app pages. Set `true` for the default policy, or an object with:
@@ -170,6 +172,14 @@ The plugins section is used to configure which plugin packages should be used in
170
172
  - `version: string`: An npm or pnpm version specifier of the package to use.
171
173
  - `typePrefix: string`: A prefix to append to all types exported by the package to prevent type name clashes.
172
174
 
175
+ A phone app's shell lists the plugins that add native code to it under `mobile.shells[].plugins`, each at an exact version. A package in both lists must have the same version. See [Shell plugins](/cli#shell-plugins).
176
+
177
+ ## Mobile
178
+
179
+ > **Experimental.** The `mobile` section builds only when `config.experimental.mobile` is `true`.
180
+
181
+ The `mobile` section declares the pages, menus, home page, app events and shells a native iOS and Android app shows. See [Mobile Apps](/mobile-apps).
182
+
173
183
  ## Menus
174
184
 
175
185
  Menu objects describe links to pages, within the app or external. Menu lists are filtered to only show pages that the user is authorized to see as a result of public, private or [role based access controlled (RBAC)](/roles) pages. Blocks such as [PageSiderMenu](/PageSiderMenu) render menu links. If no menu defined, a default menu is created, containing links to all pages defined in the app.
@@ -395,6 +405,7 @@ Every build error or warning from a check that the build prints shows its slug a
395
405
  | `websocket-refs` | Invalid websocket action reference warnings |
396
406
  | `callmethod-refs` | CallMethod actions targeting blocks not defined on the page |
397
407
  | `icons` | Unresolvable icon name warnings |
408
+ | `native-ignored` | Properties set on a mobile page that the native block ignores |
398
409
  | `types` | All type validation (blocks, operators, actions, requests, connections) |
399
410
  | `schema` | JSON schema validation errors |
400
411
  | `secrets` | Environment variable names that are not set in the build environment |
@@ -0,0 +1,110 @@
1
+ # Mobile Apps (Experimental)
2
+
3
+ :::warning
4
+ **Mobile apps are experimental.** Turn them on with `config.experimental.mobile: true`. The `mobile` section, the native blocks and actions, the `lowdefy mobile` commands and the phone flags of `lowdefy dev` may change, or be removed, in a minor release. They have run on the iOS simulator; Android devices and real store submissions are still being tested.
5
+ :::
6
+
7
+ A Lowdefy app can run on iPhones and Android phones as a native app. The phone app is a **shell**, built from `@lowdefy/shell` (Expo and React Native), that opens one Lowdefy app. It uses the same YAML, server, requests, API endpoints and auth as the web app. Pages for phones are declared under `mobile` in `lowdefy.yaml` and render with native blocks, which have the same names, properties and events as the web blocks.
8
+
9
+ ## Turn it on
10
+
11
+ ```yaml
12
+ lowdefy: 7.1.0
13
+
14
+ config:
15
+ experimental:
16
+ mobile: true
17
+ environments:
18
+ production:
19
+ url: https://app.example.com
20
+
21
+ mobile:
22
+ menus:
23
+ tabs:
24
+ - pageId: today
25
+ icon: CalendarDays
26
+ - pageId: settings
27
+ icon: Settings
28
+ pages:
29
+ - _ref: mobile/today.yaml
30
+ - _ref: mobile/settings.yaml
31
+ shells:
32
+ - id: main
33
+ name: Example
34
+ icon: assets/icon.png
35
+ version: '1.0'
36
+ profile: basic
37
+ ios:
38
+ bundleId: com.example.app
39
+ android:
40
+ package: com.example.app
41
+ ```
42
+
43
+ Without `config.experimental.mobile: true`, a `mobile` section, or `offline` on a request, fails the build:
44
+
45
+ ```
46
+ Mobile apps are experimental. Set "config.experimental.mobile: true" in lowdefy.yaml to build the "mobile" section.
47
+ ```
48
+
49
+ An app without a `mobile` section builds and runs exactly as before, with or without the flag.
50
+
51
+ ## The mobile section
52
+
53
+ - `pages: object[]`: The pages a phone shows. A page can be phone-only, or the same `_ref` as a web page (a shared page), which is built once for both. A page on a phone may only use the types a shell carries; the build names any other.
54
+ - `menus: object`: How the phone navigates. `tabs` (2 to 5 items, each `pageId`, `icon` or `sfSymbol`, `title`), a `drawer`, or `stack: true` for a single stack of pages.
55
+ - `homePageId: string`: The page the app opens on. Defaults to the first menu item, or else the first mobile page.
56
+ - `minShellVersion: string`: The oldest shell version that may open the app. An older shell shows an "update the app" screen.
57
+ - `events: object`: App events (`onInit`, `onInitAsync`) that run on phones, in place of the root `events`. See [App events on phones](/events-and-actions).
58
+ - `shells: object[]`: The native apps built from this app. Each has an `id`, `name`, `icon`, store `version`, a capability `profile`, optional `extensions`, and `ios`, `android` and `eas` settings. See [`lowdefy mobile`](/cli#mobile).
59
+ - `auth: object`: Phone sign-in settings, such as how long a phone's session lasts.
60
+ - `notifications`, `share`, `widgets`, `shortcuts`, `background`: Push notification categories and the endpoints that register a phone, the page shared items open, Home Screen widgets, app icon shortcuts and background fetch.
61
+
62
+ ## Capability profiles
63
+
64
+ A shell's `profile` fixes the native modules it carries, and so the permissions it asks for and what the store listing declares:
65
+
66
+ | Profile | Carries |
67
+ | --- | --- |
68
+ | `basic` | Native blocks, sign-in, biometric unlock, dictation, push and local notifications, haptics, share, Photos and Files pickers, read aloud, keep awake, icon shortcuts and background fetch. |
69
+ | `field` | `basic`, plus the camera (photos, codes, documents), location while in use, maps, voice notes and screen brightness. |
70
+ | `field-nfc` | `field`, plus reading and writing NFC tags. |
71
+ | `field-tracking` | `field`, plus location in the background and geofences. |
72
+
73
+ `extensions` add `share` (receive shared items), `widgets` (iOS widgets), `contacts` or `calendar` on top of a profile. A native action used on a shell that does not carry it fails with a message that names the profile it needs.
74
+
75
+ ## Offline requests
76
+
77
+ A request with `offline: queue` is kept on the phone while it has no signal, and sent in order when the signal comes back. The action resolves `{ queued: true, id }`. The payload is evaluated once, when the request is queued. The web ignores `offline`. It also needs `config.experimental.mobile: true`.
78
+
79
+ ```yaml
80
+ requests:
81
+ - id: save_note
82
+ type: MongoDBUpdateOne
83
+ connectionId: jobs
84
+ offline: queue
85
+ payload:
86
+ key:
87
+ _uuid: true
88
+ ```
89
+
90
+ ## Sign-in
91
+
92
+ Phones hold ordinary sessions of the app's auth, sent as bearer tokens. The default sign-in is a native email-code screen. Passkeys, SSO and two-factor sign-in open in the system browser sheet and return to the app. Sign-out removes everything the phone cached for that person.
93
+
94
+ ## Develop on a phone
95
+
96
+ - `lowdefy dev --ios` opens the app in Lowdefy Dev on an iPhone simulator (macOS with Xcode).
97
+ - `lowdefy dev --android` opens it on an Android emulator, or a phone connected by USB.
98
+ - `lowdefy dev --lan` lets a phone on the local network pair by QR code.
99
+
100
+ The [agent tools](/ai-agent-docs) take a `device` to screenshot, inspect and drive a phone. See [The CLI](/cli#dev).
101
+
102
+ ## Build and release
103
+
104
+ `lowdefy mobile config | build | submit | update | release | checklist` builds, submits and updates shells with [EAS](https://expo.dev/eas), from your own Expo, Apple and Google accounts. `release` builds and submits when native code changed, and sends an over-the-air update when only JavaScript changed. See [`lowdefy mobile`](/cli#mobile).
105
+
106
+ ## Not yet supported
107
+
108
+ - Android devices and real EAS store runs are not yet fully tested.
109
+ - Released builds of Lowdefy Dev. Until they ship, point `LOWDEFY_DEV_APP_IOS` or `LOWDEFY_DEV_APP_ANDROID` at a build.
110
+ - Offline reads (offline data), and Android widgets.
@@ -83,7 +83,7 @@ This example shows how you can create and read from `global`:
83
83
 
84
84
  `lowdefy.yaml`
85
85
  ```yaml
86
- lowdefy: 7.0.0
86
+ lowdefy: 7.1.0
87
87
  global:
88
88
  key: value
89
89
  pages:
@@ -101,7 +101,7 @@ The following examples shows how to modify the `global` object:
101
101
 
102
102
  `lowdefy.yaml`
103
103
  ```yaml
104
- lowdefy: 7.0.0
104
+ lowdefy: 7.1.0
105
105
  global:
106
106
  key: value
107
107
  pages:
@@ -7,7 +7,7 @@ Lowdefy uses the [Ant Design](https://ant.design/) design token system for themi
7
7
  Configure your app's theme in `lowdefy.yaml` under `theme.antd`:
8
8
 
9
9
  ```yaml
10
- lowdefy: 7.0.0
10
+ lowdefy: 7.1.0
11
11
  theme:
12
12
  antd:
13
13
  token:
@@ -64,7 +64,7 @@ Properties for a AxiosHttp can be set on either the connection, the request, or
64
64
  ###### A basic full example requesting data from https://jsonplaceholder.typicode.com
65
65
 
66
66
  ```yaml
67
- lowdefy: 7.0.0
67
+ lowdefy: 7.1.0
68
68
  name: Lowdefy starter
69
69
  connections:
70
70
  - id: my_api
@@ -680,9 +680,18 @@ The cells are written as unordered bulkWrites of 1000 cells, each write guarded
680
680
  queued: 2400 # cells queued, those waiting for an input column included
681
681
  skipped: 12 # selected cells the mode left alone (live, fresh or not matching)
682
682
  missingInputs: 3 # cells set to empty for a missing input
683
+ byColumn: # the same counts for each column run, summing to the totals
684
+ email: { queued: 1200, missingInputs: 3 }
685
+ pitch: { queued: 1200, missingInputs: 0 }
683
686
  runId: 66f9…
684
687
  ```
685
688
 
689
+ ##### Dry run
690
+
691
+ With `dryRun: true` the request reads and plans exactly as a run does (the same selection, mode, `maxCells`, `maxTimeMS` and tenant scope) and returns the counts the run would write, writing no cell and no change log record. The response is `{ dryRun: true, queued, missingInputs, skipped, byColumn }`, with no `runId`. Over `maxCells` it throws as a run would, so an app learns a run is too large before it asks.
692
+
693
+ Use it to confirm a run that costs money before it starts: in the run event, call the request with `dryRun: true`, show a confirm with each column's `queued` count times that column's provider cost, and on a yes call it again without `dryRun`. Cells can change between the two calls, so the run's own response, whose `byColumn` has the same shape, says what was queued.
694
+
686
695
  #### Properties
687
696
  - `columns: string[]`: __Required__ - The keys of the enrichment or ai columns to run.
688
697
  - `columnDefs: object[]`: __Required__ - The table columns, declared and user-defined merged.
@@ -692,6 +701,7 @@ runId: 66f9…
692
701
  - `filter: object`: The base filter every read and write is scoped by, for example `{ org_id: { _user: organization.id } }`. Required unless the connection is tenant-scoped. Set it to `{}` to run on every document.
693
702
  - `maxCells: integer`: Default: `10000` - The most cells one enqueue may write, queued and missing input cells together.
694
703
  - `maxTimeMS: integer`: Default: `30000` - The time limit of each read.
704
+ - `dryRun: boolean`: Default: `false` - Count the cells the run would queue and set empty, by column, and write nothing. See [Dry run](#dry-run).
695
705
  - `runId: string`: The `runId` the queued cells get, 1 to 64 letters, digits, `_` or `-`. Generated when left out.
696
706
  - `user: object`: The user that `{ $user: path }` values in a selection filter resolve from. Set it to `{ _user: true }`.
697
707
  - `timezone: string`: Default: `UTC` - The IANA time zone whose days the date filters of a selection compare.
@@ -1330,8 +1340,11 @@ groups: # only when view.group has more levels than groupPath
1330
1340
  aggregates: { amount: 125000 }
1331
1341
  aggregates: # only when view.aggregates is set, over the rows this request matches
1332
1342
  amount: 3400000
1343
+ sentence: Stage is any of Lead or Won # only when view.filter is set
1333
1344
  ```
1334
1345
 
1346
+ `sentence` is the filter in words, from the field `title` and `options` (`describeCondition` in `@lowdefy/helpers`). It reads the same as the Table's Filter button tooltip when each field carries its column's plain-text `title` and its options as `[{ value, label }]`; a field without a `title` reads as its key, where the Table shows the key humanized. An agent or a server routine that runs the request with no browser can then say what a saved view matches.
1347
+
1335
1348
  When `view.group` is set and `groupPath` is shorter than it, the request returns the groups of the next level, inside the groups in `groupPath`. When `groupPath` has a value for every level, it returns the leaf rows of that group.
1336
1349
 
1337
1350
  ##### Filters
@@ -1343,7 +1356,7 @@ The view `filter` is a condition: `{ and: [...] }`, `{ or: [...] }` or `{ key, o
1343
1356
  | all | `eq`, `ne`, `in`, `nin`, `empty`, `notEmpty` |
1344
1357
  | `text`, `email`, `phone`, `url`, `link`, `html`, `relation`, `tag`, `status`, `avatar` | `contains`, `notContains`, `startsWith`, `endsWith` |
1345
1358
  | `number`, `currency`, `percent`, `progress`, `rating` | `gt`, `gte`, `lt`, `lte`, `between` (`value: [from, to]`) |
1346
- | `date`, `datetime` | `before`, `after`, `between`, `within` (`value: { last or next: n, unit: day, week, month or year }`) |
1359
+ | `date`, `datetime` | `before`, `after`, `between`, `within` (`value: { last or next: n, unit: day, week, month or year }`); `before` and `after` take a date or the same relative value |
1347
1360
  | `boolean` | `isTrue`, `isFalse` |
1348
1361
  | `tags`, `people` | `contains` (has the value), `notContains` (does not have the value); `in` is has any of, `nin` is has none of |
1349
1362
  | `image`, `json` | the operators for all types only |
@@ -1353,6 +1366,7 @@ These are the operators the `Table` filter menus offer for each column type, so
1353
1366
  - Text comparisons are case-insensitive.
1354
1367
  - `empty` matches null, missing, `''` and `[]`.
1355
1368
  - `eq` and `ne` on dates compare whole days, and so do `before`, `after` and `between` on `date` fields. `within` covers whole days, from the start of the day `n` units ago to the end of today (or from the start of today to the end of the day `n` units ahead), as the table filters in the browser.
1369
+ - `before` and `after` with a relative value, such as `{ last: 3, unit: month }`, resolve when the query runs to the day it names in `timezone`: `before` matches values before the start of that day and `after` values from the end of it, on `date` and `datetime` fields alike. A bad relative value is refused with the message `within` gives.
1356
1370
  - Days are the days of `timezone`, UTC by default. The browser filters by the user's local days, so pass the user's time zone for day-based filters, for example `timezone: { _payload: timezone }` with `timezone: { _js: 'return Intl.DateTimeFormat().resolvedOptions().timeZone;' }` in the request `payload`. A date-only value such as `2026-03-01` (what `date` column filters send) is that day in the time zone. An instant is compared by the day it falls on there.
1357
1371
  - `isFalse` matches every value that is not `true`.
1358
1372
  - Numeric values may be numbers or numeric strings, and date values dates, date strings or timestamps.
@@ -1386,6 +1400,8 @@ A request over a limit throws before the query runs.
1386
1400
  - `sortable: boolean`: Default: `true` - Allow sorting by the field.
1387
1401
  - `filterable: boolean`: Default: `true` - Allow filtering by the field.
1388
1402
  - `groupable: boolean`: Default: `false` - Allow grouping by the field, and `countDistinct` on it. `tags` and `people` fields can not be grouped.
1403
+ - `title: string`: Default: the field key - The field's name in the response `sentence`, as the Table column's title.
1404
+ - `options: object[]`: The field's options as `[{ value, label }]`. The response `sentence` reads option values as their labels.
1389
1405
  - `pipeline: object[]`: Default: `[]` - Base aggregation stages that always run first, for example tenant scoping and a `$project`. `$out` and `$merge` are not allowed.
1390
1406
  - `view: object`: The Table view, `{ _payload: view }`. Only `sort`, `filter`, `search`, `group` and `aggregates` are read.
1391
1407
  - `startRow: integer`: Default: `0` - Index of the first row to return, `{ _payload: startRow }`.
@@ -1757,12 +1773,12 @@ The change event payload is available on `_event: messages` in `onMessage` and v
1757
1773
 
1758
1774
  ## Errors
1759
1775
 
1760
- When MongoDB rejects an operation, the request fails with a `ServiceError` that carries:
1776
+ When MongoDB rejects an operation, the request fails with a `RequestError` that carries:
1761
1777
 
1762
1778
  - `code` — the MongoDB error code, for example `11000` for a duplicate key.
1763
- - `message` — a plain sentence naming the collection and the request type, like `MongoDB: Duplicate key on collection "orders".`
1764
- - `hint` — a sentence saying what to do about it, for example to insert with `MongoDBUpdateOne` and `upsert: true`, to add an index covering the filter, or to grant the database user a role.
1779
+ - `message` — a plain sentence naming the collection and the request type, like `Duplicate key on collection "orders".`
1780
+ - `hint` — a sentence saying what to do about it, for example to insert with `MongoDBUpdateOne` and `upsert: true`, or to grant the database user a role.
1765
1781
 
1766
- The driver's own message is never sent to the browser — it can quote values from the document that triggered the error. It is logged on the server instead, where the dev server terminal prints it under the located error line as `Caused by: MongoServerError: E11000 …`.
1782
+ A time limit (codes `50` and `89`) or the aggregation memory limit (code `292`) is a `ServiceError` instead, with the same `code` and a `hint` such as adding an index covering the filter. Network, DNS and TLS failures are also `ServiceError`s, classified by the connection layer rather than by an error code. A `ServiceError` is an outage that can pass with time; a `RequestError` repeats until the request or the database changes.
1767
1783
 
1768
- Network, DNS and TLS failures are also `ServiceError`s, classified by the connection layer rather than by an error code.
1784
+ The driver's own message is never sent to the browser — it can quote values from the document that triggered the error. The dev server terminal prints it under the located error line as `Caused by: MongoServerError: E11000 …`.
@@ -11,7 +11,7 @@ Importantly, `:reject` does not trigger `:catch` blocks in [`:try`](/:try) state
11
11
  This makes `:reject` ideal for handling validation and business logic errors separately from system errors.
12
12
  Choose [`:throw`](/:throw) when a step failed and the routine may recover; choose `:reject` when the routine decided the request cannot be fulfilled.
13
13
 
14
- In a [webhook endpoint](/api#webhook-endpoints), `:status` and `:body` set the HTTP answer: the endpoint answers `:status` (an integer from 400 to 499, default 400) with `:body` sent as is. Without `:body`, the body is `{ "error": { "code": "rejected", "message": <the reject message> } }`. A `:reject` in an `InternalApi` endpoint the webhook calls with `CallApi` sets the answer the same way. On any other endpoint, `:status` and `:body` are a build error.
14
+ In a [webhook endpoint](/api#webhook-endpoints), `:status` and `:body` set the HTTP answer: the endpoint answers `:status` (an integer from 400 to 499, default 400) with `:body` sent as is. Without `:body`, the body is `{ "error": { "code": "rejected", "message": <the reject message> } }`. A `:reject` in an `InternalApi` endpoint the webhook calls with `CallApi` sets the answer the same way. In a [link endpoint](/api#link-endpoints), `:status` sets the status the link answers with, and `:body` is a build error, since a link answers with no body. On any other endpoint, `:status` and `:body` are a build error.
15
15
 
16
16
  `:reject` also takes an Error as its message, such as the error a `:catch` caught: `:reject: { _error: true }`. The reject message is then "Something went wrong.", unless the error was a `UserError` or an auth refusal (`AuthenticationError`, `AuthorizationError` or `TwoFactorEnrolmentRequiredError`), whose message is kept. To reject with the caught error's real message, name it: `:reject: { _error: message }`. See [`_error`](/_error).
17
17
 
@@ -19,7 +19,7 @@ In a [webhook endpoint](/api#webhook-endpoints), `:status` and `:body` set the H
19
19
 
20
20
  - `:reject: string | Error`: __Required__ - The error message that will be returned in the response object of the API call result, or an Error whose message to use.
21
21
  - `:cause: any`: Additional metadata that will be returned with the error message.
22
- - `:status: integer`: In a webhook endpoint, or an `InternalApi` endpoint a webhook calls, the HTTP status the webhook answers with, from 400 to 499. Defaults to 400.
22
+ - `:status: integer`: In a webhook or link endpoint, or an `InternalApi` endpoint one calls, the HTTP status the endpoint answers with, from 400 to 499. Defaults to 400.
23
23
  - `:body: any`: In a webhook endpoint, or an `InternalApi` endpoint a webhook calls, the body the webhook answers with, sent as is.
24
24
 
25
25
  #### Examples
@@ -121,6 +121,6 @@ Keep `config.requestTimeout` below `maxDuration`: when it is not, Vercel stops t
121
121
 
122
122
  On Vercel, only the request timeout cancels an AI model call a request is waiting on. A client that disconnects does not: the call runs until it finishes, reaches its own `timeout`, or hits the request timeout. On the Node server a disconnect cancels it too.
123
123
 
124
- > The function runs on Vercel's Node.js runtime. Streaming agent responses (`/api/agent/*`) are exempt from `config.requestTimeout` and are bounded only by `maxDuration` — for heavy streaming or agent workloads, a long-lived Node host (Docker, Fly.io, Railway, Render) may suit better. An agent run keeps running to the end when its client disconnects, so its work completes; a `GET` stream (such as an MCP client's notification stream) stops when its client goes, instead of holding the function until `maxDuration`.
124
+ > The function runs on Vercel's Node.js runtime. Streaming agent responses (`/api/agent/*`) are exempt from `config.requestTimeout` and are bounded only by `maxDuration` — for heavy streaming or agent workloads, a long-lived Node host (Docker, Fly.io, Railway, Render) may suit better. An agent run keeps running to the end when its client disconnects, so its work completes; a `GET` stream (such as an SSE feed) stops when its client goes, instead of holding the function until `maxDuration`. The MCP endpoint answers `GET` with 405, so an MCP client holds no stream open.
125
125
 
126
126
  All other Vercel configuration like domain names, preview deploy branches, serverless regions and redirects can be configured as desired.
@@ -1384,7 +1384,7 @@ Migrate the column-level checkbox flags in the same edit — `checkboxSelection`
1384
1384
  | `columnDefs.$.cell.zeroColor` | string | - | Number: CSS colour when value === 0 (requires `signColor: true`). |
1385
1385
  | `columnDefs.$.cell.color` | string | - | Number: CSS colour applied to all values (overridden by `signColor`). |
1386
1386
  | `columnDefs.$.cell.prefix` | string | - | Number: literal prefix (e.g. `Δ `, `~`). |
1387
- | `columnDefs.$.cell.align` | string | - | Cell horizontal alignment. Defaults to `right` for `cell.type: number`. Sets `cellStyle.justifyContent` and `ag-*-aligned-header` on the header. Enum: `left`, `center`, `right`. |
1387
+ | `columnDefs.$.cell.align` | string | - | Cell horizontal alignment. Defaults to `right` for `cell.type: number`. Sets `cellStyle.justifyContent`, `cellStyle.textAlign` and `ag-*-aligned-header` on the header. Enum: `left`, `center`, `right`. |
1388
1388
  | `columnDefs.$.cell.buttons` | array | - | Buttons cell: list of buttons rendered per row. Each button triggers its own block-level event (declared in `events:`). Per-button properties mirror the `Button` block schema. `*Field` variants (`titleField`, `iconField`, `disabledField`, `hiddenField`) are row-data paths. |
1389
1389
  | `columnDefs.$.cell.buttons.$.eventName` | string | - | Block-level event name to trigger on click. |
1390
1390
  | `columnDefs.$.cell.buttons.$.title` | string | - | Title text on the button - supports html. |