@lowdefy/docs-content 6.1.0 → 7.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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 +7 -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/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 +36 -19
- 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/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 +44 -0
- package/index.json +3691 -14
- package/package.json +11 -1
- package/scripts/collectImportedFiles.js +80 -0
- package/scripts/extractAgentDocs.js +41 -30
- package/scripts/hashDocSources.js +38 -0
- package/scripts/isRedirectPage.js +26 -0
- package/scripts/recordSourceHashes.js +100 -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
|
@@ -192,6 +192,45 @@ Text input with auto-complete suggestions from a list of options.
|
|
|
192
192
|
- Option A
|
|
193
193
|
- Option B
|
|
194
194
|
- Option C
|
|
195
|
+
- id: variant_underlined
|
|
196
|
+
type: AutoComplete
|
|
197
|
+
properties:
|
|
198
|
+
title: Underlined
|
|
199
|
+
variant: underlined
|
|
200
|
+
options:
|
|
201
|
+
- Apple
|
|
202
|
+
- Banana
|
|
203
|
+
- Cherry
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
```yaml
|
|
207
|
+
- id: prefix_search
|
|
208
|
+
type: AutoComplete
|
|
209
|
+
properties:
|
|
210
|
+
title: Search Fruit
|
|
211
|
+
prefixIcon: search
|
|
212
|
+
options:
|
|
213
|
+
- Apple
|
|
214
|
+
- Apricot
|
|
215
|
+
- Banana
|
|
216
|
+
- Cherry
|
|
217
|
+
events:
|
|
218
|
+
onSelect:
|
|
219
|
+
- id: selected_message
|
|
220
|
+
type: DisplayMessage
|
|
221
|
+
params:
|
|
222
|
+
content:
|
|
223
|
+
_string.concat:
|
|
224
|
+
- "Picked "
|
|
225
|
+
- _event: value
|
|
226
|
+
- id: prefix_text
|
|
227
|
+
type: AutoComplete
|
|
228
|
+
properties:
|
|
229
|
+
title: Email Domain
|
|
230
|
+
prefix: "@"
|
|
231
|
+
options:
|
|
232
|
+
- example.com
|
|
233
|
+
- example.org
|
|
195
234
|
```
|
|
196
235
|
|
|
197
236
|
```yaml
|
|
@@ -396,10 +435,11 @@ Text input with auto-complete suggestions from a list of options.
|
|
|
396
435
|
- id: style_background
|
|
397
436
|
type: AutoComplete
|
|
398
437
|
style:
|
|
399
|
-
.element:
|
|
438
|
+
.element:
|
|
439
|
+
backgroundColor: var(--ant-color-success-bg)
|
|
400
440
|
properties:
|
|
401
441
|
title: Custom Background
|
|
402
|
-
placeholder:
|
|
442
|
+
placeholder: Green tinted background
|
|
403
443
|
options:
|
|
404
444
|
- Option A
|
|
405
445
|
- Option B
|
|
@@ -423,7 +463,7 @@ Text input with auto-complete suggestions from a list of options.
|
|
|
423
463
|
- id: class_element
|
|
424
464
|
type: AutoComplete
|
|
425
465
|
class:
|
|
426
|
-
element: rounded-lg shadow-sm
|
|
466
|
+
.element: rounded-lg shadow-sm
|
|
427
467
|
properties:
|
|
428
468
|
title: Custom Class
|
|
429
469
|
placeholder: Tailwind classes applied
|
|
@@ -623,7 +663,7 @@ Text input with auto-complete suggestions from a list of options.
|
|
|
623
663
|
type: Button
|
|
624
664
|
properties:
|
|
625
665
|
title: Search
|
|
626
|
-
icon:
|
|
666
|
+
icon: search
|
|
627
667
|
type: primary
|
|
628
668
|
size: large
|
|
629
669
|
events:
|
|
@@ -692,7 +732,7 @@ Text input with auto-complete suggestions from a list of options.
|
|
|
692
732
|
properties:
|
|
693
733
|
title: Save Profile
|
|
694
734
|
type: primary
|
|
695
|
-
icon:
|
|
735
|
+
icon: save
|
|
696
736
|
events:
|
|
697
737
|
onClick:
|
|
698
738
|
- id: save_action
|
|
@@ -707,27 +747,55 @@ Text input with auto-complete suggestions from a list of options.
|
|
|
707
747
|
| `allowClear` | boolean | `true` | Allow the user to clear the selected value, sets the value to null. |
|
|
708
748
|
| `autoFocus` | boolean | `false` | Autofocus to the block on page load. |
|
|
709
749
|
| `bordered` | boolean | `true` | Whether or not the input has a border style. Deprecated, use variant instead. |
|
|
710
|
-
| `backfill` | boolean | `false` | Backfill selected item the input when using keyboard |
|
|
750
|
+
| `backfill` | boolean | `false` | Backfill the selected item into the input when using the keyboard. |
|
|
711
751
|
| `defaultOpen` | boolean | `false` | Initial open state of dropdown. |
|
|
712
752
|
| `disabled` | boolean | `false` | Disable the block if true. |
|
|
713
753
|
| `label` | object | - | Label properties. |
|
|
754
|
+
| `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
|
|
755
|
+
| `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
756
|
+
| `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. |
|
|
757
|
+
| `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
758
|
+
| `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
|
|
759
|
+
| `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
760
|
+
| `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
|
|
761
|
+
| `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
762
|
+
| `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
|
|
763
|
+
| `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
764
|
+
| `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
|
|
765
|
+
| `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
714
766
|
| `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
|
|
715
767
|
| `label.colon` | boolean | `true` | Append label with colon. |
|
|
716
768
|
| `label.extra` | string | - | Extra text to display beneath the content - supports html. |
|
|
717
769
|
| `label.title` | string | - | Label title - supports html. |
|
|
718
770
|
| `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. |
|
|
719
771
|
| `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
|
|
720
|
-
| `label.tooltip.icon` | string | `"
|
|
772
|
+
| `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`. |
|
|
721
773
|
| `label.tooltip.color` | string | - | Color of the tooltip icon. |
|
|
722
|
-
| `label.span` | number | - | Label inline
|
|
774
|
+
| `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. |
|
|
723
775
|
| `label.disabled` | boolean | `false` | Hide input label. |
|
|
724
776
|
| `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
|
|
725
777
|
| `label.inline` | boolean | `false` | Render input and label inline. |
|
|
778
|
+
| `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
|
|
779
|
+
| `listHeight` | number | `256` | Height of the dropdown list in pixels. |
|
|
726
780
|
| `options` | array | `[]` | Options can either be an array of string values. |
|
|
727
781
|
| `placeholder` | string | `"Type or select item"` | Placeholder text inside the block before user selects input. |
|
|
782
|
+
| `placement` | string | `"bottomLeft"` | Position of the dropdown relative to the selector. Enum: `bottomLeft`, `bottomRight`, `topLeft`, `topRight`. |
|
|
783
|
+
| `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). |
|
|
784
|
+
| `prefix` | string | - | Text shown inside the selector before the selected value. |
|
|
785
|
+
| `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. |
|
|
786
|
+
| `prefixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
787
|
+
| `prefixIcon.color` | string | - | Icon color. |
|
|
788
|
+
| `prefixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
789
|
+
| `prefixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
790
|
+
| `prefixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
791
|
+
| `prefixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
792
|
+
| `prefixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
793
|
+
| `prefixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
794
|
+
| `prefixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
728
795
|
| `size` | string | `"default"` | Size of the block. Enum: `small`, `default`, `large`. |
|
|
729
796
|
| `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed. |
|
|
730
|
-
| `variant` | string | - | Input visual variant.
|
|
797
|
+
| `variant` | string | - | Input visual variant. The deprecated bordered: false takes precedence and renders the input as 'borderless'. Enum: `outlined`, `filled`, `borderless`, `underlined`. |
|
|
798
|
+
| `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. |
|
|
731
799
|
| `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). |
|
|
732
800
|
| `theme.borderRadius` | number | `6` | Border radius of the input. |
|
|
733
801
|
| `theme.borderRadiusLG` | number | `8` | Border radius for large size. |
|
|
@@ -770,7 +838,9 @@ Text input with auto-complete suggestions from a list of options.
|
|
|
770
838
|
| `onChange` | `{ value }` | Trigger actions when selection is changed. |
|
|
771
839
|
| `onFocus` | \- | Trigger action when an selector gets focus. |
|
|
772
840
|
| `onClear` | \- | Trigger action when selector gets cleared. |
|
|
841
|
+
| `onOpenChange` | `{ open }` | Trigger actions when the dropdown opens or closes. |
|
|
773
842
|
| `onSearch` | `{ value }` | Called when searching items. |
|
|
843
|
+
| `onSelect` | `{ value }` | Trigger actions when an option is selected from the dropdown, as opposed to typed. |
|
|
774
844
|
| `onTooltipClick` | \- | Trigger actions when the tooltip icon is clicked. |
|
|
775
845
|
|
|
776
846
|
| Key | Target |
|
|
@@ -782,5 +852,7 @@ Text input with auto-complete suggestions from a list of options.
|
|
|
782
852
|
| `/extra` | The AutoComplete extra content. |
|
|
783
853
|
| `/feedback` | The AutoComplete validation feedback. |
|
|
784
854
|
| `/options` | The AutoComplete options. |
|
|
855
|
+
| `/popup` | The AutoComplete dropdown popup. |
|
|
856
|
+
| `/prefixIcon` | The prefix icon in the AutoComplete. |
|
|
785
857
|
|
|
786
858
|
No slots defined.
|
|
@@ -91,6 +91,27 @@ Radio group styled as toggle buttons.
|
|
|
91
91
|
value: rejected
|
|
92
92
|
```
|
|
93
93
|
|
|
94
|
+
```yaml
|
|
95
|
+
- id: block_button_selector
|
|
96
|
+
type: ButtonSelector
|
|
97
|
+
properties:
|
|
98
|
+
title: Billing Period
|
|
99
|
+
block: true
|
|
100
|
+
options:
|
|
101
|
+
- Monthly
|
|
102
|
+
- Quarterly
|
|
103
|
+
- Yearly
|
|
104
|
+
- id: vertical_button_selector
|
|
105
|
+
type: ButtonSelector
|
|
106
|
+
properties:
|
|
107
|
+
title: Plan
|
|
108
|
+
direction: vertical
|
|
109
|
+
options:
|
|
110
|
+
- Starter
|
|
111
|
+
- Team
|
|
112
|
+
- Enterprise
|
|
113
|
+
```
|
|
114
|
+
|
|
94
115
|
```yaml
|
|
95
116
|
- id: size_small
|
|
96
117
|
type: ButtonSelector
|
|
@@ -571,6 +592,7 @@ Radio group styled as toggle buttons.
|
|
|
571
592
|
```yaml
|
|
572
593
|
- id: class_padding
|
|
573
594
|
type: ButtonSelector
|
|
595
|
+
class: p-4
|
|
574
596
|
properties:
|
|
575
597
|
title: Tailwind Padding
|
|
576
598
|
variant: solid
|
|
@@ -581,9 +603,9 @@ Radio group styled as toggle buttons.
|
|
|
581
603
|
value: b
|
|
582
604
|
- label: Option C
|
|
583
605
|
value: c
|
|
584
|
-
class: p-4
|
|
585
606
|
- id: class_shadow_rounded
|
|
586
607
|
type: ButtonSelector
|
|
608
|
+
class: shadow-md rounded-lg p-2
|
|
587
609
|
properties:
|
|
588
610
|
title: Shadow and Rounded
|
|
589
611
|
variant: solid
|
|
@@ -594,9 +616,9 @@ Radio group styled as toggle buttons.
|
|
|
594
616
|
value: b
|
|
595
617
|
- label: Option C
|
|
596
618
|
value: c
|
|
597
|
-
class: shadow-md rounded-lg p-2
|
|
598
619
|
- id: class_background
|
|
599
620
|
type: ButtonSelector
|
|
621
|
+
class: bg-bg-layout p-3 rounded
|
|
600
622
|
properties:
|
|
601
623
|
title: Background Color
|
|
602
624
|
variant: solid
|
|
@@ -607,7 +629,6 @@ Radio group styled as toggle buttons.
|
|
|
607
629
|
value: b
|
|
608
630
|
- label: Option C
|
|
609
631
|
value: c
|
|
610
|
-
class: bg-bg-layout p-3 rounded
|
|
611
632
|
```
|
|
612
633
|
|
|
613
634
|
```yaml
|
|
@@ -746,7 +767,7 @@ Radio group styled as toggle buttons.
|
|
|
746
767
|
properties:
|
|
747
768
|
title: Submit Survey
|
|
748
769
|
type: primary
|
|
749
|
-
icon:
|
|
770
|
+
icon: send
|
|
750
771
|
events:
|
|
751
772
|
onClick:
|
|
752
773
|
- id: survey_submit_action
|
|
@@ -816,7 +837,7 @@ Radio group styled as toggle buttons.
|
|
|
816
837
|
properties:
|
|
817
838
|
title: Save Settings
|
|
818
839
|
type: primary
|
|
819
|
-
icon:
|
|
840
|
+
icon: save
|
|
820
841
|
events:
|
|
821
842
|
onClick:
|
|
822
843
|
- id: settings_save_action
|
|
@@ -886,13 +907,15 @@ Radio group styled as toggle buttons.
|
|
|
886
907
|
|
|
887
908
|
| Property | Type | Default | Description |
|
|
888
909
|
| --- | --- | --- | --- |
|
|
910
|
+
| `block` | boolean | `false` | Stretch the buttons to fill the width of the parent, sharing it equally. |
|
|
911
|
+
| `direction` | string | `"horizontal"` | Lay the option buttons out in a row or stack them in a column. Enum: `horizontal`, `vertical`. |
|
|
889
912
|
| `variant` | string | `"solid"` | Visual variant of the selected option button, matching the Button block. Enum: `solid`, `outlined`. |
|
|
890
913
|
| `buttonStyle` | string | - | Deprecated — use `variant` (solid \| outlined) instead. Enum: `solid`, `outline`. |
|
|
891
914
|
| `color` | string | - | Color applied to the selected button. Fills the background in solid mode (with auto-contrasting text) and the border/text in outline mode. |
|
|
892
915
|
| `disabled` | boolean | `false` | Disable the block if true. |
|
|
893
916
|
| `options` | array | `[]` | Options can either be an array of primitive values, on an array of label, value pairs - supports html. |
|
|
894
917
|
| `options.$.label` | string | - | Value label shown to user - supports html. |
|
|
895
|
-
| `options.$.value` |
|
|
918
|
+
| `options.$.value` | - | - | Option value. Can be of any type. |
|
|
896
919
|
| `options.$.disabled` | boolean | `false` | Disable the option if true. |
|
|
897
920
|
| `options.$.style` | object | - | Css style to apply to the option. |
|
|
898
921
|
| `options.$.color` | string | - | Color applied to this option when it is selected. Falls back to the block-level color when not set. |
|
|
@@ -902,18 +925,31 @@ Radio group styled as toggle buttons.
|
|
|
902
925
|
| `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. |
|
|
903
926
|
| `size` | string | `"default"` | Size of the block. Enum: `small`, `default`, `large`. |
|
|
904
927
|
| `label` | object | - | Label properties. |
|
|
928
|
+
| `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
|
|
929
|
+
| `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
930
|
+
| `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. |
|
|
931
|
+
| `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
932
|
+
| `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
|
|
933
|
+
| `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
934
|
+
| `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
|
|
935
|
+
| `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
936
|
+
| `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
|
|
937
|
+
| `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
938
|
+
| `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
|
|
939
|
+
| `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
905
940
|
| `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
|
|
906
941
|
| `label.colon` | boolean | `true` | Append label with colon. |
|
|
907
942
|
| `label.extra` | string | - | Extra text to display beneath the content - supports html. |
|
|
908
943
|
| `label.title` | string | - | Label title - supports html. |
|
|
909
944
|
| `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. |
|
|
910
945
|
| `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
|
|
911
|
-
| `label.tooltip.icon` | string | `"
|
|
946
|
+
| `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`. |
|
|
912
947
|
| `label.tooltip.color` | string | - | Color of the tooltip icon. |
|
|
913
|
-
| `label.span` | number | - | Label inline
|
|
948
|
+
| `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. |
|
|
914
949
|
| `label.disabled` | boolean | `false` | Hide input label. |
|
|
915
950
|
| `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
|
|
916
951
|
| `label.inline` | boolean | `false` | Render input and label inline. |
|
|
952
|
+
| `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
|
|
917
953
|
| `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
|
|
918
954
|
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design radio tokens](https://ant.design/components/radio#design-token). |
|
|
919
955
|
| `theme.radioSize` | number | `16` | Size of the radio dot element. |
|
|
@@ -960,5 +996,6 @@ Radio group styled as toggle buttons.
|
|
|
960
996
|
| `/label` | The ButtonSelector label. |
|
|
961
997
|
| `/extra` | The ButtonSelector extra content. |
|
|
962
998
|
| `/feedback` | The ButtonSelector validation feedback. |
|
|
999
|
+
| `/options` | Each ButtonSelector option. |
|
|
963
1000
|
|
|
964
1001
|
No slots defined.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Captcha
|
|
2
|
+
|
|
3
|
+
Renders a captcha widget (Cloudflare Turnstile) and writes the minted token into state under its blockId. Configure `provider` and `siteKey` from the `_build.authConfig` projection when `auth.captcha` is enabled. The `reset` method clears the value and mints a fresh token; expiry clears the value automatically.
|
|
4
|
+
|
|
5
|
+
> The widget script loads from the provider's CDN at render - apps behind a strict CSP should allowlist challenges.cloudflare.com. Tokens are single-use and short-lived: pass the block value as the `captchaToken` param of auth actions, and call the block's `reset` method from the action's `onError` chain to mint a fresh token for retries.
|
|
6
|
+
|
|
7
|
+
```yaml
|
|
8
|
+
- id: captcha_basic
|
|
9
|
+
type: Captcha
|
|
10
|
+
properties:
|
|
11
|
+
provider: cloudflare-turnstile
|
|
12
|
+
siteKey: 1x00000000000000000000AA
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
```yaml
|
|
16
|
+
- id: captcha_compact
|
|
17
|
+
type: Captcha
|
|
18
|
+
properties:
|
|
19
|
+
provider: cloudflare-turnstile
|
|
20
|
+
siteKey: 1x00000000000000000000AA
|
|
21
|
+
theme: light
|
|
22
|
+
size: compact
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
| Property | Type | Default | Description |
|
|
26
|
+
| --- | --- | --- | --- |
|
|
27
|
+
| `provider` | string | `"cloudflare-turnstile"` | Captcha provider to render. Normally fed from the auth config projection: { _build.authConfig: captcha.provider }. Enum: `cloudflare-turnstile`. |
|
|
28
|
+
| `siteKey` | string | - | The provider site key - public, rendered into the page. Normally fed from the auth config projection: { _build.authConfig: captcha.siteKey }. |
|
|
29
|
+
| `theme` | string | `"auto"` | Widget theme. Enum: `auto`, `light`, `dark`. |
|
|
30
|
+
| `size` | string | `"normal"` | Widget size. Enum: `normal`, `compact`, `flexible`. |
|
|
31
|
+
|
|
32
|
+
| Event | Event Data | Description |
|
|
33
|
+
| --- | --- | --- |
|
|
34
|
+
| `onSuccess` | \- | Trigger actions when the captcha challenge succeeds and a token is minted. |
|
|
35
|
+
| `onExpire` | \- | Trigger actions when the minted token expires - the block value is cleared so a late submit fails with a clear missing-token error. |
|
|
36
|
+
| `onError` | \- | Trigger actions when the captcha provider reports an error. |
|
|
37
|
+
|
|
38
|
+
No CSS keys defined.
|
|
39
|
+
|
|
40
|
+
No slots defined.
|
|
@@ -703,16 +703,92 @@ Checkbox group for selecting multiple options.
|
|
|
703
703
|
valueKey: id
|
|
704
704
|
```
|
|
705
705
|
|
|
706
|
+
```yaml
|
|
707
|
+
- id: columns_two
|
|
708
|
+
type: CheckboxSelector
|
|
709
|
+
properties:
|
|
710
|
+
title: Two columns
|
|
711
|
+
columns: 2
|
|
712
|
+
options:
|
|
713
|
+
- Weekday mornings
|
|
714
|
+
- Weekday afternoons
|
|
715
|
+
- Weekday evenings
|
|
716
|
+
- Weekend mornings
|
|
717
|
+
- Weekend afternoons
|
|
718
|
+
- Weekend evenings
|
|
719
|
+
- id: columns_four
|
|
720
|
+
type: CheckboxSelector
|
|
721
|
+
properties:
|
|
722
|
+
title: Four columns
|
|
723
|
+
columns: 4
|
|
724
|
+
options:
|
|
725
|
+
- January
|
|
726
|
+
- February
|
|
727
|
+
- March
|
|
728
|
+
- April
|
|
729
|
+
- May
|
|
730
|
+
- June
|
|
731
|
+
- July
|
|
732
|
+
- August
|
|
733
|
+
- id: columns_responsive
|
|
734
|
+
type: CheckboxSelector
|
|
735
|
+
properties:
|
|
736
|
+
title: One column below md, three from md up
|
|
737
|
+
columns:
|
|
738
|
+
xs: 1
|
|
739
|
+
md: 3
|
|
740
|
+
options:
|
|
741
|
+
- Email
|
|
742
|
+
- SMS
|
|
743
|
+
- Push notification
|
|
744
|
+
- Webhook
|
|
745
|
+
- In-app message
|
|
746
|
+
- Weekly digest
|
|
747
|
+
- id: columns_gutter
|
|
748
|
+
type: CheckboxSelector
|
|
749
|
+
properties:
|
|
750
|
+
title: Wider gutter
|
|
751
|
+
columns: 2
|
|
752
|
+
gutter:
|
|
753
|
+
- 24
|
|
754
|
+
- 12
|
|
755
|
+
options:
|
|
756
|
+
- Read
|
|
757
|
+
- Write
|
|
758
|
+
- Delete
|
|
759
|
+
- Administer
|
|
760
|
+
- id: columns_per_option_color
|
|
761
|
+
type: CheckboxSelector
|
|
762
|
+
properties:
|
|
763
|
+
title: Coloured options in a grid
|
|
764
|
+
columns: 2
|
|
765
|
+
options:
|
|
766
|
+
- label: Low
|
|
767
|
+
value: low
|
|
768
|
+
color: "#16a34a"
|
|
769
|
+
- label: Medium
|
|
770
|
+
value: medium
|
|
771
|
+
color: "#d97706"
|
|
772
|
+
- label: High
|
|
773
|
+
value: high
|
|
774
|
+
color: "#dc2626"
|
|
775
|
+
- label: Critical
|
|
776
|
+
value: critical
|
|
777
|
+
color: "#7e22ce"
|
|
778
|
+
```
|
|
779
|
+
|
|
706
780
|
| Property | Type | Default | Description |
|
|
707
781
|
| --- | --- | --- | --- |
|
|
708
|
-
| `align` | string | `"start"` | Align options. Enum: `start`, `end`, `center`, `baseline`. |
|
|
782
|
+
| `align` | string | `"start"` | Align options. Ignored when 'columns' is set. Enum: `start`, `end`, `center`, `baseline`. |
|
|
709
783
|
| `color` | string | - | Selected checkbox color. |
|
|
784
|
+
| `columns` | integer \| object | - | Number of columns to lay the options out in, or a responsive breakpoint object. Use a count that divides 24 evenly. |
|
|
710
785
|
| `disabled` | boolean | `false` | Disable the block if true. |
|
|
711
|
-
| `direction` | string | `"horizontal"` | List options horizontally or vertical. Enum: `horizontal`, `vertical`. |
|
|
712
|
-
| `
|
|
786
|
+
| `direction` | string | `"horizontal"` | List options horizontally or vertical. Ignored when 'columns' is set. Enum: `horizontal`, `vertical`. |
|
|
787
|
+
| `gutter` | number \| array | - | Gap between options in the grid. Number or [horizontal, vertical] array. Applies when 'columns' is set. |
|
|
788
|
+
| `wrap` | boolean | `true` | Specifies wrapping of options. Applies when 'direction' is 'horizontal'. Ignored when 'columns' is set. |
|
|
713
789
|
| `options` | array | `[]` | Options can either be an array of primitive values, on an array of label, value pairs - supports html. |
|
|
714
790
|
| `options.$.label` | string | - | Value label shown to user - supports html. |
|
|
715
|
-
| `options.$.value` |
|
|
791
|
+
| `options.$.value` | - | - | Option value. Can be of any type. |
|
|
716
792
|
| `options.$.disabled` | boolean | `false` | Disable the option if true. |
|
|
717
793
|
| `options.$.style` | object | - | Css style to apply to the option. |
|
|
718
794
|
| `options.$.color` | string | - | Color applied to this option when it is selected. Falls back to the block-level color when not set. |
|
|
@@ -721,18 +797,31 @@ Checkbox group for selecting multiple options.
|
|
|
721
797
|
| `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"). |
|
|
722
798
|
| `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. |
|
|
723
799
|
| `label` | object | - | Label properties. |
|
|
800
|
+
| `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
|
|
801
|
+
| `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
802
|
+
| `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. |
|
|
803
|
+
| `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
804
|
+
| `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
|
|
805
|
+
| `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
806
|
+
| `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
|
|
807
|
+
| `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
808
|
+
| `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
|
|
809
|
+
| `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
810
|
+
| `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
|
|
811
|
+
| `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
724
812
|
| `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
|
|
725
813
|
| `label.colon` | boolean | `true` | Append label with colon. |
|
|
726
814
|
| `label.extra` | string | - | Extra text to display beneath the content - supports html. |
|
|
727
815
|
| `label.title` | string | - | Label title - supports html. |
|
|
728
816
|
| `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. |
|
|
729
817
|
| `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
|
|
730
|
-
| `label.tooltip.icon` | string | `"
|
|
818
|
+
| `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`. |
|
|
731
819
|
| `label.tooltip.color` | string | - | Color of the tooltip icon. |
|
|
732
|
-
| `label.span` | number | - | Label inline
|
|
820
|
+
| `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. |
|
|
733
821
|
| `label.disabled` | boolean | `false` | Hide input label. |
|
|
734
822
|
| `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
|
|
735
823
|
| `label.inline` | boolean | `false` | Render input and label inline. |
|
|
824
|
+
| `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
|
|
736
825
|
| `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
|
|
737
826
|
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design checkbox tokens](https://ant.design/components/checkbox#design-token). |
|
|
738
827
|
| `theme.colorPrimary` | string | - | Primary color for checked checkboxes. |
|
|
@@ -746,7 +835,7 @@ Checkbox group for selecting multiple options.
|
|
|
746
835
|
| `theme.lineWidth` | number | `1` | Border width of the checkbox. |
|
|
747
836
|
| `theme.lineType` | string | `"solid"` | Border style of the checkbox. |
|
|
748
837
|
| `theme.fontSize` | number | `14` | Font size for checkbox labels. |
|
|
749
|
-
| `theme.marginXS` | number | `8` |
|
|
838
|
+
| `theme.marginXS` | number | `8` | Column gap on the checkbox group element. Does not space the options apart; set 'gutter' for a grid. |
|
|
750
839
|
| `theme.paddingXS` | number | `8` | Inline padding between the checkbox and its label text. |
|
|
751
840
|
|
|
752
841
|
| Event | Event Data | Description |
|
|
@@ -761,5 +850,6 @@ Checkbox group for selecting multiple options.
|
|
|
761
850
|
| `/label` | The CheckboxSelector label. |
|
|
762
851
|
| `/extra` | The CheckboxSelector extra content. |
|
|
763
852
|
| `/feedback` | The CheckboxSelector validation feedback. |
|
|
853
|
+
| `/options` | Each CheckboxSelector option. |
|
|
764
854
|
|
|
765
855
|
No slots defined.
|
|
@@ -19,6 +19,34 @@ Single checkbox for boolean input.
|
|
|
19
19
|
description: Keep me signed in on this device
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
+
```yaml
|
|
23
|
+
- id: select_all
|
|
24
|
+
type: CheckboxSwitch
|
|
25
|
+
properties:
|
|
26
|
+
title: Recipients
|
|
27
|
+
description: Select all
|
|
28
|
+
indeterminate:
|
|
29
|
+
_ne:
|
|
30
|
+
- _if_none:
|
|
31
|
+
- _state: recipient_alice
|
|
32
|
+
- false
|
|
33
|
+
- _if_none:
|
|
34
|
+
- _state: recipient_bob
|
|
35
|
+
- false
|
|
36
|
+
- id: recipient_alice
|
|
37
|
+
type: CheckboxSwitch
|
|
38
|
+
properties:
|
|
39
|
+
description: Alice
|
|
40
|
+
label:
|
|
41
|
+
disabled: true
|
|
42
|
+
- id: recipient_bob
|
|
43
|
+
type: CheckboxSwitch
|
|
44
|
+
properties:
|
|
45
|
+
description: Bob
|
|
46
|
+
label:
|
|
47
|
+
disabled: true
|
|
48
|
+
```
|
|
49
|
+
|
|
22
50
|
```yaml
|
|
23
51
|
- id: desc_terms
|
|
24
52
|
type: CheckboxSwitch
|
|
@@ -369,7 +397,7 @@ Single checkbox for boolean input.
|
|
|
369
397
|
properties:
|
|
370
398
|
title: Create Account
|
|
371
399
|
type: primary
|
|
372
|
-
icon:
|
|
400
|
+
icon: UserPlus
|
|
373
401
|
block: true
|
|
374
402
|
events:
|
|
375
403
|
onClick:
|
|
@@ -436,7 +464,7 @@ Single checkbox for boolean input.
|
|
|
436
464
|
properties:
|
|
437
465
|
title: Save Preferences
|
|
438
466
|
type: primary
|
|
439
|
-
icon:
|
|
467
|
+
icon: save
|
|
440
468
|
events:
|
|
441
469
|
onClick:
|
|
442
470
|
- id: save_notif
|
|
@@ -448,9 +476,11 @@ Single checkbox for boolean input.
|
|
|
448
476
|
|
|
449
477
|
| Property | Type | Default | Description |
|
|
450
478
|
| --- | --- | --- | --- |
|
|
479
|
+
| `autoFocus` | boolean | `false` | Autofocus to the block on page load. |
|
|
451
480
|
| `color` | string | - | Selected checkbox color. |
|
|
452
481
|
| `disabled` | boolean | `false` | Disable the block if true. |
|
|
453
482
|
| `description` | string | - | Text to display next to the checkbox - supports html. |
|
|
483
|
+
| `indeterminate` | boolean | `false` | Show the checkbox as partly checked, eg. for a select all checkbox when only some items are selected. Only changes how the checkbox looks, not its value. |
|
|
454
484
|
| `label` | object | - | Label properties. |
|
|
455
485
|
| `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
|
|
456
486
|
| `label.colon` | boolean | `true` | Append label with colon. |
|
|
@@ -458,7 +488,7 @@ Single checkbox for boolean input.
|
|
|
458
488
|
| `label.title` | string | - | Label title - supports html. |
|
|
459
489
|
| `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. |
|
|
460
490
|
| `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
|
|
461
|
-
| `label.tooltip.icon` | string | `"
|
|
491
|
+
| `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`. |
|
|
462
492
|
| `label.tooltip.color` | string | - | Color of the tooltip icon. |
|
|
463
493
|
| `label.span` | number | - | Label inline span. |
|
|
464
494
|
| `label.disabled` | boolean | `false` | Hide input label. |
|