@lowdefy/docs-content 0.0.0-experimental-20260710073520

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 (304) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +20 -0
  3. package/content/actions/callapi.md +66 -0
  4. package/content/actions/callmethod.md +41 -0
  5. package/content/actions/copytoclipboard.md +32 -0
  6. package/content/actions/displaymessage.md +53 -0
  7. package/content/actions/downloadcsv.md +89 -0
  8. package/content/actions/fetch.md +50 -0
  9. package/content/actions/geolocationcurrentposition.md +56 -0
  10. package/content/actions/link.md +104 -0
  11. package/content/actions/login.md +85 -0
  12. package/content/actions/logout.md +56 -0
  13. package/content/actions/pdfmake.md +304 -0
  14. package/content/actions/request.md +67 -0
  15. package/content/actions/reset.md +27 -0
  16. package/content/actions/resetvalidation.md +85 -0
  17. package/content/actions/scrollto.md +85 -0
  18. package/content/actions/setdarkmode.md +62 -0
  19. package/content/actions/setfocus.md +33 -0
  20. package/content/actions/setglobal.md +63 -0
  21. package/content/actions/setlocale.md +69 -0
  22. package/content/actions/setstate.md +70 -0
  23. package/content/actions/throw.md +72 -0
  24. package/content/actions/validate.md +87 -0
  25. package/content/actions/wait.md +24 -0
  26. package/content/agents/agent-endpoint-tools.md +190 -0
  27. package/content/agents/agent-mcp-tools.md +124 -0
  28. package/content/agents/agent-multi-agent.md +136 -0
  29. package/content/agents/agent-properties.md +174 -0
  30. package/content/agents/agent-server-hooks.md +336 -0
  31. package/content/agents/agentchat.md +515 -0
  32. package/content/agents/agentconversations.md +148 -0
  33. package/content/concepts/ai-agent-docs.md +190 -0
  34. package/content/concepts/cli.md +213 -0
  35. package/content/concepts/connections-and-requests.md +7 -0
  36. package/content/concepts/custom-html.md +3 -0
  37. package/content/concepts/custom-styling.md +161 -0
  38. package/content/concepts/events-and-actions.md +271 -0
  39. package/content/concepts/hosting-files.md +18 -0
  40. package/content/concepts/i18n.md +320 -0
  41. package/content/concepts/keyboard-shortcuts.md +218 -0
  42. package/content/concepts/layout-overview.md +478 -0
  43. package/content/concepts/lists.md +144 -0
  44. package/content/concepts/logger.md +43 -0
  45. package/content/concepts/lowdefy-schema.md +365 -0
  46. package/content/concepts/menus.md +144 -0
  47. package/content/concepts/module-authoring.md +564 -0
  48. package/content/concepts/modules.md +338 -0
  49. package/content/concepts/operators.md +45 -0
  50. package/content/concepts/overview.md +19 -0
  51. package/content/concepts/references-and-templates.md +207 -0
  52. package/content/concepts/secrets.md +24 -0
  53. package/content/concepts/selectors.md +143 -0
  54. package/content/connections/amazonredshift.md +176 -0
  55. package/content/connections/anthropic.md +232 -0
  56. package/content/connections/awss3.md +313 -0
  57. package/content/connections/azureblobstorage.md +133 -0
  58. package/content/connections/elasticsearch.md +371 -0
  59. package/content/connections/google.md +228 -0
  60. package/content/connections/googlecloudstorage.md +139 -0
  61. package/content/connections/googlesheet.md +313 -0
  62. package/content/connections/knex.md +206 -0
  63. package/content/connections/mariadb.md +177 -0
  64. package/content/connections/mcp.md +134 -0
  65. package/content/connections/mongodb.md +739 -0
  66. package/content/connections/mssql.md +191 -0
  67. package/content/connections/mysql.md +192 -0
  68. package/content/connections/openai-connection.md +228 -0
  69. package/content/connections/postgresql.md +200 -0
  70. package/content/connections/redis.md +116 -0
  71. package/content/connections/sendgridmail.md +94 -0
  72. package/content/connections/smtp.md +149 -0
  73. package/content/connections/sqlite.md +187 -0
  74. package/content/connections/stripe.md +115 -0
  75. package/content/container-blocks/affix.md +413 -0
  76. package/content/container-blocks/alert.md +937 -0
  77. package/content/container-blocks/badge.md +1222 -0
  78. package/content/container-blocks/box.md +1453 -0
  79. package/content/container-blocks/card.md +1200 -0
  80. package/content/container-blocks/carousel.md +2247 -0
  81. package/content/container-blocks/collapse.md +1335 -0
  82. package/content/container-blocks/configprovider.md +1070 -0
  83. package/content/container-blocks/confirmmodal.md +1159 -0
  84. package/content/container-blocks/content.md +597 -0
  85. package/content/container-blocks/descriptions.md +870 -0
  86. package/content/container-blocks/drawer.md +1379 -0
  87. package/content/container-blocks/dropdownmenu.md +643 -0
  88. package/content/container-blocks/flex.md +1510 -0
  89. package/content/container-blocks/footer.md +380 -0
  90. package/content/container-blocks/googlemaps.md +546 -0
  91. package/content/container-blocks/googlemapsheatmap.md +607 -0
  92. package/content/container-blocks/googlemapsscript.md +61 -0
  93. package/content/container-blocks/header.md +302 -0
  94. package/content/container-blocks/label.md +739 -0
  95. package/content/container-blocks/layout.md +604 -0
  96. package/content/container-blocks/masonry.md +1090 -0
  97. package/content/container-blocks/mobilemenu.md +1244 -0
  98. package/content/container-blocks/modal.md +1180 -0
  99. package/content/container-blocks/pageheadermenu.md +614 -0
  100. package/content/container-blocks/pagesidebarlayout.md +438 -0
  101. package/content/container-blocks/pagesidermenu.md +651 -0
  102. package/content/container-blocks/popover.md +1421 -0
  103. package/content/container-blocks/result.md +972 -0
  104. package/content/container-blocks/sider.md +1064 -0
  105. package/content/container-blocks/span.md +747 -0
  106. package/content/container-blocks/spinner.md +267 -0
  107. package/content/container-blocks/splitter.md +1735 -0
  108. package/content/container-blocks/tabs.md +1718 -0
  109. package/content/container-blocks/tooltip.md +1274 -0
  110. package/content/container-blocks/watermark.md +515 -0
  111. package/content/controls/for.md +103 -0
  112. package/content/controls/if.md +107 -0
  113. package/content/controls/log.md +50 -0
  114. package/content/controls/parallel.md +71 -0
  115. package/content/controls/parallel_for.md +36 -0
  116. package/content/controls/reject.md +56 -0
  117. package/content/controls/return.md +66 -0
  118. package/content/controls/set_state.md +98 -0
  119. package/content/controls/switch.md +90 -0
  120. package/content/controls/throw.md +79 -0
  121. package/content/controls/try.md +88 -0
  122. package/content/deployment/docker.md +149 -0
  123. package/content/deployment/node-server.md +27 -0
  124. package/content/deployment/vercel.md +101 -0
  125. package/content/display-blocks/aggrid.md +1459 -0
  126. package/content/display-blocks/anchor.md +336 -0
  127. package/content/display-blocks/avatar.md +1154 -0
  128. package/content/display-blocks/breadcrumb.md +517 -0
  129. package/content/display-blocks/button.md +758 -0
  130. package/content/display-blocks/calendar.md +156 -0
  131. package/content/display-blocks/dangeroushtml.md +314 -0
  132. package/content/display-blocks/dangerousmarkdown.md +423 -0
  133. package/content/display-blocks/diffgit.md +44 -0
  134. package/content/display-blocks/difflist.md +225 -0
  135. package/content/display-blocks/diffsidebyside.md +56 -0
  136. package/content/display-blocks/difftimeline.md +94 -0
  137. package/content/display-blocks/divider.md +406 -0
  138. package/content/display-blocks/download.md +60 -0
  139. package/content/display-blocks/dropdownbutton.md +661 -0
  140. package/content/display-blocks/echart.md +418 -0
  141. package/content/display-blocks/floatbutton.md +545 -0
  142. package/content/display-blocks/html.md +311 -0
  143. package/content/display-blocks/icon.md +717 -0
  144. package/content/display-blocks/img.md +479 -0
  145. package/content/display-blocks/markdown.md +520 -0
  146. package/content/display-blocks/markdownwithcode.md +730 -0
  147. package/content/display-blocks/menu.md +1123 -0
  148. package/content/display-blocks/message.md +941 -0
  149. package/content/display-blocks/notification.md +1410 -0
  150. package/content/display-blocks/paragraph.md +643 -0
  151. package/content/display-blocks/progress.md +818 -0
  152. package/content/display-blocks/qrcode.md +519 -0
  153. package/content/display-blocks/s3download.md +240 -0
  154. package/content/display-blocks/search.md +360 -0
  155. package/content/display-blocks/skeleton.md +272 -0
  156. package/content/display-blocks/skeletonavatar.md +222 -0
  157. package/content/display-blocks/skeletonbutton.md +245 -0
  158. package/content/display-blocks/skeletoninput.md +223 -0
  159. package/content/display-blocks/skeletonparagraph.md +201 -0
  160. package/content/display-blocks/statistic.md +485 -0
  161. package/content/display-blocks/steps.md +585 -0
  162. package/content/display-blocks/tag.md +620 -0
  163. package/content/display-blocks/title.md +654 -0
  164. package/content/display-blocks/tour.md +2359 -0
  165. package/content/input-blocks/autocomplete.md +786 -0
  166. package/content/input-blocks/buttonselector.md +964 -0
  167. package/content/input-blocks/checkboxselector.md +765 -0
  168. package/content/input-blocks/checkboxswitch.md +497 -0
  169. package/content/input-blocks/colorselector.md +884 -0
  170. package/content/input-blocks/daterangeselector.md +777 -0
  171. package/content/input-blocks/dateselector.md +693 -0
  172. package/content/input-blocks/datetimeselector.md +791 -0
  173. package/content/input-blocks/inputgallery.md +528 -0
  174. package/content/input-blocks/monthselector.md +717 -0
  175. package/content/input-blocks/multipleselector.md +1337 -0
  176. package/content/input-blocks/numberinput.md +855 -0
  177. package/content/input-blocks/pagination.md +679 -0
  178. package/content/input-blocks/paragraphinput.md +1664 -0
  179. package/content/input-blocks/passwordinput.md +480 -0
  180. package/content/input-blocks/phonenumberinput.md +688 -0
  181. package/content/input-blocks/radioselector.md +820 -0
  182. package/content/input-blocks/ratingslider.md +684 -0
  183. package/content/input-blocks/s3uploadbutton.md +384 -0
  184. package/content/input-blocks/s3uploaddragger.md +305 -0
  185. package/content/input-blocks/s3uploadphoto.md +288 -0
  186. package/content/input-blocks/segmentedselector.md +782 -0
  187. package/content/input-blocks/selector.md +1162 -0
  188. package/content/input-blocks/switch.md +552 -0
  189. package/content/input-blocks/textarea.md +714 -0
  190. package/content/input-blocks/textinput.md +639 -0
  191. package/content/input-blocks/tiptapinput.md +226 -0
  192. package/content/input-blocks/tiptapmentioninput.md +471 -0
  193. package/content/input-blocks/titleinput.md +1094 -0
  194. package/content/input-blocks/treeinput.md +144 -0
  195. package/content/input-blocks/treemultipleselector.md +162 -0
  196. package/content/input-blocks/treeselector.md +185 -0
  197. package/content/input-blocks/upload.md +149 -0
  198. package/content/input-blocks/uploaddragger.md +85 -0
  199. package/content/input-blocks/uploadphoto.md +84 -0
  200. package/content/input-blocks/weekselector.md +630 -0
  201. package/content/list-blocks/controlledlist.md +498 -0
  202. package/content/list-blocks/list.md +529 -0
  203. package/content/list-blocks/listselector.md +301 -0
  204. package/content/list-blocks/masonrylist.md +230 -0
  205. package/content/migration/upgrade-guide.md +106 -0
  206. package/content/migration/v4-to-v5.md +589 -0
  207. package/content/migration/v5-to-v6.md +36 -0
  208. package/content/operators/_actions.md +58 -0
  209. package/content/operators/_and.md +76 -0
  210. package/content/operators/_api.md +254 -0
  211. package/content/operators/_app.md +114 -0
  212. package/content/operators/_args.md +65 -0
  213. package/content/operators/_array.md +331 -0
  214. package/content/operators/_base64.md +49 -0
  215. package/content/operators/_boolean.md +33 -0
  216. package/content/operators/_build.md +166 -0
  217. package/content/operators/_change_case.md +357 -0
  218. package/content/operators/_date.md +415 -0
  219. package/content/operators/_dayjs.md +128 -0
  220. package/content/operators/_diff.md +61 -0
  221. package/content/operators/_divide.md +32 -0
  222. package/content/operators/_eq.md +52 -0
  223. package/content/operators/_event.md +86 -0
  224. package/content/operators/_function.md +52 -0
  225. package/content/operators/_get.md +92 -0
  226. package/content/operators/_global.md +86 -0
  227. package/content/operators/_gt.md +50 -0
  228. package/content/operators/_gte.md +50 -0
  229. package/content/operators/_hash.md +112 -0
  230. package/content/operators/_if.md +30 -0
  231. package/content/operators/_if_none.md +47 -0
  232. package/content/operators/_index.md +48 -0
  233. package/content/operators/_input.md +86 -0
  234. package/content/operators/_intl.md +135 -0
  235. package/content/operators/_item.md +166 -0
  236. package/content/operators/_js.md +113 -0
  237. package/content/operators/_json.md +120 -0
  238. package/content/operators/_jsonata.md +152 -0
  239. package/content/operators/_locale.md +65 -0
  240. package/content/operators/_location.md +40 -0
  241. package/content/operators/_log.md +22 -0
  242. package/content/operators/_lt.md +50 -0
  243. package/content/operators/_lte.md +50 -0
  244. package/content/operators/_math.md +407 -0
  245. package/content/operators/_media.md +83 -0
  246. package/content/operators/_menu.md +62 -0
  247. package/content/operators/_module.md +340 -0
  248. package/content/operators/_mql.md +95 -0
  249. package/content/operators/_ne.md +62 -0
  250. package/content/operators/_not.md +33 -0
  251. package/content/operators/_number.md +159 -0
  252. package/content/operators/_nunjucks.md +117 -0
  253. package/content/operators/_object.md +253 -0
  254. package/content/operators/_operator.md +33 -0
  255. package/content/operators/_or.md +67 -0
  256. package/content/operators/_product.md +45 -0
  257. package/content/operators/_random.md +90 -0
  258. package/content/operators/_ref.md +80 -0
  259. package/content/operators/_regex.md +69 -0
  260. package/content/operators/_request.md +35 -0
  261. package/content/operators/_request_details.md +29 -0
  262. package/content/operators/_secret.md +56 -0
  263. package/content/operators/_state.md +134 -0
  264. package/content/operators/_step.md +98 -0
  265. package/content/operators/_string.md +327 -0
  266. package/content/operators/_subtract.md +24 -0
  267. package/content/operators/_sum.md +45 -0
  268. package/content/operators/_switch.md +37 -0
  269. package/content/operators/_t.md +96 -0
  270. package/content/operators/_theme.md +65 -0
  271. package/content/operators/_type.md +78 -0
  272. package/content/operators/_uri.md +49 -0
  273. package/content/operators/_url_query.md +92 -0
  274. package/content/operators/_user.md +154 -0
  275. package/content/operators/_uuid.md +118 -0
  276. package/content/operators/_var.md +88 -0
  277. package/content/operators/_yaml.md +96 -0
  278. package/content/other/introduction.md +39 -0
  279. package/content/other/next-auth-providers.md +3 -0
  280. package/content/other/updatesession.md +26 -0
  281. package/content/plugins/plugins-actions.md +80 -0
  282. package/content/plugins/plugins-connections.md +98 -0
  283. package/content/plugins/plugins-dev.md +138 -0
  284. package/content/plugins/plugins-introduction.md +29 -0
  285. package/content/plugins/plugins-operators.md +71 -0
  286. package/content/testing/e2e-auth.md +108 -0
  287. package/content/testing/e2e-configuration.md +107 -0
  288. package/content/testing/e2e-getting-started.md +96 -0
  289. package/content/testing/e2e-introduction.md +53 -0
  290. package/content/testing/e2e-mocking.md +155 -0
  291. package/content/testing/e2e-writing-tests.md +214 -0
  292. package/content/tutorial/tutorial-actions-operators.md +222 -0
  293. package/content/tutorial/tutorial-add-blocks.md +86 -0
  294. package/content/tutorial/tutorial-create-page.md +57 -0
  295. package/content/tutorial/tutorial-display-data-page.md +181 -0
  296. package/content/tutorial/tutorial-next-steps.md +53 -0
  297. package/content/tutorial/tutorial-requests-sql.md +22 -0
  298. package/content/tutorial/tutorial-start.md +71 -0
  299. package/content/user-authentication/auth-providers.md +15 -0
  300. package/content/user-authentication/login-and-logout.md +122 -0
  301. package/content/user-authentication/users-introduction.md +31 -0
  302. package/index.json +2281 -0
  303. package/package.json +34 -0
  304. package/scripts/extractAgentDocs.js +130 -0
@@ -0,0 +1,1064 @@
1
+ # Sider
2
+
3
+ Sidebar layout container for page navigation.
4
+
5
+ The Sider block provides a sidebar within a Layout. It supports collapsing, themes, breakpoints, and custom widths. Place navigation menus or supplementary content inside the sider.
6
+
7
+ ```yaml
8
+ - id: basic_layout
9
+ type: Layout
10
+ style:
11
+ minHeight: 300px
12
+ blocks:
13
+ - id: basic_sider
14
+ type: Sider
15
+ properties:
16
+ theme: light
17
+ width: 200
18
+ blocks:
19
+ - id: basic_menu
20
+ type: Menu
21
+ properties:
22
+ mode: inline
23
+ theme: light
24
+ links:
25
+ - id: basic_home
26
+ type: MenuLink
27
+ properties:
28
+ title: Home
29
+ icon: AiOutlineHome
30
+ - id: basic_users
31
+ type: MenuLink
32
+ properties:
33
+ title: Users
34
+ icon: AiOutlineUser
35
+ - id: basic_settings
36
+ type: MenuLink
37
+ properties:
38
+ title: Settings
39
+ icon: AiOutlineSetting
40
+ - id: basic_content
41
+ type: Content
42
+ style:
43
+ padding: 24px
44
+ background: var(--ant-color-bg-container)
45
+ blocks:
46
+ - id: basic_content_text
47
+ type: Paragraph
48
+ properties:
49
+ content: The Sider block provides a sidebar within a Layout. It supports
50
+ collapsing, themes, breakpoints, and custom widths. Place
51
+ navigation menus or supplementary content inside the sider.
52
+ ```
53
+
54
+ Setting theme to "dark" gives the sider a dark background with light text. Match the Menu theme to the sider theme for a consistent appearance.
55
+
56
+ ```yaml
57
+ - id: dark_layout
58
+ type: Layout
59
+ style:
60
+ minHeight: 300px
61
+ blocks:
62
+ - id: dark_sider
63
+ type: Sider
64
+ properties:
65
+ theme: dark
66
+ width: 200
67
+ blocks:
68
+ - id: dark_menu
69
+ type: Menu
70
+ properties:
71
+ mode: inline
72
+ theme: dark
73
+ links:
74
+ - id: dark_dashboard
75
+ type: MenuLink
76
+ properties:
77
+ title: Dashboard
78
+ icon: AiOutlineDashboard
79
+ - id: dark_analytics
80
+ type: MenuLink
81
+ properties:
82
+ title: Analytics
83
+ icon: AiOutlineBarChart
84
+ - id: dark_files
85
+ type: MenuLink
86
+ properties:
87
+ title: Files
88
+ icon: AiOutlineFile
89
+ - id: dark_content
90
+ type: Content
91
+ style:
92
+ padding: 24px
93
+ background: var(--ant-color-bg-container)
94
+ blocks:
95
+ - id: dark_content_text
96
+ type: Paragraph
97
+ properties:
98
+ content: Setting theme to "dark" gives the sider a dark background with light
99
+ text. Match the Menu theme to the sider theme for a consistent
100
+ appearance.
101
+ ```
102
+
103
+ With collapsible set to true a collapse trigger appears at the bottom. Toggle between expanded and collapsed states. Menu icons remain visible when collapsed.
104
+
105
+ ```yaml
106
+ - id: collapsible_layout
107
+ type: Layout
108
+ style:
109
+ minHeight: 300px
110
+ blocks:
111
+ - id: collapsible_sider
112
+ type: Sider
113
+ properties:
114
+ theme: light
115
+ width: 220
116
+ collapsible: true
117
+ initialCollapsed: false
118
+ blocks:
119
+ - id: collapsible_menu
120
+ type: Menu
121
+ properties:
122
+ mode: inline
123
+ theme: light
124
+ links:
125
+ - id: col_inbox
126
+ type: MenuLink
127
+ properties:
128
+ title: Inbox
129
+ icon: AiOutlineInbox
130
+ - id: col_starred
131
+ type: MenuLink
132
+ properties:
133
+ title: Starred
134
+ icon: AiOutlineStar
135
+ - id: col_sent
136
+ type: MenuLink
137
+ properties:
138
+ title: Sent
139
+ icon: AiOutlineSend
140
+ - id: collapsible_content
141
+ type: Content
142
+ style:
143
+ padding: 24px
144
+ background: var(--ant-color-bg-container)
145
+ blocks:
146
+ - id: collapsible_content_text
147
+ type: Paragraph
148
+ properties:
149
+ content: With collapsible set to true a collapse trigger appears at the bottom.
150
+ Toggle between expanded and collapsed states. Menu icons remain
151
+ visible when collapsed.
152
+ ```
153
+
154
+ This sider starts collapsed with initialCollapsed set to true. Click the collapse trigger to expand it.
155
+
156
+ ```yaml
157
+ - id: init_collapsed_layout
158
+ type: Layout
159
+ style:
160
+ minHeight: 300px
161
+ blocks:
162
+ - id: init_collapsed_sider
163
+ type: Sider
164
+ properties:
165
+ theme: light
166
+ width: 200
167
+ collapsible: true
168
+ initialCollapsed: true
169
+ blocks:
170
+ - id: init_collapsed_menu
171
+ type: Menu
172
+ properties:
173
+ mode: inline
174
+ theme: light
175
+ links:
176
+ - id: ic_overview
177
+ type: MenuLink
178
+ properties:
179
+ title: Overview
180
+ icon: AiOutlineAppstore
181
+ - id: ic_reports
182
+ type: MenuLink
183
+ properties:
184
+ title: Reports
185
+ icon: AiOutlineFileText
186
+ - id: ic_config
187
+ type: MenuLink
188
+ properties:
189
+ title: Configuration
190
+ icon: AiOutlineTool
191
+ - id: init_collapsed_content
192
+ type: Content
193
+ style:
194
+ padding: 24px
195
+ background: var(--ant-color-bg-container)
196
+ blocks:
197
+ - id: init_collapsed_content_text
198
+ type: Paragraph
199
+ properties:
200
+ content: This sider starts collapsed with initialCollapsed set to true. Click
201
+ the collapse trigger to expand it.
202
+ ```
203
+
204
+ Setting collapsedWidth to 0 completely hides the sider when collapsed and shows a special floating trigger. Useful for mobile-friendly layouts where sidebar space needs to be fully reclaimed.
205
+
206
+ ```yaml
207
+ - id: cw_layout
208
+ type: Layout
209
+ style:
210
+ minHeight: 300px
211
+ blocks:
212
+ - id: cw_sider
213
+ type: Sider
214
+ properties:
215
+ theme: dark
216
+ width: 240
217
+ collapsedWidth: 0
218
+ collapsible: true
219
+ initialCollapsed: true
220
+ blocks:
221
+ - id: cw_menu
222
+ type: Menu
223
+ properties:
224
+ mode: inline
225
+ theme: dark
226
+ links:
227
+ - id: cw_projects
228
+ type: MenuLink
229
+ properties:
230
+ title: Projects
231
+ icon: AiOutlineProject
232
+ - id: cw_tasks
233
+ type: MenuLink
234
+ properties:
235
+ title: Tasks
236
+ icon: AiOutlineCheckSquare
237
+ - id: cw_content
238
+ type: Content
239
+ style:
240
+ padding: 24px
241
+ background: var(--ant-color-bg-container)
242
+ blocks:
243
+ - id: cw_content_text
244
+ type: Paragraph
245
+ properties:
246
+ content: Setting collapsedWidth to 0 completely hides the sider when collapsed
247
+ and shows a special floating trigger. Useful for mobile-friendly
248
+ layouts where sidebar space needs to be fully reclaimed.
249
+ ```
250
+
251
+ The Sider is placed on the right side of the layout with reverseArrow set to true. This flips the collapse arrow direction to match the right-side placement.
252
+
253
+ ```yaml
254
+ - id: reverse_layout
255
+ type: Layout
256
+ style:
257
+ minHeight: 300px
258
+ blocks:
259
+ - id: reverse_content
260
+ type: Content
261
+ style:
262
+ padding: 24px
263
+ background: var(--ant-color-bg-container)
264
+ blocks:
265
+ - id: reverse_content_text
266
+ type: Paragraph
267
+ properties:
268
+ content: The Sider is placed on the right side of the layout with reverseArrow
269
+ set to true. This flips the collapse arrow direction to match the
270
+ right-side placement.
271
+ - id: reverse_sider
272
+ type: Sider
273
+ properties:
274
+ theme: light
275
+ width: 200
276
+ collapsible: true
277
+ initialCollapsed: false
278
+ reverseArrow: true
279
+ style:
280
+ borderLeft: 1px solid
281
+ blocks:
282
+ - id: reverse_menu
283
+ type: Menu
284
+ properties:
285
+ mode: inline
286
+ theme: light
287
+ links:
288
+ - id: rev_details
289
+ type: MenuLink
290
+ properties:
291
+ title: Details
292
+ icon: AiOutlineInfoCircle
293
+ - id: rev_history
294
+ type: MenuLink
295
+ properties:
296
+ title: History
297
+ icon: AiOutlineHistory
298
+ ```
299
+
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
+
302
+ ```yaml
303
+ - id: bp_layout
304
+ type: Layout
305
+ style:
306
+ minHeight: 300px
307
+ blocks:
308
+ - id: bp_sider
309
+ type: Sider
310
+ properties:
311
+ theme: light
312
+ width: 200
313
+ collapsible: true
314
+ initialCollapsed: false
315
+ breakpoint: lg
316
+ events:
317
+ onBreakpoint:
318
+ - id: bp_sider_set_state
319
+ type: SetState
320
+ params:
321
+ breakpointTriggered: true
322
+ blocks:
323
+ - id: bp_menu
324
+ type: Menu
325
+ properties:
326
+ mode: inline
327
+ theme: light
328
+ links:
329
+ - id: bp_home
330
+ type: MenuLink
331
+ properties:
332
+ title: Home
333
+ icon: AiOutlineHome
334
+ - id: bp_search
335
+ type: MenuLink
336
+ properties:
337
+ title: Search
338
+ icon: AiOutlineSearch
339
+ - id: bp_content
340
+ type: Content
341
+ style:
342
+ padding: 24px
343
+ background: var(--ant-color-bg-container)
344
+ blocks:
345
+ - id: bp_content_text
346
+ type: Paragraph
347
+ properties:
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.
352
+ ```
353
+
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.
355
+
356
+ ```yaml
357
+ - id: width_layout
358
+ type: Layout
359
+ style:
360
+ minHeight: 300px
361
+ blocks:
362
+ - id: width_sider
363
+ type: Sider
364
+ properties:
365
+ theme: light
366
+ width: 300
367
+ collapsible: false
368
+ initialCollapsed: false
369
+ blocks:
370
+ - id: width_menu
371
+ type: Menu
372
+ properties:
373
+ mode: inline
374
+ theme: light
375
+ links:
376
+ - id: width_nav1
377
+ type: MenuLink
378
+ properties:
379
+ title: Getting Started
380
+ icon: AiOutlineRocket
381
+ - id: width_nav2
382
+ type: MenuLink
383
+ properties:
384
+ title: Documentation
385
+ icon: AiOutlineBook
386
+ - id: width_nav3
387
+ type: MenuLink
388
+ properties:
389
+ title: API Reference
390
+ icon: AiOutlineCode
391
+ - id: width_content
392
+ type: Content
393
+ style:
394
+ padding: 24px
395
+ background: var(--ant-color-bg-container)
396
+ blocks:
397
+ - id: width_content_text
398
+ type: Paragraph
399
+ properties:
400
+ content: The width property accepts a number (pixels) or string value. Here the
401
+ sider is set to 300px wide, providing more room for longer menu
402
+ labels or nested navigation.
403
+ ```
404
+
405
+ The Sider fires onOpen and onClose events when it expands or collapses. Use these events with SetState or other actions to react to sider state changes. Toggle the sider to see the state update above.
406
+
407
+ ```yaml
408
+ - id: events_layout
409
+ type: Layout
410
+ style:
411
+ minHeight: 300px
412
+ blocks:
413
+ - id: events_sider
414
+ type: Sider
415
+ properties:
416
+ theme: light
417
+ width: 200
418
+ collapsible: true
419
+ initialCollapsed: false
420
+ events:
421
+ onOpen:
422
+ - id: events_on_open_action
423
+ type: SetState
424
+ params:
425
+ siderState: open
426
+ onClose:
427
+ - id: events_on_close_action
428
+ type: SetState
429
+ params:
430
+ siderState: closed
431
+ blocks:
432
+ - id: events_menu
433
+ type: Menu
434
+ properties:
435
+ mode: inline
436
+ theme: light
437
+ links:
438
+ - id: events_nav_home
439
+ type: MenuLink
440
+ properties:
441
+ title: Home
442
+ icon: AiOutlineHome
443
+ - id: events_nav_alerts
444
+ type: MenuLink
445
+ properties:
446
+ title: Alerts
447
+ icon: AiOutlineBell
448
+ - id: events_content
449
+ type: Content
450
+ style:
451
+ padding: 24px
452
+ background: var(--ant-color-bg-container)
453
+ blocks:
454
+ - id: events_state_label
455
+ type: Paragraph
456
+ properties:
457
+ content:
458
+ _nunjucks:
459
+ template: "Sider state: {{ siderState }}"
460
+ on:
461
+ _state: true
462
+ - id: events_content_text
463
+ type: Paragraph
464
+ properties:
465
+ content: The Sider fires onOpen and onClose events when it expands or collapses.
466
+ Use these events with SetState or other actions to react to sider
467
+ state changes. Toggle the sider to see the state update above.
468
+ ```
469
+
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.
473
+
474
+ ```yaml
475
+ - id: token_layout
476
+ type: Layout
477
+ style:
478
+ minHeight: 300px
479
+ blocks:
480
+ - id: token_sider
481
+ type: Sider
482
+ properties:
483
+ theme: light
484
+ width: 220
485
+ collapsible: true
486
+ initialCollapsed: false
487
+ designTokens:
488
+ colorPrimary: "#722ed1"
489
+ colorText: "#531dab"
490
+ blocks:
491
+ - id: token_menu
492
+ type: Menu
493
+ properties:
494
+ mode: inline
495
+ theme: light
496
+ links:
497
+ - id: token_nav_explore
498
+ type: MenuLink
499
+ properties:
500
+ title: Explore
501
+ icon: AiOutlineCompass
502
+ - id: token_nav_favorites
503
+ type: MenuLink
504
+ properties:
505
+ title: Favorites
506
+ icon: AiOutlineHeart
507
+ - id: token_nav_settings
508
+ type: MenuLink
509
+ properties:
510
+ title: Settings
511
+ icon: AiOutlineSetting
512
+ - id: token_content
513
+ type: Content
514
+ style:
515
+ padding: 24px
516
+ background: var(--ant-color-bg-container)
517
+ blocks:
518
+ - id: token_content_text
519
+ type: Paragraph
520
+ properties:
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.
574
+ ```
575
+
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.
577
+
578
+ A shadow-lg class on the element CSS key gives the sider an elevated appearance that visually separates it from the main content area.
579
+
580
+ ```yaml
581
+ - id: css_layout
582
+ type: Layout
583
+ style:
584
+ minHeight: 300px
585
+ blocks:
586
+ - id: css_sider
587
+ type: Sider
588
+ properties:
589
+ theme: light
590
+ width: 220
591
+ collapsible: false
592
+ initialCollapsed: false
593
+ class:
594
+ element: bg-gradient-to-b from-primary/10 to-bg-container border-r border-border
595
+ blocks:
596
+ - id: css_menu
597
+ type: Menu
598
+ properties:
599
+ mode: inline
600
+ theme: light
601
+ links:
602
+ - id: css_nav_workspace
603
+ type: MenuLink
604
+ properties:
605
+ title: Workspace
606
+ icon: AiOutlineAppstore
607
+ - id: css_nav_members
608
+ type: MenuLink
609
+ properties:
610
+ title: Members
611
+ icon: AiOutlineTeam
612
+ - id: css_nav_billing
613
+ type: MenuLink
614
+ properties:
615
+ title: Billing
616
+ icon: AiOutlineCreditCard
617
+ - id: css_content
618
+ type: Content
619
+ style:
620
+ padding: 24px
621
+ background: var(--ant-color-bg-container)
622
+ blocks:
623
+ - id: css_content_text
624
+ type: Paragraph
625
+ properties:
626
+ content: The Sider has a single CSS key called "element" which targets the
627
+ entire sider container. Use it with Tailwind classes for
628
+ gradients, borders, shadows, and other visual effects.
629
+ - id: css_shadow_layout
630
+ type: Layout
631
+ style:
632
+ minHeight: 300px
633
+ blocks:
634
+ - id: css_shadow_sider
635
+ type: Sider
636
+ properties:
637
+ theme: light
638
+ width: 200
639
+ collapsible: false
640
+ initialCollapsed: false
641
+ class:
642
+ element: shadow-lg bg-bg-container
643
+ blocks:
644
+ - id: css_shadow_menu
645
+ type: Menu
646
+ properties:
647
+ mode: inline
648
+ theme: light
649
+ links:
650
+ - id: css_sh_dashboard
651
+ type: MenuLink
652
+ properties:
653
+ title: Dashboard
654
+ icon: AiOutlineDashboard
655
+ - id: css_sh_analytics
656
+ type: MenuLink
657
+ properties:
658
+ title: Analytics
659
+ icon: AiOutlineLineChart
660
+ - id: css_shadow_content
661
+ type: Content
662
+ style:
663
+ padding: 24px
664
+ background: var(--ant-color-bg-container)
665
+ blocks:
666
+ - id: css_shadow_content_text
667
+ type: Paragraph
668
+ properties:
669
+ content: A shadow-lg class on the element CSS key gives the sider an elevated
670
+ appearance that visually separates it from the main content area.
671
+ ```
672
+
673
+ Admin
674
+
675
+ Dashboard
676
+
677
+ ```yaml
678
+ - id: admin_layout
679
+ type: Layout
680
+ style:
681
+ minHeight: 400px
682
+ blocks:
683
+ - id: admin_sider
684
+ type: Sider
685
+ properties:
686
+ theme: dark
687
+ width: 240
688
+ collapsible: true
689
+ initialCollapsed: false
690
+ events:
691
+ onClose:
692
+ - id: admin_on_close
693
+ type: SetState
694
+ params:
695
+ adminSiderOpen: false
696
+ onOpen:
697
+ - id: admin_on_open
698
+ type: SetState
699
+ params:
700
+ adminSiderOpen: true
701
+ blocks:
702
+ - id: admin_logo_box
703
+ type: Box
704
+ style:
705
+ padding: 16px
706
+ textAlign: center
707
+ blocks:
708
+ - id: admin_logo_title
709
+ type: Title
710
+ class: text-white
711
+ properties:
712
+ content: Admin
713
+ level: 4
714
+ - id: admin_menu
715
+ type: Menu
716
+ properties:
717
+ mode: inline
718
+ theme: dark
719
+ links:
720
+ - id: admin_nav_dashboard
721
+ type: MenuLink
722
+ properties:
723
+ title: Dashboard
724
+ icon: AiOutlineDashboard
725
+ - id: admin_nav_users
726
+ type: MenuGroup
727
+ properties:
728
+ title: User Management
729
+ icon: AiOutlineTeam
730
+ links:
731
+ - id: admin_nav_all_users
732
+ type: MenuLink
733
+ properties:
734
+ title: All Users
735
+ - id: admin_nav_roles
736
+ type: MenuLink
737
+ properties:
738
+ title: Roles
739
+ - id: admin_nav_content
740
+ type: MenuGroup
741
+ properties:
742
+ title: Content
743
+ icon: AiOutlineFileText
744
+ links:
745
+ - id: admin_nav_pages
746
+ type: MenuLink
747
+ properties:
748
+ title: Pages
749
+ - id: admin_nav_media
750
+ type: MenuLink
751
+ properties:
752
+ title: Media
753
+ - id: admin_nav_settings
754
+ type: MenuLink
755
+ properties:
756
+ title: Settings
757
+ icon: AiOutlineSetting
758
+ - id: admin_content
759
+ type: Content
760
+ style:
761
+ padding: 24px
762
+ background: var(--ant-color-bg-layout)
763
+ blocks:
764
+ - id: admin_header_row
765
+ type: Box
766
+ layout:
767
+ gap: 16
768
+ justify: space-between
769
+ align: center
770
+ blocks:
771
+ - id: admin_page_title
772
+ type: Title
773
+ layout:
774
+ flex: 0 0 auto
775
+ properties:
776
+ content: Dashboard
777
+ level: 3
778
+ - id: admin_header_actions
779
+ type: Box
780
+ layout:
781
+ flex: 0 0 auto
782
+ gap: 8
783
+ blocks:
784
+ - id: admin_notif_btn
785
+ type: Button
786
+ layout:
787
+ flex: 0 0 auto
788
+ properties:
789
+ icon: AiOutlineBell
790
+ color: default
791
+ variant: text
792
+ hideTitle: true
793
+ - id: admin_profile_btn
794
+ type: Button
795
+ layout:
796
+ flex: 0 0 auto
797
+ properties:
798
+ icon: AiOutlineUser
799
+ color: default
800
+ variant: text
801
+ hideTitle: true
802
+ - id: admin_stats_row
803
+ type: Box
804
+ layout:
805
+ gap: 16
806
+ blocks:
807
+ - id: admin_stat_users
808
+ type: Card
809
+ layout:
810
+ flex: 1 1 0
811
+ properties:
812
+ size: small
813
+ blocks:
814
+ - id: admin_stat_users_val
815
+ type: Statistic
816
+ properties:
817
+ title: Total Users
818
+ value: 2847
819
+ - id: admin_stat_revenue
820
+ type: Card
821
+ layout:
822
+ flex: 1 1 0
823
+ properties:
824
+ size: small
825
+ blocks:
826
+ - id: admin_stat_revenue_val
827
+ type: Statistic
828
+ properties:
829
+ title: Revenue
830
+ value: 48200
831
+ prefix: $
832
+ - id: admin_stat_orders
833
+ type: Card
834
+ layout:
835
+ flex: 1 1 0
836
+ properties:
837
+ size: small
838
+ blocks:
839
+ - id: admin_stat_orders_val
840
+ type: Statistic
841
+ properties:
842
+ title: Orders
843
+ value: 384
844
+ ```
845
+
846
+ Settings
847
+
848
+ Profile Settings
849
+
850
+ Manage your personal information and preferences.
851
+
852
+ ```yaml
853
+ - id: settings_layout
854
+ type: Layout
855
+ style:
856
+ minHeight: 400px
857
+ blocks:
858
+ - id: settings_sider
859
+ type: Sider
860
+ properties:
861
+ theme: light
862
+ width: 220
863
+ collapsible: false
864
+ initialCollapsed: false
865
+ style:
866
+ borderRight: 1px solid
867
+ blocks:
868
+ - id: settings_heading
869
+ type: Title
870
+ style:
871
+ padding: 16px 16px 8px
872
+ properties:
873
+ content: Settings
874
+ level: 5
875
+ - id: settings_menu
876
+ type: Menu
877
+ properties:
878
+ mode: inline
879
+ theme: light
880
+ links:
881
+ - id: settings_nav_profile
882
+ type: MenuLink
883
+ properties:
884
+ title: Profile
885
+ icon: AiOutlineUser
886
+ - id: settings_nav_account
887
+ type: MenuLink
888
+ properties:
889
+ title: Account
890
+ icon: AiOutlineSafety
891
+ - id: settings_nav_notifications
892
+ type: MenuLink
893
+ properties:
894
+ title: Notifications
895
+ icon: AiOutlineBell
896
+ - id: settings_nav_appearance
897
+ type: MenuLink
898
+ properties:
899
+ title: Appearance
900
+ icon: AiOutlineBgColors
901
+ - id: settings_nav_integrations
902
+ type: MenuLink
903
+ properties:
904
+ title: Integrations
905
+ icon: AiOutlineApi
906
+ - id: settings_content
907
+ type: Content
908
+ style:
909
+ padding: 24px
910
+ background: var(--ant-color-bg-container)
911
+ blocks:
912
+ - id: settings_content_title
913
+ type: Title
914
+ properties:
915
+ content: Profile Settings
916
+ level: 4
917
+ - id: settings_content_desc
918
+ type: Paragraph
919
+ properties:
920
+ content: Manage your personal information and preferences.
921
+ - id: settings_divider
922
+ type: Divider
923
+ - id: settings_form_name
924
+ type: TextInput
925
+ properties:
926
+ title: Display Name
927
+ placeholder: Enter your name
928
+ - id: settings_form_email
929
+ type: TextInput
930
+ properties:
931
+ title: Email Address
932
+ placeholder: you@example.com
933
+ - id: settings_form_bio
934
+ type: TextArea
935
+ properties:
936
+ title: Bio
937
+ placeholder: Tell us about yourself
938
+ - id: settings_form_save
939
+ type: Button
940
+ properties:
941
+ title: Save Changes
942
+ color: primary
943
+ variant: solid
944
+ icon: AiOutlineSave
945
+ ```
946
+
947
+ Introduction
948
+
949
+ Welcome to the documentation. This page gives an overview of the framework and how to get started building your first application.
950
+
951
+ Use the sidebar on the left to browse through different sections. On smaller screens the sidebar collapses automatically thanks to the breakpoint property set to "md".
952
+
953
+ ```yaml
954
+ - id: docs_layout
955
+ type: Layout
956
+ style:
957
+ minHeight: 400px
958
+ blocks:
959
+ - id: docs_sider
960
+ type: Sider
961
+ properties:
962
+ theme: light
963
+ width: 260
964
+ collapsible: true
965
+ initialCollapsed: false
966
+ breakpoint: md
967
+ class:
968
+ element: border-r border-border
969
+ blocks:
970
+ - id: docs_search
971
+ type: TextInput
972
+ style:
973
+ padding: 12px 16px
974
+ properties:
975
+ placeholder: Search docs...
976
+ prefixIcon: AiOutlineSearch
977
+ - id: docs_menu
978
+ type: Menu
979
+ properties:
980
+ mode: inline
981
+ theme: light
982
+ links:
983
+ - id: docs_nav_getting_started
984
+ type: MenuGroup
985
+ properties:
986
+ title: Getting Started
987
+ links:
988
+ - id: docs_nav_intro
989
+ type: MenuLink
990
+ properties:
991
+ title: Introduction
992
+ - id: docs_nav_install
993
+ type: MenuLink
994
+ properties:
995
+ title: Installation
996
+ - id: docs_nav_quickstart
997
+ type: MenuLink
998
+ properties:
999
+ title: Quick Start
1000
+ - id: docs_nav_guides
1001
+ type: MenuGroup
1002
+ properties:
1003
+ title: Guides
1004
+ links:
1005
+ - id: docs_nav_blocks
1006
+ type: MenuLink
1007
+ properties:
1008
+ title: Blocks
1009
+ - id: docs_nav_operators
1010
+ type: MenuLink
1011
+ properties:
1012
+ title: Operators
1013
+ - id: docs_nav_actions
1014
+ type: MenuLink
1015
+ properties:
1016
+ title: Actions
1017
+ - id: docs_content
1018
+ type: Content
1019
+ style:
1020
+ padding: 32px
1021
+ background: var(--ant-color-bg-container)
1022
+ blocks:
1023
+ - id: docs_content_title
1024
+ type: Title
1025
+ properties:
1026
+ content: Introduction
1027
+ level: 3
1028
+ - id: docs_content_p1
1029
+ type: Paragraph
1030
+ properties:
1031
+ content: Welcome to the documentation. This page gives an overview of the
1032
+ framework and how to get started building your first application.
1033
+ - id: docs_content_p2
1034
+ type: Paragraph
1035
+ properties:
1036
+ content: Use the sidebar on the left to browse through different sections. On
1037
+ smaller screens the sidebar collapses automatically thanks to the
1038
+ breakpoint property set to "md".
1039
+ ```
1040
+
1041
+ | Property | Type | Default | Description |
1042
+ | --- | --- | --- | --- |
1043
+ | `breakpoint` | string | `"sm"` | Breakpoint of the responsive layout Enum: `xs`, `sm`, `md`, `lg`, `xl`, `xxl`. |
1044
+ | `collapsedWidth` | integer | - | Width of the collapsed sidebar, by setting to 0 a special trigger will appear |
1045
+ | `collapsible` | boolean | - | Whether can be collapsed |
1046
+ | `initialCollapsed` | boolean | `true` | Set the initial collapsed state |
1047
+ | `reverseArrow` | boolean | `false` | Direction of arrow, for a sider that expands from the right |
1048
+ | `width` | string \| number | - | width of the sidebar |
1049
+ | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). |
1050
+
1051
+ | Event | Event Data | Description |
1052
+ | --- | --- | --- |
1053
+ | `onClose` | \- | Trigger actions when sider is closed. |
1054
+ | `onOpen` | \- | Trigger actions when sider is opened. |
1055
+ | `onBreakpoint` | \- | Trigger actions on breakpoint change. |
1056
+
1057
+ | Key | Target |
1058
+ | --- | --- |
1059
+ | `/block` | Outer block wrapper (always available). |
1060
+ | `/element` | The Sider element. |
1061
+
1062
+ | Slot | Description |
1063
+ | --- | --- |
1064
+ | `content` | Child blocks in the sider panel. |