@lowdefy/docs-content 6.0.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 +41 -4
- 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 +185 -2
- package/content/concepts/four-primitives.md +31 -0
- package/content/concepts/html-attributes.md +293 -0
- package/content/concepts/i18n.md +12 -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 +144 -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 +3 -0
- package/content/connections/smtp.md +16 -0
- 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 +26 -3
- package/content/controls/return.md +17 -1
- package/content/controls/throw.md +30 -2
- package/content/controls/try.md +24 -2
- package/content/controls/while.md +46 -0
- package/content/deployment/deployment-environments.md +146 -0
- package/content/deployment/docker.md +23 -7
- package/content/deployment/node-server.md +4 -0
- package/content/deployment/vercel.md +25 -19
- 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 +196 -0
- 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 +3472 -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
|
@@ -41,6 +41,13 @@ Combined date and time picker.
|
|
|
41
41
|
variant: borderless
|
|
42
42
|
label:
|
|
43
43
|
disabled: true
|
|
44
|
+
- id: dts_variant_underlined
|
|
45
|
+
type: DateTimeSelector
|
|
46
|
+
properties:
|
|
47
|
+
title: Underlined
|
|
48
|
+
variant: underlined
|
|
49
|
+
label:
|
|
50
|
+
disabled: true
|
|
44
51
|
```
|
|
45
52
|
|
|
46
53
|
```yaml
|
|
@@ -251,6 +258,55 @@ Combined date and time picker.
|
|
|
251
258
|
disabled: true
|
|
252
259
|
```
|
|
253
260
|
|
|
261
|
+
```yaml
|
|
262
|
+
- id: dts_prefix_icon
|
|
263
|
+
type: DateTimeSelector
|
|
264
|
+
properties:
|
|
265
|
+
title: Prefix Icon
|
|
266
|
+
prefixIcon: clock
|
|
267
|
+
suffixIcon:
|
|
268
|
+
name: calendar
|
|
269
|
+
color: "#8c8c8c"
|
|
270
|
+
- id: dts_prefix_text
|
|
271
|
+
type: DateTimeSelector
|
|
272
|
+
properties:
|
|
273
|
+
title: Prefix Text
|
|
274
|
+
prefix: "From:"
|
|
275
|
+
- id: dts_placement
|
|
276
|
+
type: DateTimeSelector
|
|
277
|
+
properties:
|
|
278
|
+
title: Popup Opens Top Right
|
|
279
|
+
placement: topRight
|
|
280
|
+
- id: dts_read_only
|
|
281
|
+
type: DateTimeSelector
|
|
282
|
+
properties:
|
|
283
|
+
title: Pick From Calendar Only
|
|
284
|
+
inputReadOnly: true
|
|
285
|
+
label:
|
|
286
|
+
extra: The input is read-only, so touch devices do not open the keyboard.
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
```yaml
|
|
290
|
+
- id: dts_no_confirm
|
|
291
|
+
type: DateTimeSelector
|
|
292
|
+
properties:
|
|
293
|
+
title: No OK Button
|
|
294
|
+
needConfirm: false
|
|
295
|
+
label:
|
|
296
|
+
extra: No OK button, the selection is saved when the popup closes.
|
|
297
|
+
- id: dts_twelve_hour
|
|
298
|
+
type: DateTimeSelector
|
|
299
|
+
properties:
|
|
300
|
+
title: 12 Hour Clock
|
|
301
|
+
format: YYYY-MM-DD hh:mm a
|
|
302
|
+
timeFormat: hh:mm a
|
|
303
|
+
- id: dts_show_week
|
|
304
|
+
type: DateTimeSelector
|
|
305
|
+
properties:
|
|
306
|
+
title: Show Week Numbers
|
|
307
|
+
showWeek: true
|
|
308
|
+
```
|
|
309
|
+
|
|
254
310
|
```yaml
|
|
255
311
|
- id: dts_dis_outlined
|
|
256
312
|
type: DateTimeSelector
|
|
@@ -294,14 +350,14 @@ Combined date and time picker.
|
|
|
294
350
|
type: DateTimeSelector
|
|
295
351
|
properties:
|
|
296
352
|
title: Clock Icon
|
|
297
|
-
suffixIcon:
|
|
353
|
+
suffixIcon: clock
|
|
298
354
|
label:
|
|
299
355
|
disabled: true
|
|
300
356
|
- id: dts_icon_schedule
|
|
301
357
|
type: DateTimeSelector
|
|
302
358
|
properties:
|
|
303
359
|
title: Schedule Icon
|
|
304
|
-
suffixIcon:
|
|
360
|
+
suffixIcon: CalendarDays
|
|
305
361
|
label:
|
|
306
362
|
disabled: true
|
|
307
363
|
- id: dts_icon_custom_color
|
|
@@ -309,7 +365,7 @@ Combined date and time picker.
|
|
|
309
365
|
properties:
|
|
310
366
|
title: Custom Color Icon
|
|
311
367
|
suffixIcon:
|
|
312
|
-
name:
|
|
368
|
+
name: calendar
|
|
313
369
|
color: "#1677ff"
|
|
314
370
|
label:
|
|
315
371
|
disabled: true
|
|
@@ -318,7 +374,7 @@ Combined date and time picker.
|
|
|
318
374
|
properties:
|
|
319
375
|
title: Heart Icon
|
|
320
376
|
suffixIcon:
|
|
321
|
-
name:
|
|
377
|
+
name: heart
|
|
322
378
|
color: "#ff4d4f"
|
|
323
379
|
label:
|
|
324
380
|
disabled: true
|
|
@@ -510,7 +566,8 @@ Combined date and time picker.
|
|
|
510
566
|
- id: dts_style_element
|
|
511
567
|
type: DateTimeSelector
|
|
512
568
|
style:
|
|
513
|
-
.element:
|
|
569
|
+
.element:
|
|
570
|
+
backgroundColor: var(--ant-color-primary-bg)
|
|
514
571
|
properties:
|
|
515
572
|
title: Custom Background
|
|
516
573
|
label:
|
|
@@ -595,7 +652,7 @@ Combined date and time picker.
|
|
|
595
652
|
placeholder: Select appointment date & time
|
|
596
653
|
format: DD MMMM YYYY HH:mm
|
|
597
654
|
size: large
|
|
598
|
-
suffixIcon:
|
|
655
|
+
suffixIcon: CalendarDays
|
|
599
656
|
showToday: true
|
|
600
657
|
showNow: true
|
|
601
658
|
allowClear: true
|
|
@@ -625,7 +682,7 @@ Combined date and time picker.
|
|
|
625
682
|
minuteStep: 30
|
|
626
683
|
hourStep: 1
|
|
627
684
|
suffixIcon:
|
|
628
|
-
name:
|
|
685
|
+
name: calendar
|
|
629
686
|
color: "#1677ff"
|
|
630
687
|
disabledDates:
|
|
631
688
|
min: 2026-01-01
|
|
@@ -640,7 +697,7 @@ Combined date and time picker.
|
|
|
640
697
|
selectUTC: true
|
|
641
698
|
size: large
|
|
642
699
|
variant: filled
|
|
643
|
-
suffixIcon:
|
|
700
|
+
suffixIcon: clock
|
|
644
701
|
label:
|
|
645
702
|
extra: Time is recorded in UTC.
|
|
646
703
|
- id: dts_combo_themed
|
|
@@ -653,7 +710,7 @@ Combined date and time picker.
|
|
|
653
710
|
placeholder: Choose a special date & time...
|
|
654
711
|
minuteStep: 15
|
|
655
712
|
suffixIcon:
|
|
656
|
-
name:
|
|
713
|
+
name: heart
|
|
657
714
|
color: "#eb2f96"
|
|
658
715
|
label:
|
|
659
716
|
disabled: true
|
|
@@ -678,7 +735,7 @@ Combined date and time picker.
|
|
|
678
735
|
format: DD MMMM YYYY HH:mm
|
|
679
736
|
minuteStep: 15
|
|
680
737
|
size: large
|
|
681
|
-
suffixIcon:
|
|
738
|
+
suffixIcon: CalendarDays
|
|
682
739
|
label:
|
|
683
740
|
extra: Appointments are available in 15-minute slots.
|
|
684
741
|
disabledDates:
|
|
@@ -708,7 +765,7 @@ Combined date and time picker.
|
|
|
708
765
|
type: Button
|
|
709
766
|
properties:
|
|
710
767
|
title: Book Appointment
|
|
711
|
-
icon:
|
|
768
|
+
icon: calendar
|
|
712
769
|
type: primary
|
|
713
770
|
size: large
|
|
714
771
|
block: true
|
|
@@ -739,7 +796,7 @@ Combined date and time picker.
|
|
|
739
796
|
placeholder: Select meeting date and time
|
|
740
797
|
format: DD MMMM YYYY HH:mm
|
|
741
798
|
minuteStep: 15
|
|
742
|
-
suffixIcon:
|
|
799
|
+
suffixIcon: clock
|
|
743
800
|
label:
|
|
744
801
|
extra: Meetings are scheduled in 15-minute increments.
|
|
745
802
|
disabledDates:
|
|
@@ -754,7 +811,7 @@ Combined date and time picker.
|
|
|
754
811
|
type: Button
|
|
755
812
|
properties:
|
|
756
813
|
title: Schedule Meeting
|
|
757
|
-
icon:
|
|
814
|
+
icon: CalendarDays
|
|
758
815
|
type: primary
|
|
759
816
|
size: large
|
|
760
817
|
block: true
|
|
@@ -773,7 +830,7 @@ Combined date and time picker.
|
|
|
773
830
|
| `autoFocus` | boolean | `false` | Autofocus to the block on page load. |
|
|
774
831
|
| `bordered` | boolean | `true` | Deprecated - use variant: 'borderless'. Whether or not the input has a border style. |
|
|
775
832
|
| `disabled` | boolean | `false` | Disable the block if true. |
|
|
776
|
-
| `variant` | string | `"outlined"` | Variant style of the input. Use 'borderless' instead of bordered: false. Enum: `outlined`, `filled`, `borderless`. |
|
|
833
|
+
| `variant` | string | `"outlined"` | Variant style of the input. Use 'borderless' instead of bordered: false. Enum: `outlined`, `filled`, `borderless`, `underlined`. |
|
|
777
834
|
| `disabledDates` | object | - | Disable specific dates so that they can not be chosen. |
|
|
778
835
|
| `disabledDates.min` | string \| object | - | Disable all dates less than the minimum date. Can be a date string or a _date object. |
|
|
779
836
|
| `disabledDates.max` | string \| object | - | Disable all dates greater than the maximum date. Can be a date string or a _date object. |
|
|
@@ -783,68 +840,119 @@ Combined date and time picker.
|
|
|
783
840
|
| `disabledDates.ranges.$.to` | string \| object | - | End of the disabled range. |
|
|
784
841
|
| `format` | string | - | Format in which to parse the date value, eg. "DD MMMM YYYY HH:mm" will parse a date value of 1999-12-31T15:30 as "31 December 1999 15:30". The format has to conform to dayjs formats. Defaults to the active locale's date-time format, or "YYYY-MM-DD HH:mm" when no locale is configured. |
|
|
785
842
|
| `hourStep` | integer | `1` | Hour intervals to show in the time selector. |
|
|
843
|
+
| `inputReadOnly` | boolean | `false` | Make the text input read-only, so a date can only be chosen from the calendar. This also stops the on-screen keyboard opening on touch devices. |
|
|
786
844
|
| `label` | object | - | Label properties. |
|
|
845
|
+
| `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
|
|
846
|
+
| `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
847
|
+
| `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. |
|
|
848
|
+
| `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
849
|
+
| `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
|
|
850
|
+
| `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
851
|
+
| `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
|
|
852
|
+
| `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
853
|
+
| `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
|
|
854
|
+
| `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
855
|
+
| `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
|
|
856
|
+
| `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
787
857
|
| `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
|
|
788
858
|
| `label.colon` | boolean | `true` | Append label with colon. |
|
|
789
859
|
| `label.extra` | string | - | Extra text to display beneath the content - supports html. |
|
|
790
860
|
| `label.title` | string | - | Label title - supports html. |
|
|
791
861
|
| `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. |
|
|
792
862
|
| `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
|
|
793
|
-
| `label.tooltip.icon` | string | `"
|
|
863
|
+
| `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`. |
|
|
794
864
|
| `label.tooltip.color` | string | - | Color of the tooltip icon. |
|
|
795
|
-
| `label.span` | number | - | Label inline
|
|
865
|
+
| `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. |
|
|
796
866
|
| `label.disabled` | boolean | `false` | Hide input label. |
|
|
797
867
|
| `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
|
|
798
868
|
| `label.inline` | boolean | `false` | Render input and label inline. |
|
|
869
|
+
| `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
|
|
799
870
|
| `minuteStep` | integer | `5` | Minute intervals to show in the time selector. |
|
|
871
|
+
| `needConfirm` | boolean | `true` | Require the OK button to confirm the selection. When false, the popup has no OK button and the selection is saved when the popup closes, eg. when the user clicks outside it or presses Enter. |
|
|
800
872
|
| `placeholder` | string | - | Placeholder text inside the block before user types input. |
|
|
873
|
+
| `placement` | string | `"bottomLeft"` | Position of the calendar popup relative to the input. Enum: `bottomLeft`, `bottomRight`, `topLeft`, `topRight`. |
|
|
874
|
+
| `prefix` | string | - | Prefix text shown before the date in the input, priority over prefixIcon. |
|
|
875
|
+
| `prefixIcon` | string \| object | - | Icon name (a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`) or properties of an Icon block to customize icon on the left-hand side of the date picker. |
|
|
876
|
+
| `prefixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
877
|
+
| `prefixIcon.color` | string | - | Icon color. |
|
|
878
|
+
| `prefixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
879
|
+
| `prefixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
880
|
+
| `prefixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
881
|
+
| `prefixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
882
|
+
| `prefixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
883
|
+
| `prefixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
884
|
+
| `prefixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
801
885
|
| `presets` | array | - | Shortcuts listed next to the calendar to quickly select a date and time. Presets are re-evaluated every time the block config is evaluated, so operator based values like "_date: now" stay current. A preset is offered on the same terms as the calendar cells: a shortcut with nothing it may select is listed as disabled. |
|
|
802
886
|
| `presets.$.label` | string | - | Text shown for the shortcut - supports html. |
|
|
803
887
|
| `presets.$.value` | string \| number \| object | - | A date string, a timestamp, or a _date object. The date is used as the instant it names, so "_date: now" and _dayjs chains need no special handling. With selectUTC the instant is shown on the UTC clock, so a chain that snaps to a calendar boundary needs a utc step to snap to the UTC day, eg. "_dayjs: [now, utc, {startOf: day}]". Without selectUTC the instant is shown on the local clock, so a chain resolves in local time, eg. "_dayjs: [now, {startOf: day}]". |
|
|
804
|
-
| `secondStep` | integer | `
|
|
888
|
+
| `secondStep` | integer | `30` | Second intervals to show in the time selector. |
|
|
805
889
|
| `selectUTC` | boolean | `false` | Shows the user's selection as UTC time, not time-zone based. |
|
|
806
|
-
| `showToday` | boolean | `true` |
|
|
890
|
+
| `showToday` | boolean | `true` | Deprecated - use showNow. Used for showNow when showNow is not set. |
|
|
807
891
|
| `showNow` | boolean | `true` | Shows a 'Now' button to set current time. |
|
|
892
|
+
| `showWeek` | boolean | `false` | Show the week number of each row in the calendar. |
|
|
808
893
|
| `size` | string | `"default"` | Size of the block. Enum: `small`, `default`, `large`. |
|
|
809
|
-
| `suffixIcon` | string \| object | `"
|
|
810
|
-
| `
|
|
894
|
+
| `suffixIcon` | string \| object | `"calendar"` | Icon name (a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`) or properties of an Icon block to customize icon on right-hand side of the date picker. |
|
|
895
|
+
| `suffixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
896
|
+
| `suffixIcon.color` | string | - | Icon color. |
|
|
897
|
+
| `suffixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
898
|
+
| `suffixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
899
|
+
| `suffixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
900
|
+
| `suffixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
901
|
+
| `suffixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
902
|
+
| `suffixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
903
|
+
| `suffixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
904
|
+
| `timeFormat` | string | `"HH:mm"` | Time format to show in the time selector. HH:mm:ss will show hours, minutes and seconds, HH:mm only hours and minutes and HH only hours. A 12 hour format like "hh:mm a" adds an AM/PM column; use a matching format, eg. "YYYY-MM-DD hh:mm a", to show the time in the input. |
|
|
811
905
|
| `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
|
|
812
906
|
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design date-picker tokens](https://ant.design/components/date-picker#design-token). |
|
|
907
|
+
| `theme.activeBg` | string | `"#ffffff"` | Background color of the input when the picker is active/focused. |
|
|
908
|
+
| `theme.activeBorderColor` | string | - | Border color when the picker is active/focused. |
|
|
909
|
+
| `theme.activeShadow` | string | `"0 0 0 2px rgba(5,145,255,0.1)"` | Shadow effect when the picker is active/focused. |
|
|
910
|
+
| `theme.borderRadius` | number | `6` | Border radius of the picker input. |
|
|
911
|
+
| `theme.borderRadiusLG` | number | `8` | Border radius for the large picker and popup panel. |
|
|
912
|
+
| `theme.borderRadiusSM` | number | `4` | Border radius for the small picker. |
|
|
913
|
+
| `theme.cellActiveWithRangeBg` | string | `"#e6f4ff"` | Background color of cells within the selected range. |
|
|
914
|
+
| `theme.cellBgDisabled` | string | `"rgba(0,0,0,0.04)"` | Background color of disabled cells. |
|
|
813
915
|
| `theme.cellHeight` | number | `24` | Height of a calendar cell. |
|
|
916
|
+
| `theme.cellHoverBg` | string | `"rgba(0, 0, 0, 0.04)"` | Background color of a calendar cell on hover. |
|
|
917
|
+
| `theme.cellHoverWithRangeBg` | string | `"#cbe0fd"` | Background color of cells within range on hover. |
|
|
918
|
+
| `theme.cellRangeBorderColor` | string | `"#82b4f9"` | Border color of range selection cells. |
|
|
814
919
|
| `theme.cellWidth` | number | `36` | Width of a calendar cell. |
|
|
815
|
-
| `theme.
|
|
816
|
-
| `theme.
|
|
817
|
-
| `theme.
|
|
818
|
-
| `theme.
|
|
819
|
-
| `theme.
|
|
820
|
-
| `theme.
|
|
821
|
-
| `theme.
|
|
920
|
+
| `theme.colorBgContainer` | string | - | Background color of the picker input. |
|
|
921
|
+
| `theme.colorBorder` | string | - | Border color of the picker input. |
|
|
922
|
+
| `theme.colorPrimary` | string | - | Primary color used for the selected date and active states. |
|
|
923
|
+
| `theme.colorText` | string | - | Text color of the picker input and calendar cells. |
|
|
924
|
+
| `theme.colorTextPlaceholder` | string | - | Color of the placeholder text. |
|
|
925
|
+
| `theme.controlHeight` | number | `32` | Height of the picker input. |
|
|
926
|
+
| `theme.controlHeightLG` | number | `40` | Height of the large picker input. |
|
|
927
|
+
| `theme.controlHeightSM` | number | `24` | Height of the small picker input. |
|
|
928
|
+
| `theme.errorActiveShadow` | string | `"0 0 0 2px rgba(255,38,5,0.06)"` | Shadow effect when the picker has error status and is focused. |
|
|
929
|
+
| `theme.fontSize` | number | `14` | Font size of the picker input. |
|
|
930
|
+
| `theme.fontSizeLG` | number | `16` | Font size for the large picker. |
|
|
931
|
+
| `theme.fontSizeSM` | number | `14` | Font size for the small picker. |
|
|
932
|
+
| `theme.hoverBg` | string | `"#ffffff"` | Background color of the input when hovering over the picker. |
|
|
933
|
+
| `theme.hoverBorderColor` | string | - | Border color when hovering over the picker. |
|
|
934
|
+
| `theme.lineWidth` | number | `1` | Border width of the picker input. |
|
|
935
|
+
| `theme.paddingBlock` | number | `4` | Vertical padding for the default size picker. |
|
|
936
|
+
| `theme.paddingBlockLG` | number | `7` | Vertical padding for the large size picker. |
|
|
937
|
+
| `theme.paddingBlockSM` | number | `0` | Vertical padding for the small size picker. |
|
|
938
|
+
| `theme.paddingInline` | number | `11` | Horizontal padding for the default size picker. |
|
|
939
|
+
| `theme.paddingInlineLG` | number | `11` | Horizontal padding for the large size picker. |
|
|
940
|
+
| `theme.paddingInlineSM` | number | `7` | Horizontal padding for the small size picker. |
|
|
941
|
+
| `theme.presetsMaxWidth` | number | `200` | Maximum width of the presets list next to the calendar. |
|
|
942
|
+
| `theme.presetsWidth` | number | `120` | Width of the presets list next to the calendar. |
|
|
822
943
|
| `theme.timeCellHeight` | number | `28` | Height of a time cell in the time panel. |
|
|
823
|
-
| `theme.
|
|
824
|
-
| `theme.
|
|
825
|
-
| `theme.
|
|
826
|
-
| `theme.
|
|
827
|
-
| `theme.
|
|
828
|
-
| `theme.paddingBlockSM` | number | `0` | Vertical padding for small size. |
|
|
829
|
-
| `theme.paddingBlockLG` | number | `7` | Vertical padding for large size. |
|
|
830
|
-
| `theme.paddingInline` | number | `11` | Horizontal padding of the input. |
|
|
831
|
-
| `theme.paddingInlineSM` | number | `7` | Horizontal padding for small size. |
|
|
832
|
-
| `theme.paddingInlineLG` | number | `11` | Horizontal padding for large size. |
|
|
833
|
-
| `theme.zIndexPopup` | number | `1050` | Z-index of the picker popup. |
|
|
834
|
-
| `theme.borderRadius` | number | `6` | Border radius of the input. |
|
|
835
|
-
| `theme.controlHeight` | number | `32` | Height of the input. |
|
|
836
|
-
| `theme.controlHeightLG` | number | `40` | Height for large size. |
|
|
837
|
-
| `theme.controlHeightSM` | number | `24` | Height for small size. |
|
|
838
|
-
| `theme.fontSize` | number | `14` | Font size. |
|
|
839
|
-
| `theme.lineWidth` | number | `1` | Border width. |
|
|
840
|
-
| `theme.colorPrimary` | string | - | Primary color override. |
|
|
841
|
-
| `theme.colorBgContainer` | string | - | Background color of the input. |
|
|
842
|
-
| `theme.colorText` | string | - | Text color. |
|
|
843
|
-
| `theme.colorBorder` | string | - | Border color. |
|
|
844
|
-
| `theme.colorTextPlaceholder` | string | - | Placeholder text color. |
|
|
944
|
+
| `theme.timeColumnHeight` | number | `224` | Height of the time panel column. |
|
|
945
|
+
| `theme.timeColumnWidth` | number | `56` | Width of the time panel column. |
|
|
946
|
+
| `theme.warningActiveShadow` | string | `"0 0 0 2px rgba(255,215,5,0.1)"` | Shadow effect when the picker has warning status and is focused. |
|
|
947
|
+
| `theme.withoutTimeCellHeight` | number | `66` | Height of the cells of the month, week, quarter, year and decade panels. |
|
|
948
|
+
| `theme.zIndexPopup` | number | `1050` | Z-index of the picker popup layer. |
|
|
845
949
|
|
|
846
950
|
| Event | Event Data | Description |
|
|
847
951
|
| --- | --- | --- |
|
|
952
|
+
| `onBlur` | \- | Trigger actions when the picker loses focus. |
|
|
953
|
+
| `onClear` | \- | Trigger actions when the clear button is clicked. |
|
|
954
|
+
| `onFocus` | \- | Trigger actions when the picker gets focus. |
|
|
955
|
+
| `onOpenChange` | `{ open }` | Trigger actions when the calendar popup opens or closes. |
|
|
848
956
|
| `onChange` | `{ value }` | Trigger actions when selection is changed. |
|
|
849
957
|
| `onTooltipClick` | \- | Trigger actions when the tooltip icon is clicked. |
|
|
850
958
|
|
|
@@ -856,6 +964,7 @@ Combined date and time picker.
|
|
|
856
964
|
| `/extra` | The DateTimeSelector extra content. |
|
|
857
965
|
| `/feedback` | The DateTimeSelector validation feedback. |
|
|
858
966
|
| `/popup` | The DateTimeSelector popup. |
|
|
967
|
+
| `/prefixIcon` | The prefix icon in the DateTimeSelector. |
|
|
859
968
|
| `/suffixIcon` | The suffix icon in the DateTimeSelector. |
|
|
860
969
|
|
|
861
970
|
No slots defined.
|
|
@@ -14,7 +14,7 @@ A visual reference of every input block available in Lowdefy. Each section shows
|
|
|
14
14
|
properties:
|
|
15
15
|
label:
|
|
16
16
|
title: With prefix icon
|
|
17
|
-
prefixIcon:
|
|
17
|
+
prefixIcon: user
|
|
18
18
|
placeholder: Username
|
|
19
19
|
- id: ig_text_count
|
|
20
20
|
type: TextInput
|
|
@@ -270,8 +270,8 @@ A visual reference of every input block available in Lowdefy. Each section shows
|
|
|
270
270
|
properties:
|
|
271
271
|
label:
|
|
272
272
|
title: Switch (with icons)
|
|
273
|
-
checkedIcon:
|
|
274
|
-
uncheckedIcon:
|
|
273
|
+
checkedIcon: check
|
|
274
|
+
uncheckedIcon: close
|
|
275
275
|
- id: ig_checkbox_sw
|
|
276
276
|
type: CheckboxSwitch
|
|
277
277
|
properties:
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
# IntentInput
|
|
2
|
+
|
|
3
|
+
A text input that becomes what the user means. The user types in their own words, a classifier (typically a `Decide` request) picks the intent, and the box grows to show that intent's slot: a faded preview while unsure, a choice between two intents when they are close, and the slot solid when sure. Each intent's slot holds ordinary blocks.
|
|
4
|
+
|
|
5
|
+
## How it works
|
|
6
|
+
|
|
7
|
+
`IntentInput` only shows. Your app classifies:
|
|
8
|
+
|
|
9
|
+
1. The user types. Shortly after the text changes, the block fires `onClassify` with the text.
|
|
10
|
+
2. `onClassify` runs a classifier, typically a [`Decide`](/AIGenerateRequests) request with one `choice` question, and its answer comes back through the `answer` property. The block reads `answer` when the `onClassify` actions finish, so set it in those actions (a `Request` does).
|
|
11
|
+
3. The block shows the slot named after the intent in the answer.
|
|
12
|
+
|
|
13
|
+
Scores move while the user is mid-word, so the shown intent only changes when another intent leads two answers in a row, keeps the lead while the user pauses, or is near certain. Until a new answer arrives the block keeps the last one, so the slot does not drop out between keystrokes.
|
|
14
|
+
|
|
15
|
+
## Define intents once
|
|
16
|
+
|
|
17
|
+
The same object can be the block's `intents` and the options of the `Decide` question: the block reads `label`, `icon` and `color`, and `Decide` reads `description`.
|
|
18
|
+
|
|
19
|
+
```yaml
|
|
20
|
+
# intents.yaml
|
|
21
|
+
task:
|
|
22
|
+
label: Task
|
|
23
|
+
icon: CircleCheck
|
|
24
|
+
color: '#6366f1'
|
|
25
|
+
description: Work for the team to do, like a bug to fix or a feature to build
|
|
26
|
+
ticket:
|
|
27
|
+
label: Ticket
|
|
28
|
+
icon: LifeBuoy
|
|
29
|
+
color: '#f43f5e'
|
|
30
|
+
description: A problem or request reported by a customer
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
```yaml
|
|
34
|
+
requests:
|
|
35
|
+
- id: classify
|
|
36
|
+
type: Decide
|
|
37
|
+
connectionId: gateway
|
|
38
|
+
payload:
|
|
39
|
+
text:
|
|
40
|
+
_state: capture.text
|
|
41
|
+
properties:
|
|
42
|
+
model: typesafe-ai/jev
|
|
43
|
+
maxRetries: 0 # by the time a retry answers, the text has moved on
|
|
44
|
+
timeout: 2500
|
|
45
|
+
state:
|
|
46
|
+
_payload: text
|
|
47
|
+
questions:
|
|
48
|
+
intent:
|
|
49
|
+
choice: What the person wants to do with this text
|
|
50
|
+
options:
|
|
51
|
+
_build.object.assign:
|
|
52
|
+
- _ref: intents.yaml
|
|
53
|
+
# An escape option for text that is unfinished. Options that are not
|
|
54
|
+
# intents are ignored by the block.
|
|
55
|
+
- none: Too short, unclear or unfinished to tell yet
|
|
56
|
+
|
|
57
|
+
blocks:
|
|
58
|
+
- id: capture
|
|
59
|
+
type: IntentInput
|
|
60
|
+
properties:
|
|
61
|
+
placeholder: Add a task, log a ticket…
|
|
62
|
+
intents:
|
|
63
|
+
_ref: intents.yaml
|
|
64
|
+
answer:
|
|
65
|
+
_request: classify.intent
|
|
66
|
+
events:
|
|
67
|
+
onClassify:
|
|
68
|
+
- id: classify
|
|
69
|
+
type: Request
|
|
70
|
+
params: classify
|
|
71
|
+
slots:
|
|
72
|
+
task:
|
|
73
|
+
blocks: [] # what a task shows
|
|
74
|
+
ticket:
|
|
75
|
+
blocks: [] # what a ticket shows
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
An evaluation model such as TypeSafe's Jev (`typesafe-ai/jev` on the [AI Gateway](/AIGateway)) answers in well under a second with a probability for every option, which suits classifying as the user types. Any language model works with `backend: structured-output`. A classifier of your own works too: `answer` takes any `{ choice, confidence, probabilities }` object, such as a keyword match in [`_js`](/_js) for offline use.
|
|
79
|
+
|
|
80
|
+
## Slots
|
|
81
|
+
|
|
82
|
+
Each intent's slot holds ordinary blocks, so it can hold a form, a summary and the button that saves it. Let the model pick the intent and let code read the fields: parse the text in `onClassify` with [`_js`](/_js), or run a [`GenerateObject`](/AIGenerateRequests) request for the fields of the intent that was chosen.
|
|
83
|
+
|
|
84
|
+
A slot is shown while the user is still unsure too (faded, and not clickable), so give fields a fallback such as `_if_none` for text that is not complete yet.
|
|
85
|
+
|
|
86
|
+
The blocks of every slot exist while only one is shown, so a `Validate` with no params also checks the required fields of the slots that are hidden. Pass the shown slot's block ids, such as `params: [task_title, task_due]`.
|
|
87
|
+
|
|
88
|
+
## The value
|
|
89
|
+
|
|
90
|
+
The value is `{ text, intent, mode }`:
|
|
91
|
+
|
|
92
|
+
- `text`: what the user typed. Set `capture.text` with `SetState` to fill the box; it classifies like typed text.
|
|
93
|
+
- `intent`: the intent shown, or `null`.
|
|
94
|
+
- `mode`: `idle` (nothing recognised), `preview` (the slot, faded), `choose` (the user is offered the two leading intents) or `committed` (the slot, solid). A choice the user picks is `committed` until the answers settle on a different intent.
|
|
95
|
+
|
|
96
|
+
Use `_state: capture.intent` in other blocks and requests, and `SetState` `capture: null` after saving to clear the box.
|
|
97
|
+
|
|
98
|
+
## Confidence
|
|
99
|
+
|
|
100
|
+
`confidence` sets how sure the answer must be before the slot changes how it looks. The defaults suit most classifiers:
|
|
101
|
+
|
|
102
|
+
```yaml
|
|
103
|
+
confidence:
|
|
104
|
+
preview: 0.3 # show a faded preview from here
|
|
105
|
+
show: 0.6 # commit and show the slot solid from here
|
|
106
|
+
switch: 0.85 # replace the shown intent at once from here
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
The block uses the provider's calibrated `confidence` for the chosen intent where the answer has one, and scales the `probabilities` of the other intents to keep their ratio to it, so the chosen intent always leads.
|
|
110
|
+
|
|
111
|
+
```yaml
|
|
112
|
+
- id: capture_demo
|
|
113
|
+
type: IntentInput
|
|
114
|
+
properties:
|
|
115
|
+
placeholder: Try "fix the login bug" or "sync with Sam friday 2pm"
|
|
116
|
+
intents:
|
|
117
|
+
task:
|
|
118
|
+
label: Task
|
|
119
|
+
icon: CircleCheck
|
|
120
|
+
color: "#6366f1"
|
|
121
|
+
meeting:
|
|
122
|
+
label: Meeting
|
|
123
|
+
icon: Calendar
|
|
124
|
+
color: "#0ea5e9"
|
|
125
|
+
answer:
|
|
126
|
+
_state: capture_demo_answer
|
|
127
|
+
events:
|
|
128
|
+
onClassify:
|
|
129
|
+
- id: classify
|
|
130
|
+
type: SetState
|
|
131
|
+
params:
|
|
132
|
+
capture_demo_answer:
|
|
133
|
+
_js:
|
|
134
|
+
fn: >
|
|
135
|
+
const text = args.text.toLowerCase();
|
|
136
|
+
|
|
137
|
+
const probabilities = { task: 0.05, meeting: 0.05 };
|
|
138
|
+
|
|
139
|
+
if (/^(fix|add|build|update|remove)\b/.test(text))
|
|
140
|
+
probabilities.task = 0.9;
|
|
141
|
+
|
|
142
|
+
if (/\b(sync|meeting|call|standup)\b/.test(text)) {
|
|
143
|
+
probabilities.meeting = /\d|today|tomorrow|day\b/.test(text) ? 0.9 : 0.4;
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
return { probabilities };
|
|
147
|
+
args:
|
|
148
|
+
text:
|
|
149
|
+
_event: text
|
|
150
|
+
slots:
|
|
151
|
+
task:
|
|
152
|
+
blocks:
|
|
153
|
+
- id: capture_demo_task
|
|
154
|
+
type: Paragraph
|
|
155
|
+
properties:
|
|
156
|
+
content:
|
|
157
|
+
_string.concat:
|
|
158
|
+
- "New task: "
|
|
159
|
+
- _state: capture_demo.text
|
|
160
|
+
- id: capture_demo_create
|
|
161
|
+
type: Button
|
|
162
|
+
properties:
|
|
163
|
+
title: Create task
|
|
164
|
+
type: primary
|
|
165
|
+
meeting:
|
|
166
|
+
blocks:
|
|
167
|
+
- id: capture_demo_meeting
|
|
168
|
+
type: Paragraph
|
|
169
|
+
properties:
|
|
170
|
+
content:
|
|
171
|
+
_string.concat:
|
|
172
|
+
- "New meeting: "
|
|
173
|
+
- _state: capture_demo.text
|
|
174
|
+
- id: capture_demo_invite
|
|
175
|
+
type: Button
|
|
176
|
+
properties:
|
|
177
|
+
title: Send invite
|
|
178
|
+
type: primary
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
| Property | Type | Default | Description |
|
|
182
|
+
| --- | --- | --- | --- |
|
|
183
|
+
| `autoFocus` | boolean | - | Focus the input on mount. |
|
|
184
|
+
| `placeholder` | string | - | Placeholder text. |
|
|
185
|
+
| `intents` | object | - | The intents the text can become, by name. Each name is also the slot shown for it. The same object can be the options of the Decide question that classifies the text. |
|
|
186
|
+
| `answer` | object \| null | - | The classification of the current text, in the shape of a Decide choice answer: `_request: classify.intent`. Options that are not intents, such as a `none` option, are ignored. While a new answer loads, the last one is kept. |
|
|
187
|
+
| `answer.choice` | string \| null | - | |
|
|
188
|
+
| `answer.confidence` | number \| null | - | |
|
|
189
|
+
| `answer.probabilities` | object \| null | - | |
|
|
190
|
+
| `confidence` | object | - | How sure the answer must be before the slot changes how it looks. |
|
|
191
|
+
| `confidence.preview` | number | `0.3` | Show a faded preview of the slot from this confidence. |
|
|
192
|
+
| `confidence.show` | number | `0.6` | Commit to the intent and show its slot solid from this confidence. |
|
|
193
|
+
| `confidence.switch` | number | `0.85` | Replace the shown intent at once from this confidence. Below it, another intent must lead twice in a row, or hold the lead while the user pauses. |
|
|
194
|
+
|
|
195
|
+
| Event | Event Data | Description |
|
|
196
|
+
| --- | --- | --- |
|
|
197
|
+
| `onChange` | `{ text }` | Trigger actions when the user types. |
|
|
198
|
+
| `onClassify` | `{ text }` | Trigger actions shortly after the text changes, to classify it. Typically runs a Decide request whose answer is passed back as `answer`. |
|
|
199
|
+
| `onIntentChange` | `{ intent, mode }` | Trigger actions when the shown intent or its mode changes. |
|
|
200
|
+
| `onSubmit` | `{ text, intent, mode }` | Trigger actions when Enter is pressed. |
|
|
201
|
+
|
|
202
|
+
| Key | Target |
|
|
203
|
+
| --- | --- |
|
|
204
|
+
| `/block` | Outer block wrapper (always available). |
|
|
205
|
+
| `/element` | The IntentInput element. |
|
|
206
|
+
|
|
207
|
+
Slot keys are user-defined in your config and resolved at build time — not generated at runtime. The block typically pairs slots with an array property (`tabs`, `panels`, `slides`) listed in the Properties table; see the examples above for the expected shape.
|