@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
@@ -168,27 +168,27 @@ Phone number input with international country code selector.
168
168
  type: PhoneNumberInput
169
169
  properties:
170
170
  title: Prefix Phone Icon
171
- prefixIcon: AiOutlinePhone
171
+ prefixIcon: phone
172
172
  placeholder: Enter phone number
173
173
  - id: icon_suffix_check
174
174
  type: PhoneNumberInput
175
175
  properties:
176
176
  title: Suffix Check Icon
177
- suffixIcon: AiOutlineCheckCircle
177
+ suffixIcon: check-circle
178
178
  placeholder: Verified number
179
179
  - id: icon_both
180
180
  type: PhoneNumberInput
181
181
  properties:
182
182
  title: Both Icons
183
- prefixIcon: AiOutlinePhone
184
- suffixIcon: AiOutlineInfoCircle
183
+ prefixIcon: phone
184
+ suffixIcon: info
185
185
  placeholder: Enter number
186
186
  - id: icon_custom_color
187
187
  type: PhoneNumberInput
188
188
  properties:
189
189
  title: Custom Icon Color
190
190
  prefixIcon:
191
- name: AiOutlinePhone
191
+ name: phone
192
192
  color: "#1677ff"
193
193
  placeholder: Blue phone icon
194
194
  ```
@@ -387,7 +387,7 @@ Phone number input with international country code selector.
387
387
  placeholder: (555) 123-4567
388
388
  allowClear: true
389
389
  size: large
390
- prefixIcon: AiOutlinePhone
390
+ prefixIcon: phone
391
391
  replaceInput:
392
392
  pattern: "[^0-9()\\-\\s]"
393
393
  flags: g
@@ -403,7 +403,7 @@ Phone number input with international country code selector.
403
403
  placeholder: Enter international number
404
404
  allowClear: true
405
405
  maxLength: 15
406
- suffixIcon: AiOutlineGlobal
406
+ suffixIcon: globe
407
407
  label:
408
408
  inline: true
409
409
  span: 8
@@ -427,7 +427,7 @@ Phone number input with international country code selector.
427
427
  allowClear: true
428
428
  maxLength: 10
429
429
  placeholder: Enter mobile number
430
- prefixIcon: AiOutlineMobile
430
+ prefixIcon: Smartphone
431
431
  replaceInput:
432
432
  pattern: "[^0-9]"
433
433
  flags: g
@@ -449,7 +449,7 @@ Phone number input with international country code selector.
449
449
  allowClear: true
450
450
  size: large
451
451
  prefixIcon:
452
- name: AiOutlinePhone
452
+ name: phone
453
453
  color: "#52c41a"
454
454
  theme:
455
455
  colorPrimary: "#52c41a"
@@ -472,7 +472,7 @@ Phone number input with international country code selector.
472
472
  required: true
473
473
  properties:
474
474
  title: Full Name
475
- prefixIcon: AiOutlineUser
475
+ prefixIcon: user
476
476
  placeholder: John Doe
477
477
  label:
478
478
  colon: false
@@ -482,7 +482,7 @@ Phone number input with international country code selector.
482
482
  properties:
483
483
  title: Email Address
484
484
  type: email
485
- prefixIcon: AiOutlineMail
485
+ prefixIcon: mail
486
486
  placeholder: john@example.com
487
487
  label:
488
488
  colon: false
@@ -493,7 +493,7 @@ Phone number input with international country code selector.
493
493
  title: Phone Number
494
494
  defaultRegion: US
495
495
  allowClear: true
496
- prefixIcon: AiOutlinePhone
496
+ prefixIcon: phone
497
497
  placeholder: (555) 123-4567
498
498
  label:
499
499
  colon: false
@@ -519,7 +519,7 @@ Phone number input with international country code selector.
519
519
  title: Send Message
520
520
  color: primary
521
521
  variant: solid
522
- icon: AiOutlineSend
522
+ icon: send
523
523
  events:
524
524
  onClick:
525
525
  - id: contact_validate
@@ -548,7 +548,7 @@ Phone number input with international country code selector.
548
548
  title: Mobile Number
549
549
  defaultRegion: US
550
550
  allowClear: true
551
- prefixIcon: AiOutlineMobile
551
+ prefixIcon: Smartphone
552
552
  placeholder: Enter mobile number
553
553
  label:
554
554
  colon: false
@@ -565,7 +565,7 @@ Phone number input with international country code selector.
565
565
  required: true
566
566
  properties:
567
567
  title: Password
568
- prefixIcon: AiOutlineLock
568
+ prefixIcon: lock
569
569
  placeholder: At least 8 characters
570
570
  label:
571
571
  colon: false
@@ -590,7 +590,7 @@ Phone number input with international country code selector.
590
590
  title: Create Account
591
591
  color: primary
592
592
  variant: solid
593
- icon: AiOutlineArrowRight
593
+ icon: arrow-right
594
594
  events:
595
595
  onClick:
596
596
  - id: register_validate
@@ -608,6 +608,7 @@ Phone number input with international country code selector.
608
608
 
609
609
  | Property | Type | Default | Description |
610
610
  | --- | --- | --- | --- |
611
+ | `showFlags` | boolean | `true` | Show country flags in the country selector and input. |
611
612
  | `allowClear` | boolean | `false` | Allow the user to clear their input. |
612
613
  | `allowedRegions` | array | - | List of allowed ISO 3166-1 alpha-2 region codes. If allowedRegions is [] or null, the default list of all regions is used. |
613
614
  | `autoFocus` | boolean | `false` | Autofocus to the block on page load. |
@@ -616,35 +617,65 @@ Phone number input with international country code selector.
616
617
  | `disabled` | boolean | `false` | Disable the block if true. |
617
618
  | `maxLength` | integer | - | The max number of input characters. |
618
619
  | `placeholder` | string | - | Placeholder text inside the block before user types input. |
619
- | `prefix` | string | - | Prefix text for the block, priority over $prefix_con. |
620
- | `prefixIcon` | string \| object | - | Name of an React-Icon (See all icons) or properties of an Icon block to customize icon to prefix the text input. |
620
+ | `prefix` | string | - | Prefix text for the block, priority over prefixIcon. |
621
+ | `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 customize icon to prefix the text input. |
622
+ | `prefixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
623
+ | `prefixIcon.color` | string | - | Icon color. |
624
+ | `prefixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
625
+ | `prefixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
626
+ | `prefixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
627
+ | `prefixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
628
+ | `prefixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
629
+ | `prefixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
630
+ | `prefixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
621
631
  | `label` | object | - | Label properties. |
632
+ | `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
633
+ | `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
634
+ | `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. |
635
+ | `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
636
+ | `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
637
+ | `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
638
+ | `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
639
+ | `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
640
+ | `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
641
+ | `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
642
+ | `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
643
+ | `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
622
644
  | `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
623
645
  | `label.colon` | boolean | `true` | Append label with colon. |
624
646
  | `label.extra` | string | - | Extra text to display beneath the content - supports html. |
625
647
  | `label.title` | string | - | Label title - supports html. |
626
648
  | `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. |
627
649
  | `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
628
- | `label.tooltip.icon` | string | `"AiOutlineQuestionCircle"` | Name of the icon to show beside the label. |
650
+ | `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`. |
629
651
  | `label.tooltip.color` | string | - | Color of the tooltip icon. |
630
- | `label.span` | number | - | Label inline span. |
652
+ | `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. |
631
653
  | `label.disabled` | boolean | `false` | Hide input label. |
632
654
  | `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
633
655
  | `label.inline` | boolean | `false` | Render input and label inline. |
656
+ | `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
634
657
  | `replaceInput` | object | - | Regex used to sanitize input. |
635
658
  | `replaceInput.pattern` | string | - | The regular expression pattern to use to sanitize input. |
636
659
  | `replaceInput.flags` | string | - | The regex flags to use. The default value is 'gm'. |
637
660
  | `replaceInput.replacement` | string | - | The string used to replace the input that matches the pattern. The default value is ''. |
638
- | `showArrow` | boolean | `true` | Show the suffix icon at the drop-down position of the selector. |
661
+ | `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. |
639
662
  | `size` | string | `"middle"` | Size of the block. Enum: `small`, `middle`, `large`. |
640
- | `suffix` | string | - | Suffix text for the block, priority over suffixIcon. |
641
- | `suffixIcon` | string \| object | - | Name of an React-Icon (See all icons) or properties of an Icon block to customize icon to suffix the text input. |
663
+ | `suffix` | string | - | Suffix text for the block, shown before suffixIcon. |
664
+ | `suffixIcon` | 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 icon to suffix the text input. |
665
+ | `suffixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
666
+ | `suffixIcon.color` | string | - | Icon color. |
667
+ | `suffixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
668
+ | `suffixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
669
+ | `suffixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
670
+ | `suffixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
671
+ | `suffixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
672
+ | `suffixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
673
+ | `suffixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
642
674
  | `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
643
- | `variant` | string | - | Input visual variant. When set, takes precedence over bordered. Enum: `outlined`, `filled`, `borderless`. |
644
- | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design input tokens](https://ant.design/components/input#design-token). |
675
+ | `variant` | string | - | Input visual variant. The deprecated bordered: false takes precedence and renders the input as 'borderless'. Enum: `outlined`, `filled`, `borderless`, `underlined`. |
676
+ | `theme` | object | - | Antd design token overrides for this block, applied to both the region selector (antd Select) and the phone number input (antd Input). See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design input tokens](https://ant.design/components/input#design-token). |
645
677
  | `theme.activeBorderColor` | string | - | Border color when the input is focused. |
646
678
  | `theme.activeShadow` | string | - | Box shadow when the input is focused. |
647
- | `theme.addonBg` | string | `"rgba(0, 0, 0, 0.02)"` | Background color of addon elements. |
648
679
  | `theme.colorBgContainer` | string | - | Background color of the input. |
649
680
  | `theme.colorBorder` | string | - | Border color of the input. |
650
681
  | `theme.colorError` | string | - | Color used for error status. |
@@ -661,6 +692,7 @@ Phone number input with international country code selector.
661
692
  | `theme.hoverBorderColor` | string | - | Border color when the input is hovered. |
662
693
  | `theme.paddingBlock` | number | `4` | Vertical padding. |
663
694
  | `theme.paddingInline` | number | `11` | Horizontal padding. |
695
+ | `theme.selectorBg` | string | `"#ffffff"` | Background color of the region selector. |
664
696
  | `theme.warningActiveShadow` | string | `"0 0 0 2px rgba(255, 215, 5, 0.1)"` | Box shadow when the input has warning status and is focused. |
665
697
 
666
698
  | Event | Event Data | Description |
@@ -669,6 +701,7 @@ Phone number input with international country code selector.
669
701
  | `onCodeChange` | \- | Trigger action when the selector is changed. |
670
702
  | `onChange` | `{ value }` | Trigger action when the number is changed. |
671
703
  | `onBlur` | \- | Trigger action event occurs when input loses focus. |
704
+ | `onClear` | \- | Trigger action when the clear button is clicked. |
672
705
  | `onFocus` | \- | Trigger action when input gets focus. |
673
706
  | `onPressEnter` | \- | Trigger action when enter is pressed while text input is focused. |
674
707
  | `onTooltipClick` | \- | Trigger actions when the tooltip icon is clicked. |
@@ -0,0 +1,319 @@
1
+ # PlacesAutocomplete
2
+
3
+ Address input with place suggestions from the Google Places Autocomplete Data API. Must be wrapped in a `GoogleMapsScript` block. The block value is an object: selecting a suggestion fetches the configured place fields, renames them through `resultMapping` and writes them to the value, while typing writes the free text to `labelField` so a form always holds a usable address. Typing, selecting or clearing first removes the keys the previous place wrote, so typed text never keeps another place's coordinates; sibling keys written by other blocks are preserved, and the value becomes null when none remain. `onPlaceChanged` receives the mapped place, `onChange` the new value, and `onError` fires when the Places API request fails.
4
+
5
+ > The PlacesAutocomplete block must be wrapped in a GoogleMapsScript block, with a valid Google Maps API key that has the Places API (New) enabled. Load the places library on the script, `libraries: [places]`, so it is ready on first render; when it is not listed the block imports it on demand through `google.maps.importLibrary`. Outside a GoogleMapsScript, or when the places library cannot be loaded, the block is a plain text input that still writes the label field. Suggestions are requested `debounce` milliseconds (default 250) after the last keystroke. The examples on this page require a configured API key to return suggestions.
6
+
7
+ ```yaml
8
+ - id: pa_default
9
+ type: PlacesAutocomplete
10
+ ```
11
+
12
+ ```yaml
13
+ - id: pa_title
14
+ type: PlacesAutocomplete
15
+ properties:
16
+ title: Delivery address
17
+ placeholder: Search for an address
18
+ - id: pa_label_extra
19
+ type: PlacesAutocomplete
20
+ properties:
21
+ title: Site address
22
+ label:
23
+ extra: Start typing, then pick a suggestion to capture the full address.
24
+ tooltip: Addresses are verified against Google Places.
25
+ ```
26
+
27
+ ```yaml
28
+ - id: pa_fetch_fields
29
+ type: PlacesAutocomplete
30
+ properties:
31
+ title: Address
32
+ fetchFields:
33
+ - addressComponents
34
+ - location
35
+ - id
36
+ - displayName
37
+ ```
38
+
39
+ ```yaml
40
+ - id: pa_result_mapping
41
+ type: PlacesAutocomplete
42
+ properties:
43
+ title: Address
44
+ fetchFields:
45
+ - location
46
+ - addressComponents
47
+ resultMapping:
48
+ formattedAddress: address.line1
49
+ location: address.coordinates
50
+ addressComponents: address.components
51
+ labelField: address.line1
52
+ ```
53
+
54
+ ```yaml
55
+ - id: pa_region_codes
56
+ type: PlacesAutocomplete
57
+ properties:
58
+ title: Address in the United Kingdom
59
+ requestOptions:
60
+ includedRegionCodes:
61
+ - gb
62
+ - id: pa_location_bias
63
+ type: PlacesAutocomplete
64
+ properties:
65
+ title: Near central London
66
+ requestOptions:
67
+ includedPrimaryTypes:
68
+ - street_address
69
+ locationBias:
70
+ center:
71
+ lat: 51.5074
72
+ lng: -0.1278
73
+ radius: 20000
74
+ ```
75
+
76
+ ```yaml
77
+ - id: pa_size_small
78
+ type: PlacesAutocomplete
79
+ properties:
80
+ title: Small
81
+ size: small
82
+ - id: pa_size_middle
83
+ type: PlacesAutocomplete
84
+ properties:
85
+ title: Middle
86
+ size: middle
87
+ - id: pa_size_large
88
+ type: PlacesAutocomplete
89
+ properties:
90
+ title: Large
91
+ size: large
92
+ ```
93
+
94
+ ```yaml
95
+ - id: pa_variant_filled
96
+ type: PlacesAutocomplete
97
+ properties:
98
+ title: Filled
99
+ variant: filled
100
+ - id: pa_variant_borderless
101
+ type: PlacesAutocomplete
102
+ properties:
103
+ title: Borderless
104
+ variant: borderless
105
+ - id: pa_variant_underlined
106
+ type: PlacesAutocomplete
107
+ properties:
108
+ title: Underlined
109
+ variant: underlined
110
+ ```
111
+
112
+ ```yaml
113
+ - id: pa_disabled
114
+ type: PlacesAutocomplete
115
+ properties:
116
+ title: Disabled
117
+ disabled: true
118
+ - id: pa_no_clear
119
+ type: PlacesAutocomplete
120
+ properties:
121
+ title: Clear button hidden
122
+ allowClear: false
123
+ ```
124
+
125
+ ```yaml
126
+ - id: pa_custom_icon
127
+ type: PlacesAutocomplete
128
+ properties:
129
+ title: Address
130
+ optionsIcon:
131
+ name: home
132
+ color: "#1890ff"
133
+ loadingPlaceholder: Searching addresses...
134
+ notFoundContent: No matching address
135
+ ```
136
+
137
+ ```yaml
138
+ - id: pa_required
139
+ type: PlacesAutocomplete
140
+ required: true
141
+ properties:
142
+ title: Address
143
+ validate:
144
+ - message: An address must be selected.
145
+ status: error
146
+ pass:
147
+ _if_none:
148
+ - _state: pa_required.formattedAddress
149
+ - false
150
+ ```
151
+
152
+ ```yaml
153
+ - id: pa_events
154
+ type: PlacesAutocomplete
155
+ properties:
156
+ title: Address
157
+ fetchFields:
158
+ - location
159
+ events:
160
+ onPlaceChanged:
161
+ - id: pa_place_changed_message
162
+ type: DisplayMessage
163
+ params:
164
+ content:
165
+ _string.concat:
166
+ - "Selected: "
167
+ - _event: place.formattedAddress
168
+ duration: 2
169
+ onError:
170
+ - id: pa_error_message
171
+ type: DisplayMessage
172
+ params:
173
+ status: error
174
+ content:
175
+ _event: message
176
+ onSearch:
177
+ - id: pa_search_state
178
+ type: SetState
179
+ params:
180
+ pa_last_search:
181
+ _event: value
182
+ onClear:
183
+ - id: pa_clear_state
184
+ type: SetState
185
+ params:
186
+ pa_last_search: null
187
+ ```
188
+
189
+ Delivery details
190
+
191
+ ```yaml
192
+ - id: pa_form_title
193
+ type: Title
194
+ properties:
195
+ content: Delivery details
196
+ level: 4
197
+ - id: pa_form_address
198
+ type: PlacesAutocomplete
199
+ properties:
200
+ title: Street address
201
+ placeholder: Search for a delivery address
202
+ fetchFields:
203
+ - addressComponents
204
+ - location
205
+ label:
206
+ extra: Pick a suggestion to capture the coordinates for the driver.
207
+ - id: pa_form_instructions
208
+ type: TextArea
209
+ properties:
210
+ title: Delivery instructions
211
+ placeholder: Gate code, buzzer, where to leave the parcel
212
+ - id: pa_form_submit
213
+ type: Button
214
+ properties:
215
+ title: Save address
216
+ icon: save
217
+ ```
218
+
219
+ | Property | Type | Default | Description |
220
+ | --- | --- | --- | --- |
221
+ | `allowClear` | boolean | `true` | Allow the user to clear the input. Clearing removes the place keys from the block value, and sets the value to null when no sibling keys remain. |
222
+ | `autoFocus` | boolean | `false` | Autofocus to the block on page load. |
223
+ | `backfill` | boolean | `false` | Backfill the highlighted suggestion into the input when using the keyboard. |
224
+ | `bordered` | boolean | `true` | Whether or not the input has a border style. Deprecated, use variant instead. |
225
+ | `debounce` | number | `250` | Milliseconds to wait after the last keystroke before requesting suggestions from the Places API. |
226
+ | `defaultOpen` | boolean | `false` | Initial open state of the suggestions dropdown. |
227
+ | `disabled` | boolean | `false` | Disable the block if true. |
228
+ | `fetchFields` | array | - | Place fields to fetch when a suggestion is selected, in camelCase, for example `addressComponents`, `location` or `viewport`. `formattedAddress` is always fetched. See [Place fields](https://developers.google.com/maps/documentation/javascript/reference/place#Place). |
229
+ | `label` | object | - | Label properties. |
230
+ | `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
231
+ | `label.colon` | boolean | `true` | Append label with colon. |
232
+ | `label.disabled` | boolean | `false` | Hide input label. |
233
+ | `label.extra` | string | - | Extra text to display beneath the content - supports html. |
234
+ | `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
235
+ | `label.inline` | boolean | `false` | Render input and label inline. |
236
+ | `label.span` | number | - | Label inline span. |
237
+ | `label.title` | string | - | Label title - supports html. |
238
+ | `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. |
239
+ | `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
240
+ | `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`. |
241
+ | `label.tooltip.color` | string | - | Color of the tooltip icon. |
242
+ | `labelField` | string | `"formattedAddress"` | The key in the block value, after `resultMapping` is applied, that is displayed in the input and written when the user types free text. Typing removes the keys the previous place wrote (the mapped `input`, `id`, `formattedAddress` and `fetchFields` keys), so typed text never carries another place's fields. |
243
+ | `loadingPlaceholder` | string | `"Loading..."` | Text displayed in the dropdown while suggestions are being fetched. |
244
+ | `notFoundContent` | string | `"No results found"` | Text displayed in the dropdown when the search returns no suggestions. |
245
+ | `optionsIcon` | string \| object | `"location"` | Icon displayed before each suggestion in the dropdown: a semantic name like `location`, a Lucide icon name like `MapPin`, or a set-qualified name like `tabler:MapPin`, or properties of an Icon block. |
246
+ | `placeholder` | string | `"Start typing to search"` | Placeholder text inside the block before the user types input. |
247
+ | `requestOptions` | object | - | Additional options passed to the autocomplete request. See [AutocompleteRequest](https://developers.google.com/maps/documentation/javascript/reference/autocomplete-data#AutocompleteRequest). |
248
+ | `requestOptions.includedPrimaryTypes` | array | - | Restrict suggestions to these place types, for example `street_address` or `locality`. |
249
+ | `requestOptions.includedRegionCodes` | array | - | Restrict suggestions to these regions, as up to 15 CLDR two character region codes, for example `["us", "gb"]`. |
250
+ | `requestOptions.language` | string | - | The language in which to return the suggestions. |
251
+ | `requestOptions.locationBias` | object | - | Bias suggestions towards an area, as a circle or a rectangle. Cannot be used with locationRestriction. |
252
+ | `requestOptions.locationRestriction` | object | - | Restrict suggestions to an area, as a circle or a rectangle. Cannot be used with locationBias. |
253
+ | `requestOptions.origin` | object | - | The origin from which the distance to a suggestion is calculated, as a lat and lng object. |
254
+ | `requestOptions.origin.lat` | number | - | Lateral coordinate. |
255
+ | `requestOptions.origin.lng` | number | - | Longitudinal coordinate. |
256
+ | `requestOptions.region` | string | - | The region code used to format the suggestions. |
257
+ | `resultMapping` | object | - | Rename the fetched place fields before they are written to the block value. Dotted target paths are nested, for example `{ formattedAddress: address.line1, location: geometry.location }`. |
258
+ | `size` | string | `"middle"` | Size of the block. Enum: `small`, `middle`, `large`. |
259
+ | `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). |
260
+ | `theme.borderRadius` | number | `6` | Border radius of the input. |
261
+ | `theme.borderRadiusLG` | number | `8` | Border radius for large size. |
262
+ | `theme.borderRadiusSM` | number | `4` | Border radius for small size. |
263
+ | `theme.controlHeight` | number | `32` | Height of the input. |
264
+ | `theme.controlHeightLG` | number | `40` | Height for large size. |
265
+ | `theme.controlHeightSM` | number | `24` | Height for small size. |
266
+ | `theme.fontSize` | number | `14` | Font size of the input text. |
267
+ | `theme.fontSizeLG` | number | `16` | Font size for large size. |
268
+ | `theme.fontSizeSM` | number | `14` | Font size for small size. |
269
+ | `theme.colorPrimary` | string | - | Primary color, used for focus border and active state. |
270
+ | `theme.colorPrimaryHover` | string | - | Primary hover color, used for hover border state. |
271
+ | `theme.colorBgContainer` | string | `"#ffffff"` | Background color of the selector. |
272
+ | `theme.colorBgElevated` | string | `"#ffffff"` | Background color of the dropdown. |
273
+ | `theme.colorText` | string | - | Text color of the input. |
274
+ | `theme.colorTextPlaceholder` | string | - | Placeholder text color. |
275
+ | `theme.colorTextDisabled` | string | - | Text color when disabled. |
276
+ | `theme.colorBorder` | string | - | Border color of the input. |
277
+ | `theme.hoverBorderColor` | string | - | Border color when hovered. |
278
+ | `theme.activeBorderColor` | string | - | Border color when focused/active. |
279
+ | `theme.activeOutlineColor` | string | - | Outline color when focused. |
280
+ | `theme.clearBg` | string | `"#ffffff"` | Background color of the clear button. |
281
+ | `theme.optionSelectedBg` | string | `"#e6f4ff"` | Background color of the selected option. |
282
+ | `theme.optionSelectedColor` | string | `"rgba(0, 0, 0, 0.88)"` | Text color of the selected option. |
283
+ | `theme.optionSelectedFontWeight` | number | `600` | Font weight of the selected option. |
284
+ | `theme.optionActiveBg` | string | `"rgba(0, 0, 0, 0.04)"` | Background color of the active (hovered) option. |
285
+ | `theme.optionFontSize` | number | `14` | Font size of dropdown option text. |
286
+ | `theme.optionHeight` | number | `32` | Height of each dropdown option. |
287
+ | `theme.optionLineHeight` | number | - | Line height of dropdown option text. |
288
+ | `theme.optionPadding` | string \| number | `"5px 12px"` | Padding of each dropdown option. |
289
+ | `theme.selectorBg` | string | `"#ffffff"` | Background color of the selector input. |
290
+ | `theme.zIndexPopup` | number | `1050` | Z-index of the dropdown popup. |
291
+ | `theme.showArrowPaddingInlineEnd` | number | `18` | Right padding when the arrow icon is shown. |
292
+ | `theme.lineWidth` | number | `1` | Border width of the input. |
293
+ | `theme.paddingInline` | number | `11` | Horizontal padding of the input. |
294
+ | `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
295
+ | `variant` | string | `"outlined"` | Input visual variant. When set, takes precedence over bordered. Enum: `outlined`, `filled`, `borderless`, `underlined`. |
296
+
297
+ | Event | Event Data | Description |
298
+ | --- | --- | --- |
299
+ | `onBlur` | \- | Trigger actions when the input loses focus. |
300
+ | `onChange` | `{ value }` | Trigger actions after the block value changes, by typing, by selecting a suggestion or by clearing the input. |
301
+ | `onClear` | \- | Trigger actions when the input is cleared. |
302
+ | `onError` | `{ message }` | Trigger actions when fetching suggestions or place fields fails, for example when the Places API is not enabled on the API key. When fetching place fields fails, the typed text stays in the block value and onPlaceChanged is not triggered. |
303
+ | `onFocus` | \- | Trigger actions when the input gains focus. |
304
+ | `onPlaceChanged` | `{ place, value }` | Trigger actions after a suggestion is selected and its place fields have been fetched and written to the block value. |
305
+ | `onSearch` | `{ value }` | Trigger actions when the search text changes. |
306
+ | `onTooltipClick` | \- | Trigger actions when the tooltip icon is clicked. |
307
+
308
+ | Key | Target |
309
+ | --- | --- |
310
+ | `/block` | Outer block wrapper (always available). |
311
+ | `/element` | The PlacesAutocomplete input element. |
312
+ | `/selector` | The inner value container of the input (antd `content` semantic slot). |
313
+ | `/label` | The PlacesAutocomplete label. |
314
+ | `/extra` | The PlacesAutocomplete extra content. |
315
+ | `/feedback` | The PlacesAutocomplete validation feedback. |
316
+ | `/options` | Each suggestion in the dropdown. |
317
+ | `/popup` | The suggestions dropdown. |
318
+
319
+ No slots defined.