@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
@@ -26,17 +26,17 @@ The Sider block provides a sidebar within a Layout. It supports collapsing, them
26
26
  type: MenuLink
27
27
  properties:
28
28
  title: Home
29
- icon: home
29
+ icon: AiOutlineHome
30
30
  - id: basic_users
31
31
  type: MenuLink
32
32
  properties:
33
33
  title: Users
34
- icon: user
34
+ icon: AiOutlineUser
35
35
  - id: basic_settings
36
36
  type: MenuLink
37
37
  properties:
38
38
  title: Settings
39
- icon: settings
39
+ icon: AiOutlineSetting
40
40
  - id: basic_content
41
41
  type: Content
42
42
  style:
@@ -75,17 +75,17 @@ Setting theme to "dark" gives the sider a dark background with light text. Match
75
75
  type: MenuLink
76
76
  properties:
77
77
  title: Dashboard
78
- icon: Gauge
78
+ icon: AiOutlineDashboard
79
79
  - id: dark_analytics
80
80
  type: MenuLink
81
81
  properties:
82
82
  title: Analytics
83
- icon: chart
83
+ icon: AiOutlineBarChart
84
84
  - id: dark_files
85
85
  type: MenuLink
86
86
  properties:
87
87
  title: Files
88
- icon: file
88
+ icon: AiOutlineFile
89
89
  - id: dark_content
90
90
  type: Content
91
91
  style:
@@ -126,17 +126,17 @@ With collapsible set to true a collapse trigger appears at the bottom. Toggle be
126
126
  type: MenuLink
127
127
  properties:
128
128
  title: Inbox
129
- icon: Inbox
129
+ icon: AiOutlineInbox
130
130
  - id: col_starred
131
131
  type: MenuLink
132
132
  properties:
133
133
  title: Starred
134
- icon: star
134
+ icon: AiOutlineStar
135
135
  - id: col_sent
136
136
  type: MenuLink
137
137
  properties:
138
138
  title: Sent
139
- icon: send
139
+ icon: AiOutlineSend
140
140
  - id: collapsible_content
141
141
  type: Content
142
142
  style:
@@ -177,17 +177,17 @@ This sider starts collapsed with initialCollapsed set to true. Click the collaps
177
177
  type: MenuLink
178
178
  properties:
179
179
  title: Overview
180
- icon: grid
180
+ icon: AiOutlineAppstore
181
181
  - id: ic_reports
182
182
  type: MenuLink
183
183
  properties:
184
184
  title: Reports
185
- icon: document
185
+ icon: AiOutlineFileText
186
186
  - id: ic_config
187
187
  type: MenuLink
188
188
  properties:
189
189
  title: Configuration
190
- icon: Wrench
190
+ icon: AiOutlineTool
191
191
  - id: init_collapsed_content
192
192
  type: Content
193
193
  style:
@@ -228,12 +228,12 @@ Setting collapsedWidth to 0 completely hides the sider when collapsed and shows
228
228
  type: MenuLink
229
229
  properties:
230
230
  title: Projects
231
- icon: SquareKanban
231
+ icon: AiOutlineProject
232
232
  - id: cw_tasks
233
233
  type: MenuLink
234
234
  properties:
235
235
  title: Tasks
236
- icon: SquareCheck
236
+ icon: AiOutlineCheckSquare
237
237
  - id: cw_content
238
238
  type: Content
239
239
  style:
@@ -277,7 +277,7 @@ The Sider is placed on the right side of the layout with reverseArrow set to tru
277
277
  initialCollapsed: false
278
278
  reverseArrow: true
279
279
  style:
280
- borderLeft: "1px solid #f0f0f0"
280
+ borderLeft: 1px solid
281
281
  blocks:
282
282
  - id: reverse_menu
283
283
  type: Menu
@@ -289,15 +289,15 @@ The Sider is placed on the right side of the layout with reverseArrow set to tru
289
289
  type: MenuLink
290
290
  properties:
291
291
  title: Details
292
- icon: info
292
+ icon: AiOutlineInfoCircle
293
293
  - id: rev_history
294
294
  type: MenuLink
295
295
  properties:
296
296
  title: History
297
- icon: history
297
+ icon: AiOutlineHistory
298
298
  ```
299
299
 
300
- The onBreakpoint event fires when the viewport crosses the breakpoint, with `broken` true below it. Here it calls the sider's setOpen method, so the sider collapses below the large (lg) breakpoint. Supported values are xs, sm, md, lg, xl, xxl and xxxl.
300
+ The breakpoint property controls when the sider automatically collapses on smaller screens. Set to "lg" here, so the sider collapses when the viewport is below the large breakpoint. Supported values are xs, sm, md, lg, xl, and xxl.
301
301
 
302
302
  ```yaml
303
303
  - id: bp_layout
@@ -315,15 +315,10 @@ The onBreakpoint event fires when the viewport crosses the breakpoint, with `bro
315
315
  breakpoint: lg
316
316
  events:
317
317
  onBreakpoint:
318
- - id: bp_sider_set_open
319
- type: CallMethod
318
+ - id: bp_sider_set_state
319
+ type: SetState
320
320
  params:
321
- blockId: bp_sider
322
- method: setOpen
323
- args:
324
- - open:
325
- _not:
326
- _event: broken
321
+ breakpointTriggered: true
327
322
  blocks:
328
323
  - id: bp_menu
329
324
  type: Menu
@@ -335,12 +330,12 @@ The onBreakpoint event fires when the viewport crosses the breakpoint, with `bro
335
330
  type: MenuLink
336
331
  properties:
337
332
  title: Home
338
- icon: home
333
+ icon: AiOutlineHome
339
334
  - id: bp_search
340
335
  type: MenuLink
341
336
  properties:
342
337
  title: Search
343
- icon: search
338
+ icon: AiOutlineSearch
344
339
  - id: bp_content
345
340
  type: Content
346
341
  style:
@@ -350,10 +345,10 @@ The onBreakpoint event fires when the viewport crosses the breakpoint, with `bro
350
345
  - id: bp_content_text
351
346
  type: Paragraph
352
347
  properties:
353
- content: The onBreakpoint event fires when the viewport crosses the breakpoint,
354
- with `broken` true below it. Here it calls the sider's setOpen
355
- method, so the sider collapses below the large (lg) breakpoint.
356
- Supported values are xs, sm, md, lg, xl, xxl and xxxl.
348
+ content: The breakpoint property controls when the sider automatically collapses
349
+ on smaller screens. Set to "lg" here, so the sider collapses when
350
+ the viewport is below the large breakpoint. Supported values are
351
+ xs, sm, md, lg, xl, and xxl.
357
352
  ```
358
353
 
359
354
  The width property accepts a number (pixels) or string value. Here the sider is set to 300px wide, providing more room for longer menu labels or nested navigation.
@@ -382,17 +377,17 @@ The width property accepts a number (pixels) or string value. Here the sider is
382
377
  type: MenuLink
383
378
  properties:
384
379
  title: Getting Started
385
- icon: Rocket
380
+ icon: AiOutlineRocket
386
381
  - id: width_nav2
387
382
  type: MenuLink
388
383
  properties:
389
384
  title: Documentation
390
- icon: Book
385
+ icon: AiOutlineBook
391
386
  - id: width_nav3
392
387
  type: MenuLink
393
388
  properties:
394
389
  title: API Reference
395
- icon: CodeXml
390
+ icon: AiOutlineCode
396
391
  - id: width_content
397
392
  type: Content
398
393
  style:
@@ -444,12 +439,12 @@ The Sider fires onOpen and onClose events when it expands or collapses. Use thes
444
439
  type: MenuLink
445
440
  properties:
446
441
  title: Home
447
- icon: home
442
+ icon: AiOutlineHome
448
443
  - id: events_nav_alerts
449
444
  type: MenuLink
450
445
  properties:
451
446
  title: Alerts
452
- icon: bell
447
+ icon: AiOutlineBell
453
448
  - id: events_content
454
449
  type: Content
455
450
  style:
@@ -472,7 +467,9 @@ The Sider fires onOpen and onClose events when it expands or collapses. Use thes
472
467
  state changes. Toggle the sider to see the state update above.
473
468
  ```
474
469
 
475
- The Sider theme takes antd Layout design tokens. Here lightTriggerBg, lightTriggerColor and triggerHeight style the collapse trigger, and the Menu theme styles the selected item.
470
+ Use designTokens to override antd theme tokens on the Sider. Here colorBgContainer changes the sidebar background, colorPrimary affects the selected item highlight, and colorText changes the menu text color.
471
+
472
+ Token overrides work with both light and dark themes. This dark sider uses a custom navy background and green primary color for the active menu item highlight.
476
473
 
477
474
  ```yaml
478
475
  - id: token_layout
@@ -483,37 +480,35 @@ The Sider theme takes antd Layout design tokens. Here lightTriggerBg, lightTrigg
483
480
  - id: token_sider
484
481
  type: Sider
485
482
  properties:
483
+ theme: light
486
484
  width: 220
487
485
  collapsible: true
488
486
  initialCollapsed: false
489
- theme:
490
- lightTriggerBg: "#f9f0ff"
491
- lightTriggerColor: "#722ed1"
492
- triggerHeight: 40
487
+ designTokens:
488
+ colorPrimary: "#722ed1"
489
+ colorText: "#531dab"
493
490
  blocks:
494
491
  - id: token_menu
495
492
  type: Menu
496
493
  properties:
497
494
  mode: inline
498
- theme:
499
- itemSelectedBg: "#f9f0ff"
500
- itemSelectedColor: "#722ed1"
495
+ theme: light
501
496
  links:
502
497
  - id: token_nav_explore
503
498
  type: MenuLink
504
499
  properties:
505
500
  title: Explore
506
- icon: Compass
501
+ icon: AiOutlineCompass
507
502
  - id: token_nav_favorites
508
503
  type: MenuLink
509
504
  properties:
510
505
  title: Favorites
511
- icon: heart
506
+ icon: AiOutlineHeart
512
507
  - id: token_nav_settings
513
508
  type: MenuLink
514
509
  properties:
515
510
  title: Settings
516
- icon: settings
511
+ icon: AiOutlineSetting
517
512
  - id: token_content
518
513
  type: Content
519
514
  style:
@@ -523,9 +518,59 @@ The Sider theme takes antd Layout design tokens. Here lightTriggerBg, lightTrigg
523
518
  - id: token_content_text
524
519
  type: Paragraph
525
520
  properties:
526
- content: The Sider theme takes antd Layout design tokens. Here lightTriggerBg,
527
- lightTriggerColor and triggerHeight style the collapse trigger,
528
- and the Menu theme styles the selected item.
521
+ content: Use designTokens to override antd theme tokens on the Sider. Here
522
+ colorBgContainer changes the sidebar background, colorPrimary
523
+ affects the selected item highlight, and colorText changes the
524
+ menu text color.
525
+ - id: token_dark_layout
526
+ type: Layout
527
+ style:
528
+ minHeight: 300px
529
+ blocks:
530
+ - id: token_dark_sider
531
+ type: Sider
532
+ properties:
533
+ theme: dark
534
+ width: 220
535
+ collapsible: true
536
+ initialCollapsed: false
537
+ designTokens:
538
+ colorPrimary: "#52c41a"
539
+ colorBgContainer: "#1a1a2e"
540
+ blocks:
541
+ - id: token_dark_menu
542
+ type: Menu
543
+ properties:
544
+ mode: inline
545
+ theme: dark
546
+ links:
547
+ - id: token_dark_nav_status
548
+ type: MenuLink
549
+ properties:
550
+ title: Status
551
+ icon: AiOutlineCheckCircle
552
+ - id: token_dark_nav_logs
553
+ type: MenuLink
554
+ properties:
555
+ title: Logs
556
+ icon: AiOutlineFileText
557
+ - id: token_dark_nav_deploy
558
+ type: MenuLink
559
+ properties:
560
+ title: Deploy
561
+ icon: AiOutlineCloudUpload
562
+ - id: token_dark_content
563
+ type: Content
564
+ style:
565
+ padding: 24px
566
+ background: var(--ant-color-bg-container)
567
+ blocks:
568
+ - id: token_dark_content_text
569
+ type: Paragraph
570
+ properties:
571
+ content: Token overrides work with both light and dark themes. This dark sider
572
+ uses a custom navy background and green primary color for the
573
+ active menu item highlight.
529
574
  ```
530
575
 
531
576
  The Sider has a single CSS key called "element" which targets the entire sider container. Use it with Tailwind classes for gradients, borders, shadows, and other visual effects.
@@ -546,7 +591,7 @@ A shadow-lg class on the element CSS key gives the sider an elevated appearance
546
591
  collapsible: false
547
592
  initialCollapsed: false
548
593
  class:
549
- .element: bg-gradient-to-b from-primary/10 to-bg-container border-r border-border
594
+ element: bg-gradient-to-b from-primary/10 to-bg-container border-r border-border
550
595
  blocks:
551
596
  - id: css_menu
552
597
  type: Menu
@@ -558,17 +603,17 @@ A shadow-lg class on the element CSS key gives the sider an elevated appearance
558
603
  type: MenuLink
559
604
  properties:
560
605
  title: Workspace
561
- icon: grid
606
+ icon: AiOutlineAppstore
562
607
  - id: css_nav_members
563
608
  type: MenuLink
564
609
  properties:
565
610
  title: Members
566
- icon: users
611
+ icon: AiOutlineTeam
567
612
  - id: css_nav_billing
568
613
  type: MenuLink
569
614
  properties:
570
615
  title: Billing
571
- icon: CreditCard
616
+ icon: AiOutlineCreditCard
572
617
  - id: css_content
573
618
  type: Content
574
619
  style:
@@ -594,7 +639,7 @@ A shadow-lg class on the element CSS key gives the sider an elevated appearance
594
639
  collapsible: false
595
640
  initialCollapsed: false
596
641
  class:
597
- .element: shadow-lg bg-bg-container
642
+ element: shadow-lg bg-bg-container
598
643
  blocks:
599
644
  - id: css_shadow_menu
600
645
  type: Menu
@@ -606,12 +651,12 @@ A shadow-lg class on the element CSS key gives the sider an elevated appearance
606
651
  type: MenuLink
607
652
  properties:
608
653
  title: Dashboard
609
- icon: Gauge
654
+ icon: AiOutlineDashboard
610
655
  - id: css_sh_analytics
611
656
  type: MenuLink
612
657
  properties:
613
658
  title: Analytics
614
- icon: ChartLine
659
+ icon: AiOutlineLineChart
615
660
  - id: css_shadow_content
616
661
  type: Content
617
662
  style:
@@ -676,12 +721,12 @@ Dashboard
676
721
  type: MenuLink
677
722
  properties:
678
723
  title: Dashboard
679
- icon: Gauge
724
+ icon: AiOutlineDashboard
680
725
  - id: admin_nav_users
681
726
  type: MenuGroup
682
727
  properties:
683
728
  title: User Management
684
- icon: users
729
+ icon: AiOutlineTeam
685
730
  links:
686
731
  - id: admin_nav_all_users
687
732
  type: MenuLink
@@ -695,7 +740,7 @@ Dashboard
695
740
  type: MenuGroup
696
741
  properties:
697
742
  title: Content
698
- icon: document
743
+ icon: AiOutlineFileText
699
744
  links:
700
745
  - id: admin_nav_pages
701
746
  type: MenuLink
@@ -709,7 +754,7 @@ Dashboard
709
754
  type: MenuLink
710
755
  properties:
711
756
  title: Settings
712
- icon: settings
757
+ icon: AiOutlineSetting
713
758
  - id: admin_content
714
759
  type: Content
715
760
  style:
@@ -741,7 +786,7 @@ Dashboard
741
786
  layout:
742
787
  flex: 0 0 auto
743
788
  properties:
744
- icon: bell
789
+ icon: AiOutlineBell
745
790
  color: default
746
791
  variant: text
747
792
  hideTitle: true
@@ -750,7 +795,7 @@ Dashboard
750
795
  layout:
751
796
  flex: 0 0 auto
752
797
  properties:
753
- icon: user
798
+ icon: AiOutlineUser
754
799
  color: default
755
800
  variant: text
756
801
  hideTitle: true
@@ -818,7 +863,7 @@ Manage your personal information and preferences.
818
863
  collapsible: false
819
864
  initialCollapsed: false
820
865
  style:
821
- borderRight: "1px solid #f0f0f0"
866
+ borderRight: 1px solid
822
867
  blocks:
823
868
  - id: settings_heading
824
869
  type: Title
@@ -837,27 +882,27 @@ Manage your personal information and preferences.
837
882
  type: MenuLink
838
883
  properties:
839
884
  title: Profile
840
- icon: user
885
+ icon: AiOutlineUser
841
886
  - id: settings_nav_account
842
887
  type: MenuLink
843
888
  properties:
844
889
  title: Account
845
- icon: Shield
890
+ icon: AiOutlineSafety
846
891
  - id: settings_nav_notifications
847
892
  type: MenuLink
848
893
  properties:
849
894
  title: Notifications
850
- icon: bell
895
+ icon: AiOutlineBell
851
896
  - id: settings_nav_appearance
852
897
  type: MenuLink
853
898
  properties:
854
899
  title: Appearance
855
- icon: PaintBucket
900
+ icon: AiOutlineBgColors
856
901
  - id: settings_nav_integrations
857
902
  type: MenuLink
858
903
  properties:
859
904
  title: Integrations
860
- icon: Plug
905
+ icon: AiOutlineApi
861
906
  - id: settings_content
862
907
  type: Content
863
908
  style:
@@ -896,7 +941,7 @@ Manage your personal information and preferences.
896
941
  title: Save Changes
897
942
  color: primary
898
943
  variant: solid
899
- icon: save
944
+ icon: AiOutlineSave
900
945
  ```
901
946
 
902
947
  Introduction
@@ -920,7 +965,7 @@ Use the sidebar on the left to browse through different sections. On smaller scr
920
965
  initialCollapsed: false
921
966
  breakpoint: md
922
967
  class:
923
- .element: border-r border-border
968
+ element: border-r border-border
924
969
  blocks:
925
970
  - id: docs_search
926
971
  type: TextInput
@@ -928,7 +973,7 @@ Use the sidebar on the left to browse through different sections. On smaller scr
928
973
  padding: 12px 16px
929
974
  properties:
930
975
  placeholder: Search docs...
931
- prefixIcon: search
976
+ prefixIcon: AiOutlineSearch
932
977
  - id: docs_menu
933
978
  type: Menu
934
979
  properties:
@@ -995,32 +1040,24 @@ Use the sidebar on the left to browse through different sections. On smaller scr
995
1040
 
996
1041
  | Property | Type | Default | Description |
997
1042
  | --- | --- | --- | --- |
998
- | `breakpoint` | string | - | Breakpoint of the responsive layout. Crossing it fires onBreakpoint. Enum: `xs`, `sm`, `md`, `lg`, `xl`, `xxl`, `xxxl`. |
1043
+ | `breakpoint` | string | `"sm"` | Breakpoint of the responsive layout Enum: `xs`, `sm`, `md`, `lg`, `xl`, `xxl`. |
999
1044
  | `collapsedWidth` | integer | - | Width of the collapsed sidebar, by setting to 0 a special trigger will appear |
1000
- | `collapsible` | boolean | `false` | Show a trigger at the bottom of the sider that collapses and expands it. |
1045
+ | `collapsible` | boolean | - | Whether can be collapsed |
1001
1046
  | `initialCollapsed` | boolean | `true` | Set the initial collapsed state |
1002
1047
  | `reverseArrow` | boolean | `false` | Direction of arrow, for a sider that expands from the right |
1003
1048
  | `width` | string \| number | - | width of the sidebar |
1004
- | `theme` | string \| object | - | The Sider color theme, light or dark, or antd Layout design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design layout tokens](https://ant.design/components/layout#design-token). |
1005
- | `theme.triggerHeight` | number | `48` | Height of the collapse trigger of a collapsible Sider. |
1006
- | `theme.triggerBg` | string | `"#002140"` | Background color of the collapse trigger of a dark Sider. |
1007
- | `theme.triggerColor` | string | `"#fff"` | Color of the collapse trigger of a dark Sider. |
1008
- | `theme.lightTriggerBg` | string | `"#ffffff"` | Background color of the collapse trigger of a light Sider. |
1009
- | `theme.lightTriggerColor` | string | `"rgba(0, 0, 0, 0.88)"` | Color of the collapse trigger of a light Sider. |
1010
- | `theme.zeroTriggerWidth` | number | `40` | Width of the trigger shown when collapsedWidth is 0. |
1011
- | `theme.zeroTriggerHeight` | number | `40` | Height of the trigger shown when collapsedWidth is 0. |
1049
+ | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). |
1012
1050
 
1013
1051
  | Event | Event Data | Description |
1014
1052
  | --- | --- | --- |
1015
1053
  | `onClose` | \- | Trigger actions when sider is closed. |
1016
1054
  | `onOpen` | \- | Trigger actions when sider is opened. |
1017
- | `onBreakpoint` | `{ broken }` | Trigger actions when the screen width crosses the breakpoint. Use it with the setOpen method to collapse the sider on small screens. |
1055
+ | `onBreakpoint` | \- | Trigger actions on breakpoint change. |
1018
1056
 
1019
1057
  | Key | Target |
1020
1058
  | --- | --- |
1021
1059
  | `/block` | Outer block wrapper (always available). |
1022
1060
  | `/element` | The Sider element. |
1023
- | `/body` | The box inside the Sider that holds its child blocks. |
1024
1061
 
1025
1062
  | Slot | Description |
1026
1063
  | --- | --- |
@@ -53,7 +53,7 @@ This content property overrides the content area below.
53
53
  layout:
54
54
  flex: 0 0 auto
55
55
  properties:
56
- name: info
56
+ name: AiOutlineInfoCircle
57
57
  size: 14
58
58
  color: "#1677ff"
59
59
  - id: span_content_area_text
@@ -338,7 +338,7 @@ Status:
338
338
  layout:
339
339
  flex: 0 0 auto
340
340
  properties:
341
- name: check-circle
341
+ name: AiOutlineCheckCircle
342
342
  size: 14
343
343
  color: "#52c41a"
344
344
  - id: span_nested_value_text
@@ -465,7 +465,7 @@ LIVE
465
465
  layout:
466
466
  flex: 0 0 auto
467
467
  properties:
468
- name: FaceSlightlySmiling
468
+ name: AiOutlineSmile
469
469
  size: 16
470
470
  color: "#faad14"
471
471
  - id: span_icon_smile_label
@@ -487,7 +487,7 @@ LIVE
487
487
  layout:
488
488
  flex: 0 0 auto
489
489
  properties:
490
- name: check-circle
490
+ name: AiOutlineCheckCircle
491
491
  size: 16
492
492
  color: "#52c41a"
493
493
  - id: span_icon_check_label
@@ -509,7 +509,7 @@ LIVE
509
509
  layout:
510
510
  flex: 0 0 auto
511
511
  properties:
512
- name: warning
512
+ name: AiOutlineWarning
513
513
  size: 16
514
514
  color: "#ff4d4f"
515
515
  - id: span_icon_warning_label
@@ -563,7 +563,7 @@ Estimated delivery Mar 18, 2026
563
563
  layout:
564
564
  flex: 0 0 auto
565
565
  properties:
566
- name: check-circle
566
+ name: AiOutlineCheckCircle
567
567
  size: 14
568
568
  color: "#52c41a"
569
569
  - id: span_order_shipped_text
@@ -679,7 +679,7 @@ Admin
679
679
  layout:
680
680
  flex: 0 0 auto
681
681
  properties:
682
- name: user
682
+ name: AiOutlineUser
683
683
  size: 20
684
684
  color: "#1677ff"
685
685
  - id: span_profile_name
@@ -150,7 +150,7 @@ Loading orders...
150
150
  flex: 0 0 auto
151
151
  properties:
152
152
  title: Refresh
153
- icon: refresh
153
+ icon: AiOutlineReload
154
154
  color: primary
155
155
  variant: outlined
156
156
  size: small
@@ -239,7 +239,7 @@ Loading orders...
239
239
  title: Submit
240
240
  color: primary
241
241
  variant: solid
242
- icon: send
242
+ icon: AiOutlineSend
243
243
  events:
244
244
  onClick:
245
245
  - id: spinner_btn_loading_set_state
@@ -255,7 +255,7 @@ Loading orders...
255
255
 
256
256
  | Property | Type | Default | Description |
257
257
  | --- | --- | --- | --- |
258
- | `size` | string \| number | - | Size of the icon spinner: small, medium, large, or a pixel number. |
258
+ | `size` | string | - | Size of the icon spinner. Enum: `small`, `medium`, `large`. |
259
259
 
260
260
  No events defined.
261
261