@lowdefy/docs-content 0.0.0-experimental-20260928120643 → 6.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -1
- package/content/actions/link.md +0 -17
- package/content/actions/login.md +5 -23
- package/content/actions/logout.md +5 -5
- package/content/actions/pdfmake.md +2 -2
- package/content/actions/setdarkmode.md +2 -2
- package/content/agents/agent-properties.md +2 -4
- package/content/agents/agentchat.md +6 -21
- package/content/agents/agentconversations.md +2 -2
- package/content/concepts/ai-agent-docs.md +101 -313
- package/content/concepts/cli.md +3 -34
- package/content/concepts/connections-and-requests.md +0 -402
- package/content/concepts/custom-html.md +0 -40
- package/content/concepts/custom-styling.md +5 -50
- package/content/concepts/events-and-actions.md +2 -64
- package/content/concepts/i18n.md +2 -7
- package/content/concepts/keyboard-shortcuts.md +2 -2
- package/content/concepts/layout-overview.md +1 -1
- package/content/concepts/logger.md +0 -81
- package/content/concepts/lowdefy-schema.md +1 -4
- package/content/concepts/menus.md +7 -7
- package/content/concepts/module-authoring.md +2 -2
- package/content/connections/anthropic.md +2 -162
- package/content/connections/awss3.md +0 -54
- package/content/connections/google.md +2 -162
- package/content/connections/mongodb.md +3 -121
- package/content/connections/openai-connection.md +2 -162
- package/content/container-blocks/affix.md +7 -47
- package/content/container-blocks/alert.md +24 -76
- package/content/container-blocks/badge.md +24 -100
- package/content/container-blocks/box.md +9 -9
- package/content/container-blocks/card.md +25 -80
- package/content/container-blocks/carousel.md +7 -60
- package/content/container-blocks/collapse.md +9 -87
- package/content/container-blocks/configprovider.md +13 -35
- package/content/container-blocks/confirmmodal.md +23 -69
- package/content/container-blocks/content.md +98 -62
- package/content/container-blocks/descriptions.md +4 -45
- package/content/container-blocks/drawer.md +28 -92
- package/content/container-blocks/dropdownmenu.md +31 -119
- package/content/container-blocks/flex.md +62 -40
- package/content/container-blocks/footer.md +11 -15
- package/content/container-blocks/googlemapsheatmap.md +1 -1
- package/content/container-blocks/googlemapsscript.md +2 -2
- package/content/container-blocks/header.md +36 -71
- package/content/container-blocks/label.md +7 -34
- package/content/container-blocks/layout.md +34 -52
- package/content/container-blocks/masonry.md +71 -17
- package/content/container-blocks/mobilemenu.md +88 -131
- package/content/container-blocks/modal.md +26 -114
- package/content/container-blocks/pageheadermenu.md +31 -81
- package/content/container-blocks/pagesidebarlayout.md +26 -169
- package/content/container-blocks/pagesidermenu.md +42 -95
- package/content/container-blocks/popover.md +31 -34
- package/content/container-blocks/result.md +21 -32
- package/content/container-blocks/sider.md +122 -85
- package/content/container-blocks/span.md +7 -7
- package/content/container-blocks/spinner.md +3 -3
- package/content/container-blocks/splitter.md +68 -150
- package/content/container-blocks/tabs.md +12 -64
- package/content/container-blocks/tooltip.md +46 -22
- package/content/container-blocks/watermark.md +4 -22
- package/content/controls/reject.md +2 -4
- package/content/controls/throw.md +0 -1
- package/content/controls/try.md +2 -3
- package/content/deployment/deployment-environments.md +6 -8
- package/content/deployment/docker.md +7 -22
- package/content/deployment/node-server.md +0 -4
- package/content/deployment/vercel.md +6 -13
- package/content/display-blocks/aggrid.md +11 -26
- package/content/display-blocks/anchor.md +15 -15
- package/content/display-blocks/avatar.md +37 -57
- package/content/display-blocks/breadcrumb.md +21 -70
- package/content/display-blocks/button.md +18 -92
- package/content/display-blocks/calendar.md +0 -12
- package/content/display-blocks/dangeroushtml.md +1 -1
- package/content/display-blocks/difflist.md +1 -1
- package/content/display-blocks/difftimeline.md +1 -1
- package/content/display-blocks/divider.md +3 -64
- package/content/display-blocks/dropdownbutton.md +28 -79
- package/content/display-blocks/echart.md +1 -35
- package/content/display-blocks/floatbutton.md +42 -129
- package/content/display-blocks/html.md +1 -61
- package/content/display-blocks/icon.md +67 -250
- package/content/display-blocks/menu.md +73 -145
- package/content/display-blocks/message.md +124 -38
- package/content/display-blocks/notification.md +222 -94
- package/content/display-blocks/paragraph.md +9 -59
- package/content/display-blocks/progress.md +17 -96
- package/content/display-blocks/qrcode.md +4 -19
- package/content/display-blocks/s3download.md +1 -1
- package/content/display-blocks/search.md +7 -17
- package/content/display-blocks/skeletonbutton.md +0 -1
- package/content/display-blocks/skeletoninput.md +0 -1
- package/content/display-blocks/statistic.md +17 -75
- package/content/display-blocks/steps.md +25 -58
- package/content/display-blocks/tag.md +17 -102
- package/content/display-blocks/title.md +11 -50
- package/content/display-blocks/tour.md +23 -33
- package/content/input-blocks/autocomplete.md +9 -81
- package/content/input-blocks/buttonselector.md +8 -45
- package/content/input-blocks/checkboxselector.md +7 -97
- package/content/input-blocks/checkboxswitch.md +3 -33
- package/content/input-blocks/colorselector.md +14 -63
- package/content/input-blocks/daterangeselector.md +45 -165
- package/content/input-blocks/dateselector.md +41 -139
- package/content/input-blocks/datetimeselector.md +49 -158
- package/content/input-blocks/inputgallery.md +3 -3
- package/content/input-blocks/monthselector.md +52 -120
- package/content/input-blocks/multipleselector.md +39 -150
- package/content/input-blocks/numberinput.md +12 -98
- package/content/input-blocks/pagination.md +14 -70
- package/content/input-blocks/paragraphinput.md +37 -51
- package/content/input-blocks/passwordinput.md +6 -60
- package/content/input-blocks/phonenumberinput.md +26 -59
- package/content/input-blocks/radioselector.md +7 -83
- package/content/input-blocks/ratingslider.md +26 -57
- package/content/input-blocks/s3uploadbutton.md +24 -24
- package/content/input-blocks/s3uploaddragger.md +3 -3
- package/content/input-blocks/s3uploadphoto.md +5 -5
- package/content/input-blocks/segmentedselector.md +32 -72
- package/content/input-blocks/selector.md +21 -109
- package/content/input-blocks/switch.md +17 -65
- package/content/input-blocks/textarea.md +3 -32
- package/content/input-blocks/textinput.md +28 -69
- package/content/input-blocks/tiptapmentioninput.md +1 -1
- package/content/input-blocks/titleinput.md +12 -39
- package/content/input-blocks/treeinput.md +25 -49
- package/content/input-blocks/treemultipleselector.md +10 -127
- package/content/input-blocks/treeselector.md +9 -97
- package/content/input-blocks/upload.md +15 -64
- package/content/input-blocks/uploaddragger.md +1 -17
- package/content/input-blocks/uploadphoto.md +1 -18
- package/content/input-blocks/weekselector.md +55 -120
- package/content/list-blocks/controlledlist.md +15 -24
- package/content/list-blocks/list.md +11 -11
- package/content/list-blocks/masonrylist.md +34 -7
- package/content/migration/upgrade-guide.md +0 -1
- package/content/operators/_app.md +1 -2
- package/content/operators/_error.md +1 -23
- package/content/operators/_get.md +6 -6
- package/content/operators/_operator.md +3 -17
- package/content/operators/_ref.md +0 -258
- package/content/operators/_type.md +3 -14
- package/content/operators/_user.md +3 -3
- package/content/other/introduction.md +1 -1
- package/content/plugins/plugins-dev.md +0 -66
- package/content/plugins/plugins-introduction.md +1 -27
- package/content/testing/e2e-configuration.md +1 -8
- package/content/testing/e2e-getting-started.md +1 -1
- package/content/testing/e2e-introduction.md +1 -1
- package/content/tutorial/tutorial-actions-operators.md +2 -2
- package/content/tutorial/tutorial-add-blocks.md +2 -2
- package/content/tutorial/tutorial-create-page.md +2 -48
- package/content/tutorial/tutorial-display-data-page.md +3 -3
- package/content/tutorial/tutorial-requests-sql.md +0 -153
- package/content/tutorial/tutorial-start.md +1 -66
- package/content/user-authentication/login-and-logout.md +8 -158
- package/content/user-authentication/users-introduction.md +0 -8
- package/index.json +2 -6065
- package/package.json +1 -7
- package/scripts/extractAgentDocs.js +4 -36
- package/content/actions/emailotpsend.md +0 -58
- package/content/actions/emailotpverify.md +0 -77
- package/content/actions/getlocalstorage.md +0 -41
- package/content/actions/magiclinkverify.md +0 -113
- package/content/actions/posthogalias.md +0 -29
- package/content/actions/posthogcapture.md +0 -49
- package/content/actions/posthogcapturepageleave.md +0 -38
- package/content/actions/posthogfeatureflag.md +0 -50
- package/content/actions/posthoggroup.md +0 -37
- package/content/actions/posthogidentify.md +0 -54
- package/content/actions/posthoginit.md +0 -66
- package/content/actions/posthogoptin.md +0 -29
- package/content/actions/posthogoptout.md +0 -29
- package/content/actions/posthogpageview.md +0 -37
- package/content/actions/posthogreloadfeatureflags.md +0 -47
- package/content/actions/posthogreset.md +0 -28
- package/content/actions/posthogsetpersonproperties.md +0 -36
- package/content/actions/removelocalstorage.md +0 -26
- package/content/actions/setlocalstorage.md +0 -32
- package/content/adapter-reference/mongodbauthadapter.md +0 -46
- package/content/agents/agents-introduction.md +0 -107
- package/content/callback-reference/auth0logoutcallback.md +0 -54
- package/content/concepts/blocks.md +0 -150
- package/content/concepts/dynamic-page-content.md +0 -304
- package/content/concepts/html-attributes.md +0 -285
- package/content/concepts/lowdefy-api.md +0 -1110
- package/content/concepts/notifications.md +0 -155
- package/content/concepts/page-and-app-state.md +0 -244
- package/content/concepts/theming.md +0 -582
- package/content/connections/aigateway.md +0 -368
- package/content/connections/axioshttp.md +0 -181
- package/content/controls/while.md +0 -46
- package/content/display-blocks/clickablehtml.md +0 -239
- package/content/display-blocks/eventlog.md +0 -363
- package/content/display-blocks/pollingtimer.md +0 -263
- package/content/input-blocks/captcha.md +0 -40
- package/content/input-blocks/placesautocomplete.md +0 -319
- package/content/input-blocks/tagmultipleselector.md +0 -114
- package/content/input-blocks/tagselector.md +0 -114
- package/content/migration/auth-upgrade.md +0 -327
- package/content/migration/v3-to-v4.md +0 -417
- package/content/migration/v6-to-v7.md +0 -222
- package/content/operators/_cron.md +0 -292
- package/content/other/mongodbadapter.md +0 -3
- package/content/plugins/plugins-icon-sets.md +0 -267
- package/content/plugins/posthog.md +0 -275
- package/content/provider-reference/auth-js-providers.md +0 -107
- package/content/provider-reference/openidconnectprovider.md +0 -44
- package/content/testing/config-tests.md +0 -278
- package/content/tutorial/tutorial-requests-api.md +0 -155
- package/content/user-authentication/auth-configuration.md +0 -266
- package/content/user-authentication/auth-steps.md +0 -138
- package/content/user-authentication/mcp-oauth.md +0 -292
- package/content/user-authentication/organizations.md +0 -221
- package/content/user-authentication/protected-pages-apis.md +0 -97
- package/content/user-authentication/roles.md +0 -49
- package/content/user-authentication/two-factor.md +0 -229
- package/content/user-authentication/user-object.md +0 -58
- package/content/websockets/websocket-publish.md +0 -108
- package/content/websockets/websocket-subscriptions.md +0 -100
- package/content/websockets/websockets-introduction.md +0 -97
- package/hazards.json +0 -44
- package/scripts/hashDocSources.js +0 -38
- package/scripts/recordSourceHashes.js +0 -88
|
@@ -269,45 +269,6 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
269
269
|
value: blue
|
|
270
270
|
```
|
|
271
271
|
|
|
272
|
-
```yaml
|
|
273
|
-
- id: prefix_icon_selector
|
|
274
|
-
type: Selector
|
|
275
|
-
properties:
|
|
276
|
-
title: Prefix Icon
|
|
277
|
-
prefixIcon: globe
|
|
278
|
-
placeholder: Choose a region...
|
|
279
|
-
options:
|
|
280
|
-
- label: Europe
|
|
281
|
-
value: eu
|
|
282
|
-
- label: North America
|
|
283
|
-
value: na
|
|
284
|
-
- label: Asia Pacific
|
|
285
|
-
value: apac
|
|
286
|
-
- id: wide_dropdown_selector
|
|
287
|
-
type: Selector
|
|
288
|
-
style:
|
|
289
|
-
.element:
|
|
290
|
-
width: 160px
|
|
291
|
-
properties:
|
|
292
|
-
title: Dropdown Wider Than the Input
|
|
293
|
-
popupMatchSelectWidth: false
|
|
294
|
-
placement: bottomRight
|
|
295
|
-
options:
|
|
296
|
-
- label: Standard shipping (5 to 7 business days)
|
|
297
|
-
value: standard
|
|
298
|
-
- label: Express shipping (1 to 2 business days)
|
|
299
|
-
value: express
|
|
300
|
-
- id: underlined_selector
|
|
301
|
-
type: Selector
|
|
302
|
-
properties:
|
|
303
|
-
title: Underlined Variant
|
|
304
|
-
variant: underlined
|
|
305
|
-
options:
|
|
306
|
-
- Draft
|
|
307
|
-
- Published
|
|
308
|
-
- Archived
|
|
309
|
-
```
|
|
310
|
-
|
|
311
272
|
```yaml
|
|
312
273
|
- id: size_small
|
|
313
274
|
type: Selector
|
|
@@ -351,7 +312,7 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
351
312
|
type: Selector
|
|
352
313
|
properties:
|
|
353
314
|
title: Custom Suffix Icon
|
|
354
|
-
suffixIcon:
|
|
315
|
+
suffixIcon: AiOutlineSearch
|
|
355
316
|
placeholder: Search items...
|
|
356
317
|
options:
|
|
357
318
|
- label: Database
|
|
@@ -365,7 +326,7 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
365
326
|
properties:
|
|
366
327
|
title: Styled Suffix Icon
|
|
367
328
|
suffixIcon:
|
|
368
|
-
name:
|
|
329
|
+
name: AiOutlineFilter
|
|
369
330
|
color: "#722ed1"
|
|
370
331
|
placeholder: Filter options...
|
|
371
332
|
options:
|
|
@@ -379,7 +340,7 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
379
340
|
type: Selector
|
|
380
341
|
properties:
|
|
381
342
|
title: Custom Clear Icon
|
|
382
|
-
clearIcon:
|
|
343
|
+
clearIcon: AiOutlineDelete
|
|
383
344
|
placeholder: Select to see custom clear icon...
|
|
384
345
|
options:
|
|
385
346
|
- label: Item One
|
|
@@ -393,7 +354,7 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
393
354
|
properties:
|
|
394
355
|
title: Styled Clear Icon
|
|
395
356
|
clearIcon:
|
|
396
|
-
name:
|
|
357
|
+
name: AiOutlineCloseCircle
|
|
397
358
|
color: "#f5222d"
|
|
398
359
|
placeholder: Select then hover to clear...
|
|
399
360
|
options:
|
|
@@ -580,7 +541,7 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
580
541
|
- label: Three
|
|
581
542
|
value: 3
|
|
582
543
|
class:
|
|
583
|
-
|
|
544
|
+
element: rounded-lg shadow-sm
|
|
584
545
|
- id: class_label
|
|
585
546
|
type: Selector
|
|
586
547
|
properties:
|
|
@@ -591,7 +552,7 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
591
552
|
- label: Beta
|
|
592
553
|
value: beta
|
|
593
554
|
class:
|
|
594
|
-
|
|
555
|
+
label: text-blue-600 font-semibold
|
|
595
556
|
```
|
|
596
557
|
|
|
597
558
|
```yaml
|
|
@@ -785,7 +746,7 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
785
746
|
title: Searchable Styled Options
|
|
786
747
|
showSearch: true
|
|
787
748
|
placeholder: Search and select a status...
|
|
788
|
-
suffixIcon:
|
|
749
|
+
suffixIcon: AiOutlineSearch
|
|
789
750
|
options:
|
|
790
751
|
- label: '<span style="color: #52c41a;">Active</span>'
|
|
791
752
|
value: active
|
|
@@ -808,10 +769,10 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
808
769
|
showSearch: true
|
|
809
770
|
placeholder: Choose a department...
|
|
810
771
|
suffixIcon:
|
|
811
|
-
name:
|
|
772
|
+
name: AiOutlineTeam
|
|
812
773
|
color: "#1677ff"
|
|
813
774
|
clearIcon:
|
|
814
|
-
name:
|
|
775
|
+
name: AiOutlineClose
|
|
815
776
|
color: "#ff4d4f"
|
|
816
777
|
options:
|
|
817
778
|
- label: <b>Engineering</b>
|
|
@@ -885,7 +846,7 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
885
846
|
title: Country
|
|
886
847
|
showSearch: true
|
|
887
848
|
placeholder: Select your country...
|
|
888
|
-
suffixIcon:
|
|
849
|
+
suffixIcon: AiOutlineGlobal
|
|
889
850
|
options:
|
|
890
851
|
- label: United States
|
|
891
852
|
value: us
|
|
@@ -929,7 +890,7 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
929
890
|
title: Timezone
|
|
930
891
|
showSearch: true
|
|
931
892
|
placeholder: Select your timezone...
|
|
932
|
-
suffixIcon:
|
|
893
|
+
suffixIcon: AiOutlineClockCircle
|
|
933
894
|
label:
|
|
934
895
|
extra: Used for scheduling and notifications.
|
|
935
896
|
options:
|
|
@@ -951,7 +912,7 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
951
912
|
type: Button
|
|
952
913
|
properties:
|
|
953
914
|
title: Save Preferences
|
|
954
|
-
icon:
|
|
915
|
+
icon: AiOutlineSave
|
|
955
916
|
type: primary
|
|
956
917
|
size: large
|
|
957
918
|
block: true
|
|
@@ -976,7 +937,7 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
976
937
|
title: Product
|
|
977
938
|
showSearch: true
|
|
978
939
|
placeholder: Select a product...
|
|
979
|
-
suffixIcon:
|
|
940
|
+
suffixIcon: AiOutlineShopping
|
|
980
941
|
options:
|
|
981
942
|
- label: Laptop Pro 15"
|
|
982
943
|
value: laptop_pro
|
|
@@ -1036,7 +997,7 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
1036
997
|
type: Button
|
|
1037
998
|
properties:
|
|
1038
999
|
title: Place Order
|
|
1039
|
-
icon:
|
|
1000
|
+
icon: AiOutlineCheckCircle
|
|
1040
1001
|
type: primary
|
|
1041
1002
|
size: large
|
|
1042
1003
|
block: true
|
|
@@ -1104,48 +1065,25 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
1104
1065
|
| `allowClear` | boolean | `true` | Allow the user to clear the selected value, sets the value to null. |
|
|
1105
1066
|
| `autoFocus` | boolean | `false` | Autofocus to the block on page load. |
|
|
1106
1067
|
| `bordered` | boolean | `true` | Whether or not the selector has a border style. Deprecated, use variant instead. |
|
|
1107
|
-
| `clearIcon` | string \| object | `"
|
|
1108
|
-
| `clearIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
1109
|
-
| `clearIcon.color` | string | - | Icon color. |
|
|
1110
|
-
| `clearIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
1111
|
-
| `clearIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
1112
|
-
| `clearIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
1113
|
-
| `clearIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
1114
|
-
| `clearIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
1115
|
-
| `clearIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
1116
|
-
| `clearIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
1068
|
+
| `clearIcon` | string \| object | `"AiOutlineCloseCircle"` | Name of an React-Icon (See all icons) or properties of an Icon block to customize icon at far right position of the selector, shown when user is given option to clear input. |
|
|
1117
1069
|
| `label` | object | - | Label properties. |
|
|
1118
|
-
| `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
|
|
1119
|
-
| `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
1120
|
-
| `label.sm` | object | - | Label width on small screens (576px and up) when the label is not inline. Also applies below 576px unless `xs` is set. |
|
|
1121
|
-
| `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
1122
|
-
| `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
|
|
1123
|
-
| `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
1124
|
-
| `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
|
|
1125
|
-
| `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
1126
|
-
| `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
|
|
1127
|
-
| `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
1128
|
-
| `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
|
|
1129
|
-
| `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
1130
1070
|
| `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
|
|
1131
1071
|
| `label.colon` | boolean | `true` | Append label with colon. |
|
|
1132
1072
|
| `label.extra` | string | - | Extra text to display beneath the content - supports html. |
|
|
1133
1073
|
| `label.title` | string | - | Label title - supports html. |
|
|
1134
1074
|
| `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. |
|
|
1135
1075
|
| `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
|
|
1136
|
-
| `label.tooltip.icon` | string | `"
|
|
1076
|
+
| `label.tooltip.icon` | string | `"AiOutlineQuestionCircle"` | Name of the icon to show beside the label. |
|
|
1137
1077
|
| `label.tooltip.color` | string | - | Color of the tooltip icon. |
|
|
1138
|
-
| `label.span` | number | - | Label
|
|
1078
|
+
| `label.span` | number | - | Label inline span. |
|
|
1139
1079
|
| `label.disabled` | boolean | `false` | Hide input label. |
|
|
1140
1080
|
| `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
|
|
1141
1081
|
| `label.inline` | boolean | `false` | Render input and label inline. |
|
|
1142
|
-
| `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
|
|
1143
1082
|
| `disabled` | boolean | `false` | Disable the block if true. |
|
|
1144
1083
|
| `data` | array | - | Alternative to `options`: an array of raw rows. Each row is rendered to a label with the `html` template, and `valueKey` selects which field becomes the value. Use this to drive a selector directly from data without building label/value pairs in your request. |
|
|
1145
1084
|
| `html` | string | - | Nunjucks template that renders each option label when using `data`. The context exposes `item` (the current row) and `index` (the zero-based row index). Ignored when `options` is used. |
|
|
1146
1085
|
| `valueKey` | string | - | Field used as the selected value. With `options` it names the value field (defaults to "value"). With `data` it names the field stored when an option is selected; omit it to store the whole row. Supports dotted paths (e.g. "user.id"). |
|
|
1147
1086
|
| `primaryKey` | string | - | Field used to match the current value (e.g. set with SetState) back to an option for highlighting. Defaults to `valueKey`. Set this when the stored value is the whole row but a single field (e.g. "id") uniquely identifies it. In the tree selectors it also serves as each node’s id, referenced by `parentKey`. Supports dotted paths. |
|
|
1148
|
-
| `listHeight` | number | `256` | Height of the dropdown list in pixels. |
|
|
1149
1087
|
| `options` | array | `[]` | Options can either be an array of primitive values, on an array of label, value pairs - supports html. |
|
|
1150
1088
|
| `options.$.label` | string | - | Value label shown to user - supports html. |
|
|
1151
1089
|
| `options.$.value` | string \| number \| boolean \| object \| array | - | Value selected. Can be of any type. |
|
|
@@ -1154,37 +1092,14 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
1154
1092
|
| `options.$.style` | object | - | Css style to applied to option. |
|
|
1155
1093
|
| `options.$.color` | string | - | Color applied to the selected value shown in the input, and used to tint this option in the dropdown. |
|
|
1156
1094
|
| `placeholder` | string | `"Select item"` | Placeholder text inside the block before user selects input. |
|
|
1157
|
-
| `placement` | string | `"bottomLeft"` | Position of the dropdown relative to the selector. Enum: `bottomLeft`, `bottomRight`, `topLeft`, `topRight`. |
|
|
1158
|
-
| `popupMatchSelectWidth` | boolean \| number | `true` | Make the dropdown the same width as the selector. Set a number of pixels for a fixed dropdown width, or false to size the dropdown to its options (this also turns off virtual scrolling). |
|
|
1159
|
-
| `prefix` | string | - | Text shown inside the selector before the selected value. |
|
|
1160
|
-
| `prefixIcon` | string \| object | - | Icon name (a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`) or properties of an Icon block to show inside the selector before the selected value. Ignored when `prefix` is set. |
|
|
1161
|
-
| `prefixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
1162
|
-
| `prefixIcon.color` | string | - | Icon color. |
|
|
1163
|
-
| `prefixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
1164
|
-
| `prefixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
1165
|
-
| `prefixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
1166
|
-
| `prefixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
1167
|
-
| `prefixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
1168
|
-
| `prefixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
1169
|
-
| `prefixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
1170
1095
|
| `loadingPlaceholder` | string | `"Loading"` | Placeholder text to show in options while the block is loading. |
|
|
1171
|
-
| `notFoundContent` | string | `"
|
|
1172
|
-
| `showArrow` | boolean | `true` | Show the suffix icon at the drop-down position of the selector.
|
|
1096
|
+
| `notFoundContent` | string | `"not Found"` | Placeholder text to show when list of options are empty. |
|
|
1097
|
+
| `showArrow` | boolean | `true` | Show the suffix icon at the drop-down position of the selector. |
|
|
1173
1098
|
| `showSearch` | boolean | `true` | Make the selector options searchable. |
|
|
1174
1099
|
| `size` | string | `"default"` | Size of the block. Enum: `small`, `default`, `large`. |
|
|
1175
|
-
| `suffixIcon` | string \| object | `"
|
|
1176
|
-
| `suffixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
1177
|
-
| `suffixIcon.color` | string | - | Icon color. |
|
|
1178
|
-
| `suffixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
1179
|
-
| `suffixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
1180
|
-
| `suffixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
1181
|
-
| `suffixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
1182
|
-
| `suffixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
1183
|
-
| `suffixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
1184
|
-
| `suffixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
1100
|
+
| `suffixIcon` | string \| object | `"AiOutlineDown"` | Name of an React-Icon (See all icons) or properties of an Icon block to customize icon at the drop-down position of the selector. |
|
|
1185
1101
|
| `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
|
|
1186
|
-
| `variant` | string | - | Input variant. `solid` fills the whole input with the selected option color; `outlined` colors its border/text. `filled`/`borderless
|
|
1187
|
-
| `virtual` | boolean | `true` | Only render the dropdown options in view. Set to false when options have very different heights, or so screen readers can reach every option. |
|
|
1102
|
+
| `variant` | string | - | Input variant. `solid` fills the whole input with the selected option color; `outlined` colors its border/text. `filled`/`borderless` are the antd input styles. Enum: `solid`, `outlined`, `filled`, `borderless`. |
|
|
1188
1103
|
| `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). |
|
|
1189
1104
|
| `theme.borderRadius` | number | `6` | Border radius of the selector. |
|
|
1190
1105
|
| `theme.borderRadiusLG` | number | `8` | Border radius for large selectors. |
|
|
@@ -1229,7 +1144,6 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
1229
1144
|
| `onChange` | `{ value }` | Trigger action when selection is changed. |
|
|
1230
1145
|
| `onFocus` | \- | Trigger action when selector gets focus. |
|
|
1231
1146
|
| `onClear` | \- | Trigger action when selector is cleared. |
|
|
1232
|
-
| `onOpenChange` | `{ open }` | Trigger actions when the dropdown opens or closes. |
|
|
1233
1147
|
| `onSearch` | `{ value }` | Trigger actions when input is changed. |
|
|
1234
1148
|
| `onTooltipClick` | \- | Trigger actions when the tooltip icon is clicked. |
|
|
1235
1149
|
|
|
@@ -1243,8 +1157,6 @@ Dropdown selector with search, clear, and custom icons.
|
|
|
1243
1157
|
| `/extra` | The Selector extra content. |
|
|
1244
1158
|
| `/feedback` | The Selector validation feedback. |
|
|
1245
1159
|
| `/options` | The Selector options. |
|
|
1246
|
-
| `/popup` | The Selector dropdown popup. |
|
|
1247
|
-
| `/prefixIcon` | The prefix icon in the Selector. |
|
|
1248
1160
|
| `/suffixIcon` | The suffix icon in the Selector. |
|
|
1249
1161
|
|
|
1250
1162
|
No slots defined.
|
|
@@ -25,22 +25,6 @@ Toggle switch with optional text and icon labels.
|
|
|
25
25
|
disabled: true
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
```yaml
|
|
29
|
-
- id: loading_switch
|
|
30
|
-
type: Switch
|
|
31
|
-
properties:
|
|
32
|
-
title: Saving
|
|
33
|
-
loading: true
|
|
34
|
-
label:
|
|
35
|
-
extra: Shows a spinner and ignores clicks, eg. while a request saves the value.
|
|
36
|
-
events:
|
|
37
|
-
onMount:
|
|
38
|
-
- id: set_default
|
|
39
|
-
type: SetState
|
|
40
|
-
params:
|
|
41
|
-
loading_switch: true
|
|
42
|
-
```
|
|
43
|
-
|
|
44
28
|
```yaml
|
|
45
29
|
- id: text_on_off
|
|
46
30
|
type: Switch
|
|
@@ -90,25 +74,25 @@ Toggle switch with optional text and icon labels.
|
|
|
90
74
|
type: Switch
|
|
91
75
|
properties:
|
|
92
76
|
title: Custom Checked Icon
|
|
93
|
-
checkedIcon:
|
|
94
|
-
uncheckedIcon:
|
|
77
|
+
checkedIcon: AiOutlineLike
|
|
78
|
+
uncheckedIcon: AiOutlineDislike
|
|
95
79
|
label:
|
|
96
80
|
disabled: true
|
|
97
81
|
- id: icon_lock
|
|
98
82
|
type: Switch
|
|
99
83
|
properties:
|
|
100
84
|
title: Lock / Unlock
|
|
101
|
-
checkedIcon:
|
|
102
|
-
uncheckedIcon:
|
|
85
|
+
checkedIcon: AiOutlineLock
|
|
86
|
+
uncheckedIcon: AiOutlineUnlock
|
|
103
87
|
label:
|
|
104
88
|
disabled: true
|
|
105
89
|
- id: icon_sound
|
|
106
90
|
type: Switch
|
|
107
91
|
properties:
|
|
108
92
|
title: Sound On / Off
|
|
109
|
-
checkedIcon:
|
|
93
|
+
checkedIcon: AiOutlineSound
|
|
110
94
|
uncheckedIcon:
|
|
111
|
-
name:
|
|
95
|
+
name: AiOutlineStop
|
|
112
96
|
color: "#999"
|
|
113
97
|
label:
|
|
114
98
|
disabled: true
|
|
@@ -116,16 +100,16 @@ Toggle switch with optional text and icon labels.
|
|
|
116
100
|
type: Switch
|
|
117
101
|
properties:
|
|
118
102
|
title: Visibility Toggle
|
|
119
|
-
checkedIcon:
|
|
120
|
-
uncheckedIcon:
|
|
103
|
+
checkedIcon: AiOutlineEye
|
|
104
|
+
uncheckedIcon: AiOutlineEyeInvisible
|
|
121
105
|
label:
|
|
122
106
|
disabled: true
|
|
123
107
|
- id: icon_power
|
|
124
108
|
type: Switch
|
|
125
109
|
properties:
|
|
126
110
|
title: Power Toggle
|
|
127
|
-
checkedIcon:
|
|
128
|
-
uncheckedIcon:
|
|
111
|
+
checkedIcon: AiOutlineThunderbolt
|
|
112
|
+
uncheckedIcon: AiOutlinePoweroff
|
|
129
113
|
label:
|
|
130
114
|
disabled: true
|
|
131
115
|
```
|
|
@@ -236,8 +220,8 @@ Toggle switch with optional text and icon labels.
|
|
|
236
220
|
properties:
|
|
237
221
|
title: Disabled with Icons
|
|
238
222
|
disabled: true
|
|
239
|
-
checkedIcon:
|
|
240
|
-
uncheckedIcon:
|
|
223
|
+
checkedIcon: AiOutlineLike
|
|
224
|
+
uncheckedIcon: AiOutlineDislike
|
|
241
225
|
label:
|
|
242
226
|
disabled: true
|
|
243
227
|
```
|
|
@@ -495,7 +479,7 @@ Toggle switch with optional text and icon labels.
|
|
|
495
479
|
type: Button
|
|
496
480
|
properties:
|
|
497
481
|
title: Save Privacy Settings
|
|
498
|
-
icon:
|
|
482
|
+
icon: AiOutlineSave
|
|
499
483
|
type: primary
|
|
500
484
|
block: true
|
|
501
485
|
events:
|
|
@@ -510,58 +494,26 @@ Toggle switch with optional text and icon labels.
|
|
|
510
494
|
| Property | Type | Default | Description |
|
|
511
495
|
| --- | --- | --- | --- |
|
|
512
496
|
| `autoFocus` | boolean | `false` | Autofocus to the block on page load. |
|
|
513
|
-
| `checkedIcon` | string \| object | `"
|
|
514
|
-
| `checkedIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
515
|
-
| `checkedIcon.color` | string | - | Icon color. |
|
|
516
|
-
| `checkedIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
517
|
-
| `checkedIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
518
|
-
| `checkedIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
519
|
-
| `checkedIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
520
|
-
| `checkedIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
521
|
-
| `checkedIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
522
|
-
| `checkedIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
497
|
+
| `checkedIcon` | string \| object | `"AiOutlineCheck"` | Name of an React-Icon (See all icons) or properties of an Icon block to customize icon to shown when switch is checked (true). |
|
|
523
498
|
| `checkedText` | string | - | Text to shown when switch is checked (true). |
|
|
524
499
|
| `color` | string | - | Switch checked color. |
|
|
525
500
|
| `disabled` | boolean | `false` | Disable the block if true. |
|
|
526
501
|
| `label` | object | - | Label properties. |
|
|
527
|
-
| `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
|
|
528
|
-
| `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
529
|
-
| `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. |
|
|
530
|
-
| `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
531
|
-
| `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
|
|
532
|
-
| `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
533
|
-
| `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
|
|
534
|
-
| `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
535
|
-
| `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
|
|
536
|
-
| `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
537
|
-
| `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
|
|
538
|
-
| `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
539
502
|
| `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
|
|
540
503
|
| `label.colon` | boolean | `true` | Append label with colon. |
|
|
541
504
|
| `label.extra` | string | - | Extra text to display beneath the content - supports html. |
|
|
542
505
|
| `label.title` | string | - | Label title - supports html. |
|
|
543
506
|
| `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. |
|
|
544
507
|
| `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
|
|
545
|
-
| `label.tooltip.icon` | string | `"
|
|
508
|
+
| `label.tooltip.icon` | string | `"AiOutlineQuestionCircle"` | Name of the icon to show beside the label. |
|
|
546
509
|
| `label.tooltip.color` | string | - | Color of the tooltip icon. |
|
|
547
|
-
| `label.span` | number | - | Label
|
|
510
|
+
| `label.span` | number | - | Label inline span. |
|
|
548
511
|
| `label.disabled` | boolean | `false` | Hide input label. |
|
|
549
512
|
| `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
|
|
550
513
|
| `label.inline` | boolean | `false` | Render input and label inline. |
|
|
551
|
-
| `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
|
|
552
|
-
| `loading` | boolean | `false` | Show a loading indicator in the switch handle and block changes, eg. while a request saves the new value. |
|
|
553
514
|
| `size` | string | `"default"` | Size of the block. Enum: `small`, `default`. |
|
|
554
515
|
| `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
|
|
555
|
-
| `uncheckedIcon` | string \| object | `"
|
|
556
|
-
| `uncheckedIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
557
|
-
| `uncheckedIcon.color` | string | - | Icon color. |
|
|
558
|
-
| `uncheckedIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
559
|
-
| `uncheckedIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
560
|
-
| `uncheckedIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
561
|
-
| `uncheckedIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
562
|
-
| `uncheckedIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
563
|
-
| `uncheckedIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
564
|
-
| `uncheckedIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
516
|
+
| `uncheckedIcon` | string \| object | `"AiOutlineClose"` | Name of an React-Icon (See all icons) or properties of an Icon block to customize icon to shown when switch is unchecked (false). |
|
|
565
517
|
| `uncheckedText` | string | - | Text to shown when switch is not checked (false). |
|
|
566
518
|
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design switch tokens](https://ant.design/components/switch#design-token). |
|
|
567
519
|
| `theme.trackHeight` | number | `22` | Height of the switch track. |
|
|
@@ -241,21 +241,6 @@ Multi-line text input with auto-sizing, character count, and clear button.
|
|
|
241
241
|
placeholder: Larger borderless textarea
|
|
242
242
|
```
|
|
243
243
|
|
|
244
|
-
```yaml
|
|
245
|
-
- id: variant_filled
|
|
246
|
-
type: TextArea
|
|
247
|
-
properties:
|
|
248
|
-
title: Filled
|
|
249
|
-
variant: filled
|
|
250
|
-
placeholder: Filled variant
|
|
251
|
-
- id: variant_underlined
|
|
252
|
-
type: TextArea
|
|
253
|
-
properties:
|
|
254
|
-
title: Underlined
|
|
255
|
-
variant: underlined
|
|
256
|
-
placeholder: Underlined variant
|
|
257
|
-
```
|
|
258
|
-
|
|
259
244
|
```yaml
|
|
260
245
|
- id: disabled_empty
|
|
261
246
|
type: TextArea
|
|
@@ -658,38 +643,25 @@ Multi-line text input with auto-sizing, character count, and clear button.
|
|
|
658
643
|
| `bordered` | boolean | `true` | Whether or not the textarea has a border style. Deprecated, use variant instead. |
|
|
659
644
|
| `disabled` | boolean | `false` | Disable the block if true. |
|
|
660
645
|
| `label` | object | - | Label properties. |
|
|
661
|
-
| `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
|
|
662
|
-
| `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
663
|
-
| `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. |
|
|
664
|
-
| `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
665
|
-
| `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
|
|
666
|
-
| `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
667
|
-
| `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
|
|
668
|
-
| `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
669
|
-
| `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
|
|
670
|
-
| `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
671
|
-
| `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
|
|
672
|
-
| `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
673
646
|
| `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
|
|
674
647
|
| `label.colon` | boolean | `true` | Append label with colon. |
|
|
675
648
|
| `label.extra` | string | - | Extra text to display beneath the content - supports html. |
|
|
676
649
|
| `label.title` | string | - | Label title - supports html. |
|
|
677
650
|
| `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. |
|
|
678
651
|
| `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
|
|
679
|
-
| `label.tooltip.icon` | string | `"
|
|
652
|
+
| `label.tooltip.icon` | string | `"AiOutlineQuestionCircle"` | Name of the icon to show beside the label. |
|
|
680
653
|
| `label.tooltip.color` | string | - | Color of the tooltip icon. |
|
|
681
|
-
| `label.span` | number | - | Label
|
|
654
|
+
| `label.span` | number | - | Label inline span. |
|
|
682
655
|
| `label.disabled` | boolean | `false` | Hide input label. |
|
|
683
656
|
| `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
|
|
684
657
|
| `label.inline` | boolean | `false` | Render input and label inline. |
|
|
685
|
-
| `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
|
|
686
658
|
| `maxLength` | integer | - | The max number of input characters. |
|
|
687
659
|
| `placeholder` | string | - | Placeholder text inside the block before user types input. |
|
|
688
660
|
| `rows` | integer | - | Number of rows in the block, should be greater or equal to 1. Defining rows disables any prefix. |
|
|
689
661
|
| `size` | string | `"middle"` | Size of the block. Enum: `small`, `middle`, `large`. |
|
|
690
662
|
| `showCount` | boolean \| object | `false` | Show input character count. |
|
|
691
663
|
| `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
|
|
692
|
-
| `variant` | string | - | Input visual variant.
|
|
664
|
+
| `variant` | string | - | Input visual variant. When set, takes precedence over bordered. Enum: `outlined`, `filled`, `borderless`. |
|
|
693
665
|
| `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). |
|
|
694
666
|
| `theme.activeBorderColor` | string | - | Border color when the input is active/focused. |
|
|
695
667
|
| `theme.hoverBorderColor` | string | - | Border color when the input is hovered. |
|
|
@@ -727,7 +699,6 @@ Multi-line text input with auto-sizing, character count, and clear button.
|
|
|
727
699
|
| --- | --- | --- |
|
|
728
700
|
| `onBlur` | \- | Trigger action event occurs when text input loses focus. |
|
|
729
701
|
| `onChange` | `{ value }` | Trigger action when text input is changed. |
|
|
730
|
-
| `onClear` | \- | Trigger action when the clear button is clicked. |
|
|
731
702
|
| `onFocus` | \- | Trigger action when text input gets focus. |
|
|
732
703
|
| `onPressEnter` | \- | Trigger action when enter is pressed while text input is focused. |
|
|
733
704
|
| `onTooltipClick` | \- | Trigger actions when the tooltip icon is clicked. |
|