@lowdefy/docs-content 0.0.0-experimental-20260928120643 → 6.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 (226) hide show
  1. package/README.md +0 -1
  2. package/content/actions/link.md +0 -17
  3. package/content/actions/login.md +5 -23
  4. package/content/actions/logout.md +5 -5
  5. package/content/actions/pdfmake.md +2 -2
  6. package/content/actions/setdarkmode.md +2 -2
  7. package/content/agents/agent-properties.md +2 -4
  8. package/content/agents/agentchat.md +6 -21
  9. package/content/agents/agentconversations.md +2 -2
  10. package/content/concepts/ai-agent-docs.md +101 -313
  11. package/content/concepts/cli.md +3 -34
  12. package/content/concepts/connections-and-requests.md +0 -402
  13. package/content/concepts/custom-html.md +0 -40
  14. package/content/concepts/custom-styling.md +5 -50
  15. package/content/concepts/events-and-actions.md +2 -64
  16. package/content/concepts/i18n.md +2 -7
  17. package/content/concepts/keyboard-shortcuts.md +2 -2
  18. package/content/concepts/layout-overview.md +1 -1
  19. package/content/concepts/logger.md +0 -81
  20. package/content/concepts/lowdefy-schema.md +1 -4
  21. package/content/concepts/menus.md +7 -7
  22. package/content/concepts/module-authoring.md +2 -2
  23. package/content/connections/anthropic.md +2 -162
  24. package/content/connections/awss3.md +0 -54
  25. package/content/connections/google.md +2 -162
  26. package/content/connections/mongodb.md +3 -121
  27. package/content/connections/openai-connection.md +2 -162
  28. package/content/container-blocks/affix.md +7 -47
  29. package/content/container-blocks/alert.md +24 -76
  30. package/content/container-blocks/badge.md +24 -100
  31. package/content/container-blocks/box.md +9 -9
  32. package/content/container-blocks/card.md +25 -80
  33. package/content/container-blocks/carousel.md +7 -60
  34. package/content/container-blocks/collapse.md +9 -87
  35. package/content/container-blocks/configprovider.md +13 -35
  36. package/content/container-blocks/confirmmodal.md +23 -69
  37. package/content/container-blocks/content.md +98 -62
  38. package/content/container-blocks/descriptions.md +4 -45
  39. package/content/container-blocks/drawer.md +28 -92
  40. package/content/container-blocks/dropdownmenu.md +31 -119
  41. package/content/container-blocks/flex.md +62 -40
  42. package/content/container-blocks/footer.md +11 -15
  43. package/content/container-blocks/googlemapsheatmap.md +1 -1
  44. package/content/container-blocks/googlemapsscript.md +2 -2
  45. package/content/container-blocks/header.md +36 -71
  46. package/content/container-blocks/label.md +7 -34
  47. package/content/container-blocks/layout.md +34 -52
  48. package/content/container-blocks/masonry.md +71 -17
  49. package/content/container-blocks/mobilemenu.md +88 -131
  50. package/content/container-blocks/modal.md +26 -114
  51. package/content/container-blocks/pageheadermenu.md +31 -81
  52. package/content/container-blocks/pagesidebarlayout.md +26 -169
  53. package/content/container-blocks/pagesidermenu.md +42 -95
  54. package/content/container-blocks/popover.md +31 -34
  55. package/content/container-blocks/result.md +21 -32
  56. package/content/container-blocks/sider.md +122 -85
  57. package/content/container-blocks/span.md +7 -7
  58. package/content/container-blocks/spinner.md +3 -3
  59. package/content/container-blocks/splitter.md +68 -150
  60. package/content/container-blocks/tabs.md +12 -64
  61. package/content/container-blocks/tooltip.md +46 -22
  62. package/content/container-blocks/watermark.md +4 -22
  63. package/content/controls/reject.md +2 -4
  64. package/content/controls/throw.md +0 -1
  65. package/content/controls/try.md +2 -3
  66. package/content/deployment/deployment-environments.md +6 -8
  67. package/content/deployment/docker.md +7 -22
  68. package/content/deployment/node-server.md +0 -4
  69. package/content/deployment/vercel.md +6 -13
  70. package/content/display-blocks/aggrid.md +11 -26
  71. package/content/display-blocks/anchor.md +15 -15
  72. package/content/display-blocks/avatar.md +37 -57
  73. package/content/display-blocks/breadcrumb.md +21 -70
  74. package/content/display-blocks/button.md +18 -92
  75. package/content/display-blocks/calendar.md +0 -12
  76. package/content/display-blocks/dangeroushtml.md +1 -1
  77. package/content/display-blocks/difflist.md +1 -1
  78. package/content/display-blocks/difftimeline.md +1 -1
  79. package/content/display-blocks/divider.md +3 -64
  80. package/content/display-blocks/dropdownbutton.md +28 -79
  81. package/content/display-blocks/echart.md +1 -35
  82. package/content/display-blocks/floatbutton.md +42 -129
  83. package/content/display-blocks/html.md +1 -61
  84. package/content/display-blocks/icon.md +67 -250
  85. package/content/display-blocks/menu.md +73 -145
  86. package/content/display-blocks/message.md +124 -38
  87. package/content/display-blocks/notification.md +222 -94
  88. package/content/display-blocks/paragraph.md +9 -59
  89. package/content/display-blocks/progress.md +17 -96
  90. package/content/display-blocks/qrcode.md +4 -19
  91. package/content/display-blocks/s3download.md +1 -1
  92. package/content/display-blocks/search.md +7 -17
  93. package/content/display-blocks/skeletonbutton.md +0 -1
  94. package/content/display-blocks/skeletoninput.md +0 -1
  95. package/content/display-blocks/statistic.md +17 -75
  96. package/content/display-blocks/steps.md +25 -58
  97. package/content/display-blocks/tag.md +17 -102
  98. package/content/display-blocks/title.md +11 -50
  99. package/content/display-blocks/tour.md +23 -33
  100. package/content/input-blocks/autocomplete.md +9 -81
  101. package/content/input-blocks/buttonselector.md +8 -45
  102. package/content/input-blocks/checkboxselector.md +7 -97
  103. package/content/input-blocks/checkboxswitch.md +3 -33
  104. package/content/input-blocks/colorselector.md +14 -63
  105. package/content/input-blocks/daterangeselector.md +45 -165
  106. package/content/input-blocks/dateselector.md +41 -139
  107. package/content/input-blocks/datetimeselector.md +49 -158
  108. package/content/input-blocks/inputgallery.md +3 -3
  109. package/content/input-blocks/monthselector.md +52 -120
  110. package/content/input-blocks/multipleselector.md +39 -150
  111. package/content/input-blocks/numberinput.md +12 -98
  112. package/content/input-blocks/pagination.md +14 -70
  113. package/content/input-blocks/paragraphinput.md +37 -51
  114. package/content/input-blocks/passwordinput.md +6 -60
  115. package/content/input-blocks/phonenumberinput.md +26 -59
  116. package/content/input-blocks/radioselector.md +7 -83
  117. package/content/input-blocks/ratingslider.md +26 -57
  118. package/content/input-blocks/s3uploadbutton.md +24 -24
  119. package/content/input-blocks/s3uploaddragger.md +3 -3
  120. package/content/input-blocks/s3uploadphoto.md +5 -5
  121. package/content/input-blocks/segmentedselector.md +32 -72
  122. package/content/input-blocks/selector.md +21 -109
  123. package/content/input-blocks/switch.md +17 -65
  124. package/content/input-blocks/textarea.md +3 -32
  125. package/content/input-blocks/textinput.md +28 -69
  126. package/content/input-blocks/tiptapmentioninput.md +1 -1
  127. package/content/input-blocks/titleinput.md +12 -39
  128. package/content/input-blocks/treeinput.md +25 -49
  129. package/content/input-blocks/treemultipleselector.md +10 -127
  130. package/content/input-blocks/treeselector.md +9 -97
  131. package/content/input-blocks/upload.md +15 -64
  132. package/content/input-blocks/uploaddragger.md +1 -17
  133. package/content/input-blocks/uploadphoto.md +1 -18
  134. package/content/input-blocks/weekselector.md +55 -120
  135. package/content/list-blocks/controlledlist.md +15 -24
  136. package/content/list-blocks/list.md +11 -11
  137. package/content/list-blocks/masonrylist.md +34 -7
  138. package/content/migration/upgrade-guide.md +0 -1
  139. package/content/operators/_app.md +1 -2
  140. package/content/operators/_error.md +1 -23
  141. package/content/operators/_get.md +6 -6
  142. package/content/operators/_operator.md +3 -17
  143. package/content/operators/_ref.md +0 -258
  144. package/content/operators/_type.md +3 -14
  145. package/content/operators/_user.md +3 -3
  146. package/content/other/introduction.md +1 -1
  147. package/content/plugins/plugins-dev.md +0 -66
  148. package/content/plugins/plugins-introduction.md +1 -27
  149. package/content/testing/e2e-configuration.md +1 -8
  150. package/content/testing/e2e-getting-started.md +1 -1
  151. package/content/testing/e2e-introduction.md +1 -1
  152. package/content/tutorial/tutorial-actions-operators.md +2 -2
  153. package/content/tutorial/tutorial-add-blocks.md +2 -2
  154. package/content/tutorial/tutorial-create-page.md +2 -48
  155. package/content/tutorial/tutorial-display-data-page.md +3 -3
  156. package/content/tutorial/tutorial-requests-sql.md +0 -153
  157. package/content/tutorial/tutorial-start.md +1 -66
  158. package/content/user-authentication/login-and-logout.md +8 -158
  159. package/content/user-authentication/users-introduction.md +0 -8
  160. package/index.json +2 -6065
  161. package/package.json +1 -7
  162. package/scripts/extractAgentDocs.js +4 -36
  163. package/content/actions/emailotpsend.md +0 -58
  164. package/content/actions/emailotpverify.md +0 -77
  165. package/content/actions/getlocalstorage.md +0 -41
  166. package/content/actions/magiclinkverify.md +0 -113
  167. package/content/actions/posthogalias.md +0 -29
  168. package/content/actions/posthogcapture.md +0 -49
  169. package/content/actions/posthogcapturepageleave.md +0 -38
  170. package/content/actions/posthogfeatureflag.md +0 -50
  171. package/content/actions/posthoggroup.md +0 -37
  172. package/content/actions/posthogidentify.md +0 -54
  173. package/content/actions/posthoginit.md +0 -66
  174. package/content/actions/posthogoptin.md +0 -29
  175. package/content/actions/posthogoptout.md +0 -29
  176. package/content/actions/posthogpageview.md +0 -37
  177. package/content/actions/posthogreloadfeatureflags.md +0 -47
  178. package/content/actions/posthogreset.md +0 -28
  179. package/content/actions/posthogsetpersonproperties.md +0 -36
  180. package/content/actions/removelocalstorage.md +0 -26
  181. package/content/actions/setlocalstorage.md +0 -32
  182. package/content/adapter-reference/mongodbauthadapter.md +0 -46
  183. package/content/agents/agents-introduction.md +0 -107
  184. package/content/callback-reference/auth0logoutcallback.md +0 -54
  185. package/content/concepts/blocks.md +0 -150
  186. package/content/concepts/dynamic-page-content.md +0 -304
  187. package/content/concepts/html-attributes.md +0 -285
  188. package/content/concepts/lowdefy-api.md +0 -1110
  189. package/content/concepts/notifications.md +0 -155
  190. package/content/concepts/page-and-app-state.md +0 -244
  191. package/content/concepts/theming.md +0 -582
  192. package/content/connections/aigateway.md +0 -368
  193. package/content/connections/axioshttp.md +0 -181
  194. package/content/controls/while.md +0 -46
  195. package/content/display-blocks/clickablehtml.md +0 -239
  196. package/content/display-blocks/eventlog.md +0 -363
  197. package/content/display-blocks/pollingtimer.md +0 -263
  198. package/content/input-blocks/captcha.md +0 -40
  199. package/content/input-blocks/placesautocomplete.md +0 -319
  200. package/content/input-blocks/tagmultipleselector.md +0 -114
  201. package/content/input-blocks/tagselector.md +0 -114
  202. package/content/migration/auth-upgrade.md +0 -327
  203. package/content/migration/v3-to-v4.md +0 -417
  204. package/content/migration/v6-to-v7.md +0 -222
  205. package/content/operators/_cron.md +0 -292
  206. package/content/other/mongodbadapter.md +0 -3
  207. package/content/plugins/plugins-icon-sets.md +0 -267
  208. package/content/plugins/posthog.md +0 -275
  209. package/content/provider-reference/auth-js-providers.md +0 -107
  210. package/content/provider-reference/openidconnectprovider.md +0 -44
  211. package/content/testing/config-tests.md +0 -278
  212. package/content/tutorial/tutorial-requests-api.md +0 -155
  213. package/content/user-authentication/auth-configuration.md +0 -266
  214. package/content/user-authentication/auth-steps.md +0 -138
  215. package/content/user-authentication/mcp-oauth.md +0 -292
  216. package/content/user-authentication/organizations.md +0 -221
  217. package/content/user-authentication/protected-pages-apis.md +0 -97
  218. package/content/user-authentication/roles.md +0 -49
  219. package/content/user-authentication/two-factor.md +0 -229
  220. package/content/user-authentication/user-object.md +0 -58
  221. package/content/websockets/websocket-publish.md +0 -108
  222. package/content/websockets/websocket-subscriptions.md +0 -100
  223. package/content/websockets/websockets-introduction.md +0 -97
  224. package/hazards.json +0 -44
  225. package/scripts/hashDocSources.js +0 -38
  226. package/scripts/recordSourceHashes.js +0 -88
@@ -67,45 +67,6 @@ An Affix block makes its content stick to the viewport when scrolling.
67
67
  size: small
68
68
  ```
69
69
 
70
- Scroll this panel. The toolbar sticks to the top of the panel instead of the page, because `target` names the panel's id. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
71
-
72
- ```yaml
73
- - id: affix_panel
74
- type: Box
75
- class:
76
- .element: h-48 overflow-y-auto rounded border border-gray-200 p-3
77
- blocks:
78
- - id: affix_panel_toolbar
79
- type: Affix
80
- properties:
81
- offsetTop: 0
82
- target: affix_panel
83
- blocks:
84
- - id: affix_panel_toolbar_btn
85
- type: Button
86
- layout:
87
- flex: 0 0 auto
88
- properties:
89
- title: Save changes
90
- icon: save
91
- size: small
92
- - id: affix_panel_text
93
- type: Paragraph
94
- properties:
95
- content: Scroll this panel. The toolbar sticks to the top of the panel instead
96
- of the page, because `target` names the panel's id. Lorem ipsum dolor
97
- sit amet, consectetur adipiscing elit, sed do eiusmod tempor
98
- incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
99
- quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
100
- commodo consequat. Duis aute irure dolor in reprehenderit in voluptate
101
- velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint
102
- occaecat cupidatat non proident, sunt in culpa qui officia deserunt
103
- mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur
104
- adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
105
- magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation
106
- ullamco laboris nisi ut aliquip ex ea commodo consequat.
107
- ```
108
-
109
70
  ```yaml
110
71
  - id: affix_offset_bottom_0
111
72
  type: Affix
@@ -248,7 +209,7 @@ Scroll this panel. The toolbar sticks to the top of the panel instead of the pag
248
209
  layout:
249
210
  flex: 0 0 auto
250
211
  class:
251
- .element: shadow-lg rounded-lg
212
+ element: shadow-lg rounded-lg
252
213
  properties:
253
214
  offsetTop: 10
254
215
  blocks:
@@ -266,7 +227,7 @@ Scroll this panel. The toolbar sticks to the top of the panel instead of the pag
266
227
  layout:
267
228
  flex: 0 0 auto
268
229
  class:
269
- .element: ring-2 ring-green-400 rounded-lg
230
+ element: ring-2 ring-green-400 rounded-lg
270
231
  properties:
271
232
  offsetTop: 10
272
233
  blocks:
@@ -355,7 +316,7 @@ Edit Employee Record
355
316
  flex: 0 0 auto
356
317
  properties:
357
318
  title: Save Changes
358
- icon: save
319
+ icon: AiOutlineSave
359
320
  color: primary
360
321
  variant: solid
361
322
  size: small
@@ -401,7 +362,7 @@ Edit Employee Record
401
362
  flex: 0 0 auto
402
363
  properties:
403
364
  title: Delete
404
- icon: delete
365
+ icon: AiOutlineDelete
405
366
  color: danger
406
367
  variant: outlined
407
368
  size: small
@@ -418,7 +379,7 @@ Edit Employee Record
418
379
  flex: 0 0 auto
419
380
  properties:
420
381
  title: Export
421
- icon: download
382
+ icon: AiOutlineDownload
422
383
  color: primary
423
384
  variant: solid
424
385
  size: small
@@ -434,14 +395,13 @@ Edit Employee Record
434
395
  | Property | Type | Default | Description |
435
396
  | --- | --- | --- | --- |
436
397
  | `offsetBottom` | number | - | Offset from the bottom of the viewport (in pixels). |
437
- | `offsetTop` | number | `0` | Offset from the top of the viewport (in pixels). |
438
- | `target` | string | - | Id of the scrollable element the content sticks to, for example a scrolling panel. Defaults to the page window. |
398
+ | `offsetTop` | number | - | Offset from the top of the viewport (in pixels). |
439
399
  | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design affix tokens](https://ant.design/components/affix#design-token). |
440
400
  | `theme.zIndexPopup` | number | `10` | Z-index of the affix element when fixed. |
441
401
 
442
402
  | Event | Event Data | Description |
443
403
  | --- | --- | --- |
444
- | `onChange` | `{ affixed }` | Triggered when container affix status changes. |
404
+ | `onChange` | \- | Triggered when container affix status changes. |
445
405
 
446
406
  | Key | Target |
447
407
  | --- | --- |
@@ -33,26 +33,6 @@ 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
-
56
36
  > Payment Received
57
37
 
58
38
  > Scheduled Maintenance
@@ -206,18 +186,6 @@ Alert banner with type, description, icon, and closable options.
206
186
  closable: true
207
187
  ```
208
188
 
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
-
221
189
  > Cookie consent notice
222
190
 
223
191
  > New features available
@@ -285,25 +253,25 @@ Alert banner with type, description, icon, and closable options.
285
253
  properties:
286
254
  message: All tests passed
287
255
  type: success
288
- icon: check-circle
256
+ icon: AiOutlineCheckCircle
289
257
  - id: custom_icon_bell
290
258
  type: Alert
291
259
  properties:
292
260
  message: You have 3 new notifications
293
261
  type: info
294
- icon: bell
262
+ icon: AiOutlineBell
295
263
  - id: custom_icon_lock
296
264
  type: Alert
297
265
  properties:
298
266
  message: Your session has been locked for security
299
267
  type: warning
300
- icon: lock
268
+ icon: AiOutlineLock
301
269
  - id: custom_icon_bug
302
270
  type: Alert
303
271
  properties:
304
272
  message: Bug detected in module
305
273
  type: error
306
- icon: Bug
274
+ icon: AiOutlineBug
307
275
  - id: custom_icon_rocket
308
276
  type: Alert
309
277
  properties:
@@ -311,21 +279,21 @@ Alert banner with type, description, icon, and closable options.
311
279
  description: Your application is being deployed to the production environment.
312
280
  This usually takes 2-3 minutes.
313
281
  type: info
314
- icon: Rocket
282
+ icon: AiOutlineRocket
315
283
  - id: custom_icon_star
316
284
  type: Alert
317
285
  properties:
318
286
  message: You earned a new achievement
319
287
  description: Congratulations on completing your first project!
320
288
  type: success
321
- icon: star
289
+ icon: AiOutlineStar
322
290
  - id: custom_icon_object
323
291
  type: Alert
324
292
  properties:
325
293
  message: Custom styled icon
326
294
  type: info
327
295
  icon:
328
- name: Zap
296
+ name: AiOutlineThunderbolt
329
297
  color: "#faad14"
330
298
  - id: custom_icon_colored_obj
331
299
  type: Alert
@@ -334,7 +302,7 @@ Alert banner with type, description, icon, and closable options.
334
302
  description: No vulnerabilities were detected in your dependencies.
335
303
  type: success
336
304
  icon:
337
- name: Shield
305
+ name: AiOutlineSafety
338
306
  color: "#52c41a"
339
307
  ```
340
308
 
@@ -564,7 +532,7 @@ Alert banner with type, description, icon, and closable options.
564
532
  flex: 0 0 auto
565
533
  properties:
566
534
  title: Download
567
- icon: download
535
+ icon: AiOutlineDownload
568
536
  color: green
569
537
  variant: solid
570
538
  size: small
@@ -589,7 +557,7 @@ Alert banner with type, description, icon, and closable options.
589
557
  type: success
590
558
  closable: true
591
559
  closeText: OK
592
- icon: CloudUpload
560
+ icon: AiOutlineCloudUpload
593
561
  - id: combo_full_warning
594
562
  type: Alert
595
563
  properties:
@@ -598,7 +566,7 @@ Alert banner with type, description, icon, and closable options.
598
566
  requests). Consider implementing request caching.
599
567
  type: warning
600
568
  closable: true
601
- icon: Plug
569
+ icon: AiOutlineApi
602
570
  - id: combo_full_error
603
571
  type: Alert
604
572
  properties:
@@ -608,7 +576,7 @@ Alert banner with type, description, icon, and closable options.
608
576
  locked.
609
577
  type: error
610
578
  closable: true
611
- icon: warning
579
+ icon: AiOutlineWarning
612
580
  - id: combo_banner_closable_icon
613
581
  type: Alert
614
582
  properties:
@@ -616,7 +584,7 @@ Alert banner with type, description, icon, and closable options.
616
584
  type: info
617
585
  banner: true
618
586
  closable: true
619
- icon: FlaskConical
587
+ icon: AiOutlineExperiment
620
588
  - id: combo_noicon_closable_desc
621
589
  type: Alert
622
590
  properties:
@@ -797,7 +765,7 @@ Alert banner with type, description, icon, and closable options.
797
765
  description: <ul><li>Email address is required</li><li>Password must be at least
798
766
  8 characters</li><li>Please agree to the terms of service</li></ul>
799
767
  type: error
800
- icon: CircleAlert
768
+ icon: AiOutlineExclamationCircle
801
769
  - id: real_onboarding
802
770
  type: Alert
803
771
  properties:
@@ -806,7 +774,7 @@ Alert banner with type, description, icon, and closable options.
806
774
  members from the Settings page.
807
775
  type: info
808
776
  closable: true
809
- icon: FaceSlightlySmiling
777
+ icon: AiOutlineSmile
810
778
  slots:
811
779
  action:
812
780
  blocks:
@@ -819,7 +787,7 @@ Alert banner with type, description, icon, and closable options.
819
787
  color: primary
820
788
  variant: solid
821
789
  size: small
822
- icon: add
790
+ icon: AiOutlinePlus
823
791
  - id: real_deprecation
824
792
  type: Alert
825
793
  properties:
@@ -830,7 +798,7 @@ Alert banner with type, description, icon, and closable options.
830
798
  type: warning
831
799
  closable: true
832
800
  closeText: Acknowledged
833
- icon: clock
801
+ icon: AiOutlineClockCircle
834
802
  - id: real_maintenance
835
803
  type: Alert
836
804
  properties:
@@ -847,7 +815,7 @@ Alert banner with type, description, icon, and closable options.
847
815
  description: "Application <b>my-app</b> has been deployed to
848
816
  <code>production</code> environment. Build #1847 completed in 2m 34s."
849
817
  type: success
850
- icon: check-circle
818
+ icon: AiOutlineCheckCircle
851
819
  slots:
852
820
  action:
853
821
  blocks:
@@ -874,7 +842,7 @@ Alert banner with type, description, icon, and closable options.
874
842
  color: green
875
843
  variant: solid
876
844
  size: small
877
- icon: link
845
+ icon: AiOutlineLink
878
846
  - id: real_quota_warning
879
847
  type: Alert
880
848
  properties:
@@ -883,7 +851,7 @@ Alert banner with type, description, icon, and closable options.
883
851
  Current usage: 18.4 / 20 vCPUs. Consider scaling your plan or optimizing
884
852
  workloads."
885
853
  type: warning
886
- icon: Gauge
854
+ icon: AiOutlineDashboard
887
855
  slots:
888
856
  action:
889
857
  blocks:
@@ -903,7 +871,7 @@ Alert banner with type, description, icon, and closable options.
903
871
  description: You do not have permission to view this resource. Contact your
904
872
  administrator to request access to the Analytics dashboard.
905
873
  type: error
906
- icon: Ban
874
+ icon: AiOutlineStop
907
875
  closable: true
908
876
  - id: real_feature_flag
909
877
  type: Alert
@@ -914,39 +882,19 @@ Alert banner with type, description, icon, and closable options.
914
882
  type: info
915
883
  closable: true
916
884
  closeText: Understood
917
- icon: FlaskConical
885
+ icon: AiOutlineExperiment
918
886
  ```
919
887
 
920
888
  | Property | Type | Default | Description |
921
889
  | --- | --- | --- | --- |
922
890
  | `banner` | boolean | `false` | Style as banner at top of application window. |
923
891
  | `closable` | boolean | `false` | Allow alert to be closed. |
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. |
892
+ | `closeText` | string | - | Close text to show. |
935
893
  | `description` | string | - | Content description of alert - supports html. |
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. |
894
+ | `icon` | string \| object | - | Name of an Ant Design Icon or properties of an Icon block to customize alert icon. |
946
895
  | `message` | string | - | Content message of alert - supports html. |
947
896
  | `showIcon` | boolean | `true` | Show type default icon. |
948
897
  | `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`. |
950
898
  | `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). |
951
899
  | `theme.defaultPadding` | string | `"8px 12px"` | Default padding for the alert without description. |
952
900
  | `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: bell
107
+ icon: AiOutlineBell
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: bell
486
+ icon: AiOutlineBell
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: clock
499
+ name: AiOutlineClockCircle
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: CircleAlert
513
+ name: AiOutlineExclamation
514
514
  color: "#faad14"
515
515
  blocks:
516
516
  - id: icon_exclamation_child
@@ -573,8 +573,6 @@ U
573
573
 
574
574
  U
575
575
 
576
- N
577
-
578
576
  ```yaml
579
577
  - id: title_tooltip
580
578
  type: Badge
@@ -601,20 +599,7 @@ N
601
599
  type: Avatar
602
600
  properties:
603
601
  shape: square
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
602
+ icon: AiOutlineUser
618
603
  ```
619
604
 
620
605
  JD
@@ -655,7 +640,7 @@ JD
655
640
  - id: wrap_icon_bell_child
656
641
  type: Icon
657
642
  properties:
658
- name: bell
643
+ name: AiOutlineBell
659
644
  size: 24
660
645
  - id: wrap_icon_mail
661
646
  type: Badge
@@ -667,58 +652,10 @@ JD
667
652
  - id: wrap_icon_mail_child
668
653
  type: Icon
669
654
  properties:
670
- name: mail
655
+ name: AiOutlineMail
671
656
  size: 24
672
657
  ```
673
658
 
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
-
722
659
  U
723
660
 
724
661
  U
@@ -734,7 +671,7 @@ U
734
671
  count: 5
735
672
  style:
736
673
  .indicator:
737
- boxShadow: "0 0 0 2px #1677ff"
674
+ boxShadow: 0 0 0 2px
738
675
  blocks:
739
676
  - id: css_indicator_shadow_child
740
677
  type: Avatar
@@ -785,7 +722,7 @@ Inbox
785
722
  - id: tw_element_margin
786
723
  type: Badge
787
724
  class:
788
- .element: mr-8
725
+ element: mr-8
789
726
  layout:
790
727
  flex: 0 0 auto
791
728
  properties:
@@ -799,7 +736,7 @@ Inbox
799
736
  - id: tw_indicator_animate
800
737
  type: Badge
801
738
  class:
802
- .indicator: animate-bounce
739
+ indicator: animate-bounce
803
740
  layout:
804
741
  flex: 0 0 auto
805
742
  properties:
@@ -813,7 +750,7 @@ Inbox
813
750
  - id: tw_badge_in_box
814
751
  type: Badge
815
752
  class:
816
- .element: p-1
753
+ element: p-1
817
754
  layout:
818
755
  flex: 0 0 auto
819
756
  properties:
@@ -951,7 +888,7 @@ JD
951
888
  flex: 1 1 0
952
889
  properties:
953
890
  placeholder: Search...
954
- prefixIcon: search
891
+ prefixIcon: AiOutlineSearch
955
892
  - id: rw_notif_badge_mail
956
893
  type: Badge
957
894
  layout:
@@ -963,7 +900,7 @@ JD
963
900
  - id: rw_notif_mail_btn
964
901
  type: Button
965
902
  properties:
966
- icon: mail
903
+ icon: AiOutlineMail
967
904
  color: default
968
905
  variant: text
969
906
  hideTitle: true
@@ -984,7 +921,7 @@ JD
984
921
  - id: rw_notif_bell_btn
985
922
  type: Button
986
923
  properties:
987
- icon: bell
924
+ icon: AiOutlineBell
988
925
  color: default
989
926
  variant: text
990
927
  hideTitle: true
@@ -1001,7 +938,8 @@ JD
1001
938
  flex: 0 0 auto
1002
939
  properties:
1003
940
  content: JD
1004
- color: "#1677ff"
941
+ color: "#fff"
942
+ backgroundColor: "#1677ff"
1005
943
  ```
1006
944
 
1007
945
  #ORD-1042
@@ -1164,7 +1102,7 @@ James Wilson
1164
1102
  class: justify-start w-full
1165
1103
  properties:
1166
1104
  title: Inbox
1167
- icon: Inbox
1105
+ icon: AiOutlineInbox
1168
1106
  color: primary
1169
1107
  variant: text
1170
1108
  events:
@@ -1188,7 +1126,7 @@ James Wilson
1188
1126
  class: justify-start w-full
1189
1127
  properties:
1190
1128
  title: Alerts
1191
- icon: Siren
1129
+ icon: AiOutlineAlert
1192
1130
  color: default
1193
1131
  variant: text
1194
1132
  events:
@@ -1211,7 +1149,7 @@ James Wilson
1211
1149
  class: justify-start w-full
1212
1150
  properties:
1213
1151
  title: Tasks
1214
- icon: SquareCheck
1152
+ icon: AiOutlineCheckSquare
1215
1153
  color: default
1216
1154
  variant: text
1217
1155
  events:
@@ -1232,7 +1170,7 @@ James Wilson
1232
1170
  class: justify-start w-full
1233
1171
  properties:
1234
1172
  title: Settings
1235
- icon: settings
1173
+ icon: AiOutlineSetting
1236
1174
  color: default
1237
1175
  variant: text
1238
1176
  events:
@@ -1249,26 +1187,13 @@ James Wilson
1249
1187
  | `count` | number \| string | - | Text to show in badge. |
1250
1188
  | `dot` | boolean | `false` | Whether to display a red dot instead of count. |
1251
1189
  | `size` | string | `"default"` | Sets the size of badge if count is set. Enum: `default`, `small`. |
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. |
1190
+ | `icon` | string \| object | - | Name of an React-Icon (See all icons) or properties of an Icon block to use an icon in badge. |
1262
1191
  | `offset` | array | - | Set offset of the badge dot, array of numbers for x and y offset ([x,y]). |
1263
1192
  | `overflowCount` | number | `99` | Max count to show |
1264
1193
  | `showZero` | boolean | `false` | Whether to show badge when count is zero. |
1265
1194
  | `status` | string | `null` | Set Badge as a status dot. Enum: `success`, `processing`, `default`, `error`, `warning`. |
1266
1195
  | `text` | string | - | If status is set, text sets the display text of the status dot. |
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. |
1196
+ | `title` | string | - | Text to show when hovering over the badge. |
1272
1197
  | `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). |
1273
1198
  | `theme.indicatorHeight` | number | `20` | Height of the badge indicator. |
1274
1199
  | `theme.indicatorHeightSM` | number | `14` | Height of the badge indicator in small size. |
@@ -1276,7 +1201,6 @@ James Wilson
1276
1201
  | `theme.textFontSize` | number | `12` | Font size for badge count text. |
1277
1202
  | `theme.textFontSizeSM` | number | `12` | Font size for badge count text in small size. |
1278
1203
  | `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. |
1280
1204
  | `theme.textLineHeight` | number | - | Line height for badge count text. |
1281
1205
  | `theme.statusSize` | number | `6` | Size of the status dot. |
1282
1206
  | `theme.indicatorZIndex` | number \| string | `"auto"` | Z-index of the badge indicator. |
@@ -1289,9 +1213,9 @@ No events defined.
1289
1213
  | Key | Target |
1290
1214
  | --- | --- |
1291
1215
  | `/block` | Outer block wrapper (always available). |
1292
- | `/element` | The Badge element, or the ribbon wrapper when ribbon is set. |
1216
+ | `/element` | The Badge element. |
1293
1217
  | `/icon` | The icon in the Badge. |
1294
- | `/indicator` | The Badge count or dot indicator, or the ribbon when ribbon is set. |
1218
+ | `/indicator` | The Badge indicator. |
1295
1219
 
1296
1220
  | Slot | Description |
1297
1221
  | --- | --- |