@lowdefy/docs-content 6.1.0 → 7.0.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 (285) 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 +5 -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/setstate.md +2 -0
  31. package/content/actions/validate.md +7 -4
  32. package/content/adapter-reference/mongodbauthadapter.md +46 -0
  33. package/content/agents/agent-endpoint-tools.md +24 -0
  34. package/content/agents/agent-properties.md +13 -3
  35. package/content/agents/agent-server-hooks.md +1 -1
  36. package/content/agents/agentchat.md +43 -7
  37. package/content/agents/agentconversations.md +42 -8
  38. package/content/agents/agents-introduction.md +107 -0
  39. package/content/callback-reference/auth0logoutcallback.md +54 -0
  40. package/content/concepts/ai-agent-docs.md +455 -106
  41. package/content/concepts/blocks.md +150 -0
  42. package/content/concepts/connections-and-requests.md +402 -0
  43. package/content/concepts/custom-html.md +42 -0
  44. package/content/concepts/custom-styling.md +50 -5
  45. package/content/concepts/dynamic-page-content.md +309 -0
  46. package/content/concepts/events-and-actions.md +154 -2
  47. package/content/concepts/four-primitives.md +31 -0
  48. package/content/concepts/html-attributes.md +293 -0
  49. package/content/concepts/i18n.md +8 -3
  50. package/content/concepts/keyboard-shortcuts.md +2 -2
  51. package/content/concepts/layout-overview.md +1 -1
  52. package/content/concepts/logger.md +99 -0
  53. package/content/concepts/lowdefy-api.md +1319 -0
  54. package/content/concepts/lowdefy-schema.md +136 -3
  55. package/content/concepts/menus.md +8 -7
  56. package/content/concepts/module-authoring.md +76 -5
  57. package/content/concepts/modules.md +3 -1
  58. package/content/concepts/notifications.md +180 -0
  59. package/content/concepts/operators.md +7 -0
  60. package/content/concepts/page-and-app-state.md +252 -0
  61. package/content/concepts/page-paths.md +209 -0
  62. package/content/concepts/theming.md +582 -0
  63. package/content/connections/aigateway.md +375 -0
  64. package/content/connections/anthropic.md +169 -2
  65. package/content/connections/awss3.md +178 -2
  66. package/content/connections/axioshttp.md +181 -0
  67. package/content/connections/google.md +169 -2
  68. package/content/connections/mongodb.md +1014 -3
  69. package/content/connections/openai-connection.md +169 -2
  70. package/content/connections/sendgridmail.md +2 -0
  71. package/content/connections/smtp.md +3 -1
  72. package/content/connections/treg.md +329 -0
  73. package/content/container-blocks/affix.md +47 -7
  74. package/content/container-blocks/alert.md +76 -24
  75. package/content/container-blocks/badge.md +100 -24
  76. package/content/container-blocks/box.md +9 -9
  77. package/content/container-blocks/card.md +132 -27
  78. package/content/container-blocks/carousel.md +60 -7
  79. package/content/container-blocks/collapse.md +153 -9
  80. package/content/container-blocks/configprovider.md +35 -13
  81. package/content/container-blocks/confirmmodal.md +69 -23
  82. package/content/container-blocks/content.md +62 -98
  83. package/content/container-blocks/descriptions.md +45 -4
  84. package/content/container-blocks/drawer.md +139 -28
  85. package/content/container-blocks/dropdownmenu.md +119 -31
  86. package/content/container-blocks/flex.md +40 -62
  87. package/content/container-blocks/footer.md +15 -11
  88. package/content/container-blocks/googlemapsheatmap.md +1 -1
  89. package/content/container-blocks/googlemapsscript.md +2 -2
  90. package/content/container-blocks/header.md +71 -36
  91. package/content/container-blocks/label.md +34 -7
  92. package/content/container-blocks/layout.md +52 -34
  93. package/content/container-blocks/masonry.md +17 -71
  94. package/content/container-blocks/mobilemenu.md +131 -88
  95. package/content/container-blocks/modal.md +161 -26
  96. package/content/container-blocks/pageheadermenu.md +138 -31
  97. package/content/container-blocks/pagesidebarlayout.md +230 -27
  98. package/content/container-blocks/pagesidermenu.md +153 -43
  99. package/content/container-blocks/popover.md +34 -31
  100. package/content/container-blocks/result.md +32 -21
  101. package/content/container-blocks/sider.md +85 -122
  102. package/content/container-blocks/span.md +7 -7
  103. package/content/container-blocks/spinner.md +3 -3
  104. package/content/container-blocks/splitter.md +150 -68
  105. package/content/container-blocks/tabs.md +64 -12
  106. package/content/container-blocks/tooltip.md +22 -46
  107. package/content/container-blocks/watermark.md +22 -4
  108. package/content/controls/parallel_for.md +21 -2
  109. package/content/controls/reject.md +24 -3
  110. package/content/controls/return.md +17 -1
  111. package/content/controls/throw.md +1 -0
  112. package/content/controls/try.md +4 -2
  113. package/content/controls/while.md +46 -0
  114. package/content/deployment/deployment-environments.md +10 -7
  115. package/content/deployment/docker.md +22 -7
  116. package/content/deployment/node-server.md +4 -0
  117. package/content/deployment/vercel.md +17 -6
  118. package/content/display-blocks/aggrid.md +33 -16
  119. package/content/display-blocks/anchor.md +16 -15
  120. package/content/display-blocks/avatar.md +57 -37
  121. package/content/display-blocks/breadcrumb.md +70 -21
  122. package/content/display-blocks/button.md +93 -19
  123. package/content/display-blocks/calendar.md +12 -0
  124. package/content/display-blocks/clickablehtml.md +239 -0
  125. package/content/display-blocks/dangeroushtml.md +1 -1
  126. package/content/display-blocks/difflist.md +1 -1
  127. package/content/display-blocks/difftimeline.md +1 -1
  128. package/content/display-blocks/divider.md +64 -3
  129. package/content/display-blocks/dropdownbutton.md +81 -30
  130. package/content/display-blocks/echart.md +35 -1
  131. package/content/display-blocks/eventlog.md +363 -0
  132. package/content/display-blocks/floatbutton.md +129 -42
  133. package/content/display-blocks/html.md +61 -1
  134. package/content/display-blocks/icon.md +250 -67
  135. package/content/display-blocks/img.md +2 -2
  136. package/content/display-blocks/menu.md +146 -73
  137. package/content/display-blocks/message.md +38 -124
  138. package/content/display-blocks/notification.md +94 -222
  139. package/content/display-blocks/paragraph.md +59 -9
  140. package/content/display-blocks/pollingtimer.md +263 -0
  141. package/content/display-blocks/progress.md +96 -17
  142. package/content/display-blocks/qrcode.md +19 -4
  143. package/content/display-blocks/s3download.md +1 -1
  144. package/content/display-blocks/search.md +19 -9
  145. package/content/display-blocks/skeletonbutton.md +1 -0
  146. package/content/display-blocks/skeletoninput.md +1 -0
  147. package/content/display-blocks/statistic.md +75 -17
  148. package/content/display-blocks/steps.md +58 -25
  149. package/content/display-blocks/table.md +2527 -0
  150. package/content/display-blocks/tablelight.md +621 -0
  151. package/content/display-blocks/tag.md +102 -17
  152. package/content/display-blocks/title.md +50 -11
  153. package/content/display-blocks/tour.md +33 -23
  154. package/content/input-blocks/autocomplete.md +81 -9
  155. package/content/input-blocks/buttonselector.md +45 -8
  156. package/content/input-blocks/captcha.md +40 -0
  157. package/content/input-blocks/checkboxselector.md +97 -7
  158. package/content/input-blocks/checkboxswitch.md +33 -3
  159. package/content/input-blocks/colorselector.md +63 -14
  160. package/content/input-blocks/daterangeselector.md +165 -45
  161. package/content/input-blocks/dateselector.md +139 -41
  162. package/content/input-blocks/datetimeselector.md +158 -49
  163. package/content/input-blocks/inputgallery.md +3 -3
  164. package/content/input-blocks/intentinput.md +207 -0
  165. package/content/input-blocks/monthselector.md +120 -52
  166. package/content/input-blocks/multipleselector.md +150 -39
  167. package/content/input-blocks/numberinput.md +98 -12
  168. package/content/input-blocks/pagination.md +70 -14
  169. package/content/input-blocks/paragraphinput.md +51 -37
  170. package/content/input-blocks/passwordinput.md +60 -6
  171. package/content/input-blocks/phonenumberinput.md +59 -26
  172. package/content/input-blocks/placesautocomplete.md +319 -0
  173. package/content/input-blocks/radioselector.md +83 -7
  174. package/content/input-blocks/ratingslider.md +57 -26
  175. package/content/input-blocks/s3uploadbutton.md +24 -24
  176. package/content/input-blocks/s3uploaddragger.md +3 -3
  177. package/content/input-blocks/s3uploadphoto.md +5 -5
  178. package/content/input-blocks/segmentedselector.md +72 -32
  179. package/content/input-blocks/selector.md +109 -21
  180. package/content/input-blocks/switch.md +65 -17
  181. package/content/input-blocks/tableinput.md +445 -0
  182. package/content/input-blocks/tagmultipleselector.md +114 -0
  183. package/content/input-blocks/tagselector.md +114 -0
  184. package/content/input-blocks/textarea.md +32 -3
  185. package/content/input-blocks/textinput.md +70 -29
  186. package/content/input-blocks/tiptapinput.md +1 -1
  187. package/content/input-blocks/tiptapmentioninput.md +2 -2
  188. package/content/input-blocks/titleinput.md +39 -12
  189. package/content/input-blocks/treeinput.md +49 -25
  190. package/content/input-blocks/treemultipleselector.md +127 -10
  191. package/content/input-blocks/treeselector.md +97 -9
  192. package/content/input-blocks/upload.md +64 -15
  193. package/content/input-blocks/uploaddragger.md +17 -1
  194. package/content/input-blocks/uploadphoto.md +18 -1
  195. package/content/input-blocks/weekselector.md +120 -55
  196. package/content/learn/introduction.md +27 -0
  197. package/content/learn/quickstart.md +53 -0
  198. package/content/learn/showcase.md +8 -0
  199. package/content/list-blocks/controlledlist.md +24 -15
  200. package/content/list-blocks/list.md +11 -11
  201. package/content/list-blocks/masonrylist.md +7 -34
  202. package/content/migration/auth-upgrade.md +337 -0
  203. package/content/migration/upgrade-guide.md +1 -0
  204. package/content/migration/v3-to-v4.md +417 -0
  205. package/content/migration/v6-to-v7.md +620 -0
  206. package/content/operators/_agent.md +155 -0
  207. package/content/operators/_app.md +2 -1
  208. package/content/operators/_array.md +122 -1
  209. package/content/operators/_build.md +1 -0
  210. package/content/operators/_credential.md +57 -0
  211. package/content/operators/_cron.md +292 -0
  212. package/content/operators/_date.md +2 -0
  213. package/content/operators/_error.md +24 -1
  214. package/content/operators/_get.md +6 -6
  215. package/content/operators/_hmac.md +78 -0
  216. package/content/operators/_js.md +2 -1
  217. package/content/operators/_location.md +1 -1
  218. package/content/operators/_media.md +13 -0
  219. package/content/operators/_module.md +56 -2
  220. package/content/operators/_operator.md +17 -3
  221. package/content/operators/_path_params.md +82 -0
  222. package/content/operators/_ref.md +258 -0
  223. package/content/operators/_request.md +1 -1
  224. package/content/operators/_request_details.md +6 -0
  225. package/content/operators/_type.md +14 -3
  226. package/content/operators/_url_query.md +2 -0
  227. package/content/operators/_user.md +3 -3
  228. package/content/plugins/plugins-actions.md +10 -0
  229. package/content/plugins/plugins-connections.md +25 -0
  230. package/content/plugins/plugins-dev.md +66 -0
  231. package/content/plugins/plugins-icon-sets.md +267 -0
  232. package/content/plugins/plugins-introduction.md +27 -1
  233. package/content/plugins/plugins.md +19 -0
  234. package/content/plugins/posthog.md +359 -0
  235. package/content/provider-reference/auth-js-providers.md +107 -0
  236. package/content/provider-reference/openidconnectprovider.md +44 -0
  237. package/content/recipes/recipes.md +16 -0
  238. package/content/reference/actions-reference.md +31 -0
  239. package/content/reference/blocks-reference.md +35 -0
  240. package/content/reference/cli.md +403 -0
  241. package/content/reference/connections-reference.md +23 -0
  242. package/content/reference/operators-reference.md +47 -0
  243. package/content/reference/reference.md +16 -0
  244. package/content/reference/schema-reference.md +12 -0
  245. package/content/testing/config-tests.md +677 -0
  246. package/content/testing/e2e-configuration.md +31 -1
  247. package/content/testing/e2e-getting-started.md +1 -1
  248. package/content/testing/e2e-introduction.md +1 -1
  249. package/content/testing/e2e-writing-tests.md +12 -1
  250. package/content/testing/explore-pull-request.md +136 -0
  251. package/content/testing/journey-data-sets.md +326 -0
  252. package/content/tutorial/tutorial-actions-operators.md +2 -2
  253. package/content/tutorial/tutorial-add-blocks.md +2 -2
  254. package/content/tutorial/tutorial-create-page.md +48 -2
  255. package/content/tutorial/tutorial-display-data-page.md +3 -3
  256. package/content/tutorial/tutorial-requests-api.md +155 -0
  257. package/content/tutorial/tutorial-requests-sql.md +153 -0
  258. package/content/tutorial/tutorial-start.md +66 -1
  259. package/content/user-authentication/auth-configuration.md +267 -0
  260. package/content/user-authentication/auth-providers.md +24 -0
  261. package/content/user-authentication/auth-steps.md +141 -0
  262. package/content/user-authentication/login-and-logout.md +160 -8
  263. package/content/user-authentication/mcp-oauth.md +424 -0
  264. package/content/user-authentication/organizations.md +246 -0
  265. package/content/user-authentication/protected-pages-apis.md +97 -0
  266. package/content/user-authentication/roles.md +49 -0
  267. package/content/user-authentication/two-factor.md +229 -0
  268. package/content/user-authentication/user-object.md +58 -0
  269. package/content/user-authentication/users-introduction.md +8 -0
  270. package/content/websockets/websocket-publish.md +105 -0
  271. package/content/websockets/websocket-subscriptions.md +136 -0
  272. package/content/websockets/websockets-introduction.md +101 -0
  273. package/hazards.json +56 -0
  274. package/index.json +3458 -14
  275. package/package.json +10 -1
  276. package/scripts/extractAgentDocs.js +41 -30
  277. package/scripts/hashDocSources.js +38 -0
  278. package/scripts/isRedirectPage.js +26 -0
  279. package/scripts/recordSourceHashes.js +97 -0
  280. package/scripts/resolvePageSections.js +42 -0
  281. package/scripts/sectionKind.js +27 -0
  282. package/content/concepts/cli.md +0 -223
  283. package/content/other/introduction.md +0 -39
  284. package/content/other/next-auth-providers.md +0 -3
  285. /package/content/{other → actions}/updatesession.md +0 -0
@@ -226,13 +226,13 @@ Segmented control for switching between options.
226
226
  options:
227
227
  - label: List
228
228
  value: list
229
- icon: AiOutlineUnorderedList
229
+ icon: list
230
230
  - label: Grid
231
231
  value: grid
232
- icon: AiOutlineAppstore
232
+ icon: grid
233
233
  - label: Calendar
234
234
  value: calendar
235
- icon: AiOutlineCalendar
235
+ icon: calendar
236
236
  - id: icon_small
237
237
  type: SegmentedSelector
238
238
  properties:
@@ -241,13 +241,13 @@ Segmented control for switching between options.
241
241
  options:
242
242
  - label: Map
243
243
  value: map
244
- icon: AiOutlineEnvironment
244
+ icon: location
245
245
  - label: Satellite
246
246
  value: satellite
247
- icon: AiOutlineGlobal
247
+ icon: globe
248
248
  - label: Terrain
249
249
  value: terrain
250
- icon: AiOutlineBlock
250
+ icon: Blocks
251
251
  - id: icon_block
252
252
  type: SegmentedSelector
253
253
  properties:
@@ -256,16 +256,16 @@ Segmented control for switching between options.
256
256
  options:
257
257
  - label: Home
258
258
  value: home
259
- icon: AiOutlineHome
259
+ icon: home
260
260
  - label: Search
261
261
  value: search
262
- icon: AiOutlineSearch
262
+ icon: search
263
263
  - label: Favorites
264
264
  value: favorites
265
- icon: AiOutlineHeart
265
+ icon: heart
266
266
  - label: Profile
267
267
  value: profile
268
- icon: AiOutlineUser
268
+ icon: user
269
269
  - id: icon_round
270
270
  type: SegmentedSelector
271
271
  properties:
@@ -274,13 +274,29 @@ Segmented control for switching between options.
274
274
  options:
275
275
  - label: Code
276
276
  value: code
277
- icon: AiOutlineCode
277
+ icon: CodeXml
278
278
  - label: Preview
279
279
  value: preview
280
- icon: AiOutlineEye
280
+ icon: view
281
281
  - label: Split
282
282
  value: split
283
- icon: AiOutlineColumnWidth
283
+ icon: MoveHorizontal
284
+ ```
285
+
286
+ ```yaml
287
+ - id: segmented_tooltips
288
+ type: SegmentedSelector
289
+ properties:
290
+ title: View
291
+ options:
292
+ - label: List
293
+ value: list
294
+ icon: list
295
+ tooltip: Show items as a list
296
+ - label: Grid
297
+ value: grid
298
+ icon: grid
299
+ tooltip: Show items as a grid
284
300
  ```
285
301
 
286
302
  ```yaml
@@ -304,16 +320,16 @@ Segmented control for switching between options.
304
320
  options:
305
321
  - label: Dashboard
306
322
  value: dashboard
307
- icon: AiOutlineDashboard
323
+ icon: Gauge
308
324
  - label: Analytics
309
325
  value: analytics
310
- icon: AiOutlineBarChart
326
+ icon: chart
311
327
  - label: Reports
312
328
  value: reports
313
- icon: AiOutlineFileText
329
+ icon: document
314
330
  - label: Settings
315
331
  value: settings
316
- icon: AiOutlineSetting
332
+ icon: settings
317
333
  - id: vertical_large
318
334
  type: SegmentedSelector
319
335
  properties:
@@ -359,13 +375,13 @@ Segmented control for switching between options.
359
375
  options:
360
376
  - label: Edit
361
377
  value: edit
362
- icon: AiOutlineEdit
378
+ icon: edit
363
379
  - label: View
364
380
  value: view
365
- icon: AiOutlineEye
381
+ icon: view
366
382
  - label: Delete
367
383
  value: delete
368
- icon: AiOutlineDelete
384
+ icon: delete
369
385
  ```
370
386
 
371
387
  ```yaml
@@ -584,13 +600,13 @@ Segmented control for switching between options.
584
600
  options:
585
601
  - label: Overview
586
602
  value: overview
587
- icon: AiOutlineDashboard
603
+ icon: Gauge
588
604
  - label: Charts
589
605
  value: charts
590
- icon: AiOutlineBarChart
606
+ icon: chart
591
607
  - label: Table
592
608
  value: table
593
- icon: AiOutlineTable
609
+ icon: Table
594
610
  events:
595
611
  onChange:
596
612
  - id: view_changed_action
@@ -612,7 +628,7 @@ Segmented control for switching between options.
612
628
  type: Button
613
629
  properties:
614
630
  title: Refresh Data
615
- icon: AiOutlineReload
631
+ icon: refresh
616
632
  type: primary
617
633
  events:
618
634
  onClick:
@@ -637,13 +653,13 @@ Segmented control for switching between options.
637
653
  options:
638
654
  - label: Light
639
655
  value: light
640
- icon: AiOutlineBulb
656
+ icon: Lightbulb
641
657
  - label: Dark
642
658
  value: dark
643
- icon: AiOutlineEyeInvisible
659
+ icon: hide
644
660
  - label: System
645
661
  value: system
646
- icon: AiOutlineLaptop
662
+ icon: Laptop
647
663
  events:
648
664
  onChange:
649
665
  - id: theme_changed_action
@@ -691,7 +707,7 @@ Segmented control for switching between options.
691
707
  type: Button
692
708
  properties:
693
709
  title: Save Settings
694
- icon: AiOutlineSave
710
+ icon: save
695
711
  type: primary
696
712
  events:
697
713
  onClick:
@@ -730,23 +746,46 @@ Segmented control for switching between options.
730
746
  | `options.$.label` | string | - | Value label shown to user - supports html. |
731
747
  | `options.$.value` | string \| number \| boolean \| object \| array | - | Value selected. Can be of any type. |
732
748
  | `options.$.disabled` | boolean | `false` | Disable the option if true. |
733
- | `options.$.icon` | string | - | Name of a React-Icon (See [all icons](https://react-icons.github.io/react-icons/)) to display in the segment option. |
749
+ | `options.$.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 display in the segment option. |
750
+ | `options.$.icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
751
+ | `options.$.icon.color` | string | - | Icon color. |
752
+ | `options.$.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
753
+ | `options.$.icon.rotate` | number | - | Number of degrees to rotate the icon. |
754
+ | `options.$.icon.spin` | boolean | - | Continuously spin the icon with animation. |
755
+ | `options.$.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
756
+ | `options.$.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
757
+ | `options.$.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
758
+ | `options.$.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
759
+ | `options.$.tooltip` | string | - | Tooltip shown when hovering the segment option. |
734
760
  | `shape` | string | `"default"` | Shape of the segmented control. Enum: `default`, `round`. |
735
- | `size` | string | `"default"` | Size of the block. Enum: `small`, `default`, `large`. |
761
+ | `size` | string | `"middle"` | Size of the block. Enum: `small`, `middle`, `large`. |
736
762
  | `vertical` | boolean | `false` | Display the segmented control vertically. |
737
763
  | `label` | object | - | Label properties. |
764
+ | `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
765
+ | `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
766
+ | `label.sm` | object | - | Label width on small screens (576px and up) when the label is not inline. Also applies below 576px unless `xs` is set. |
767
+ | `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
768
+ | `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
769
+ | `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
770
+ | `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
771
+ | `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
772
+ | `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
773
+ | `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
774
+ | `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
775
+ | `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
738
776
  | `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
739
777
  | `label.colon` | boolean | `true` | Append label with colon. |
740
778
  | `label.extra` | string | - | Extra text to display beneath the content - supports html. |
741
779
  | `label.title` | string | - | Label title - supports html. |
742
780
  | `label.tooltip` | string \| object | - | Help tooltip shown via an icon beside the label. A string sets the tooltip text (supports html), or an object to also customize the icon and color. Use the block's onTooltipClick event to respond to clicks on the icon. |
743
781
  | `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
744
- | `label.tooltip.icon` | string | `"AiOutlineQuestionCircle"` | Name of the icon to show beside the label. |
782
+ | `label.tooltip.icon` | string | `"help"` | Icon name to show beside the label: a semantic name like `help`, a Lucide icon name like `CircleQuestionMark`, or a set-qualified name like `tabler:HelpCircle`. |
745
783
  | `label.tooltip.color` | string | - | Color of the tooltip icon. |
746
- | `label.span` | number | - | Label inline span. |
784
+ | `label.span` | number | - | Label width in columns, out of 24, on medium screens (768px) and up when the label is not inline. The content takes the remaining columns. |
747
785
  | `label.disabled` | boolean | `false` | Hide input label. |
748
786
  | `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
749
787
  | `label.inline` | boolean | `false` | Render input and label inline. |
788
+ | `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
750
789
  | `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
751
790
  | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design segmented tokens](https://ant.design/components/segmented#design-token). |
752
791
  | `theme.trackBg` | string | - | Background color of the segmented track container. |
@@ -775,6 +814,7 @@ Segmented control for switching between options.
775
814
  | `/block` | Outer block wrapper (always available). |
776
815
  | `/element` | The SegmentedSelector element. |
777
816
  | `/icon` | The icon in the SegmentedSelector. |
817
+ | `/options` | Each SegmentedSelector option. |
778
818
  | `/label` | The SegmentedSelector label. |
779
819
  | `/extra` | The SegmentedSelector extra content. |
780
820
  | `/feedback` | The SegmentedSelector validation feedback. |
@@ -269,6 +269,45 @@ Dropdown selector with search, clear, and custom icons.
269
269
  value: blue
270
270
  ```
271
271
 
272
+ ```yaml
273
+ - id: prefix_icon_selector
274
+ type: Selector
275
+ properties:
276
+ title: Prefix Icon
277
+ prefixIcon: globe
278
+ placeholder: Choose a region...
279
+ options:
280
+ - label: Europe
281
+ value: eu
282
+ - label: North America
283
+ value: na
284
+ - label: Asia Pacific
285
+ value: apac
286
+ - id: wide_dropdown_selector
287
+ type: Selector
288
+ style:
289
+ .element:
290
+ width: 160px
291
+ properties:
292
+ title: Dropdown Wider Than the Input
293
+ popupMatchSelectWidth: false
294
+ placement: bottomRight
295
+ options:
296
+ - label: Standard shipping (5 to 7 business days)
297
+ value: standard
298
+ - label: Express shipping (1 to 2 business days)
299
+ value: express
300
+ - id: underlined_selector
301
+ type: Selector
302
+ properties:
303
+ title: Underlined Variant
304
+ variant: underlined
305
+ options:
306
+ - Draft
307
+ - Published
308
+ - Archived
309
+ ```
310
+
272
311
  ```yaml
273
312
  - id: size_small
274
313
  type: Selector
@@ -312,7 +351,7 @@ Dropdown selector with search, clear, and custom icons.
312
351
  type: Selector
313
352
  properties:
314
353
  title: Custom Suffix Icon
315
- suffixIcon: AiOutlineSearch
354
+ suffixIcon: search
316
355
  placeholder: Search items...
317
356
  options:
318
357
  - label: Database
@@ -326,7 +365,7 @@ Dropdown selector with search, clear, and custom icons.
326
365
  properties:
327
366
  title: Styled Suffix Icon
328
367
  suffixIcon:
329
- name: AiOutlineFilter
368
+ name: filter
330
369
  color: "#722ed1"
331
370
  placeholder: Filter options...
332
371
  options:
@@ -340,7 +379,7 @@ Dropdown selector with search, clear, and custom icons.
340
379
  type: Selector
341
380
  properties:
342
381
  title: Custom Clear Icon
343
- clearIcon: AiOutlineDelete
382
+ clearIcon: delete
344
383
  placeholder: Select to see custom clear icon...
345
384
  options:
346
385
  - label: Item One
@@ -354,7 +393,7 @@ Dropdown selector with search, clear, and custom icons.
354
393
  properties:
355
394
  title: Styled Clear Icon
356
395
  clearIcon:
357
- name: AiOutlineCloseCircle
396
+ name: close-circle
358
397
  color: "#f5222d"
359
398
  placeholder: Select then hover to clear...
360
399
  options:
@@ -541,7 +580,7 @@ Dropdown selector with search, clear, and custom icons.
541
580
  - label: Three
542
581
  value: 3
543
582
  class:
544
- element: rounded-lg shadow-sm
583
+ .element: rounded-lg shadow-sm
545
584
  - id: class_label
546
585
  type: Selector
547
586
  properties:
@@ -552,7 +591,7 @@ Dropdown selector with search, clear, and custom icons.
552
591
  - label: Beta
553
592
  value: beta
554
593
  class:
555
- label: text-blue-600 font-semibold
594
+ .label: text-blue-600 font-semibold
556
595
  ```
557
596
 
558
597
  ```yaml
@@ -746,7 +785,7 @@ Dropdown selector with search, clear, and custom icons.
746
785
  title: Searchable Styled Options
747
786
  showSearch: true
748
787
  placeholder: Search and select a status...
749
- suffixIcon: AiOutlineSearch
788
+ suffixIcon: search
750
789
  options:
751
790
  - label: '<span style="color: #52c41a;">Active</span>'
752
791
  value: active
@@ -769,10 +808,10 @@ Dropdown selector with search, clear, and custom icons.
769
808
  showSearch: true
770
809
  placeholder: Choose a department...
771
810
  suffixIcon:
772
- name: AiOutlineTeam
811
+ name: users
773
812
  color: "#1677ff"
774
813
  clearIcon:
775
- name: AiOutlineClose
814
+ name: close
776
815
  color: "#ff4d4f"
777
816
  options:
778
817
  - label: <b>Engineering</b>
@@ -846,7 +885,7 @@ Dropdown selector with search, clear, and custom icons.
846
885
  title: Country
847
886
  showSearch: true
848
887
  placeholder: Select your country...
849
- suffixIcon: AiOutlineGlobal
888
+ suffixIcon: globe
850
889
  options:
851
890
  - label: United States
852
891
  value: us
@@ -890,7 +929,7 @@ Dropdown selector with search, clear, and custom icons.
890
929
  title: Timezone
891
930
  showSearch: true
892
931
  placeholder: Select your timezone...
893
- suffixIcon: AiOutlineClockCircle
932
+ suffixIcon: clock
894
933
  label:
895
934
  extra: Used for scheduling and notifications.
896
935
  options:
@@ -912,7 +951,7 @@ Dropdown selector with search, clear, and custom icons.
912
951
  type: Button
913
952
  properties:
914
953
  title: Save Preferences
915
- icon: AiOutlineSave
954
+ icon: save
916
955
  type: primary
917
956
  size: large
918
957
  block: true
@@ -937,7 +976,7 @@ Dropdown selector with search, clear, and custom icons.
937
976
  title: Product
938
977
  showSearch: true
939
978
  placeholder: Select a product...
940
- suffixIcon: AiOutlineShopping
979
+ suffixIcon: ShoppingBag
941
980
  options:
942
981
  - label: Laptop Pro 15"
943
982
  value: laptop_pro
@@ -997,7 +1036,7 @@ Dropdown selector with search, clear, and custom icons.
997
1036
  type: Button
998
1037
  properties:
999
1038
  title: Place Order
1000
- icon: AiOutlineCheckCircle
1039
+ icon: check-circle
1001
1040
  type: primary
1002
1041
  size: large
1003
1042
  block: true
@@ -1065,25 +1104,48 @@ Dropdown selector with search, clear, and custom icons.
1065
1104
  | `allowClear` | boolean | `true` | Allow the user to clear the selected value, sets the value to null. |
1066
1105
  | `autoFocus` | boolean | `false` | Autofocus to the block on page load. |
1067
1106
  | `bordered` | boolean | `true` | Whether or not the selector has a border style. Deprecated, use variant instead. |
1068
- | `clearIcon` | string \| object | `"AiOutlineCloseCircle"` | Name of an React-Icon (See all icons) or properties of an Icon block to customize icon at far right position of the selector, shown when user is given option to clear input. |
1107
+ | `clearIcon` | string \| object | `"clear"` | 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 icon at far right position of the selector, shown when user is given option to clear input. |
1108
+ | `clearIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
1109
+ | `clearIcon.color` | string | - | Icon color. |
1110
+ | `clearIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
1111
+ | `clearIcon.rotate` | number | - | Number of degrees to rotate the icon. |
1112
+ | `clearIcon.spin` | boolean | - | Continuously spin the icon with animation. |
1113
+ | `clearIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
1114
+ | `clearIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
1115
+ | `clearIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
1116
+ | `clearIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
1069
1117
  | `label` | object | - | Label properties. |
1118
+ | `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
1119
+ | `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
1120
+ | `label.sm` | object | - | Label width on small screens (576px and up) when the label is not inline. Also applies below 576px unless `xs` is set. |
1121
+ | `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
1122
+ | `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
1123
+ | `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
1124
+ | `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
1125
+ | `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
1126
+ | `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
1127
+ | `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
1128
+ | `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
1129
+ | `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
1070
1130
  | `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
1071
1131
  | `label.colon` | boolean | `true` | Append label with colon. |
1072
1132
  | `label.extra` | string | - | Extra text to display beneath the content - supports html. |
1073
1133
  | `label.title` | string | - | Label title - supports html. |
1074
1134
  | `label.tooltip` | string \| object | - | Help tooltip shown via an icon beside the label. A string sets the tooltip text (supports html), or an object to also customize the icon and color. Use the block's onTooltipClick event to respond to clicks on the icon. |
1075
1135
  | `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
1076
- | `label.tooltip.icon` | string | `"AiOutlineQuestionCircle"` | Name of the icon to show beside the label. |
1136
+ | `label.tooltip.icon` | string | `"help"` | Icon name to show beside the label: a semantic name like `help`, a Lucide icon name like `CircleQuestionMark`, or a set-qualified name like `tabler:HelpCircle`. |
1077
1137
  | `label.tooltip.color` | string | - | Color of the tooltip icon. |
1078
- | `label.span` | number | - | Label inline span. |
1138
+ | `label.span` | number | - | Label width in columns, out of 24, on medium screens (768px) and up when the label is not inline. The content takes the remaining columns. |
1079
1139
  | `label.disabled` | boolean | `false` | Hide input label. |
1080
1140
  | `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
1081
1141
  | `label.inline` | boolean | `false` | Render input and label inline. |
1142
+ | `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
1082
1143
  | `disabled` | boolean | `false` | Disable the block if true. |
1083
1144
  | `data` | array | - | Alternative to `options`: an array of raw rows. Each row is rendered to a label with the `html` template, and `valueKey` selects which field becomes the value. Use this to drive a selector directly from data without building label/value pairs in your request. |
1084
1145
  | `html` | string | - | Nunjucks template that renders each option label when using `data`. The context exposes `item` (the current row) and `index` (the zero-based row index). Ignored when `options` is used. |
1085
1146
  | `valueKey` | string | - | Field used as the selected value. With `options` it names the value field (defaults to "value"). With `data` it names the field stored when an option is selected; omit it to store the whole row. Supports dotted paths (e.g. "user.id"). |
1086
1147
  | `primaryKey` | string | - | Field used to match the current value (e.g. set with SetState) back to an option for highlighting. Defaults to `valueKey`. Set this when the stored value is the whole row but a single field (e.g. "id") uniquely identifies it. In the tree selectors it also serves as each node’s id, referenced by `parentKey`. Supports dotted paths. |
1148
+ | `listHeight` | number | `256` | Height of the dropdown list in pixels. |
1087
1149
  | `options` | array | `[]` | Options can either be an array of primitive values, on an array of label, value pairs - supports html. |
1088
1150
  | `options.$.label` | string | - | Value label shown to user - supports html. |
1089
1151
  | `options.$.value` | string \| number \| boolean \| object \| array | - | Value selected. Can be of any type. |
@@ -1092,14 +1154,37 @@ Dropdown selector with search, clear, and custom icons.
1092
1154
  | `options.$.style` | object | - | Css style to applied to option. |
1093
1155
  | `options.$.color` | string | - | Color applied to the selected value shown in the input, and used to tint this option in the dropdown. |
1094
1156
  | `placeholder` | string | `"Select item"` | Placeholder text inside the block before user selects input. |
1157
+ | `placement` | string | `"bottomLeft"` | Position of the dropdown relative to the selector. Enum: `bottomLeft`, `bottomRight`, `topLeft`, `topRight`. |
1158
+ | `popupMatchSelectWidth` | boolean \| number | `true` | Make the dropdown the same width as the selector. Set a number of pixels for a fixed dropdown width, or false to size the dropdown to its options (this also turns off virtual scrolling). |
1159
+ | `prefix` | string | - | Text shown inside the selector before the selected value. |
1160
+ | `prefixIcon` | 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 show inside the selector before the selected value. Ignored when `prefix` is set. |
1161
+ | `prefixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
1162
+ | `prefixIcon.color` | string | - | Icon color. |
1163
+ | `prefixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
1164
+ | `prefixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
1165
+ | `prefixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
1166
+ | `prefixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
1167
+ | `prefixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
1168
+ | `prefixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
1169
+ | `prefixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
1095
1170
  | `loadingPlaceholder` | string | `"Loading"` | Placeholder text to show in options while the block is loading. |
1096
- | `notFoundContent` | string | `"not Found"` | Placeholder text to show when list of options are empty. |
1097
- | `showArrow` | boolean | `true` | Show the suffix icon at the drop-down position of the selector. |
1171
+ | `notFoundContent` | string | `"Not found"` | Placeholder text to show when list of options are empty. |
1172
+ | `showArrow` | boolean | `true` | Show the suffix icon at the drop-down position of the selector. antd shows the arrow by default; `false` hides it by clearing the suffix icon. |
1098
1173
  | `showSearch` | boolean | `true` | Make the selector options searchable. |
1099
1174
  | `size` | string | `"default"` | Size of the block. Enum: `small`, `default`, `large`. |
1100
- | `suffixIcon` | string \| object | `"AiOutlineDown"` | Name of an React-Icon (See all icons) or properties of an Icon block to customize icon at the drop-down position of the selector. |
1175
+ | `suffixIcon` | string \| object | `"chevron-down"` | 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 icon at the drop-down position of the selector. |
1176
+ | `suffixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
1177
+ | `suffixIcon.color` | string | - | Icon color. |
1178
+ | `suffixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
1179
+ | `suffixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
1180
+ | `suffixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
1181
+ | `suffixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
1182
+ | `suffixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
1183
+ | `suffixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
1184
+ | `suffixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
1101
1185
  | `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
1102
- | `variant` | string | - | Input variant. `solid` fills the whole input with the selected option color; `outlined` colors its border/text. `filled`/`borderless` are the antd input styles. Enum: `solid`, `outlined`, `filled`, `borderless`. |
1186
+ | `variant` | string | - | Input variant. `solid` fills the whole input with the selected option color; `outlined` colors its border/text. `filled`/`borderless`/`underlined` are the antd input styles. Enum: `solid`, `outlined`, `filled`, `borderless`, `underlined`. |
1187
+ | `virtual` | boolean | `true` | Only render the dropdown options in view. Set to false when options have very different heights, or so screen readers can reach every option. |
1103
1188
  | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design select tokens](https://ant.design/components/select#design-token). |
1104
1189
  | `theme.borderRadius` | number | `6` | Border radius of the selector. |
1105
1190
  | `theme.borderRadiusLG` | number | `8` | Border radius for large selectors. |
@@ -1144,6 +1229,7 @@ Dropdown selector with search, clear, and custom icons.
1144
1229
  | `onChange` | `{ value }` | Trigger action when selection is changed. |
1145
1230
  | `onFocus` | \- | Trigger action when selector gets focus. |
1146
1231
  | `onClear` | \- | Trigger action when selector is cleared. |
1232
+ | `onOpenChange` | `{ open }` | Trigger actions when the dropdown opens or closes. |
1147
1233
  | `onSearch` | `{ value }` | Trigger actions when input is changed. |
1148
1234
  | `onTooltipClick` | \- | Trigger actions when the tooltip icon is clicked. |
1149
1235
 
@@ -1157,6 +1243,8 @@ Dropdown selector with search, clear, and custom icons.
1157
1243
  | `/extra` | The Selector extra content. |
1158
1244
  | `/feedback` | The Selector validation feedback. |
1159
1245
  | `/options` | The Selector options. |
1246
+ | `/popup` | The Selector dropdown popup. |
1247
+ | `/prefixIcon` | The prefix icon in the Selector. |
1160
1248
  | `/suffixIcon` | The suffix icon in the Selector. |
1161
1249
 
1162
1250
  No slots defined.