@lowdefy/docs-content 6.1.0 → 7.1.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.
- package/README.md +1 -0
- package/content/actions/downloadcsv.md +1 -1
- package/content/actions/emailotpsend.md +58 -0
- package/content/actions/emailotpverify.md +79 -0
- package/content/actions/getlocalstorage.md +43 -0
- package/content/actions/link.md +47 -1
- package/content/actions/login.md +25 -5
- package/content/actions/logout.md +7 -5
- package/content/actions/magiclinkverify.md +117 -0
- package/content/actions/pdfmake.md +2 -2
- package/content/actions/posthogalias.md +29 -0
- package/content/actions/posthogcapture.md +49 -0
- package/content/actions/posthogcapturepageleave.md +38 -0
- package/content/actions/posthogfeatureflag.md +50 -0
- package/content/actions/posthoggroup.md +37 -0
- package/content/actions/posthogidentify.md +54 -0
- package/content/actions/posthoginit.md +96 -0
- package/content/actions/posthogoptin.md +29 -0
- package/content/actions/posthogoptout.md +29 -0
- package/content/actions/posthogpageview.md +37 -0
- package/content/actions/posthogreloadfeatureflags.md +47 -0
- package/content/actions/posthogreset.md +28 -0
- package/content/actions/posthogsetpersonproperties.md +36 -0
- package/content/actions/removelocalstorage.md +28 -0
- package/content/actions/resetvalidation.md +7 -3
- package/content/actions/setdarkmode.md +3 -3
- package/content/actions/setglobal.md +2 -0
- package/content/actions/setlocale.md +1 -1
- package/content/actions/setlocalstorage.md +34 -0
- package/content/actions/validate.md +7 -4
- package/content/adapter-reference/mongodbauthadapter.md +46 -0
- package/content/agents/agent-endpoint-tools.md +24 -0
- package/content/agents/agent-properties.md +13 -3
- package/content/agents/agent-server-hooks.md +1 -1
- package/content/agents/agentchat.md +43 -7
- package/content/agents/agentconversations.md +42 -8
- package/content/agents/agents-introduction.md +107 -0
- package/content/callback-reference/auth0logoutcallback.md +54 -0
- package/content/concepts/ai-agent-docs.md +455 -106
- package/content/concepts/blocks.md +150 -0
- package/content/concepts/connections-and-requests.md +402 -0
- package/content/concepts/custom-html.md +42 -0
- package/content/concepts/custom-styling.md +50 -5
- package/content/concepts/dynamic-page-content.md +309 -0
- package/content/concepts/events-and-actions.md +154 -2
- package/content/concepts/four-primitives.md +31 -0
- package/content/concepts/html-attributes.md +293 -0
- package/content/concepts/i18n.md +8 -3
- package/content/concepts/keyboard-shortcuts.md +2 -2
- package/content/concepts/layout-overview.md +1 -1
- package/content/concepts/logger.md +99 -0
- package/content/concepts/lowdefy-api.md +1319 -0
- package/content/concepts/lowdefy-schema.md +136 -3
- package/content/concepts/menus.md +8 -7
- package/content/concepts/module-authoring.md +76 -5
- package/content/concepts/modules.md +3 -1
- package/content/concepts/notifications.md +180 -0
- package/content/concepts/operators.md +7 -0
- package/content/concepts/page-and-app-state.md +252 -0
- package/content/concepts/page-paths.md +209 -0
- package/content/concepts/theming.md +582 -0
- package/content/connections/aigateway.md +375 -0
- package/content/connections/anthropic.md +169 -2
- package/content/connections/awss3.md +178 -2
- package/content/connections/axioshttp.md +181 -0
- package/content/connections/google.md +169 -2
- package/content/connections/mongodb.md +1014 -3
- package/content/connections/openai-connection.md +169 -2
- package/content/connections/sendgridmail.md +2 -0
- package/content/connections/smtp.md +3 -1
- package/content/connections/treg.md +329 -0
- package/content/container-blocks/affix.md +47 -7
- package/content/container-blocks/alert.md +76 -24
- package/content/container-blocks/badge.md +100 -24
- package/content/container-blocks/box.md +9 -9
- package/content/container-blocks/card.md +132 -27
- package/content/container-blocks/carousel.md +60 -7
- package/content/container-blocks/collapse.md +153 -9
- package/content/container-blocks/configprovider.md +35 -13
- package/content/container-blocks/confirmmodal.md +69 -23
- package/content/container-blocks/content.md +62 -98
- package/content/container-blocks/descriptions.md +45 -4
- package/content/container-blocks/drawer.md +139 -28
- package/content/container-blocks/dropdownmenu.md +119 -31
- package/content/container-blocks/flex.md +40 -62
- package/content/container-blocks/footer.md +15 -11
- package/content/container-blocks/googlemapsheatmap.md +1 -1
- package/content/container-blocks/googlemapsscript.md +2 -2
- package/content/container-blocks/header.md +71 -36
- package/content/container-blocks/label.md +34 -7
- package/content/container-blocks/layout.md +52 -34
- package/content/container-blocks/masonry.md +17 -71
- package/content/container-blocks/mobilemenu.md +131 -88
- package/content/container-blocks/modal.md +161 -26
- package/content/container-blocks/pageheadermenu.md +138 -31
- package/content/container-blocks/pagesidebarlayout.md +230 -27
- package/content/container-blocks/pagesidermenu.md +153 -43
- package/content/container-blocks/popover.md +34 -31
- package/content/container-blocks/result.md +32 -21
- package/content/container-blocks/sider.md +85 -122
- package/content/container-blocks/span.md +7 -7
- package/content/container-blocks/spinner.md +3 -3
- package/content/container-blocks/splitter.md +150 -68
- package/content/container-blocks/tabs.md +64 -12
- package/content/container-blocks/tooltip.md +22 -46
- package/content/container-blocks/watermark.md +22 -4
- package/content/controls/parallel_for.md +21 -2
- package/content/controls/reject.md +24 -3
- package/content/controls/return.md +17 -1
- package/content/controls/throw.md +1 -0
- package/content/controls/try.md +4 -2
- package/content/controls/while.md +46 -0
- package/content/deployment/deployment-environments.md +10 -7
- package/content/deployment/docker.md +22 -7
- package/content/deployment/node-server.md +4 -0
- package/content/deployment/vercel.md +17 -6
- package/content/display-blocks/aggrid.md +36 -19
- package/content/display-blocks/anchor.md +16 -15
- package/content/display-blocks/avatar.md +57 -37
- package/content/display-blocks/breadcrumb.md +70 -21
- package/content/display-blocks/button.md +93 -19
- package/content/display-blocks/calendar.md +12 -0
- package/content/display-blocks/clickablehtml.md +239 -0
- package/content/display-blocks/dangeroushtml.md +1 -1
- package/content/display-blocks/difflist.md +1 -1
- package/content/display-blocks/difftimeline.md +1 -1
- package/content/display-blocks/divider.md +64 -3
- package/content/display-blocks/dropdownbutton.md +81 -30
- package/content/display-blocks/echart.md +35 -1
- package/content/display-blocks/eventlog.md +363 -0
- package/content/display-blocks/floatbutton.md +129 -42
- package/content/display-blocks/html.md +61 -1
- package/content/display-blocks/icon.md +250 -67
- package/content/display-blocks/img.md +2 -2
- package/content/display-blocks/menu.md +146 -73
- package/content/display-blocks/message.md +38 -124
- package/content/display-blocks/notification.md +94 -222
- package/content/display-blocks/paragraph.md +59 -9
- package/content/display-blocks/pollingtimer.md +263 -0
- package/content/display-blocks/progress.md +96 -17
- package/content/display-blocks/qrcode.md +19 -4
- package/content/display-blocks/s3download.md +1 -1
- package/content/display-blocks/search.md +19 -9
- package/content/display-blocks/skeletonbutton.md +1 -0
- package/content/display-blocks/skeletoninput.md +1 -0
- package/content/display-blocks/statistic.md +75 -17
- package/content/display-blocks/steps.md +58 -25
- package/content/display-blocks/table.md +2527 -0
- package/content/display-blocks/tablelight.md +621 -0
- package/content/display-blocks/tag.md +102 -17
- package/content/display-blocks/title.md +50 -11
- package/content/display-blocks/tour.md +33 -23
- package/content/input-blocks/autocomplete.md +81 -9
- package/content/input-blocks/buttonselector.md +45 -8
- package/content/input-blocks/captcha.md +40 -0
- package/content/input-blocks/checkboxselector.md +97 -7
- package/content/input-blocks/checkboxswitch.md +33 -3
- package/content/input-blocks/colorselector.md +63 -14
- package/content/input-blocks/daterangeselector.md +165 -45
- package/content/input-blocks/dateselector.md +139 -41
- package/content/input-blocks/datetimeselector.md +158 -49
- package/content/input-blocks/inputgallery.md +3 -3
- package/content/input-blocks/intentinput.md +207 -0
- package/content/input-blocks/monthselector.md +120 -52
- package/content/input-blocks/multipleselector.md +150 -39
- package/content/input-blocks/numberinput.md +98 -12
- package/content/input-blocks/pagination.md +70 -14
- package/content/input-blocks/paragraphinput.md +51 -37
- package/content/input-blocks/passwordinput.md +60 -6
- package/content/input-blocks/phonenumberinput.md +59 -26
- package/content/input-blocks/placesautocomplete.md +319 -0
- package/content/input-blocks/radioselector.md +83 -7
- package/content/input-blocks/ratingslider.md +57 -26
- package/content/input-blocks/s3uploadbutton.md +24 -24
- package/content/input-blocks/s3uploaddragger.md +3 -3
- package/content/input-blocks/s3uploadphoto.md +5 -5
- package/content/input-blocks/segmentedselector.md +72 -32
- package/content/input-blocks/selector.md +109 -21
- package/content/input-blocks/switch.md +65 -17
- package/content/input-blocks/tableinput.md +445 -0
- package/content/input-blocks/tagmultipleselector.md +114 -0
- package/content/input-blocks/tagselector.md +114 -0
- package/content/input-blocks/textarea.md +32 -3
- package/content/input-blocks/textinput.md +70 -29
- package/content/input-blocks/tiptapinput.md +1 -1
- package/content/input-blocks/tiptapmentioninput.md +2 -2
- package/content/input-blocks/titleinput.md +39 -12
- package/content/input-blocks/treeinput.md +49 -25
- package/content/input-blocks/treemultipleselector.md +127 -10
- package/content/input-blocks/treeselector.md +97 -9
- package/content/input-blocks/upload.md +64 -15
- package/content/input-blocks/uploaddragger.md +17 -1
- package/content/input-blocks/uploadphoto.md +18 -1
- package/content/input-blocks/weekselector.md +120 -55
- package/content/learn/introduction.md +27 -0
- package/content/learn/quickstart.md +53 -0
- package/content/list-blocks/controlledlist.md +24 -15
- package/content/list-blocks/list.md +11 -11
- package/content/list-blocks/masonrylist.md +7 -34
- package/content/migration/auth-upgrade.md +337 -0
- package/content/migration/upgrade-guide.md +1 -0
- package/content/migration/v3-to-v4.md +417 -0
- package/content/migration/v6-to-v7.md +620 -0
- package/content/operators/_agent.md +155 -0
- package/content/operators/_app.md +2 -1
- package/content/operators/_array.md +122 -1
- package/content/operators/_build.md +1 -0
- package/content/operators/_credential.md +57 -0
- package/content/operators/_cron.md +292 -0
- package/content/operators/_date.md +2 -0
- package/content/operators/_error.md +24 -1
- package/content/operators/_get.md +6 -6
- package/content/operators/_hmac.md +78 -0
- package/content/operators/_js.md +2 -1
- package/content/operators/_location.md +1 -1
- package/content/operators/_media.md +13 -0
- package/content/operators/_module.md +56 -2
- package/content/operators/_operator.md +17 -3
- package/content/operators/_path_params.md +82 -0
- package/content/operators/_ref.md +258 -0
- package/content/operators/_request.md +1 -1
- package/content/operators/_request_details.md +6 -0
- package/content/operators/_type.md +14 -3
- package/content/operators/_url_query.md +2 -0
- package/content/operators/_user.md +3 -3
- package/content/plugins/plugins-actions.md +10 -0
- package/content/plugins/plugins-connections.md +25 -0
- package/content/plugins/plugins-dev.md +66 -0
- package/content/plugins/plugins-icon-sets.md +267 -0
- package/content/plugins/plugins-introduction.md +27 -1
- package/content/plugins/plugins.md +19 -0
- package/content/plugins/posthog.md +359 -0
- package/content/provider-reference/auth-js-providers.md +107 -0
- package/content/provider-reference/openidconnectprovider.md +44 -0
- package/content/recipes/recipes.md +16 -0
- package/content/reference/actions-reference.md +31 -0
- package/content/reference/blocks-reference.md +35 -0
- package/content/reference/cli.md +403 -0
- package/content/reference/connections-reference.md +23 -0
- package/content/reference/operators-reference.md +47 -0
- package/content/reference/reference.md +16 -0
- package/content/reference/schema-reference.md +12 -0
- package/content/testing/config-tests.md +677 -0
- package/content/testing/e2e-configuration.md +31 -1
- package/content/testing/e2e-getting-started.md +1 -1
- package/content/testing/e2e-introduction.md +1 -1
- package/content/testing/e2e-writing-tests.md +12 -1
- package/content/testing/explore-pull-request.md +136 -0
- package/content/testing/journey-data-sets.md +326 -0
- package/content/tutorial/tutorial-actions-operators.md +2 -2
- package/content/tutorial/tutorial-add-blocks.md +2 -2
- package/content/tutorial/tutorial-create-page.md +48 -2
- package/content/tutorial/tutorial-display-data-page.md +3 -3
- package/content/tutorial/tutorial-requests-api.md +155 -0
- package/content/tutorial/tutorial-requests-sql.md +153 -0
- package/content/tutorial/tutorial-start.md +66 -1
- package/content/user-authentication/auth-configuration.md +267 -0
- package/content/user-authentication/auth-providers.md +24 -0
- package/content/user-authentication/auth-steps.md +141 -0
- package/content/user-authentication/login-and-logout.md +160 -8
- package/content/user-authentication/mcp-oauth.md +424 -0
- package/content/user-authentication/organizations.md +246 -0
- package/content/user-authentication/protected-pages-apis.md +97 -0
- package/content/user-authentication/roles.md +49 -0
- package/content/user-authentication/two-factor.md +229 -0
- package/content/user-authentication/user-object.md +58 -0
- package/content/user-authentication/users-introduction.md +8 -0
- package/content/websockets/websocket-publish.md +105 -0
- package/content/websockets/websocket-subscriptions.md +136 -0
- package/content/websockets/websockets-introduction.md +101 -0
- package/hazards.json +44 -0
- package/index.json +3691 -14
- package/package.json +11 -1
- package/scripts/collectImportedFiles.js +80 -0
- package/scripts/extractAgentDocs.js +41 -30
- package/scripts/hashDocSources.js +38 -0
- package/scripts/isRedirectPage.js +26 -0
- package/scripts/recordSourceHashes.js +100 -0
- package/scripts/resolvePageSections.js +42 -0
- package/scripts/sectionKind.js +27 -0
- package/content/concepts/cli.md +0 -223
- package/content/other/introduction.md +0 -39
- package/content/other/next-auth-providers.md +0 -3
- /package/content/{other → actions}/updatesession.md +0 -0
|
@@ -15,7 +15,7 @@ The generated Dockerfile:
|
|
|
15
15
|
```text
|
|
16
16
|
# syntax=docker/dockerfile:1
|
|
17
17
|
|
|
18
|
-
FROM node:
|
|
18
|
+
FROM node:24-slim AS builder
|
|
19
19
|
|
|
20
20
|
WORKDIR /lowdefy
|
|
21
21
|
|
|
@@ -41,7 +41,7 @@ RUN --mount=type=cache,id=pnpm,target=/pnpm/store \
|
|
|
41
41
|
&& npx lowdefy@"$LOWDEFY_VERSION" build \
|
|
42
42
|
&& npx lowdefy@"$LOWDEFY_VERSION" docker-output
|
|
43
43
|
|
|
44
|
-
FROM node:
|
|
44
|
+
FROM node:24-slim AS runner
|
|
45
45
|
|
|
46
46
|
ENV NODE_ENV=production
|
|
47
47
|
ENV PORT=3000
|
|
@@ -93,7 +93,7 @@ Key properties of this setup:
|
|
|
93
93
|
- **Fast rebuilds**: the pnpm store is kept in a BuildKit cache mount, so changing app config only re-downloads dependencies that actually changed.
|
|
94
94
|
- **Small runtime image**: `docker-output` traces the server's real import graph and copies only what the server loads at runtime — a fraction of the installed `node_modules`, since the client-side block packages are already compiled into `dist/client` and never imported by the server.
|
|
95
95
|
- **Non-root**: the server runs as the `node` user built into the official Node.js images.
|
|
96
|
-
- For stronger supply-chain guarantees, pin the base images by digest (`node:
|
|
96
|
+
- For stronger supply-chain guarantees, pin the base images by digest (`node:24-slim@sha256:...`) and let a bot like Renovate or Dependabot keep the digest updated.
|
|
97
97
|
|
|
98
98
|
### Health checks
|
|
99
99
|
|
|
@@ -124,7 +124,7 @@ The server is configured entirely through environment variables at runtime — t
|
|
|
124
124
|
| `LOWDEFY_SECRET_*` | App secrets, accessed with the [`_secret`](/_secret) operator. |
|
|
125
125
|
| `AUTH_SECRET` | Required when using [Lowdefy Auth](/users-introduction). |
|
|
126
126
|
| `LOWDEFY_ENVIRONMENT` | Read at build time: the environment this image is built for, one of `config.environments`. |
|
|
127
|
-
| `
|
|
127
|
+
| `BETTER_AUTH_URL` | The app's canonical origin for auth links and the MCP resource URIs. Defaults to the `url` of the current environment in `config.environments`. The server refuses to start without one of the two when `auth.email` is configured. Set it when a proxy terminates TLS in front of the container: without it, auth trusts only the origin the request reached the server on (`http://…`), and refuses sign-in from the `https://` page. |
|
|
128
128
|
| `CRON_SECRET` | Bearer token protecting `/api/cron/*` and `/api/detached/*` endpoints. |
|
|
129
129
|
| `LOWDEFY_LOG_LEVEL` | Server log level: `debug`, `info` (default), `warn`, `error`. |
|
|
130
130
|
| `SENTRY_DSN` | Enables Sentry error reporting when set. |
|
|
@@ -148,6 +148,21 @@ RUN --mount=type=secret,id=sentry,env=SENTRY_AUTH_TOKEN \
|
|
|
148
148
|
npx lowdefy@"$LOWDEFY_VERSION" build
|
|
149
149
|
```
|
|
150
150
|
|
|
151
|
+
### Behind a reverse proxy
|
|
152
|
+
|
|
153
|
+
The server takes each request's client address from its connection. Auth rate limits count attempts per client address (for example 3 sign-in attempts per 10 seconds), sessions record it, and the request log writes it as `client_address`. `X-Forwarded-For` is not read by default, because any client can send it.
|
|
154
|
+
|
|
155
|
+
Behind a reverse proxy, load balancer or ingress, every connection comes from the proxy, so every client would share its address and its rate limits. List the proxy addresses, or CIDR ranges, in `config.trustedProxies`:
|
|
156
|
+
|
|
157
|
+
```yaml
|
|
158
|
+
config:
|
|
159
|
+
trustedProxies:
|
|
160
|
+
- 10.0.0.0/8
|
|
161
|
+
- 172.16.0.0/12
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
When a request's connection comes from a trusted proxy, the server reads `X-Forwarded-For` from the right, skips every trusted hop, and takes the first address that is not trusted. Entries further left were written by the client and are ignored. Do not list `0.0.0.0/0` or `::/0`: they trust every address, so any client could choose its own, and the build warns about them. The proxy must append to `X-Forwarded-For` (nginx: `proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;`). The server logs a warning the first time a request carries `X-Forwarded-For` while `trustedProxies` is not set.
|
|
165
|
+
|
|
151
166
|
### Logging
|
|
152
167
|
|
|
153
168
|
The server writes structured JSON logs (one JSON object per line, via [pino](https://getpino.io)) to stdout — the format container platforms and log collectors (CloudWatch, Loki, Datadog, etc.) expect. Nothing is written to files inside the container.
|
|
@@ -188,7 +203,7 @@ The container inherits the Dockerfile `HEALTHCHECK`, so `docker compose ps` repo
|
|
|
188
203
|
docker compose up --build
|
|
189
204
|
```
|
|
190
205
|
|
|
191
|
-
If you set a container memory limit, Node.js
|
|
206
|
+
If you set a container memory limit, Node.js 24+ sizes its heap from the container's cgroup limit automatically. To control it explicitly, set `NODE_OPTIONS=--max-old-space-size=<MiB>` a comfortable margin below the container limit.
|
|
192
207
|
|
|
193
208
|
### Config files or plugins outside the config directory
|
|
194
209
|
|
|
@@ -199,7 +214,7 @@ Sometimes files outside of the config directory need to be accessed by the Lowde
|
|
|
199
214
|
```text
|
|
200
215
|
# syntax=docker/dockerfile:1
|
|
201
216
|
|
|
202
|
-
FROM node:
|
|
217
|
+
FROM node:24-slim AS builder
|
|
203
218
|
|
|
204
219
|
WORKDIR /lowdefy
|
|
205
220
|
|
|
@@ -217,7 +232,7 @@ RUN --mount=type=cache,id=pnpm,target=/pnpm/store \
|
|
|
217
232
|
&& npx lowdefy@"$LOWDEFY_VERSION" build --config-directory ./app \
|
|
218
233
|
&& npx lowdefy@"$LOWDEFY_VERSION" docker-output --config-directory ./app
|
|
219
234
|
|
|
220
|
-
FROM node:
|
|
235
|
+
FROM node:24-slim AS runner
|
|
221
236
|
|
|
222
237
|
ENV NODE_ENV=production
|
|
223
238
|
ENV PORT=3000
|
|
@@ -22,6 +22,10 @@ from inside the folder, or `pnpm start`. The server listens on `PORT` (default 3
|
|
|
22
22
|
|
|
23
23
|
Always run the build before restarting the server — the server reads the client asset manifest once at startup.
|
|
24
24
|
|
|
25
|
+
With `auth.email` configured, the server needs the app's canonical origin — `BETTER_AUTH_URL`, or the `url` of the current environment in `config.environments` — or it refuses to start, so emailed auth links cannot take their host from a request. To test the production server locally, set `BETTER_AUTH_URL=http://localhost:3000`.
|
|
26
|
+
|
|
27
|
+
Behind a reverse proxy or load balancer, list its addresses in `config.trustedProxies` so auth rate limits count each client, not the proxy. See [Behind a reverse proxy](/docker#behind-a-reverse-proxy).
|
|
28
|
+
|
|
25
29
|
### Alternative
|
|
26
30
|
|
|
27
31
|
An alternative option would be to make use of [Docker](./docker) to deploy the app. Docker has a few advantages, including scalability, application portability, version control and deployment speed, amoung others.
|
|
@@ -27,14 +27,17 @@ In the Vercel project:
|
|
|
27
27
|
- Eg: if `lowdefy.yaml` is at the top level of the repository, set the root directory to `deploy`; if it is in `apps/app_name`, set it to `apps/app_name/deploy`.
|
|
28
28
|
- **Install Command:** `bash vercel.install.sh`. Leave the **Build Command** to `vercel.json` (do not override it in the dashboard). There is no **Output Directory** setting — the build emits `.vercel/output`, which Vercel detects automatically.
|
|
29
29
|
- Enable **"Include files outside the root directory in the Build Step"** — the Lowdefy config usually lives in the parent of `deploy/`.
|
|
30
|
+
- **Node.js Version:** `24.x` or newer. The install and build steps run the Lowdefy CLI, which requires Node.js 24; the function itself runs on the `nodejs24.x` runtime set in the generated Build Output.
|
|
30
31
|
|
|
31
32
|
###### Public files
|
|
32
33
|
|
|
33
|
-
Files in your app's `public/` directory (favicon, icons, images, `manifest.webmanifest`, etc.) are copied into `dist/client` by Vite during the build, placed in `.vercel/output/static`, and served by the Vercel CDN — no extra configuration needed.
|
|
34
|
+
Files in your app's `public/` directory (favicon, icons, images, `manifest.webmanifest`, etc.) are copied into `dist/client` by Vite during the build, placed in `.vercel/output/static`, and served by the Vercel CDN — no extra configuration needed. With `config.basePath` set, they are placed and served under the base path, as are the generated cron paths below.
|
|
34
35
|
|
|
35
36
|
###### Secrets and environment variables
|
|
36
37
|
|
|
37
|
-
Secrets can be set in the Environment Variables settings section by creating environment variables prefixed with `LOWDEFY_SECRET_`.
|
|
38
|
+
Secrets can be set in the Environment Variables settings section by creating environment variables prefixed with `LOWDEFY_SECRET_`. Pin the auth canonical URL with the current environment's `url` (see [Deployment environments](/deployment-environments)) or `BETTER_AUTH_URL`; with `auth.email` configured the app refuses to start without it. Different secrets can be set for production and preview deployments.
|
|
39
|
+
|
|
40
|
+
On Vercel the client address used by auth rate limits, sessions and request logs comes from the platform (`x-real-ip`), which Vercel sets on every request. `config.trustedProxies` is not used.
|
|
38
41
|
|
|
39
42
|
###### Function settings
|
|
40
43
|
|
|
@@ -82,11 +85,15 @@ Each schedule becomes a cron job pointing at `/api/cron/<endpointId>`. When it f
|
|
|
82
85
|
|
|
83
86
|
###### Deployment environments
|
|
84
87
|
|
|
85
|
-
Declare the app's environments once under `config.environments` and name the current one with the `LOWDEFY_ENVIRONMENT` Environment Variable — see [Deployment environments](/deployment-environments) for every setting (URL, crons, email, Sentry, feature switches, guards). On Vercel, add `LOWDEFY_ENVIRONMENT` to each Vercel environment (for example `prod` on Production and `staging` on the staging branch's Preview environment). Vercel Environment Variables are available at build time, which is when Lowdefy reads it and checks guards.
|
|
88
|
+
Declare the app's environments once under `config.environments` and name the current one with the `LOWDEFY_ENVIRONMENT` Environment Variable — see [Deployment environments](/deployment-environments) for every setting (URL, crons, email, Sentry, PostHog, feature switches, guards). On Vercel, add `LOWDEFY_ENVIRONMENT` to each Vercel environment (for example `prod` on Production and `staging` on the staging branch's Preview environment). Vercel Environment Variables are available at build time, which is when Lowdefy reads it and checks guards.
|
|
89
|
+
|
|
90
|
+
###### Sentry
|
|
91
|
+
|
|
92
|
+
With `SENTRY_DSN` set, the function reports server errors to Sentry but does not trace requests, unless `logger.sentry.serverTracing` is `true`: tracing adds to every cold start, and the function stays billed after each response while a sampled transaction uploads. A request that captures no error ends as soon as its response is sent. See [Logger](/logger).
|
|
86
93
|
|
|
87
94
|
###### Crons for staging and other environments
|
|
88
95
|
|
|
89
|
-
Vercel fires cron jobs only on the **production** deployment — a staging or preview deployment never runs its schedules on its own. Give an environment a `cron.secret` and the environment Vercel fires crons on registers that environment's schedules too; when one fires, production forwards it to that environment's own `/api/cron/<endpointId>` at its `url` and answers Vercel immediately (the ping is fire-and-forget, kept alive via the request context and bounded by `maxDuration`; its outcome is logged as `forward_scheduled_endpoint_done` / `_failed`).
|
|
96
|
+
Vercel fires cron jobs only on the **production** deployment — a staging or preview deployment never runs its schedules on its own. Give an environment a `cron.secret` and the environment Vercel fires crons on registers that environment's schedules too; when one fires, production forwards it to that environment's own `/api/cron/<endpointId>` at its `url` (under `config.basePath` when one is set) and answers Vercel immediately (the ping is fire-and-forget, kept alive via the request context and bounded by `maxDuration`; its outcome is logged as `forward_scheduled_endpoint_done` / `_failed`).
|
|
90
97
|
|
|
91
98
|
- **Forwarded environments:** an environment with a `cron.secret` is forwarded to, so it must have a `url`. `cron.secret` is the **name** of the Lowdefy secret holding that environment's own `CRON_SECRET` — a plain string such as `STAGING_CRON_SECRET`, not `{ _secret: ... }`: environment settings are resolved at build time, and the forward route reads the value at runtime from `LOWDEFY_SECRET_<name>`. Set `cron.enabled: false` on an environment to register no crons for it.
|
|
92
99
|
- **Secrets on production:** for each forwarded environment add an Environment Variable `LOWDEFY_SECRET_<secret name>` (for example `LOWDEFY_SECRET_STAGING_CRON_SECRET`) to the production deployment, with that environment's `CRON_SECRET` as value. The forward route `/api/cron-forward/*` itself is secured by production's own `CRON_SECRET` like every cron route, and fails closed when the environment's secret is missing.
|
|
@@ -107,9 +114,13 @@ See [Async Endpoints](/lowdefy-api) and [Detached Endpoint Calls](/lowdefy-api)
|
|
|
107
114
|
|
|
108
115
|
Vercel Fluid bills by execution duration, so a request that hangs (a stuck database, SMTP or external API call) is a real cost risk. Two guardrails apply:
|
|
109
116
|
|
|
110
|
-
- **`config.requestTimeout`** (in `lowdefy.yaml`, default `30000` ms) — the server returns a timeout instead of letting a request run on. Set to `0` to disable. Agent streaming routes are exempt.
|
|
117
|
+
- **`config.requestTimeout`** (in `lowdefy.yaml`, default `30000` ms) — the server returns a timeout instead of letting a request run on, and cancels the AI model calls the request was waiting on. Set to `0` to disable. Agent streaming routes are exempt.
|
|
111
118
|
- **`config.vercel.maxDuration`** (default `60`) — a hard platform cap; Vercel stops the function at this many seconds. See Function settings above.
|
|
112
119
|
|
|
113
|
-
|
|
120
|
+
Keep `config.requestTimeout` below `maxDuration`: when it is not, Vercel stops the function before the request timeout answers, so the upstream calls the request left running are not cancelled and the request ends without a logged timeout. The build warns when `config.requestTimeout` is not shorter than `maxDuration` (or than the 60-second default, when it runs on Vercel).
|
|
121
|
+
|
|
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
|
+
|
|
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`.
|
|
114
125
|
|
|
115
126
|
All other Vercel configuration like domain names, preview deploy branches, serverless regions and redirects can be configured as desired.
|
|
@@ -410,7 +410,7 @@ Migrate the column-level checkbox flags in the same edit — `checkboxSelection`
|
|
|
410
410
|
assignee: Diana
|
|
411
411
|
priority: Low
|
|
412
412
|
status: To Do
|
|
413
|
-
- task: Code review PR
|
|
413
|
+
- task: "Code review PR #42"
|
|
414
414
|
assignee: Erik
|
|
415
415
|
priority: Medium
|
|
416
416
|
status: In Progress
|
|
@@ -1064,20 +1064,25 @@ Migrate the column-level checkbox flags in the same edit — `checkboxSelection`
|
|
|
1064
1064
|
Archived: default
|
|
1065
1065
|
- headerName: Actions
|
|
1066
1066
|
field: _id
|
|
1067
|
-
width:
|
|
1067
|
+
width: 300
|
|
1068
1068
|
cell:
|
|
1069
1069
|
type: buttons
|
|
1070
1070
|
buttons:
|
|
1071
1071
|
- eventName: onEditClick
|
|
1072
1072
|
title: Edit
|
|
1073
|
-
icon:
|
|
1073
|
+
icon: edit
|
|
1074
1074
|
type: primary
|
|
1075
1075
|
- eventName: onDeleteClick
|
|
1076
1076
|
title: Delete
|
|
1077
|
-
icon:
|
|
1077
|
+
icon: delete
|
|
1078
1078
|
danger: true
|
|
1079
1079
|
disabledField: locked
|
|
1080
1080
|
hiddenField: archived
|
|
1081
|
+
- eventName: onOpenClick
|
|
1082
|
+
title: Open
|
|
1083
|
+
icon: arrow-right
|
|
1084
|
+
iconPlacement: end
|
|
1085
|
+
type: link
|
|
1081
1086
|
rowData:
|
|
1082
1087
|
- _id: TSK-001
|
|
1083
1088
|
name: Wire main switchboard
|
|
@@ -1112,6 +1117,14 @@ Migrate the column-level checkbox flags in the same edit — `checkboxSelection`
|
|
|
1112
1117
|
_string.concat:
|
|
1113
1118
|
- "Delete "
|
|
1114
1119
|
- _event: row.name
|
|
1120
|
+
onOpenClick:
|
|
1121
|
+
- id: open_msg
|
|
1122
|
+
type: DisplayMessage
|
|
1123
|
+
params:
|
|
1124
|
+
content:
|
|
1125
|
+
_string.concat:
|
|
1126
|
+
- "Open "
|
|
1127
|
+
- _event: row._id
|
|
1115
1128
|
```
|
|
1116
1129
|
|
|
1117
1130
|
```yaml
|
|
@@ -1307,6 +1320,7 @@ Migrate the column-level checkbox flags in the same edit — `checkboxSelection`
|
|
|
1307
1320
|
| `themeParams` | object | - | AG Grid Theming API parameters merged onto this block's theme, for per-grid overrides. Keys are AG Grid param names, e.g. `headerBackgroundColor`, `rowHoverColor`, `borderColor`. Values are CSS strings and may reference antd tokens, e.g. `var(--ant-color-primary)`. An unrecognised param name has no effect — neither Lowdefy nor AG Grid validates the names — so check spelling against AG Grid's theming parameter reference. |
|
|
1308
1321
|
| `height` | number \| string | `"auto"` | Specify table height explicitly, in pixel. |
|
|
1309
1322
|
| `rowData` | array | - | The list of data to display on the table. |
|
|
1323
|
+
| `quickFilterValue` | string | - | Show only rows with a cell containing this text. Bind it to state to drive a search box; the `setQuickFilter` method does the same imperatively. |
|
|
1310
1324
|
| `rowId` | string | - | The data field to use in `getRowId` which results in Row Selection being maintained across Row Data changes (assuming the Row exists in both sets). See Ag Grid docs for more details (https://www.ag-grid.com/react-data-grid/data-update-row-data/). |
|
|
1311
1325
|
| `enableBrowserTooltips` | boolean | `false` | Set to `true` to use the browser native `title` attribute tooltips instead of AG Grid's styled tooltip component. |
|
|
1312
1326
|
| `suppressCellFocus` | boolean | `true` | When `true` (default), clicking a cell does not draw the AG Grid cell-focus border. Set to `false` to enable spreadsheet-style cell focus and keyboard navigation. |
|
|
@@ -1316,18 +1330,18 @@ Migrate the column-level checkbox flags in the same edit — `checkboxSelection`
|
|
|
1316
1330
|
| `columnDefs` | array | - | A list of properties for each column. |
|
|
1317
1331
|
| `columnDefs.$.field` | string | - | The field of the row object to get the cell's data from. Deep references into a row object is supported via dot notation, i.e 'address.firstLine'. |
|
|
1318
1332
|
| `columnDefs.$.headerName` | string | - | The name to render in the column header. If not specified and field is specified, the field name will be used as the header name. |
|
|
1319
|
-
| `columnDefs.$.filter` | boolean | `false` | Filter
|
|
1333
|
+
| `columnDefs.$.filter` | boolean \| string | `false` | Filter to use for this column. Set to `true` to use the default filter, or name a provided filter: `agTextColumnFilter`, `agNumberColumnFilter` or `agDateColumnFilter`. `agSetColumnFilter` and `agMultiColumnFilter` need AG Grid Enterprise, which this block does not include. Enum: `true`, `false`, `agTextColumnFilter`, `agNumberColumnFilter`, `agDateColumnFilter`. |
|
|
1320
1334
|
| `columnDefs.$.sortable` | boolean | `false` | Set to true to allow sorting on this column. |
|
|
1321
1335
|
| `columnDefs.$.resizable` | boolean | `false` | Set to true to allow this column should be resized. |
|
|
1322
1336
|
| `columnDefs.$.width` | number | - | Initial width in pixels for the cell. |
|
|
1323
|
-
| `columnDefs.$.cellStyle` |
|
|
1324
|
-
| `columnDefs.$.cellRenderer` | object | - | Provide your own cell Renderer function (using the `_function` operator) for this column's cells
|
|
1337
|
+
| `columnDefs.$.cellStyle` | object | - | An object of css values returning an object of css values for a particular cell. |
|
|
1338
|
+
| `columnDefs.$.cellRenderer` | object \| string | - | Provide your own cell Renderer function (using the `_function` operator) for this column's cells, or name a registered cell renderer such as `agAnimateShowChangeCellRenderer`. |
|
|
1325
1339
|
| `columnDefs.$.valueFormatter` | object \| string | - | A function (using the `_function` operator) or expression to format a value, should return a string. Not used for CSV export or copy to clipboard, only for UI cell rendering. |
|
|
1326
1340
|
| `columnDefs.$.tooltipField` | string | - | The field of the row object to read the tooltip value from. When set, hovering a cell shows a tooltip with that value using the grid's default tooltip component. |
|
|
1327
1341
|
| `columnDefs.$.tooltipValueGetter` | object | - | Provide a function (using the `_function` operator) that returns the tooltip value for a cell. Overrides `tooltipField`. |
|
|
1328
|
-
| `columnDefs.$.tooltipComponent` | object | - | Provide a custom tooltip component. See AG Grid tooltip component docs (https://www.ag-grid.com/react-data-grid/component-tooltip/). |
|
|
1342
|
+
| `columnDefs.$.tooltipComponent` | object \| string | - | Provide a custom tooltip component, or the name of a component registered with the AG Grid `components` grid option. See AG Grid tooltip component docs (https://www.ag-grid.com/react-data-grid/component-tooltip/). |
|
|
1329
1343
|
| `columnDefs.$.ellipsis` | number | - | Line-clamp count for long text. Automatically enables `wrapText` and `autoHeight` and applies the `.lf-ellipsis-N` class (1–6). |
|
|
1330
|
-
| `columnDefs.$.cell` | object | - | Built-in cell renderer. Takes precedence over `cellRenderer` when `type` is set. Field-valued keys (e.g. `nameField`, `srcField`, `urlQuery.*`) are row-data paths. |
|
|
1344
|
+
| `columnDefs.$.cell` | object | - | Built-in cell renderer. Takes precedence over `cellRenderer` when `type` is set. Field-valued keys (e.g. `nameField`, `srcField`, `urlQuery.*`, `pathParams.*`) are row-data paths. |
|
|
1331
1345
|
| `columnDefs.$.cell.type` | string | - | The built-in renderer to use. Enum: `tag`, `avatar`, `link`, `date`, `boolean`, `progress`, `number`, `buttons`, `menu`, `selector`, `multipleSelector`, `switch`, `textInput`, `paragraphInput`. |
|
|
1332
1346
|
| `columnDefs.$.cell.colorMap` | object | - | Tag: map of cell value → color (antd tag color name or hex). Used when `cell.type: tag`. The cell value may be a single string or an array of strings; arrays render one tag per item. If neither `colorMap`, `colorFrom`, nor `default` is set, tag values are auto-coloured from a stable hash for consistency across rows. |
|
|
1333
1347
|
| `columnDefs.$.cell.colorFrom` | string | - | Tag: row-data path to a color value. Takes precedence over `colorMap`. |
|
|
@@ -1336,13 +1350,14 @@ Migrate the column-level checkbox flags in the same edit — `checkboxSelection`
|
|
|
1336
1350
|
| `columnDefs.$.cell.srcField` | string | - | Avatar: row-data path for the image src (optional). |
|
|
1337
1351
|
| `columnDefs.$.cell.idField` | string | - | Avatar: row-data path for an id used to seed initials colour. |
|
|
1338
1352
|
| `columnDefs.$.cell.shape` | string | - | Avatar shape. Defaults to `circle`. Enum: `circle`, `square`. |
|
|
1339
|
-
| `columnDefs.$.cell.link` | object | - | Avatar/Link: navigation config. Emits `onCellLink` on click. `pageId`/`href`/`back`/`home`/`newTab` are literal; `urlQuery` values are row-data paths. |
|
|
1353
|
+
| `columnDefs.$.cell.link` | object | - | Avatar/Link: navigation config. Emits `onCellLink` on click. `pageId`/`href`/`back`/`home`/`newTab` are literal; `urlQuery` and `pathParams` values are row-data paths. |
|
|
1340
1354
|
| `columnDefs.$.cell.pageId` | string | - | Link: target page id (literal). |
|
|
1341
1355
|
| `columnDefs.$.cell.href` | string | - | Link: literal href (overrides `pageId`). |
|
|
1342
1356
|
| `columnDefs.$.cell.back` | boolean | - | Link: navigate back. |
|
|
1343
1357
|
| `columnDefs.$.cell.home` | boolean | - | Link: navigate home. |
|
|
1344
1358
|
| `columnDefs.$.cell.newTab` | boolean | - | Link: open in a new tab. |
|
|
1345
1359
|
| `columnDefs.$.cell.urlQuery` | object | - | Link: query params. Each value is a row-data path. |
|
|
1360
|
+
| `columnDefs.$.cell.pathParams` | object | - | Link: values for the page path's placeholders. Each value is a row-data path. |
|
|
1346
1361
|
| `columnDefs.$.cell.labelField` | string | - | Link: row-data path for the visible label (falls back to cell value). |
|
|
1347
1362
|
| `columnDefs.$.cell.format` | string | - | Number: `number` (default), `currency`, `percent`, or `compact` (K/M/B). Date: dayjs format string (default `YYYY-MM-DD HH:mm`). |
|
|
1348
1363
|
| `columnDefs.$.cell.relative` | boolean | - | Date: render as relative time (e.g. "3 hours ago"). |
|
|
@@ -1365,7 +1380,7 @@ Migrate the column-level checkbox flags in the same edit — `checkboxSelection`
|
|
|
1365
1380
|
| `columnDefs.$.cell.negative` | string | `"minus"` | Number: how to render negative numbers — `minus` (default) or `parentheses` for accounting. Enum: `minus`, `parentheses`. |
|
|
1366
1381
|
| `columnDefs.$.cell.signColor` | boolean | `false` | Number: when true, positives use `positiveColor` (default success token), negatives use `negativeColor` (default error token). |
|
|
1367
1382
|
| `columnDefs.$.cell.positiveColor` | string | - | Number: CSS colour when value > 0 (requires `signColor: true`). |
|
|
1368
|
-
| `columnDefs.$.cell.negativeColor` | string | - | Number: CSS colour when value
|
|
1383
|
+
| `columnDefs.$.cell.negativeColor` | string | - | Number: CSS colour when value < 0 (requires `signColor: true`). |
|
|
1369
1384
|
| `columnDefs.$.cell.zeroColor` | string | - | Number: CSS colour when value === 0 (requires `signColor: true`). |
|
|
1370
1385
|
| `columnDefs.$.cell.color` | string | - | Number: CSS colour applied to all values (overridden by `signColor`). |
|
|
1371
1386
|
| `columnDefs.$.cell.prefix` | string | - | Number: literal prefix (e.g. `Δ `, `~`). |
|
|
@@ -1374,8 +1389,9 @@ Migrate the column-level checkbox flags in the same edit — `checkboxSelection`
|
|
|
1374
1389
|
| `columnDefs.$.cell.buttons.$.eventName` | string | - | Block-level event name to trigger on click. |
|
|
1375
1390
|
| `columnDefs.$.cell.buttons.$.title` | string | - | Title text on the button - supports html. |
|
|
1376
1391
|
| `columnDefs.$.cell.buttons.$.titleField` | string | - | Row-data path for the title. |
|
|
1377
|
-
| `columnDefs.$.cell.buttons.$.icon` | string \| object | - |
|
|
1392
|
+
| `columnDefs.$.cell.buttons.$.icon` | string \| object | - | Icon name (a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`) or Icon block config. |
|
|
1378
1393
|
| `columnDefs.$.cell.buttons.$.iconField` | string | - | Row-data path for the icon name or config. |
|
|
1394
|
+
| `columnDefs.$.cell.buttons.$.iconPlacement` | string | `"start"` | Place the icon before (start) or after (end) the title. Enum: `start`, `end`. |
|
|
1379
1395
|
| `columnDefs.$.cell.buttons.$.type` | string | - | antd Button type. Enum: `primary`, `default`, `dashed`, `link`, `text`. |
|
|
1380
1396
|
| `columnDefs.$.cell.buttons.$.variant` | string | - | antd Button variant. Takes precedence over `type` when set. Enum: `solid`, `outlined`, `dashed`, `filled`, `text`, `link`. |
|
|
1381
1397
|
| `columnDefs.$.cell.buttons.$.color` | string | - | Button color (antd preset or hex). |
|
|
@@ -1384,6 +1400,7 @@ Migrate the column-level checkbox flags in the same edit — `checkboxSelection`
|
|
|
1384
1400
|
| `columnDefs.$.cell.buttons.$.danger` | boolean | `false` | |
|
|
1385
1401
|
| `columnDefs.$.cell.buttons.$.ghost` | boolean | `false` | |
|
|
1386
1402
|
| `columnDefs.$.cell.buttons.$.hideTitle` | boolean | `false` | Hide the button's title (icon-only). |
|
|
1403
|
+
| `columnDefs.$.cell.buttons.$.tooltip` | string | - | Hover text for the button. An icon-only button (`hideTitle: true`) shows its `title` as the tooltip when this is not set. |
|
|
1387
1404
|
| `columnDefs.$.cell.buttons.$.disabled` | boolean | `false` | |
|
|
1388
1405
|
| `columnDefs.$.cell.buttons.$.disabledField` | string | - | Row-data path → boolean. |
|
|
1389
1406
|
| `columnDefs.$.cell.buttons.$.hidden` | boolean | `false` | Hide the button entirely. |
|
|
@@ -1392,15 +1409,15 @@ Migrate the column-level checkbox flags in the same edit — `checkboxSelection`
|
|
|
1392
1409
|
| `columnDefs.$.cell.items.$.eventName` | string | - | Block-level event name to trigger on click. Event payload is `{ row, value, item: { eventName, title }, itemIndex }`. |
|
|
1393
1410
|
| `columnDefs.$.cell.items.$.title` | string | - | Item label - supports html. |
|
|
1394
1411
|
| `columnDefs.$.cell.items.$.titleField` | string | - | Row-data path for the label. |
|
|
1395
|
-
| `columnDefs.$.cell.items.$.icon` | string \| object | - |
|
|
1412
|
+
| `columnDefs.$.cell.items.$.icon` | string \| object | - | Icon name (a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`) or Icon block config. |
|
|
1396
1413
|
| `columnDefs.$.cell.items.$.iconField` | string | - | Row-data path for the icon name or config. |
|
|
1397
1414
|
| `columnDefs.$.cell.items.$.danger` | boolean | `false` | Render the item in the danger colour. |
|
|
1398
1415
|
| `columnDefs.$.cell.items.$.disabled` | boolean | `false` | |
|
|
1399
1416
|
| `columnDefs.$.cell.items.$.disabledField` | string | - | Row-data path → boolean. |
|
|
1400
1417
|
| `columnDefs.$.cell.items.$.hidden` | boolean | `false` | Hide the item entirely. |
|
|
1401
1418
|
| `columnDefs.$.cell.items.$.hiddenField` | string | - | Row-data path → boolean. |
|
|
1402
|
-
| `columnDefs.$.cell.icon` | string \| object | `"
|
|
1403
|
-
| `columnDefs.$.cell.placement` | string | `"bottomRight"` | Menu cell: where the dropdown opens relative to its trigger. Enum: `bottomLeft`, `bottom`, `bottomRight`, `topLeft`, `top`, `topRight`. |
|
|
1419
|
+
| `columnDefs.$.cell.icon` | string \| object | `"more-vertical"` | Menu cell: the trigger icon. Icon name (a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`) or Icon block config. The trigger is icon-only. |
|
|
1420
|
+
| `columnDefs.$.cell.placement` | string | `"bottomRight"` | Menu cell: where the dropdown opens relative to its trigger. Enum: `bottomLeft`, `bottom`, `bottomRight`, `topLeft`, `top`, `topRight`, `left`, `leftTop`, `leftBottom`, `right`, `rightTop`, `rightBottom`. |
|
|
1404
1421
|
| `columnDefs.$.cell.options` | array | - | Selector / Multiple selector cell: dropdown options. An array of primitives, or objects mirroring the `Selector` block options: `{ label, value, disabled, color, filterString, style }`. `label` supports html. |
|
|
1405
1422
|
| `columnDefs.$.cell.valueKey` | string | - | Selector / Multiple selector: field on each option object to use as its value. Defaults to `value`. |
|
|
1406
1423
|
| `columnDefs.$.cell.primaryKey` | string | - | Selector / Multiple selector: field used to match the cell value to an option (identity key for object values). |
|
|
@@ -1418,8 +1435,8 @@ Migrate the column-level checkbox flags in the same edit — `checkboxSelection`
|
|
|
1418
1435
|
| `columnDefs.$.cell.autoClearSearchValue` | boolean | - | Multiple selector: clear the search box after each selection. |
|
|
1419
1436
|
| `columnDefs.$.cell.checkedText` | string | - | Switch: label shown inside the switch when on. |
|
|
1420
1437
|
| `columnDefs.$.cell.uncheckedText` | string | - | Switch: label shown inside the switch when off. |
|
|
1421
|
-
| `columnDefs.$.cell.checkedIcon` | string \| object | - | Switch: icon shown when on (
|
|
1422
|
-
| `columnDefs.$.cell.uncheckedIcon` | string \| object | - | Switch: icon shown when off (
|
|
1438
|
+
| `columnDefs.$.cell.checkedIcon` | string \| object | - | Switch: icon shown when on (icon name like `edit`, `Pencil` or `tabler:Pencil`, or Icon block config). |
|
|
1439
|
+
| `columnDefs.$.cell.uncheckedIcon` | string \| object | - | Switch: icon shown when off (icon name like `edit`, `Pencil` or `tabler:Pencil`, or Icon block config). |
|
|
1423
1440
|
| `columnDefs.$.cell.inputType` | string | - | Text input: the HTML input type (e.g. `text`, `email`, `number`, `password`). Named `inputType` to avoid clashing with `cell.type`. |
|
|
1424
1441
|
| `columnDefs.$.cell.maxLength` | number | - | Text input / Paragraph input: maximum number of characters. |
|
|
1425
1442
|
| `columnDefs.$.cell.showCount` | boolean | - | Text input: show the character count. |
|
|
@@ -1438,9 +1455,9 @@ Migrate the column-level checkbox flags in the same edit — `checkboxSelection`
|
|
|
1438
1455
|
|
|
1439
1456
|
| Event | Event Data | Description |
|
|
1440
1457
|
| --- | --- | --- |
|
|
1441
|
-
| `onCellClick` | `{ cell, colId, row, rowIndex, selected }` | Trigger event when a cell is clicked. |
|
|
1458
|
+
| `onCellClick` | `{ cell, colId, row, rowIndex, selected }` | Trigger event when a cell is clicked. Clicks on a button, link, menu, input or checkbox in the cell do not trigger it. |
|
|
1442
1459
|
| `onFilterChanged` | `{ rows, filter }` | Trigger event when the filter changes. |
|
|
1443
|
-
| `onRowClick` | `{ row, selected, rowIndex }` | Trigger event when a row is clicked. |
|
|
1460
|
+
| `onRowClick` | `{ row, selected, rowIndex }` | Trigger event when a row is clicked. Clicks on a button, link, menu, input or checkbox in a cell do not trigger it. |
|
|
1444
1461
|
| `onRowSelected` | `{ row, rowIndex, selected }` | Trigger event when a row is selected. |
|
|
1445
1462
|
| `onSelectionChanged` | `{ selected }` | Triggered when the selected rows are changed. |
|
|
1446
1463
|
| `onSortChanged` | `{ rows, sort }` | Trigger event when the sort changes. |
|
|
@@ -57,7 +57,7 @@ Hyperlink anchor for navigation.
|
|
|
57
57
|
properties:
|
|
58
58
|
title: Link with Icon
|
|
59
59
|
url: https://lowdefy.com
|
|
60
|
-
icon:
|
|
60
|
+
icon: link
|
|
61
61
|
- id: icon_download
|
|
62
62
|
type: Anchor
|
|
63
63
|
layout:
|
|
@@ -65,7 +65,7 @@ Hyperlink anchor for navigation.
|
|
|
65
65
|
properties:
|
|
66
66
|
title: Download
|
|
67
67
|
url: https://lowdefy.com
|
|
68
|
-
icon:
|
|
68
|
+
icon: download
|
|
69
69
|
- id: icon_external
|
|
70
70
|
type: Anchor
|
|
71
71
|
layout:
|
|
@@ -73,7 +73,7 @@ Hyperlink anchor for navigation.
|
|
|
73
73
|
properties:
|
|
74
74
|
title: External Link
|
|
75
75
|
url: https://lowdefy.com
|
|
76
|
-
icon:
|
|
76
|
+
icon: SquareArrowOutUpRight
|
|
77
77
|
- id: icon_mail
|
|
78
78
|
type: Anchor
|
|
79
79
|
layout:
|
|
@@ -81,7 +81,7 @@ Hyperlink anchor for navigation.
|
|
|
81
81
|
properties:
|
|
82
82
|
title: Send Email
|
|
83
83
|
url: https://lowdefy.com
|
|
84
|
-
icon:
|
|
84
|
+
icon: mail
|
|
85
85
|
- id: icon_github
|
|
86
86
|
type: Anchor
|
|
87
87
|
layout:
|
|
@@ -89,7 +89,7 @@ Hyperlink anchor for navigation.
|
|
|
89
89
|
properties:
|
|
90
90
|
title: GitHub
|
|
91
91
|
url: https://github.com/lowdefy/lowdefy
|
|
92
|
-
icon:
|
|
92
|
+
icon: GitBranch
|
|
93
93
|
- id: icon_object
|
|
94
94
|
type: Anchor
|
|
95
95
|
layout:
|
|
@@ -98,7 +98,7 @@ Hyperlink anchor for navigation.
|
|
|
98
98
|
title: Colored Icon
|
|
99
99
|
url: https://lowdefy.com
|
|
100
100
|
icon:
|
|
101
|
-
name:
|
|
101
|
+
name: heart
|
|
102
102
|
color: "#ff4d4f"
|
|
103
103
|
```
|
|
104
104
|
|
|
@@ -119,7 +119,7 @@ Hyperlink anchor for navigation.
|
|
|
119
119
|
title: External Docs
|
|
120
120
|
url: https://docs.lowdefy.com
|
|
121
121
|
newTab: true
|
|
122
|
-
icon:
|
|
122
|
+
icon: SquareArrowOutUpRight
|
|
123
123
|
```
|
|
124
124
|
|
|
125
125
|
```yaml
|
|
@@ -139,7 +139,7 @@ Hyperlink anchor for navigation.
|
|
|
139
139
|
title: Disabled with Icon
|
|
140
140
|
url: https://lowdefy.com
|
|
141
141
|
disabled: true
|
|
142
|
-
icon:
|
|
142
|
+
icon: lock
|
|
143
143
|
- id: enabled_link
|
|
144
144
|
type: Anchor
|
|
145
145
|
layout:
|
|
@@ -148,7 +148,7 @@ Hyperlink anchor for navigation.
|
|
|
148
148
|
title: Enabled Link
|
|
149
149
|
url: https://lowdefy.com
|
|
150
150
|
disabled: false
|
|
151
|
-
icon:
|
|
151
|
+
icon: unlock
|
|
152
152
|
```
|
|
153
153
|
|
|
154
154
|
```yaml
|
|
@@ -166,7 +166,7 @@ Hyperlink anchor for navigation.
|
|
|
166
166
|
flex: 0 0 auto
|
|
167
167
|
properties:
|
|
168
168
|
url: https://lowdefy.com
|
|
169
|
-
icon:
|
|
169
|
+
icon: home
|
|
170
170
|
ariaLabel: Go to home page
|
|
171
171
|
```
|
|
172
172
|
|
|
@@ -198,7 +198,7 @@ Hyperlink anchor for navigation.
|
|
|
198
198
|
properties:
|
|
199
199
|
title: Go Back
|
|
200
200
|
back: true
|
|
201
|
-
icon:
|
|
201
|
+
icon: arrow-left
|
|
202
202
|
- id: nav_home
|
|
203
203
|
type: Anchor
|
|
204
204
|
layout:
|
|
@@ -206,7 +206,7 @@ Hyperlink anchor for navigation.
|
|
|
206
206
|
properties:
|
|
207
207
|
title: Go Home
|
|
208
208
|
home: true
|
|
209
|
-
icon:
|
|
209
|
+
icon: home
|
|
210
210
|
```
|
|
211
211
|
|
|
212
212
|
```yaml
|
|
@@ -217,7 +217,7 @@ Hyperlink anchor for navigation.
|
|
|
217
217
|
properties:
|
|
218
218
|
title: Documentation
|
|
219
219
|
url: https://docs.lowdefy.com
|
|
220
|
-
icon:
|
|
220
|
+
icon: Book
|
|
221
221
|
events:
|
|
222
222
|
onClick:
|
|
223
223
|
shortcut: mod+shift+d
|
|
@@ -302,7 +302,7 @@ Hyperlink anchor for navigation.
|
|
|
302
302
|
properties:
|
|
303
303
|
title: Large Red Link
|
|
304
304
|
url: https://lowdefy.com
|
|
305
|
-
icon:
|
|
305
|
+
icon: heart
|
|
306
306
|
```
|
|
307
307
|
|
|
308
308
|
| Property | Type | Default | Description |
|
|
@@ -312,8 +312,9 @@ Hyperlink anchor for navigation.
|
|
|
312
312
|
| `home` | boolean | - | When the link is clicked, route to the home page. |
|
|
313
313
|
| `input` | object | - | When the link is clicked, pass data as the input object to the next Lowdefy page. Can only be used with pageId link and newTab false. |
|
|
314
314
|
| `urlQuery` | object | - | When the link is clicked, pass data as a url query to the next page. |
|
|
315
|
+
| `pathParams` | object | - | Values for the placeholders in the path of the page given by pageId, like `{ ticket_id: '1234' }` for `tickets/{ticket_id}`. |
|
|
315
316
|
| `disabled` | boolean | `false` | Disable the anchor if true. |
|
|
316
|
-
| `icon` | string \| object | - |
|
|
317
|
+
| `icon` | string \| object | - | Icon name (a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`) or properties of an Icon block for anchor icon. |
|
|
317
318
|
| `pageId` | string | - | When the link is clicked, route to the provided Lowdefy page. |
|
|
318
319
|
| `href` | string | - | The href to link to when the anchor link is clicked. |
|
|
319
320
|
| `url` | string | - | External url to link to when the anchor link is clicked. |
|