@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,1070 @@
1
+ # ConfigProvider
2
+
3
+ Global configuration provider for antd theme and locale settings.
4
+
5
+ ```yaml
6
+ - id: cp_primary_color
7
+ type: ConfigProvider
8
+ properties:
9
+ token:
10
+ colorPrimary: "#722ed1"
11
+ blocks:
12
+ - id: cp_primary_row
13
+ type: Box
14
+ layout:
15
+ gap: 8
16
+ blocks:
17
+ - id: cp_primary_btn_solid
18
+ type: Button
19
+ layout:
20
+ flex: 0 0 auto
21
+ properties:
22
+ title: Solid
23
+ color: primary
24
+ variant: solid
25
+ - id: cp_primary_btn_outlined
26
+ type: Button
27
+ layout:
28
+ flex: 0 0 auto
29
+ properties:
30
+ title: Outlined
31
+ color: primary
32
+ variant: outlined
33
+ - id: cp_primary_btn_dashed
34
+ type: Button
35
+ layout:
36
+ flex: 0 0 auto
37
+ properties:
38
+ title: Dashed
39
+ color: primary
40
+ variant: dashed
41
+ - id: cp_primary_btn_text
42
+ type: Button
43
+ layout:
44
+ flex: 0 0 auto
45
+ properties:
46
+ title: Text
47
+ color: primary
48
+ variant: text
49
+ - id: cp_primary_btn_link
50
+ type: Button
51
+ layout:
52
+ flex: 0 0 auto
53
+ properties:
54
+ title: Link
55
+ color: primary
56
+ variant: link
57
+ - id: cp_primary_switch
58
+ type: Switch
59
+ properties:
60
+ label:
61
+ title: Purple themed switch
62
+ colon: false
63
+ - id: cp_primary_progress
64
+ type: Progress
65
+ properties:
66
+ percent: 65
67
+ ```
68
+
69
+ Dark Mode
70
+
71
+ The dark algorithm inverts the color scheme for all child components. Backgrounds become dark and text becomes light automatically.
72
+
73
+ ```yaml
74
+ - id: cp_dark
75
+ type: ConfigProvider
76
+ properties:
77
+ algorithm: dark
78
+ blocks:
79
+ - id: cp_dark_box
80
+ type: Box
81
+ style:
82
+ padding: 24px
83
+ background: "#141414"
84
+ borderRadius: 8px
85
+ layout:
86
+ gap: 12
87
+ blocks:
88
+ - id: cp_dark_title
89
+ type: Title
90
+ properties:
91
+ content: Dark Mode
92
+ level: 4
93
+ - id: cp_dark_text
94
+ type: Paragraph
95
+ properties:
96
+ content: The dark algorithm inverts the color scheme for all child components.
97
+ Backgrounds become dark and text becomes light automatically.
98
+ - id: cp_dark_btn_row
99
+ type: Box
100
+ layout:
101
+ gap: 8
102
+ blocks:
103
+ - id: cp_dark_btn1
104
+ type: Button
105
+ layout:
106
+ flex: 0 0 auto
107
+ properties:
108
+ title: Primary
109
+ color: primary
110
+ variant: solid
111
+ - id: cp_dark_btn2
112
+ type: Button
113
+ layout:
114
+ flex: 0 0 auto
115
+ properties:
116
+ title: Default
117
+ color: default
118
+ variant: outlined
119
+ - id: cp_dark_btn3
120
+ type: Button
121
+ layout:
122
+ flex: 0 0 auto
123
+ properties:
124
+ title: Danger
125
+ color: danger
126
+ variant: solid
127
+ - id: cp_dark_switch
128
+ type: Switch
129
+ properties:
130
+ label:
131
+ title: Dark switch
132
+ colon: false
133
+ ```
134
+
135
+ The compact algorithm reduces padding and margins for denser layouts. Useful for data-heavy dashboards and admin panels.
136
+
137
+ ```yaml
138
+ - id: cp_compact
139
+ type: ConfigProvider
140
+ properties:
141
+ algorithm: compact
142
+ blocks:
143
+ - id: cp_compact_row
144
+ type: Box
145
+ layout:
146
+ gap: 8
147
+ blocks:
148
+ - id: cp_compact_btn1
149
+ type: Button
150
+ layout:
151
+ flex: 0 0 auto
152
+ properties:
153
+ title: Compact Solid
154
+ color: primary
155
+ variant: solid
156
+ - id: cp_compact_btn2
157
+ type: Button
158
+ layout:
159
+ flex: 0 0 auto
160
+ properties:
161
+ title: Compact Outlined
162
+ color: primary
163
+ variant: outlined
164
+ - id: cp_compact_input
165
+ type: TextInput
166
+ properties:
167
+ label:
168
+ title: Compact input
169
+ colon: false
170
+ placeholder: Compact sized input
171
+ - id: cp_compact_text
172
+ type: Paragraph
173
+ properties:
174
+ content: The compact algorithm reduces padding and margins for denser layouts.
175
+ Useful for data-heavy dashboards and admin panels.
176
+ ```
177
+
178
+ Dark + Compact
179
+
180
+ Multiple algorithms can be combined by passing an array. Here dark and compact are used together for a dense dark-themed layout.
181
+
182
+ ```yaml
183
+ - id: cp_combined
184
+ type: ConfigProvider
185
+ properties:
186
+ algorithm:
187
+ - dark
188
+ - compact
189
+ blocks:
190
+ - id: cp_combined_box
191
+ type: Box
192
+ style:
193
+ padding: 24px
194
+ background: "#141414"
195
+ borderRadius: 8px
196
+ layout:
197
+ gap: 12
198
+ blocks:
199
+ - id: cp_combined_title
200
+ type: Title
201
+ properties:
202
+ content: Dark + Compact
203
+ level: 4
204
+ - id: cp_combined_text
205
+ type: Paragraph
206
+ properties:
207
+ content: Multiple algorithms can be combined by passing an array. Here dark and
208
+ compact are used together for a dense dark-themed layout.
209
+ - id: cp_combined_btn_row
210
+ type: Box
211
+ layout:
212
+ gap: 8
213
+ blocks:
214
+ - id: cp_combined_btn1
215
+ type: Button
216
+ layout:
217
+ flex: 0 0 auto
218
+ properties:
219
+ title: Action
220
+ color: primary
221
+ variant: solid
222
+ - id: cp_combined_btn2
223
+ type: Button
224
+ layout:
225
+ flex: 0 0 auto
226
+ properties:
227
+ title: Cancel
228
+ color: default
229
+ variant: outlined
230
+ ```
231
+
232
+ **Small:**
233
+
234
+ **Middle (default):**
235
+
236
+ **Large:**
237
+
238
+ ```yaml
239
+ - id: cp_size_small_label
240
+ type: Markdown
241
+ properties:
242
+ content: "**Small:**"
243
+ - id: cp_size_small
244
+ type: ConfigProvider
245
+ properties:
246
+ componentSize: small
247
+ blocks:
248
+ - id: cp_small_row
249
+ type: Box
250
+ layout:
251
+ gap: 8
252
+ blocks:
253
+ - id: cp_small_btn
254
+ type: Button
255
+ layout:
256
+ flex: 0 0 auto
257
+ properties:
258
+ title: Small Button
259
+ color: primary
260
+ variant: solid
261
+ - id: cp_small_input
262
+ type: TextInput
263
+ layout:
264
+ flex: 0 1 200px
265
+ properties:
266
+ placeholder: Small input
267
+ label:
268
+ disabled: true
269
+ - id: cp_size_middle_label
270
+ type: Markdown
271
+ properties:
272
+ content: "**Middle (default):**"
273
+ - id: cp_size_middle
274
+ type: ConfigProvider
275
+ properties:
276
+ componentSize: middle
277
+ blocks:
278
+ - id: cp_middle_row
279
+ type: Box
280
+ layout:
281
+ gap: 8
282
+ blocks:
283
+ - id: cp_middle_btn
284
+ type: Button
285
+ layout:
286
+ flex: 0 0 auto
287
+ properties:
288
+ title: Middle Button
289
+ color: primary
290
+ variant: solid
291
+ - id: cp_middle_input
292
+ type: TextInput
293
+ layout:
294
+ flex: 0 1 200px
295
+ properties:
296
+ placeholder: Middle input
297
+ label:
298
+ disabled: true
299
+ - id: cp_size_large_label
300
+ type: Markdown
301
+ properties:
302
+ content: "**Large:**"
303
+ - id: cp_size_large
304
+ type: ConfigProvider
305
+ properties:
306
+ componentSize: large
307
+ blocks:
308
+ - id: cp_large_row
309
+ type: Box
310
+ layout:
311
+ gap: 8
312
+ blocks:
313
+ - id: cp_large_btn
314
+ type: Button
315
+ layout:
316
+ flex: 0 0 auto
317
+ properties:
318
+ title: Large Button
319
+ color: primary
320
+ variant: solid
321
+ - id: cp_large_input
322
+ type: TextInput
323
+ layout:
324
+ flex: 0 1 200px
325
+ properties:
326
+ placeholder: Large input
327
+ label:
328
+ disabled: true
329
+ ```
330
+
331
+ Setting componentDisabled to true disables all interactive child components at once, without needing to set disabled on each individual component.
332
+
333
+ ```yaml
334
+ - id: cp_disabled
335
+ type: ConfigProvider
336
+ properties:
337
+ componentDisabled: true
338
+ blocks:
339
+ - id: cp_disabled_row
340
+ type: Box
341
+ layout:
342
+ gap: 8
343
+ blocks:
344
+ - id: cp_disabled_btn
345
+ type: Button
346
+ layout:
347
+ flex: 0 0 auto
348
+ properties:
349
+ title: Disabled Button
350
+ color: primary
351
+ variant: solid
352
+ - id: cp_disabled_btn2
353
+ type: Button
354
+ layout:
355
+ flex: 0 0 auto
356
+ properties:
357
+ title: Also Disabled
358
+ color: default
359
+ variant: outlined
360
+ - id: cp_disabled_switch
361
+ type: Switch
362
+ properties:
363
+ label:
364
+ title: Disabled switch
365
+ colon: false
366
+ - id: cp_disabled_input
367
+ type: TextInput
368
+ properties:
369
+ placeholder: Disabled input
370
+ label:
371
+ title: Disabled input
372
+ colon: false
373
+ - id: cp_disabled_text
374
+ type: Paragraph
375
+ properties:
376
+ content: Setting componentDisabled to true disables all interactive child
377
+ components at once, without needing to set disabled on each individual
378
+ component.
379
+ ```
380
+
381
+ Setting direction to rtl enables right-to-left layout for all child components. This is essential for languages like Arabic and Hebrew.
382
+
383
+ ```yaml
384
+ - id: cp_rtl
385
+ type: ConfigProvider
386
+ properties:
387
+ direction: rtl
388
+ blocks:
389
+ - id: cp_rtl_row
390
+ type: Box
391
+ layout:
392
+ gap: 8
393
+ blocks:
394
+ - id: cp_rtl_btn
395
+ type: Button
396
+ layout:
397
+ flex: 0 0 auto
398
+ properties:
399
+ title: Right-to-Left
400
+ color: primary
401
+ variant: solid
402
+ icon: AiOutlineArrowLeft
403
+ - id: cp_rtl_input
404
+ type: TextInput
405
+ properties:
406
+ placeholder: RTL text input
407
+ label:
408
+ title: RTL Input
409
+ colon: false
410
+ - id: cp_rtl_text
411
+ type: Paragraph
412
+ properties:
413
+ content: Setting direction to rtl enables right-to-left layout for all child
414
+ components. This is essential for languages like Arabic and Hebrew.
415
+ ```
416
+
417
+ **Outlined (default):**
418
+
419
+ **Filled:**
420
+
421
+ **Borderless:**
422
+
423
+ **Underlined:**
424
+
425
+ ```yaml
426
+ - id: cp_variant_outlined_label
427
+ type: Markdown
428
+ properties:
429
+ content: "**Outlined (default):**"
430
+ - id: cp_variant_outlined
431
+ type: ConfigProvider
432
+ properties:
433
+ variant: outlined
434
+ blocks:
435
+ - id: cp_vo_input
436
+ type: TextInput
437
+ properties:
438
+ placeholder: Outlined input
439
+ label:
440
+ title: Name
441
+ colon: false
442
+ - id: cp_variant_filled_label
443
+ type: Markdown
444
+ properties:
445
+ content: "**Filled:**"
446
+ - id: cp_variant_filled
447
+ type: ConfigProvider
448
+ properties:
449
+ variant: filled
450
+ blocks:
451
+ - id: cp_vf_input
452
+ type: TextInput
453
+ properties:
454
+ placeholder: Filled input
455
+ label:
456
+ title: Name
457
+ colon: false
458
+ - id: cp_variant_borderless_label
459
+ type: Markdown
460
+ properties:
461
+ content: "**Borderless:**"
462
+ - id: cp_variant_borderless
463
+ type: ConfigProvider
464
+ properties:
465
+ variant: borderless
466
+ blocks:
467
+ - id: cp_vb_input
468
+ type: TextInput
469
+ properties:
470
+ placeholder: Borderless input
471
+ label:
472
+ title: Name
473
+ colon: false
474
+ - id: cp_variant_underlined_label
475
+ type: Markdown
476
+ properties:
477
+ content: "**Underlined:**"
478
+ - id: cp_variant_underlined
479
+ type: ConfigProvider
480
+ properties:
481
+ variant: underlined
482
+ blocks:
483
+ - id: cp_vu_input
484
+ type: TextInput
485
+ properties:
486
+ placeholder: Underlined input
487
+ label:
488
+ title: Name
489
+ colon: false
490
+ ```
491
+
492
+ The components property allows overriding design tokens at the component level. Here, Button and Input components have custom borderRadius applied without affecting other components.
493
+
494
+ ```yaml
495
+ - id: cp_components
496
+ type: ConfigProvider
497
+ properties:
498
+ components:
499
+ Button:
500
+ borderRadius: 20
501
+ controlHeight: 40
502
+ Input:
503
+ borderRadius: 20
504
+ blocks:
505
+ - id: cp_components_row
506
+ type: Box
507
+ layout:
508
+ gap: 8
509
+ blocks:
510
+ - id: cp_comp_btn
511
+ type: Button
512
+ layout:
513
+ flex: 0 0 auto
514
+ properties:
515
+ title: Pill Button
516
+ color: primary
517
+ variant: solid
518
+ - id: cp_comp_btn2
519
+ type: Button
520
+ layout:
521
+ flex: 0 0 auto
522
+ properties:
523
+ title: Also Pill
524
+ color: default
525
+ variant: outlined
526
+ - id: cp_comp_input
527
+ type: TextInput
528
+ properties:
529
+ placeholder: Rounded input
530
+ label:
531
+ title: Rounded input
532
+ colon: false
533
+ - id: cp_comp_text
534
+ type: Paragraph
535
+ properties:
536
+ content: The components property allows overriding design tokens at the
537
+ component level. Here, Button and Input components have custom
538
+ borderRadius applied without affecting other components.
539
+ ```
540
+
541
+ Global design tokens customize the look of all child components. This section uses a custom primary color (orange), larger font size, rounded borders, and a warm background color.
542
+
543
+ ```yaml
544
+ - id: cp_tokens
545
+ type: ConfigProvider
546
+ properties:
547
+ token:
548
+ colorPrimary: "#fa541c"
549
+ fontSize: 16
550
+ borderRadius: 8
551
+ blocks:
552
+ - id: cp_tokens_card
553
+ type: Card
554
+ properties:
555
+ title: Custom Themed Card
556
+ blocks:
557
+ - id: cp_tokens_text
558
+ type: Paragraph
559
+ properties:
560
+ content: Global design tokens customize the look of all child components. This
561
+ section uses a custom primary color (orange), larger font size,
562
+ rounded borders, and a warm background color.
563
+ - id: cp_tokens_btn_row
564
+ type: Box
565
+ layout:
566
+ gap: 8
567
+ blocks:
568
+ - id: cp_tokens_btn1
569
+ type: Button
570
+ layout:
571
+ flex: 0 0 auto
572
+ properties:
573
+ title: Primary
574
+ color: primary
575
+ variant: solid
576
+ - id: cp_tokens_btn2
577
+ type: Button
578
+ layout:
579
+ flex: 0 0 auto
580
+ properties:
581
+ title: Outlined
582
+ color: primary
583
+ variant: outlined
584
+ - id: cp_tokens_input
585
+ type: TextInput
586
+ properties:
587
+ placeholder: Themed input
588
+ label:
589
+ title: Themed Input
590
+ colon: false
591
+ ```
592
+
593
+ The theme property provides antd design token overrides for this block and all its descendants. It works similarly to token but is applied at the block level through the antd theme system.
594
+
595
+ ```yaml
596
+ - id: cp_theme
597
+ type: ConfigProvider
598
+ properties:
599
+ theme:
600
+ colorPrimary: "#13c2c2"
601
+ colorInfo: "#13c2c2"
602
+ borderRadius: 12
603
+ blocks:
604
+ - id: cp_theme_card
605
+ type: Card
606
+ properties:
607
+ title: Theme Overrides via theme Property
608
+ blocks:
609
+ - id: cp_theme_text
610
+ type: Paragraph
611
+ properties:
612
+ content: The theme property provides antd design token overrides for this block
613
+ and all its descendants. It works similarly to token but is
614
+ applied at the block level through the antd theme system.
615
+ - id: cp_theme_btn_row
616
+ type: Box
617
+ layout:
618
+ gap: 8
619
+ blocks:
620
+ - id: cp_theme_btn1
621
+ type: Button
622
+ layout:
623
+ flex: 0 0 auto
624
+ properties:
625
+ title: Teal Primary
626
+ color: primary
627
+ variant: solid
628
+ - id: cp_theme_btn2
629
+ type: Button
630
+ layout:
631
+ flex: 0 0 auto
632
+ properties:
633
+ title: Teal Outlined
634
+ color: primary
635
+ variant: outlined
636
+ - id: cp_theme_switch
637
+ type: Switch
638
+ properties:
639
+ label:
640
+ title: Teal themed switch
641
+ colon: false
642
+ ```
643
+
644
+ Styled Wrapper
645
+
646
+ Tailwind CSS classes can be applied to the ConfigProvider wrapper div using the class property. Here a gradient background with rounded corners wraps all themed children.
647
+
648
+ Elevated Section
649
+
650
+ A ConfigProvider with shadow and padding classes creates a visually distinct themed section on the page.
651
+
652
+ ```yaml
653
+ - id: cp_styled_gradient
654
+ type: ConfigProvider
655
+ class: bg-gradient-to-r from-primary/10 to-primary/5 p-6 rounded-xl border
656
+ border-border
657
+ properties:
658
+ token:
659
+ colorPrimary: "#6366f1"
660
+ blocks:
661
+ - id: cp_styled_gradient_title
662
+ type: Title
663
+ properties:
664
+ content: Styled Wrapper
665
+ level: 4
666
+ - id: cp_styled_gradient_text
667
+ type: Paragraph
668
+ properties:
669
+ content: Tailwind CSS classes can be applied to the ConfigProvider wrapper div
670
+ using the class property. Here a gradient background with rounded
671
+ corners wraps all themed children.
672
+ - id: cp_styled_gradient_row
673
+ type: Box
674
+ layout:
675
+ gap: 8
676
+ blocks:
677
+ - id: cp_styled_gradient_btn1
678
+ type: Button
679
+ layout:
680
+ flex: 0 0 auto
681
+ properties:
682
+ title: Indigo Action
683
+ color: primary
684
+ variant: solid
685
+ - id: cp_styled_gradient_btn2
686
+ type: Button
687
+ layout:
688
+ flex: 0 0 auto
689
+ properties:
690
+ title: Cancel
691
+ color: default
692
+ variant: outlined
693
+ - id: cp_styled_shadow
694
+ type: ConfigProvider
695
+ class: shadow-lg p-8 rounded-2xl bg-bg-container
696
+ properties:
697
+ token:
698
+ colorPrimary: "#059669"
699
+ blocks:
700
+ - id: cp_styled_shadow_title
701
+ type: Title
702
+ properties:
703
+ content: Elevated Section
704
+ level: 4
705
+ - id: cp_styled_shadow_text
706
+ type: Paragraph
707
+ properties:
708
+ content: A ConfigProvider with shadow and padding classes creates a visually
709
+ distinct themed section on the page.
710
+ - id: cp_styled_shadow_btn
711
+ type: Button
712
+ layout:
713
+ flex: 0 0 auto
714
+ properties:
715
+ title: Confirm
716
+ color: primary
717
+ variant: solid
718
+ ```
719
+
720
+ Acme Commerce
721
+
722
+ This demonstrates using ConfigProvider to apply a brand theme across an entire section. The rose primary color, pill-shaped buttons, and custom font size create a cohesive brand identity for all child components.
723
+
724
+ ```yaml
725
+ - id: cp_brand_wrapper
726
+ type: ConfigProvider
727
+ properties:
728
+ token:
729
+ colorPrimary: "#e11d48"
730
+ colorInfo: "#0ea5e9"
731
+ borderRadius: 6
732
+ fontSize: 14
733
+ components:
734
+ Button:
735
+ borderRadius: 20
736
+ blocks:
737
+ - id: cp_brand_header
738
+ type: Box
739
+ class: bg-bg-layout p-6 rounded-lg border border-border
740
+ layout:
741
+ gap: 16
742
+ blocks:
743
+ - id: cp_brand_title_row
744
+ type: Box
745
+ layout:
746
+ gap: 12
747
+ align: center
748
+ blocks:
749
+ - id: cp_brand_avatar
750
+ type: Avatar
751
+ layout:
752
+ flex: 0 0 auto
753
+ properties:
754
+ icon: AiOutlineShop
755
+ size: 48
756
+ color: "#fff"
757
+ backgroundColor: "#e11d48"
758
+ - id: cp_brand_title
759
+ type: Title
760
+ layout:
761
+ flex: 1 1 0
762
+ properties:
763
+ content: Acme Commerce
764
+ level: 3
765
+ - id: cp_brand_description
766
+ type: Paragraph
767
+ properties:
768
+ content: This demonstrates using ConfigProvider to apply a brand theme across an
769
+ entire section. The rose primary color, pill-shaped buttons, and
770
+ custom font size create a cohesive brand identity for all child
771
+ components.
772
+ - id: cp_brand_form_row
773
+ type: Box
774
+ layout:
775
+ gap: 12
776
+ blocks:
777
+ - id: cp_brand_search_input
778
+ type: TextInput
779
+ layout:
780
+ flex: 1 1 0
781
+ properties:
782
+ placeholder: Search products...
783
+ label:
784
+ disabled: true
785
+ suffixIcon: AiOutlineSearch
786
+ - id: cp_brand_search_btn
787
+ type: Button
788
+ layout:
789
+ flex: 0 0 auto
790
+ properties:
791
+ title: Search
792
+ color: primary
793
+ variant: solid
794
+ - id: cp_brand_cart_btn
795
+ type: Button
796
+ layout:
797
+ flex: 0 0 auto
798
+ properties:
799
+ title: Cart
800
+ icon: AiOutlineShoppingCart
801
+ color: default
802
+ variant: outlined
803
+ - id: cp_brand_stats_row
804
+ type: Box
805
+ layout:
806
+ gap: 16
807
+ blocks:
808
+ - id: cp_brand_stat1
809
+ type: Statistic
810
+ layout:
811
+ flex: 1 1 0
812
+ properties:
813
+ title: Products
814
+ value: 1240
815
+ - id: cp_brand_stat2
816
+ type: Statistic
817
+ layout:
818
+ flex: 1 1 0
819
+ properties:
820
+ title: Orders Today
821
+ value: 87
822
+ - id: cp_brand_stat3
823
+ type: Statistic
824
+ layout:
825
+ flex: 1 1 0
826
+ properties:
827
+ title: Revenue
828
+ value: 12480
829
+ prefix: $
830
+ ```
831
+
832
+ System Metrics
833
+
834
+ ```yaml
835
+ - id: cp_dashboard_wrapper
836
+ type: ConfigProvider
837
+ properties:
838
+ algorithm:
839
+ - compact
840
+ componentSize: small
841
+ token:
842
+ colorPrimary: "#1677ff"
843
+ fontSize: 12
844
+ variant: filled
845
+ blocks:
846
+ - id: cp_dashboard_title
847
+ type: Title
848
+ properties:
849
+ content: System Metrics
850
+ level: 4
851
+ - id: cp_dashboard_cards_row
852
+ type: Box
853
+ layout:
854
+ gap: 12
855
+ blocks:
856
+ - id: cp_dashboard_card1
857
+ type: Card
858
+ layout:
859
+ flex: 1 1 0
860
+ properties:
861
+ title: CPU Usage
862
+ size: small
863
+ blocks:
864
+ - id: cp_dashboard_progress1
865
+ type: Progress
866
+ properties:
867
+ percent: 72
868
+ - id: cp_dashboard_tag1
869
+ type: Tag
870
+ properties:
871
+ title: Normal
872
+ color: success
873
+ - id: cp_dashboard_card2
874
+ type: Card
875
+ layout:
876
+ flex: 1 1 0
877
+ properties:
878
+ title: Memory
879
+ size: small
880
+ blocks:
881
+ - id: cp_dashboard_progress2
882
+ type: Progress
883
+ properties:
884
+ percent: 89
885
+ - id: cp_dashboard_tag2
886
+ type: Tag
887
+ properties:
888
+ title: High
889
+ color: warning
890
+ - id: cp_dashboard_card3
891
+ type: Card
892
+ layout:
893
+ flex: 1 1 0
894
+ properties:
895
+ title: Disk I/O
896
+ size: small
897
+ blocks:
898
+ - id: cp_dashboard_progress3
899
+ type: Progress
900
+ properties:
901
+ percent: 34
902
+ - id: cp_dashboard_tag3
903
+ type: Tag
904
+ properties:
905
+ title: Low
906
+ color: blue
907
+ - id: cp_dashboard_filter_row
908
+ type: Box
909
+ layout:
910
+ gap: 8
911
+ align: center
912
+ blocks:
913
+ - id: cp_dashboard_filter_input
914
+ type: TextInput
915
+ layout:
916
+ flex: 0 1 200px
917
+ properties:
918
+ placeholder: Filter services...
919
+ label:
920
+ disabled: true
921
+ - id: cp_dashboard_selector
922
+ type: Selector
923
+ layout:
924
+ flex: 0 1 150px
925
+ properties:
926
+ placeholder: Region
927
+ label:
928
+ disabled: true
929
+ options:
930
+ - label: US East
931
+ value: us-east
932
+ - label: US West
933
+ value: us-west
934
+ - label: EU West
935
+ value: eu-west
936
+ - id: cp_dashboard_refresh_btn
937
+ type: Button
938
+ layout:
939
+ flex: 0 0 auto
940
+ properties:
941
+ title: Refresh
942
+ icon: AiOutlineReload
943
+ color: primary
944
+ variant: solid
945
+ ```
946
+
947
+ Admin Panel
948
+
949
+ A dark-themed admin panel using ConfigProvider to apply the dark algorithm with a custom purple accent color. All child components inherit the dark color scheme automatically.
950
+
951
+ ```yaml
952
+ - id: cp_admin_wrapper
953
+ type: ConfigProvider
954
+ properties:
955
+ algorithm: dark
956
+ token:
957
+ colorPrimary: "#7c3aed"
958
+ borderRadius: 8
959
+ blocks:
960
+ - id: cp_admin_box
961
+ type: Box
962
+ style:
963
+ padding: 24px
964
+ background: "#141414"
965
+ borderRadius: 12px
966
+ layout:
967
+ gap: 16
968
+ blocks:
969
+ - id: cp_admin_header_row
970
+ type: Box
971
+ layout:
972
+ gap: 12
973
+ align: center
974
+ blocks:
975
+ - id: cp_admin_title
976
+ type: Title
977
+ layout:
978
+ flex: 1 1 0
979
+ properties:
980
+ content: Admin Panel
981
+ level: 3
982
+ - id: cp_admin_status_tag
983
+ type: Tag
984
+ layout:
985
+ flex: 0 0 auto
986
+ properties:
987
+ title: Online
988
+ color: success
989
+ - id: cp_admin_desc
990
+ type: Paragraph
991
+ properties:
992
+ content: A dark-themed admin panel using ConfigProvider to apply the dark
993
+ algorithm with a custom purple accent color. All child components
994
+ inherit the dark color scheme automatically.
995
+ - id: cp_admin_form
996
+ type: Box
997
+ layout:
998
+ gap: 12
999
+ blocks:
1000
+ - id: cp_admin_name_input
1001
+ type: TextInput
1002
+ properties:
1003
+ placeholder: Enter username
1004
+ label:
1005
+ title: Username
1006
+ colon: false
1007
+ - id: cp_admin_email_input
1008
+ type: TextInput
1009
+ properties:
1010
+ placeholder: Enter email address
1011
+ label:
1012
+ title: Email
1013
+ colon: false
1014
+ - id: cp_admin_role_selector
1015
+ type: Selector
1016
+ properties:
1017
+ placeholder: Select role
1018
+ label:
1019
+ title: Role
1020
+ colon: false
1021
+ options:
1022
+ - label: Administrator
1023
+ value: admin
1024
+ - label: Editor
1025
+ value: editor
1026
+ - label: Viewer
1027
+ value: viewer
1028
+ - id: cp_admin_btn_row
1029
+ type: Box
1030
+ layout:
1031
+ gap: 8
1032
+ blocks:
1033
+ - id: cp_admin_save_btn
1034
+ type: Button
1035
+ layout:
1036
+ flex: 0 0 auto
1037
+ properties:
1038
+ title: Save User
1039
+ icon: AiOutlineSave
1040
+ color: primary
1041
+ variant: solid
1042
+ - id: cp_admin_cancel_btn
1043
+ type: Button
1044
+ layout:
1045
+ flex: 0 0 auto
1046
+ properties:
1047
+ title: Cancel
1048
+ color: default
1049
+ variant: outlined
1050
+ ```
1051
+
1052
+ | Property | Type | Default | Description |
1053
+ | --- | --- | --- | --- |
1054
+ | `algorithm` | string \| array | - | Theme algorithm. Can be "default", "dark", "compact", or an array of these values. |
1055
+ | `componentDisabled` | boolean | `false` | Set disabled state for all child components. |
1056
+ | `componentSize` | string | - | Set size for all child components. Enum: `small`, `middle`, `large`. |
1057
+ | `components` | object | - | Component-level token overrides. Keys are component names, values are token objects. |
1058
+ | `direction` | string | `"ltr"` | Direction of layout. Enum: `ltr`, `rtl`. |
1059
+ | `locale` | object | - | Antd locale object to localize built-in component strings (date pickers, pagination, modal, form validation). Pair with the _locale operator and config.i18n to keep the whole subtree in one language. |
1060
+ | `token` | object | - | Theme token configuration. Customize design tokens like colorPrimary, fontSize, etc. |
1061
+ | `variant` | string | - | Global input variant style for all child components. Enum: `outlined`, `filled`, `borderless`, `underlined`. |
1062
+ | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). |
1063
+
1064
+ No events defined.
1065
+
1066
+ No CSS keys defined.
1067
+
1068
+ | Slot | Description |
1069
+ | --- | --- |
1070
+ | `content` | Child blocks wrapped by the ConfigProvider. |