@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.
- package/README.md +1 -0
- package/content/actions/downloadcsv.md +1 -1
- package/content/actions/emailotpsend.md +58 -0
- package/content/actions/emailotpverify.md +79 -0
- package/content/actions/getlocalstorage.md +43 -0
- package/content/actions/link.md +47 -1
- package/content/actions/login.md +25 -5
- package/content/actions/logout.md +7 -5
- package/content/actions/magiclinkverify.md +117 -0
- package/content/actions/pdfmake.md +2 -2
- package/content/actions/posthogalias.md +29 -0
- package/content/actions/posthogcapture.md +49 -0
- package/content/actions/posthogcapturepageleave.md +38 -0
- package/content/actions/posthogfeatureflag.md +50 -0
- package/content/actions/posthoggroup.md +37 -0
- package/content/actions/posthogidentify.md +54 -0
- package/content/actions/posthoginit.md +96 -0
- package/content/actions/posthogoptin.md +29 -0
- package/content/actions/posthogoptout.md +29 -0
- package/content/actions/posthogpageview.md +37 -0
- package/content/actions/posthogreloadfeatureflags.md +47 -0
- package/content/actions/posthogreset.md +28 -0
- package/content/actions/posthogsetpersonproperties.md +36 -0
- package/content/actions/removelocalstorage.md +28 -0
- package/content/actions/resetvalidation.md +5 -3
- package/content/actions/setdarkmode.md +3 -3
- package/content/actions/setglobal.md +2 -0
- package/content/actions/setlocale.md +1 -1
- package/content/actions/setlocalstorage.md +34 -0
- package/content/actions/setstate.md +2 -0
- package/content/actions/validate.md +7 -4
- package/content/adapter-reference/mongodbauthadapter.md +46 -0
- package/content/agents/agent-endpoint-tools.md +24 -0
- package/content/agents/agent-properties.md +13 -3
- package/content/agents/agent-server-hooks.md +1 -1
- package/content/agents/agentchat.md +43 -7
- package/content/agents/agentconversations.md +42 -8
- package/content/agents/agents-introduction.md +107 -0
- package/content/callback-reference/auth0logoutcallback.md +54 -0
- package/content/concepts/ai-agent-docs.md +455 -106
- package/content/concepts/blocks.md +150 -0
- package/content/concepts/connections-and-requests.md +402 -0
- package/content/concepts/custom-html.md +42 -0
- package/content/concepts/custom-styling.md +50 -5
- package/content/concepts/dynamic-page-content.md +309 -0
- package/content/concepts/events-and-actions.md +154 -2
- package/content/concepts/four-primitives.md +31 -0
- package/content/concepts/html-attributes.md +293 -0
- package/content/concepts/i18n.md +8 -3
- package/content/concepts/keyboard-shortcuts.md +2 -2
- package/content/concepts/layout-overview.md +1 -1
- package/content/concepts/logger.md +99 -0
- package/content/concepts/lowdefy-api.md +1319 -0
- package/content/concepts/lowdefy-schema.md +136 -3
- package/content/concepts/menus.md +8 -7
- package/content/concepts/module-authoring.md +76 -5
- package/content/concepts/modules.md +3 -1
- package/content/concepts/notifications.md +180 -0
- package/content/concepts/operators.md +7 -0
- package/content/concepts/page-and-app-state.md +252 -0
- package/content/concepts/page-paths.md +209 -0
- package/content/concepts/theming.md +582 -0
- package/content/connections/aigateway.md +375 -0
- package/content/connections/anthropic.md +169 -2
- package/content/connections/awss3.md +178 -2
- package/content/connections/axioshttp.md +181 -0
- package/content/connections/google.md +169 -2
- package/content/connections/mongodb.md +1014 -3
- package/content/connections/openai-connection.md +169 -2
- package/content/connections/sendgridmail.md +2 -0
- package/content/connections/smtp.md +3 -1
- package/content/connections/treg.md +329 -0
- package/content/container-blocks/affix.md +47 -7
- package/content/container-blocks/alert.md +76 -24
- package/content/container-blocks/badge.md +100 -24
- package/content/container-blocks/box.md +9 -9
- package/content/container-blocks/card.md +132 -27
- package/content/container-blocks/carousel.md +60 -7
- package/content/container-blocks/collapse.md +153 -9
- package/content/container-blocks/configprovider.md +35 -13
- package/content/container-blocks/confirmmodal.md +69 -23
- package/content/container-blocks/content.md +62 -98
- package/content/container-blocks/descriptions.md +45 -4
- package/content/container-blocks/drawer.md +139 -28
- package/content/container-blocks/dropdownmenu.md +119 -31
- package/content/container-blocks/flex.md +40 -62
- package/content/container-blocks/footer.md +15 -11
- package/content/container-blocks/googlemapsheatmap.md +1 -1
- package/content/container-blocks/googlemapsscript.md +2 -2
- package/content/container-blocks/header.md +71 -36
- package/content/container-blocks/label.md +34 -7
- package/content/container-blocks/layout.md +52 -34
- package/content/container-blocks/masonry.md +17 -71
- package/content/container-blocks/mobilemenu.md +131 -88
- package/content/container-blocks/modal.md +161 -26
- package/content/container-blocks/pageheadermenu.md +138 -31
- package/content/container-blocks/pagesidebarlayout.md +230 -27
- package/content/container-blocks/pagesidermenu.md +153 -43
- package/content/container-blocks/popover.md +34 -31
- package/content/container-blocks/result.md +32 -21
- package/content/container-blocks/sider.md +85 -122
- package/content/container-blocks/span.md +7 -7
- package/content/container-blocks/spinner.md +3 -3
- package/content/container-blocks/splitter.md +150 -68
- package/content/container-blocks/tabs.md +64 -12
- package/content/container-blocks/tooltip.md +22 -46
- package/content/container-blocks/watermark.md +22 -4
- package/content/controls/parallel_for.md +21 -2
- package/content/controls/reject.md +24 -3
- package/content/controls/return.md +17 -1
- package/content/controls/throw.md +1 -0
- package/content/controls/try.md +4 -2
- package/content/controls/while.md +46 -0
- package/content/deployment/deployment-environments.md +10 -7
- package/content/deployment/docker.md +22 -7
- package/content/deployment/node-server.md +4 -0
- package/content/deployment/vercel.md +17 -6
- package/content/display-blocks/aggrid.md +33 -16
- package/content/display-blocks/anchor.md +16 -15
- package/content/display-blocks/avatar.md +57 -37
- package/content/display-blocks/breadcrumb.md +70 -21
- package/content/display-blocks/button.md +93 -19
- package/content/display-blocks/calendar.md +12 -0
- package/content/display-blocks/clickablehtml.md +239 -0
- 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 +64 -3
- package/content/display-blocks/dropdownbutton.md +81 -30
- package/content/display-blocks/echart.md +35 -1
- package/content/display-blocks/eventlog.md +363 -0
- package/content/display-blocks/floatbutton.md +129 -42
- package/content/display-blocks/html.md +61 -1
- package/content/display-blocks/icon.md +250 -67
- package/content/display-blocks/img.md +2 -2
- package/content/display-blocks/menu.md +146 -73
- package/content/display-blocks/message.md +38 -124
- package/content/display-blocks/notification.md +94 -222
- package/content/display-blocks/paragraph.md +59 -9
- package/content/display-blocks/pollingtimer.md +263 -0
- package/content/display-blocks/progress.md +96 -17
- package/content/display-blocks/qrcode.md +19 -4
- package/content/display-blocks/s3download.md +1 -1
- package/content/display-blocks/search.md +19 -9
- package/content/display-blocks/skeletonbutton.md +1 -0
- package/content/display-blocks/skeletoninput.md +1 -0
- package/content/display-blocks/statistic.md +75 -17
- package/content/display-blocks/steps.md +58 -25
- package/content/display-blocks/table.md +2527 -0
- package/content/display-blocks/tablelight.md +621 -0
- package/content/display-blocks/tag.md +102 -17
- package/content/display-blocks/title.md +50 -11
- package/content/display-blocks/tour.md +33 -23
- package/content/input-blocks/autocomplete.md +81 -9
- package/content/input-blocks/buttonselector.md +45 -8
- package/content/input-blocks/captcha.md +40 -0
- package/content/input-blocks/checkboxselector.md +97 -7
- package/content/input-blocks/checkboxswitch.md +33 -3
- package/content/input-blocks/colorselector.md +63 -14
- package/content/input-blocks/daterangeselector.md +165 -45
- package/content/input-blocks/dateselector.md +139 -41
- package/content/input-blocks/datetimeselector.md +158 -49
- package/content/input-blocks/inputgallery.md +3 -3
- package/content/input-blocks/intentinput.md +207 -0
- package/content/input-blocks/monthselector.md +120 -52
- package/content/input-blocks/multipleselector.md +150 -39
- package/content/input-blocks/numberinput.md +98 -12
- package/content/input-blocks/pagination.md +70 -14
- package/content/input-blocks/paragraphinput.md +51 -37
- package/content/input-blocks/passwordinput.md +60 -6
- package/content/input-blocks/phonenumberinput.md +59 -26
- package/content/input-blocks/placesautocomplete.md +319 -0
- package/content/input-blocks/radioselector.md +83 -7
- package/content/input-blocks/ratingslider.md +57 -26
- 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 +72 -32
- package/content/input-blocks/selector.md +109 -21
- package/content/input-blocks/switch.md +65 -17
- package/content/input-blocks/tableinput.md +445 -0
- package/content/input-blocks/tagmultipleselector.md +114 -0
- package/content/input-blocks/tagselector.md +114 -0
- package/content/input-blocks/textarea.md +32 -3
- package/content/input-blocks/textinput.md +70 -29
- package/content/input-blocks/tiptapinput.md +1 -1
- package/content/input-blocks/tiptapmentioninput.md +2 -2
- package/content/input-blocks/titleinput.md +39 -12
- package/content/input-blocks/treeinput.md +49 -25
- package/content/input-blocks/treemultipleselector.md +127 -10
- package/content/input-blocks/treeselector.md +97 -9
- package/content/input-blocks/upload.md +64 -15
- package/content/input-blocks/uploaddragger.md +17 -1
- package/content/input-blocks/uploadphoto.md +18 -1
- package/content/input-blocks/weekselector.md +120 -55
- package/content/learn/introduction.md +27 -0
- package/content/learn/quickstart.md +53 -0
- package/content/learn/showcase.md +8 -0
- package/content/list-blocks/controlledlist.md +24 -15
- package/content/list-blocks/list.md +11 -11
- package/content/list-blocks/masonrylist.md +7 -34
- package/content/migration/auth-upgrade.md +337 -0
- package/content/migration/upgrade-guide.md +1 -0
- package/content/migration/v3-to-v4.md +417 -0
- package/content/migration/v6-to-v7.md +620 -0
- package/content/operators/_agent.md +155 -0
- package/content/operators/_app.md +2 -1
- package/content/operators/_array.md +122 -1
- package/content/operators/_build.md +1 -0
- package/content/operators/_credential.md +57 -0
- package/content/operators/_cron.md +292 -0
- package/content/operators/_date.md +2 -0
- package/content/operators/_error.md +24 -1
- package/content/operators/_get.md +6 -6
- package/content/operators/_hmac.md +78 -0
- package/content/operators/_js.md +2 -1
- package/content/operators/_location.md +1 -1
- package/content/operators/_media.md +13 -0
- package/content/operators/_module.md +56 -2
- package/content/operators/_operator.md +17 -3
- package/content/operators/_path_params.md +82 -0
- package/content/operators/_ref.md +258 -0
- package/content/operators/_request.md +1 -1
- package/content/operators/_request_details.md +6 -0
- package/content/operators/_type.md +14 -3
- package/content/operators/_url_query.md +2 -0
- package/content/operators/_user.md +3 -3
- package/content/plugins/plugins-actions.md +10 -0
- package/content/plugins/plugins-connections.md +25 -0
- package/content/plugins/plugins-dev.md +66 -0
- package/content/plugins/plugins-icon-sets.md +267 -0
- package/content/plugins/plugins-introduction.md +27 -1
- package/content/plugins/plugins.md +19 -0
- package/content/plugins/posthog.md +359 -0
- package/content/provider-reference/auth-js-providers.md +107 -0
- package/content/provider-reference/openidconnectprovider.md +44 -0
- package/content/recipes/recipes.md +16 -0
- package/content/reference/actions-reference.md +31 -0
- package/content/reference/blocks-reference.md +35 -0
- package/content/reference/cli.md +403 -0
- package/content/reference/connections-reference.md +23 -0
- package/content/reference/operators-reference.md +47 -0
- package/content/reference/reference.md +16 -0
- package/content/reference/schema-reference.md +12 -0
- package/content/testing/config-tests.md +677 -0
- package/content/testing/e2e-configuration.md +31 -1
- package/content/testing/e2e-getting-started.md +1 -1
- package/content/testing/e2e-introduction.md +1 -1
- package/content/testing/e2e-writing-tests.md +12 -1
- package/content/testing/explore-pull-request.md +136 -0
- package/content/testing/journey-data-sets.md +326 -0
- 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 +48 -2
- package/content/tutorial/tutorial-display-data-page.md +3 -3
- package/content/tutorial/tutorial-requests-api.md +155 -0
- package/content/tutorial/tutorial-requests-sql.md +153 -0
- package/content/tutorial/tutorial-start.md +66 -1
- package/content/user-authentication/auth-configuration.md +267 -0
- package/content/user-authentication/auth-providers.md +24 -0
- package/content/user-authentication/auth-steps.md +141 -0
- package/content/user-authentication/login-and-logout.md +160 -8
- package/content/user-authentication/mcp-oauth.md +424 -0
- package/content/user-authentication/organizations.md +246 -0
- package/content/user-authentication/protected-pages-apis.md +97 -0
- package/content/user-authentication/roles.md +49 -0
- package/content/user-authentication/two-factor.md +229 -0
- package/content/user-authentication/user-object.md +58 -0
- package/content/user-authentication/users-introduction.md +8 -0
- package/content/websockets/websocket-publish.md +105 -0
- package/content/websockets/websocket-subscriptions.md +136 -0
- package/content/websockets/websockets-introduction.md +101 -0
- package/hazards.json +56 -0
- package/index.json +3458 -14
- package/package.json +10 -1
- package/scripts/extractAgentDocs.js +41 -30
- package/scripts/hashDocSources.js +38 -0
- package/scripts/isRedirectPage.js +26 -0
- package/scripts/recordSourceHashes.js +97 -0
- package/scripts/resolvePageSections.js +42 -0
- package/scripts/sectionKind.js +27 -0
- package/content/concepts/cli.md +0 -223
- package/content/other/introduction.md +0 -39
- package/content/other/next-auth-providers.md +0 -3
- /package/content/{other → actions}/updatesession.md +0 -0
|
@@ -388,7 +388,7 @@ Editable title heading with levels, copyable, and text styles.
|
|
|
388
388
|
- id: set_default
|
|
389
389
|
type: SetState
|
|
390
390
|
params:
|
|
391
|
-
editable_boolean_true:
|
|
391
|
+
editable_boolean_true: Click this title to edit it in place
|
|
392
392
|
- id: editable_boolean_false
|
|
393
393
|
type: TitleInput
|
|
394
394
|
properties:
|
|
@@ -400,6 +400,18 @@ Editable title heading with levels, copyable, and text styles.
|
|
|
400
400
|
type: SetState
|
|
401
401
|
params:
|
|
402
402
|
editable_boolean_false: Not editable (editable false)
|
|
403
|
+
- id: editable_with_icon
|
|
404
|
+
type: TitleInput
|
|
405
|
+
properties:
|
|
406
|
+
level: 3
|
|
407
|
+
editable:
|
|
408
|
+
icon: edit
|
|
409
|
+
events:
|
|
410
|
+
onMount:
|
|
411
|
+
- id: set_default
|
|
412
|
+
type: SetState
|
|
413
|
+
params:
|
|
414
|
+
editable_with_icon: Edit with the text or the icon
|
|
403
415
|
- id: editable_custom_tooltip
|
|
404
416
|
type: TitleInput
|
|
405
417
|
properties:
|
|
@@ -411,7 +423,12 @@ Editable title heading with levels, copyable, and text styles.
|
|
|
411
423
|
- id: set_default
|
|
412
424
|
type: SetState
|
|
413
425
|
params:
|
|
414
|
-
editable_custom_tooltip:
|
|
426
|
+
editable_custom_tooltip: Hover for a tooltip, click to edit
|
|
427
|
+
- id: editable_placeholder
|
|
428
|
+
type: TitleInput
|
|
429
|
+
properties:
|
|
430
|
+
level: 3
|
|
431
|
+
placeholder: Name this document
|
|
415
432
|
- id: editable_max_length
|
|
416
433
|
type: TitleInput
|
|
417
434
|
properties:
|
|
@@ -861,9 +878,9 @@ Editable title heading with levels, copyable, and text styles.
|
|
|
861
878
|
level: 3
|
|
862
879
|
editable: true
|
|
863
880
|
style:
|
|
864
|
-
background: linear-gradient(90deg,
|
|
881
|
+
background: "linear-gradient(90deg, #f0f5ff, #fff)"
|
|
865
882
|
padding: 8px 16px
|
|
866
|
-
borderLeft: 4px solid
|
|
883
|
+
borderLeft: "4px solid #1677ff"
|
|
867
884
|
events:
|
|
868
885
|
onMount:
|
|
869
886
|
- id: set_default
|
|
@@ -890,7 +907,7 @@ Editable title heading with levels, copyable, and text styles.
|
|
|
890
907
|
type: success
|
|
891
908
|
editable: true
|
|
892
909
|
style:
|
|
893
|
-
border: 1px dashed
|
|
910
|
+
border: "1px dashed #52c41a"
|
|
894
911
|
borderRadius: 8px
|
|
895
912
|
padding: 12px 20px
|
|
896
913
|
className: shadow-md
|
|
@@ -954,7 +971,7 @@ Editable title heading with levels, copyable, and text styles.
|
|
|
954
971
|
type: Button
|
|
955
972
|
properties:
|
|
956
973
|
title: Save Document
|
|
957
|
-
icon:
|
|
974
|
+
icon: save
|
|
958
975
|
type: primary
|
|
959
976
|
size: large
|
|
960
977
|
block: true
|
|
@@ -1013,7 +1030,7 @@ Editable title heading with levels, copyable, and text styles.
|
|
|
1013
1030
|
type: Button
|
|
1014
1031
|
properties:
|
|
1015
1032
|
title: Publish Post
|
|
1016
|
-
icon:
|
|
1033
|
+
icon: send
|
|
1017
1034
|
type: primary
|
|
1018
1035
|
size: large
|
|
1019
1036
|
block: true
|
|
@@ -1040,19 +1057,29 @@ Editable title heading with levels, copyable, and text styles.
|
|
|
1040
1057
|
| `ellipsis.rows` | number | - | Max rows of content. |
|
|
1041
1058
|
| `ellipsis.expandable` | boolean | - | Expand hidden content when clicked. |
|
|
1042
1059
|
| `ellipsis.suffix` | string | - | Suffix of ellipses content. |
|
|
1043
|
-
| `editable` | boolean \| object | `true` | Allow
|
|
1044
|
-
| `editable.icon` | string \| object | - |
|
|
1045
|
-
| `editable.
|
|
1060
|
+
| `editable` | boolean \| object | `true` | Allow editing the title in place. Click the text, or focus it and press Enter, to edit. Enter saves, Escape cancels. Provide an object for editable settings. |
|
|
1061
|
+
| `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. |
|
|
1062
|
+
| `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`. |
|
|
1063
|
+
| `editable.icon.color` | string | - | Icon color. |
|
|
1064
|
+
| `editable.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
1065
|
+
| `editable.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
1066
|
+
| `editable.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
1067
|
+
| `editable.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
1068
|
+
| `editable.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
1069
|
+
| `editable.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
1070
|
+
| `editable.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
1071
|
+
| `editable.tooltip` | string | - | Tooltip text, shown on the edit icon, or on the text when no icon is set. |
|
|
1046
1072
|
| `editable.editing` | boolean | `false` | Control editing state. |
|
|
1047
1073
|
| `editable.maxLength` | number | - | Max length of text area input. |
|
|
1048
1074
|
| `italic` | boolean | `false` | Apply italic style. |
|
|
1049
1075
|
| `level` | number | `1` | Set title type. Matches with h1, h2, h3 and h4. Enum: `1`, `2`, `3`, `4`, `5`. |
|
|
1050
1076
|
| `mark` | boolean | `false` | Apply marked (highlighted) style. |
|
|
1077
|
+
| `placeholder` | string | `"Untitled"` | Muted text shown when the title is empty and editable. |
|
|
1051
1078
|
| `type` | string | `"default"` | Additional types. Don't specify for default. Enum: `default`, `secondary`, `warning`, `danger`, `success`. |
|
|
1052
1079
|
| `underline` | boolean | `false` | Apply underline style. |
|
|
1053
1080
|
| `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). |
|
|
1054
|
-
| `theme.titleMarginBottom` | string | `"0.5em"` | Margin bottom for title elements. |
|
|
1055
|
-
| `theme.titleMarginTop` | string | `"1.2em"` | Margin top for title elements. |
|
|
1081
|
+
| `theme.titleMarginBottom` | string \| number | `"0.5em"` | Margin bottom for title elements, as a CSS length or a number of pixels. |
|
|
1082
|
+
| `theme.titleMarginTop` | string \| number | `"1.2em"` | Margin top for title elements, as a CSS length or a number of pixels. |
|
|
1056
1083
|
| `theme.colorText` | string | - | Default text color. |
|
|
1057
1084
|
| `theme.colorTextSecondary` | string | - | Text color for secondary type. |
|
|
1058
1085
|
| `theme.colorSuccess` | string | - | Text color for success type. |
|
|
@@ -89,6 +89,41 @@ Inline tree with nested options and checkboxes. (Renamed from `TreeSelector`.)
|
|
|
89
89
|
label: Operations
|
|
90
90
|
```
|
|
91
91
|
|
|
92
|
+
```yaml
|
|
93
|
+
- id: tree_block_node
|
|
94
|
+
type: TreeInput
|
|
95
|
+
properties:
|
|
96
|
+
blockNode: true
|
|
97
|
+
height: 160
|
|
98
|
+
defaultExpandAll: true
|
|
99
|
+
primaryKey: id
|
|
100
|
+
parentKey: parentId
|
|
101
|
+
valueKey: id
|
|
102
|
+
html: "{{ item.label }}"
|
|
103
|
+
data:
|
|
104
|
+
- id: 1
|
|
105
|
+
label: Documents
|
|
106
|
+
- id: 2
|
|
107
|
+
label: Invoices
|
|
108
|
+
parentId: 1
|
|
109
|
+
- id: 3
|
|
110
|
+
label: Receipts
|
|
111
|
+
parentId: 1
|
|
112
|
+
- id: 4
|
|
113
|
+
label: Contracts
|
|
114
|
+
parentId: 1
|
|
115
|
+
- id: 5
|
|
116
|
+
label: Photos
|
|
117
|
+
- id: 6
|
|
118
|
+
label: Holidays
|
|
119
|
+
parentId: 5
|
|
120
|
+
- id: 7
|
|
121
|
+
label: Events
|
|
122
|
+
parentId: 5
|
|
123
|
+
- id: 8
|
|
124
|
+
label: Music
|
|
125
|
+
```
|
|
126
|
+
|
|
92
127
|
| Property | Type | Default | Description |
|
|
93
128
|
| --- | --- | --- | --- |
|
|
94
129
|
| `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. |
|
|
@@ -98,39 +133,25 @@ Inline tree with nested options and checkboxes. (Renamed from `TreeSelector`.)
|
|
|
98
133
|
| `parentKey` | string | - | Tree selectors only: names each row’s parent id. Build a flat `data`/`options` array where each row has a `primaryKey` (its own id) and a `parentKey` whose value equals the parent row’s `primaryKey`. Rows whose `parentKey` is empty or points at no row become tree roots. Supports dotted paths. |
|
|
99
134
|
| `options` | array | `[]` | Options can either be an array of primitive values, on an array of label, value pairs - supports html. |
|
|
100
135
|
| `options.$.label` | string | - | Value label shown to user - supports html. |
|
|
101
|
-
| `options.$.value` |
|
|
136
|
+
| `options.$.value` | - | - | Option value. Can be of any type. |
|
|
102
137
|
| `options.$.disabled` | boolean | `false` | Disable the option if true. |
|
|
103
138
|
| `options.$.style` | object | - | Css style to apply to the option. |
|
|
104
139
|
| `options.$.color` | string | - | Color applied to this option when it is selected. Falls back to the block-level color when not set. |
|
|
105
140
|
| `disabled` | boolean | `false` | Disable the block if true. |
|
|
141
|
+
| `blockNode` | boolean | `false` | Make each tree node fill the remaining width of the row, so the whole row is clickable and highlighted. |
|
|
106
142
|
| `checkable` | boolean | `false` | Show checkboxes on the tree nodes. |
|
|
107
143
|
| `showLine` | boolean | `false` | Show a connecting line if true. |
|
|
108
144
|
| `selectable` | boolean | `true` | Selectable if true. |
|
|
109
145
|
| `defaultExpandAll` | boolean | `false` | Expand all tree nodes by default. |
|
|
110
|
-
| `
|
|
111
|
-
| `theme
|
|
112
|
-
| `theme.
|
|
113
|
-
| `theme.
|
|
114
|
-
| `theme.
|
|
115
|
-
| `theme.
|
|
116
|
-
| `theme.
|
|
117
|
-
| `theme.
|
|
118
|
-
| `theme.
|
|
119
|
-
| `theme.optionSelectedBg` | string | - | Background of selected option. |
|
|
120
|
-
| `theme.optionSelectedColor` | string | - | Text color of selected option. |
|
|
121
|
-
| `theme.optionSelectedFontWeight` | string | - | Font weight of selected option. |
|
|
122
|
-
| `theme.optionActiveBg` | string | - | Background of active (hovered) option. |
|
|
123
|
-
| `theme.optionFontSize` | number | `14` | Font size of options. |
|
|
124
|
-
| `theme.optionHeight` | number | `32` | Height of each option. |
|
|
125
|
-
| `theme.optionLineHeight` | string | - | Line height of options. |
|
|
126
|
-
| `theme.optionPadding` | string | - | Padding of options. |
|
|
127
|
-
| `theme.multipleSelectorBgDisabled` | string | - | Background when disabled in multiple mode. |
|
|
128
|
-
| `theme.multipleItemBg` | string | - | Background of tag items in multiple mode. |
|
|
129
|
-
| `theme.multipleItemBorderColor` | string | - | Border color of tag items. |
|
|
130
|
-
| `theme.multipleItemHeight` | number | `24` | Height of tag items. |
|
|
131
|
-
| `theme.multipleItemHeightSM` | number | `16` | Height of tag items (small). |
|
|
132
|
-
| `theme.multipleItemHeightLG` | number | `32` | Height of tag items (large). |
|
|
133
|
-
| `theme.zIndexPopup` | number | `1050` | z-index of the dropdown. |
|
|
146
|
+
| `height` | number | - | Height of the tree in pixels. When set, the tree scrolls and only renders the nodes in view, for large trees. |
|
|
147
|
+
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design tree tokens](https://ant.design/components/tree#design-token). |
|
|
148
|
+
| `theme.indentSize` | number | `24` | Indent width of each tree level. |
|
|
149
|
+
| `theme.nodeHoverBg` | string | `"rgba(0, 0, 0, 0.04)"` | Background color of a hovered tree node. |
|
|
150
|
+
| `theme.nodeHoverColor` | string | `"rgba(0, 0, 0, 0.88)"` | Text color of a hovered tree node. |
|
|
151
|
+
| `theme.nodeSelectedBg` | string | `"#e6f4ff"` | Background color of the selected tree node. |
|
|
152
|
+
| `theme.nodeSelectedColor` | string | `"rgba(0, 0, 0, 0.88)"` | Text color of the selected tree node. |
|
|
153
|
+
| `theme.switcherSize` | number | `24` | Width of the expand/collapse switcher. |
|
|
154
|
+
| `theme.titleHeight` | number | `24` | Height of a tree node title. |
|
|
134
155
|
|
|
135
156
|
| Event | Event Data | Description |
|
|
136
157
|
| --- | --- | --- |
|
|
@@ -140,5 +161,8 @@ Inline tree with nested options and checkboxes. (Renamed from `TreeSelector`.)
|
|
|
140
161
|
| --- | --- |
|
|
141
162
|
| `/block` | Outer block wrapper (always available). |
|
|
142
163
|
| `/element` | The TreeInput element. |
|
|
164
|
+
| `/item` | Each tree node row. |
|
|
165
|
+
| `/itemSwitcher` | The expand/collapse switcher of each tree node. |
|
|
166
|
+
| `/itemTitle` | The title of each tree node. |
|
|
143
167
|
|
|
144
168
|
No slots defined.
|
|
@@ -73,6 +73,53 @@ Searchable multiple-select tree dropdown (tags or checkboxes). Driven by flat `d
|
|
|
73
73
|
_state: true
|
|
74
74
|
```
|
|
75
75
|
|
|
76
|
+
```yaml
|
|
77
|
+
- id: check_strictly_tree_multiple
|
|
78
|
+
type: TreeMultipleSelector
|
|
79
|
+
properties:
|
|
80
|
+
title: Folders (parents check on their own)
|
|
81
|
+
checkable: true
|
|
82
|
+
checkStrictly: true
|
|
83
|
+
treeDefaultExpandAll: true
|
|
84
|
+
primaryKey: id
|
|
85
|
+
parentKey: parentId
|
|
86
|
+
valueKey: id
|
|
87
|
+
html: "{{ item.label }}"
|
|
88
|
+
data:
|
|
89
|
+
- id: 1
|
|
90
|
+
label: Projects
|
|
91
|
+
- id: 2
|
|
92
|
+
label: Website
|
|
93
|
+
parentId: 1
|
|
94
|
+
- id: 3
|
|
95
|
+
label: Mobile App
|
|
96
|
+
parentId: 1
|
|
97
|
+
- id: 4
|
|
98
|
+
label: Archive
|
|
99
|
+
- id: max_count_tree_multiple
|
|
100
|
+
type: TreeMultipleSelector
|
|
101
|
+
properties:
|
|
102
|
+
title: Pick Up to 2 Teams
|
|
103
|
+
maxCount: 2
|
|
104
|
+
maxTagCount: responsive
|
|
105
|
+
treeDefaultExpandAll: true
|
|
106
|
+
primaryKey: id
|
|
107
|
+
parentKey: parentId
|
|
108
|
+
valueKey: id
|
|
109
|
+
html: "{{ item.label }}"
|
|
110
|
+
data:
|
|
111
|
+
- id: 1
|
|
112
|
+
label: Engineering
|
|
113
|
+
- id: 2
|
|
114
|
+
label: Frontend
|
|
115
|
+
parentId: 1
|
|
116
|
+
- id: 3
|
|
117
|
+
label: Backend
|
|
118
|
+
parentId: 1
|
|
119
|
+
- id: 4
|
|
120
|
+
label: Sales
|
|
121
|
+
```
|
|
122
|
+
|
|
76
123
|
| Property | Type | Default | Description |
|
|
77
124
|
| --- | --- | --- | --- |
|
|
78
125
|
| `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. |
|
|
@@ -82,43 +129,108 @@ Searchable multiple-select tree dropdown (tags or checkboxes). Driven by flat `d
|
|
|
82
129
|
| `parentKey` | string | - | Tree selectors only: names each row’s parent id. Build a flat `data`/`options` array where each row has a `primaryKey` (its own id) and a `parentKey` whose value equals the parent row’s `primaryKey`. Rows whose `parentKey` is empty or points at no row become tree roots. Supports dotted paths. |
|
|
83
130
|
| `options` | array | `[]` | Options can either be an array of primitive values, on an array of label, value pairs - supports html. |
|
|
84
131
|
| `options.$.label` | string | - | Value label shown to user - supports html. |
|
|
85
|
-
| `options.$.value` |
|
|
132
|
+
| `options.$.value` | - | - | Option value. Can be of any type. |
|
|
86
133
|
| `options.$.disabled` | boolean | `false` | Disable the option if true. |
|
|
87
134
|
| `options.$.style` | object | - | Css style to apply to the option. |
|
|
88
135
|
| `options.$.color` | string | - | Color applied to this option when it is selected. Falls back to the block-level color when not set. |
|
|
89
136
|
| `label` | object | - | Label properties. |
|
|
137
|
+
| `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
|
|
138
|
+
| `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
139
|
+
| `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. |
|
|
140
|
+
| `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
141
|
+
| `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
|
|
142
|
+
| `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
143
|
+
| `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
|
|
144
|
+
| `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
145
|
+
| `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
|
|
146
|
+
| `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
147
|
+
| `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
|
|
148
|
+
| `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
90
149
|
| `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
|
|
91
150
|
| `label.colon` | boolean | `true` | Append label with colon. |
|
|
92
151
|
| `label.extra` | string | - | Extra text to display beneath the content - supports html. |
|
|
93
152
|
| `label.title` | string | - | Label title - supports html. |
|
|
94
153
|
| `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. |
|
|
95
154
|
| `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
|
|
96
|
-
| `label.tooltip.icon` | string | `"
|
|
155
|
+
| `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`. |
|
|
97
156
|
| `label.tooltip.color` | string | - | Color of the tooltip icon. |
|
|
98
|
-
| `label.span` | number | - | Label inline
|
|
157
|
+
| `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. |
|
|
99
158
|
| `label.disabled` | boolean | `false` | Hide input label. |
|
|
100
159
|
| `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
|
|
101
160
|
| `label.inline` | boolean | `false` | Render input and label inline. |
|
|
161
|
+
| `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
|
|
102
162
|
| `disabled` | boolean | `false` | Disable the block if true. |
|
|
103
163
|
| `autoFocus` | boolean | `false` | Autofocus to the block on page load. |
|
|
104
164
|
| `allowClear` | boolean | `true` | Allow the user to clear their input. |
|
|
105
165
|
| `bordered` | boolean | `true` | Whether or not the input has a border style. Deprecated, use variant instead. |
|
|
106
|
-
| `variant` | string | - | Input visual variant.
|
|
166
|
+
| `variant` | string | - | Input visual variant. The deprecated bordered: false takes precedence and renders the input as 'borderless'. Enum: `outlined`, `filled`, `borderless`, `underlined`. |
|
|
107
167
|
| `size` | string | `"default"` | Size of the block. Enum: `small`, `default`, `large`. |
|
|
108
168
|
| `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
|
|
169
|
+
| `listHeight` | number | `256` | Height of the dropdown list in pixels. |
|
|
170
|
+
| `placement` | string | `"bottomLeft"` | Position of the dropdown relative to the selector. Enum: `bottomLeft`, `bottomRight`, `topLeft`, `topRight`. |
|
|
171
|
+
| `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). |
|
|
172
|
+
| `prefix` | string | - | Text shown inside the selector before the selected value. |
|
|
173
|
+
| `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. |
|
|
174
|
+
| `prefixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
175
|
+
| `prefixIcon.color` | string | - | Icon color. |
|
|
176
|
+
| `prefixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
177
|
+
| `prefixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
178
|
+
| `prefixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
179
|
+
| `prefixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
180
|
+
| `prefixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
181
|
+
| `prefixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
182
|
+
| `prefixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
183
|
+
| `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. |
|
|
109
184
|
| `placeholder` | string | `"Select items"` | Placeholder text inside the block before user types input. |
|
|
110
185
|
| `showSearch` | boolean | `true` | Make the tree searchable. |
|
|
111
186
|
| `treeDefaultExpandAll` | boolean | `false` | Expand all tree nodes by default. |
|
|
187
|
+
| `treeExpandAction` | string | - | Expand or collapse a node by clicking or double-clicking its title. When not set, nodes only expand with the switcher. Enum: `click`, `doubleClick`. |
|
|
188
|
+
| `treeLine` | boolean | `false` | Show connecting lines between tree nodes. |
|
|
189
|
+
| `autoClearSearchValue` | boolean | `true` | Whether the current search will be cleared on selecting an item. |
|
|
112
190
|
| `checkable` | boolean | `false` | Show checkboxes on the tree nodes instead of selectable tags. |
|
|
191
|
+
| `checkStrictly` | boolean | `false` | When `checkable` is true, check nodes independently: checking a parent does not check its children, and checking every child does not check the parent. |
|
|
113
192
|
| `showCheckedStrategy` | string | `"SHOW_CHILD"` | How checked nodes are shown when `checkable` is true: SHOW_ALL (all checked), SHOW_PARENT (parent only), SHOW_CHILD (leaf children only). Enum: `SHOW_ALL`, `SHOW_PARENT`, `SHOW_CHILD`. |
|
|
114
|
-
| `
|
|
193
|
+
| `maxCount` | number | - | Maximum number of options that can be selected. Once reached, the remaining options are disabled. |
|
|
194
|
+
| `maxTagCount` | number \| string | - | Maximum number of selected tags shown before the rest collapse into a count. Set to 'responsive' to fit as many tags as the input width allows. |
|
|
115
195
|
| `notFoundContent` | string | `"Not found"` | Content shown when no nodes match the search. |
|
|
116
|
-
| `suffixIcon` | string \| object | `"
|
|
117
|
-
| `
|
|
196
|
+
| `suffixIcon` | string \| object | `"chevron-down"` | Dropdown suffix icon. |
|
|
197
|
+
| `suffixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
198
|
+
| `suffixIcon.color` | string | - | Icon color. |
|
|
199
|
+
| `suffixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
200
|
+
| `suffixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
201
|
+
| `suffixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
202
|
+
| `suffixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
203
|
+
| `suffixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
204
|
+
| `suffixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
205
|
+
| `suffixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
206
|
+
| `clearIcon` | string \| object | `"clear"` | Clear icon. |
|
|
207
|
+
| `clearIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
208
|
+
| `clearIcon.color` | string | - | Icon color. |
|
|
209
|
+
| `clearIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
210
|
+
| `clearIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
211
|
+
| `clearIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
212
|
+
| `clearIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
213
|
+
| `clearIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
214
|
+
| `clearIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
215
|
+
| `clearIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
216
|
+
| `removeIcon` | string \| object | `"close"` | Icon name (a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`) or properties of an Icon block to customize the remove icon on each selected tag. |
|
|
217
|
+
| `removeIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
218
|
+
| `removeIcon.color` | string | - | Icon color. |
|
|
219
|
+
| `removeIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
220
|
+
| `removeIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
221
|
+
| `removeIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
222
|
+
| `removeIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
223
|
+
| `removeIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
224
|
+
| `removeIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
225
|
+
| `removeIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
118
226
|
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design tree-select tokens](https://ant.design/components/tree-select#design-token). |
|
|
119
|
-
| `theme.
|
|
120
|
-
| `theme.nodeHoverBg` | string |
|
|
121
|
-
| `theme.
|
|
227
|
+
| `theme.indentSize` | number | `24` | Indent width of each tree level. |
|
|
228
|
+
| `theme.nodeHoverBg` | string | `"rgba(0, 0, 0, 0.04)"` | Background color of a hovered tree node. |
|
|
229
|
+
| `theme.nodeHoverColor` | string | `"rgba(0, 0, 0, 0.88)"` | Text color of a hovered tree node. |
|
|
230
|
+
| `theme.nodeSelectedBg` | string | `"#e6f4ff"` | Background color of the selected tree node. |
|
|
231
|
+
| `theme.nodeSelectedColor` | string | `"rgba(0, 0, 0, 0.88)"` | Text color of the selected tree node. |
|
|
232
|
+
| `theme.switcherSize` | number | `24` | Width of the expand/collapse switcher. |
|
|
233
|
+
| `theme.titleHeight` | number | `24` | Height of a tree node title. |
|
|
122
234
|
| `theme.clearBg` | string | - | Background color of clear button. |
|
|
123
235
|
| `theme.selectorBg` | string | - | Background color of the selector. |
|
|
124
236
|
| `theme.hoverBorderColor` | string | - | Border color when hovered. |
|
|
@@ -146,6 +258,7 @@ Searchable multiple-select tree dropdown (tags or checkboxes). Driven by flat `d
|
|
|
146
258
|
| `onChange` | `{ value }` | Trigger action when selection is changed. |
|
|
147
259
|
| `onFocus` | \- | Trigger action when the selector gains focus. |
|
|
148
260
|
| `onClear` | \- | Trigger action when the selector is cleared. |
|
|
261
|
+
| `onOpenChange` | `{ open }` | Trigger actions when the dropdown opens or closes. |
|
|
149
262
|
| `onSearch` | `{ value }` | Trigger action when the search input changes. |
|
|
150
263
|
| `onTooltipClick` | \- | Trigger actions when the tooltip icon is clicked. |
|
|
151
264
|
|
|
@@ -158,5 +271,9 @@ Searchable multiple-select tree dropdown (tags or checkboxes). Driven by flat `d
|
|
|
158
271
|
| `/feedback` | The TreeMultipleSelector validation feedback. |
|
|
159
272
|
| `/suffixIcon` | The suffix icon in the TreeMultipleSelector. |
|
|
160
273
|
| `/clearIcon` | The clear icon in the TreeMultipleSelector. |
|
|
274
|
+
| `/popup` | The TreeMultipleSelector dropdown popup. |
|
|
275
|
+
| `/prefixIcon` | The prefix icon in the TreeMultipleSelector. |
|
|
276
|
+
| `/removeIcon` | The remove icon on each selected tag in the TreeMultipleSelector. |
|
|
277
|
+
| `/selector` | The inner value/tag container of the TreeMultipleSelector (antd `content` semantic slot). |
|
|
161
278
|
|
|
162
279
|
No slots defined.
|
|
@@ -99,6 +99,38 @@ Searchable single-select tree dropdown. Driven by flat `data`/`options` with `pr
|
|
|
99
99
|
label: Operations
|
|
100
100
|
```
|
|
101
101
|
|
|
102
|
+
```yaml
|
|
103
|
+
- id: tree_line_selector
|
|
104
|
+
type: TreeSelector
|
|
105
|
+
properties:
|
|
106
|
+
title: Location
|
|
107
|
+
treeLine: true
|
|
108
|
+
treeExpandAction: click
|
|
109
|
+
primaryKey: id
|
|
110
|
+
parentKey: parentId
|
|
111
|
+
valueKey: id
|
|
112
|
+
html: "{{ item.label }}"
|
|
113
|
+
data:
|
|
114
|
+
- id: eu
|
|
115
|
+
label: Europe
|
|
116
|
+
selectable: false
|
|
117
|
+
- id: de
|
|
118
|
+
label: Germany
|
|
119
|
+
parentId: eu
|
|
120
|
+
- id: fr
|
|
121
|
+
label: France
|
|
122
|
+
parentId: eu
|
|
123
|
+
- id: am
|
|
124
|
+
label: Americas
|
|
125
|
+
selectable: false
|
|
126
|
+
- id: us
|
|
127
|
+
label: United States
|
|
128
|
+
parentId: am
|
|
129
|
+
- id: br
|
|
130
|
+
label: Brazil
|
|
131
|
+
parentId: am
|
|
132
|
+
```
|
|
133
|
+
|
|
102
134
|
| Property | Type | Default | Description |
|
|
103
135
|
| --- | --- | --- | --- |
|
|
104
136
|
| `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. |
|
|
@@ -108,40 +140,92 @@ Searchable single-select tree dropdown. Driven by flat `data`/`options` with `pr
|
|
|
108
140
|
| `parentKey` | string | - | Tree selectors only: names each row’s parent id. Build a flat `data`/`options` array where each row has a `primaryKey` (its own id) and a `parentKey` whose value equals the parent row’s `primaryKey`. Rows whose `parentKey` is empty or points at no row become tree roots. Supports dotted paths. |
|
|
109
141
|
| `options` | array | `[]` | Options can either be an array of primitive values, on an array of label, value pairs - supports html. |
|
|
110
142
|
| `options.$.label` | string | - | Value label shown to user - supports html. |
|
|
111
|
-
| `options.$.value` |
|
|
143
|
+
| `options.$.value` | - | - | Option value. Can be of any type. |
|
|
112
144
|
| `options.$.disabled` | boolean | `false` | Disable the option if true. |
|
|
113
145
|
| `options.$.style` | object | - | Css style to apply to the option. |
|
|
114
146
|
| `options.$.color` | string | - | Color applied to this option when it is selected. Falls back to the block-level color when not set. |
|
|
115
147
|
| `label` | object | - | Label properties. |
|
|
148
|
+
| `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
|
|
149
|
+
| `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
150
|
+
| `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. |
|
|
151
|
+
| `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
152
|
+
| `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
|
|
153
|
+
| `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
154
|
+
| `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
|
|
155
|
+
| `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
156
|
+
| `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
|
|
157
|
+
| `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
158
|
+
| `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
|
|
159
|
+
| `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
116
160
|
| `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
|
|
117
161
|
| `label.colon` | boolean | `true` | Append label with colon. |
|
|
118
162
|
| `label.extra` | string | - | Extra text to display beneath the content - supports html. |
|
|
119
163
|
| `label.title` | string | - | Label title - supports html. |
|
|
120
164
|
| `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. |
|
|
121
165
|
| `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
|
|
122
|
-
| `label.tooltip.icon` | string | `"
|
|
166
|
+
| `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`. |
|
|
123
167
|
| `label.tooltip.color` | string | - | Color of the tooltip icon. |
|
|
124
|
-
| `label.span` | number | - | Label inline
|
|
168
|
+
| `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. |
|
|
125
169
|
| `label.disabled` | boolean | `false` | Hide input label. |
|
|
126
170
|
| `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
|
|
127
171
|
| `label.inline` | boolean | `false` | Render input and label inline. |
|
|
172
|
+
| `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
|
|
128
173
|
| `disabled` | boolean | `false` | Disable the block if true. |
|
|
129
174
|
| `autoFocus` | boolean | `false` | Autofocus to the block on page load. |
|
|
130
175
|
| `allowClear` | boolean | `true` | Allow the user to clear their input. |
|
|
131
176
|
| `bordered` | boolean | `true` | Whether or not the input has a border style. Deprecated, use variant instead. |
|
|
132
|
-
| `variant` | string | - | Input visual variant.
|
|
177
|
+
| `variant` | string | - | Input visual variant. The deprecated bordered: false takes precedence and renders the input as 'borderless'. Enum: `outlined`, `filled`, `borderless`, `underlined`. |
|
|
133
178
|
| `size` | string | `"default"` | Size of the block. Enum: `small`, `default`, `large`. |
|
|
134
179
|
| `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
|
|
180
|
+
| `listHeight` | number | `256` | Height of the dropdown list in pixels. |
|
|
181
|
+
| `placement` | string | `"bottomLeft"` | Position of the dropdown relative to the selector. Enum: `bottomLeft`, `bottomRight`, `topLeft`, `topRight`. |
|
|
182
|
+
| `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). |
|
|
183
|
+
| `prefix` | string | - | Text shown inside the selector before the selected value. |
|
|
184
|
+
| `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. |
|
|
185
|
+
| `prefixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
186
|
+
| `prefixIcon.color` | string | - | Icon color. |
|
|
187
|
+
| `prefixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
188
|
+
| `prefixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
189
|
+
| `prefixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
190
|
+
| `prefixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
191
|
+
| `prefixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
192
|
+
| `prefixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
193
|
+
| `prefixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
194
|
+
| `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. |
|
|
135
195
|
| `placeholder` | string | `"Select item"` | Placeholder text inside the block before user types input. |
|
|
136
196
|
| `showSearch` | boolean | `true` | Make the tree searchable. |
|
|
137
197
|
| `treeDefaultExpandAll` | boolean | `false` | Expand all tree nodes by default. |
|
|
198
|
+
| `treeExpandAction` | string | - | Expand or collapse a node by clicking or double-clicking its title. When not set, nodes only expand with the switcher. Enum: `click`, `doubleClick`. |
|
|
199
|
+
| `treeLine` | boolean | `false` | Show connecting lines between tree nodes. |
|
|
138
200
|
| `notFoundContent` | string | `"Not found"` | Content shown when no nodes match the search. |
|
|
139
|
-
| `suffixIcon` | string \| object | `"
|
|
140
|
-
| `
|
|
201
|
+
| `suffixIcon` | string \| object | `"chevron-down"` | Dropdown suffix icon. |
|
|
202
|
+
| `suffixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
203
|
+
| `suffixIcon.color` | string | - | Icon color. |
|
|
204
|
+
| `suffixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
205
|
+
| `suffixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
206
|
+
| `suffixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
207
|
+
| `suffixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
208
|
+
| `suffixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
209
|
+
| `suffixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
210
|
+
| `suffixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
211
|
+
| `clearIcon` | string \| object | `"clear"` | Clear icon. |
|
|
212
|
+
| `clearIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
213
|
+
| `clearIcon.color` | string | - | Icon color. |
|
|
214
|
+
| `clearIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
215
|
+
| `clearIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
216
|
+
| `clearIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
217
|
+
| `clearIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
218
|
+
| `clearIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
219
|
+
| `clearIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
220
|
+
| `clearIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
141
221
|
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design tree-select tokens](https://ant.design/components/tree-select#design-token). |
|
|
142
|
-
| `theme.
|
|
143
|
-
| `theme.nodeHoverBg` | string |
|
|
144
|
-
| `theme.
|
|
222
|
+
| `theme.indentSize` | number | `24` | Indent width of each tree level. |
|
|
223
|
+
| `theme.nodeHoverBg` | string | `"rgba(0, 0, 0, 0.04)"` | Background color of a hovered tree node. |
|
|
224
|
+
| `theme.nodeHoverColor` | string | `"rgba(0, 0, 0, 0.88)"` | Text color of a hovered tree node. |
|
|
225
|
+
| `theme.nodeSelectedBg` | string | `"#e6f4ff"` | Background color of the selected tree node. |
|
|
226
|
+
| `theme.nodeSelectedColor` | string | `"rgba(0, 0, 0, 0.88)"` | Text color of the selected tree node. |
|
|
227
|
+
| `theme.switcherSize` | number | `24` | Width of the expand/collapse switcher. |
|
|
228
|
+
| `theme.titleHeight` | number | `24` | Height of a tree node title. |
|
|
145
229
|
| `theme.clearBg` | string | - | Background color of clear button. |
|
|
146
230
|
| `theme.selectorBg` | string | - | Background color of the selector. |
|
|
147
231
|
| `theme.hoverBorderColor` | string | - | Border color when hovered. |
|
|
@@ -169,6 +253,7 @@ Searchable single-select tree dropdown. Driven by flat `data`/`options` with `pr
|
|
|
169
253
|
| `onChange` | `{ value }` | Trigger action when selection is changed. |
|
|
170
254
|
| `onFocus` | \- | Trigger action when the selector gains focus. |
|
|
171
255
|
| `onClear` | \- | Trigger action when the selector is cleared. |
|
|
256
|
+
| `onOpenChange` | `{ open }` | Trigger actions when the dropdown opens or closes. |
|
|
172
257
|
| `onSearch` | `{ value }` | Trigger action when the search input changes. |
|
|
173
258
|
| `onTooltipClick` | \- | Trigger actions when the tooltip icon is clicked. |
|
|
174
259
|
|
|
@@ -181,5 +266,8 @@ Searchable single-select tree dropdown. Driven by flat `data`/`options` with `pr
|
|
|
181
266
|
| `/feedback` | The TreeSelector validation feedback. |
|
|
182
267
|
| `/suffixIcon` | The suffix icon in the TreeSelector. |
|
|
183
268
|
| `/clearIcon` | The clear icon in the TreeSelector. |
|
|
269
|
+
| `/popup` | The TreeSelector dropdown popup. |
|
|
270
|
+
| `/prefixIcon` | The prefix icon in the TreeSelector. |
|
|
271
|
+
| `/selector` | The inner value/tag container of the TreeSelector (antd `content` semantic slot). |
|
|
184
272
|
|
|
185
273
|
No slots defined.
|