@lowdefy/docs-content 6.1.0 → 7.0.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 +5 -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/setstate.md +2 -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 +33 -16
- 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/learn/showcase.md +8 -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 +56 -0
- package/index.json +3458 -14
- package/package.json +10 -1
- package/scripts/extractAgentDocs.js +41 -30
- package/scripts/hashDocSources.js +38 -0
- package/scripts/isRedirectPage.js +26 -0
- package/scripts/recordSourceHashes.js +97 -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
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# S3Download
|
|
2
2
|
|
|
3
|
-
__Deprecated__ — use the provider-neutral
|
|
3
|
+
__Deprecated__ — use the provider-neutral <a href="/Download">Download</a> block with `downloadPolicyRequestId` instead. S3Download remains as an alias so existing apps keep working. Download files from AWS S3. Requires an AwsS3Bucket connection and an AwsS3PresignedGetObject request. The s3GetPolicyRequestId property must reference the request id. If files were uploaded with S3Upload, its fileList value can be mapped directly to this block.
|
|
4
4
|
|
|
5
5
|
> The S3Download block requires an AwsS3Bucket connection and an AwsS3PresignedGetObject request. The examples below show configuration structure but will not download files without a configured connection.
|
|
6
6
|
|
|
@@ -163,11 +163,11 @@ See the [MiniSearch API docs](https://lucaong.github.io/minisearch/classes/MiniS
|
|
|
163
163
|
- label: Concepts
|
|
164
164
|
match:
|
|
165
165
|
section: Concepts
|
|
166
|
-
icon:
|
|
166
|
+
icon: Lightbulb
|
|
167
167
|
- label: Blocks
|
|
168
168
|
match:
|
|
169
169
|
section: Blocks
|
|
170
|
-
icon:
|
|
170
|
+
icon: PanelsTopLeft
|
|
171
171
|
events:
|
|
172
172
|
onSelect:
|
|
173
173
|
- id: navigate
|
|
@@ -221,15 +221,15 @@ See the [MiniSearch API docs](https://lucaong.github.io/minisearch/classes/MiniS
|
|
|
221
221
|
- label: Admin
|
|
222
222
|
match:
|
|
223
223
|
category: Admin
|
|
224
|
-
icon:
|
|
224
|
+
icon: settings
|
|
225
225
|
- label: Finance
|
|
226
226
|
match:
|
|
227
227
|
category: Finance
|
|
228
|
-
icon:
|
|
228
|
+
icon: DollarSign
|
|
229
229
|
- label: Analytics
|
|
230
230
|
match:
|
|
231
231
|
category: Analytics
|
|
232
|
-
icon:
|
|
232
|
+
icon: chart
|
|
233
233
|
placeholder: Search features...
|
|
234
234
|
label: Find
|
|
235
235
|
shortcut: mod+k
|
|
@@ -308,7 +308,16 @@ See the [MiniSearch API docs](https://lucaong.github.io/minisearch/classes/MiniS
|
|
|
308
308
|
| `searchOptions.prefix` | boolean | `true` | Enable prefix matching. |
|
|
309
309
|
| `searchOptions.combineWith` | string | `"OR"` | How to combine search terms. Enum: `OR`, `AND`. |
|
|
310
310
|
| `label` | string | `"Search"` | Trigger button text. |
|
|
311
|
-
| `icon` | string \| object |
|
|
311
|
+
| `icon` | string \| object | `"search"` | Trigger button icon: a semantic name like `search`, a Lucide icon name like `Search`, or a set-qualified name like `tabler:Search`, or properties of an Icon block. |
|
|
312
|
+
| `icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
313
|
+
| `icon.color` | string | - | Icon color. |
|
|
314
|
+
| `icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
315
|
+
| `icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
316
|
+
| `icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
317
|
+
| `icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
318
|
+
| `icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
319
|
+
| `icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
320
|
+
| `icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
312
321
|
| `showShortcut` | boolean | `true` | Show keyboard shortcut badge on the trigger button. |
|
|
313
322
|
| `placeholder` | string | `"Search..."` | Search input placeholder text. |
|
|
314
323
|
| `shortcut` | string | `"mod+k"` | Keyboard shortcut to open the modal. Renders a shortcut badge on the trigger button (see showShortcut). Use "mod" for Cmd on Mac, Ctrl elsewhere. |
|
|
@@ -328,9 +337,9 @@ See the [MiniSearch API docs](https://lucaong.github.io/minisearch/classes/MiniS
|
|
|
328
337
|
| `noResultsMessage` | string | `"No results found."` | Message shown when no results match. |
|
|
329
338
|
| `highlightMatches` | boolean | `true` | Highlight matched terms in results. |
|
|
330
339
|
| `recentSearches` | boolean | `true` | Show recent searches when input is empty. |
|
|
331
|
-
| `recentSearchesKey` | string | `"search"` | localStorage key prefix for recent searches. |
|
|
340
|
+
| `recentSearchesKey` | string | `"search"` | localStorage key prefix for recent searches. Recent searches are kept per app and per signed-in user, and cleared at sign-out. |
|
|
332
341
|
| `recentSearchesCount` | number | `5` | Maximum number of recent searches stored. |
|
|
333
|
-
| `theme` | object | - | Antd design token overrides for
|
|
342
|
+
| `theme` | object | - | Antd design token overrides for the trigger Button, the search Modal and its Input, e.g. `borderRadius`, `colorPrimary`, `colorBgElevated` or `fontSize`. See [antd design tokens](https://ant.design/components/overview#design-token). |
|
|
334
343
|
|
|
335
344
|
| Event | Event Data | Description |
|
|
336
345
|
| --- | --- | --- |
|
|
@@ -354,7 +363,8 @@ See the [MiniSearch API docs](https://lucaong.github.io/minisearch/classes/MiniS
|
|
|
354
363
|
| `/itemIcon` | The icon in a result item. |
|
|
355
364
|
| `/itemTitle` | The title in a result item. |
|
|
356
365
|
| `/itemDescription` | The description/snippet in a result item. |
|
|
357
|
-
| `/highlight` | Highlighted match text (
|
|
366
|
+
| `/highlight` | Highlighted match text (<mark> elements). |
|
|
358
367
|
| `/empty` | The empty state message. |
|
|
368
|
+
| `/loading` | The loading spinner container. |
|
|
359
369
|
|
|
360
370
|
No slots defined.
|
|
@@ -232,6 +232,7 @@ Button-shaped skeleton loading placeholder.
|
|
|
232
232
|
|
|
233
233
|
| Property | Type | Default | Description |
|
|
234
234
|
| --- | --- | --- | --- |
|
|
235
|
+
| `shape` | string | `"default"` | Shape of the skeleton; round gives fully rounded ends. Enum: `default`, `round`. |
|
|
235
236
|
| `size` | string | `"medium"` | Size of the skeleton. Enum: `small`, `medium`, `large`. |
|
|
236
237
|
| `width` | number \| string | - | Width of the skeleton. |
|
|
237
238
|
|
|
@@ -206,6 +206,7 @@ Input-shaped skeleton loading placeholder.
|
|
|
206
206
|
|
|
207
207
|
| Property | Type | Default | Description |
|
|
208
208
|
| --- | --- | --- | --- |
|
|
209
|
+
| `label` | boolean | `true` | Render the label skeleton. Set to false for an input without a label. |
|
|
209
210
|
| `size` | string | `"medium"` | Size of the skeleton. Enum: `small`, `medium`, `large`. |
|
|
210
211
|
| `width` | number \| string | - | Width of the skeleton. |
|
|
211
212
|
| `labelHeight` | number \| string | - | Height of the skeleton. |
|
|
@@ -78,7 +78,7 @@ Statistic display with prefix, suffix, and formatting.
|
|
|
78
78
|
properties:
|
|
79
79
|
title: Feedback
|
|
80
80
|
value: 1128
|
|
81
|
-
prefixIcon:
|
|
81
|
+
prefixIcon: ThumbsUp
|
|
82
82
|
- id: prefixicon_arrow_up
|
|
83
83
|
type: Statistic
|
|
84
84
|
layout:
|
|
@@ -88,7 +88,7 @@ Statistic display with prefix, suffix, and formatting.
|
|
|
88
88
|
value: 11.28
|
|
89
89
|
suffix: "%"
|
|
90
90
|
prefixIcon:
|
|
91
|
-
name:
|
|
91
|
+
name: arrow-up
|
|
92
92
|
color: "#3f8600"
|
|
93
93
|
- id: prefixicon_arrow_down
|
|
94
94
|
type: Statistic
|
|
@@ -99,7 +99,7 @@ Statistic display with prefix, suffix, and formatting.
|
|
|
99
99
|
value: 9.3
|
|
100
100
|
suffix: "%"
|
|
101
101
|
prefixIcon:
|
|
102
|
-
name:
|
|
102
|
+
name: arrow-down
|
|
103
103
|
color: "#cf1322"
|
|
104
104
|
- id: suffixicon_rise
|
|
105
105
|
type: Statistic
|
|
@@ -110,7 +110,7 @@ Statistic display with prefix, suffix, and formatting.
|
|
|
110
110
|
value: 12500
|
|
111
111
|
prefix: $
|
|
112
112
|
suffixIcon:
|
|
113
|
-
name:
|
|
113
|
+
name: TrendingUp
|
|
114
114
|
color: "#3f8600"
|
|
115
115
|
- id: suffixicon_info
|
|
116
116
|
type: Statistic
|
|
@@ -119,7 +119,7 @@ Statistic display with prefix, suffix, and formatting.
|
|
|
119
119
|
properties:
|
|
120
120
|
title: Sessions
|
|
121
121
|
value: 8920
|
|
122
|
-
suffixIcon:
|
|
122
|
+
suffixIcon: info
|
|
123
123
|
```
|
|
124
124
|
|
|
125
125
|
```yaml
|
|
@@ -180,6 +180,37 @@ Statistic display with prefix, suffix, and formatting.
|
|
|
180
180
|
decimalSeparator: ","
|
|
181
181
|
```
|
|
182
182
|
|
|
183
|
+
```yaml
|
|
184
|
+
- id: timer_countdown
|
|
185
|
+
type: Statistic
|
|
186
|
+
layout:
|
|
187
|
+
span: 12
|
|
188
|
+
properties:
|
|
189
|
+
title: Launch in
|
|
190
|
+
value:
|
|
191
|
+
_date: 2030-01-01T00:00:00.000Z
|
|
192
|
+
timer:
|
|
193
|
+
type: countdown
|
|
194
|
+
format: D [days] HH:mm:ss
|
|
195
|
+
events:
|
|
196
|
+
onFinish:
|
|
197
|
+
- id: timer_countdown_finished
|
|
198
|
+
type: DisplayMessage
|
|
199
|
+
params:
|
|
200
|
+
content: We have launched.
|
|
201
|
+
- id: timer_countup
|
|
202
|
+
type: Statistic
|
|
203
|
+
layout:
|
|
204
|
+
span: 12
|
|
205
|
+
properties:
|
|
206
|
+
title: Incident open for
|
|
207
|
+
value:
|
|
208
|
+
_date: 2026-01-01T00:00:00.000Z
|
|
209
|
+
timer:
|
|
210
|
+
type: countup
|
|
211
|
+
format: D [days] HH:mm
|
|
212
|
+
```
|
|
213
|
+
|
|
183
214
|
```yaml
|
|
184
215
|
- id: loading_true
|
|
185
216
|
type: Statistic
|
|
@@ -251,7 +282,7 @@ Statistic display with prefix, suffix, and formatting.
|
|
|
251
282
|
properties:
|
|
252
283
|
title: Active Users
|
|
253
284
|
value: 2847
|
|
254
|
-
prefixIcon:
|
|
285
|
+
prefixIcon: users
|
|
255
286
|
- id: css_tailwind_center
|
|
256
287
|
type: Statistic
|
|
257
288
|
layout:
|
|
@@ -273,7 +304,7 @@ Statistic display with prefix, suffix, and formatting.
|
|
|
273
304
|
.element:
|
|
274
305
|
padding: 16px 24px
|
|
275
306
|
borderRadius: 8px
|
|
276
|
-
border: 1px solid
|
|
307
|
+
border: "1px solid #ffa39e"
|
|
277
308
|
.value:
|
|
278
309
|
color: "#cf1322"
|
|
279
310
|
fontSize: 28
|
|
@@ -337,7 +368,7 @@ _Last updated 2 minutes ago_
|
|
|
337
368
|
prefix: $
|
|
338
369
|
precision: 0
|
|
339
370
|
prefixIcon:
|
|
340
|
-
name:
|
|
371
|
+
name: CircleDollarSign
|
|
341
372
|
color: "#52c41a"
|
|
342
373
|
- id: dash_users
|
|
343
374
|
type: Statistic
|
|
@@ -348,7 +379,7 @@ _Last updated 2 minutes ago_
|
|
|
348
379
|
title: Active Users
|
|
349
380
|
value: 8920
|
|
350
381
|
prefixIcon:
|
|
351
|
-
name:
|
|
382
|
+
name: users
|
|
352
383
|
color: "#1677ff"
|
|
353
384
|
- id: dash_errors
|
|
354
385
|
type: Statistic
|
|
@@ -361,7 +392,7 @@ _Last updated 2 minutes ago_
|
|
|
361
392
|
suffix: "%"
|
|
362
393
|
precision: 2
|
|
363
394
|
prefixIcon:
|
|
364
|
-
name:
|
|
395
|
+
name: Bug
|
|
365
396
|
color: "#ff4d4f"
|
|
366
397
|
- id: dashboard_updated
|
|
367
398
|
type: Markdown
|
|
@@ -391,7 +422,7 @@ _Last updated 2 minutes ago_
|
|
|
391
422
|
prefix: $
|
|
392
423
|
precision: 0
|
|
393
424
|
prefixIcon:
|
|
394
|
-
name:
|
|
425
|
+
name: arrow-up
|
|
395
426
|
color: "#3f8600"
|
|
396
427
|
theme:
|
|
397
428
|
contentFontSize: 28
|
|
@@ -402,7 +433,7 @@ _Last updated 2 minutes ago_
|
|
|
402
433
|
properties:
|
|
403
434
|
title: Orders
|
|
404
435
|
value: 1523
|
|
405
|
-
prefixIcon:
|
|
436
|
+
prefixIcon: ShoppingCart
|
|
406
437
|
- id: sales_avg
|
|
407
438
|
type: Statistic
|
|
408
439
|
layout:
|
|
@@ -424,7 +455,7 @@ _Last updated 2 minutes ago_
|
|
|
424
455
|
flex: 0 0 auto
|
|
425
456
|
properties:
|
|
426
457
|
title: Export Report
|
|
427
|
-
icon:
|
|
458
|
+
icon: download
|
|
428
459
|
color: primary
|
|
429
460
|
variant: outlined
|
|
430
461
|
events:
|
|
@@ -440,7 +471,7 @@ _Last updated 2 minutes ago_
|
|
|
440
471
|
flex: 0 0 auto
|
|
441
472
|
properties:
|
|
442
473
|
title: Share
|
|
443
|
-
icon:
|
|
474
|
+
icon: share
|
|
444
475
|
color: primary
|
|
445
476
|
variant: solid
|
|
446
477
|
events:
|
|
@@ -459,9 +490,30 @@ _Last updated 2 minutes ago_
|
|
|
459
490
|
| `loading` | boolean | `false` | Control the loading status of Statistic. |
|
|
460
491
|
| `precision` | number | - | Number of decimals to display. |
|
|
461
492
|
| `prefix` | string | - | Prefix text, priority over prefixIcon. |
|
|
462
|
-
| `prefixIcon` | string \| object | - |
|
|
493
|
+
| `prefixIcon` | 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 to customize icon which prefix the statistic. |
|
|
494
|
+
| `prefixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
495
|
+
| `prefixIcon.color` | string | - | Icon color. |
|
|
496
|
+
| `prefixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
497
|
+
| `prefixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
498
|
+
| `prefixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
499
|
+
| `prefixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
500
|
+
| `prefixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
501
|
+
| `prefixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
502
|
+
| `prefixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
463
503
|
| `suffix` | string | - | Suffix text, priority over suffixIcon. |
|
|
464
|
-
| `suffixIcon` | string \| object | - |
|
|
504
|
+
| `suffixIcon` | 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 to customize icon which suffix the statistic. |
|
|
505
|
+
| `suffixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
506
|
+
| `suffixIcon.color` | string | - | Icon color. |
|
|
507
|
+
| `suffixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
508
|
+
| `suffixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
509
|
+
| `suffixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
510
|
+
| `suffixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
511
|
+
| `suffixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
512
|
+
| `suffixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
513
|
+
| `suffixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
514
|
+
| `timer` | object | - | Show a live timer instead of a static value. `value` is the target time for a countdown, or the start time for a count up, as a date or a timestamp in milliseconds. |
|
|
515
|
+
| `timer.type` | string | - | Count down to value, or count up from value. Enum: `countdown`, `countup`. |
|
|
516
|
+
| `timer.format` | string | `"HH:mm:ss"` | Format of the time, using the tokens Y, M, D, H, m, s and S, like `D [days] HH:mm:ss`. |
|
|
465
517
|
| `title` | string | - | Title to describe the component - supports html. |
|
|
466
518
|
| `value` | number \| string | - | Value to display. |
|
|
467
519
|
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design statistic tokens](https://ant.design/components/statistic#design-token). |
|
|
@@ -472,13 +524,19 @@ _Last updated 2 minutes ago_
|
|
|
472
524
|
| `theme.colorText` | string | - | Default text color for the statistic value. |
|
|
473
525
|
| `theme.colorTextDescription` | string | - | Color for the statistic title text. |
|
|
474
526
|
|
|
475
|
-
|
|
527
|
+
| Event | Event Data | Description |
|
|
528
|
+
| --- | --- | --- |
|
|
529
|
+
| `onFinish` | \- | Trigger actions when a countdown timer reaches zero. |
|
|
476
530
|
|
|
477
531
|
| Key | Target |
|
|
478
532
|
| --- | --- |
|
|
479
533
|
| `/block` | Outer block wrapper (always available). |
|
|
480
534
|
| `/element` | The Statistic element. |
|
|
535
|
+
| `/title` | The Statistic title. |
|
|
536
|
+
| `/content` | The value section, with the prefix, value and suffix. |
|
|
537
|
+
| `/prefix` | The prefix of the value. |
|
|
481
538
|
| `/prefixIcon` | The prefix icon in the Statistic. |
|
|
539
|
+
| `/suffix` | The suffix of the value. |
|
|
482
540
|
| `/suffixIcon` | The suffix icon in the Statistic. |
|
|
483
541
|
| `/value` | The Statistic value. |
|
|
484
542
|
|
|
@@ -64,11 +64,11 @@ Navigation steps bar, guiding users through the steps of a task.
|
|
|
64
64
|
current: 1
|
|
65
65
|
items:
|
|
66
66
|
- title: Login
|
|
67
|
-
icon:
|
|
67
|
+
icon: user
|
|
68
68
|
- title: Verification
|
|
69
|
-
icon:
|
|
69
|
+
icon: FileUser
|
|
70
70
|
- title: Done
|
|
71
|
-
icon:
|
|
71
|
+
icon: FaceSlightlySmiling
|
|
72
72
|
- id: icon_custom_color
|
|
73
73
|
type: Steps
|
|
74
74
|
properties:
|
|
@@ -76,15 +76,15 @@ Navigation steps bar, guiding users through the steps of a task.
|
|
|
76
76
|
items:
|
|
77
77
|
- title: Upload
|
|
78
78
|
icon:
|
|
79
|
-
name:
|
|
79
|
+
name: CloudUpload
|
|
80
80
|
color: "#1677ff"
|
|
81
81
|
- title: Process
|
|
82
82
|
icon:
|
|
83
|
-
name:
|
|
83
|
+
name: loading
|
|
84
84
|
color: "#faad14"
|
|
85
85
|
- title: Complete
|
|
86
86
|
icon:
|
|
87
|
-
name:
|
|
87
|
+
name: check
|
|
88
88
|
color: "#52c41a"
|
|
89
89
|
```
|
|
90
90
|
|
|
@@ -202,13 +202,13 @@ Navigation steps bar, guiding users through the steps of a task.
|
|
|
202
202
|
items:
|
|
203
203
|
- title: Account
|
|
204
204
|
description: Create your account
|
|
205
|
-
icon:
|
|
205
|
+
icon: user
|
|
206
206
|
- title: Settings
|
|
207
207
|
description: Configure preferences
|
|
208
|
-
icon:
|
|
208
|
+
icon: settings
|
|
209
209
|
- title: Review
|
|
210
210
|
description: Review and submit
|
|
211
|
-
icon:
|
|
211
|
+
icon: check
|
|
212
212
|
- title: Done
|
|
213
213
|
description: All finished
|
|
214
214
|
events:
|
|
@@ -258,6 +258,23 @@ Navigation steps bar, guiding users through the steps of a task.
|
|
|
258
258
|
- title: Waiting
|
|
259
259
|
```
|
|
260
260
|
|
|
261
|
+
```yaml
|
|
262
|
+
- id: max_count_steps
|
|
263
|
+
type: Steps
|
|
264
|
+
properties:
|
|
265
|
+
current: 5
|
|
266
|
+
maxCount: 5
|
|
267
|
+
items:
|
|
268
|
+
- title: Draft
|
|
269
|
+
- title: Review
|
|
270
|
+
- title: Legal
|
|
271
|
+
- title: Finance
|
|
272
|
+
- title: Approval
|
|
273
|
+
- title: Signed
|
|
274
|
+
- title: Filed
|
|
275
|
+
- title: Archived
|
|
276
|
+
```
|
|
277
|
+
|
|
261
278
|
```yaml
|
|
262
279
|
- id: progress_steps
|
|
263
280
|
type: Steps
|
|
@@ -370,11 +387,11 @@ Navigation steps bar, guiding users through the steps of a task.
|
|
|
370
387
|
_state: wizard_step
|
|
371
388
|
items:
|
|
372
389
|
- title: Account
|
|
373
|
-
icon:
|
|
390
|
+
icon: user
|
|
374
391
|
- title: Profile
|
|
375
|
-
icon:
|
|
392
|
+
icon: IdCard
|
|
376
393
|
- title: Confirm
|
|
377
|
-
icon:
|
|
394
|
+
icon: check
|
|
378
395
|
events:
|
|
379
396
|
onChange:
|
|
380
397
|
- id: wizard_set_step
|
|
@@ -499,16 +516,16 @@ Navigation steps bar, guiding users through the steps of a task.
|
|
|
499
516
|
items:
|
|
500
517
|
- title: Order Placed
|
|
501
518
|
description: March 10, 2026 at 2:30 PM
|
|
502
|
-
icon:
|
|
519
|
+
icon: ShoppingCart
|
|
503
520
|
- title: Payment Confirmed
|
|
504
521
|
description: March 10, 2026 at 2:31 PM
|
|
505
|
-
icon:
|
|
522
|
+
icon: CreditCard
|
|
506
523
|
- title: Shipped
|
|
507
524
|
description: March 12, 2026 - Tracking number available
|
|
508
|
-
icon:
|
|
525
|
+
icon: Car
|
|
509
526
|
- title: Delivered
|
|
510
527
|
description: Estimated March 15, 2026
|
|
511
|
-
icon:
|
|
528
|
+
icon: home
|
|
512
529
|
```
|
|
513
530
|
|
|
514
531
|
```yaml
|
|
@@ -532,7 +549,7 @@ Navigation steps bar, guiding users through the steps of a task.
|
|
|
532
549
|
style:
|
|
533
550
|
.element:
|
|
534
551
|
padding: 16px
|
|
535
|
-
border: 1px solid
|
|
552
|
+
border: "1px solid #d9d9d9"
|
|
536
553
|
borderRadius: 8
|
|
537
554
|
```
|
|
538
555
|
|
|
@@ -545,15 +562,25 @@ Navigation steps bar, guiding users through the steps of a task.
|
|
|
545
562
|
| `type` | string | `"default"` | Type of steps. Enum: `default`, `dot`, `inline`, `navigation`, `panel`. |
|
|
546
563
|
| `orientation` | string | `"horizontal"` | Orientation of the step bar. Enum: `horizontal`, `vertical`. |
|
|
547
564
|
| `titlePlacement` | string | `"horizontal"` | Place title and description horizontal or vertical. Enum: `horizontal`, `vertical`. |
|
|
565
|
+
| `maxCount` | integer | - | Maximum number of steps to show, at least 3. Hidden steps collapse into disabled ellipsis steps around the current step. |
|
|
548
566
|
| `percent` | number | - | Progress circle percentage of current step in process status (only works with type default). |
|
|
549
|
-
| `progressDot` | boolean | `false` | Steps with progress dot style. |
|
|
567
|
+
| `progressDot` | boolean | `false` | Steps with progress dot style. Same as `type: dot`. |
|
|
550
568
|
| `variant` | string | `"filled"` | Style variant of the steps. Enum: `filled`, `outlined`. |
|
|
551
569
|
| `responsive` | boolean | `true` | Change to vertical direction when screen width smaller than 532px. |
|
|
552
570
|
| `items` | array | - | List of step items. |
|
|
553
571
|
| `items.$.title` | string | - | Title of the step - supports html. |
|
|
554
572
|
| `items.$.subTitle` | string | - | Subtitle of the step - supports html. |
|
|
555
573
|
| `items.$.description` | string | - | Description of the step - supports html. |
|
|
556
|
-
| `items.$.icon` | string \| object | - |
|
|
574
|
+
| `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 properties of an Icon block to use as the step icon. |
|
|
575
|
+
| `items.$.icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
576
|
+
| `items.$.icon.color` | string | - | Icon color. |
|
|
577
|
+
| `items.$.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
578
|
+
| `items.$.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
579
|
+
| `items.$.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
580
|
+
| `items.$.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
581
|
+
| `items.$.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
582
|
+
| `items.$.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
583
|
+
| `items.$.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
557
584
|
| `items.$.status` | string | - | Status of this step, overrides the current step status. Enum: `wait`, `process`, `finish`, `error`. |
|
|
558
585
|
| `items.$.disabled` | boolean | `false` | Disable click on this step. |
|
|
559
586
|
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design steps tokens](https://ant.design/components/steps#design-token). |
|
|
@@ -564,13 +591,15 @@ Navigation steps bar, guiding users through the steps of a task.
|
|
|
564
591
|
| `theme.iconSize` | number | `32` | Size of the step icon. |
|
|
565
592
|
| `theme.iconSizeSM` | number | `24` | Size of the small step icon. |
|
|
566
593
|
| `theme.iconTop` | number | `-0.5` | Top position of the step icon. |
|
|
567
|
-
| `theme.descriptionMaxWidth` | number |
|
|
568
|
-
| `theme.titleLineHeight` | number | `32` |
|
|
594
|
+
| `theme.descriptionMaxWidth` | number | - | Max width of each step description. Unset by default in antd 6, so descriptions take the width of their step. |
|
|
595
|
+
| `theme.titleLineHeight` | number | `32` | Deprecated in antd 6 and has no effect. |
|
|
596
|
+
| `theme.customIconSize` | number | `32` | Size of the container of a custom step icon. |
|
|
597
|
+
| `theme.customIconFontSize` | number | `24` | Font size of a custom step icon. |
|
|
569
598
|
| `theme.navArrowColor` | string | `"rgba(0, 0, 0, 0.25)"` | Color of the navigation arrow. |
|
|
570
|
-
| `theme.navContentMaxWidth` | string | `"
|
|
571
|
-
| `theme.finishIconBorderColor` | string | `"#
|
|
572
|
-
| `theme.waitIconBorderColor` | string | `"
|
|
573
|
-
| `theme.waitIconColor` | string | `"rgba(0, 0, 0, 0.
|
|
599
|
+
| `theme.navContentMaxWidth` | string | `"unset"` | Max width of navigation step content. |
|
|
600
|
+
| `theme.finishIconBorderColor` | string | `"#e6f4ff"` | Border color of finished step icon. |
|
|
601
|
+
| `theme.waitIconBorderColor` | string | `"transparent"` | Border color of waiting step icon. |
|
|
602
|
+
| `theme.waitIconColor` | string | `"rgba(0, 0, 0, 0.65)"` | Color of waiting step icon. |
|
|
574
603
|
|
|
575
604
|
| Event | Event Data | Description |
|
|
576
605
|
| --- | --- | --- |
|
|
@@ -581,5 +610,9 @@ Navigation steps bar, guiding users through the steps of a task.
|
|
|
581
610
|
| `/block` | Outer block wrapper (always available). |
|
|
582
611
|
| `/element` | The Steps element. |
|
|
583
612
|
| `/icon` | The icon in the Steps. |
|
|
613
|
+
| `/item` | Each step. |
|
|
614
|
+
| `/itemTitle` | The title of each step. |
|
|
615
|
+
| `/itemSubtitle` | The subtitle of each step. |
|
|
616
|
+
| `/itemContent` | The description of each step. |
|
|
584
617
|
|
|
585
618
|
No slots defined.
|