@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
@@ -91,25 +91,6 @@ Description list with configurable layout and columns.
91
91
  value: 0.5 kg
92
92
  - label: In Stock
93
93
  value: 1,250 units
94
- - id: size_medium
95
- type: Descriptions
96
- properties:
97
- title: Medium Size
98
- size: medium
99
- bordered: true
100
- items:
101
- - label: Product
102
- value: Widget Plus
103
- - label: SKU
104
- value: WGT-PLS-003
105
- - label: Price
106
- value: $34.99
107
- - label: Category
108
- value: Electronics
109
- - label: Weight
110
- value: 0.4 kg
111
- - label: In Stock
112
- value: 2,015 units
113
94
  - id: size_small
114
95
  type: Descriptions
115
96
  properties:
@@ -323,24 +304,6 @@ Description list with configurable layout and columns.
323
304
  value: Database connection pool exhausted. Increased max_connections from 100 to
324
305
  250 and implemented connection retry logic with exponential backoff.
325
306
  span: 3
326
- - id: spanning_filled
327
- type: Descriptions
328
- properties:
329
- title: Shipment
330
- bordered: true
331
- column: 3
332
- items:
333
- - label: Carrier
334
- value: Road freight
335
- - label: Tracking
336
- value: Use span filled to take the rest of the row, whatever the column count.
337
- span: filled
338
- - label: Weight
339
- value: 12 kg
340
- - label: Pieces
341
- value: 3
342
- - label: Insured
343
- value: Yes
344
307
  ```
345
308
 
346
309
  ```yaml
@@ -622,7 +585,7 @@ Description list with configurable layout and columns.
622
585
  value: +1 (555) 444-7890
623
586
  style:
624
587
  .element:
625
- border: "2px solid #1677ff"
588
+ border: 2px solid
626
589
  borderRadius: 8px
627
590
  padding: 4px
628
591
  - id: css_label_content
@@ -865,11 +828,9 @@ Description list with configurable layout and columns.
865
828
  | `column.md` | integer | - | The number of description items in a row for 'md' media size. |
866
829
  | `column.lg` | integer | - | The number of description items in a row for 'lg' media size. |
867
830
  | `column.xl` | integer | - | The number of description items in a row for 'xl' media size. |
868
- | `column.xxl` | integer | - | The number of description items in a row for 'xxl' media size. |
869
- | `column.xxxl` | integer | - | The number of description items in a row for 'xxxl' media size. |
870
831
  | `itemOptions` | array | - | |
871
832
  | `itemOptions.$.key` | string | - | Item key to which these settings should apply. |
872
- | `itemOptions.$.span` | number \| string \| object | - | Item span for this key, or 'filled' to fill the rest of the row. Can also be a function that receives item and index. |
833
+ | `itemOptions.$.span` | number \| object | - | Item span for this key. Can also be a function that receives item and index. |
873
834
  | `itemOptions.$.style` | object | - | Item css style for this key. Can also be a function that receives item and index. |
874
835
  | `itemOptions.$.transformLabel` | object | - | Function to transform item key or label. Function receives arguments label, item and index. |
875
836
  | `itemOptions.$.transformValue` | object | - | Function to transform item value. Function receives arguments value, item and index. |
@@ -878,10 +839,10 @@ Description list with configurable layout and columns.
878
839
  | `items.$.labelStyle` | object | - | Customize label style. |
879
840
  | `items.$.label` | string | - | Item label - supports html. |
880
841
  | `items.$.value` | string \| number | - | Value of item - supports html. |
881
- | `items.$.span` | integer \| string \| object | - | Number of columns for this item to span. Set to 'filled' to fill the rest of the row, or an object of breakpoint spans like `{ xs: 1, md: 2 }`. |
842
+ | `items.$.span` | integer | - | Number of columns for this item to span. |
882
843
  | `items.$.style` | object | - | Css style object to applied to item. |
883
844
  | `layout` | string | `"horizontal"` | Put values next to or below their labels. Enum: `horizontal`, `vertical`. |
884
- | `size` | string | `"default"` | Size of the block. `default` is the largest size. Enum: `default`, `medium`, `small`. |
845
+ | `size` | string | `"default"` | Size of the block. Enum: `default`, `small`. |
885
846
  | `title` | string | - | The title of the description block, placed at the top - supports html. |
886
847
  | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design descriptions tokens](https://ant.design/components/descriptions#design-token). |
887
848
  | `theme.labelBg` | string | `"rgba(0, 0, 0, 0.02)"` | Background color for labels in bordered mode. |
@@ -901,8 +862,6 @@ No events defined.
901
862
  | --- | --- |
902
863
  | `/block` | Outer block wrapper (always available). |
903
864
  | `/element` | The Descriptions element. |
904
- | `/header` | The header row with the title and extra content. |
905
- | `/title` | The Descriptions title. |
906
865
  | `/content` | The Descriptions content. |
907
866
  | `/label` | The Descriptions label. |
908
867
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Panel that slides in from the edge of the screen.
4
4
 
5
- This is a basic drawer with a title and default settings. It opens from the right side with the default width of 378px.
5
+ This is a basic drawer with a title and default settings. It opens from the right side with a width of 256px.
6
6
 
7
7
  Click the X button or the mask area to close it.
8
8
 
@@ -33,7 +33,7 @@ Click the X button or the mask area to close it.
33
33
  type: Paragraph
34
34
  properties:
35
35
  content: This is a basic drawer with a title and default settings. It opens from
36
- the right side with the default width of 378px.
36
+ the right side with a width of 256px.
37
37
  - id: drawer_basic_p2
38
38
  type: Paragraph
39
39
  properties:
@@ -432,52 +432,6 @@ The mask is visible but clicking it does not close the drawer. Users must use th
432
432
  must use the close button or Escape key.
433
433
  ```
434
434
 
435
- Drag the left edge to resize the drawer. The onResizeEnd event receives the new size, so it can be saved as a user preference.
436
-
437
- ```yaml
438
- - id: drawer_resizable_trigger
439
- type: Button
440
- layout:
441
- flex: 0 0 auto
442
- properties:
443
- title: Open Resizable Drawer
444
- color: primary
445
- variant: outlined
446
- events:
447
- onClick:
448
- - id: drawer_resizable_open
449
- type: CallMethod
450
- params:
451
- blockId: drawer_resizable
452
- method: setOpen
453
- args:
454
- - open: true
455
- - id: drawer_resizable
456
- type: Drawer
457
- properties:
458
- title: Resizable Drawer
459
- size: 480
460
- resizable: true
461
- maxSize: 900
462
- closable:
463
- placement: end
464
- mask:
465
- blur: true
466
- events:
467
- onResizeEnd:
468
- - id: drawer_resizable_save_size
469
- type: SetState
470
- params:
471
- drawer_size:
472
- _event: size
473
- blocks:
474
- - id: drawer_resizable_p1
475
- type: Paragraph
476
- properties:
477
- content: Drag the left edge to resize the drawer. The onResizeEnd event receives
478
- the new size, so it can be saved as a user preference.
479
- ```
480
-
481
435
  Pressing the Escape key closes this drawer. This is the default behavior.
482
436
 
483
437
  Pressing Escape does not close this drawer. The user must click the close button or mask to dismiss.
@@ -728,7 +682,7 @@ This drawer uses the toggleOpen method. Each click of the button alternates betw
728
682
  title: Toggle Drawer
729
683
  color: primary
730
684
  variant: solid
731
- icon: menu
685
+ icon: AiOutlineMenu
732
686
  events:
733
687
  onClick:
734
688
  - id: drawer_toggle_call
@@ -836,10 +790,8 @@ This drawer uses style.header and style.body to apply custom background colors t
836
790
  title: Styled Drawer
837
791
  style:
838
792
  .header:
839
- backgroundColor: var(--ant-color-primary-bg)
840
- borderBottom: 1px solid var(--ant-color-primary-border)
841
- .body:
842
- backgroundColor: var(--ant-color-fill-quaternary)
793
+ borderBottom: 1px solid
794
+ .body: null
843
795
  blocks:
844
796
  - id: drawer_inline_style_content
845
797
  type: Paragraph
@@ -877,8 +829,8 @@ The mask CSS key applies a backdrop blur effect, and the content CSS key adds ro
877
829
  properties:
878
830
  title: Tailwind CSS Keys
879
831
  class:
880
- .header: bg-bg-layout
881
- .body: bg-bg-layout
832
+ header: bg-bg-layout
833
+ body: bg-bg-layout
882
834
  blocks:
883
835
  - id: drawer_css_keys_content
884
836
  type: Paragraph
@@ -908,8 +860,8 @@ The mask CSS key applies a backdrop blur effect, and the content CSS key adds ro
908
860
  properties:
909
861
  title: Accent Header
910
862
  class:
911
- .header: bg-gradient-to-r from-primary/100 to-indigo-600 text-white
912
- .body: bg-bg-layout
863
+ header: bg-gradient-to-r from-primary/100 to-indigo-600 text-white
864
+ body: bg-bg-layout
913
865
  blocks:
914
866
  - id: drawer_css_accent_content
915
867
  type: Paragraph
@@ -938,8 +890,8 @@ The mask CSS key applies a backdrop blur effect, and the content CSS key adds ro
938
890
  properties:
939
891
  title: Custom Mask Style
940
892
  class:
941
- .mask: backdrop-blur-sm
942
- .content: rounded-l-xl
893
+ mask: backdrop-blur-sm
894
+ content: rounded-l-xl
943
895
  blocks:
944
896
  - id: drawer_css_mask_content
945
897
  type: Paragraph
@@ -1062,7 +1014,7 @@ Overrides footerPaddingBlock, footerPaddingInline, and zIndexPopup design tokens
1062
1014
  title: Edit Record
1063
1015
  color: primary
1064
1016
  variant: solid
1065
- icon: edit
1017
+ icon: AiOutlineEdit
1066
1018
  events:
1067
1019
  onClick:
1068
1020
  - id: drawer_edit_form_open
@@ -1172,7 +1124,7 @@ Overrides footerPaddingBlock, footerPaddingInline, and zIndexPopup design tokens
1172
1124
  title: Filters
1173
1125
  color: default
1174
1126
  variant: outlined
1175
- icon: filter
1127
+ icon: AiOutlineFilter
1176
1128
  events:
1177
1129
  onClick:
1178
1130
  - id: drawer_filter_panel_open
@@ -1248,7 +1200,7 @@ Overrides footerPaddingBlock, footerPaddingInline, and zIndexPopup design tokens
1248
1200
  value: 3
1249
1201
  - label: 4+
1250
1202
  value: 4
1251
- - label: "5"
1203
+ - label: 5
1252
1204
  value: 5
1253
1205
  - id: drawer_filter_panel_in_stock
1254
1206
  type: Switch
@@ -1289,7 +1241,7 @@ Jane Cooper
1289
1241
  title: View Profile
1290
1242
  color: primary
1291
1243
  variant: solid
1292
- icon: user
1244
+ icon: AiOutlineUser
1293
1245
  events:
1294
1246
  onClick:
1295
1247
  - id: drawer_profile_open
@@ -1316,9 +1268,10 @@ Jane Cooper
1316
1268
  layout:
1317
1269
  flex: 0 0 auto
1318
1270
  properties:
1319
- icon: user
1271
+ icon: AiOutlineUser
1320
1272
  size: 64
1321
- color: "#1677ff"
1273
+ color: "#fff"
1274
+ backgroundColor: "#1677ff"
1322
1275
  - id: drawer_profile_info
1323
1276
  type: Box
1324
1277
  layout:
@@ -1369,7 +1322,7 @@ Jane Cooper
1369
1322
  title: Edit Profile
1370
1323
  color: primary
1371
1324
  variant: outlined
1372
- icon: edit
1325
+ icon: AiOutlineEdit
1373
1326
  - id: drawer_profile_message_btn
1374
1327
  type: Button
1375
1328
  layout:
@@ -1378,35 +1331,20 @@ Jane Cooper
1378
1331
  title: Send Message
1379
1332
  color: primary
1380
1333
  variant: solid
1381
- icon: mail
1334
+ icon: AiOutlineMail
1382
1335
  ```
1383
1336
 
1384
1337
  | Property | Type | Default | Description |
1385
1338
  | --- | --- | --- | --- |
1386
- | `closable` | boolean \| object | `true` | Whether a close (x) button is visible in the Drawer header or not. Set an object to disable the button or to move it to the end of the header. |
1387
- | `closable.disabled` | boolean | `false` | Show the close button, but disabled. |
1388
- | `closable.placement` | string | `"start"` | Place the close button at the start or the end of the header. Enum: `start`, `end`. |
1389
- | `destroyOnHidden` | boolean | `false` | Unmount the blocks inside the Drawer when it closes, so they mount again (and their onMount events run) each time it opens. Their state is kept. |
1390
- | `focusable` | object | - | Focus management of the dialog. |
1391
- | `focusable.trap` | boolean | `true` | Keep keyboard focus inside the dialog while it is open. |
1392
- | `focusable.focusTriggerAfterClose` | boolean | `true` | Return focus to the element that opened the dialog after it closes. |
1393
- | `forceRender` | boolean | `false` | Render the blocks inside the Drawer before it is first opened, so their methods can be called and their onMount events run while it is still closed. |
1394
- | `getContainer` | string \| boolean | - | Where the Drawer is mounted. By default it is mounted on the page body. Set to `false` to render it in place, inside the nearest positioned parent (give that parent `position: relative`), or to a CSS selector to mount it in the first matching element. |
1395
- | `loading` | boolean | `false` | Show a loading skeleton in place of the Drawer body. |
1396
- | `mask` | boolean \| object | `true` | Whether to show the mask. Set an object to configure the mask with `enabled`, `blur` and `closable`. |
1397
- | `mask.enabled` | boolean | `true` | Whether to show the mask. |
1398
- | `mask.blur` | boolean | `false` | Blur the page behind the mask. |
1399
- | `mask.closable` | boolean | - | Whether clicking the mask closes the dialog. Takes precedence over `maskClosable`. |
1400
- | `maskClosable` | boolean | `true` | Clicking on the mask (area outside the Drawer) to close the Drawer or not. `mask.closable` takes precedence. |
1401
- | `maxSize` | number | - | Maximum size in pixels a resizable Drawer can be dragged to. |
1402
- | `resizable` | boolean | `false` | Let the user resize the Drawer by dragging its edge. The configured size is the starting size. |
1403
- | `size` | string \| number | - | Size of the Drawer: width for left and right placements, height for top and bottom. `default` (378px), `large` (736px), a number of pixels or a CSS length. Takes precedence over width and height. |
1404
- | `title` | string | - | The title of the Drawer - supports html. |
1405
- | `width` | string \| number | `378` | Width of the Drawer dialog. |
1406
- | `height` | string \| number | `378` | When placement is top or bottom, height of the Drawer dialog. |
1339
+ | `closable` | boolean | `true` | Whether a close (x) button is visible on top right of the Drawer dialog or not. |
1340
+ | `mask` | boolean | `true` | Whether to show mask or not. |
1341
+ | `maskClosable` | boolean | `true` | Clicking on the mask (area outside the Drawer) to close the Drawer or not. |
1342
+ | `title` | string | - | The title of the Drawer. |
1343
+ | `width` | string \| number | `"256px"` | Width of the Drawer dialog. |
1344
+ | `height` | string \| number | `"256px"` | When placement is top or bottom, height of the Drawer dialog. |
1407
1345
  | `zIndex` | integer | `1000` | The z-index of the Drawer. |
1408
1346
  | `placement` | string | `"right"` | The placement of the Drawer. Enum: `top`, `right`, `bottom`, `left`. |
1409
- | `keyboard` | boolean | `true` | Whether pressing Esc closes the Drawer. |
1347
+ | `keyboard` | boolean | `true` | Whether support press esc to close. |
1410
1348
  | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design drawer tokens](https://ant.design/components/drawer#design-token). |
1411
1349
  | `theme.footerPaddingBlock` | number | `8` | Vertical padding of the footer. |
1412
1350
  | `theme.footerPaddingInline` | number | `16` | Horizontal padding of the footer. |
@@ -1421,15 +1359,13 @@ Jane Cooper
1421
1359
  | `onClose` | \- | Trigger actions when drawer is closed. |
1422
1360
  | `onOpen` | \- | Trigger actions when drawer is opened. |
1423
1361
  | `afterClose` | \- | Trigger actions after drawer is closed. |
1424
- | `afterOpenChange` | `{ open, drawerOpen }` | Trigger actions after the open or close animation of the drawer has finished. |
1425
- | `onResizeEnd` | `{ size }` | Trigger actions when the user finishes resizing a resizable drawer. Not triggered when the resize handle is clicked without dragging. |
1362
+ | `afterOpenChange` | \- | Trigger actions after drawer is opened. |
1426
1363
 
1427
1364
  | Key | Target |
1428
1365
  | --- | --- |
1429
1366
  | `/block` | Outer block wrapper (always available). |
1430
1367
  | `/element` | The Drawer element. |
1431
1368
  | `/header` | The Drawer header. |
1432
- | `/title` | The Drawer title. |
1433
1369
  | `/body` | The Drawer body. |
1434
1370
  | `/footer` | The Drawer footer. |
1435
1371
  | `/mask` | The Drawer mask. |
@@ -15,20 +15,20 @@ Floating dropdown menu triggered by any child block. Menu items follow the Menu
15
15
  pageId: home
16
16
  properties:
17
17
  title: Home
18
- icon: home
18
+ icon: AiOutlineHome
19
19
  - id: dm_basic_profile
20
20
  type: MenuLink
21
21
  pageId: home
22
22
  properties:
23
23
  title: Profile
24
- icon: user
24
+ icon: AiOutlineUser
25
25
  - id: dm_basic_div
26
26
  type: MenuDivider
27
27
  - id: dm_basic_logout
28
28
  type: MenuLink
29
29
  properties:
30
30
  title: Log Out
31
- icon: logout
31
+ icon: AiOutlineLogout
32
32
  danger: true
33
33
  blocks:
34
34
  - id: dropdown_menu_basic_btn
@@ -83,19 +83,19 @@ Right-click anywhere in this card to open the context menu.
83
83
  type: MenuLink
84
84
  properties:
85
85
  title: Copy
86
- icon: copy
86
+ icon: AiOutlineCopy
87
87
  - id: dm_ctx_paste
88
88
  type: MenuLink
89
89
  properties:
90
90
  title: Paste
91
- icon: Files
91
+ icon: AiOutlineSnippets
92
92
  - id: dm_ctx_div
93
93
  type: MenuDivider
94
94
  - id: dm_ctx_delete
95
95
  type: MenuLink
96
96
  properties:
97
97
  title: Delete
98
- icon: delete
98
+ icon: AiOutlineDelete
99
99
  danger: true
100
100
  blocks:
101
101
  - id: dropdown_menu_context_area
@@ -189,76 +189,6 @@ Right-click anywhere in this card to open the context menu.
189
189
  color: default
190
190
  variant: outlined
191
191
  size: small
192
- - id: dropdown_menu_pl_right
193
- type: DropdownMenu
194
- layout:
195
- flex: 0 0 auto
196
- properties:
197
- trigger: click
198
- placement: right
199
- links:
200
- - id: dm_pl_right_1
201
- type: MenuLink
202
- properties:
203
- title: Item 1
204
- - id: dm_pl_right_2
205
- type: MenuLink
206
- properties:
207
- title: Item 2
208
- blocks:
209
- - id: dropdown_menu_pl_right_btn
210
- type: Button
211
- layout:
212
- flex: 0 0 auto
213
- properties:
214
- title: right
215
- color: default
216
- variant: outlined
217
- size: small
218
- ```
219
-
220
- ```yaml
221
- - id: dropdown_menu_selectable
222
- type: DropdownMenu
223
- layout:
224
- flex: 0 0 auto
225
- properties:
226
- trigger: click
227
- selectable: true
228
- selectedKeys:
229
- _if_none:
230
- - _state: dm_sort_keys
231
- - - dm_sort_newest
232
- links:
233
- - id: dm_sort_newest
234
- type: MenuLink
235
- properties:
236
- title: Newest first
237
- - id: dm_sort_oldest
238
- type: MenuLink
239
- properties:
240
- title: Oldest first
241
- - id: dm_sort_name
242
- type: MenuLink
243
- properties:
244
- title: Name
245
- events:
246
- onSelect:
247
- - id: dm_sort_set
248
- type: SetState
249
- params:
250
- dm_sort_keys:
251
- _event: selectedKeys
252
- blocks:
253
- - id: dropdown_menu_selectable_btn
254
- type: Button
255
- layout:
256
- flex: 0 0 auto
257
- properties:
258
- title: Sort
259
- icon: sort
260
- color: default
261
- variant: outlined
262
192
  ```
263
193
 
264
194
  ```yaml
@@ -274,12 +204,12 @@ Right-click anywhere in this card to open the context menu.
274
204
  type: MenuLink
275
205
  properties:
276
206
  title: Settings
277
- icon: settings
207
+ icon: AiOutlineSetting
278
208
  - id: dm_arrow_2
279
209
  type: MenuLink
280
210
  properties:
281
211
  title: Help
282
- icon: help
212
+ icon: AiOutlineQuestionCircle
283
213
  blocks:
284
214
  - id: dropdown_menu_arrow_btn
285
215
  type: Button
@@ -302,12 +232,12 @@ Right-click anywhere in this card to open the context menu.
302
232
  type: MenuLink
303
233
  properties:
304
234
  title: Settings
305
- icon: settings
235
+ icon: AiOutlineSetting
306
236
  - id: dm_arrowc_2
307
237
  type: MenuLink
308
238
  properties:
309
239
  title: Help
310
- icon: help
240
+ icon: AiOutlineQuestionCircle
311
241
  blocks:
312
242
  - id: dropdown_menu_arrow_center_btn
313
243
  type: Button
@@ -331,7 +261,7 @@ Right-click anywhere in this card to open the context menu.
331
261
  type: MenuGroup
332
262
  properties:
333
263
  title: Navigation
334
- icon: grid
264
+ icon: AiOutlineAppstore
335
265
  links:
336
266
  - id: dm_grp_nav_home
337
267
  type: MenuLink
@@ -349,7 +279,7 @@ Right-click anywhere in this card to open the context menu.
349
279
  type: MenuGroup
350
280
  properties:
351
281
  title: Account
352
- icon: user
282
+ icon: AiOutlineUser
353
283
  links:
354
284
  - id: dm_grp_acc_profile
355
285
  type: MenuLink
@@ -384,7 +314,7 @@ Right-click anywhere in this card to open the context menu.
384
314
  type: MenuLink
385
315
  properties:
386
316
  title: Available Action
387
- icon: check
317
+ icon: AiOutlineCheck
388
318
  - id: dm_dis_disabled
389
319
  type: MenuLink
390
320
  properties:
@@ -420,13 +350,13 @@ Right-click anywhere in this card to open the context menu.
420
350
  type: MenuLink
421
351
  properties:
422
352
  title: New File
423
- icon: FilePlus
353
+ icon: AiOutlineFileAdd
424
354
  shortcut: mod+shift+N
425
355
  - id: dm_sc_save
426
356
  type: MenuLink
427
357
  properties:
428
358
  title: Save
429
- icon: save
359
+ icon: AiOutlineSave
430
360
  shortcut: mod+shift+S
431
361
  - id: dm_sc_div
432
362
  type: MenuDivider
@@ -434,7 +364,7 @@ Right-click anywhere in this card to open the context menu.
434
364
  type: MenuLink
435
365
  properties:
436
366
  title: Close
437
- icon: close
367
+ icon: AiOutlineClose
438
368
  shortcut: mod+shift+W
439
369
  events:
440
370
  onClick:
@@ -489,7 +419,7 @@ Right-click anywhere in this card to open the context menu.
489
419
  title: Click to Toggle
490
420
  color: primary
491
421
  variant: solid
492
- icon: bell
422
+ icon: AiOutlineBell
493
423
  ```
494
424
 
495
425
  ```yaml
@@ -504,17 +434,17 @@ Right-click anywhere in this card to open the context menu.
504
434
  type: MenuLink
505
435
  properties:
506
436
  title: Edit
507
- icon: edit
437
+ icon: AiOutlineEdit
508
438
  - id: dm_oc_copy
509
439
  type: MenuLink
510
440
  properties:
511
441
  title: Copy
512
- icon: copy
442
+ icon: AiOutlineCopy
513
443
  - id: dm_oc_delete
514
444
  type: MenuLink
515
445
  properties:
516
446
  title: Delete
517
- icon: delete
447
+ icon: AiOutlineDelete
518
448
  danger: true
519
449
  events:
520
450
  onClick:
@@ -589,20 +519,20 @@ Jane Doe
589
519
  pageId: home
590
520
  properties:
591
521
  title: My Profile
592
- icon: user
522
+ icon: AiOutlineUser
593
523
  - id: dm_user_settings
594
524
  type: MenuLink
595
525
  pageId: home
596
526
  properties:
597
527
  title: Settings
598
- icon: settings
528
+ icon: AiOutlineSetting
599
529
  - id: dm_user_div
600
530
  type: MenuDivider
601
531
  - id: dm_user_logout
602
532
  type: MenuLink
603
533
  properties:
604
534
  title: Log Out
605
- icon: logout
535
+ icon: AiOutlineLogout
606
536
  danger: true
607
537
  blocks:
608
538
  - id: dropdown_menu_user_trigger
@@ -617,7 +547,8 @@ Jane Doe
617
547
  flex: 0 0 auto
618
548
  properties:
619
549
  content: JD
620
- color: "#1677ff"
550
+ color: "#fff"
551
+ backgroundColor: "#1677ff"
621
552
  - id: dropdown_menu_user_name
622
553
  type: Paragraph
623
554
  layout:
@@ -638,7 +569,7 @@ Jane Doe
638
569
  type: Button
639
570
  properties:
640
571
  title: Open Menu
641
- icon: menu
572
+ icon: AiOutlineMenu
642
573
  ```
643
574
 
644
575
  | Property | Type | Default | Description |
@@ -653,16 +584,7 @@ Jane Doe
653
584
  | `links.$.class` | string \| array \| object | - | CSS classes for the menu item. Flat applies to the item wrapper; use dot-prefixed slot keys to target parts. |
654
585
  | `links.$.properties` | object | - | Properties for the menu item. |
655
586
  | `links.$.properties.title` | string | - | Menu item title. |
656
- | `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. |
657
- | `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`. |
658
- | `links.$.properties.icon.color` | string | - | Icon color. |
659
- | `links.$.properties.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
660
- | `links.$.properties.icon.rotate` | number | - | Number of degrees to rotate the icon. |
661
- | `links.$.properties.icon.spin` | boolean | - | Continuously spin the icon with animation. |
662
- | `links.$.properties.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
663
- | `links.$.properties.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
664
- | `links.$.properties.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
665
- | `links.$.properties.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
587
+ | `links.$.properties.icon` | string \| object | - | Name of a React-Icon or properties of an Icon block to customize icon on menu item. |
666
588
  | `links.$.properties.danger` | boolean | `false` | Apply danger style to menu item. |
667
589
  | `links.$.properties.disabled` | boolean | `false` | Disable the menu item. |
668
590
  | `links.$.properties.tooltip` | string | - | Tooltip text shown when the menu is collapsed. |
@@ -680,15 +602,6 @@ Jane Doe
680
602
  | `links.$.links.$.properties` | object | - | Properties for the menu item. |
681
603
  | `links.$.links.$.properties.title` | string | - | Menu item title. |
682
604
  | `links.$.links.$.properties.icon` | string \| object | - | Icon name or config. |
683
- | `links.$.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`. |
684
- | `links.$.links.$.properties.icon.color` | string | - | Icon color. |
685
- | `links.$.links.$.properties.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
686
- | `links.$.links.$.properties.icon.rotate` | number | - | Number of degrees to rotate the icon. |
687
- | `links.$.links.$.properties.icon.spin` | boolean | - | Continuously spin the icon with animation. |
688
- | `links.$.links.$.properties.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
689
- | `links.$.links.$.properties.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
690
- | `links.$.links.$.properties.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
691
- | `links.$.links.$.properties.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
692
605
  | `links.$.links.$.properties.danger` | boolean | `false` | Danger style. |
693
606
  | `links.$.links.$.properties.disabled` | boolean | `false` | Disable the item. |
694
607
  | `links.$.links.$.properties.tooltip` | string | - | Tooltip text shown when the menu is collapsed. |
@@ -696,12 +609,11 @@ Jane Doe
696
609
  | `links.$.links.$.properties.dashed` | boolean | `false` | Dashed divider line. |
697
610
  | `links.$.links.$.properties.shortcut` | string | - | Keyboard shortcut. Renders a kbd badge floated to the far right and wires the key handler. Use "mod" for Cmd/Ctrl. |
698
611
  | `trigger` | string | `"hover"` | How the dropdown opens. Enum: `click`, `hover`, `contextMenu`. |
699
- | `placement` | string | `"bottomLeft"` | Position relative to trigger. Enum: `bottomLeft`, `bottom`, `bottomRight`, `topLeft`, `top`, `topRight`, `left`, `leftTop`, `leftBottom`, `right`, `rightTop`, `rightBottom`. |
612
+ | `placement` | string | `"bottomLeft"` | Position relative to trigger. Enum: `bottomLeft`, `bottom`, `bottomRight`, `topLeft`, `top`, `topRight`. |
700
613
  | `arrow` | boolean \| object | `false` | Show arrow pointing to trigger. |
701
614
  | `arrow.pointAtCenter` | boolean | - | |
702
615
  | `disabled` | boolean | `false` | Disable the dropdown. |
703
616
  | `destroyOnClose` | boolean | `false` | Unmount menu DOM when closed. |
704
- | `selectable` | boolean | `false` | Allow menu items to be selected. Selecting an item highlights it and fires onSelect. |
705
617
  | `selectedKeys` | array | - | Highlighted menu items. |
706
618
  | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design dropdown tokens](https://ant.design/components/dropdown#design-token). |
707
619
  | `theme.zIndexPopup` | number | `1050` | Z-index of the dropdown popup. |
@@ -713,7 +625,7 @@ Jane Doe
713
625
  | Event | Event Data | Description |
714
626
  | --- | --- | --- |
715
627
  | `onClick` | `{ key, keyPath, pageId, url }` | Trigger action when a menu item is clicked. |
716
- | `onSelect` | `{ key, selectedKeys, pageId, url }` | Trigger action when a menu item is selected. Requires `selectable: true`. |
628
+ | `onSelect` | `{ key, selectedKeys, pageId, url }` | Trigger action when a menu item is selected. |
717
629
  | `onOpenChange` | `{ open }` | Trigger action when dropdown opens or closes. |
718
630
 
719
631
  | Key | Target |
@@ -723,8 +635,8 @@ Jane Doe
723
635
  | `/menu` | The floating menu container. |
724
636
  | `/item` | Individual menu items. |
725
637
  | `/itemIcon` | Icon within menu items. |
726
- | `/subMenu` | Has no effect: antd does not expose submenu containers as a separately styled part. The item key also applies to submenu items. |
727
- | `/arrow` | Has no effect: antd does not expose the dropdown arrow as a separately styled part. |
638
+ | `/subMenu` | Submenu/group containers. |
639
+ | `/arrow` | Dropdown arrow indicator. |
728
640
 
729
641
  | Slot | Description |
730
642
  | --- | --- |