@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,1123 @@
1
+ # Menu
2
+
3
+ Horizontal or vertical navigation menu with nested items.
4
+
5
+ ```yaml
6
+ - id: mode_horizontal
7
+ type: Menu
8
+ properties:
9
+ mode: horizontal
10
+ links:
11
+ - id: mh_home
12
+ type: MenuLink
13
+ properties:
14
+ title: Home
15
+ icon: AiOutlineHome
16
+ - id: mh_about
17
+ type: MenuLink
18
+ properties:
19
+ title: About
20
+ - id: mh_services
21
+ type: MenuGroup
22
+ properties:
23
+ title: Services
24
+ links:
25
+ - id: mh_consulting
26
+ type: MenuLink
27
+ properties:
28
+ title: Consulting
29
+ - id: mh_development
30
+ type: MenuLink
31
+ properties:
32
+ title: Development
33
+ - id: mh_contact
34
+ type: MenuLink
35
+ properties:
36
+ title: Contact
37
+ - id: mode_vertical
38
+ type: Menu
39
+ style:
40
+ width: 256
41
+ properties:
42
+ mode: vertical
43
+ links:
44
+ - id: mv_dashboard
45
+ type: MenuLink
46
+ properties:
47
+ title: Dashboard
48
+ icon: AiOutlineHome
49
+ - id: mv_users
50
+ type: MenuLink
51
+ properties:
52
+ title: Users
53
+ icon: AiOutlineUser
54
+ - id: mv_settings
55
+ type: MenuGroup
56
+ properties:
57
+ title: Settings
58
+ icon: AiOutlineSetting
59
+ links:
60
+ - id: mv_profile
61
+ type: MenuLink
62
+ properties:
63
+ title: Profile
64
+ - id: mv_security
65
+ type: MenuLink
66
+ properties:
67
+ title: Security
68
+ - id: mode_inline
69
+ type: Menu
70
+ style:
71
+ width: 256
72
+ properties:
73
+ mode: inline
74
+ defaultOpenKeys:
75
+ - mi_navigation
76
+ links:
77
+ - id: mi_navigation
78
+ type: MenuGroup
79
+ properties:
80
+ title: Navigation
81
+ icon: AiOutlineAppstore
82
+ links:
83
+ - id: mi_option1
84
+ type: MenuLink
85
+ properties:
86
+ title: Option 1
87
+ - id: mi_option2
88
+ type: MenuLink
89
+ properties:
90
+ title: Option 2
91
+ - id: mi_tools
92
+ type: MenuGroup
93
+ properties:
94
+ title: Tools
95
+ icon: AiOutlineTool
96
+ links:
97
+ - id: mi_option3
98
+ type: MenuLink
99
+ properties:
100
+ title: Option 3
101
+ - id: mi_option4
102
+ type: MenuLink
103
+ properties:
104
+ title: Option 4
105
+ ```
106
+
107
+ ```yaml
108
+ - id: lt_icons_menu
109
+ type: Menu
110
+ style:
111
+ width: 256
112
+ properties:
113
+ mode: vertical
114
+ links:
115
+ - id: lt_mail
116
+ type: MenuLink
117
+ properties:
118
+ title: Mail
119
+ icon: AiOutlineMail
120
+ - id: lt_calendar
121
+ type: MenuLink
122
+ properties:
123
+ title: Calendar
124
+ icon: AiOutlineCalendar
125
+ - id: lt_settings
126
+ type: MenuLink
127
+ properties:
128
+ title: Settings
129
+ icon: AiOutlineSetting
130
+ - id: lt_dividers_menu
131
+ type: Menu
132
+ style:
133
+ width: 256
134
+ properties:
135
+ mode: vertical
136
+ links:
137
+ - id: lt_general
138
+ type: MenuLink
139
+ properties:
140
+ title: General
141
+ icon: AiOutlineSetting
142
+ - id: lt_profile
143
+ type: MenuLink
144
+ properties:
145
+ title: Profile
146
+ icon: AiOutlineUser
147
+ - id: lt_solid_divider
148
+ type: MenuDivider
149
+ - id: lt_files
150
+ type: MenuLink
151
+ properties:
152
+ title: Files
153
+ icon: AiOutlineFile
154
+ - id: lt_dashed_divider
155
+ type: MenuDivider
156
+ properties:
157
+ dashed: true
158
+ - id: lt_logout
159
+ type: MenuLink
160
+ properties:
161
+ title: Logout
162
+ icon: AiOutlineLogout
163
+ - id: lt_nested_menu
164
+ type: Menu
165
+ style:
166
+ width: 256
167
+ properties:
168
+ mode: inline
169
+ defaultOpenKeys:
170
+ - lt_parent
171
+ links:
172
+ - id: lt_parent
173
+ type: MenuGroup
174
+ properties:
175
+ title: Navigation
176
+ icon: AiOutlineAppstore
177
+ links:
178
+ - id: lt_child_group
179
+ type: MenuGroup
180
+ properties:
181
+ title: Sub Group
182
+ links:
183
+ - id: lt_sub1
184
+ type: MenuLink
185
+ properties:
186
+ title: Sub Item 1
187
+ - id: lt_sub2
188
+ type: MenuLink
189
+ properties:
190
+ title: Sub Item 2
191
+ - id: lt_direct
192
+ type: MenuLink
193
+ properties:
194
+ title: Direct Item
195
+ - id: lt_danger_menu
196
+ type: Menu
197
+ style:
198
+ width: 256
199
+ properties:
200
+ mode: vertical
201
+ links:
202
+ - id: lt_edit
203
+ type: MenuLink
204
+ properties:
205
+ title: Edit
206
+ icon: AiOutlineEdit
207
+ - id: lt_copy
208
+ type: MenuLink
209
+ properties:
210
+ title: Copy
211
+ icon: AiOutlineCopy
212
+ - id: lt_danger_divider
213
+ type: MenuDivider
214
+ - id: lt_delete
215
+ type: MenuLink
216
+ properties:
217
+ title: Delete
218
+ icon: AiOutlineDelete
219
+ danger: true
220
+ ```
221
+
222
+ ```yaml
223
+ - id: sk_menu
224
+ type: Menu
225
+ properties:
226
+ mode: horizontal
227
+ selectedKeys:
228
+ - sk_active
229
+ links:
230
+ - id: sk_home
231
+ type: MenuLink
232
+ properties:
233
+ title: Home
234
+ - id: sk_active
235
+ type: MenuLink
236
+ properties:
237
+ title: Active Page
238
+ - id: sk_other
239
+ type: MenuLink
240
+ properties:
241
+ title: Other
242
+ - id: dok_menu
243
+ type: Menu
244
+ style:
245
+ width: 256
246
+ properties:
247
+ mode: inline
248
+ defaultOpenKeys:
249
+ - dok_group1
250
+ - dok_group2
251
+ links:
252
+ - id: dok_group1
253
+ type: MenuGroup
254
+ properties:
255
+ title: Group 1
256
+ icon: AiOutlineFolder
257
+ links:
258
+ - id: dok_item1
259
+ type: MenuLink
260
+ properties:
261
+ title: Item 1
262
+ - id: dok_item2
263
+ type: MenuLink
264
+ properties:
265
+ title: Item 2
266
+ - id: dok_group2
267
+ type: MenuGroup
268
+ properties:
269
+ title: Group 2
270
+ icon: AiOutlineFolderOpen
271
+ links:
272
+ - id: dok_item3
273
+ type: MenuLink
274
+ properties:
275
+ title: Item 3
276
+ - id: sk_multiple_menu
277
+ type: Menu
278
+ style:
279
+ width: 256
280
+ properties:
281
+ mode: vertical
282
+ selectedKeys:
283
+ - sk_multi_b
284
+ links:
285
+ - id: sk_multi_a
286
+ type: MenuLink
287
+ properties:
288
+ title: Dashboard
289
+ icon: AiOutlineHome
290
+ - id: sk_multi_b
291
+ type: MenuLink
292
+ properties:
293
+ title: Reports
294
+ icon: AiOutlineBarChart
295
+ - id: sk_multi_c
296
+ type: MenuLink
297
+ properties:
298
+ title: Settings
299
+ icon: AiOutlineSetting
300
+ ```
301
+
302
+ ```yaml
303
+ - id: io_collapsed_menu
304
+ type: Menu
305
+ style:
306
+ width: 80
307
+ properties:
308
+ mode: inline
309
+ collapsed: true
310
+ links:
311
+ - id: io_home
312
+ type: MenuLink
313
+ properties:
314
+ title: Home
315
+ icon: AiOutlineHome
316
+ - id: io_users
317
+ type: MenuLink
318
+ properties:
319
+ title: Users
320
+ icon: AiOutlineUser
321
+ - id: io_settings
322
+ type: MenuLink
323
+ properties:
324
+ title: Settings
325
+ icon: AiOutlineSetting
326
+ - id: io_indent_menu
327
+ type: Menu
328
+ style:
329
+ width: 280
330
+ properties:
331
+ mode: inline
332
+ inlineIndent: 40
333
+ defaultOpenKeys:
334
+ - io_ind_group
335
+ links:
336
+ - id: io_ind_group
337
+ type: MenuGroup
338
+ properties:
339
+ title: Deep Indent
340
+ icon: AiOutlineMenuFold
341
+ links:
342
+ - id: io_ind_a
343
+ type: MenuLink
344
+ properties:
345
+ title: Indented Item A
346
+ - id: io_ind_b
347
+ type: MenuLink
348
+ properties:
349
+ title: Indented Item B
350
+ - id: io_expand_icon_menu
351
+ type: Menu
352
+ style:
353
+ width: 256
354
+ properties:
355
+ mode: inline
356
+ expandIcon: AiOutlineRight
357
+ defaultOpenKeys:
358
+ - io_exp_group
359
+ links:
360
+ - id: io_exp_group
361
+ type: MenuGroup
362
+ properties:
363
+ title: Custom Expand Icon
364
+ icon: AiOutlineAppstore
365
+ links:
366
+ - id: io_exp_a
367
+ type: MenuLink
368
+ properties:
369
+ title: Sub Item A
370
+ - id: io_exp_b
371
+ type: MenuLink
372
+ properties:
373
+ title: Sub Item B
374
+ ```
375
+
376
+ ```yaml
377
+ - id: sd_fast_menu
378
+ type: Menu
379
+ style:
380
+ width: 256
381
+ properties:
382
+ mode: vertical
383
+ subMenuOpenDelay: 0
384
+ subMenuCloseDelay: 0
385
+ links:
386
+ - id: sd_fast_group
387
+ type: MenuGroup
388
+ properties:
389
+ title: Instant Open
390
+ icon: AiOutlineThunderbolt
391
+ links:
392
+ - id: sd_fast_a
393
+ type: MenuLink
394
+ properties:
395
+ title: No Delay Open
396
+ - id: sd_fast_b
397
+ type: MenuLink
398
+ properties:
399
+ title: No Delay Close
400
+ - id: sd_slow_menu
401
+ type: Menu
402
+ style:
403
+ width: 256
404
+ properties:
405
+ mode: vertical
406
+ subMenuOpenDelay: 0.5
407
+ subMenuCloseDelay: 1
408
+ links:
409
+ - id: sd_slow_group
410
+ type: MenuGroup
411
+ properties:
412
+ title: Slow Submenu
413
+ icon: AiOutlineClockCircle
414
+ links:
415
+ - id: sd_slow_a
416
+ type: MenuLink
417
+ properties:
418
+ title: 0.5s Open Delay
419
+ - id: sd_slow_b
420
+ type: MenuLink
421
+ properties:
422
+ title: 1s Close Delay
423
+ - id: sd_force_render_menu
424
+ type: Menu
425
+ style:
426
+ width: 256
427
+ properties:
428
+ mode: vertical
429
+ forceSubMenuRender: true
430
+ links:
431
+ - id: sd_force_group
432
+ type: MenuGroup
433
+ properties:
434
+ title: Pre-rendered Submenu
435
+ icon: AiOutlineSync
436
+ links:
437
+ - id: sd_force_a
438
+ type: MenuLink
439
+ properties:
440
+ title: Already in DOM
441
+ - id: sd_force_b
442
+ type: MenuLink
443
+ properties:
444
+ title: Before Visible
445
+ ```
446
+
447
+ ```yaml
448
+ - id: css_tailwind_menu
449
+ type: Menu
450
+ class: shadow-md rounded-lg
451
+ style:
452
+ width: 256
453
+ properties:
454
+ mode: vertical
455
+ links:
456
+ - id: css_tw_home
457
+ type: MenuLink
458
+ properties:
459
+ title: Home
460
+ icon: AiOutlineHome
461
+ - id: css_tw_reports
462
+ type: MenuLink
463
+ properties:
464
+ title: Reports
465
+ icon: AiOutlineBarChart
466
+ - id: css_tw_settings
467
+ type: MenuLink
468
+ properties:
469
+ title: Settings
470
+ icon: AiOutlineSetting
471
+ - id: css_inline_menu
472
+ type: Menu
473
+ style:
474
+ width: 256
475
+ border: 1px solid
476
+ borderRadius: 8
477
+ padding: 4
478
+ properties:
479
+ mode: vertical
480
+ links:
481
+ - id: css_in_dashboard
482
+ type: MenuLink
483
+ properties:
484
+ title: Dashboard
485
+ icon: AiOutlineDashboard
486
+ - id: css_in_analytics
487
+ type: MenuLink
488
+ properties:
489
+ title: Analytics
490
+ icon: AiOutlineLineChart
491
+ - id: css_dark_bg
492
+ type: Box
493
+ class: bg-gradient-to-b from-slate-900 to-slate-800 p-4 rounded-lg
494
+ blocks:
495
+ - id: css_dark_menu
496
+ type: Menu
497
+ properties:
498
+ mode: horizontal
499
+ theme: dark
500
+ links:
501
+ - id: css_dk_home
502
+ type: MenuLink
503
+ properties:
504
+ title: Home
505
+ icon: AiOutlineHome
506
+ - id: css_dk_explore
507
+ type: MenuLink
508
+ properties:
509
+ title: Explore
510
+ icon: AiOutlineCompass
511
+ - id: css_dk_profile
512
+ type: MenuLink
513
+ properties:
514
+ title: Profile
515
+ icon: AiOutlineUser
516
+ - id: css_link_style_menu
517
+ type: Menu
518
+ style:
519
+ width: 256
520
+ properties:
521
+ mode: vertical
522
+ links:
523
+ - id: css_ls_normal
524
+ type: MenuLink
525
+ properties:
526
+ title: Normal Item
527
+ - id: css_ls_styled
528
+ type: MenuLink
529
+ style:
530
+ fontWeight: bold
531
+ fontStyle: italic
532
+ properties:
533
+ title: Bold Italic Item
534
+ - id: css_ls_colored
535
+ type: MenuLink
536
+ style:
537
+ color: "#1677ff"
538
+ properties:
539
+ title: Blue Text Item
540
+ ```
541
+
542
+ ```yaml
543
+ - id: tt_colors_menu
544
+ type: Menu
545
+ properties:
546
+ mode: horizontal
547
+ theme:
548
+ itemSelectedColor: "#722ed1"
549
+ horizontalItemSelectedColor: "#722ed1"
550
+ itemHoverColor: "#9254de"
551
+ horizontalItemHoverColor: "#9254de"
552
+ selectedKeys:
553
+ - tt_active
554
+ links:
555
+ - id: tt_home
556
+ type: MenuLink
557
+ properties:
558
+ title: Home
559
+ icon: AiOutlineHome
560
+ - id: tt_active
561
+ type: MenuLink
562
+ properties:
563
+ title: Active
564
+ icon: AiOutlineStar
565
+ - id: tt_settings
566
+ type: MenuLink
567
+ properties:
568
+ title: Settings
569
+ icon: AiOutlineSetting
570
+ - id: tt_sizing_menu
571
+ type: Menu
572
+ style:
573
+ width: 280
574
+ properties:
575
+ mode: vertical
576
+ theme:
577
+ itemHeight: 50
578
+ iconSize: 18
579
+ itemBorderRadius: 12
580
+ itemPaddingInline: 24
581
+ fontSize: 16
582
+ links:
583
+ - id: tt_sz_home
584
+ type: MenuLink
585
+ properties:
586
+ title: Dashboard
587
+ icon: AiOutlineHome
588
+ - id: tt_sz_reports
589
+ type: MenuLink
590
+ properties:
591
+ title: Reports
592
+ icon: AiOutlineBarChart
593
+ - id: tt_sz_settings
594
+ type: MenuLink
595
+ properties:
596
+ title: Settings
597
+ icon: AiOutlineSetting
598
+ - id: tt_dark_custom_menu
599
+ type: Menu
600
+ style:
601
+ width: 256
602
+ properties:
603
+ mode: vertical
604
+ theme:
605
+ itemBg: "#1a1a2e"
606
+ itemColor: "#e0e0e0"
607
+ itemHoverBg: "#16213e"
608
+ itemHoverColor: "#00d4ff"
609
+ itemSelectedBg: "#0f3460"
610
+ itemSelectedColor: "#00d4ff"
611
+ selectedKeys:
612
+ - tt_dc_analytics
613
+ links:
614
+ - id: tt_dc_home
615
+ type: MenuLink
616
+ properties:
617
+ title: Home
618
+ icon: AiOutlineHome
619
+ - id: tt_dc_analytics
620
+ type: MenuLink
621
+ properties:
622
+ title: Analytics
623
+ icon: AiOutlineLineChart
624
+ - id: tt_dc_team
625
+ type: MenuLink
626
+ properties:
627
+ title: Team
628
+ icon: AiOutlineTeam
629
+ - id: tt_danger_menu
630
+ type: Menu
631
+ style:
632
+ width: 256
633
+ properties:
634
+ mode: vertical
635
+ theme:
636
+ dangerItemColor: "#cf1322"
637
+ dangerItemHoverColor: "#ff4d4f"
638
+ dangerItemSelectedColor: "#fff"
639
+ dangerItemSelectedBg: "#ff4d4f"
640
+ links:
641
+ - id: tt_dg_files
642
+ type: MenuLink
643
+ properties:
644
+ title: My Files
645
+ icon: AiOutlineFile
646
+ - id: tt_dg_divider
647
+ type: MenuDivider
648
+ - id: tt_dg_delete
649
+ type: MenuLink
650
+ properties:
651
+ title: Delete Account
652
+ icon: AiOutlineDelete
653
+ danger: true
654
+ ```
655
+
656
+ Admin Panel
657
+
658
+ Manage your blog posts here. Use the sidebar to navigate between sections.
659
+
660
+ **Recent Activity:**
661
+ - 3 new posts published this week
662
+ - 12 comments pending review
663
+ - 2 pages updated
664
+
665
+ ```yaml
666
+ - id: admin_layout
667
+ type: Box
668
+ layout:
669
+ direction: row
670
+ gap: 0
671
+ blocks:
672
+ - id: admin_sidebar
673
+ type: Box
674
+ layout:
675
+ flex: 0 0 256px
676
+ blocks:
677
+ - id: admin_logo
678
+ type: Markdown
679
+ class: px-4 py-3 font-bold text-lg border-b border-border
680
+ properties:
681
+ content: Admin Panel
682
+ - id: admin_menu
683
+ type: Menu
684
+ style:
685
+ width: 256
686
+ properties:
687
+ mode: inline
688
+ defaultOpenKeys:
689
+ - adm_content
690
+ selectedKeys:
691
+ - adm_posts
692
+ links:
693
+ - id: adm_overview
694
+ type: MenuLink
695
+ properties:
696
+ title: Overview
697
+ icon: AiOutlineDashboard
698
+ - id: adm_content
699
+ type: MenuGroup
700
+ properties:
701
+ title: Content
702
+ icon: AiOutlineFileText
703
+ links:
704
+ - id: adm_posts
705
+ type: MenuLink
706
+ properties:
707
+ title: Posts
708
+ - id: adm_pages
709
+ type: MenuLink
710
+ properties:
711
+ title: Pages
712
+ - id: adm_media
713
+ type: MenuLink
714
+ properties:
715
+ title: Media
716
+ - id: adm_users
717
+ type: MenuGroup
718
+ properties:
719
+ title: Users
720
+ icon: AiOutlineTeam
721
+ links:
722
+ - id: adm_all_users
723
+ type: MenuLink
724
+ properties:
725
+ title: All Users
726
+ - id: adm_roles
727
+ type: MenuLink
728
+ properties:
729
+ title: Roles
730
+ - id: adm_divider
731
+ type: MenuDivider
732
+ - id: adm_danger_zone
733
+ type: MenuLink
734
+ properties:
735
+ title: Danger Zone
736
+ icon: AiOutlineWarning
737
+ danger: true
738
+ events:
739
+ onSelect:
740
+ - id: adm_select_msg
741
+ type: DisplayMessage
742
+ params:
743
+ content:
744
+ _string.concat:
745
+ - "Navigated to: "
746
+ - _event: key
747
+ status: info
748
+ - id: admin_main
749
+ type: Card
750
+ layout:
751
+ flex: 1 1 auto
752
+ properties:
753
+ title: Posts
754
+ size: small
755
+ blocks:
756
+ - id: admin_welcome
757
+ type: Markdown
758
+ properties:
759
+ content: >
760
+ Manage your blog posts here. Use the sidebar to navigate between
761
+ sections.
762
+
763
+
764
+ **Recent Activity:**
765
+
766
+ - 3 new posts published this week
767
+
768
+ - 12 comments pending review
769
+
770
+ - 2 pages updated
771
+ ```
772
+
773
+ ## Configuration Guide
774
+
775
+ Learn how to configure your Lowdefy application with YAML configuration files.
776
+
777
+ **Topics covered:**
778
+ - App configuration
779
+ - Page definitions
780
+ - Block properties
781
+ - Event handling
782
+
783
+ ```yaml
784
+ - id: docs_header_box
785
+ type: Box
786
+ class: border-b border-border
787
+ blocks:
788
+ - id: docs_nav_menu
789
+ type: Menu
790
+ properties:
791
+ mode: horizontal
792
+ selectedKeys:
793
+ - docs_guides
794
+ theme:
795
+ horizontalItemSelectedColor: "#1677ff"
796
+ horizontalItemHoverColor: "#4096ff"
797
+ activeBarHeight: 3
798
+ links:
799
+ - id: docs_getting_started
800
+ type: MenuLink
801
+ properties:
802
+ title: Getting Started
803
+ icon: AiOutlineRocket
804
+ - id: docs_guides
805
+ type: MenuLink
806
+ properties:
807
+ title: Guides
808
+ icon: AiOutlineBook
809
+ - id: docs_api_ref
810
+ type: MenuGroup
811
+ properties:
812
+ title: API Reference
813
+ links:
814
+ - id: docs_rest
815
+ type: MenuLink
816
+ properties:
817
+ title: REST API
818
+ - id: docs_graphql
819
+ type: MenuLink
820
+ properties:
821
+ title: GraphQL
822
+ - id: docs_api_divider
823
+ type: MenuDivider
824
+ - id: docs_changelog
825
+ type: MenuLink
826
+ properties:
827
+ title: Changelog
828
+ - id: docs_examples
829
+ type: MenuLink
830
+ properties:
831
+ title: Examples
832
+ icon: AiOutlineCode
833
+ events:
834
+ onClick:
835
+ - id: docs_click_msg
836
+ type: DisplayMessage
837
+ params:
838
+ content:
839
+ _string.concat:
840
+ - "Opening: "
841
+ - _event: key
842
+ status: success
843
+ - id: docs_content_card
844
+ type: Card
845
+ properties:
846
+ title: Guides
847
+ size: small
848
+ blocks:
849
+ - id: docs_content
850
+ type: Markdown
851
+ properties:
852
+ content: >
853
+ ## Configuration Guide
854
+
855
+
856
+ Learn how to configure your Lowdefy application with YAML
857
+ configuration files.
858
+
859
+
860
+ **Topics covered:**
861
+
862
+ - App configuration
863
+
864
+ - Page definitions
865
+
866
+ - Block properties
867
+
868
+ - Event handling
869
+ ```
870
+
871
+ ```yaml
872
+ - id: ip_per_item_class_menu
873
+ type: Menu
874
+ style:
875
+ width: 280
876
+ properties:
877
+ mode: vertical
878
+ links:
879
+ - id: ip_dashboard
880
+ type: MenuLink
881
+ class: rounded-lg
882
+ properties:
883
+ title: Dashboard
884
+ icon: AiOutlineDashboard
885
+ - id: ip_reports
886
+ type: MenuLink
887
+ class:
888
+ .element: rounded-lg
889
+ .icon: text-blue-500
890
+ .label: font-semibold
891
+ properties:
892
+ title: Reports
893
+ icon: AiOutlineBarChart
894
+ - id: ip_settings
895
+ type: MenuLink
896
+ style:
897
+ .element:
898
+ borderLeft: 3px solid '#1677ff'
899
+ .label:
900
+ letterSpacing: 0.05em
901
+ properties:
902
+ title: Settings
903
+ icon: AiOutlineSetting
904
+ - id: ip_disabled_tooltip_extra_menu
905
+ type: Menu
906
+ style:
907
+ width: 280
908
+ properties:
909
+ mode: vertical
910
+ links:
911
+ - id: ip_search
912
+ type: MenuLink
913
+ properties:
914
+ title: Search
915
+ icon: AiOutlineSearch
916
+ extra: ⌘K
917
+ tooltip: Open command palette
918
+ - id: ip_history
919
+ type: MenuLink
920
+ properties:
921
+ title: History
922
+ icon: AiOutlineHistory
923
+ disabled: true
924
+ tooltip: Coming soon
925
+ - id: ip_divider
926
+ type: MenuDivider
927
+ - id: ip_delete
928
+ type: MenuLink
929
+ properties:
930
+ title: Delete account
931
+ icon: AiOutlineDelete
932
+ danger: true
933
+ extra: irreversible
934
+ - id: ip_popup_class_menu
935
+ type: Menu
936
+ style:
937
+ width: 280
938
+ properties:
939
+ mode: vertical
940
+ links:
941
+ - id: ip_group
942
+ type: MenuGroup
943
+ class:
944
+ .popup: shadow-2xl rounded-lg
945
+ properties:
946
+ title: Settings
947
+ icon: AiOutlineSetting
948
+ links:
949
+ - id: ip_general
950
+ type: MenuLink
951
+ properties:
952
+ title: General
953
+ - id: ip_security
954
+ type: MenuLink
955
+ properties:
956
+ title: Security
957
+ ```
958
+
959
+ ```yaml
960
+ - id: ks_menu
961
+ type: Menu
962
+ style:
963
+ width: 256
964
+ properties:
965
+ mode: vertical
966
+ links:
967
+ - id: ks_home
968
+ type: MenuLink
969
+ properties:
970
+ title: Home
971
+ icon: AiOutlineHome
972
+ shortcut: mod+1
973
+ - id: ks_search
974
+ type: MenuLink
975
+ properties:
976
+ title: Search
977
+ icon: AiOutlineSearch
978
+ shortcut: mod+k
979
+ - id: ks_settings
980
+ type: MenuLink
981
+ properties:
982
+ title: Settings
983
+ icon: AiOutlineSetting
984
+ shortcut: mod+,
985
+ events:
986
+ onSelect:
987
+ - id: ks_select_msg
988
+ type: DisplayMessage
989
+ params:
990
+ content:
991
+ _string.concat:
992
+ - "Selected: "
993
+ - _event: key
994
+ status: info
995
+ ```
996
+
997
+ | Property | Type | Default | Description |
998
+ | --- | --- | --- | --- |
999
+ | `expandIcon` | string \| object | - | Menu expand icon. |
1000
+ | `menuId` | string | - | App menu id used to get menu links. |
1001
+ | `mode` | string | `"vertical"` | Type of menu to render. Enum: `vertical`, `horizontal`, `inline`. |
1002
+ | `selectedKeys` | array | - | Array with the keys of currently selected menu items. |
1003
+ | `defaultOpenKeys` | array | - | Array with the keys of default opened sub menus. |
1004
+ | `collapsed` | boolean | `false` | Collapse the inline menu. |
1005
+ | `inlineIndent` | number | `24` | Indent width for each sub menu level in pixels (inline mode only). |
1006
+ | `forceSubMenuRender` | boolean | `false` | Render submenu into DOM before it becomes visible. |
1007
+ | `subMenuCloseDelay` | number | - | Delay time to hide submenu when mouse leaves (in seconds). |
1008
+ | `subMenuOpenDelay` | number | - | Delay time to show submenu when mouse enters (in seconds). |
1009
+ | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design menu tokens](https://ant.design/components/menu#design-token). |
1010
+ | `theme.dropdownWidth` | number | `160` | Width of dropdown submenus. |
1011
+ | `theme.zIndexPopup` | number | `1050` | Z-index for popup submenus. |
1012
+ | `theme.itemBorderRadius` | number | `8` | Border radius for menu items. |
1013
+ | `theme.subMenuItemBorderRadius` | number | `4` | Border radius for submenu items. |
1014
+ | `theme.itemColor` | string | - | Text color of menu items. |
1015
+ | `theme.itemHoverColor` | string | - | Text color when hovering menu items. |
1016
+ | `theme.horizontalItemHoverColor` | string | - | Text color when hovering horizontal menu items. |
1017
+ | `theme.itemSelectedColor` | string | - | Text color of selected menu items. |
1018
+ | `theme.horizontalItemSelectedColor` | string | - | Text color of selected horizontal menu items. |
1019
+ | `theme.itemDisabledColor` | string | - | Text color of disabled menu items. |
1020
+ | `theme.dangerItemColor` | string | - | Text color of danger menu items. |
1021
+ | `theme.dangerItemHoverColor` | string | - | Text color when hovering danger items. |
1022
+ | `theme.dangerItemSelectedColor` | string | - | Text color of selected danger items. |
1023
+ | `theme.dangerItemSelectedBg` | string | - | Background color of selected danger items. |
1024
+ | `theme.dangerItemActiveBg` | string | - | Background color of active danger items. |
1025
+ | `theme.itemBg` | string | - | Background color of menu items. |
1026
+ | `theme.itemHoverBg` | string | - | Background color when hovering menu items. |
1027
+ | `theme.subMenuItemBg` | string | - | Background color of submenu items. |
1028
+ | `theme.itemActiveBg` | string | - | Background color of active menu items. |
1029
+ | `theme.itemSelectedBg` | string | - | Background color of selected menu items. |
1030
+ | `theme.horizontalItemSelectedBg` | string | - | Background color of selected horizontal items. |
1031
+ | `theme.horizontalItemHoverBg` | string | - | Background color of hovered horizontal items. |
1032
+ | `theme.horizontalItemBorderRadius` | number | `0` | Border radius for horizontal menu items. |
1033
+ | `theme.activeBarWidth` | number | `0` | Width of active indicator bar. |
1034
+ | `theme.activeBarHeight` | number | `2` | Height of active indicator bar. |
1035
+ | `theme.activeBarBorderWidth` | number | `1` | Border width of active indicator bar. |
1036
+ | `theme.itemHeight` | number | `40` | Height of menu items. |
1037
+ | `theme.itemMarginInline` | number | `4` | Horizontal margin between items. |
1038
+ | `theme.itemMarginBlock` | number | `4` | Vertical margin between items. |
1039
+ | `theme.itemPaddingInline` | number | `16` | Horizontal padding of menu items. |
1040
+ | `theme.collapsedWidth` | number | `80` | Width of collapsed inline menu. |
1041
+ | `theme.popupBg` | string | - | Background color of popup submenus. |
1042
+ | `theme.groupTitleColor` | string | - | Text color of group titles. |
1043
+ | `theme.groupTitleFontSize` | number | `14` | Font size of group titles. |
1044
+ | `theme.iconSize` | number | `14` | Icon size in menu items. |
1045
+ | `theme.iconMarginInlineEnd` | number | `10` | Margin after icon in menu items. |
1046
+ | `theme.collapsedIconSize` | number | `16` | Icon size in collapsed menu. |
1047
+ | `theme.darkItemColor` | string | - | Text color in dark theme. |
1048
+ | `theme.darkItemBg` | string | `"#001529"` | Background color in dark theme. |
1049
+ | `theme.darkSubMenuItemBg` | string | `"#000c17"` | Submenu background in dark theme. |
1050
+ | `theme.darkItemSelectedColor` | string | - | Selected item text color in dark theme. |
1051
+ | `theme.darkItemSelectedBg` | string | - | Selected item background in dark theme. |
1052
+ | `theme.darkItemHoverBg` | string | - | Hover background in dark theme. |
1053
+ | `theme.darkItemHoverColor` | string | - | Hover text color in dark theme. |
1054
+ | `theme.darkGroupTitleColor` | string | - | Group title color in dark theme. |
1055
+ | `theme.darkItemDisabledColor` | string | - | Disabled item color in dark theme. |
1056
+ | `theme.darkPopupBg` | string | `"#001529"` | Popup background in dark theme. |
1057
+ | `theme.darkDangerItemColor` | string | - | Danger item color in dark theme. |
1058
+ | `theme.darkDangerItemSelectedBg` | string | - | Selected danger item background in dark theme. |
1059
+ | `theme.darkDangerItemHoverColor` | string | - | Hover danger item color in dark theme. |
1060
+ | `theme.darkDangerItemSelectedColor` | string | - | Selected danger item text color in dark theme. |
1061
+ | `theme.darkDangerItemActiveBg` | string | - | Active danger item background in dark theme. |
1062
+ | `links` | array | - | |
1063
+ | `links.$.id` | string | - | Menu item id. |
1064
+ | `links.$.type` | string | `"MenuLink"` | Menu item type. Enum: `MenuDivider`, `MenuLink`, `MenuGroup`. |
1065
+ | `links.$.pageId` | string | - | Page to link to. |
1066
+ | `links.$.style` | object \| string \| array | - | CSS styles for the menu item. Use a flat object for the item wrapper, or use dot-prefixed slot keys (`.element`, `.icon`, `.label`) to target specific parts. |
1067
+ | `links.$.class` | string \| array \| object | - | CSS classes for the menu item (including Tailwind utilities). Flat string/array applies to the item wrapper. Use an object with dot-prefixed slot keys (`.element`, `.icon`, `.label`, `.popup` — popup only on MenuGroup) to target specific parts. |
1068
+ | `links.$.properties` | object | - | properties from menu item. |
1069
+ | `links.$.properties.title` | string | - | Menu item title. |
1070
+ | `links.$.properties.icon` | string \| object | - | Name of an React-Icon (See all icons) or properties of an Icon block to customize icon on menu item. |
1071
+ | `links.$.properties.danger` | boolean | `false` | Apply danger style (MenuLink only). Switches the item onto the `dangerItem*` token set — theme via `properties.theme.dangerItemColor` etc. |
1072
+ | `links.$.properties.disabled` | boolean | `false` | Disable the menu item (blocks clicks and applies a greyed style). |
1073
+ | `links.$.properties.tooltip` | string | - | Tooltip text shown on hover when the menu is collapsed. Maps to antd item `title`. |
1074
+ | `links.$.properties.extra` | string | - | Free-form right-aligned label on a MenuLink (e.g. a status hint like "beta" or "soon"). For real keyboard shortcuts use `shortcut` instead — it renders a kbd badge AND wires the key handler. When both are set, `shortcut` sits to the far right of `extra`. |
1075
+ | `links.$.properties.dashed` | boolean | `false` | Whether the divider line is dashed (MenuDivider only). |
1076
+ | `links.$.properties.shortcut` | string | - | Keyboard shortcut for this menu item. Renders a kbd badge floated to the far right of the item AND wires the key handler (fires onSelect when pressed). Use "mod" for Cmd/Ctrl. |
1077
+ | `links.$.links` | array | - | |
1078
+ | `links.$.links.$.id` | string | - | Menu item id. |
1079
+ | `links.$.links.$.type` | string | `"MenuLink"` | Menu item type. Enum: `MenuDivider`, `MenuLink`, `MenuGroup`. |
1080
+ | `links.$.links.$.style` | object \| string \| array | - | CSS styles for the menu item. Use a flat object for the item wrapper, or dot-prefixed slot keys (`.element`, `.icon`, `.label`). |
1081
+ | `links.$.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. |
1082
+ | `links.$.links.$.pageId` | string | - | Page to link to. |
1083
+ | `links.$.links.$.properties` | object | - | properties from menu item. |
1084
+ | `links.$.links.$.properties.title` | string | - | Menu item title. |
1085
+ | `links.$.links.$.properties.icon` | string \| object | - | Icon name or Icon block properties. |
1086
+ | `links.$.links.$.properties.danger` | boolean | `false` | Apply danger style (MenuLink only). |
1087
+ | `links.$.links.$.properties.disabled` | boolean | `false` | Disable the menu item. |
1088
+ | `links.$.links.$.properties.tooltip` | string | - | Tooltip text shown when the menu is collapsed. |
1089
+ | `links.$.links.$.properties.extra` | string | - | Free-form right-aligned label on a MenuLink. For real keybindings use `shortcut`; when both are set, `shortcut` sits to the right of `extra`. |
1090
+ | `links.$.links.$.properties.dashed` | boolean | `false` | Whether the divider line is dashed. |
1091
+ | `links.$.links.$.properties.shortcut` | string | - | Keyboard shortcut for this menu item. Renders a kbd badge floated to the far right of the item AND wires the key handler (fires onSelect when pressed). Use "mod" for Cmd/Ctrl. |
1092
+ | `links.$.links.$.links` | array | - | |
1093
+ | `links.$.links.$.links.$.id` | string | - | Menu item id. |
1094
+ | `links.$.links.$.links.$.type` | string | `"MenuLink"` | Menu item type. Enum: `MenuDivider`, `MenuLink`. |
1095
+ | `links.$.links.$.links.$.style` | object \| string \| array | - | CSS styles for the menu item. Use a flat object or dot-prefixed slot keys. |
1096
+ | `links.$.links.$.links.$.class` | string \| array \| object | - | CSS classes for the menu item. |
1097
+ | `links.$.links.$.links.$.pageId` | string | - | Page to link to. |
1098
+ | `links.$.links.$.links.$.properties` | object | - | properties from menu item. |
1099
+ | `links.$.links.$.links.$.properties.title` | string | - | Menu item title. |
1100
+ | `links.$.links.$.links.$.properties.icon` | string \| object | - | Icon name or Icon block properties. |
1101
+ | `links.$.links.$.links.$.properties.danger` | boolean | `false` | Apply danger style (MenuLink only). |
1102
+ | `links.$.links.$.links.$.properties.disabled` | boolean | `false` | Disable the menu item. |
1103
+ | `links.$.links.$.links.$.properties.tooltip` | string | - | Tooltip text shown when the menu is collapsed. |
1104
+ | `links.$.links.$.links.$.properties.extra` | string | - | Free-form right-aligned label on a MenuLink. For real keybindings use `shortcut`. |
1105
+ | `links.$.links.$.links.$.properties.dashed` | boolean | `false` | Whether the divider line is dashed. |
1106
+ | `links.$.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. |
1107
+
1108
+ | Event | Event Data | Description |
1109
+ | --- | --- | --- |
1110
+ | `onSelect` | `{ key }` | Trigger action when menu item is selected. |
1111
+ | `onClick` | `{ key }` | Trigger action when menu item is clicked. |
1112
+ | `onToggleMenuGroup` | `{ openKeys }` | Trigger action when mobile menu group is opened. |
1113
+
1114
+ | Key | Target |
1115
+ | --- | --- |
1116
+ | `/block` | Outer block wrapper (always available). |
1117
+ | `/element` | The Menu element. |
1118
+ | `/expandIcon` | The expand icon in the Menu. |
1119
+ | `/icon` | Deprecated alias for `itemIcon`. |
1120
+ | `/itemIcon` | The icon shown in each menu item. |
1121
+ | `/item` | The Menu item wrapper (li). |
1122
+
1123
+ No slots defined.