@lowdefy/docs-content 6.0.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.
Files changed (285) hide show
  1. package/README.md +1 -0
  2. package/content/actions/downloadcsv.md +1 -1
  3. package/content/actions/emailotpsend.md +58 -0
  4. package/content/actions/emailotpverify.md +79 -0
  5. package/content/actions/getlocalstorage.md +43 -0
  6. package/content/actions/link.md +47 -1
  7. package/content/actions/login.md +25 -5
  8. package/content/actions/logout.md +7 -5
  9. package/content/actions/magiclinkverify.md +117 -0
  10. package/content/actions/pdfmake.md +2 -2
  11. package/content/actions/posthogalias.md +29 -0
  12. package/content/actions/posthogcapture.md +49 -0
  13. package/content/actions/posthogcapturepageleave.md +38 -0
  14. package/content/actions/posthogfeatureflag.md +50 -0
  15. package/content/actions/posthoggroup.md +37 -0
  16. package/content/actions/posthogidentify.md +54 -0
  17. package/content/actions/posthoginit.md +96 -0
  18. package/content/actions/posthogoptin.md +29 -0
  19. package/content/actions/posthogoptout.md +29 -0
  20. package/content/actions/posthogpageview.md +37 -0
  21. package/content/actions/posthogreloadfeatureflags.md +47 -0
  22. package/content/actions/posthogreset.md +28 -0
  23. package/content/actions/posthogsetpersonproperties.md +36 -0
  24. package/content/actions/removelocalstorage.md +28 -0
  25. package/content/actions/resetvalidation.md +5 -3
  26. package/content/actions/setdarkmode.md +3 -3
  27. package/content/actions/setglobal.md +2 -0
  28. package/content/actions/setlocale.md +1 -1
  29. package/content/actions/setlocalstorage.md +34 -0
  30. package/content/actions/setstate.md +2 -0
  31. package/content/actions/validate.md +7 -4
  32. package/content/adapter-reference/mongodbauthadapter.md +46 -0
  33. package/content/agents/agent-endpoint-tools.md +24 -0
  34. package/content/agents/agent-properties.md +13 -3
  35. package/content/agents/agent-server-hooks.md +1 -1
  36. package/content/agents/agentchat.md +41 -4
  37. package/content/agents/agentconversations.md +42 -8
  38. package/content/agents/agents-introduction.md +107 -0
  39. package/content/callback-reference/auth0logoutcallback.md +54 -0
  40. package/content/concepts/ai-agent-docs.md +455 -106
  41. package/content/concepts/blocks.md +150 -0
  42. package/content/concepts/connections-and-requests.md +402 -0
  43. package/content/concepts/custom-html.md +42 -0
  44. package/content/concepts/custom-styling.md +50 -5
  45. package/content/concepts/dynamic-page-content.md +309 -0
  46. package/content/concepts/events-and-actions.md +185 -2
  47. package/content/concepts/four-primitives.md +31 -0
  48. package/content/concepts/html-attributes.md +293 -0
  49. package/content/concepts/i18n.md +12 -3
  50. package/content/concepts/keyboard-shortcuts.md +2 -2
  51. package/content/concepts/layout-overview.md +1 -1
  52. package/content/concepts/logger.md +99 -0
  53. package/content/concepts/lowdefy-api.md +1319 -0
  54. package/content/concepts/lowdefy-schema.md +144 -3
  55. package/content/concepts/menus.md +8 -7
  56. package/content/concepts/module-authoring.md +76 -5
  57. package/content/concepts/modules.md +3 -1
  58. package/content/concepts/notifications.md +180 -0
  59. package/content/concepts/operators.md +7 -0
  60. package/content/concepts/page-and-app-state.md +252 -0
  61. package/content/concepts/page-paths.md +209 -0
  62. package/content/concepts/theming.md +582 -0
  63. package/content/connections/aigateway.md +375 -0
  64. package/content/connections/anthropic.md +169 -2
  65. package/content/connections/awss3.md +178 -2
  66. package/content/connections/axioshttp.md +181 -0
  67. package/content/connections/google.md +169 -2
  68. package/content/connections/mongodb.md +1014 -3
  69. package/content/connections/openai-connection.md +169 -2
  70. package/content/connections/sendgridmail.md +3 -0
  71. package/content/connections/smtp.md +16 -0
  72. package/content/connections/treg.md +329 -0
  73. package/content/container-blocks/affix.md +47 -7
  74. package/content/container-blocks/alert.md +76 -24
  75. package/content/container-blocks/badge.md +100 -24
  76. package/content/container-blocks/box.md +9 -9
  77. package/content/container-blocks/card.md +132 -27
  78. package/content/container-blocks/carousel.md +60 -7
  79. package/content/container-blocks/collapse.md +153 -9
  80. package/content/container-blocks/configprovider.md +35 -13
  81. package/content/container-blocks/confirmmodal.md +69 -23
  82. package/content/container-blocks/content.md +62 -98
  83. package/content/container-blocks/descriptions.md +45 -4
  84. package/content/container-blocks/drawer.md +139 -28
  85. package/content/container-blocks/dropdownmenu.md +119 -31
  86. package/content/container-blocks/flex.md +40 -62
  87. package/content/container-blocks/footer.md +15 -11
  88. package/content/container-blocks/googlemapsheatmap.md +1 -1
  89. package/content/container-blocks/googlemapsscript.md +2 -2
  90. package/content/container-blocks/header.md +71 -36
  91. package/content/container-blocks/label.md +34 -7
  92. package/content/container-blocks/layout.md +52 -34
  93. package/content/container-blocks/masonry.md +17 -71
  94. package/content/container-blocks/mobilemenu.md +131 -88
  95. package/content/container-blocks/modal.md +161 -26
  96. package/content/container-blocks/pageheadermenu.md +138 -31
  97. package/content/container-blocks/pagesidebarlayout.md +230 -27
  98. package/content/container-blocks/pagesidermenu.md +153 -43
  99. package/content/container-blocks/popover.md +34 -31
  100. package/content/container-blocks/result.md +32 -21
  101. package/content/container-blocks/sider.md +85 -122
  102. package/content/container-blocks/span.md +7 -7
  103. package/content/container-blocks/spinner.md +3 -3
  104. package/content/container-blocks/splitter.md +150 -68
  105. package/content/container-blocks/tabs.md +64 -12
  106. package/content/container-blocks/tooltip.md +22 -46
  107. package/content/container-blocks/watermark.md +22 -4
  108. package/content/controls/parallel_for.md +21 -2
  109. package/content/controls/reject.md +26 -3
  110. package/content/controls/return.md +17 -1
  111. package/content/controls/throw.md +30 -2
  112. package/content/controls/try.md +24 -2
  113. package/content/controls/while.md +46 -0
  114. package/content/deployment/deployment-environments.md +146 -0
  115. package/content/deployment/docker.md +23 -7
  116. package/content/deployment/node-server.md +4 -0
  117. package/content/deployment/vercel.md +25 -19
  118. package/content/display-blocks/aggrid.md +33 -16
  119. package/content/display-blocks/anchor.md +16 -15
  120. package/content/display-blocks/avatar.md +57 -37
  121. package/content/display-blocks/breadcrumb.md +70 -21
  122. package/content/display-blocks/button.md +93 -19
  123. package/content/display-blocks/calendar.md +12 -0
  124. package/content/display-blocks/clickablehtml.md +239 -0
  125. package/content/display-blocks/dangeroushtml.md +1 -1
  126. package/content/display-blocks/difflist.md +1 -1
  127. package/content/display-blocks/difftimeline.md +1 -1
  128. package/content/display-blocks/divider.md +64 -3
  129. package/content/display-blocks/dropdownbutton.md +81 -30
  130. package/content/display-blocks/echart.md +35 -1
  131. package/content/display-blocks/eventlog.md +363 -0
  132. package/content/display-blocks/floatbutton.md +129 -42
  133. package/content/display-blocks/html.md +61 -1
  134. package/content/display-blocks/icon.md +250 -67
  135. package/content/display-blocks/img.md +2 -2
  136. package/content/display-blocks/menu.md +146 -73
  137. package/content/display-blocks/message.md +38 -124
  138. package/content/display-blocks/notification.md +94 -222
  139. package/content/display-blocks/paragraph.md +59 -9
  140. package/content/display-blocks/pollingtimer.md +263 -0
  141. package/content/display-blocks/progress.md +96 -17
  142. package/content/display-blocks/qrcode.md +19 -4
  143. package/content/display-blocks/s3download.md +1 -1
  144. package/content/display-blocks/search.md +19 -9
  145. package/content/display-blocks/skeletonbutton.md +1 -0
  146. package/content/display-blocks/skeletoninput.md +1 -0
  147. package/content/display-blocks/statistic.md +75 -17
  148. package/content/display-blocks/steps.md +58 -25
  149. package/content/display-blocks/table.md +2527 -0
  150. package/content/display-blocks/tablelight.md +621 -0
  151. package/content/display-blocks/tag.md +102 -17
  152. package/content/display-blocks/title.md +50 -11
  153. package/content/display-blocks/tour.md +33 -23
  154. package/content/input-blocks/autocomplete.md +81 -9
  155. package/content/input-blocks/buttonselector.md +45 -8
  156. package/content/input-blocks/captcha.md +40 -0
  157. package/content/input-blocks/checkboxselector.md +97 -7
  158. package/content/input-blocks/checkboxswitch.md +33 -3
  159. package/content/input-blocks/colorselector.md +63 -14
  160. package/content/input-blocks/daterangeselector.md +165 -45
  161. package/content/input-blocks/dateselector.md +139 -41
  162. package/content/input-blocks/datetimeselector.md +158 -49
  163. package/content/input-blocks/inputgallery.md +3 -3
  164. package/content/input-blocks/intentinput.md +207 -0
  165. package/content/input-blocks/monthselector.md +120 -52
  166. package/content/input-blocks/multipleselector.md +150 -39
  167. package/content/input-blocks/numberinput.md +98 -12
  168. package/content/input-blocks/pagination.md +70 -14
  169. package/content/input-blocks/paragraphinput.md +51 -37
  170. package/content/input-blocks/passwordinput.md +60 -6
  171. package/content/input-blocks/phonenumberinput.md +59 -26
  172. package/content/input-blocks/placesautocomplete.md +319 -0
  173. package/content/input-blocks/radioselector.md +83 -7
  174. package/content/input-blocks/ratingslider.md +57 -26
  175. package/content/input-blocks/s3uploadbutton.md +24 -24
  176. package/content/input-blocks/s3uploaddragger.md +3 -3
  177. package/content/input-blocks/s3uploadphoto.md +5 -5
  178. package/content/input-blocks/segmentedselector.md +72 -32
  179. package/content/input-blocks/selector.md +109 -21
  180. package/content/input-blocks/switch.md +65 -17
  181. package/content/input-blocks/tableinput.md +445 -0
  182. package/content/input-blocks/tagmultipleselector.md +114 -0
  183. package/content/input-blocks/tagselector.md +114 -0
  184. package/content/input-blocks/textarea.md +32 -3
  185. package/content/input-blocks/textinput.md +70 -29
  186. package/content/input-blocks/tiptapinput.md +1 -1
  187. package/content/input-blocks/tiptapmentioninput.md +2 -2
  188. package/content/input-blocks/titleinput.md +39 -12
  189. package/content/input-blocks/treeinput.md +49 -25
  190. package/content/input-blocks/treemultipleselector.md +127 -10
  191. package/content/input-blocks/treeselector.md +97 -9
  192. package/content/input-blocks/upload.md +64 -15
  193. package/content/input-blocks/uploaddragger.md +17 -1
  194. package/content/input-blocks/uploadphoto.md +18 -1
  195. package/content/input-blocks/weekselector.md +120 -55
  196. package/content/learn/introduction.md +27 -0
  197. package/content/learn/quickstart.md +53 -0
  198. package/content/learn/showcase.md +8 -0
  199. package/content/list-blocks/controlledlist.md +24 -15
  200. package/content/list-blocks/list.md +11 -11
  201. package/content/list-blocks/masonrylist.md +7 -34
  202. package/content/migration/auth-upgrade.md +337 -0
  203. package/content/migration/upgrade-guide.md +1 -0
  204. package/content/migration/v3-to-v4.md +417 -0
  205. package/content/migration/v6-to-v7.md +620 -0
  206. package/content/operators/_agent.md +155 -0
  207. package/content/operators/_app.md +2 -1
  208. package/content/operators/_array.md +122 -1
  209. package/content/operators/_build.md +1 -0
  210. package/content/operators/_credential.md +57 -0
  211. package/content/operators/_cron.md +292 -0
  212. package/content/operators/_date.md +2 -0
  213. package/content/operators/_error.md +196 -0
  214. package/content/operators/_get.md +6 -6
  215. package/content/operators/_hmac.md +78 -0
  216. package/content/operators/_js.md +2 -1
  217. package/content/operators/_location.md +1 -1
  218. package/content/operators/_media.md +13 -0
  219. package/content/operators/_module.md +56 -2
  220. package/content/operators/_operator.md +17 -3
  221. package/content/operators/_path_params.md +82 -0
  222. package/content/operators/_ref.md +258 -0
  223. package/content/operators/_request.md +1 -1
  224. package/content/operators/_request_details.md +6 -0
  225. package/content/operators/_type.md +14 -3
  226. package/content/operators/_url_query.md +2 -0
  227. package/content/operators/_user.md +3 -3
  228. package/content/plugins/plugins-actions.md +10 -0
  229. package/content/plugins/plugins-connections.md +25 -0
  230. package/content/plugins/plugins-dev.md +66 -0
  231. package/content/plugins/plugins-icon-sets.md +267 -0
  232. package/content/plugins/plugins-introduction.md +27 -1
  233. package/content/plugins/plugins.md +19 -0
  234. package/content/plugins/posthog.md +359 -0
  235. package/content/provider-reference/auth-js-providers.md +107 -0
  236. package/content/provider-reference/openidconnectprovider.md +44 -0
  237. package/content/recipes/recipes.md +16 -0
  238. package/content/reference/actions-reference.md +31 -0
  239. package/content/reference/blocks-reference.md +35 -0
  240. package/content/reference/cli.md +403 -0
  241. package/content/reference/connections-reference.md +23 -0
  242. package/content/reference/operators-reference.md +47 -0
  243. package/content/reference/reference.md +16 -0
  244. package/content/reference/schema-reference.md +12 -0
  245. package/content/testing/config-tests.md +677 -0
  246. package/content/testing/e2e-configuration.md +31 -1
  247. package/content/testing/e2e-getting-started.md +1 -1
  248. package/content/testing/e2e-introduction.md +1 -1
  249. package/content/testing/e2e-writing-tests.md +12 -1
  250. package/content/testing/explore-pull-request.md +136 -0
  251. package/content/testing/journey-data-sets.md +326 -0
  252. package/content/tutorial/tutorial-actions-operators.md +2 -2
  253. package/content/tutorial/tutorial-add-blocks.md +2 -2
  254. package/content/tutorial/tutorial-create-page.md +48 -2
  255. package/content/tutorial/tutorial-display-data-page.md +3 -3
  256. package/content/tutorial/tutorial-requests-api.md +155 -0
  257. package/content/tutorial/tutorial-requests-sql.md +153 -0
  258. package/content/tutorial/tutorial-start.md +66 -1
  259. package/content/user-authentication/auth-configuration.md +267 -0
  260. package/content/user-authentication/auth-providers.md +24 -0
  261. package/content/user-authentication/auth-steps.md +141 -0
  262. package/content/user-authentication/login-and-logout.md +160 -8
  263. package/content/user-authentication/mcp-oauth.md +424 -0
  264. package/content/user-authentication/organizations.md +246 -0
  265. package/content/user-authentication/protected-pages-apis.md +97 -0
  266. package/content/user-authentication/roles.md +49 -0
  267. package/content/user-authentication/two-factor.md +229 -0
  268. package/content/user-authentication/user-object.md +58 -0
  269. package/content/user-authentication/users-introduction.md +8 -0
  270. package/content/websockets/websocket-publish.md +105 -0
  271. package/content/websockets/websocket-subscriptions.md +136 -0
  272. package/content/websockets/websockets-introduction.md +101 -0
  273. package/hazards.json +56 -0
  274. package/index.json +3472 -14
  275. package/package.json +10 -1
  276. package/scripts/extractAgentDocs.js +41 -30
  277. package/scripts/hashDocSources.js +38 -0
  278. package/scripts/isRedirectPage.js +26 -0
  279. package/scripts/recordSourceHashes.js +97 -0
  280. package/scripts/resolvePageSections.js +42 -0
  281. package/scripts/sectionKind.js +27 -0
  282. package/content/concepts/cli.md +0 -223
  283. package/content/other/introduction.md +0 -39
  284. package/content/other/next-auth-providers.md +0 -3
  285. /package/content/{other → actions}/updatesession.md +0 -0
@@ -328,7 +328,7 @@ Multiple algorithms can be combined by passing an array. Here dark and compact a
328
328
  disabled: true
329
329
  ```
330
330
 
331
- Setting componentDisabled to true disables all interactive child components at once, without needing to set disabled on each individual component.
331
+ Setting componentDisabled to true disables all interactive child components at once, without needing to set disabled on each individual component. A block that sets disabled to false stays enabled.
332
332
 
333
333
  ```yaml
334
334
  - id: cp_disabled
@@ -370,12 +370,30 @@ Setting componentDisabled to true disables all interactive child components at o
370
370
  label:
371
371
  title: Disabled input
372
372
  colon: false
373
+ - id: cp_disabled_selector
374
+ type: Selector
375
+ properties:
376
+ placeholder: Disabled selector
377
+ options:
378
+ - Option 1
379
+ - Option 2
380
+ label:
381
+ title: Disabled selector
382
+ colon: false
383
+ - id: cp_enabled_input
384
+ type: TextInput
385
+ properties:
386
+ placeholder: Still enabled
387
+ disabled: false
388
+ label:
389
+ title: "Re-enabled with disabled: false"
390
+ colon: false
373
391
  - id: cp_disabled_text
374
392
  type: Paragraph
375
393
  properties:
376
394
  content: Setting componentDisabled to true disables all interactive child
377
395
  components at once, without needing to set disabled on each individual
378
- component.
396
+ component. A block that sets disabled to false stays enabled.
379
397
  ```
380
398
 
381
399
  Setting direction to rtl enables right-to-left layout for all child components. This is essential for languages like Arabic and Hebrew.
@@ -399,7 +417,7 @@ Setting direction to rtl enables right-to-left layout for all child components.
399
417
  title: Right-to-Left
400
418
  color: primary
401
419
  variant: solid
402
- icon: AiOutlineArrowLeft
420
+ icon: arrow-left
403
421
  - id: cp_rtl_input
404
422
  type: TextInput
405
423
  properties:
@@ -751,10 +769,9 @@ This demonstrates using ConfigProvider to apply a brand theme across an entire s
751
769
  layout:
752
770
  flex: 0 0 auto
753
771
  properties:
754
- icon: AiOutlineShop
772
+ icon: Store
755
773
  size: 48
756
- color: "#fff"
757
- backgroundColor: "#e11d48"
774
+ color: "#e11d48"
758
775
  - id: cp_brand_title
759
776
  type: Title
760
777
  layout:
@@ -782,7 +799,7 @@ This demonstrates using ConfigProvider to apply a brand theme across an entire s
782
799
  placeholder: Search products...
783
800
  label:
784
801
  disabled: true
785
- suffixIcon: AiOutlineSearch
802
+ suffixIcon: search
786
803
  - id: cp_brand_search_btn
787
804
  type: Button
788
805
  layout:
@@ -797,7 +814,7 @@ This demonstrates using ConfigProvider to apply a brand theme across an entire s
797
814
  flex: 0 0 auto
798
815
  properties:
799
816
  title: Cart
800
- icon: AiOutlineShoppingCart
817
+ icon: ShoppingCart
801
818
  color: default
802
819
  variant: outlined
803
820
  - id: cp_brand_stats_row
@@ -939,7 +956,7 @@ System Metrics
939
956
  flex: 0 0 auto
940
957
  properties:
941
958
  title: Refresh
942
- icon: AiOutlineReload
959
+ icon: refresh
943
960
  color: primary
944
961
  variant: solid
945
962
  ```
@@ -1036,7 +1053,7 @@ A dark-themed admin panel using ConfigProvider to apply the dark algorithm with
1036
1053
  flex: 0 0 auto
1037
1054
  properties:
1038
1055
  title: Save User
1039
- icon: AiOutlineSave
1056
+ icon: save
1040
1057
  color: primary
1041
1058
  variant: solid
1042
1059
  - id: cp_admin_cancel_btn
@@ -1052,14 +1069,19 @@ A dark-themed admin panel using ConfigProvider to apply the dark algorithm with
1052
1069
  | Property | Type | Default | Description |
1053
1070
  | --- | --- | --- | --- |
1054
1071
  | `algorithm` | string \| array | - | Theme algorithm. Can be "default", "dark", "compact", or an array of these values. |
1055
- | `componentDisabled` | boolean | `false` | Set disabled state for all child components. |
1056
- | `componentSize` | string | - | Set size for all child components. Enum: `small`, `middle`, `large`. |
1072
+ | `componentDisabled` | boolean | `false` | Disable every input and button inside the ConfigProvider. A block that sets its own `disabled` property keeps that value, so `disabled: false` re-enables it. |
1073
+ | `componentSize` | string | - | Set size for all child components. `middle` is the older name for `medium`. Enum: `small`, `medium`, `middle`, `large`. |
1057
1074
  | `components` | object | - | Component-level token overrides. Keys are component names, values are token objects. |
1058
1075
  | `direction` | string | `"ltr"` | Direction of layout. Enum: `ltr`, `rtl`. |
1059
1076
  | `locale` | object | - | Antd locale object to localize built-in component strings (date pickers, pagination, modal, form validation). Pair with the _locale operator and config.i18n to keep the whole subtree in one language. |
1077
+ | `popupMatchSelectWidth` | boolean \| number | - | Whether dropdowns of select-like components match the width of their input. A number sets a minimum dropdown width in pixels. `false` also turns off virtual scrolling. |
1078
+ | `popupOverflow` | string | `"viewport"` | Keep dropdowns of select-like components inside the viewport, or let them follow the page scroll. Enum: `viewport`, `scroll`. |
1060
1079
  | `token` | object | - | Theme token configuration. Customize design tokens like colorPrimary, fontSize, etc. |
1080
+ | `virtual` | boolean | `true` | Set to false to turn off virtual scrolling in selectors, trees and tables, so every option renders. |
1081
+ | `wave` | object | - | Click wave effect of buttons and other clickable components. |
1082
+ | `wave.disabled` | boolean | `false` | Turn off the click wave effect. |
1061
1083
  | `variant` | string | - | Global input variant style for all child components. Enum: `outlined`, `filled`, `borderless`, `underlined`. |
1062
- | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). |
1084
+ | `theme` | object | - | Antd design token overrides for this block and its descendants. Merged with token, which takes precedence. See [antd design tokens](https://ant.design/components/overview#design-token). |
1063
1085
 
1064
1086
  No events defined.
1065
1087
 
@@ -275,14 +275,14 @@ Are you absolutely sure you want to delete this project and all its data?
275
275
  properties:
276
276
  title: Delete Item?
277
277
  content: This item will be permanently removed from the system.
278
- icon: AiOutlineDelete
278
+ icon: delete
279
279
  - id: confirm_icon_colored
280
280
  type: ConfirmModal
281
281
  properties:
282
282
  title: Danger Zone
283
283
  content: Are you absolutely sure you want to delete this project and all its data?
284
284
  icon:
285
- name: AiOutlineWarning
285
+ name: warning
286
286
  color: "#ff4d4f"
287
287
  size: 22
288
288
  ```
@@ -513,10 +513,11 @@ Your data will be exported to a CSV file and downloaded.
513
513
  status: confirm
514
514
  okText: Export
515
515
  okButton:
516
- icon: AiOutlineDownload
516
+ icon: download
517
+ iconPlacement: end
517
518
  cancelText: Cancel
518
519
  cancelButton:
519
- icon: AiOutlineClose
520
+ icon: close
520
521
  ```
521
522
 
522
523
  This modal uses style to apply custom CSS directly to the modal element.
@@ -718,7 +719,7 @@ The body CSS key targets the modal body area. This modal uses bg-bg-layout and p
718
719
  - id: confirm_css_element
719
720
  type: ConfirmModal
720
721
  class:
721
- element: rounded-2xl shadow-2xl
722
+ .element: rounded-2xl shadow-2xl
722
723
  properties:
723
724
  title: Styled Element
724
725
  content: The element CSS key applies Tailwind classes to the modal wrapper. This
@@ -726,7 +727,7 @@ The body CSS key targets the modal body area. This modal uses bg-bg-layout and p
726
727
  - id: confirm_css_body
727
728
  type: ConfirmModal
728
729
  class:
729
- body: bg-bg-layout p-6
730
+ .body: bg-bg-layout p-6
730
731
  properties:
731
732
  title: Styled Body
732
733
  content: The body CSS key targets the modal body area. This modal uses
@@ -839,10 +840,9 @@ James Park - Engineering Lead
839
840
  layout:
840
841
  flex: 0 0 auto
841
842
  properties:
842
- icon: AiOutlineUser
843
+ icon: user
843
844
  size: 32
844
- color: "#fff"
845
- backgroundColor: "#1677ff"
845
+ color: "#1677ff"
846
846
  - id: delete_flow_name_1
847
847
  type: Paragraph
848
848
  layout:
@@ -855,7 +855,7 @@ James Park - Engineering Lead
855
855
  flex: 0 0 auto
856
856
  properties:
857
857
  title: Remove
858
- icon: AiOutlineDelete
858
+ icon: delete
859
859
  color: danger
860
860
  variant: text
861
861
  size: small
@@ -883,10 +883,9 @@ James Park - Engineering Lead
883
883
  layout:
884
884
  flex: 0 0 auto
885
885
  properties:
886
- icon: AiOutlineUser
886
+ icon: user
887
887
  size: 32
888
- color: "#fff"
889
- backgroundColor: "#52c41a"
888
+ color: "#52c41a"
890
889
  - id: delete_flow_name_2
891
890
  type: Paragraph
892
891
  layout:
@@ -899,7 +898,7 @@ James Park - Engineering Lead
899
898
  flex: 0 0 auto
900
899
  properties:
901
900
  title: Remove
902
- icon: AiOutlineDelete
901
+ icon: delete
903
902
  color: danger
904
903
  variant: text
905
904
  size: small
@@ -920,7 +919,7 @@ James Park - Engineering Lead
920
919
  title: Remove Team Member
921
920
  status: error
922
921
  icon:
923
- name: AiOutlineUserDelete
922
+ name: UserMinus
924
923
  color: "#ff4d4f"
925
924
  okText: Remove
926
925
  okButton:
@@ -981,7 +980,7 @@ Please verify your ticket details before submitting. You will receive a confirma
981
980
  flex: 0 0 auto
982
981
  properties:
983
982
  title: Submit Ticket
984
- icon: AiOutlineSend
983
+ icon: send
985
984
  color: primary
986
985
  variant: solid
987
986
  events:
@@ -1002,7 +1001,7 @@ Please verify your ticket details before submitting. You will receive a confirma
1002
1001
  cancelText: Review Again
1003
1002
  centered: true
1004
1003
  width: 480
1005
- icon: AiOutlineCheckCircle
1004
+ icon: check-circle
1006
1005
  events:
1007
1006
  onOk:
1008
1007
  - id: form_submit_ok_msg
@@ -1086,7 +1085,7 @@ You have unsaved changes that will be lost if you leave this page. Do you want t
1086
1085
  content: You have unsaved changes that will be lost if you leave this page. Do
1087
1086
  you want to save your changes before leaving?
1088
1087
  status: warning
1089
- icon: AiOutlineWarning
1088
+ icon: warning
1090
1089
  okText: Save & Leave
1091
1090
  cancelText: Discard Changes
1092
1091
  closable: true
@@ -1112,15 +1111,62 @@ You have unsaved changes that will be lost if you leave this page. Do you want t
1112
1111
  | --- | --- | --- | --- |
1113
1112
  | `title` | string | - | Modal title - supports html. |
1114
1113
  | `centered` | boolean | `false` | Centered Modal. |
1115
- | `closable` | boolean | `false` | Whether a close (x) button is visible on top right of the confirm dialog or not. |
1114
+ | `closable` | boolean \| object | `false` | Whether a close (x) button is visible on top right of the confirm dialog or not. Set `{ disabled: true }` to show the button disabled. |
1115
+ | `closable.disabled` | boolean | `false` | Show the close button, but disabled. |
1116
1116
  | `content` | string | - | Modal content. Overridden by the "content" content area - supports html. |
1117
- | `icon` | string \| object | - | Name of an React-Icon (See all icons) or properties of an Icon block to customize modal icon. |
1118
- | `mask` | boolean | `true` | Whether show mask or not. |
1119
- | `maskClosable` | boolean | `false` | Whether to close the modal dialog when the mask (area outside the modal) is clicked. |
1117
+ | `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 customize modal icon. |
1118
+ | `icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
1119
+ | `icon.color` | string | - | Icon color. |
1120
+ | `icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
1121
+ | `icon.rotate` | number | - | Number of degrees to rotate the icon. |
1122
+ | `icon.spin` | boolean | - | Continuously spin the icon with animation. |
1123
+ | `icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
1124
+ | `icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
1125
+ | `icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
1126
+ | `icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
1127
+ | `focusable` | object | - | Focus management of the dialog. |
1128
+ | `focusable.trap` | boolean | `true` | Keep keyboard focus inside the dialog while it is open. |
1129
+ | `focusable.focusTriggerAfterClose` | boolean | `true` | Return focus to the element that opened the dialog after it closes. |
1130
+ | `focusable.autoFocusButton` | string \| null | `"ok"` | The button that receives focus when the confirm modal opens. Set to null to focus neither. Enum: `ok`, `cancel`, `null`. |
1131
+ | `keyboard` | boolean | `true` | Whether pressing Esc closes the confirm modal. |
1132
+ | `mask` | boolean \| object | `true` | Whether to show the mask. Set an object to configure the mask with `enabled`, `blur` and `closable`. |
1133
+ | `mask.enabled` | boolean | `true` | Whether to show the mask. |
1134
+ | `mask.blur` | boolean | `false` | Blur the page behind the mask. |
1135
+ | `mask.closable` | boolean | - | Whether clicking the mask closes the dialog. Takes precedence over `maskClosable`. |
1136
+ | `maskClosable` | boolean | `false` | Whether to close the modal dialog when the mask (area outside the modal) is clicked. `mask.closable` takes precedence. |
1137
+ | `scrollLock` | boolean | `true` | Whether to lock page scrolling while the confirm modal is open. |
1120
1138
  | `okText` | string | - | Text of the Ok button. When unset, antd uses the localized default from ConfigProvider locale. |
1121
1139
  | `cancelText` | string | - | Text of the Cancel button. When unset, antd uses the localized default from ConfigProvider locale. |
1122
1140
  | `okButton` | object | - | Ok button properties. |
1141
+ | `okButton.type` | string | - | The button type. Enum: `default`, `primary`, `dashed`, `text`, `link`. |
1142
+ | `okButton.danger` | boolean | `false` | Set the danger status of the button. |
1143
+ | `okButton.disabled` | boolean | `false` | Disable the button. |
1144
+ | `okButton.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 show in the button. |
1145
+ | `okButton.icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
1146
+ | `okButton.icon.color` | string | - | Icon color. |
1147
+ | `okButton.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
1148
+ | `okButton.icon.rotate` | number | - | Number of degrees to rotate the icon. |
1149
+ | `okButton.icon.spin` | boolean | - | Continuously spin the icon with animation. |
1150
+ | `okButton.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
1151
+ | `okButton.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
1152
+ | `okButton.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
1153
+ | `okButton.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
1154
+ | `okButton.iconPlacement` | string | `"start"` | Place the icon before (`start`) or after (`end`) the button text. Enum: `start`, `end`. |
1123
1155
  | `cancelButton` | object | - | Cancel button properties. |
1156
+ | `cancelButton.type` | string | - | The button type. Enum: `default`, `primary`, `dashed`, `text`, `link`. |
1157
+ | `cancelButton.danger` | boolean | `false` | Set the danger status of the button. |
1158
+ | `cancelButton.disabled` | boolean | `false` | Disable the button. |
1159
+ | `cancelButton.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 show in the button. |
1160
+ | `cancelButton.icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
1161
+ | `cancelButton.icon.color` | string | - | Icon color. |
1162
+ | `cancelButton.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
1163
+ | `cancelButton.icon.rotate` | number | - | Number of degrees to rotate the icon. |
1164
+ | `cancelButton.icon.spin` | boolean | - | Continuously spin the icon with animation. |
1165
+ | `cancelButton.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
1166
+ | `cancelButton.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
1167
+ | `cancelButton.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
1168
+ | `cancelButton.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
1169
+ | `cancelButton.iconPlacement` | string | `"start"` | Place the icon before (`start`) or after (`end`) the button text. Enum: `start`, `end`. |
1124
1170
  | `width` | number \| string | `416` | Width of the modal dialog. |
1125
1171
  | `zIndex` | number | `1000` | The z-index of the Modal. |
1126
1172
  | `status` | string | `"confirm"` | Modal status type. Enum: `success`, `error`, `info`, `warning`, `confirm`. |
@@ -1143,7 +1189,7 @@ You have unsaved changes that will be lost if you leave this page. Do you want t
1143
1189
  | `onOk` | \- | Trigger actions when Ok button is clicked. |
1144
1190
  | `onOpen` | \- | Trigger actions when confirm modal is opened. |
1145
1191
  | `onCancel` | \- | Trigger actions when Cancel button is clicked. |
1146
- | `onClose` | \- | Triggered after onOk or onCancel actions are completed. |
1192
+ | `onClose` | \- | Trigger actions after the confirm modal has closed, once the onOk or onCancel actions are completed. |
1147
1193
 
1148
1194
  | Key | Target |
1149
1195
  | --- | --- |
@@ -70,7 +70,8 @@ Content works within a Layout alongside Header and Footer blocks to form a compl
70
70
  properties:
71
71
  content: My Application
72
72
  level: 4
73
- style:
73
+ style:
74
+ .element:
74
75
  margin: 0
75
76
  - id: content_full_page_main
76
77
  type: Content
@@ -124,7 +125,8 @@ When used alongside a Sider block, Content fills the remaining horizontal space.
124
125
  properties:
125
126
  content: App with Sidebar
126
127
  level: 4
127
- style:
128
+ style:
129
+ .element:
128
130
  margin: 0
129
131
  - id: content_sider_inner
130
132
  type: Layout
@@ -145,16 +147,22 @@ When used alongside a Sider block, Content fills the remaining horizontal space.
145
147
  type: Menu
146
148
  properties:
147
149
  mode: inline
148
- options:
149
- - id: dashboard
150
- title: Dashboard
151
- icon: AiOutlineDashboard
152
- - id: users
153
- title: Users
154
- icon: AiOutlineUser
155
- - id: settings
156
- title: Settings
157
- icon: AiOutlineSetting
150
+ links:
151
+ - id: cs_dashboard
152
+ type: MenuLink
153
+ properties:
154
+ title: Dashboard
155
+ icon: Gauge
156
+ - id: cs_users
157
+ type: MenuLink
158
+ properties:
159
+ title: Users
160
+ icon: user
161
+ - id: cs_settings
162
+ type: MenuLink
163
+ properties:
164
+ title: Settings
165
+ icon: settings
158
166
  - id: content_sider_main
159
167
  type: Content
160
168
  layout:
@@ -178,94 +186,40 @@ When used alongside a Sider block, Content fills the remaining horizontal space.
178
186
  admin dashboards and applications with navigation sidebars.
179
187
  ```
180
188
 
181
- Themed Content Area
182
-
183
- Use the theme property to override antd design tokens. The colorBgLayout token changes the background of the Content block, and colorText adjusts the default text color within it.
184
-
185
- Warm Color Scheme
186
-
187
- A warm-toned content area using orange theme tokens. Theme tokens cascade through the antd design system and affect all child blocks within this Content.
188
-
189
- Dark Content Area
190
-
191
- Dark-themed content using colorBgLayout and colorText tokens. For app-wide dark themes, prefer using a global ConfigProvider rather than per-block overrides.
192
-
193
189
  ```yaml
194
190
  - id: content_theme_layout
195
191
  type: Layout
192
+ properties:
193
+ theme:
194
+ bodyBg: "#e6f4ff"
196
195
  blocks:
197
196
  - id: content_theme_custom
198
197
  type: Content
199
198
  style:
200
199
  padding: 24px
201
200
  minHeight: 150px
202
- properties:
203
- theme:
204
- colorText: "#003a8c"
205
201
  blocks:
206
- - id: content_theme_title
207
- type: Title
208
- properties:
209
- content: Themed Content Area
210
- level: 4
211
202
  - id: content_theme_text
212
- type: Paragraph
203
+ type: Html
213
204
  properties:
214
- content: >
215
- Use the theme property to override antd design tokens. The
216
- colorBgLayout token changes the background of the Content block,
217
- and colorText adjusts the default text color within it.
205
+ html: The parent Layout theme sets the background behind the Content area with
206
+ the bodyBg token.
218
207
  - id: content_theme_warm_layout
219
208
  type: Layout
209
+ properties:
210
+ theme:
211
+ bodyBg: "#fff7e6"
220
212
  blocks:
221
213
  - id: content_theme_warm
222
214
  type: Content
223
215
  style:
224
216
  padding: 24px
225
217
  minHeight: 150px
226
- properties:
227
- theme:
228
- colorText: "#874d00"
229
218
  blocks:
230
- - id: content_theme_warm_title
231
- type: Title
232
- properties:
233
- content: Warm Color Scheme
234
- level: 4
235
219
  - id: content_theme_warm_text
236
- type: Paragraph
237
- properties:
238
- content: >
239
- A warm-toned content area using orange theme tokens. Theme tokens
240
- cascade through the antd design system and affect all child blocks
241
- within this Content.
242
- - id: content_theme_dark_layout
243
- type: Layout
244
- blocks:
245
- - id: content_theme_dark
246
- type: Content
247
- style:
248
- padding: 24px
249
- minHeight: 150px
250
- properties:
251
- theme:
252
- colorBgLayout: "#1f1f1f"
253
- colorText: "#e0e0e0"
254
- blocks:
255
- - id: content_theme_dark_title
256
- type: Title
257
- class: text-text-secondary
220
+ type: Html
258
221
  properties:
259
- content: Dark Content Area
260
- level: 4
261
- - id: content_theme_dark_text
262
- type: Paragraph
263
- class: text-text-secondary
264
- properties:
265
- content: >
266
- Dark-themed content using colorBgLayout and colorText tokens. For
267
- app-wide dark themes, prefer using a global ConfigProvider rather
268
- than per-block overrides.
222
+ html: A warm-toned content area from the same Layout token.
269
223
  ```
270
224
 
271
225
  Rounded Content with Tailwind
@@ -287,7 +241,7 @@ A left accent border highlights the content area. Combine Tailwind border utilit
287
241
  - id: content_css_rounded
288
242
  type: Content
289
243
  class:
290
- element: bg-bg-layout rounded-xl p-6 m-4
244
+ .element: bg-bg-layout rounded-xl p-6 m-4
291
245
  style:
292
246
  minHeight: 150px
293
247
  blocks:
@@ -308,7 +262,7 @@ A left accent border highlights the content area. Combine Tailwind border utilit
308
262
  - id: content_css_gradient
309
263
  type: Content
310
264
  class:
311
- element: bg-gradient-to-br from-primary/10 to-primary/5 p-8 m-4 rounded-lg
265
+ .element: bg-gradient-to-br from-primary/10 to-primary/5 p-8 m-4 rounded-lg
312
266
  shadow-inner
313
267
  style:
314
268
  minHeight: 150px
@@ -331,7 +285,7 @@ A left accent border highlights the content area. Combine Tailwind border utilit
331
285
  - id: content_css_border
332
286
  type: Content
333
287
  class:
334
- element: border-l-4 border-l-green-500 bg-bg-layout p-6 m-4
288
+ .element: border-l-4 border-l-green-500 bg-bg-layout p-6 m-4
335
289
  style:
336
290
  minHeight: 150px
337
291
  blocks:
@@ -377,7 +331,8 @@ New team member Sarah joined — 1 hour ago
377
331
  properties:
378
332
  content: Analytics Dashboard
379
333
  level: 4
380
- style:
334
+ style:
335
+ .element:
381
336
  margin: 0
382
337
  - id: content_dashboard_header_btn
383
338
  type: Button
@@ -385,7 +340,7 @@ New team member Sarah joined — 1 hour ago
385
340
  flex: 0 0 auto
386
341
  properties:
387
342
  title: Export Report
388
- icon: AiOutlineDownload
343
+ icon: download
389
344
  color: default
390
345
  variant: outlined
391
346
  size: small
@@ -408,19 +363,27 @@ New team member Sarah joined — 1 hour ago
408
363
  type: Menu
409
364
  properties:
410
365
  mode: inline
411
- options:
412
- - id: overview
413
- title: Overview
414
- icon: AiOutlineHome
415
- - id: analytics
416
- title: Analytics
417
- icon: AiOutlineBarChart
418
- - id: reports
419
- title: Reports
420
- icon: AiOutlineFileText
421
- - id: team
422
- title: Team
423
- icon: AiOutlineTeam
366
+ links:
367
+ - id: cd_overview
368
+ type: MenuLink
369
+ properties:
370
+ title: Overview
371
+ icon: home
372
+ - id: cd_analytics
373
+ type: MenuLink
374
+ properties:
375
+ title: Analytics
376
+ icon: chart
377
+ - id: cd_reports
378
+ type: MenuLink
379
+ properties:
380
+ title: Reports
381
+ icon: document
382
+ - id: cd_team
383
+ type: MenuLink
384
+ properties:
385
+ title: Team
386
+ icon: users
424
387
  - id: content_dashboard_main
425
388
  type: Content
426
389
  layout:
@@ -514,7 +477,8 @@ Update your personal details and preferences below.
514
477
  properties:
515
478
  content: Account Settings
516
479
  level: 4
517
- style:
480
+ style:
481
+ .element:
518
482
  margin: 0
519
483
  - id: content_settings_main
520
484
  type: Content
@@ -571,7 +535,7 @@ Update your personal details and preferences below.
571
535
  title: Save Changes
572
536
  color: primary
573
537
  variant: solid
574
- icon: AiOutlineSave
538
+ icon: save
575
539
  events:
576
540
  onClick:
577
541
  - id: content_settings_save_msg
@@ -583,7 +547,7 @@ Update your personal details and preferences below.
583
547
 
584
548
  | Property | Type | Default | Description |
585
549
  | --- | --- | --- | --- |
586
- | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). |
550
+ | `theme` | object | - | Not applied: antd scopes Layout design tokens to the Layout element, so set tokens such as headerHeight or footerBg on the parent Layout block theme. |
587
551
 
588
552
  No events defined.
589
553