@lowdefy/docs-content 0.0.0-experimental-20260928120643 → 6.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -1
- package/content/actions/link.md +0 -17
- package/content/actions/login.md +5 -23
- package/content/actions/logout.md +5 -5
- package/content/actions/pdfmake.md +2 -2
- package/content/actions/setdarkmode.md +2 -2
- package/content/agents/agent-properties.md +2 -4
- package/content/agents/agentchat.md +6 -21
- package/content/agents/agentconversations.md +2 -2
- package/content/concepts/ai-agent-docs.md +101 -313
- package/content/concepts/cli.md +3 -34
- package/content/concepts/connections-and-requests.md +0 -402
- package/content/concepts/custom-html.md +0 -40
- package/content/concepts/custom-styling.md +5 -50
- package/content/concepts/events-and-actions.md +2 -64
- package/content/concepts/i18n.md +2 -7
- package/content/concepts/keyboard-shortcuts.md +2 -2
- package/content/concepts/layout-overview.md +1 -1
- package/content/concepts/logger.md +0 -81
- package/content/concepts/lowdefy-schema.md +1 -4
- package/content/concepts/menus.md +7 -7
- package/content/concepts/module-authoring.md +2 -2
- package/content/connections/anthropic.md +2 -162
- package/content/connections/awss3.md +0 -54
- package/content/connections/google.md +2 -162
- package/content/connections/mongodb.md +3 -121
- package/content/connections/openai-connection.md +2 -162
- package/content/container-blocks/affix.md +7 -47
- package/content/container-blocks/alert.md +24 -76
- package/content/container-blocks/badge.md +24 -100
- package/content/container-blocks/box.md +9 -9
- package/content/container-blocks/card.md +25 -80
- package/content/container-blocks/carousel.md +7 -60
- package/content/container-blocks/collapse.md +9 -87
- package/content/container-blocks/configprovider.md +13 -35
- package/content/container-blocks/confirmmodal.md +23 -69
- package/content/container-blocks/content.md +98 -62
- package/content/container-blocks/descriptions.md +4 -45
- package/content/container-blocks/drawer.md +28 -92
- package/content/container-blocks/dropdownmenu.md +31 -119
- package/content/container-blocks/flex.md +62 -40
- package/content/container-blocks/footer.md +11 -15
- package/content/container-blocks/googlemapsheatmap.md +1 -1
- package/content/container-blocks/googlemapsscript.md +2 -2
- package/content/container-blocks/header.md +36 -71
- package/content/container-blocks/label.md +7 -34
- package/content/container-blocks/layout.md +34 -52
- package/content/container-blocks/masonry.md +71 -17
- package/content/container-blocks/mobilemenu.md +88 -131
- package/content/container-blocks/modal.md +26 -114
- package/content/container-blocks/pageheadermenu.md +31 -81
- package/content/container-blocks/pagesidebarlayout.md +26 -169
- package/content/container-blocks/pagesidermenu.md +42 -95
- package/content/container-blocks/popover.md +31 -34
- package/content/container-blocks/result.md +21 -32
- package/content/container-blocks/sider.md +122 -85
- package/content/container-blocks/span.md +7 -7
- package/content/container-blocks/spinner.md +3 -3
- package/content/container-blocks/splitter.md +68 -150
- package/content/container-blocks/tabs.md +12 -64
- package/content/container-blocks/tooltip.md +46 -22
- package/content/container-blocks/watermark.md +4 -22
- package/content/controls/reject.md +2 -4
- package/content/controls/throw.md +0 -1
- package/content/controls/try.md +2 -3
- package/content/deployment/deployment-environments.md +6 -8
- package/content/deployment/docker.md +7 -22
- package/content/deployment/node-server.md +0 -4
- package/content/deployment/vercel.md +6 -13
- package/content/display-blocks/aggrid.md +11 -26
- package/content/display-blocks/anchor.md +15 -15
- package/content/display-blocks/avatar.md +37 -57
- package/content/display-blocks/breadcrumb.md +21 -70
- package/content/display-blocks/button.md +18 -92
- package/content/display-blocks/calendar.md +0 -12
- package/content/display-blocks/dangeroushtml.md +1 -1
- package/content/display-blocks/difflist.md +1 -1
- package/content/display-blocks/difftimeline.md +1 -1
- package/content/display-blocks/divider.md +3 -64
- package/content/display-blocks/dropdownbutton.md +28 -79
- package/content/display-blocks/echart.md +1 -35
- package/content/display-blocks/floatbutton.md +42 -129
- package/content/display-blocks/html.md +1 -61
- package/content/display-blocks/icon.md +67 -250
- package/content/display-blocks/menu.md +73 -145
- package/content/display-blocks/message.md +124 -38
- package/content/display-blocks/notification.md +222 -94
- package/content/display-blocks/paragraph.md +9 -59
- package/content/display-blocks/progress.md +17 -96
- package/content/display-blocks/qrcode.md +4 -19
- package/content/display-blocks/s3download.md +1 -1
- package/content/display-blocks/search.md +7 -17
- package/content/display-blocks/skeletonbutton.md +0 -1
- package/content/display-blocks/skeletoninput.md +0 -1
- package/content/display-blocks/statistic.md +17 -75
- package/content/display-blocks/steps.md +25 -58
- package/content/display-blocks/tag.md +17 -102
- package/content/display-blocks/title.md +11 -50
- package/content/display-blocks/tour.md +23 -33
- package/content/input-blocks/autocomplete.md +9 -81
- package/content/input-blocks/buttonselector.md +8 -45
- package/content/input-blocks/checkboxselector.md +7 -97
- package/content/input-blocks/checkboxswitch.md +3 -33
- package/content/input-blocks/colorselector.md +14 -63
- package/content/input-blocks/daterangeselector.md +45 -165
- package/content/input-blocks/dateselector.md +41 -139
- package/content/input-blocks/datetimeselector.md +49 -158
- package/content/input-blocks/inputgallery.md +3 -3
- package/content/input-blocks/monthselector.md +52 -120
- package/content/input-blocks/multipleselector.md +39 -150
- package/content/input-blocks/numberinput.md +12 -98
- package/content/input-blocks/pagination.md +14 -70
- package/content/input-blocks/paragraphinput.md +37 -51
- package/content/input-blocks/passwordinput.md +6 -60
- package/content/input-blocks/phonenumberinput.md +26 -59
- package/content/input-blocks/radioselector.md +7 -83
- package/content/input-blocks/ratingslider.md +26 -57
- package/content/input-blocks/s3uploadbutton.md +24 -24
- package/content/input-blocks/s3uploaddragger.md +3 -3
- package/content/input-blocks/s3uploadphoto.md +5 -5
- package/content/input-blocks/segmentedselector.md +32 -72
- package/content/input-blocks/selector.md +21 -109
- package/content/input-blocks/switch.md +17 -65
- package/content/input-blocks/textarea.md +3 -32
- package/content/input-blocks/textinput.md +28 -69
- package/content/input-blocks/tiptapmentioninput.md +1 -1
- package/content/input-blocks/titleinput.md +12 -39
- package/content/input-blocks/treeinput.md +25 -49
- package/content/input-blocks/treemultipleselector.md +10 -127
- package/content/input-blocks/treeselector.md +9 -97
- package/content/input-blocks/upload.md +15 -64
- package/content/input-blocks/uploaddragger.md +1 -17
- package/content/input-blocks/uploadphoto.md +1 -18
- package/content/input-blocks/weekselector.md +55 -120
- package/content/list-blocks/controlledlist.md +15 -24
- package/content/list-blocks/list.md +11 -11
- package/content/list-blocks/masonrylist.md +34 -7
- package/content/migration/upgrade-guide.md +0 -1
- package/content/operators/_app.md +1 -2
- package/content/operators/_error.md +1 -23
- package/content/operators/_get.md +6 -6
- package/content/operators/_operator.md +3 -17
- package/content/operators/_ref.md +0 -258
- package/content/operators/_type.md +3 -14
- package/content/operators/_user.md +3 -3
- package/content/other/introduction.md +1 -1
- package/content/plugins/plugins-dev.md +0 -66
- package/content/plugins/plugins-introduction.md +1 -27
- package/content/testing/e2e-configuration.md +1 -8
- package/content/testing/e2e-getting-started.md +1 -1
- package/content/testing/e2e-introduction.md +1 -1
- package/content/tutorial/tutorial-actions-operators.md +2 -2
- package/content/tutorial/tutorial-add-blocks.md +2 -2
- package/content/tutorial/tutorial-create-page.md +2 -48
- package/content/tutorial/tutorial-display-data-page.md +3 -3
- package/content/tutorial/tutorial-requests-sql.md +0 -153
- package/content/tutorial/tutorial-start.md +1 -66
- package/content/user-authentication/login-and-logout.md +8 -158
- package/content/user-authentication/users-introduction.md +0 -8
- package/index.json +2 -6065
- package/package.json +1 -7
- package/scripts/extractAgentDocs.js +4 -36
- package/content/actions/emailotpsend.md +0 -58
- package/content/actions/emailotpverify.md +0 -77
- package/content/actions/getlocalstorage.md +0 -41
- package/content/actions/magiclinkverify.md +0 -113
- package/content/actions/posthogalias.md +0 -29
- package/content/actions/posthogcapture.md +0 -49
- package/content/actions/posthogcapturepageleave.md +0 -38
- package/content/actions/posthogfeatureflag.md +0 -50
- package/content/actions/posthoggroup.md +0 -37
- package/content/actions/posthogidentify.md +0 -54
- package/content/actions/posthoginit.md +0 -66
- package/content/actions/posthogoptin.md +0 -29
- package/content/actions/posthogoptout.md +0 -29
- package/content/actions/posthogpageview.md +0 -37
- package/content/actions/posthogreloadfeatureflags.md +0 -47
- package/content/actions/posthogreset.md +0 -28
- package/content/actions/posthogsetpersonproperties.md +0 -36
- package/content/actions/removelocalstorage.md +0 -26
- package/content/actions/setlocalstorage.md +0 -32
- package/content/adapter-reference/mongodbauthadapter.md +0 -46
- package/content/agents/agents-introduction.md +0 -107
- package/content/callback-reference/auth0logoutcallback.md +0 -54
- package/content/concepts/blocks.md +0 -150
- package/content/concepts/dynamic-page-content.md +0 -304
- package/content/concepts/html-attributes.md +0 -285
- package/content/concepts/lowdefy-api.md +0 -1110
- package/content/concepts/notifications.md +0 -155
- package/content/concepts/page-and-app-state.md +0 -244
- package/content/concepts/theming.md +0 -582
- package/content/connections/aigateway.md +0 -368
- package/content/connections/axioshttp.md +0 -181
- package/content/controls/while.md +0 -46
- package/content/display-blocks/clickablehtml.md +0 -239
- package/content/display-blocks/eventlog.md +0 -363
- package/content/display-blocks/pollingtimer.md +0 -263
- package/content/input-blocks/captcha.md +0 -40
- package/content/input-blocks/placesautocomplete.md +0 -319
- package/content/input-blocks/tagmultipleselector.md +0 -114
- package/content/input-blocks/tagselector.md +0 -114
- package/content/migration/auth-upgrade.md +0 -327
- package/content/migration/v3-to-v4.md +0 -417
- package/content/migration/v6-to-v7.md +0 -222
- package/content/operators/_cron.md +0 -292
- package/content/other/mongodbadapter.md +0 -3
- package/content/plugins/plugins-icon-sets.md +0 -267
- package/content/plugins/posthog.md +0 -275
- package/content/provider-reference/auth-js-providers.md +0 -107
- package/content/provider-reference/openidconnectprovider.md +0 -44
- package/content/testing/config-tests.md +0 -278
- package/content/tutorial/tutorial-requests-api.md +0 -155
- package/content/user-authentication/auth-configuration.md +0 -266
- package/content/user-authentication/auth-steps.md +0 -138
- package/content/user-authentication/mcp-oauth.md +0 -292
- package/content/user-authentication/organizations.md +0 -221
- package/content/user-authentication/protected-pages-apis.md +0 -97
- package/content/user-authentication/roles.md +0 -49
- package/content/user-authentication/two-factor.md +0 -229
- package/content/user-authentication/user-object.md +0 -58
- package/content/websockets/websocket-publish.md +0 -108
- package/content/websockets/websocket-subscriptions.md +0 -100
- package/content/websockets/websockets-introduction.md +0 -97
- package/hazards.json +0 -44
- package/scripts/hashDocSources.js +0 -38
- package/scripts/recordSourceHashes.js +0 -88
|
@@ -154,8 +154,6 @@ Deleted Title
|
|
|
154
154
|
|
|
155
155
|
Italic & Underlined
|
|
156
156
|
|
|
157
|
-
Esc
|
|
158
|
-
|
|
159
157
|
```yaml
|
|
160
158
|
- id: deco_italic
|
|
161
159
|
type: Title
|
|
@@ -188,12 +186,6 @@ Esc
|
|
|
188
186
|
level: 4
|
|
189
187
|
italic: true
|
|
190
188
|
underline: true
|
|
191
|
-
- id: deco_keyboard
|
|
192
|
-
type: Title
|
|
193
|
-
properties:
|
|
194
|
-
content: Esc
|
|
195
|
-
level: 4
|
|
196
|
-
keyboard: true
|
|
197
189
|
```
|
|
198
190
|
|
|
199
191
|
Disabled Section Heading
|
|
@@ -287,7 +279,7 @@ Two-state copy icons
|
|
|
287
279
|
content: Custom copy icon
|
|
288
280
|
level: 4
|
|
289
281
|
copyable:
|
|
290
|
-
icon:
|
|
282
|
+
icon: AiOutlineSnippets
|
|
291
283
|
- id: copyable_two_icons
|
|
292
284
|
type: Title
|
|
293
285
|
properties:
|
|
@@ -295,8 +287,8 @@ Two-state copy icons
|
|
|
295
287
|
level: 4
|
|
296
288
|
copyable:
|
|
297
289
|
icon:
|
|
298
|
-
-
|
|
299
|
-
-
|
|
290
|
+
- AiOutlineCopy
|
|
291
|
+
- AiOutlineCheck
|
|
300
292
|
tooltips:
|
|
301
293
|
- Copy text
|
|
302
294
|
- Done!
|
|
@@ -310,10 +302,6 @@ This long title can be expanded by clicking the expand control. It demonstrates
|
|
|
310
302
|
|
|
311
303
|
This title has a custom suffix appended after the ellipsis truncation point so readers know more content exists.
|
|
312
304
|
|
|
313
|
-
This long title can be expanded and collapsed again. The expand and collapse buttons use custom text set with the symbol option.
|
|
314
|
-
|
|
315
|
-
Hover this truncated title to see the full heading in a tooltip, which helps when titles come from user data.
|
|
316
|
-
|
|
317
305
|
```yaml
|
|
318
306
|
- id: ellipsis_single
|
|
319
307
|
type: Title
|
|
@@ -351,26 +339,6 @@ Hover this truncated title to see the full heading in a tooltip, which helps whe
|
|
|
351
339
|
ellipsis:
|
|
352
340
|
rows: 1
|
|
353
341
|
suffix: " /Read More"
|
|
354
|
-
- id: ellipsis_collapsible
|
|
355
|
-
type: Title
|
|
356
|
-
properties:
|
|
357
|
-
content: This long title can be expanded and collapsed again. The expand and
|
|
358
|
-
collapse buttons use custom text set with the symbol option.
|
|
359
|
-
level: 5
|
|
360
|
-
ellipsis:
|
|
361
|
-
rows: 1
|
|
362
|
-
expandable: collapsible
|
|
363
|
-
symbol:
|
|
364
|
-
- more
|
|
365
|
-
- less
|
|
366
|
-
- id: ellipsis_tooltip
|
|
367
|
-
type: Title
|
|
368
|
-
properties:
|
|
369
|
-
content: Hover this truncated title to see the full heading in a tooltip, which
|
|
370
|
-
helps when titles come from user data.
|
|
371
|
-
level: 4
|
|
372
|
-
ellipsis:
|
|
373
|
-
tooltip: true
|
|
374
342
|
```
|
|
375
343
|
|
|
376
344
|
Tailwind Background
|
|
@@ -409,7 +377,7 @@ Inline Text Shadow
|
|
|
409
377
|
level: 4
|
|
410
378
|
style:
|
|
411
379
|
.element:
|
|
412
|
-
borderBottom:
|
|
380
|
+
borderBottom: 2px solid
|
|
413
381
|
paddingBottom: 8px
|
|
414
382
|
- id: css_inline_shadow
|
|
415
383
|
type: Title
|
|
@@ -503,7 +471,7 @@ Learn how Lowdefy simplifies complex application development by replacing boiler
|
|
|
503
471
|
flex: 0 0 auto
|
|
504
472
|
properties:
|
|
505
473
|
title: By Jane Smith
|
|
506
|
-
icon:
|
|
474
|
+
icon: AiOutlineUser
|
|
507
475
|
color: default
|
|
508
476
|
variant: text
|
|
509
477
|
size: small
|
|
@@ -513,7 +481,7 @@ Learn how Lowdefy simplifies complex application development by replacing boiler
|
|
|
513
481
|
flex: 0 0 auto
|
|
514
482
|
properties:
|
|
515
483
|
title: March 12, 2026
|
|
516
|
-
icon:
|
|
484
|
+
icon: AiOutlineCalendar
|
|
517
485
|
color: default
|
|
518
486
|
variant: text
|
|
519
487
|
size: small
|
|
@@ -631,8 +599,6 @@ Recent Activity
|
|
|
631
599
|
|
|
632
600
|
| Property | Type | Default | Description |
|
|
633
601
|
| --- | --- | --- | --- |
|
|
634
|
-
| `actions` | object | - | Configure the bar of action buttons, such as copy and expand. |
|
|
635
|
-
| `actions.placement` | string | `"end"` | Place the action buttons before or after the text. Enum: `start`, `end`. |
|
|
636
602
|
| `code` | boolean | `false` | Apply code style. |
|
|
637
603
|
| `color` | string | - | Title color. |
|
|
638
604
|
| `content` | string | - | Title text content - supports html. |
|
|
@@ -644,20 +610,16 @@ Recent Activity
|
|
|
644
610
|
| `disabled` | boolean | `false` | Apply disabled style. |
|
|
645
611
|
| `ellipsis` | boolean \| object | `false` | Display ellipsis when text overflows a single line. |
|
|
646
612
|
| `ellipsis.rows` | number | - | Max rows of content. |
|
|
647
|
-
| `ellipsis.expandable` | boolean
|
|
648
|
-
| `ellipsis.defaultExpanded` | boolean | `false` | Start with the content expanded. |
|
|
613
|
+
| `ellipsis.expandable` | boolean | - | Expand hidden content when clicked. |
|
|
649
614
|
| `ellipsis.suffix` | string | - | Suffix of ellipses content. |
|
|
650
|
-
| `ellipsis.symbol` | string \| array | - | Text of the expand button, or an array of two strings for the expand and collapse buttons. |
|
|
651
|
-
| `ellipsis.tooltip` | boolean \| string | - | Show a tooltip when the text is truncated. true shows the full text, a string shows that text. |
|
|
652
615
|
| `italic` | boolean | `false` | Apply italic style. |
|
|
653
|
-
| `keyboard` | boolean | `false` | Apply keyboard key style. |
|
|
654
616
|
| `level` | number | `1` | Set title type. Matches with h1, h2, h3 and h4. Enum: `1`, `2`, `3`, `4`, `5`. |
|
|
655
617
|
| `mark` | boolean | `false` | Apply marked (highlighted) style. |
|
|
656
|
-
| `type` | string | `"default"` | Additional types. Don't specify for default. Enum: `
|
|
618
|
+
| `type` | string | `"default"` | Additional types. Don't specify for default. Enum: `secondary`, `warning`, `danger`, `success`. |
|
|
657
619
|
| `underline` | boolean | `false` | Apply underline style. |
|
|
658
620
|
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design typography tokens](https://ant.design/components/typography#design-token). |
|
|
659
|
-
| `theme.titleMarginBottom` | string
|
|
660
|
-
| `theme.titleMarginTop` | string
|
|
621
|
+
| `theme.titleMarginBottom` | string | `"0.5em"` | Margin bottom of title. |
|
|
622
|
+
| `theme.titleMarginTop` | string | `"1.2em"` | Margin top of title. |
|
|
661
623
|
| `theme.fontSizeHeading1` | number | `38` | Font size of h1 heading. |
|
|
662
624
|
| `theme.fontSizeHeading2` | number | `30` | Font size of h2 heading. |
|
|
663
625
|
| `theme.fontSizeHeading3` | number | `24` | Font size of h3 heading. |
|
|
@@ -680,7 +642,7 @@ Recent Activity
|
|
|
680
642
|
|
|
681
643
|
| Event | Event Data | Description |
|
|
682
644
|
| --- | --- | --- |
|
|
683
|
-
| `onExpand` |
|
|
645
|
+
| `onExpand` | \- | Trigger action when ellipse expand is clicked. |
|
|
684
646
|
| `onCopy` | \- | Trigger action when copy text is clicked. |
|
|
685
647
|
|
|
686
648
|
| Key | Target |
|
|
@@ -688,6 +650,5 @@ Recent Activity
|
|
|
688
650
|
| `/block` | Outer block wrapper (always available). |
|
|
689
651
|
| `/element` | The Title element. |
|
|
690
652
|
| `/copyableIcon` | The copyable icon in the Title. |
|
|
691
|
-
| `/actions` | The bar of action buttons, such as copy and expand, next to the text. |
|
|
692
653
|
|
|
693
654
|
No slots defined.
|
|
@@ -318,7 +318,7 @@ Guided tour with steps, masks, and keyboard navigation.
|
|
|
318
318
|
title: Upload
|
|
319
319
|
color: primary
|
|
320
320
|
variant: solid
|
|
321
|
-
icon:
|
|
321
|
+
icon: AiOutlineUpload
|
|
322
322
|
- id: target_save_btn
|
|
323
323
|
type: Button
|
|
324
324
|
layout:
|
|
@@ -327,7 +327,7 @@ Guided tour with steps, masks, and keyboard navigation.
|
|
|
327
327
|
title: Save Draft
|
|
328
328
|
color: green
|
|
329
329
|
variant: outlined
|
|
330
|
-
icon:
|
|
330
|
+
icon: AiOutlineSave
|
|
331
331
|
- id: target_share_btn
|
|
332
332
|
type: Button
|
|
333
333
|
layout:
|
|
@@ -336,7 +336,7 @@ Guided tour with steps, masks, and keyboard navigation.
|
|
|
336
336
|
title: Share
|
|
337
337
|
color: purple
|
|
338
338
|
variant: solid
|
|
339
|
-
icon:
|
|
339
|
+
icon: AiOutlineShareAlt
|
|
340
340
|
- id: target_tour
|
|
341
341
|
type: Tour
|
|
342
342
|
properties:
|
|
@@ -705,7 +705,7 @@ Guided tour with steps, masks, and keyboard navigation.
|
|
|
705
705
|
type: Tour
|
|
706
706
|
style:
|
|
707
707
|
.mask:
|
|
708
|
-
boxShadow:
|
|
708
|
+
boxShadow: inset 0 0 15px
|
|
709
709
|
properties:
|
|
710
710
|
open:
|
|
711
711
|
_state: mask_custom_tour_open
|
|
@@ -1027,7 +1027,7 @@ Guided tour with steps, masks, and keyboard navigation.
|
|
|
1027
1027
|
title: Dashboard
|
|
1028
1028
|
color: primary
|
|
1029
1029
|
variant: solid
|
|
1030
|
-
icon:
|
|
1030
|
+
icon: AiOutlineDashboard
|
|
1031
1031
|
- id: cover_target_btn_2
|
|
1032
1032
|
type: Button
|
|
1033
1033
|
layout:
|
|
@@ -1036,7 +1036,7 @@ Guided tour with steps, masks, and keyboard navigation.
|
|
|
1036
1036
|
title: Settings
|
|
1037
1037
|
color: default
|
|
1038
1038
|
variant: outlined
|
|
1039
|
-
icon:
|
|
1039
|
+
icon: AiOutlineSetting
|
|
1040
1040
|
- id: cover_target_tour
|
|
1041
1041
|
type: Tour
|
|
1042
1042
|
properties:
|
|
@@ -1322,7 +1322,7 @@ Guided tour with steps, masks, and keyboard navigation.
|
|
|
1322
1322
|
title: Cannot Click During Tour
|
|
1323
1323
|
color: primary
|
|
1324
1324
|
variant: solid
|
|
1325
|
-
icon:
|
|
1325
|
+
icon: AiOutlineLock
|
|
1326
1326
|
- id: disabled_interaction_tour
|
|
1327
1327
|
type: Tour
|
|
1328
1328
|
properties:
|
|
@@ -1470,8 +1470,8 @@ Guided tour with steps, masks, and keyboard navigation.
|
|
|
1470
1470
|
open:
|
|
1471
1471
|
_state: gap_large_tour_open
|
|
1472
1472
|
gap:
|
|
1473
|
-
|
|
1474
|
-
|
|
1473
|
+
x: 20
|
|
1474
|
+
y: 20
|
|
1475
1475
|
steps:
|
|
1476
1476
|
- title: Large Gap
|
|
1477
1477
|
description: Increased gap (20px) around the target for more breathing room.
|
|
@@ -1493,8 +1493,8 @@ Guided tour with steps, masks, and keyboard navigation.
|
|
|
1493
1493
|
open:
|
|
1494
1494
|
_state: gap_tight_tour_open
|
|
1495
1495
|
gap:
|
|
1496
|
-
|
|
1497
|
-
|
|
1496
|
+
x: 0
|
|
1497
|
+
y: 0
|
|
1498
1498
|
steps:
|
|
1499
1499
|
- title: No Gap
|
|
1500
1500
|
description: The highlight fits tightly around the target with zero spacing.
|
|
@@ -2086,7 +2086,7 @@ Welcome to the application. Click the button below to take a guided tour of the
|
|
|
2086
2086
|
title: Create New
|
|
2087
2087
|
color: primary
|
|
2088
2088
|
variant: solid
|
|
2089
|
-
icon:
|
|
2089
|
+
icon: AiOutlinePlus
|
|
2090
2090
|
- id: onboard_profile_btn
|
|
2091
2091
|
type: Button
|
|
2092
2092
|
layout:
|
|
@@ -2095,7 +2095,7 @@ Welcome to the application. Click the button below to take a guided tour of the
|
|
|
2095
2095
|
title: Profile
|
|
2096
2096
|
color: default
|
|
2097
2097
|
variant: text
|
|
2098
|
-
icon:
|
|
2098
|
+
icon: AiOutlineUser
|
|
2099
2099
|
- id: onboard_settings_btn
|
|
2100
2100
|
type: Button
|
|
2101
2101
|
layout:
|
|
@@ -2104,7 +2104,7 @@ Welcome to the application. Click the button below to take a guided tour of the
|
|
|
2104
2104
|
title: Settings
|
|
2105
2105
|
color: default
|
|
2106
2106
|
variant: text
|
|
2107
|
-
icon:
|
|
2107
|
+
icon: AiOutlineSetting
|
|
2108
2108
|
- id: onboard_content
|
|
2109
2109
|
type: Markdown
|
|
2110
2110
|
properties:
|
|
@@ -2125,7 +2125,7 @@ Welcome to the application. Click the button below to take a guided tour of the
|
|
|
2125
2125
|
title: Take the Tour
|
|
2126
2126
|
color: primary
|
|
2127
2127
|
variant: solid
|
|
2128
|
-
icon:
|
|
2128
|
+
icon: AiOutlineQuestionCircle
|
|
2129
2129
|
events:
|
|
2130
2130
|
onClick:
|
|
2131
2131
|
- id: onboard_start_tour
|
|
@@ -2218,7 +2218,7 @@ Welcome to the application. Click the button below to take a guided tour of the
|
|
|
2218
2218
|
color: primary
|
|
2219
2219
|
variant: solid
|
|
2220
2220
|
size: small
|
|
2221
|
-
icon:
|
|
2221
|
+
icon: AiOutlineSave
|
|
2222
2222
|
- id: feature_export_btn
|
|
2223
2223
|
type: Button
|
|
2224
2224
|
layout:
|
|
@@ -2228,7 +2228,7 @@ Welcome to the application. Click the button below to take a guided tour of the
|
|
|
2228
2228
|
color: default
|
|
2229
2229
|
variant: outlined
|
|
2230
2230
|
size: small
|
|
2231
|
-
icon:
|
|
2231
|
+
icon: AiOutlineExport
|
|
2232
2232
|
- id: feature_editor
|
|
2233
2233
|
type: TextArea
|
|
2234
2234
|
properties:
|
|
@@ -2250,7 +2250,7 @@ Welcome to the application. Click the button below to take a guided tour of the
|
|
|
2250
2250
|
title: Learn Editor Features
|
|
2251
2251
|
color: primary
|
|
2252
2252
|
variant: outlined
|
|
2253
|
-
icon:
|
|
2253
|
+
icon: AiOutlineBulb
|
|
2254
2254
|
events:
|
|
2255
2255
|
onClick:
|
|
2256
2256
|
- id: feature_start_tour
|
|
@@ -2308,26 +2308,20 @@ Welcome to the application. Click the button below to take a guided tour of the
|
|
|
2308
2308
|
| `closable` | boolean | `true` | Whether the close button is visible. |
|
|
2309
2309
|
| `current` | integer | - | Current step index. |
|
|
2310
2310
|
| `disabledInteraction` | boolean | `false` | Whether to disable interaction with the page while the tour is active. |
|
|
2311
|
-
| `gap` | object | - | Gap between
|
|
2312
|
-
| `gap.
|
|
2313
|
-
| `gap.
|
|
2314
|
-
| `gap.x` | number | - | Horizontal gap offset. Same as the first value of `offset`. |
|
|
2315
|
-
| `gap.y` | number | - | Vertical gap offset. Same as the second value of `offset`. |
|
|
2311
|
+
| `gap` | object | - | Gap offset between highlighted area and target element. |
|
|
2312
|
+
| `gap.x` | number | - | Horizontal gap offset. |
|
|
2313
|
+
| `gap.y` | number | - | Vertical gap offset. |
|
|
2316
2314
|
| `keyboard` | boolean | `true` | Whether to enable keyboard navigation. |
|
|
2317
2315
|
| `mask` | boolean \| object | `true` | Whether to enable mask. |
|
|
2318
2316
|
| `open` | boolean | `false` | Whether to show the tour. |
|
|
2319
|
-
| `placement` | string |
|
|
2320
|
-
| `scrollIntoViewOptions` | boolean
|
|
2317
|
+
| `placement` | string | - | Position of the guide card relative to the target element. |
|
|
2318
|
+
| `scrollIntoViewOptions` | boolean | `true` | Whether to scroll the step target element into view. |
|
|
2321
2319
|
| `steps` | array | - | Tour steps. Each step has title, description, target (blockId string), placement, etc. |
|
|
2322
2320
|
| `steps.$.arrow` | boolean \| object | - | Whether to show the arrow for this step, or object with pointAtCenter. |
|
|
2323
2321
|
| `steps.$.closable` | boolean | - | Whether the close button is visible for this step. |
|
|
2324
2322
|
| `steps.$.cover` | string | - | Cover image URL for the step. |
|
|
2325
2323
|
| `steps.$.description` | string | - | Description of the step. |
|
|
2326
2324
|
| `steps.$.mask` | boolean \| object | - | Whether to enable mask for this step, or object with style and color properties. |
|
|
2327
|
-
| `steps.$.nextButtonProps` | object | - | Next button settings for this step. |
|
|
2328
|
-
| `steps.$.nextButtonProps.children` | string | - | Text of the next button, for example "Got it". |
|
|
2329
|
-
| `steps.$.prevButtonProps` | object | - | Previous button settings for this step. |
|
|
2330
|
-
| `steps.$.prevButtonProps.children` | string | - | Text of the previous button. |
|
|
2331
2325
|
| `steps.$.placement` | string | - | Position of the guide card relative to the target element. |
|
|
2332
2326
|
| `steps.$.target` | string | - | The blockId of the target element for this step. |
|
|
2333
2327
|
| `steps.$.title` | string | - | Title of the step. |
|
|
@@ -2361,9 +2355,5 @@ Welcome to the application. Click the button below to take a guided tour of the
|
|
|
2361
2355
|
| `/block` | Outer block wrapper (always available). |
|
|
2362
2356
|
| `/element` | The Tour element. |
|
|
2363
2357
|
| `/mask` | The Tour mask. |
|
|
2364
|
-
| `/title` | The title of the step card. |
|
|
2365
|
-
| `/description` | The description of the step card. |
|
|
2366
|
-
| `/cover` | The cover image area of the step card. |
|
|
2367
|
-
| `/footer` | The footer of the step card with the indicators and buttons. |
|
|
2368
2358
|
|
|
2369
2359
|
No slots defined.
|
|
@@ -192,45 +192,6 @@ 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
|
|
234
195
|
```
|
|
235
196
|
|
|
236
197
|
```yaml
|
|
@@ -435,11 +396,10 @@ Text input with auto-complete suggestions from a list of options.
|
|
|
435
396
|
- id: style_background
|
|
436
397
|
type: AutoComplete
|
|
437
398
|
style:
|
|
438
|
-
.element:
|
|
439
|
-
backgroundColor: var(--ant-color-success-bg)
|
|
399
|
+
.element: null
|
|
440
400
|
properties:
|
|
441
401
|
title: Custom Background
|
|
442
|
-
placeholder:
|
|
402
|
+
placeholder: Light green background
|
|
443
403
|
options:
|
|
444
404
|
- Option A
|
|
445
405
|
- Option B
|
|
@@ -463,7 +423,7 @@ Text input with auto-complete suggestions from a list of options.
|
|
|
463
423
|
- id: class_element
|
|
464
424
|
type: AutoComplete
|
|
465
425
|
class:
|
|
466
|
-
|
|
426
|
+
element: rounded-lg shadow-sm
|
|
467
427
|
properties:
|
|
468
428
|
title: Custom Class
|
|
469
429
|
placeholder: Tailwind classes applied
|
|
@@ -663,7 +623,7 @@ Text input with auto-complete suggestions from a list of options.
|
|
|
663
623
|
type: Button
|
|
664
624
|
properties:
|
|
665
625
|
title: Search
|
|
666
|
-
icon:
|
|
626
|
+
icon: AiOutlineSearch
|
|
667
627
|
type: primary
|
|
668
628
|
size: large
|
|
669
629
|
events:
|
|
@@ -732,7 +692,7 @@ Text input with auto-complete suggestions from a list of options.
|
|
|
732
692
|
properties:
|
|
733
693
|
title: Save Profile
|
|
734
694
|
type: primary
|
|
735
|
-
icon:
|
|
695
|
+
icon: AiOutlineSave
|
|
736
696
|
events:
|
|
737
697
|
onClick:
|
|
738
698
|
- id: save_action
|
|
@@ -747,55 +707,27 @@ Text input with auto-complete suggestions from a list of options.
|
|
|
747
707
|
| `allowClear` | boolean | `true` | Allow the user to clear the selected value, sets the value to null. |
|
|
748
708
|
| `autoFocus` | boolean | `false` | Autofocus to the block on page load. |
|
|
749
709
|
| `bordered` | boolean | `true` | Whether or not the input has a border style. Deprecated, use variant instead. |
|
|
750
|
-
| `backfill` | boolean | `false` | Backfill
|
|
710
|
+
| `backfill` | boolean | `false` | Backfill selected item the input when using keyboard |
|
|
751
711
|
| `defaultOpen` | boolean | `false` | Initial open state of dropdown. |
|
|
752
712
|
| `disabled` | boolean | `false` | Disable the block if true. |
|
|
753
713
|
| `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. |
|
|
766
714
|
| `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
|
|
767
715
|
| `label.colon` | boolean | `true` | Append label with colon. |
|
|
768
716
|
| `label.extra` | string | - | Extra text to display beneath the content - supports html. |
|
|
769
717
|
| `label.title` | string | - | Label title - supports html. |
|
|
770
718
|
| `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. |
|
|
771
719
|
| `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
|
|
772
|
-
| `label.tooltip.icon` | string | `"
|
|
720
|
+
| `label.tooltip.icon` | string | `"AiOutlineQuestionCircle"` | Name of the icon to show beside the label. |
|
|
773
721
|
| `label.tooltip.color` | string | - | Color of the tooltip icon. |
|
|
774
|
-
| `label.span` | number | - | Label
|
|
722
|
+
| `label.span` | number | - | Label inline span. |
|
|
775
723
|
| `label.disabled` | boolean | `false` | Hide input label. |
|
|
776
724
|
| `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
|
|
777
725
|
| `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. |
|
|
780
726
|
| `options` | array | `[]` | Options can either be an array of string values. |
|
|
781
727
|
| `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. |
|
|
795
728
|
| `size` | string | `"default"` | Size of the block. Enum: `small`, `default`, `large`. |
|
|
796
729
|
| `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed. |
|
|
797
|
-
| `variant` | string | - | Input visual variant.
|
|
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. |
|
|
730
|
+
| `variant` | string | - | Input visual variant. When set, takes precedence over bordered. Enum: `outlined`, `filled`, `borderless`. |
|
|
799
731
|
| `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). |
|
|
800
732
|
| `theme.borderRadius` | number | `6` | Border radius of the input. |
|
|
801
733
|
| `theme.borderRadiusLG` | number | `8` | Border radius for large size. |
|
|
@@ -838,9 +770,7 @@ Text input with auto-complete suggestions from a list of options.
|
|
|
838
770
|
| `onChange` | `{ value }` | Trigger actions when selection is changed. |
|
|
839
771
|
| `onFocus` | \- | Trigger action when an selector gets focus. |
|
|
840
772
|
| `onClear` | \- | Trigger action when selector gets cleared. |
|
|
841
|
-
| `onOpenChange` | `{ open }` | Trigger actions when the dropdown opens or closes. |
|
|
842
773
|
| `onSearch` | `{ value }` | Called when searching items. |
|
|
843
|
-
| `onSelect` | `{ value }` | Trigger actions when an option is selected from the dropdown, as opposed to typed. |
|
|
844
774
|
| `onTooltipClick` | \- | Trigger actions when the tooltip icon is clicked. |
|
|
845
775
|
|
|
846
776
|
| Key | Target |
|
|
@@ -852,7 +782,5 @@ Text input with auto-complete suggestions from a list of options.
|
|
|
852
782
|
| `/extra` | The AutoComplete extra content. |
|
|
853
783
|
| `/feedback` | The AutoComplete validation feedback. |
|
|
854
784
|
| `/options` | The AutoComplete options. |
|
|
855
|
-
| `/popup` | The AutoComplete dropdown popup. |
|
|
856
|
-
| `/prefixIcon` | The prefix icon in the AutoComplete. |
|
|
857
785
|
|
|
858
786
|
No slots defined.
|
|
@@ -91,27 +91,6 @@ 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
|
-
|
|
115
94
|
```yaml
|
|
116
95
|
- id: size_small
|
|
117
96
|
type: ButtonSelector
|
|
@@ -592,7 +571,6 @@ Radio group styled as toggle buttons.
|
|
|
592
571
|
```yaml
|
|
593
572
|
- id: class_padding
|
|
594
573
|
type: ButtonSelector
|
|
595
|
-
class: p-4
|
|
596
574
|
properties:
|
|
597
575
|
title: Tailwind Padding
|
|
598
576
|
variant: solid
|
|
@@ -603,9 +581,9 @@ Radio group styled as toggle buttons.
|
|
|
603
581
|
value: b
|
|
604
582
|
- label: Option C
|
|
605
583
|
value: c
|
|
584
|
+
class: p-4
|
|
606
585
|
- id: class_shadow_rounded
|
|
607
586
|
type: ButtonSelector
|
|
608
|
-
class: shadow-md rounded-lg p-2
|
|
609
587
|
properties:
|
|
610
588
|
title: Shadow and Rounded
|
|
611
589
|
variant: solid
|
|
@@ -616,9 +594,9 @@ Radio group styled as toggle buttons.
|
|
|
616
594
|
value: b
|
|
617
595
|
- label: Option C
|
|
618
596
|
value: c
|
|
597
|
+
class: shadow-md rounded-lg p-2
|
|
619
598
|
- id: class_background
|
|
620
599
|
type: ButtonSelector
|
|
621
|
-
class: bg-bg-layout p-3 rounded
|
|
622
600
|
properties:
|
|
623
601
|
title: Background Color
|
|
624
602
|
variant: solid
|
|
@@ -629,6 +607,7 @@ Radio group styled as toggle buttons.
|
|
|
629
607
|
value: b
|
|
630
608
|
- label: Option C
|
|
631
609
|
value: c
|
|
610
|
+
class: bg-bg-layout p-3 rounded
|
|
632
611
|
```
|
|
633
612
|
|
|
634
613
|
```yaml
|
|
@@ -767,7 +746,7 @@ Radio group styled as toggle buttons.
|
|
|
767
746
|
properties:
|
|
768
747
|
title: Submit Survey
|
|
769
748
|
type: primary
|
|
770
|
-
icon:
|
|
749
|
+
icon: AiOutlineSend
|
|
771
750
|
events:
|
|
772
751
|
onClick:
|
|
773
752
|
- id: survey_submit_action
|
|
@@ -837,7 +816,7 @@ Radio group styled as toggle buttons.
|
|
|
837
816
|
properties:
|
|
838
817
|
title: Save Settings
|
|
839
818
|
type: primary
|
|
840
|
-
icon:
|
|
819
|
+
icon: AiOutlineSave
|
|
841
820
|
events:
|
|
842
821
|
onClick:
|
|
843
822
|
- id: settings_save_action
|
|
@@ -907,15 +886,13 @@ Radio group styled as toggle buttons.
|
|
|
907
886
|
|
|
908
887
|
| Property | Type | Default | Description |
|
|
909
888
|
| --- | --- | --- | --- |
|
|
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`. |
|
|
912
889
|
| `variant` | string | `"solid"` | Visual variant of the selected option button, matching the Button block. Enum: `solid`, `outlined`. |
|
|
913
890
|
| `buttonStyle` | string | - | Deprecated — use `variant` (solid \| outlined) instead. Enum: `solid`, `outline`. |
|
|
914
891
|
| `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. |
|
|
915
892
|
| `disabled` | boolean | `false` | Disable the block if true. |
|
|
916
893
|
| `options` | array | `[]` | Options can either be an array of primitive values, on an array of label, value pairs - supports html. |
|
|
917
894
|
| `options.$.label` | string | - | Value label shown to user - supports html. |
|
|
918
|
-
| `options.$.value` |
|
|
895
|
+
| `options.$.value` | string \| number \| boolean | - | Option value. |
|
|
919
896
|
| `options.$.disabled` | boolean | `false` | Disable the option if true. |
|
|
920
897
|
| `options.$.style` | object | - | Css style to apply to the option. |
|
|
921
898
|
| `options.$.color` | string | - | Color applied to this option when it is selected. Falls back to the block-level color when not set. |
|
|
@@ -925,31 +902,18 @@ Radio group styled as toggle buttons.
|
|
|
925
902
|
| `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. |
|
|
926
903
|
| `size` | string | `"default"` | Size of the block. Enum: `small`, `default`, `large`. |
|
|
927
904
|
| `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. |
|
|
940
905
|
| `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
|
|
941
906
|
| `label.colon` | boolean | `true` | Append label with colon. |
|
|
942
907
|
| `label.extra` | string | - | Extra text to display beneath the content - supports html. |
|
|
943
908
|
| `label.title` | string | - | Label title - supports html. |
|
|
944
909
|
| `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. |
|
|
945
910
|
| `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
|
|
946
|
-
| `label.tooltip.icon` | string | `"
|
|
911
|
+
| `label.tooltip.icon` | string | `"AiOutlineQuestionCircle"` | Name of the icon to show beside the label. |
|
|
947
912
|
| `label.tooltip.color` | string | - | Color of the tooltip icon. |
|
|
948
|
-
| `label.span` | number | - | Label
|
|
913
|
+
| `label.span` | number | - | Label inline span. |
|
|
949
914
|
| `label.disabled` | boolean | `false` | Hide input label. |
|
|
950
915
|
| `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
|
|
951
916
|
| `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. |
|
|
953
917
|
| `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
|
|
954
918
|
| `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). |
|
|
955
919
|
| `theme.radioSize` | number | `16` | Size of the radio dot element. |
|
|
@@ -996,6 +960,5 @@ Radio group styled as toggle buttons.
|
|
|
996
960
|
| `/label` | The ButtonSelector label. |
|
|
997
961
|
| `/extra` | The ButtonSelector extra content. |
|
|
998
962
|
| `/feedback` | The ButtonSelector validation feedback. |
|
|
999
|
-
| `/options` | Each ButtonSelector option. |
|
|
1000
963
|
|
|
1001
964
|
No slots defined.
|