@lowdefy/docs-content 6.1.0 → 7.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (284) hide show
  1. package/README.md +1 -0
  2. package/content/actions/downloadcsv.md +1 -1
  3. package/content/actions/emailotpsend.md +58 -0
  4. package/content/actions/emailotpverify.md +79 -0
  5. package/content/actions/getlocalstorage.md +43 -0
  6. package/content/actions/link.md +47 -1
  7. package/content/actions/login.md +25 -5
  8. package/content/actions/logout.md +7 -5
  9. package/content/actions/magiclinkverify.md +117 -0
  10. package/content/actions/pdfmake.md +2 -2
  11. package/content/actions/posthogalias.md +29 -0
  12. package/content/actions/posthogcapture.md +49 -0
  13. package/content/actions/posthogcapturepageleave.md +38 -0
  14. package/content/actions/posthogfeatureflag.md +50 -0
  15. package/content/actions/posthoggroup.md +37 -0
  16. package/content/actions/posthogidentify.md +54 -0
  17. package/content/actions/posthoginit.md +96 -0
  18. package/content/actions/posthogoptin.md +29 -0
  19. package/content/actions/posthogoptout.md +29 -0
  20. package/content/actions/posthogpageview.md +37 -0
  21. package/content/actions/posthogreloadfeatureflags.md +47 -0
  22. package/content/actions/posthogreset.md +28 -0
  23. package/content/actions/posthogsetpersonproperties.md +36 -0
  24. package/content/actions/removelocalstorage.md +28 -0
  25. package/content/actions/resetvalidation.md +7 -3
  26. package/content/actions/setdarkmode.md +3 -3
  27. package/content/actions/setglobal.md +2 -0
  28. package/content/actions/setlocale.md +1 -1
  29. package/content/actions/setlocalstorage.md +34 -0
  30. package/content/actions/validate.md +7 -4
  31. package/content/adapter-reference/mongodbauthadapter.md +46 -0
  32. package/content/agents/agent-endpoint-tools.md +24 -0
  33. package/content/agents/agent-properties.md +13 -3
  34. package/content/agents/agent-server-hooks.md +1 -1
  35. package/content/agents/agentchat.md +43 -7
  36. package/content/agents/agentconversations.md +42 -8
  37. package/content/agents/agents-introduction.md +107 -0
  38. package/content/callback-reference/auth0logoutcallback.md +54 -0
  39. package/content/concepts/ai-agent-docs.md +455 -106
  40. package/content/concepts/blocks.md +150 -0
  41. package/content/concepts/connections-and-requests.md +402 -0
  42. package/content/concepts/custom-html.md +42 -0
  43. package/content/concepts/custom-styling.md +50 -5
  44. package/content/concepts/dynamic-page-content.md +309 -0
  45. package/content/concepts/events-and-actions.md +154 -2
  46. package/content/concepts/four-primitives.md +31 -0
  47. package/content/concepts/html-attributes.md +293 -0
  48. package/content/concepts/i18n.md +8 -3
  49. package/content/concepts/keyboard-shortcuts.md +2 -2
  50. package/content/concepts/layout-overview.md +1 -1
  51. package/content/concepts/logger.md +99 -0
  52. package/content/concepts/lowdefy-api.md +1319 -0
  53. package/content/concepts/lowdefy-schema.md +136 -3
  54. package/content/concepts/menus.md +8 -7
  55. package/content/concepts/module-authoring.md +76 -5
  56. package/content/concepts/modules.md +3 -1
  57. package/content/concepts/notifications.md +180 -0
  58. package/content/concepts/operators.md +7 -0
  59. package/content/concepts/page-and-app-state.md +252 -0
  60. package/content/concepts/page-paths.md +209 -0
  61. package/content/concepts/theming.md +582 -0
  62. package/content/connections/aigateway.md +375 -0
  63. package/content/connections/anthropic.md +169 -2
  64. package/content/connections/awss3.md +178 -2
  65. package/content/connections/axioshttp.md +181 -0
  66. package/content/connections/google.md +169 -2
  67. package/content/connections/mongodb.md +1014 -3
  68. package/content/connections/openai-connection.md +169 -2
  69. package/content/connections/sendgridmail.md +2 -0
  70. package/content/connections/smtp.md +3 -1
  71. package/content/connections/treg.md +329 -0
  72. package/content/container-blocks/affix.md +47 -7
  73. package/content/container-blocks/alert.md +76 -24
  74. package/content/container-blocks/badge.md +100 -24
  75. package/content/container-blocks/box.md +9 -9
  76. package/content/container-blocks/card.md +132 -27
  77. package/content/container-blocks/carousel.md +60 -7
  78. package/content/container-blocks/collapse.md +153 -9
  79. package/content/container-blocks/configprovider.md +35 -13
  80. package/content/container-blocks/confirmmodal.md +69 -23
  81. package/content/container-blocks/content.md +62 -98
  82. package/content/container-blocks/descriptions.md +45 -4
  83. package/content/container-blocks/drawer.md +139 -28
  84. package/content/container-blocks/dropdownmenu.md +119 -31
  85. package/content/container-blocks/flex.md +40 -62
  86. package/content/container-blocks/footer.md +15 -11
  87. package/content/container-blocks/googlemapsheatmap.md +1 -1
  88. package/content/container-blocks/googlemapsscript.md +2 -2
  89. package/content/container-blocks/header.md +71 -36
  90. package/content/container-blocks/label.md +34 -7
  91. package/content/container-blocks/layout.md +52 -34
  92. package/content/container-blocks/masonry.md +17 -71
  93. package/content/container-blocks/mobilemenu.md +131 -88
  94. package/content/container-blocks/modal.md +161 -26
  95. package/content/container-blocks/pageheadermenu.md +138 -31
  96. package/content/container-blocks/pagesidebarlayout.md +230 -27
  97. package/content/container-blocks/pagesidermenu.md +153 -43
  98. package/content/container-blocks/popover.md +34 -31
  99. package/content/container-blocks/result.md +32 -21
  100. package/content/container-blocks/sider.md +85 -122
  101. package/content/container-blocks/span.md +7 -7
  102. package/content/container-blocks/spinner.md +3 -3
  103. package/content/container-blocks/splitter.md +150 -68
  104. package/content/container-blocks/tabs.md +64 -12
  105. package/content/container-blocks/tooltip.md +22 -46
  106. package/content/container-blocks/watermark.md +22 -4
  107. package/content/controls/parallel_for.md +21 -2
  108. package/content/controls/reject.md +24 -3
  109. package/content/controls/return.md +17 -1
  110. package/content/controls/throw.md +1 -0
  111. package/content/controls/try.md +4 -2
  112. package/content/controls/while.md +46 -0
  113. package/content/deployment/deployment-environments.md +10 -7
  114. package/content/deployment/docker.md +22 -7
  115. package/content/deployment/node-server.md +4 -0
  116. package/content/deployment/vercel.md +17 -6
  117. package/content/display-blocks/aggrid.md +36 -19
  118. package/content/display-blocks/anchor.md +16 -15
  119. package/content/display-blocks/avatar.md +57 -37
  120. package/content/display-blocks/breadcrumb.md +70 -21
  121. package/content/display-blocks/button.md +93 -19
  122. package/content/display-blocks/calendar.md +12 -0
  123. package/content/display-blocks/clickablehtml.md +239 -0
  124. package/content/display-blocks/dangeroushtml.md +1 -1
  125. package/content/display-blocks/difflist.md +1 -1
  126. package/content/display-blocks/difftimeline.md +1 -1
  127. package/content/display-blocks/divider.md +64 -3
  128. package/content/display-blocks/dropdownbutton.md +81 -30
  129. package/content/display-blocks/echart.md +35 -1
  130. package/content/display-blocks/eventlog.md +363 -0
  131. package/content/display-blocks/floatbutton.md +129 -42
  132. package/content/display-blocks/html.md +61 -1
  133. package/content/display-blocks/icon.md +250 -67
  134. package/content/display-blocks/img.md +2 -2
  135. package/content/display-blocks/menu.md +146 -73
  136. package/content/display-blocks/message.md +38 -124
  137. package/content/display-blocks/notification.md +94 -222
  138. package/content/display-blocks/paragraph.md +59 -9
  139. package/content/display-blocks/pollingtimer.md +263 -0
  140. package/content/display-blocks/progress.md +96 -17
  141. package/content/display-blocks/qrcode.md +19 -4
  142. package/content/display-blocks/s3download.md +1 -1
  143. package/content/display-blocks/search.md +19 -9
  144. package/content/display-blocks/skeletonbutton.md +1 -0
  145. package/content/display-blocks/skeletoninput.md +1 -0
  146. package/content/display-blocks/statistic.md +75 -17
  147. package/content/display-blocks/steps.md +58 -25
  148. package/content/display-blocks/table.md +2527 -0
  149. package/content/display-blocks/tablelight.md +621 -0
  150. package/content/display-blocks/tag.md +102 -17
  151. package/content/display-blocks/title.md +50 -11
  152. package/content/display-blocks/tour.md +33 -23
  153. package/content/input-blocks/autocomplete.md +81 -9
  154. package/content/input-blocks/buttonselector.md +45 -8
  155. package/content/input-blocks/captcha.md +40 -0
  156. package/content/input-blocks/checkboxselector.md +97 -7
  157. package/content/input-blocks/checkboxswitch.md +33 -3
  158. package/content/input-blocks/colorselector.md +63 -14
  159. package/content/input-blocks/daterangeselector.md +165 -45
  160. package/content/input-blocks/dateselector.md +139 -41
  161. package/content/input-blocks/datetimeselector.md +158 -49
  162. package/content/input-blocks/inputgallery.md +3 -3
  163. package/content/input-blocks/intentinput.md +207 -0
  164. package/content/input-blocks/monthselector.md +120 -52
  165. package/content/input-blocks/multipleselector.md +150 -39
  166. package/content/input-blocks/numberinput.md +98 -12
  167. package/content/input-blocks/pagination.md +70 -14
  168. package/content/input-blocks/paragraphinput.md +51 -37
  169. package/content/input-blocks/passwordinput.md +60 -6
  170. package/content/input-blocks/phonenumberinput.md +59 -26
  171. package/content/input-blocks/placesautocomplete.md +319 -0
  172. package/content/input-blocks/radioselector.md +83 -7
  173. package/content/input-blocks/ratingslider.md +57 -26
  174. package/content/input-blocks/s3uploadbutton.md +24 -24
  175. package/content/input-blocks/s3uploaddragger.md +3 -3
  176. package/content/input-blocks/s3uploadphoto.md +5 -5
  177. package/content/input-blocks/segmentedselector.md +72 -32
  178. package/content/input-blocks/selector.md +109 -21
  179. package/content/input-blocks/switch.md +65 -17
  180. package/content/input-blocks/tableinput.md +445 -0
  181. package/content/input-blocks/tagmultipleselector.md +114 -0
  182. package/content/input-blocks/tagselector.md +114 -0
  183. package/content/input-blocks/textarea.md +32 -3
  184. package/content/input-blocks/textinput.md +70 -29
  185. package/content/input-blocks/tiptapinput.md +1 -1
  186. package/content/input-blocks/tiptapmentioninput.md +2 -2
  187. package/content/input-blocks/titleinput.md +39 -12
  188. package/content/input-blocks/treeinput.md +49 -25
  189. package/content/input-blocks/treemultipleselector.md +127 -10
  190. package/content/input-blocks/treeselector.md +97 -9
  191. package/content/input-blocks/upload.md +64 -15
  192. package/content/input-blocks/uploaddragger.md +17 -1
  193. package/content/input-blocks/uploadphoto.md +18 -1
  194. package/content/input-blocks/weekselector.md +120 -55
  195. package/content/learn/introduction.md +27 -0
  196. package/content/learn/quickstart.md +53 -0
  197. package/content/list-blocks/controlledlist.md +24 -15
  198. package/content/list-blocks/list.md +11 -11
  199. package/content/list-blocks/masonrylist.md +7 -34
  200. package/content/migration/auth-upgrade.md +337 -0
  201. package/content/migration/upgrade-guide.md +1 -0
  202. package/content/migration/v3-to-v4.md +417 -0
  203. package/content/migration/v6-to-v7.md +620 -0
  204. package/content/operators/_agent.md +155 -0
  205. package/content/operators/_app.md +2 -1
  206. package/content/operators/_array.md +122 -1
  207. package/content/operators/_build.md +1 -0
  208. package/content/operators/_credential.md +57 -0
  209. package/content/operators/_cron.md +292 -0
  210. package/content/operators/_date.md +2 -0
  211. package/content/operators/_error.md +24 -1
  212. package/content/operators/_get.md +6 -6
  213. package/content/operators/_hmac.md +78 -0
  214. package/content/operators/_js.md +2 -1
  215. package/content/operators/_location.md +1 -1
  216. package/content/operators/_media.md +13 -0
  217. package/content/operators/_module.md +56 -2
  218. package/content/operators/_operator.md +17 -3
  219. package/content/operators/_path_params.md +82 -0
  220. package/content/operators/_ref.md +258 -0
  221. package/content/operators/_request.md +1 -1
  222. package/content/operators/_request_details.md +6 -0
  223. package/content/operators/_type.md +14 -3
  224. package/content/operators/_url_query.md +2 -0
  225. package/content/operators/_user.md +3 -3
  226. package/content/plugins/plugins-actions.md +10 -0
  227. package/content/plugins/plugins-connections.md +25 -0
  228. package/content/plugins/plugins-dev.md +66 -0
  229. package/content/plugins/plugins-icon-sets.md +267 -0
  230. package/content/plugins/plugins-introduction.md +27 -1
  231. package/content/plugins/plugins.md +19 -0
  232. package/content/plugins/posthog.md +359 -0
  233. package/content/provider-reference/auth-js-providers.md +107 -0
  234. package/content/provider-reference/openidconnectprovider.md +44 -0
  235. package/content/recipes/recipes.md +16 -0
  236. package/content/reference/actions-reference.md +31 -0
  237. package/content/reference/blocks-reference.md +35 -0
  238. package/content/reference/cli.md +403 -0
  239. package/content/reference/connections-reference.md +23 -0
  240. package/content/reference/operators-reference.md +47 -0
  241. package/content/reference/reference.md +16 -0
  242. package/content/reference/schema-reference.md +12 -0
  243. package/content/testing/config-tests.md +677 -0
  244. package/content/testing/e2e-configuration.md +31 -1
  245. package/content/testing/e2e-getting-started.md +1 -1
  246. package/content/testing/e2e-introduction.md +1 -1
  247. package/content/testing/e2e-writing-tests.md +12 -1
  248. package/content/testing/explore-pull-request.md +136 -0
  249. package/content/testing/journey-data-sets.md +326 -0
  250. package/content/tutorial/tutorial-actions-operators.md +2 -2
  251. package/content/tutorial/tutorial-add-blocks.md +2 -2
  252. package/content/tutorial/tutorial-create-page.md +48 -2
  253. package/content/tutorial/tutorial-display-data-page.md +3 -3
  254. package/content/tutorial/tutorial-requests-api.md +155 -0
  255. package/content/tutorial/tutorial-requests-sql.md +153 -0
  256. package/content/tutorial/tutorial-start.md +66 -1
  257. package/content/user-authentication/auth-configuration.md +267 -0
  258. package/content/user-authentication/auth-providers.md +24 -0
  259. package/content/user-authentication/auth-steps.md +141 -0
  260. package/content/user-authentication/login-and-logout.md +160 -8
  261. package/content/user-authentication/mcp-oauth.md +424 -0
  262. package/content/user-authentication/organizations.md +246 -0
  263. package/content/user-authentication/protected-pages-apis.md +97 -0
  264. package/content/user-authentication/roles.md +49 -0
  265. package/content/user-authentication/two-factor.md +229 -0
  266. package/content/user-authentication/user-object.md +58 -0
  267. package/content/user-authentication/users-introduction.md +8 -0
  268. package/content/websockets/websocket-publish.md +105 -0
  269. package/content/websockets/websocket-subscriptions.md +136 -0
  270. package/content/websockets/websockets-introduction.md +101 -0
  271. package/hazards.json +44 -0
  272. package/index.json +3691 -14
  273. package/package.json +11 -1
  274. package/scripts/collectImportedFiles.js +80 -0
  275. package/scripts/extractAgentDocs.js +41 -30
  276. package/scripts/hashDocSources.js +38 -0
  277. package/scripts/isRedirectPage.js +26 -0
  278. package/scripts/recordSourceHashes.js +100 -0
  279. package/scripts/resolvePageSections.js +42 -0
  280. package/scripts/sectionKind.js +27 -0
  281. package/content/concepts/cli.md +0 -223
  282. package/content/other/introduction.md +0 -39
  283. package/content/other/next-auth-providers.md +0 -3
  284. /package/content/{other → actions}/updatesession.md +0 -0
@@ -33,6 +33,26 @@ Alert banner with type, description, icon, and closable options.
33
33
  type: error
34
34
  ```
35
35
 
36
+ > Backup completed
37
+
38
+ > Two invoices are overdue
39
+
40
+ ```yaml
41
+ - id: filled_success
42
+ type: Alert
43
+ properties:
44
+ message: Backup completed
45
+ type: success
46
+ variant: filled
47
+ - id: filled_warning
48
+ type: Alert
49
+ properties:
50
+ message: Two invoices are overdue
51
+ description: Send a reminder to the customer or mark the invoices as paid.
52
+ type: warning
53
+ variant: filled
54
+ ```
55
+
36
56
  > Payment Received
37
57
 
38
58
  > Scheduled Maintenance
@@ -186,6 +206,18 @@ Alert banner with type, description, icon, and closable options.
186
206
  closable: true
187
207
  ```
188
208
 
209
+ > Your session will expire in 5 minutes
210
+
211
+ ```yaml
212
+ - id: close_icon_circle
213
+ type: Alert
214
+ properties:
215
+ message: Your session will expire in 5 minutes
216
+ type: warning
217
+ closable: true
218
+ closeIcon: close-circle
219
+ ```
220
+
189
221
  > Cookie consent notice
190
222
 
191
223
  > New features available
@@ -253,25 +285,25 @@ Alert banner with type, description, icon, and closable options.
253
285
  properties:
254
286
  message: All tests passed
255
287
  type: success
256
- icon: AiOutlineCheckCircle
288
+ icon: check-circle
257
289
  - id: custom_icon_bell
258
290
  type: Alert
259
291
  properties:
260
292
  message: You have 3 new notifications
261
293
  type: info
262
- icon: AiOutlineBell
294
+ icon: bell
263
295
  - id: custom_icon_lock
264
296
  type: Alert
265
297
  properties:
266
298
  message: Your session has been locked for security
267
299
  type: warning
268
- icon: AiOutlineLock
300
+ icon: lock
269
301
  - id: custom_icon_bug
270
302
  type: Alert
271
303
  properties:
272
304
  message: Bug detected in module
273
305
  type: error
274
- icon: AiOutlineBug
306
+ icon: Bug
275
307
  - id: custom_icon_rocket
276
308
  type: Alert
277
309
  properties:
@@ -279,21 +311,21 @@ Alert banner with type, description, icon, and closable options.
279
311
  description: Your application is being deployed to the production environment.
280
312
  This usually takes 2-3 minutes.
281
313
  type: info
282
- icon: AiOutlineRocket
314
+ icon: Rocket
283
315
  - id: custom_icon_star
284
316
  type: Alert
285
317
  properties:
286
318
  message: You earned a new achievement
287
319
  description: Congratulations on completing your first project!
288
320
  type: success
289
- icon: AiOutlineStar
321
+ icon: star
290
322
  - id: custom_icon_object
291
323
  type: Alert
292
324
  properties:
293
325
  message: Custom styled icon
294
326
  type: info
295
327
  icon:
296
- name: AiOutlineThunderbolt
328
+ name: Zap
297
329
  color: "#faad14"
298
330
  - id: custom_icon_colored_obj
299
331
  type: Alert
@@ -302,7 +334,7 @@ Alert banner with type, description, icon, and closable options.
302
334
  description: No vulnerabilities were detected in your dependencies.
303
335
  type: success
304
336
  icon:
305
- name: AiOutlineSafety
337
+ name: Shield
306
338
  color: "#52c41a"
307
339
  ```
308
340
 
@@ -532,7 +564,7 @@ Alert banner with type, description, icon, and closable options.
532
564
  flex: 0 0 auto
533
565
  properties:
534
566
  title: Download
535
- icon: AiOutlineDownload
567
+ icon: download
536
568
  color: green
537
569
  variant: solid
538
570
  size: small
@@ -557,7 +589,7 @@ Alert banner with type, description, icon, and closable options.
557
589
  type: success
558
590
  closable: true
559
591
  closeText: OK
560
- icon: AiOutlineCloudUpload
592
+ icon: CloudUpload
561
593
  - id: combo_full_warning
562
594
  type: Alert
563
595
  properties:
@@ -566,7 +598,7 @@ Alert banner with type, description, icon, and closable options.
566
598
  requests). Consider implementing request caching.
567
599
  type: warning
568
600
  closable: true
569
- icon: AiOutlineApi
601
+ icon: Plug
570
602
  - id: combo_full_error
571
603
  type: Alert
572
604
  properties:
@@ -576,7 +608,7 @@ Alert banner with type, description, icon, and closable options.
576
608
  locked.
577
609
  type: error
578
610
  closable: true
579
- icon: AiOutlineWarning
611
+ icon: warning
580
612
  - id: combo_banner_closable_icon
581
613
  type: Alert
582
614
  properties:
@@ -584,7 +616,7 @@ Alert banner with type, description, icon, and closable options.
584
616
  type: info
585
617
  banner: true
586
618
  closable: true
587
- icon: AiOutlineExperiment
619
+ icon: FlaskConical
588
620
  - id: combo_noicon_closable_desc
589
621
  type: Alert
590
622
  properties:
@@ -765,7 +797,7 @@ Alert banner with type, description, icon, and closable options.
765
797
  description: <ul><li>Email address is required</li><li>Password must be at least
766
798
  8 characters</li><li>Please agree to the terms of service</li></ul>
767
799
  type: error
768
- icon: AiOutlineExclamationCircle
800
+ icon: CircleAlert
769
801
  - id: real_onboarding
770
802
  type: Alert
771
803
  properties:
@@ -774,7 +806,7 @@ Alert banner with type, description, icon, and closable options.
774
806
  members from the Settings page.
775
807
  type: info
776
808
  closable: true
777
- icon: AiOutlineSmile
809
+ icon: FaceSlightlySmiling
778
810
  slots:
779
811
  action:
780
812
  blocks:
@@ -787,7 +819,7 @@ Alert banner with type, description, icon, and closable options.
787
819
  color: primary
788
820
  variant: solid
789
821
  size: small
790
- icon: AiOutlinePlus
822
+ icon: add
791
823
  - id: real_deprecation
792
824
  type: Alert
793
825
  properties:
@@ -798,7 +830,7 @@ Alert banner with type, description, icon, and closable options.
798
830
  type: warning
799
831
  closable: true
800
832
  closeText: Acknowledged
801
- icon: AiOutlineClockCircle
833
+ icon: clock
802
834
  - id: real_maintenance
803
835
  type: Alert
804
836
  properties:
@@ -815,7 +847,7 @@ Alert banner with type, description, icon, and closable options.
815
847
  description: "Application <b>my-app</b> has been deployed to
816
848
  <code>production</code> environment. Build #1847 completed in 2m 34s."
817
849
  type: success
818
- icon: AiOutlineCheckCircle
850
+ icon: check-circle
819
851
  slots:
820
852
  action:
821
853
  blocks:
@@ -842,7 +874,7 @@ Alert banner with type, description, icon, and closable options.
842
874
  color: green
843
875
  variant: solid
844
876
  size: small
845
- icon: AiOutlineLink
877
+ icon: link
846
878
  - id: real_quota_warning
847
879
  type: Alert
848
880
  properties:
@@ -851,7 +883,7 @@ Alert banner with type, description, icon, and closable options.
851
883
  Current usage: 18.4 / 20 vCPUs. Consider scaling your plan or optimizing
852
884
  workloads."
853
885
  type: warning
854
- icon: AiOutlineDashboard
886
+ icon: Gauge
855
887
  slots:
856
888
  action:
857
889
  blocks:
@@ -871,7 +903,7 @@ Alert banner with type, description, icon, and closable options.
871
903
  description: You do not have permission to view this resource. Contact your
872
904
  administrator to request access to the Analytics dashboard.
873
905
  type: error
874
- icon: AiOutlineStop
906
+ icon: Ban
875
907
  closable: true
876
908
  - id: real_feature_flag
877
909
  type: Alert
@@ -882,19 +914,39 @@ Alert banner with type, description, icon, and closable options.
882
914
  type: info
883
915
  closable: true
884
916
  closeText: Understood
885
- icon: AiOutlineExperiment
917
+ icon: FlaskConical
886
918
  ```
887
919
 
888
920
  | Property | Type | Default | Description |
889
921
  | --- | --- | --- | --- |
890
922
  | `banner` | boolean | `false` | Style as banner at top of application window. |
891
923
  | `closable` | boolean | `false` | Allow alert to be closed. |
892
- | `closeText` | string | - | Close text to show. |
924
+ | `closeIcon` | string \| object | - | Icon name (a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`) or properties of an Icon block to customize the close icon of a closable alert. |
925
+ | `closeIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
926
+ | `closeIcon.color` | string | - | Icon color. |
927
+ | `closeIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
928
+ | `closeIcon.rotate` | number | - | Number of degrees to rotate the icon. |
929
+ | `closeIcon.spin` | boolean | - | Continuously spin the icon with animation. |
930
+ | `closeIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
931
+ | `closeIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
932
+ | `closeIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
933
+ | `closeIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
934
+ | `closeText` | string | - | Close text to show instead of the close icon. Makes the alert closable. |
893
935
  | `description` | string | - | Content description of alert - supports html. |
894
- | `icon` | string \| object | - | Name of an Ant Design Icon or properties of an Icon block to customize alert icon. |
936
+ | `icon` | string \| object | - | Icon name (a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`) or properties of an Icon block to customize alert icon. |
937
+ | `icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
938
+ | `icon.color` | string | - | Icon color. |
939
+ | `icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
940
+ | `icon.rotate` | number | - | Number of degrees to rotate the icon. |
941
+ | `icon.spin` | boolean | - | Continuously spin the icon with animation. |
942
+ | `icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
943
+ | `icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
944
+ | `icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
945
+ | `icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
895
946
  | `message` | string | - | Content message of alert - supports html. |
896
947
  | `showIcon` | boolean | `true` | Show type default icon. |
897
948
  | `type` | string | `"info"` | Alert style type. Enum: `success`, `info`, `warning`, `error`. |
949
+ | `variant` | string | `"outlined"` | Alert style variant. `filled` hides the border and keeps the background tint. Enum: `outlined`, `filled`. |
898
950
  | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design alert tokens](https://ant.design/components/alert#design-token). |
899
951
  | `theme.defaultPadding` | string | `"8px 12px"` | Default padding for the alert without description. |
900
952
  | `theme.withDescriptionPadding` | string | `"20px 24px"` | Padding for the alert when a description is present. |
@@ -104,7 +104,7 @@ U
104
104
  - id: dot_on_icon_avatar_child
105
105
  type: Avatar
106
106
  properties:
107
- icon: AiOutlineBell
107
+ icon: bell
108
108
  shape: square
109
109
  - id: dot_on_button
110
110
  type: Badge
@@ -483,7 +483,7 @@ U
483
483
  layout:
484
484
  flex: 0 0 auto
485
485
  properties:
486
- icon: AiOutlineBell
486
+ icon: bell
487
487
  blocks:
488
488
  - id: icon_bell_child
489
489
  type: Avatar
@@ -496,7 +496,7 @@ U
496
496
  flex: 0 0 auto
497
497
  properties:
498
498
  icon:
499
- name: AiOutlineClockCircle
499
+ name: clock
500
500
  color: "#1677ff"
501
501
  blocks:
502
502
  - id: icon_clock_child
@@ -510,7 +510,7 @@ U
510
510
  flex: 0 0 auto
511
511
  properties:
512
512
  icon:
513
- name: AiOutlineExclamation
513
+ name: CircleAlert
514
514
  color: "#faad14"
515
515
  blocks:
516
516
  - id: icon_exclamation_child
@@ -573,6 +573,8 @@ U
573
573
 
574
574
  U
575
575
 
576
+ N
577
+
576
578
  ```yaml
577
579
  - id: title_tooltip
578
580
  type: Badge
@@ -599,7 +601,20 @@ U
599
601
  type: Avatar
600
602
  properties:
601
603
  shape: square
602
- icon: AiOutlineUser
604
+ icon: user
605
+ - id: title_tooltip_off
606
+ type: Badge
607
+ layout:
608
+ flex: 0 0 auto
609
+ properties:
610
+ count: 3
611
+ title: false
612
+ blocks:
613
+ - id: title_tooltip_off_child
614
+ type: Avatar
615
+ properties:
616
+ shape: square
617
+ content: N
603
618
  ```
604
619
 
605
620
  JD
@@ -640,7 +655,7 @@ JD
640
655
  - id: wrap_icon_bell_child
641
656
  type: Icon
642
657
  properties:
643
- name: AiOutlineBell
658
+ name: bell
644
659
  size: 24
645
660
  - id: wrap_icon_mail
646
661
  type: Badge
@@ -652,10 +667,58 @@ JD
652
667
  - id: wrap_icon_mail_child
653
668
  type: Icon
654
669
  properties:
655
- name: AiOutlineMail
670
+ name: mail
656
671
  size: 24
657
672
  ```
658
673
 
674
+ Up to 20 members, shared workspaces and priority support.
675
+
676
+ Pay yearly and save on every seat.
677
+
678
+ ```yaml
679
+ - id: ribbon_row
680
+ type: Box
681
+ layout:
682
+ gap: 24
683
+ blocks:
684
+ - id: ribbon_recommended
685
+ type: Badge
686
+ layout:
687
+ span: 12
688
+ properties:
689
+ ribbon:
690
+ text: Recommended
691
+ blocks:
692
+ - id: ribbon_recommended_card
693
+ type: Card
694
+ properties:
695
+ title: Team plan
696
+ blocks:
697
+ - id: ribbon_recommended_text
698
+ type: Paragraph
699
+ properties:
700
+ content: Up to 20 members, shared workspaces and priority support.
701
+ - id: ribbon_sale
702
+ type: Badge
703
+ layout:
704
+ span: 12
705
+ properties:
706
+ ribbon:
707
+ text: 20% off
708
+ color: volcano
709
+ placement: start
710
+ blocks:
711
+ - id: ribbon_sale_card
712
+ type: Card
713
+ properties:
714
+ title: Annual billing
715
+ blocks:
716
+ - id: ribbon_sale_text
717
+ type: Paragraph
718
+ properties:
719
+ content: Pay yearly and save on every seat.
720
+ ```
721
+
659
722
  U
660
723
 
661
724
  U
@@ -671,7 +734,7 @@ U
671
734
  count: 5
672
735
  style:
673
736
  .indicator:
674
- boxShadow: 0 0 0 2px
737
+ boxShadow: "0 0 0 2px #1677ff"
675
738
  blocks:
676
739
  - id: css_indicator_shadow_child
677
740
  type: Avatar
@@ -722,7 +785,7 @@ Inbox
722
785
  - id: tw_element_margin
723
786
  type: Badge
724
787
  class:
725
- element: mr-8
788
+ .element: mr-8
726
789
  layout:
727
790
  flex: 0 0 auto
728
791
  properties:
@@ -736,7 +799,7 @@ Inbox
736
799
  - id: tw_indicator_animate
737
800
  type: Badge
738
801
  class:
739
- indicator: animate-bounce
802
+ .indicator: animate-bounce
740
803
  layout:
741
804
  flex: 0 0 auto
742
805
  properties:
@@ -750,7 +813,7 @@ Inbox
750
813
  - id: tw_badge_in_box
751
814
  type: Badge
752
815
  class:
753
- element: p-1
816
+ .element: p-1
754
817
  layout:
755
818
  flex: 0 0 auto
756
819
  properties:
@@ -888,7 +951,7 @@ JD
888
951
  flex: 1 1 0
889
952
  properties:
890
953
  placeholder: Search...
891
- prefixIcon: AiOutlineSearch
954
+ prefixIcon: search
892
955
  - id: rw_notif_badge_mail
893
956
  type: Badge
894
957
  layout:
@@ -900,7 +963,7 @@ JD
900
963
  - id: rw_notif_mail_btn
901
964
  type: Button
902
965
  properties:
903
- icon: AiOutlineMail
966
+ icon: mail
904
967
  color: default
905
968
  variant: text
906
969
  hideTitle: true
@@ -921,7 +984,7 @@ JD
921
984
  - id: rw_notif_bell_btn
922
985
  type: Button
923
986
  properties:
924
- icon: AiOutlineBell
987
+ icon: bell
925
988
  color: default
926
989
  variant: text
927
990
  hideTitle: true
@@ -938,8 +1001,7 @@ JD
938
1001
  flex: 0 0 auto
939
1002
  properties:
940
1003
  content: JD
941
- color: "#fff"
942
- backgroundColor: "#1677ff"
1004
+ color: "#1677ff"
943
1005
  ```
944
1006
 
945
1007
  #ORD-1042
@@ -1102,7 +1164,7 @@ James Wilson
1102
1164
  class: justify-start w-full
1103
1165
  properties:
1104
1166
  title: Inbox
1105
- icon: AiOutlineInbox
1167
+ icon: Inbox
1106
1168
  color: primary
1107
1169
  variant: text
1108
1170
  events:
@@ -1126,7 +1188,7 @@ James Wilson
1126
1188
  class: justify-start w-full
1127
1189
  properties:
1128
1190
  title: Alerts
1129
- icon: AiOutlineAlert
1191
+ icon: Siren
1130
1192
  color: default
1131
1193
  variant: text
1132
1194
  events:
@@ -1149,7 +1211,7 @@ James Wilson
1149
1211
  class: justify-start w-full
1150
1212
  properties:
1151
1213
  title: Tasks
1152
- icon: AiOutlineCheckSquare
1214
+ icon: SquareCheck
1153
1215
  color: default
1154
1216
  variant: text
1155
1217
  events:
@@ -1170,7 +1232,7 @@ James Wilson
1170
1232
  class: justify-start w-full
1171
1233
  properties:
1172
1234
  title: Settings
1173
- icon: AiOutlineSetting
1235
+ icon: settings
1174
1236
  color: default
1175
1237
  variant: text
1176
1238
  events:
@@ -1187,13 +1249,26 @@ James Wilson
1187
1249
  | `count` | number \| string | - | Text to show in badge. |
1188
1250
  | `dot` | boolean | `false` | Whether to display a red dot instead of count. |
1189
1251
  | `size` | string | `"default"` | Sets the size of badge if count is set. Enum: `default`, `small`. |
1190
- | `icon` | string \| object | - | Name of an React-Icon (See all icons) or properties of an Icon block to use an icon in badge. |
1252
+ | `icon` | string \| object | - | Icon name (a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`) or properties of an Icon block to use an icon in badge. |
1253
+ | `icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
1254
+ | `icon.color` | string | - | Icon color. |
1255
+ | `icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
1256
+ | `icon.rotate` | number | - | Number of degrees to rotate the icon. |
1257
+ | `icon.spin` | boolean | - | Continuously spin the icon with animation. |
1258
+ | `icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
1259
+ | `icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
1260
+ | `icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
1261
+ | `icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
1191
1262
  | `offset` | array | - | Set offset of the badge dot, array of numbers for x and y offset ([x,y]). |
1192
1263
  | `overflowCount` | number | `99` | Max count to show |
1193
1264
  | `showZero` | boolean | `false` | Whether to show badge when count is zero. |
1194
1265
  | `status` | string | `null` | Set Badge as a status dot. Enum: `success`, `processing`, `default`, `error`, `warning`. |
1195
1266
  | `text` | string | - | If status is set, text sets the display text of the status dot. |
1196
- | `title` | string | - | Text to show when hovering over the badge. |
1267
+ | `ribbon` | object | - | Render a ribbon on the corner of the content area instead of a count badge. Count, dot and status properties are ignored when ribbon is set. |
1268
+ | `ribbon.text` | string | - | Text inside the ribbon. |
1269
+ | `ribbon.color` | string | - | Ribbon color. A preset color name or any css color. |
1270
+ | `ribbon.placement` | string | `"end"` | Corner of the content the ribbon is placed on. `start` and `end` follow the text direction. Enum: `start`, `end`. |
1271
+ | `title` | string \| boolean | - | Text to show when hovering over the badge. Set to false to remove the native tooltip. |
1197
1272
  | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design badge tokens](https://ant.design/components/badge#design-token). |
1198
1273
  | `theme.indicatorHeight` | number | `20` | Height of the badge indicator. |
1199
1274
  | `theme.indicatorHeightSM` | number | `14` | Height of the badge indicator in small size. |
@@ -1201,6 +1276,7 @@ James Wilson
1201
1276
  | `theme.textFontSize` | number | `12` | Font size for badge count text. |
1202
1277
  | `theme.textFontSizeSM` | number | `12` | Font size for badge count text in small size. |
1203
1278
  | `theme.textFontWeight` | string | `"normal"` | Font weight for badge count text. |
1279
+ | `theme.paddingInline` | number \| string | `8` | Inline padding of a badge count with several characters. |
1204
1280
  | `theme.textLineHeight` | number | - | Line height for badge count text. |
1205
1281
  | `theme.statusSize` | number | `6` | Size of the status dot. |
1206
1282
  | `theme.indicatorZIndex` | number \| string | `"auto"` | Z-index of the badge indicator. |
@@ -1213,9 +1289,9 @@ No events defined.
1213
1289
  | Key | Target |
1214
1290
  | --- | --- |
1215
1291
  | `/block` | Outer block wrapper (always available). |
1216
- | `/element` | The Badge element. |
1292
+ | `/element` | The Badge element, or the ribbon wrapper when ribbon is set. |
1217
1293
  | `/icon` | The icon in the Badge. |
1218
- | `/indicator` | The Badge indicator. |
1294
+ | `/indicator` | The Badge count or dot indicator, or the ribbon when ribbon is set. |
1219
1295
 
1220
1296
  | Slot | Description |
1221
1297
  | --- | --- |
@@ -947,7 +947,7 @@ Fixed 100px
947
947
  layout:
948
948
  flex: 0 0 auto
949
949
  properties:
950
- name: AiOutlineRocket
950
+ name: Rocket
951
951
  size: 32
952
952
  color: "#1677ff"
953
953
  - id: box_feature_a_title
@@ -970,7 +970,7 @@ Fixed 100px
970
970
  layout:
971
971
  flex: 0 0 auto
972
972
  properties:
973
- name: AiOutlineSafety
973
+ name: Shield
974
974
  size: 32
975
975
  color: "#52c41a"
976
976
  - id: box_feature_b_title
@@ -993,7 +993,7 @@ Fixed 100px
993
993
  layout:
994
994
  flex: 0 0 auto
995
995
  properties:
996
- name: AiOutlineApi
996
+ name: Plug
997
997
  size: 32
998
998
  color: "#722ed1"
999
999
  - id: box_feature_c_title
@@ -1167,7 +1167,7 @@ Fixed 100px
1167
1167
  layout:
1168
1168
  flex: 0 0 auto
1169
1169
  properties:
1170
- name: AiOutlineCheckCircle
1170
+ name: check-circle
1171
1171
  size: 20
1172
1172
  color: "#52c41a"
1173
1173
  - id: box_inbox_item_1_body
@@ -1206,7 +1206,7 @@ Fixed 100px
1206
1206
  layout:
1207
1207
  flex: 0 0 auto
1208
1208
  properties:
1209
- name: AiOutlineUserAdd
1209
+ name: UserPlus
1210
1210
  size: 20
1211
1211
  color: "#1677ff"
1212
1212
  - id: box_inbox_item_2_body
@@ -1244,7 +1244,7 @@ Fixed 100px
1244
1244
  layout:
1245
1245
  flex: 0 0 auto
1246
1246
  properties:
1247
- name: AiOutlineWarning
1247
+ name: warning
1248
1248
  size: 20
1249
1249
  color: "#faad14"
1250
1250
  - id: box_inbox_item_3_body
@@ -1308,7 +1308,7 @@ Fixed 100px
1308
1308
  layout:
1309
1309
  flex: 0 0 auto
1310
1310
  properties:
1311
- name: AiOutlineDashboard
1311
+ name: Gauge
1312
1312
  size: 16
1313
1313
  color: "#1677ff"
1314
1314
  - id: box_sidebar_text_dashboard
@@ -1336,7 +1336,7 @@ Fixed 100px
1336
1336
  layout:
1337
1337
  flex: 0 0 auto
1338
1338
  properties:
1339
- name: AiOutlineProject
1339
+ name: SquareKanban
1340
1340
  size: 16
1341
1341
  color: rgba(128, 128, 128, 0.7)
1342
1342
  - id: box_sidebar_text_projects
@@ -1363,7 +1363,7 @@ Fixed 100px
1363
1363
  layout:
1364
1364
  flex: 0 0 auto
1365
1365
  properties:
1366
- name: AiOutlineSetting
1366
+ name: settings
1367
1367
  size: 16
1368
1368
  color: rgba(128, 128, 128, 0.7)
1369
1369
  - id: box_sidebar_text_settings