@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,384 @@
1
+ # S3UploadButton
2
+
3
+ __Deprecated__ — use the provider-neutral <a href="/Upload">Upload</a> block with `uploadPolicyRequestId` instead. S3UploadButton remains as an alias so existing apps keep working. Upload files to AWS S3 with a button trigger. Supports file type filtering, upload limits, and custom button styling. Requires an `AwsS3PresignedPostPolicy` request to define the S3 upload policy.
4
+
5
+ > The S3UploadButton requires an AwsS3Bucket connection and AwsS3PresignedPostPolicy request to upload files. The examples on this page demonstrate UI configuration only — uploads will not function without a configured S3 connection.
6
+
7
+ ```yaml
8
+ - id: basic_default
9
+ type: S3UploadButton
10
+ properties:
11
+ s3PostPolicyRequestId: s3_upload_policy_request
12
+ - id: basic_custom_title
13
+ type: S3UploadButton
14
+ properties:
15
+ s3PostPolicyRequestId: s3_upload_policy_request
16
+ button:
17
+ icon: UploadOutlined
18
+ title: Choose File
19
+ type: default
20
+ - id: basic_custom_icon
21
+ type: S3UploadButton
22
+ properties:
23
+ s3PostPolicyRequestId: s3_upload_policy_request
24
+ button:
25
+ icon: AiOutlineCloudUpload
26
+ title: Upload to Cloud
27
+ type: default
28
+ ```
29
+
30
+ ```yaml
31
+ - id: accept_images
32
+ type: S3UploadButton
33
+ properties:
34
+ s3PostPolicyRequestId: s3_upload_policy_request
35
+ accept: image/*
36
+ button:
37
+ icon: AiOutlinePicture
38
+ title: Upload Image
39
+ type: default
40
+ - id: accept_pdf
41
+ type: S3UploadButton
42
+ properties:
43
+ s3PostPolicyRequestId: s3_upload_policy_request
44
+ accept: .pdf
45
+ button:
46
+ icon: AiOutlineFilePdf
47
+ title: Upload PDF
48
+ type: default
49
+ - id: accept_specific
50
+ type: S3UploadButton
51
+ properties:
52
+ s3PostPolicyRequestId: s3_upload_policy_request
53
+ accept: .jpg,.png,.gif
54
+ button:
55
+ icon: AiOutlinePicture
56
+ title: Upload JPG, PNG, or GIF
57
+ type: default
58
+ ```
59
+
60
+ ```yaml
61
+ - id: limit_single
62
+ type: S3UploadButton
63
+ properties:
64
+ s3PostPolicyRequestId: s3_upload_policy_request
65
+ singleFile: true
66
+ button:
67
+ icon: UploadOutlined
68
+ title: Upload Single File
69
+ type: default
70
+ - id: limit_max_three
71
+ type: S3UploadButton
72
+ properties:
73
+ s3PostPolicyRequestId: s3_upload_policy_request
74
+ maxCount: 3
75
+ button:
76
+ icon: UploadOutlined
77
+ title: Upload (Max 3)
78
+ type: default
79
+ - id: limit_single_images
80
+ type: S3UploadButton
81
+ properties:
82
+ s3PostPolicyRequestId: s3_upload_policy_request
83
+ singleFile: true
84
+ accept: image/*
85
+ button:
86
+ icon: AiOutlinePicture
87
+ title: Upload One Image
88
+ type: default
89
+ ```
90
+
91
+ ```yaml
92
+ - id: button_primary
93
+ type: S3UploadButton
94
+ properties:
95
+ s3PostPolicyRequestId: s3_upload_policy_request
96
+ button:
97
+ icon: UploadOutlined
98
+ title: Upload
99
+ type: primary
100
+ - id: button_large
101
+ type: S3UploadButton
102
+ properties:
103
+ s3PostPolicyRequestId: s3_upload_policy_request
104
+ button:
105
+ icon: UploadOutlined
106
+ title: Upload Files
107
+ type: default
108
+ size: large
109
+ - id: button_different_icon
110
+ type: S3UploadButton
111
+ properties:
112
+ s3PostPolicyRequestId: s3_upload_policy_request
113
+ button:
114
+ icon: AiOutlinePaperClip
115
+ title: Attach Files
116
+ type: default
117
+ ```
118
+
119
+ ```yaml
120
+ - id: disabled_default
121
+ type: S3UploadButton
122
+ properties:
123
+ s3PostPolicyRequestId: s3_upload_policy_request
124
+ disabled: true
125
+ - id: disabled_primary
126
+ type: S3UploadButton
127
+ properties:
128
+ s3PostPolicyRequestId: s3_upload_policy_request
129
+ disabled: true
130
+ button:
131
+ icon: UploadOutlined
132
+ title: Upload
133
+ type: primary
134
+ - id: disabled_hidden_list
135
+ type: S3UploadButton
136
+ properties:
137
+ s3PostPolicyRequestId: s3_upload_policy_request
138
+ disabled: true
139
+ showUploadList: false
140
+ ```
141
+
142
+ ```yaml
143
+ - id: list_visible
144
+ type: S3UploadButton
145
+ properties:
146
+ s3PostPolicyRequestId: s3_upload_policy_request
147
+ showUploadList: true
148
+ button:
149
+ icon: UploadOutlined
150
+ title: Upload (List Visible)
151
+ type: default
152
+ - id: list_hidden
153
+ type: S3UploadButton
154
+ properties:
155
+ s3PostPolicyRequestId: s3_upload_policy_request
156
+ showUploadList: false
157
+ button:
158
+ icon: UploadOutlined
159
+ title: Upload (No List)
160
+ type: default
161
+ - id: list_single_hidden
162
+ type: S3UploadButton
163
+ properties:
164
+ s3PostPolicyRequestId: s3_upload_policy_request
165
+ singleFile: true
166
+ showUploadList: false
167
+ button:
168
+ icon: UploadOutlined
169
+ title: Upload Single (No List)
170
+ type: default
171
+ ```
172
+
173
+ ```yaml
174
+ - id: label_default
175
+ type: S3UploadButton
176
+ properties:
177
+ title: Upload Attachment
178
+ s3PostPolicyRequestId: s3_upload_policy_request
179
+ - id: label_inline
180
+ type: S3UploadButton
181
+ properties:
182
+ title: Attachment
183
+ s3PostPolicyRequestId: s3_upload_policy_request
184
+ label:
185
+ inline: true
186
+ span: 8
187
+ - id: label_extra
188
+ type: S3UploadButton
189
+ properties:
190
+ title: Upload Document
191
+ s3PostPolicyRequestId: s3_upload_policy_request
192
+ label:
193
+ extra: Accepted formats are PDF, DOCX, and PNG. Max size 10MB.
194
+ ```
195
+
196
+ ```yaml
197
+ - id: style_element_bg
198
+ type: S3UploadButton
199
+ style:
200
+ .element:
201
+ background: "#f6ffed"
202
+ border: 1px solid
203
+ borderRadius: 8
204
+ padding: 12
205
+ properties:
206
+ s3PostPolicyRequestId: s3_upload_policy_request
207
+ button:
208
+ icon: UploadOutlined
209
+ title: Upload
210
+ type: default
211
+ - id: style_label
212
+ type: S3UploadButton
213
+ style:
214
+ .label:
215
+ color: "#722ed1"
216
+ fontWeight: bold
217
+ properties:
218
+ title: Upload Files
219
+ s3PostPolicyRequestId: s3_upload_policy_request
220
+ - id: style_tailwind
221
+ type: S3UploadButton
222
+ class: shadow-md rounded-lg
223
+ properties:
224
+ s3PostPolicyRequestId: s3_upload_policy_request
225
+ button:
226
+ icon: UploadOutlined
227
+ title: Upload
228
+ type: default
229
+ ```
230
+
231
+ ```yaml
232
+ - id: doc_mgmt_card
233
+ type: Card
234
+ properties:
235
+ title: Upload Document
236
+ blocks:
237
+ - id: doc_name
238
+ type: TextInput
239
+ required: true
240
+ properties:
241
+ title: Document Name
242
+ placeholder: Enter document name
243
+ label:
244
+ colon: false
245
+ - id: doc_category
246
+ type: Selector
247
+ properties:
248
+ title: Category
249
+ placeholder: Select category
250
+ label:
251
+ colon: false
252
+ options:
253
+ - label: Contracts
254
+ value: contracts
255
+ - label: Invoices
256
+ value: invoices
257
+ - label: Reports
258
+ value: reports
259
+ - label: Other
260
+ value: other
261
+ - id: doc_upload
262
+ type: S3UploadButton
263
+ properties:
264
+ title: Attachment
265
+ s3PostPolicyRequestId: s3_upload_policy_request
266
+ accept: .pdf,.docx,.xlsx
267
+ button:
268
+ icon: AiOutlineFilePdf
269
+ title: Choose Document
270
+ type: default
271
+ label:
272
+ colon: false
273
+ extra: Accepted formats are PDF, DOCX, and XLSX.
274
+ - id: doc_save
275
+ type: Button
276
+ layout:
277
+ flex: 0 0 auto
278
+ properties:
279
+ title: Save Document
280
+ color: primary
281
+ variant: solid
282
+ icon: AiOutlineSave
283
+ events:
284
+ onClick:
285
+ - id: save_validate
286
+ type: Validate
287
+ - id: save_msg
288
+ type: DisplayMessage
289
+ params:
290
+ content: Document saved successfully!
291
+ status: success
292
+ ```
293
+
294
+ ```yaml
295
+ - id: profile_card
296
+ type: Card
297
+ properties:
298
+ title: Update Profile
299
+ blocks:
300
+ - id: profile_avatar
301
+ type: S3UploadButton
302
+ properties:
303
+ title: Profile Picture
304
+ s3PostPolicyRequestId: s3_upload_policy_request
305
+ singleFile: true
306
+ accept: image/*
307
+ button:
308
+ icon: AiOutlineCamera
309
+ title: Choose Photo
310
+ type: default
311
+ label:
312
+ colon: false
313
+ extra: Upload a JPG, PNG, or GIF image.
314
+ - id: profile_display_name
315
+ type: TextInput
316
+ required: true
317
+ properties:
318
+ title: Display Name
319
+ prefixIcon: AiOutlineUser
320
+ placeholder: Enter your display name
321
+ label:
322
+ colon: false
323
+ - id: profile_update
324
+ type: Button
325
+ layout:
326
+ flex: 0 0 auto
327
+ properties:
328
+ title: Update Profile
329
+ color: primary
330
+ variant: solid
331
+ icon: AiOutlineCheck
332
+ events:
333
+ onClick:
334
+ - id: update_validate
335
+ type: Validate
336
+ - id: update_msg
337
+ type: DisplayMessage
338
+ params:
339
+ content: Profile updated successfully!
340
+ status: success
341
+ ```
342
+
343
+ | Property | Type | Default | Description |
344
+ | --- | --- | --- | --- |
345
+ | `accept` | string | - | File types accepted by the input. See html file type input accept property at https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept. |
346
+ | `button` | object | `{"icon":"UploadOutlined","title":"Upload","type":"default"}` | Button block properties. See [Button](/Button) for all properties. |
347
+ | `button.title` | string | - | Button title text. |
348
+ | `button.icon` | string \| object | - | Button icon name or Icon block properties. |
349
+ | `button.type` | string | `"default"` | Button type. Enum: `default`, `primary`, `dashed`, `text`, `link`. |
350
+ | `button.danger` | boolean | `false` | Set button style to danger. |
351
+ | `button.disabled` | boolean | `false` | Disable the button. |
352
+ | `button.size` | string | `"default"` | Button size. Enum: `small`, `default`, `large`. |
353
+ | `disabled` | boolean | - | Disable the file input. |
354
+ | `maxCount` | number | - | Maximum number of files that can be uploaded. |
355
+ | `s3PostPolicyRequestId` | string | - | Id of a request of type AwsS3PresignedPostPolicy that defines to which S3 bucket and how the file should be uploaded. |
356
+ | `showUploadList` | boolean | `true` | Whether to show default upload list. |
357
+ | `singleFile` | boolean | `false` | Only allow a single file to be uploaded. Only one file can be selected in the prompt. |
358
+ | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/upload#design-token). See [Ant Design upload tokens](https://ant.design/components/upload#design-token). |
359
+ | `theme.actionsColor` | string | - | Color of action icons (download, preview, remove). |
360
+ | `theme.pictureCardSize` | number | - | Size of list items in card type (affects both picture-card and picture-circle). |
361
+ | `theme.controlItemBgHover` | string | - | Background color of file item on hover. |
362
+ | `theme.colorIcon` | string | - | Color of file icons. |
363
+ | `theme.fontSize` | number | - | Font size of file name text. |
364
+ | `theme.borderRadiusSM` | number | - | Border radius of file list items. |
365
+
366
+ | Event | Event Data | Description |
367
+ | --- | --- | --- |
368
+ | `onBeforeUpload` | `{ file }` | Triggered before a file is uploaded. If an action throws, the upload is cancelled. |
369
+ | `onChange` | \- | Triggered when the upload state is changing. |
370
+ | `onProgress` | `{ file, fileList }` | Triggered when the upload state is in progress. |
371
+ | `onSuccess` | `{ file, fileList }` | Triggered when the upload state is done uploading. |
372
+ | `onRemove` | `{ file, fileList }` | Triggered when the upload has been removed. |
373
+ | `onError` | `{ file, fileList }` | Triggered when the upload has failed. |
374
+ | `onClick` | \- | Triggered when the upload button is clicked. |
375
+
376
+ | Key | Target |
377
+ | --- | --- |
378
+ | `/block` | Outer block wrapper (always available). |
379
+ | `/element` | The outer block wrapper around the upload button and list. |
380
+ | `/trigger` | The antd upload trigger (.ant-upload-select) that wraps the button. |
381
+ | `/list` | The uploaded file list container. |
382
+ | `/item` | Each uploaded file row in the list. |
383
+
384
+ No slots defined.
@@ -0,0 +1,305 @@
1
+ # S3UploadDragger
2
+
3
+ __Deprecated__ — use the provider-neutral <a href="/UploadDragger">UploadDragger</a> block with `uploadPolicyRequestId` instead. S3UploadDragger remains as an alias so existing apps keep working. Drag-and-drop file upload area for AWS S3. Supports file type filtering, upload limits, custom drag zone styling, and paste-to-upload. Requires an `AwsS3PresignedPostPolicy` request to define the S3 upload policy.
4
+
5
+ > The S3UploadDragger requires an AwsS3Bucket connection and AwsS3PresignedPostPolicy request to upload files. The examples on this page demonstrate UI configuration only — uploads will not function without a configured S3 connection.
6
+
7
+ ```yaml
8
+ - id: basic_default
9
+ type: S3UploadDragger
10
+ properties:
11
+ s3PostPolicyRequestId: s3_upload_policy_request
12
+ - id: basic_custom_title
13
+ type: S3UploadDragger
14
+ properties:
15
+ s3PostPolicyRequestId: s3_upload_policy_request
16
+ title: Drop your files here
17
+ - id: basic_html_title
18
+ type: S3UploadDragger
19
+ properties:
20
+ s3PostPolicyRequestId: s3_upload_policy_request
21
+ title: <b>Upload</b> your <i>documents</i> here
22
+ ```
23
+
24
+ ```yaml
25
+ - id: accept_images
26
+ type: S3UploadDragger
27
+ properties:
28
+ s3PostPolicyRequestId: s3_upload_policy_request
29
+ title: Drag images here
30
+ accept: image/*
31
+ - id: accept_pdfs
32
+ type: S3UploadDragger
33
+ properties:
34
+ s3PostPolicyRequestId: s3_upload_policy_request
35
+ title: Drag PDF files here
36
+ accept: .pdf
37
+ - id: accept_specific
38
+ type: S3UploadDragger
39
+ properties:
40
+ s3PostPolicyRequestId: s3_upload_policy_request
41
+ title: Drag image files here (.jpg, .png, .gif)
42
+ accept: .jpg,.png,.gif
43
+ ```
44
+
45
+ ```yaml
46
+ - id: limit_single
47
+ type: S3UploadDragger
48
+ properties:
49
+ s3PostPolicyRequestId: s3_upload_policy_request
50
+ title: Upload a single file
51
+ singleFile: true
52
+ - id: limit_max_three
53
+ type: S3UploadDragger
54
+ properties:
55
+ s3PostPolicyRequestId: s3_upload_policy_request
56
+ title: Upload up to 3 files
57
+ maxCount: 3
58
+ - id: limit_single_images
59
+ type: S3UploadDragger
60
+ properties:
61
+ s3PostPolicyRequestId: s3_upload_policy_request
62
+ title: Upload a single image
63
+ singleFile: true
64
+ accept: image/*
65
+ ```
66
+
67
+ ```yaml
68
+ - id: style_light_blue
69
+ type: S3UploadDragger
70
+ properties:
71
+ s3PostPolicyRequestId: s3_upload_policy_request
72
+ title: Light blue background
73
+ style:
74
+ background: "#e6f7ff"
75
+ - id: style_dashed_border
76
+ type: S3UploadDragger
77
+ properties:
78
+ s3PostPolicyRequestId: s3_upload_policy_request
79
+ title: Dashed border style
80
+ style:
81
+ border: 2px dashed
82
+ borderRadius: 12
83
+ - id: style_large_padding
84
+ type: S3UploadDragger
85
+ properties:
86
+ s3PostPolicyRequestId: s3_upload_policy_request
87
+ title: Larger drop area with custom font
88
+ style:
89
+ padding: 40
90
+ fontSize: 18
91
+ ```
92
+
93
+ ```yaml
94
+ - id: disabled_default
95
+ type: S3UploadDragger
96
+ properties:
97
+ s3PostPolicyRequestId: s3_upload_policy_request
98
+ disabled: true
99
+ - id: disabled_custom_title
100
+ type: S3UploadDragger
101
+ properties:
102
+ s3PostPolicyRequestId: s3_upload_policy_request
103
+ disabled: true
104
+ title: Uploads are currently disabled
105
+ - id: disabled_hidden_list
106
+ type: S3UploadDragger
107
+ properties:
108
+ s3PostPolicyRequestId: s3_upload_policy_request
109
+ disabled: true
110
+ title: Disabled with hidden list
111
+ showUploadList: false
112
+ ```
113
+
114
+ ```yaml
115
+ - id: list_visible
116
+ type: S3UploadDragger
117
+ properties:
118
+ s3PostPolicyRequestId: s3_upload_policy_request
119
+ title: Upload list visible (default)
120
+ showUploadList: true
121
+ - id: list_hidden
122
+ type: S3UploadDragger
123
+ properties:
124
+ s3PostPolicyRequestId: s3_upload_policy_request
125
+ title: Upload list hidden
126
+ showUploadList: false
127
+ - id: list_single_hidden
128
+ type: S3UploadDragger
129
+ properties:
130
+ s3PostPolicyRequestId: s3_upload_policy_request
131
+ title: Single file, list hidden
132
+ singleFile: true
133
+ showUploadList: false
134
+ ```
135
+
136
+ ```yaml
137
+ - id: style_element_bg
138
+ type: S3UploadDragger
139
+ style:
140
+ .element:
141
+ background: "#f6ffed"
142
+ borderRadius: 12
143
+ padding: 8
144
+ properties:
145
+ s3PostPolicyRequestId: s3_upload_policy_request
146
+ title: Custom element background
147
+ - id: style_element_border
148
+ type: S3UploadDragger
149
+ style:
150
+ .element:
151
+ border: 2px solid
152
+ boxShadow: 0 2px 8px rgba(0,0,0,0.1)
153
+ properties:
154
+ s3PostPolicyRequestId: s3_upload_policy_request
155
+ title: Styled with border and shadow
156
+ - id: style_class_tailwind
157
+ type: S3UploadDragger
158
+ class: rounded-xl shadow-md
159
+ properties:
160
+ s3PostPolicyRequestId: s3_upload_policy_request
161
+ title: Tailwind rounded with shadow
162
+ ```
163
+
164
+ ```yaml
165
+ - id: submission_card
166
+ type: Card
167
+ properties:
168
+ title: Submit Files
169
+ size: small
170
+ blocks:
171
+ - id: submission_description
172
+ type: TextInput
173
+ required: true
174
+ properties:
175
+ label:
176
+ title: File Description
177
+ placeholder: Describe the file you are uploading
178
+ - id: submission_category
179
+ type: Selector
180
+ required: true
181
+ properties:
182
+ label:
183
+ title: File Category
184
+ placeholder: Select a category
185
+ options:
186
+ - label: Documents
187
+ value: documents
188
+ - label: Images
189
+ value: images
190
+ - label: Spreadsheets
191
+ value: spreadsheets
192
+ - label: Other
193
+ value: other
194
+ - id: submission_upload
195
+ type: S3UploadDragger
196
+ properties:
197
+ s3PostPolicyRequestId: s3_upload_policy_request
198
+ title: Drag files here or click to browse
199
+ accept: .pdf,.docx,.xlsx,.png,.jpg
200
+ - id: submission_actions
201
+ type: Box
202
+ layout:
203
+ justify: flex-end
204
+ blocks:
205
+ - id: submission_submit
206
+ type: Button
207
+ layout:
208
+ flex: 0 0 auto
209
+ properties:
210
+ title: Submit
211
+ color: primary
212
+ variant: solid
213
+ icon: AiOutlineUpload
214
+ events:
215
+ onClick:
216
+ - id: submit_validate
217
+ type: Validate
218
+ - id: submit_msg
219
+ type: DisplayMessage
220
+ params:
221
+ content: Files submitted successfully!
222
+ status: success
223
+ ```
224
+
225
+ ```yaml
226
+ - id: gallery_card
227
+ type: Card
228
+ properties:
229
+ title: Upload Photos
230
+ size: small
231
+ blocks:
232
+ - id: gallery_album_name
233
+ type: TextInput
234
+ required: true
235
+ properties:
236
+ label:
237
+ title: Album Name
238
+ placeholder: Enter album name
239
+ - id: gallery_upload
240
+ type: S3UploadDragger
241
+ properties:
242
+ s3PostPolicyRequestId: s3_upload_policy_request
243
+ title: Drag photos here or click to browse
244
+ accept: image/*
245
+ maxCount: 10
246
+ - id: gallery_actions
247
+ type: Box
248
+ layout:
249
+ justify: flex-end
250
+ blocks:
251
+ - id: gallery_submit
252
+ type: Button
253
+ layout:
254
+ flex: 0 0 auto
255
+ properties:
256
+ title: Upload Photos
257
+ color: primary
258
+ variant: solid
259
+ icon: AiOutlineCloudUpload
260
+ events:
261
+ onClick:
262
+ - id: gallery_msg
263
+ type: DisplayMessage
264
+ params:
265
+ content: Photos uploaded to album!
266
+ status: success
267
+ ```
268
+
269
+ | Property | Type | Default | Description |
270
+ | --- | --- | --- | --- |
271
+ | `height` | number \| string | - | Height of the dragger area. A number is applied in pixels; a string is passed through as a CSS length (e.g. "300px", "50vh"). Defaults to the antd `controlHeight` theme token. If `style.element.height` is set, it overrides this. |
272
+ | `title` | string | - | Title of the file input to be displayed on the draggable area. |
273
+ | `accept` | string | - | File types accepted by the input. See html file type input accept property at https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept. |
274
+ | `disabled` | boolean | - | Disable the file input. |
275
+ | `maxCount` | number | - | Maximum number of files that can be uploaded. |
276
+ | `s3PostPolicyRequestId` | string | - | Id of a request of type AwsS3PresignedPostPolicy that defines to which S3 bucket and how the file should be uploaded. |
277
+ | `showUploadList` | boolean | `true` | Whether to show default upload list. |
278
+ | `singleFile` | boolean | `false` | Only allow a single file to be uploaded. Only one file can be selected in the prompt. |
279
+ | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/upload#design-token). See [Ant Design upload tokens](https://ant.design/components/upload#design-token). |
280
+ | `theme.actionsColor` | string | - | Color of action icons (download, preview, remove). |
281
+ | `theme.pictureCardSize` | number | - | Size of list items in card type (affects both picture-card and picture-circle). |
282
+ | `theme.controlItemBgHover` | string | - | Background color of file item on hover. |
283
+ | `theme.colorIcon` | string | - | Color of file icons. |
284
+ | `theme.fontSize` | number | - | Font size of file name text. |
285
+ | `theme.borderRadiusSM` | number | - | Border radius of file list items. |
286
+
287
+ | Event | Event Data | Description |
288
+ | --- | --- | --- |
289
+ | `onBeforeUpload` | `{ file }` | Triggered before a file is uploaded. If an action throws, the upload is cancelled. |
290
+ | `onChange` | \- | Triggered when the upload state is changing. |
291
+ | `onProgress` | `{ file, fileList }` | Triggered when the upload state is in progress. |
292
+ | `onSuccess` | `{ file, fileList }` | Triggered when the upload state is done uploading. |
293
+ | `onRemove` | `{ file, fileList }` | Triggered when the upload has been removed. |
294
+ | `onError` | `{ file, fileList }` | Triggered when the upload has failed. |
295
+
296
+ | Key | Target |
297
+ | --- | --- |
298
+ | `/block` | Outer block wrapper (always available). |
299
+ | `/element` | The outer dragger box (height container, background, border, shadow). |
300
+ | `/hint` | The hint content shown inside the drop area. |
301
+ | `/trigger` | The antd drag surface (.ant-upload-drag). Target for hover/drag-hover border and background. |
302
+ | `/list` | The uploaded file list container. |
303
+ | `/item` | Each uploaded file row in the list. |
304
+
305
+ No slots defined.