@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
@@ -60,6 +60,8 @@ blocks:
60
60
 
61
61
  **Small size:**
62
62
 
63
+ **Large size:**
64
+
63
65
  ```yaml
64
66
  - id: size_default_label
65
67
  type: Markdown
@@ -78,6 +80,36 @@ blocks:
78
80
  properties:
79
81
  total: 100
80
82
  size: small
83
+ - id: size_large_label
84
+ type: Markdown
85
+ properties:
86
+ content: "**Large size:**"
87
+ - id: size_large
88
+ type: Pagination
89
+ properties:
90
+ total: 100
91
+ size: large
92
+ ```
93
+
94
+ ```yaml
95
+ - id: align_center
96
+ type: Pagination
97
+ properties:
98
+ total: 100
99
+ align: center
100
+ - id: align_end
101
+ type: Pagination
102
+ properties:
103
+ total: 100
104
+ align: end
105
+ ```
106
+
107
+ ```yaml
108
+ - id: less_items
109
+ type: Pagination
110
+ properties:
111
+ total: 500
112
+ showLessItems: true
81
113
  ```
82
114
 
83
115
  **Simple (default size):**
@@ -106,17 +138,19 @@ blocks:
106
138
  size: small
107
139
  ```
108
140
 
109
- **Boolean (default format):**
141
+ **Default format:**
110
142
 
111
143
  **Custom string:**
112
144
 
145
+ **Hidden:**
146
+
113
147
  **Show total (small):**
114
148
 
115
149
  ```yaml
116
150
  - id: show_total_bool_label
117
151
  type: Markdown
118
152
  properties:
119
- content: "**Boolean (default format):**"
153
+ content: "**Default format:**"
120
154
  - id: show_total_bool
121
155
  type: Pagination
122
156
  properties:
@@ -131,6 +165,15 @@ blocks:
131
165
  properties:
132
166
  total: 85
133
167
  showTotal: 85 results found
168
+ - id: show_total_hidden_label
169
+ type: Markdown
170
+ properties:
171
+ content: "**Hidden:**"
172
+ - id: show_total_hidden
173
+ type: Pagination
174
+ properties:
175
+ total: 85
176
+ showTotal: false
134
177
  - id: show_total_small_label
135
178
  type: Markdown
136
179
  properties:
@@ -457,19 +500,26 @@ blocks:
457
500
 
458
501
  ```yaml
459
502
  - id: with_label_default
460
- type: Pagination
503
+ type: Label
461
504
  properties:
462
505
  title: Page Navigation
463
- total: 100
506
+ blocks:
507
+ - id: with_label_default_pagination
508
+ type: Pagination
509
+ properties:
510
+ total: 100
464
511
  - id: with_label_inline
465
- type: Pagination
512
+ type: Label
466
513
  properties:
467
514
  title: Results
468
- total: 200
469
- showTotal: true
470
- label:
471
- inline: true
472
- span: 6
515
+ inline: true
516
+ span: 6
517
+ blocks:
518
+ - id: with_label_inline_pagination
519
+ type: Pagination
520
+ properties:
521
+ total: 200
522
+ showTotal: true
473
523
  ```
474
524
 
475
525
  **Custom background and padding:**
@@ -500,7 +550,7 @@ blocks:
500
550
  type: Pagination
501
551
  style:
502
552
  .element:
503
- border: 1px solid
553
+ border: "1px solid #d9d9d9"
504
554
  borderRadius: 8
505
555
  padding: 12
506
556
  display: flex
@@ -633,9 +683,12 @@ blocks:
633
683
  | Property | Type | Default | Description |
634
684
  | --- | --- | --- | --- |
635
685
  | `total` | integer | `100` | Total number of items to be displayed in pagination. |
636
- | `size` | string | `"default"` | Pagination element size. Enum: `small`, `default`. |
686
+ | `size` | string | `"default"` | Pagination element size. Enum: `small`, `default`, `large`. |
687
+ | `align` | string | `"start"` | Horizontal alignment of the pagination. Enum: `start`, `center`, `end`. |
688
+ | `responsive` | boolean | `false` | Switch to the small size on narrow screens. Only applies when size is not set. |
689
+ | `showLessItems` | boolean | `false` | Show fewer page number items around the current page. |
637
690
  | `simple` | boolean | `false` | Use simplified pagination display. |
638
- | `showTotal` | boolean \| string \| object | `false` | Show pagination total number and range if boolean, or define a custom string or function to display. |
691
+ | `showTotal` | boolean \| string \| object | `true` | Show the item range and total, such as "1-10 of 100 items". Set false to hide it, a string to show custom text, or a function that receives the total and the range. |
639
692
  | `showSizeChanger` | boolean | `false` | Determine whether to show page size select, it will be true when total > 50. |
640
693
  | `showQuickJumper` | boolean | `false` | Determine whether you can jump to pages directly. |
641
694
  | `pageSizeOptions` | array | `[10,20,30,40]` | Specify the page size changer options. |
@@ -645,8 +698,10 @@ blocks:
645
698
  | `theme.itemBg` | string | `"#ffffff"` | Background color for pagination items. |
646
699
  | `theme.itemSize` | number | `32` | Size of pagination items. |
647
700
  | `theme.itemSizeSM` | number | `24` | Size of pagination items in small mode. |
701
+ | `theme.itemSizeLG` | number | `40` | Size of pagination items in large mode. |
648
702
  | `theme.itemActiveBg` | string | `"#ffffff"` | Background color for the active pagination item. |
649
- | `theme.itemActiveColor` | string | - | Text color for the active pagination item. |
703
+ | `theme.itemActiveColor` | string | `"#1677ff"` | Text color for the active pagination item. |
704
+ | `theme.itemActiveColorHover` | string | `"#4096ff"` | Text color for the active pagination item on hover. |
650
705
  | `theme.itemActiveColorDisabled` | string | `"rgba(0,0,0,0.25)"` | Text color for the active item when disabled. |
651
706
  | `theme.itemActiveBgDisabled` | string | `"rgba(0,0,0,0.15)"` | Background color for the active item when disabled. |
652
707
  | `theme.itemLinkBg` | string | `"#ffffff"` | Background color for prev/next link items. |
@@ -675,5 +730,6 @@ blocks:
675
730
  | --- | --- |
676
731
  | `/block` | Outer block wrapper (always available). |
677
732
  | `/element` | The Pagination element. |
733
+ | `/item` | Each page number item. |
678
734
 
679
735
  No slots defined.
@@ -12,8 +12,8 @@ Editable paragraph text with copyable and ellipsis support.
12
12
  - id: set_default
13
13
  type: SetState
14
14
  params:
15
- basic_default: Click the edit icon to start editing this paragraph. Changes are
16
- saved when you press Enter or click away.
15
+ basic_default: Click anywhere in this paragraph to edit it in place. Press Enter
16
+ or click away to save, or Escape to cancel.
17
17
  - id: basic_editable_object
18
18
  type: ParagraphInput
19
19
  properties:
@@ -39,6 +39,10 @@ Editable paragraph text with copyable and ellipsis support.
39
39
  type: ParagraphInput
40
40
  properties:
41
41
  editable: true
42
+ - id: basic_placeholder
43
+ type: ParagraphInput
44
+ properties:
45
+ placeholder: Add a description
42
46
  - id: basic_long
43
47
  type: ParagraphInput
44
48
  properties:
@@ -49,11 +53,11 @@ Editable paragraph text with copyable and ellipsis support.
49
53
  type: SetState
50
54
  params:
51
55
  basic_long: This is a longer paragraph to demonstrate how ParagraphInput handles
52
- multi-line content. When you click the edit icon, a text area
53
- appears allowing you to modify all of the text. The editable
54
- paragraph is useful for inline content editing scenarios where users
55
- should be able to quickly update descriptive text without navigating
56
- to a separate form.
56
+ multi-line content. When you click the text, it becomes editable in
57
+ place, with the caret where you clicked. The editable paragraph is
58
+ useful for inline content editing scenarios where users should be
59
+ able to quickly update descriptive text without navigating to a
60
+ separate form.
57
61
  ```
58
62
 
59
63
  ```yaml
@@ -67,7 +71,7 @@ Editable paragraph text with copyable and ellipsis support.
67
71
  - id: set_default
68
72
  type: SetState
69
73
  params:
70
- tooltip_short: Hover over the edit icon to see a short tooltip.
74
+ tooltip_short: Hover over this paragraph to see a short tooltip.
71
75
  - id: tooltip_descriptive
72
76
  type: ParagraphInput
73
77
  properties:
@@ -78,7 +82,7 @@ Editable paragraph text with copyable and ellipsis support.
78
82
  - id: set_default
79
83
  type: SetState
80
84
  params:
81
- tooltip_descriptive: Hover over the edit icon to see a descriptive tooltip.
85
+ tooltip_descriptive: Hover over this paragraph to see a descriptive tooltip.
82
86
  - id: tooltip_instructional
83
87
  type: ParagraphInput
84
88
  properties:
@@ -97,20 +101,20 @@ Editable paragraph text with copyable and ellipsis support.
97
101
  type: ParagraphInput
98
102
  properties:
99
103
  editable:
100
- icon: AiOutlineHighlight
104
+ icon: highlight
101
105
  tooltip: Highlight to edit
102
106
  events:
103
107
  onMount:
104
108
  - id: set_default
105
109
  type: SetState
106
110
  params:
107
- icon_highlight: This paragraph uses a highlight icon instead of the default edit
108
- icon.
111
+ icon_highlight: An edit icon is shown only when one is set. This one uses the
112
+ highlight icon.
109
113
  - id: icon_form
110
114
  type: ParagraphInput
111
115
  properties:
112
116
  editable:
113
- icon: AiOutlineForm
117
+ icon: SquarePen
114
118
  tooltip: Open editor
115
119
  events:
116
120
  onMount:
@@ -122,7 +126,7 @@ Editable paragraph text with copyable and ellipsis support.
122
126
  type: ParagraphInput
123
127
  properties:
124
128
  editable:
125
- icon: AiOutlineEdit
129
+ icon: edit
126
130
  tooltip: Edit paragraph
127
131
  events:
128
132
  onMount:
@@ -135,7 +139,7 @@ Editable paragraph text with copyable and ellipsis support.
135
139
  properties:
136
140
  editable:
137
141
  icon:
138
- name: AiOutlineEdit
142
+ name: edit
139
143
  color: "#1677ff"
140
144
  tooltip: Edit in blue
141
145
  events:
@@ -210,8 +214,8 @@ Editable paragraph text with copyable and ellipsis support.
210
214
  type: SetState
211
215
  params:
212
216
  autosize_true: This paragraph uses autoSize true so the text area automatically
213
- grows to fit the content when editing. Try clicking the edit icon to
214
- see the text area expand.
217
+ grows to fit the content when editing. Click the text to see the
218
+ text area expand.
215
219
  - id: autosize_min_max
216
220
  type: ParagraphInput
217
221
  properties:
@@ -287,7 +291,7 @@ Editable paragraph text with copyable and ellipsis support.
287
291
  type: ParagraphInput
288
292
  properties:
289
293
  editable:
290
- icon: AiOutlineEdit
294
+ icon: edit
291
295
  tooltip: Edit this paragraph
292
296
  maxLength: 150
293
297
  autoSize:
@@ -304,7 +308,7 @@ Editable paragraph text with copyable and ellipsis support.
304
308
  type: ParagraphInput
305
309
  properties:
306
310
  editable:
307
- icon: AiOutlineHighlight
311
+ icon: highlight
308
312
  tooltip: Highlight to edit (max 100 chars)
309
313
  maxLength: 100
310
314
  events:
@@ -689,7 +693,7 @@ Editable paragraph text with copyable and ellipsis support.
689
693
  type: ParagraphInput
690
694
  properties:
691
695
  copyable:
692
- icon: AiOutlineSnippets
696
+ icon: Files
693
697
  tooltips:
694
698
  - Copy snippet
695
699
  - Snippet copied!
@@ -705,8 +709,8 @@ Editable paragraph text with copyable and ellipsis support.
705
709
  properties:
706
710
  copyable:
707
711
  icon:
708
- - AiOutlineCopy
709
- - AiOutlineCheck
712
+ - copy
713
+ - check
710
714
  tooltips:
711
715
  - Copy text
712
716
  - Text copied!
@@ -722,7 +726,7 @@ Editable paragraph text with copyable and ellipsis support.
722
726
  properties:
723
727
  copyable:
724
728
  icon:
725
- name: AiOutlineCopy
729
+ name: copy
726
730
  color: "#1677ff"
727
731
  tooltips:
728
732
  - Copy
@@ -743,8 +747,8 @@ Editable paragraph text with copyable and ellipsis support.
743
747
  copyable:
744
748
  text: Custom text for clipboard
745
749
  icon:
746
- - AiOutlineCopy
747
- - AiOutlineCheck
750
+ - copy
751
+ - check
748
752
  tooltips:
749
753
  - Copy custom text
750
754
  - Custom text copied!
@@ -1060,8 +1064,8 @@ Editable paragraph text with copyable and ellipsis support.
1060
1064
  params:
1061
1065
  default_long: This is a longer default value that spans multiple words and
1062
1066
  demonstrates how ParagraphInput handles pre-populated content. Users
1063
- can click the edit icon to modify this text. The paragraph displays
1064
- the full content by default.
1067
+ can click the text to modify it. The paragraph displays the full
1068
+ content by default.
1065
1069
  - id: default_with_styles
1066
1070
  type: ParagraphInput
1067
1071
  properties:
@@ -1460,7 +1464,7 @@ Editable paragraph text with copyable and ellipsis support.
1460
1464
  type: success
1461
1465
  strong: true
1462
1466
  editable:
1463
- icon: AiOutlineEdit
1467
+ icon: edit
1464
1468
  tooltip: Edit this paragraph
1465
1469
  maxLength: 300
1466
1470
  autoSize: true
@@ -1545,7 +1549,7 @@ Editable paragraph text with copyable and ellipsis support.
1545
1549
  type: danger
1546
1550
  strong: true
1547
1551
  editable:
1548
- icon: AiOutlineEdit
1552
+ icon: edit
1549
1553
  tooltip: Edit error message
1550
1554
  maxLength: 500
1551
1555
  autoSize:
@@ -1553,8 +1557,8 @@ Editable paragraph text with copyable and ellipsis support.
1553
1557
  maxRows: 10
1554
1558
  copyable:
1555
1559
  icon:
1556
- - AiOutlineCopy
1557
- - AiOutlineCheck
1560
+ - copy
1561
+ - check
1558
1562
  tooltips:
1559
1563
  - Copy error details
1560
1564
  - Error details copied!
@@ -1611,12 +1615,21 @@ Editable paragraph text with copyable and ellipsis support.
1611
1615
  | `copyable.tooltips` | string \| array | - | Tooltip text, can be an array or two strings for before and after clicked. |
1612
1616
  | `delete` | boolean | `false` | Apply deleted (strikethrough) style. |
1613
1617
  | `disabled` | boolean | `false` | Apply disabled style. |
1614
- | `editable` | boolean \| object | `true` | Allow paragraph editing when true, editable settings can be provided with editable object. |
1615
- | `editable.icon` | string \| object | - | Edit icon. |
1616
- | `editable.tooltip` | string | - | Edit tooltip text. |
1618
+ | `editable` | boolean \| object | `true` | Allow editing the paragraph in place. Click the text, or focus it and press Enter, to edit. Enter saves, Escape cancels. Provide an object for editable settings. |
1619
+ | `editable.icon` | string \| object | - | Show an edit icon button after the text, like `edit`. No icon is shown by default, since clicking the text edits it. |
1620
+ | `editable.icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
1621
+ | `editable.icon.color` | string | - | Icon color. |
1622
+ | `editable.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
1623
+ | `editable.icon.rotate` | number | - | Number of degrees to rotate the icon. |
1624
+ | `editable.icon.spin` | boolean | - | Continuously spin the icon with animation. |
1625
+ | `editable.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
1626
+ | `editable.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
1627
+ | `editable.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
1628
+ | `editable.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
1629
+ | `editable.tooltip` | string | - | Tooltip text, shown on the edit icon, or on the text when no icon is set. |
1617
1630
  | `editable.editing` | boolean | - | Control editing state. |
1618
1631
  | `editable.maxLength` | number | - | Max length of text area input. |
1619
- | `editable.autoSize` | boolean \| object | `false` | Auto size the text area height when editing. |
1632
+ | `editable.autoSize` | boolean \| object | `true` | Grow the text area with its content when editing. Set false for a single scrolling line. |
1620
1633
  | `editable.autoSize.minRows` | number | - | Minimum number of rows for the text area. |
1621
1634
  | `editable.autoSize.maxRows` | number | - | Maximum number of rows for the text area. |
1622
1635
  | `ellipsis` | boolean \| object | `false` | Display ellipsis when text overflows a single line. |
@@ -1625,12 +1638,13 @@ Editable paragraph text with copyable and ellipsis support.
1625
1638
  | `ellipsis.suffix` | string | - | Suffix of ellipses content. |
1626
1639
  | `italic` | boolean | `false` | Apply italic style. |
1627
1640
  | `mark` | boolean | `false` | Apply marked (highlighted) style. |
1641
+ | `placeholder` | string | `"Empty"` | Muted text shown when the paragraph is empty and editable. |
1628
1642
  | `strong` | boolean | `false` | Apply strong (bold) style. |
1629
1643
  | `type` | string | `"default"` | Additional types. Don't specify for default. Enum: `success`, `default`, `secondary`, `warning`, `danger`. |
1630
1644
  | `underline` | boolean | `false` | Apply underline style. |
1631
1645
  | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design typography tokens](https://ant.design/components/typography#design-token). |
1632
- | `theme.titleMarginBottom` | string | `"0.5em"` | Margin bottom for title elements. |
1633
- | `theme.titleMarginTop` | string | `"1.2em"` | Margin top for title elements. |
1646
+ | `theme.titleMarginBottom` | string \| number | `"0.5em"` | Margin bottom for title elements, as a CSS length or a number of pixels. |
1647
+ | `theme.titleMarginTop` | string \| number | `"1.2em"` | Margin top for title elements, as a CSS length or a number of pixels. |
1634
1648
  | `theme.colorText` | string | - | Default text color. |
1635
1649
  | `theme.colorTextSecondary` | string | - | Text color for secondary type. |
1636
1650
  | `theme.colorSuccess` | string | - | Text color for success type. |
@@ -61,6 +61,29 @@ Password input with visibility toggle.
61
61
  title: No Placeholder
62
62
  ```
63
63
 
64
+ ```yaml
65
+ - id: password_prefix_icon
66
+ type: PasswordInput
67
+ properties:
68
+ title: Prefix Icon
69
+ prefixIcon: lock
70
+ placeholder: Password
71
+ - id: password_allow_clear
72
+ type: PasswordInput
73
+ properties:
74
+ title: Allow Clear
75
+ allowClear: true
76
+ prefixIcon: lock
77
+ maxLength: 32
78
+ placeholder: Up to 32 characters
79
+ - id: password_underlined
80
+ type: PasswordInput
81
+ properties:
82
+ title: Underlined
83
+ variant: underlined
84
+ prefix: PIN
85
+ ```
86
+
64
87
  ```yaml
65
88
  - id: disabled_empty
66
89
  type: PasswordInput
@@ -333,7 +356,7 @@ Password input with visibility toggle.
333
356
  properties:
334
357
  title: Username
335
358
  placeholder: Enter your username
336
- prefixIcon: AiOutlineUser
359
+ prefixIcon: user
337
360
  - id: login_password
338
361
  type: PasswordInput
339
362
  required: true
@@ -347,7 +370,7 @@ Password input with visibility toggle.
347
370
  type: Button
348
371
  properties:
349
372
  title: Sign In
350
- icon: AiOutlineLogin
373
+ icon: login
351
374
  type: primary
352
375
  size: large
353
376
  block: true
@@ -397,7 +420,7 @@ Password input with visibility toggle.
397
420
  type: Button
398
421
  properties:
399
422
  title: Update Password
400
- icon: AiOutlineLock
423
+ icon: lock
401
424
  type: primary
402
425
  size: large
403
426
  block: true
@@ -412,26 +435,52 @@ Password input with visibility toggle.
412
435
 
413
436
  | Property | Type | Default | Description |
414
437
  | --- | --- | --- | --- |
438
+ | `allowClear` | boolean | `false` | Allow the user to clear their input. |
415
439
  | `autoFocus` | boolean | `false` | Autofocus to the block on page load. |
416
440
  | `bordered` | boolean | `true` | Whether or not the input has a border style. Deprecated, use variant instead. |
417
441
  | `disabled` | boolean | `false` | Disable the block if true. |
442
+ | `maxLength` | integer | - | The max number of input characters. |
418
443
  | `placeholder` | string | - | Placeholder text inside the block before user types input. |
444
+ | `prefix` | string | - | Prefix text for the block, priority over prefixIcon. |
445
+ | `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 password input. |
446
+ | `prefixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
447
+ | `prefixIcon.color` | string | - | Icon color. |
448
+ | `prefixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
449
+ | `prefixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
450
+ | `prefixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
451
+ | `prefixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
452
+ | `prefixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
453
+ | `prefixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
454
+ | `prefixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
419
455
  | `label` | object | - | Label properties. |
456
+ | `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
457
+ | `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
458
+ | `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. |
459
+ | `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
460
+ | `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
461
+ | `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
462
+ | `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
463
+ | `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
464
+ | `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
465
+ | `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
466
+ | `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
467
+ | `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
420
468
  | `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
421
469
  | `label.colon` | boolean | `true` | Append label with colon. |
422
470
  | `label.extra` | string | - | Extra text to display beneath the content - supports html. |
423
471
  | `label.title` | string | - | Label title - supports html. |
424
472
  | `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. |
425
473
  | `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
426
- | `label.tooltip.icon` | string | `"AiOutlineQuestionCircle"` | Name of the icon to show beside the label. |
474
+ | `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`. |
427
475
  | `label.tooltip.color` | string | - | Color of the tooltip icon. |
428
- | `label.span` | number | - | Label inline span. |
476
+ | `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. |
429
477
  | `label.disabled` | boolean | `false` | Hide input label. |
430
478
  | `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
431
479
  | `label.inline` | boolean | `false` | Render input and label inline. |
480
+ | `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
432
481
  | `size` | string | `"default"` | Size of the block. Enum: `small`, `default`, `large`. |
433
482
  | `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
434
- | `variant` | string | - | Input visual variant. When set, takes precedence over bordered. Enum: `outlined`, `filled`, `borderless`. |
483
+ | `variant` | string | - | Input visual variant. The deprecated bordered: false takes precedence and renders the input as 'borderless'. Enum: `outlined`, `filled`, `borderless`, `underlined`. |
435
484
  | `visibilityToggle` | boolean | `true` | Show password visibility toggle button. |
436
485
  | `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). |
437
486
  | `theme.activeBorderColor` | string | `"#1677ff"` | Border color when the input is active (focused). |
@@ -453,6 +502,9 @@ Password input with visibility toggle.
453
502
  | `theme.hoverBorderColor` | string | `"#4096ff"` | Border color when hovering over the input. |
454
503
  | `theme.hoverBg` | string | `"#ffffff"` | Background color when hovering over the input. |
455
504
  | `theme.activeBg` | string | `"#ffffff"` | Background color when the input is active (focused). |
505
+ | `theme.inputFontSize` | number | `14` | Font size of the input text. |
506
+ | `theme.inputFontSizeLG` | number | `16` | Font size of the input text for large inputs. |
507
+ | `theme.inputFontSizeSM` | number | `14` | Font size of the input text for small inputs. |
456
508
  | `theme.paddingBlock` | number | `4` | Vertical padding of the input. |
457
509
  | `theme.paddingBlockLG` | number | `7` | Vertical padding for large inputs. |
458
510
  | `theme.paddingBlockSM` | number | `0` | Vertical padding for small inputs. |
@@ -465,6 +517,7 @@ Password input with visibility toggle.
465
517
  | --- | --- | --- |
466
518
  | `onBlur` | \- | Trigger action event occurs when text input loses focus. |
467
519
  | `onChange` | `{ value }` | Trigger action when text input is changed. |
520
+ | `onClear` | \- | Trigger action when the clear button is clicked. |
468
521
  | `onFocus` | \- | Trigger action when text input gets focus. |
469
522
  | `onPressEnter` | \- | Trigger action when enter is pressed while text input is focused. |
470
523
  | `onTooltipClick` | \- | Trigger actions when the tooltip icon is clicked. |
@@ -476,5 +529,6 @@ Password input with visibility toggle.
476
529
  | `/label` | The PasswordInput label. |
477
530
  | `/extra` | The PasswordInput extra content. |
478
531
  | `/feedback` | The PasswordInput validation feedback. |
532
+ | `/prefixIcon` | The prefix icon in the PasswordInput. |
479
533
 
480
534
  No slots defined.