@lowdefy/docs-content 0.0.0-experimental-20260928120643 → 6.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.
Files changed (226) hide show
  1. package/README.md +0 -1
  2. package/content/actions/link.md +0 -17
  3. package/content/actions/login.md +5 -23
  4. package/content/actions/logout.md +5 -5
  5. package/content/actions/pdfmake.md +2 -2
  6. package/content/actions/setdarkmode.md +2 -2
  7. package/content/agents/agent-properties.md +2 -4
  8. package/content/agents/agentchat.md +6 -21
  9. package/content/agents/agentconversations.md +2 -2
  10. package/content/concepts/ai-agent-docs.md +101 -313
  11. package/content/concepts/cli.md +3 -34
  12. package/content/concepts/connections-and-requests.md +0 -402
  13. package/content/concepts/custom-html.md +0 -40
  14. package/content/concepts/custom-styling.md +5 -50
  15. package/content/concepts/events-and-actions.md +2 -64
  16. package/content/concepts/i18n.md +2 -7
  17. package/content/concepts/keyboard-shortcuts.md +2 -2
  18. package/content/concepts/layout-overview.md +1 -1
  19. package/content/concepts/logger.md +0 -81
  20. package/content/concepts/lowdefy-schema.md +1 -4
  21. package/content/concepts/menus.md +7 -7
  22. package/content/concepts/module-authoring.md +2 -2
  23. package/content/connections/anthropic.md +2 -162
  24. package/content/connections/awss3.md +0 -54
  25. package/content/connections/google.md +2 -162
  26. package/content/connections/mongodb.md +3 -121
  27. package/content/connections/openai-connection.md +2 -162
  28. package/content/container-blocks/affix.md +7 -47
  29. package/content/container-blocks/alert.md +24 -76
  30. package/content/container-blocks/badge.md +24 -100
  31. package/content/container-blocks/box.md +9 -9
  32. package/content/container-blocks/card.md +25 -80
  33. package/content/container-blocks/carousel.md +7 -60
  34. package/content/container-blocks/collapse.md +9 -87
  35. package/content/container-blocks/configprovider.md +13 -35
  36. package/content/container-blocks/confirmmodal.md +23 -69
  37. package/content/container-blocks/content.md +98 -62
  38. package/content/container-blocks/descriptions.md +4 -45
  39. package/content/container-blocks/drawer.md +28 -92
  40. package/content/container-blocks/dropdownmenu.md +31 -119
  41. package/content/container-blocks/flex.md +62 -40
  42. package/content/container-blocks/footer.md +11 -15
  43. package/content/container-blocks/googlemapsheatmap.md +1 -1
  44. package/content/container-blocks/googlemapsscript.md +2 -2
  45. package/content/container-blocks/header.md +36 -71
  46. package/content/container-blocks/label.md +7 -34
  47. package/content/container-blocks/layout.md +34 -52
  48. package/content/container-blocks/masonry.md +71 -17
  49. package/content/container-blocks/mobilemenu.md +88 -131
  50. package/content/container-blocks/modal.md +26 -114
  51. package/content/container-blocks/pageheadermenu.md +31 -81
  52. package/content/container-blocks/pagesidebarlayout.md +26 -169
  53. package/content/container-blocks/pagesidermenu.md +42 -95
  54. package/content/container-blocks/popover.md +31 -34
  55. package/content/container-blocks/result.md +21 -32
  56. package/content/container-blocks/sider.md +122 -85
  57. package/content/container-blocks/span.md +7 -7
  58. package/content/container-blocks/spinner.md +3 -3
  59. package/content/container-blocks/splitter.md +68 -150
  60. package/content/container-blocks/tabs.md +12 -64
  61. package/content/container-blocks/tooltip.md +46 -22
  62. package/content/container-blocks/watermark.md +4 -22
  63. package/content/controls/reject.md +2 -4
  64. package/content/controls/throw.md +0 -1
  65. package/content/controls/try.md +2 -3
  66. package/content/deployment/deployment-environments.md +6 -8
  67. package/content/deployment/docker.md +7 -22
  68. package/content/deployment/node-server.md +0 -4
  69. package/content/deployment/vercel.md +6 -13
  70. package/content/display-blocks/aggrid.md +11 -26
  71. package/content/display-blocks/anchor.md +15 -15
  72. package/content/display-blocks/avatar.md +37 -57
  73. package/content/display-blocks/breadcrumb.md +21 -70
  74. package/content/display-blocks/button.md +18 -92
  75. package/content/display-blocks/calendar.md +0 -12
  76. package/content/display-blocks/dangeroushtml.md +1 -1
  77. package/content/display-blocks/difflist.md +1 -1
  78. package/content/display-blocks/difftimeline.md +1 -1
  79. package/content/display-blocks/divider.md +3 -64
  80. package/content/display-blocks/dropdownbutton.md +28 -79
  81. package/content/display-blocks/echart.md +1 -35
  82. package/content/display-blocks/floatbutton.md +42 -129
  83. package/content/display-blocks/html.md +1 -61
  84. package/content/display-blocks/icon.md +67 -250
  85. package/content/display-blocks/menu.md +73 -145
  86. package/content/display-blocks/message.md +124 -38
  87. package/content/display-blocks/notification.md +222 -94
  88. package/content/display-blocks/paragraph.md +9 -59
  89. package/content/display-blocks/progress.md +17 -96
  90. package/content/display-blocks/qrcode.md +4 -19
  91. package/content/display-blocks/s3download.md +1 -1
  92. package/content/display-blocks/search.md +7 -17
  93. package/content/display-blocks/skeletonbutton.md +0 -1
  94. package/content/display-blocks/skeletoninput.md +0 -1
  95. package/content/display-blocks/statistic.md +17 -75
  96. package/content/display-blocks/steps.md +25 -58
  97. package/content/display-blocks/tag.md +17 -102
  98. package/content/display-blocks/title.md +11 -50
  99. package/content/display-blocks/tour.md +23 -33
  100. package/content/input-blocks/autocomplete.md +9 -81
  101. package/content/input-blocks/buttonselector.md +8 -45
  102. package/content/input-blocks/checkboxselector.md +7 -97
  103. package/content/input-blocks/checkboxswitch.md +3 -33
  104. package/content/input-blocks/colorselector.md +14 -63
  105. package/content/input-blocks/daterangeselector.md +45 -165
  106. package/content/input-blocks/dateselector.md +41 -139
  107. package/content/input-blocks/datetimeselector.md +49 -158
  108. package/content/input-blocks/inputgallery.md +3 -3
  109. package/content/input-blocks/monthselector.md +52 -120
  110. package/content/input-blocks/multipleselector.md +39 -150
  111. package/content/input-blocks/numberinput.md +12 -98
  112. package/content/input-blocks/pagination.md +14 -70
  113. package/content/input-blocks/paragraphinput.md +37 -51
  114. package/content/input-blocks/passwordinput.md +6 -60
  115. package/content/input-blocks/phonenumberinput.md +26 -59
  116. package/content/input-blocks/radioselector.md +7 -83
  117. package/content/input-blocks/ratingslider.md +26 -57
  118. package/content/input-blocks/s3uploadbutton.md +24 -24
  119. package/content/input-blocks/s3uploaddragger.md +3 -3
  120. package/content/input-blocks/s3uploadphoto.md +5 -5
  121. package/content/input-blocks/segmentedselector.md +32 -72
  122. package/content/input-blocks/selector.md +21 -109
  123. package/content/input-blocks/switch.md +17 -65
  124. package/content/input-blocks/textarea.md +3 -32
  125. package/content/input-blocks/textinput.md +28 -69
  126. package/content/input-blocks/tiptapmentioninput.md +1 -1
  127. package/content/input-blocks/titleinput.md +12 -39
  128. package/content/input-blocks/treeinput.md +25 -49
  129. package/content/input-blocks/treemultipleselector.md +10 -127
  130. package/content/input-blocks/treeselector.md +9 -97
  131. package/content/input-blocks/upload.md +15 -64
  132. package/content/input-blocks/uploaddragger.md +1 -17
  133. package/content/input-blocks/uploadphoto.md +1 -18
  134. package/content/input-blocks/weekselector.md +55 -120
  135. package/content/list-blocks/controlledlist.md +15 -24
  136. package/content/list-blocks/list.md +11 -11
  137. package/content/list-blocks/masonrylist.md +34 -7
  138. package/content/migration/upgrade-guide.md +0 -1
  139. package/content/operators/_app.md +1 -2
  140. package/content/operators/_error.md +1 -23
  141. package/content/operators/_get.md +6 -6
  142. package/content/operators/_operator.md +3 -17
  143. package/content/operators/_ref.md +0 -258
  144. package/content/operators/_type.md +3 -14
  145. package/content/operators/_user.md +3 -3
  146. package/content/other/introduction.md +1 -1
  147. package/content/plugins/plugins-dev.md +0 -66
  148. package/content/plugins/plugins-introduction.md +1 -27
  149. package/content/testing/e2e-configuration.md +1 -8
  150. package/content/testing/e2e-getting-started.md +1 -1
  151. package/content/testing/e2e-introduction.md +1 -1
  152. package/content/tutorial/tutorial-actions-operators.md +2 -2
  153. package/content/tutorial/tutorial-add-blocks.md +2 -2
  154. package/content/tutorial/tutorial-create-page.md +2 -48
  155. package/content/tutorial/tutorial-display-data-page.md +3 -3
  156. package/content/tutorial/tutorial-requests-sql.md +0 -153
  157. package/content/tutorial/tutorial-start.md +1 -66
  158. package/content/user-authentication/login-and-logout.md +8 -158
  159. package/content/user-authentication/users-introduction.md +0 -8
  160. package/index.json +2 -6065
  161. package/package.json +1 -7
  162. package/scripts/extractAgentDocs.js +4 -36
  163. package/content/actions/emailotpsend.md +0 -58
  164. package/content/actions/emailotpverify.md +0 -77
  165. package/content/actions/getlocalstorage.md +0 -41
  166. package/content/actions/magiclinkverify.md +0 -113
  167. package/content/actions/posthogalias.md +0 -29
  168. package/content/actions/posthogcapture.md +0 -49
  169. package/content/actions/posthogcapturepageleave.md +0 -38
  170. package/content/actions/posthogfeatureflag.md +0 -50
  171. package/content/actions/posthoggroup.md +0 -37
  172. package/content/actions/posthogidentify.md +0 -54
  173. package/content/actions/posthoginit.md +0 -66
  174. package/content/actions/posthogoptin.md +0 -29
  175. package/content/actions/posthogoptout.md +0 -29
  176. package/content/actions/posthogpageview.md +0 -37
  177. package/content/actions/posthogreloadfeatureflags.md +0 -47
  178. package/content/actions/posthogreset.md +0 -28
  179. package/content/actions/posthogsetpersonproperties.md +0 -36
  180. package/content/actions/removelocalstorage.md +0 -26
  181. package/content/actions/setlocalstorage.md +0 -32
  182. package/content/adapter-reference/mongodbauthadapter.md +0 -46
  183. package/content/agents/agents-introduction.md +0 -107
  184. package/content/callback-reference/auth0logoutcallback.md +0 -54
  185. package/content/concepts/blocks.md +0 -150
  186. package/content/concepts/dynamic-page-content.md +0 -304
  187. package/content/concepts/html-attributes.md +0 -285
  188. package/content/concepts/lowdefy-api.md +0 -1110
  189. package/content/concepts/notifications.md +0 -155
  190. package/content/concepts/page-and-app-state.md +0 -244
  191. package/content/concepts/theming.md +0 -582
  192. package/content/connections/aigateway.md +0 -368
  193. package/content/connections/axioshttp.md +0 -181
  194. package/content/controls/while.md +0 -46
  195. package/content/display-blocks/clickablehtml.md +0 -239
  196. package/content/display-blocks/eventlog.md +0 -363
  197. package/content/display-blocks/pollingtimer.md +0 -263
  198. package/content/input-blocks/captcha.md +0 -40
  199. package/content/input-blocks/placesautocomplete.md +0 -319
  200. package/content/input-blocks/tagmultipleselector.md +0 -114
  201. package/content/input-blocks/tagselector.md +0 -114
  202. package/content/migration/auth-upgrade.md +0 -327
  203. package/content/migration/v3-to-v4.md +0 -417
  204. package/content/migration/v6-to-v7.md +0 -222
  205. package/content/operators/_cron.md +0 -292
  206. package/content/other/mongodbadapter.md +0 -3
  207. package/content/plugins/plugins-icon-sets.md +0 -267
  208. package/content/plugins/posthog.md +0 -275
  209. package/content/provider-reference/auth-js-providers.md +0 -107
  210. package/content/provider-reference/openidconnectprovider.md +0 -44
  211. package/content/testing/config-tests.md +0 -278
  212. package/content/tutorial/tutorial-requests-api.md +0 -155
  213. package/content/user-authentication/auth-configuration.md +0 -266
  214. package/content/user-authentication/auth-steps.md +0 -138
  215. package/content/user-authentication/mcp-oauth.md +0 -292
  216. package/content/user-authentication/organizations.md +0 -221
  217. package/content/user-authentication/protected-pages-apis.md +0 -97
  218. package/content/user-authentication/roles.md +0 -49
  219. package/content/user-authentication/two-factor.md +0 -229
  220. package/content/user-authentication/user-object.md +0 -58
  221. package/content/websockets/websocket-publish.md +0 -108
  222. package/content/websockets/websocket-subscriptions.md +0 -100
  223. package/content/websockets/websockets-introduction.md +0 -97
  224. package/hazards.json +0 -44
  225. package/scripts/hashDocSources.js +0 -38
  226. package/scripts/recordSourceHashes.js +0 -88
@@ -1,6 +1,6 @@
1
1
  # Modal
2
2
 
3
- Modal dialog overlay for focused content. Add `shortcut: Escape` to the `onClose` event to run custom actions when Escape is pressed. Ant Design's Modal already closes on Escape by default — the shortcut triggers your custom actions in addition to the built-in close.
3
+ Modal dialog overlay for focused content. Add `shortcut: Escape` to the `onClose` event to run custom actions when Escape is pressed. Ant Design's Modal already closes on Escape by default — the shortcut triggers your custom actions in addition to the built-in close.
4
4
 
5
5
  This is a basic modal dialog with a title, content area, and default Ok/Cancel buttons.
6
6
 
@@ -340,8 +340,6 @@ The mask is visible but clicking it does not close the modal. Users must use the
340
340
 
341
341
  No mask overlay is shown behind the modal. The page content remains fully visible.
342
342
 
343
- The page behind the mask is blurred, which keeps attention on the dialog.
344
-
345
343
  ```yaml
346
344
  - id: modal_mask_not_closable_trigger
347
345
  type: Button
@@ -399,71 +397,6 @@ The page behind the mask is blurred, which keeps attention on the dialog.
399
397
  properties:
400
398
  content: No mask overlay is shown behind the modal. The page content remains
401
399
  fully visible.
402
- - id: modal_blur_mask_trigger
403
- type: Button
404
- layout:
405
- flex: 0 0 auto
406
- properties:
407
- title: Blurred Mask
408
- color: primary
409
- variant: outlined
410
- events:
411
- onClick:
412
- - id: modal_blur_mask_open
413
- type: CallMethod
414
- params:
415
- blockId: modal_blur_mask
416
- method: setOpen
417
- args:
418
- - open: true
419
- - id: modal_blur_mask
420
- type: Modal
421
- properties:
422
- title: Blurred Mask
423
- mask:
424
- blur: true
425
- blocks:
426
- - id: modal_blur_mask_content
427
- type: Paragraph
428
- properties:
429
- content: The page behind the mask is blurred, which keeps attention on the
430
- dialog.
431
- ```
432
-
433
- The body shows a skeleton while loading is true, for example while a request that fills the modal is running.
434
-
435
- ```yaml
436
- - id: modal_loading_trigger
437
- type: Button
438
- layout:
439
- flex: 0 0 auto
440
- properties:
441
- title: Open Loading Modal
442
- color: primary
443
- variant: outlined
444
- events:
445
- onClick:
446
- - id: modal_loading_open
447
- type: CallMethod
448
- params:
449
- blockId: modal_loading
450
- method: setOpen
451
- args:
452
- - open: true
453
- - id: modal_loading
454
- type: Modal
455
- properties:
456
- title: Customer Details
457
- loading: true
458
- width:
459
- xs: 90%
460
- md: 600
461
- blocks:
462
- - id: modal_loading_content
463
- type: Paragraph
464
- properties:
465
- content: The body shows a skeleton while loading is true, for example while a
466
- request that fills the modal is running.
467
400
  ```
468
401
 
469
402
  Setting footer to false removes the Ok and Cancel buttons entirely. This is useful for informational dialogs or when you provide your own action buttons in the content area.
@@ -557,7 +490,7 @@ The footer slot replaces the default Ok/Cancel buttons with custom content. This
557
490
  title: Delete
558
491
  color: danger
559
492
  variant: text
560
- icon: delete
493
+ icon: AiOutlineDelete
561
494
  - id: modal_footer_actions
562
495
  type: Box
563
496
  layout:
@@ -589,7 +522,7 @@ The footer slot replaces the default Ok/Cancel buttons with custom content. This
589
522
  title: Save
590
523
  color: primary
591
524
  variant: solid
592
- icon: save
525
+ icon: AiOutlineSave
593
526
  events:
594
527
  onClick:
595
528
  - id: modal_footer_save_close
@@ -608,7 +541,7 @@ The footer slot replaces the default Ok/Cancel buttons with custom content. This
608
541
  Save/Cancel on the right.
609
542
  ```
610
543
 
611
- The style .wrapper key applies CSS to the modal wrapper element. This can control overflow, positioning, and other layout aspects of the wrapper container.
544
+ The wrapperStyle property applies CSS to the modal wrapper element. This can control overflow, positioning, and other layout aspects of the wrapper container.
612
545
 
613
546
  ```yaml
614
547
  - id: modal_wrapper_style_trigger
@@ -632,16 +565,15 @@ The style .wrapper key applies CSS to the modal wrapper element. This can contro
632
565
  type: Modal
633
566
  properties:
634
567
  title: Wrapper Style Modal
635
- style:
636
- .wrapper:
568
+ wrapperStyle:
637
569
  overflow: hidden
638
570
  blocks:
639
571
  - id: modal_wrapper_style_content
640
572
  type: Paragraph
641
573
  properties:
642
- content: The style .wrapper key applies CSS to the modal wrapper element. This
643
- can control overflow, positioning, and other layout aspects of the
644
- wrapper container.
574
+ content: The wrapperStyle property applies CSS to the modal wrapper element.
575
+ This can control overflow, positioning, and other layout aspects of
576
+ the wrapper container.
645
577
  ```
646
578
 
647
579
  This modal uses a custom z-index of 2000 to ensure it appears above other overlays. The default is 1000.
@@ -688,7 +620,7 @@ This modal uses the toggleOpen method. Each click of the button alternates betwe
688
620
  title: Toggle Modal
689
621
  color: primary
690
622
  variant: solid
691
- icon: ArrowRightLeft
623
+ icon: AiOutlineSwap
692
624
  events:
693
625
  onClick:
694
626
  - id: modal_toggle_call
@@ -829,8 +761,8 @@ A warm-toned modal using an extensive set of theme tokens including headerBg, co
829
761
  titleColor: "#d46b08"
830
762
  colorBgMask: rgba(250, 173, 20, 0.1)
831
763
  borderRadiusLG: 20
832
- headerBorderBottom: "1px solid #ffd591"
833
- footerBorderTop: "1px solid #ffd591"
764
+ headerBorderBottom: 1px solid
765
+ footerBorderTop: 1px solid
834
766
  headerMarginBottom: 0
835
767
  footerMarginTop: 0
836
768
  headerPadding: 16px 24px
@@ -944,10 +876,10 @@ Modal supports these CSS keys for Tailwind class targeting: element, header, bod
944
876
  properties:
945
877
  title: Tailwind Styled Modal
946
878
  class:
947
- .header: bg-bg-layout
948
- .body: bg-bg-layout p-8
949
- .footer: bg-bg-layout
950
- .content: rounded-2xl overflow-hidden
879
+ header: bg-bg-layout
880
+ body: bg-bg-layout p-8
881
+ footer: bg-bg-layout
882
+ content: rounded-2xl overflow-hidden
951
883
  blocks:
952
884
  - id: modal_css_keys_content
953
885
  type: Paragraph
@@ -970,7 +902,7 @@ Senior Product Designer
970
902
  title: Edit Profile
971
903
  color: primary
972
904
  variant: solid
973
- icon: edit
905
+ icon: AiOutlineEdit
974
906
  events:
975
907
  onClick:
976
908
  - id: modal_profile_open
@@ -989,7 +921,7 @@ Senior Product Designer
989
921
  cancelText: Cancel
990
922
  centered: true
991
923
  theme:
992
- headerBorderBottom: "1px solid #f0f0f0"
924
+ headerBorderBottom: 1px solid
993
925
  headerMarginBottom: 0
994
926
  events:
995
927
  onOk:
@@ -1010,9 +942,10 @@ Senior Product Designer
1010
942
  layout:
1011
943
  flex: 0 0 auto
1012
944
  properties:
1013
- icon: user
945
+ icon: AiOutlineUser
1014
946
  size: 72
1015
- color: "#1677ff"
947
+ color: "#fff"
948
+ backgroundColor: "#1677ff"
1016
949
  - id: modal_profile_info
1017
950
  type: Box
1018
951
  layout:
@@ -1060,7 +993,7 @@ This action cannot be undone. All project data, files, and team assignments will
1060
993
  title: Delete Project
1061
994
  color: danger
1062
995
  variant: solid
1063
- icon: delete
996
+ icon: AiOutlineDelete
1064
997
  events:
1065
998
  onClick:
1066
999
  - id: modal_confirm_open
@@ -1128,7 +1061,7 @@ A serene mountain landscape captured at golden hour. Photography by John Doe.
1128
1061
  title: Preview Image
1129
1062
  color: primary
1130
1063
  variant: outlined
1131
- icon: image
1064
+ icon: AiOutlinePicture
1132
1065
  events:
1133
1066
  onClick:
1134
1067
  - id: modal_image_open
@@ -1190,34 +1123,16 @@ A serene mountain landscape captured at golden hour. Photography by John Doe.
1190
1123
  | Property | Type | Default | Description |
1191
1124
  | --- | --- | --- | --- |
1192
1125
  | `centered` | boolean | `false` | Center the modal vertically. |
1193
- | `closable` | boolean \| object | `true` | Whether a close (x) button is visible on top right of the modal dialog or not. Set `{ disabled: true }` to show the button disabled. |
1194
- | `closable.disabled` | boolean | `false` | Show the close button, but disabled. |
1195
- | `destroyOnHidden` | boolean | `false` | Unmount the blocks inside the modal when it closes, so they mount again (and their onMount events run) each time it opens. Their state is kept. |
1196
- | `focusable` | object | - | Focus management of the dialog. |
1197
- | `focusable.trap` | boolean | `true` | Keep keyboard focus inside the dialog while it is open. |
1198
- | `focusable.focusTriggerAfterClose` | boolean | `true` | Return focus to the element that opened the dialog after it closes. |
1199
- | `forceRender` | boolean | `false` | Render the blocks inside the modal before it is first opened, so their methods can be called and their onMount events run while it is still closed. |
1200
- | `keyboard` | boolean | `true` | Whether pressing Esc closes the modal. |
1201
- | `loading` | boolean | `false` | Show a loading skeleton in place of the modal body. |
1202
- | `scrollLock` | boolean | `true` | Whether to lock page scrolling while the modal is open. |
1126
+ | `closable` | boolean | `true` | Whether a close (x) button is visible on top right of the modal dialog or not. |
1203
1127
  | `title` | string | - | The modal dialog's title - supports html. |
1204
1128
  | `footer` | boolean | `true` | Show footer area. |
1205
- | `mask` | boolean \| object | `true` | Whether to show the mask. Set an object to configure the mask with `enabled`, `blur` and `closable`. |
1206
- | `mask.enabled` | boolean | `true` | Whether to show the mask. |
1207
- | `mask.blur` | boolean | `false` | Blur the page behind the mask. |
1208
- | `mask.closable` | boolean | - | Whether clicking the mask closes the dialog. Takes precedence over `maskClosable`. |
1209
- | `maskClosable` | boolean | `true` | Whether to close the modal dialog when the mask (area outside the modal) is clicked. `mask.closable` takes precedence. |
1129
+ | `mask` | boolean | `true` | Whether show mask or not. |
1130
+ | `maskClosable` | boolean | `true` | Whether to close the modal dialog when the mask (area outside the modal) is clicked. |
1210
1131
  | `okText` | string | - | Text of the Ok button. When unset, antd uses the localized default from ConfigProvider locale. |
1211
1132
  | `okButtonProps` | object | - | Set additional properties for the ok button. |
1212
1133
  | `cancelText` | string | - | Text of the Cancel button. When unset, antd uses the localized default from ConfigProvider locale. |
1213
1134
  | `cancelButtonProps` | object | - | Set additional properties for the cancel button. |
1214
- | `width` | string \| number \| object | `520` | Width of the modal dialog. Set an object of breakpoints (`xs`, `sm`, `md`, `lg`, `xl`, `xxl`) for a responsive width. |
1215
- | `width.xs` | string \| number | - | Width on extra small screens. |
1216
- | `width.sm` | string \| number | - | Width on small screens. |
1217
- | `width.md` | string \| number | - | Width on medium screens. |
1218
- | `width.lg` | string \| number | - | Width on large screens. |
1219
- | `width.xl` | string \| number | - | Width on extra large screens. |
1220
- | `width.xxl` | string \| number | - | Width on extra extra large screens. |
1135
+ | `width` | string \| number | `"520px"` | Width of the modal dialog. |
1221
1136
  | `zIndex` | integer | `1000` | The z-index of the modal. Useful when displaying two modals simultaneously. |
1222
1137
  | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design modal tokens](https://ant.design/components/modal#design-token). |
1223
1138
  | `theme.headerBg` | string | - | Background color of the modal header. |
@@ -1247,15 +1162,12 @@ A serene mountain landscape captured at golden hour. Photography by John Doe.
1247
1162
  | `onOpen` | \- | Trigger actions when modal is opened. |
1248
1163
  | `onCancel` | \- | Trigger actions when Cancel button is clicked. |
1249
1164
  | `onClose` | \- | Trigger actions after onOk or onCancel is completed. |
1250
- | `afterClose` | \- | Trigger actions after the modal has closed and its close animation has finished. |
1251
- | `afterOpenChange` | `{ open }` | Trigger actions after the open or close animation of the modal has finished. |
1252
1165
 
1253
1166
  | Key | Target |
1254
1167
  | --- | --- |
1255
1168
  | `/block` | Outer block wrapper (always available). |
1256
1169
  | `/element` | The Modal element. |
1257
1170
  | `/header` | The Modal header. |
1258
- | `/title` | The Modal title. |
1259
1171
  | `/body` | The Modal body. |
1260
1172
  | `/footer` | The Modal footer. |
1261
1173
  | `/mask` | The Modal mask. |
@@ -18,12 +18,12 @@ Browse the full API reference and configuration guides.
18
18
  type: MenuLink
19
19
  properties:
20
20
  title: Home
21
- icon: home
21
+ icon: AiOutlineHome
22
22
  - id: phm_basic_products
23
23
  type: MenuLink
24
24
  properties:
25
25
  title: Products
26
- icon: grid
26
+ icon: AiOutlineAppstore
27
27
  - id: phm_basic_pricing
28
28
  type: MenuLink
29
29
  properties:
@@ -78,7 +78,7 @@ Analytics Overview
78
78
  separator: /
79
79
  list:
80
80
  - label: Home
81
- icon: home
81
+ icon: AiOutlineHome
82
82
  - label: Analytics
83
83
  - label: Overview
84
84
  menu:
@@ -87,12 +87,12 @@ Analytics Overview
87
87
  type: MenuLink
88
88
  properties:
89
89
  title: Dashboard
90
- icon: Gauge
90
+ icon: AiOutlineDashboard
91
91
  - id: phm_g_analytics
92
92
  type: MenuGroup
93
93
  properties:
94
94
  title: Analytics
95
- icon: chart
95
+ icon: AiOutlineBarChart
96
96
  links:
97
97
  - id: phm_g_overview
98
98
  type: MenuLink
@@ -110,7 +110,7 @@ Analytics Overview
110
110
  type: MenuLink
111
111
  properties:
112
112
  title: Settings
113
- icon: settings
113
+ icon: AiOutlineSetting
114
114
  blocks:
115
115
  - id: phm_g_title
116
116
  type: Title
@@ -179,19 +179,19 @@ Dashboard
179
179
  type: MenuLink
180
180
  properties:
181
181
  title: My Profile
182
- icon: user
182
+ icon: AiOutlineUser
183
183
  - id: phm_prof_settings
184
184
  type: MenuLink
185
185
  properties:
186
186
  title: Settings
187
- icon: settings
187
+ icon: AiOutlineSetting
188
188
  - id: phm_prof_divider
189
189
  type: MenuDivider
190
190
  - id: phm_prof_logout
191
191
  type: MenuLink
192
192
  properties:
193
193
  title: Logout
194
- icon: logout
194
+ icon: AiOutlineLogout
195
195
  danger: true
196
196
  menu:
197
197
  links:
@@ -199,17 +199,17 @@ Dashboard
199
199
  type: MenuLink
200
200
  properties:
201
201
  title: Home
202
- icon: home
202
+ icon: AiOutlineHome
203
203
  - id: phm_prof_projects
204
204
  type: MenuLink
205
205
  properties:
206
206
  title: Projects
207
- icon: SquareKanban
207
+ icon: AiOutlineProject
208
208
  - id: phm_prof_reports
209
209
  type: MenuLink
210
210
  properties:
211
211
  title: Reports
212
- icon: chart
212
+ icon: AiOutlineBarChart
213
213
  blocks:
214
214
  - id: phm_prof_title
215
215
  type: Title
@@ -268,7 +268,7 @@ View Expense Reports
268
268
  dot: true
269
269
  profile:
270
270
  avatar:
271
- icon: user
271
+ icon: AiOutlineUser
272
272
  breadcrumb:
273
273
  list:
274
274
  - Intranet
@@ -279,17 +279,17 @@ View Expense Reports
279
279
  type: MenuLink
280
280
  properties:
281
281
  title: Home
282
- icon: home
282
+ icon: AiOutlineHome
283
283
  - id: phm_full_directory
284
284
  type: MenuLink
285
285
  properties:
286
286
  title: Directory
287
- icon: users
287
+ icon: AiOutlineTeam
288
288
  - id: phm_full_resources
289
289
  type: MenuGroup
290
290
  properties:
291
291
  title: Resources
292
- icon: Book
292
+ icon: AiOutlineBook
293
293
  links:
294
294
  - id: phm_full_policies
295
295
  type: MenuLink
@@ -303,7 +303,7 @@ View Expense Reports
303
303
  type: MenuLink
304
304
  properties:
305
305
  title: IT Support
306
- icon: help
306
+ icon: AiOutlineQuestionCircle
307
307
  slots:
308
308
  footer:
309
309
  blocks:
@@ -311,8 +311,7 @@ View Expense Reports
311
311
  type: Paragraph
312
312
  properties:
313
313
  content: Acme Corp Intranet - Internal Use Only
314
- style:
315
- .element:
314
+ style:
316
315
  margin: 0
317
316
  color: "#888"
318
317
  textAlign: center
@@ -382,22 +381,22 @@ Get started by installing the framework via npm or yarn. Follow the steps below
382
381
  type: MenuLink
383
382
  properties:
384
383
  title: Guide
385
- icon: Book
384
+ icon: AiOutlineBook
386
385
  - id: phm_light_api
387
386
  type: MenuLink
388
387
  properties:
389
388
  title: API Reference
390
- icon: Plug
389
+ icon: AiOutlineApi
391
390
  - id: phm_light_examples
392
391
  type: MenuLink
393
392
  properties:
394
393
  title: Examples
395
- icon: CodeXml
394
+ icon: AiOutlineCode
396
395
  - id: phm_light_community
397
396
  type: MenuLink
398
397
  properties:
399
398
  title: Community
400
- icon: globe
399
+ icon: AiOutlineGlobal
401
400
  breadcrumb:
402
401
  separator: /
403
402
  list:
@@ -413,7 +412,7 @@ Get started by installing the framework via npm or yarn. Follow the steps below
413
412
  flex: 0 0 auto
414
413
  properties:
415
414
  title: Search
416
- icon: search
415
+ icon: AiOutlineSearch
417
416
  color: default
418
417
  variant: outlined
419
418
  size: small
@@ -481,12 +480,12 @@ Profile from _menu
481
480
  type: MenuLink
482
481
  properties:
483
482
  title: Home
484
- icon: home
483
+ icon: AiOutlineHome
485
484
  - id: phm_mo_settings
486
485
  type: MenuLink
487
486
  properties:
488
487
  title: Settings
489
- icon: settings
488
+ icon: AiOutlineSetting
490
489
  blocks:
491
490
  - id: phm_mo_title
492
491
  type: Title
@@ -520,36 +519,14 @@ Profile from _menu
520
519
  | `breadcrumb.list.$.pageId` | string | - | Page id to link to when clicked. |
521
520
  | `breadcrumb.list.$.url` | string | - | External url link. |
522
521
  | `breadcrumb.list.$.style` | object | - | Css style to apply to link. |
523
- | `breadcrumb.list.$.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 an icon in breadcrumb link. |
524
- | `breadcrumb.list.$.icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
525
- | `breadcrumb.list.$.icon.color` | string | - | Icon color. |
526
- | `breadcrumb.list.$.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
527
- | `breadcrumb.list.$.icon.rotate` | number | - | Number of degrees to rotate the icon. |
528
- | `breadcrumb.list.$.icon.spin` | boolean | - | Continuously spin the icon with animation. |
529
- | `breadcrumb.list.$.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
530
- | `breadcrumb.list.$.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
531
- | `breadcrumb.list.$.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
532
- | `breadcrumb.list.$.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
533
- | `breadcrumb.list.$.links` | array | - | Links shown in a dropdown menu on the breadcrumb item. |
534
- | `breadcrumb.list.$.links.$.label` | string | - | Label of the dropdown link. |
535
- | `breadcrumb.list.$.links.$.pageId` | string | - | Page id to link to when clicked. |
536
- | `breadcrumb.list.$.links.$.url` | string | - | External url link. |
522
+ | `breadcrumb.list.$.icon` | string \| object | - | Name of an React-Icon (See all icons) or properties of an Icon block to use an icon in breadcrumb link. |
537
523
  | `menu` | object | - | Menu properties. |
538
524
  | `menu.links` | array | - | |
539
525
  | `menu.links.$.id` | string | - | Menu item id. |
540
526
  | `menu.links.$.pageId` | string | - | Page to link to. |
541
527
  | `menu.links.$.properties` | object | - | properties from menu item. |
542
528
  | `menu.links.$.properties.title` | string | - | Menu item title. |
543
- | `menu.links.$.properties.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 icon on menu item. |
544
- | `menu.links.$.properties.icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
545
- | `menu.links.$.properties.icon.color` | string | - | Icon color. |
546
- | `menu.links.$.properties.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
547
- | `menu.links.$.properties.icon.rotate` | number | - | Number of degrees to rotate the icon. |
548
- | `menu.links.$.properties.icon.spin` | boolean | - | Continuously spin the icon with animation. |
549
- | `menu.links.$.properties.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
550
- | `menu.links.$.properties.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
551
- | `menu.links.$.properties.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
552
- | `menu.links.$.properties.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
529
+ | `menu.links.$.properties.icon` | string \| object | - | Name of an React-Icon (See all icons) or properties of an Icon block to customize icon on menu item. |
553
530
  | `menuLg` | object | - | Menu large screen properties. Overwrites menu properties on desktop screen sizes. |
554
531
  | `menuMd` | object | - | Mobile menu properties. Overwrites menu properties on mobile screen sizes. |
555
532
  | `notifications` | object | - | Notification bell icon with badge in the header. Renders when configured. Use the link property to navigate when clicked. |
@@ -562,33 +539,15 @@ Profile from _menu
562
539
  | `notifications.showZero` | boolean | `false` | Show badge when count is zero. |
563
540
  | `notifications.overflowCount` | number | `99` | Max count to show. Values above this display as "N+". |
564
541
  | `notifications.color` | string | - | Badge color. |
565
- | `notifications.icon` | string \| object | - | Icon for the notification button. Defaults to `bell`. |
566
- | `notifications.icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
567
- | `notifications.icon.color` | string | - | Icon color. |
568
- | `notifications.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
569
- | `notifications.icon.rotate` | number | - | Number of degrees to rotate the icon. |
570
- | `notifications.icon.spin` | boolean | - | Continuously spin the icon with animation. |
571
- | `notifications.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
572
- | `notifications.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
573
- | `notifications.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
574
- | `notifications.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
542
+ | `notifications.icon` | string \| object | - | Icon for the notification button. Defaults to AiOutlineBell. |
575
543
  | `notifications.size` | string | `"small"` | Size of the notification button. Enum: `small`, `default`, `large`. |
576
544
  | `profile` | object | - | Profile avatar with optional dropdown menu in the header. Renders when configured. Use with the _user operator to populate from the authenticated user. |
577
545
  | `profile.avatar` | object | - | Avatar display properties. |
578
546
  | `profile.avatar.src` | string | - | Image URL for the avatar. Typically bound to _user: image. |
579
547
  | `profile.avatar.content` | string | - | Text content inside the avatar (e.g. user initials). Shown when no src is provided. |
580
- | `profile.avatar.icon` | string \| object | - | Icon to display in avatar when no src or content is set. Defaults to `user`. |
581
- | `profile.avatar.icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
582
- | `profile.avatar.icon.color` | string | - | Icon color. |
583
- | `profile.avatar.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
584
- | `profile.avatar.icon.rotate` | number | - | Number of degrees to rotate the icon. |
585
- | `profile.avatar.icon.spin` | boolean | - | Continuously spin the icon with animation. |
586
- | `profile.avatar.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
587
- | `profile.avatar.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
588
- | `profile.avatar.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
589
- | `profile.avatar.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
548
+ | `profile.avatar.icon` | string \| object | - | Icon to display in avatar when no src or content is set. Defaults to AiOutlineUser. |
590
549
  | `profile.avatar.color` | string | - | Background color of the avatar when not using src. |
591
- | `profile.avatar.size` | string \| number | `"small"` | Size of the avatar: default, small, large or a pixel number. |
550
+ | `profile.avatar.size` | string \| number | `"small"` | Size of the avatar. Enum: `default`, `small`, `large`. |
592
551
  | `profile.avatar.shape` | string | `"circle"` | Shape of the avatar. Enum: `circle`, `square`. |
593
552
  | `profile.links` | array | - | Dropdown menu items. Uses the same MenuLink/MenuGroup/MenuDivider schema as Menu. Compatible with _menu operator output for access-filtered menus. |
594
553
  | `profile.links.$.id` | string | - | Menu item id. |
@@ -600,15 +559,6 @@ Profile from _menu
600
559
  | `profile.links.$.properties` | object | - | Properties for the menu item. |
601
560
  | `profile.links.$.properties.title` | string | - | Menu item title. |
602
561
  | `profile.links.$.properties.icon` | string \| object | - | Icon for the menu item. |
603
- | `profile.links.$.properties.icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
604
- | `profile.links.$.properties.icon.color` | string | - | Icon color. |
605
- | `profile.links.$.properties.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
606
- | `profile.links.$.properties.icon.rotate` | number | - | Number of degrees to rotate the icon. |
607
- | `profile.links.$.properties.icon.spin` | boolean | - | Continuously spin the icon with animation. |
608
- | `profile.links.$.properties.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
609
- | `profile.links.$.properties.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
610
- | `profile.links.$.properties.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
611
- | `profile.links.$.properties.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
612
562
  | `profile.links.$.properties.danger` | boolean | `false` | Apply danger style to menu item. |
613
563
  | `profile.links.$.properties.disabled` | boolean | `false` | Disable the menu item. |
614
564
  | `profile.links.$.properties.dashed` | boolean | `false` | Whether the divider line is dashed. |
@@ -620,7 +570,7 @@ Profile from _menu
620
570
  | `profile.arrow.pointAtCenter` | boolean | - | |
621
571
  | `darkModeToggle` | boolean | `false` | Show a dark mode toggle button in the header. Toggles the Ant Design dark theme for the entire page. Preference is persisted to localStorage. |
622
572
  | `localeSelector` | boolean | `false` | Show a locale picker dropdown in the header. Lists locales declared in `config.i18n.locales` and dispatches `SetLocale` on selection. Renders nothing when `config.i18n` is not configured. |
623
- | `theme` | object | - | Antd global design token overrides, such as colorPrimary or borderRadius, applied to everything in the page layout. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design component tokens](https://ant.design/docs/react/customize-theme#seedtoken). |
573
+ | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). |
624
574
 
625
575
  | Event | Event Data | Description |
626
576
  | --- | --- | --- |