@lowdefy/docs-content 6.1.0 → 7.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -0
- package/content/actions/downloadcsv.md +1 -1
- package/content/actions/emailotpsend.md +58 -0
- package/content/actions/emailotpverify.md +79 -0
- package/content/actions/getlocalstorage.md +43 -0
- package/content/actions/link.md +47 -1
- package/content/actions/login.md +25 -5
- package/content/actions/logout.md +7 -5
- package/content/actions/magiclinkverify.md +117 -0
- package/content/actions/pdfmake.md +2 -2
- package/content/actions/posthogalias.md +29 -0
- package/content/actions/posthogcapture.md +49 -0
- package/content/actions/posthogcapturepageleave.md +38 -0
- package/content/actions/posthogfeatureflag.md +50 -0
- package/content/actions/posthoggroup.md +37 -0
- package/content/actions/posthogidentify.md +54 -0
- package/content/actions/posthoginit.md +96 -0
- package/content/actions/posthogoptin.md +29 -0
- package/content/actions/posthogoptout.md +29 -0
- package/content/actions/posthogpageview.md +37 -0
- package/content/actions/posthogreloadfeatureflags.md +47 -0
- package/content/actions/posthogreset.md +28 -0
- package/content/actions/posthogsetpersonproperties.md +36 -0
- package/content/actions/removelocalstorage.md +28 -0
- package/content/actions/resetvalidation.md +7 -3
- package/content/actions/setdarkmode.md +3 -3
- package/content/actions/setglobal.md +2 -0
- package/content/actions/setlocale.md +1 -1
- package/content/actions/setlocalstorage.md +34 -0
- package/content/actions/validate.md +7 -4
- package/content/adapter-reference/mongodbauthadapter.md +46 -0
- package/content/agents/agent-endpoint-tools.md +24 -0
- package/content/agents/agent-properties.md +13 -3
- package/content/agents/agent-server-hooks.md +1 -1
- package/content/agents/agentchat.md +43 -7
- package/content/agents/agentconversations.md +42 -8
- package/content/agents/agents-introduction.md +107 -0
- package/content/callback-reference/auth0logoutcallback.md +54 -0
- package/content/concepts/ai-agent-docs.md +455 -106
- package/content/concepts/blocks.md +150 -0
- package/content/concepts/connections-and-requests.md +402 -0
- package/content/concepts/custom-html.md +42 -0
- package/content/concepts/custom-styling.md +50 -5
- package/content/concepts/dynamic-page-content.md +309 -0
- package/content/concepts/events-and-actions.md +154 -2
- package/content/concepts/four-primitives.md +31 -0
- package/content/concepts/html-attributes.md +293 -0
- package/content/concepts/i18n.md +8 -3
- package/content/concepts/keyboard-shortcuts.md +2 -2
- package/content/concepts/layout-overview.md +1 -1
- package/content/concepts/logger.md +99 -0
- package/content/concepts/lowdefy-api.md +1319 -0
- package/content/concepts/lowdefy-schema.md +136 -3
- package/content/concepts/menus.md +8 -7
- package/content/concepts/module-authoring.md +76 -5
- package/content/concepts/modules.md +3 -1
- package/content/concepts/notifications.md +180 -0
- package/content/concepts/operators.md +7 -0
- package/content/concepts/page-and-app-state.md +252 -0
- package/content/concepts/page-paths.md +209 -0
- package/content/concepts/theming.md +582 -0
- package/content/connections/aigateway.md +375 -0
- package/content/connections/anthropic.md +169 -2
- package/content/connections/awss3.md +178 -2
- package/content/connections/axioshttp.md +181 -0
- package/content/connections/google.md +169 -2
- package/content/connections/mongodb.md +1014 -3
- package/content/connections/openai-connection.md +169 -2
- package/content/connections/sendgridmail.md +2 -0
- package/content/connections/smtp.md +3 -1
- package/content/connections/treg.md +329 -0
- package/content/container-blocks/affix.md +47 -7
- package/content/container-blocks/alert.md +76 -24
- package/content/container-blocks/badge.md +100 -24
- package/content/container-blocks/box.md +9 -9
- package/content/container-blocks/card.md +132 -27
- package/content/container-blocks/carousel.md +60 -7
- package/content/container-blocks/collapse.md +153 -9
- package/content/container-blocks/configprovider.md +35 -13
- package/content/container-blocks/confirmmodal.md +69 -23
- package/content/container-blocks/content.md +62 -98
- package/content/container-blocks/descriptions.md +45 -4
- package/content/container-blocks/drawer.md +139 -28
- package/content/container-blocks/dropdownmenu.md +119 -31
- package/content/container-blocks/flex.md +40 -62
- package/content/container-blocks/footer.md +15 -11
- package/content/container-blocks/googlemapsheatmap.md +1 -1
- package/content/container-blocks/googlemapsscript.md +2 -2
- package/content/container-blocks/header.md +71 -36
- package/content/container-blocks/label.md +34 -7
- package/content/container-blocks/layout.md +52 -34
- package/content/container-blocks/masonry.md +17 -71
- package/content/container-blocks/mobilemenu.md +131 -88
- package/content/container-blocks/modal.md +161 -26
- package/content/container-blocks/pageheadermenu.md +138 -31
- package/content/container-blocks/pagesidebarlayout.md +230 -27
- package/content/container-blocks/pagesidermenu.md +153 -43
- package/content/container-blocks/popover.md +34 -31
- package/content/container-blocks/result.md +32 -21
- package/content/container-blocks/sider.md +85 -122
- package/content/container-blocks/span.md +7 -7
- package/content/container-blocks/spinner.md +3 -3
- package/content/container-blocks/splitter.md +150 -68
- package/content/container-blocks/tabs.md +64 -12
- package/content/container-blocks/tooltip.md +22 -46
- package/content/container-blocks/watermark.md +22 -4
- package/content/controls/parallel_for.md +21 -2
- package/content/controls/reject.md +24 -3
- package/content/controls/return.md +17 -1
- package/content/controls/throw.md +1 -0
- package/content/controls/try.md +4 -2
- package/content/controls/while.md +46 -0
- package/content/deployment/deployment-environments.md +10 -7
- package/content/deployment/docker.md +22 -7
- package/content/deployment/node-server.md +4 -0
- package/content/deployment/vercel.md +17 -6
- package/content/display-blocks/aggrid.md +36 -19
- package/content/display-blocks/anchor.md +16 -15
- package/content/display-blocks/avatar.md +57 -37
- package/content/display-blocks/breadcrumb.md +70 -21
- package/content/display-blocks/button.md +93 -19
- package/content/display-blocks/calendar.md +12 -0
- package/content/display-blocks/clickablehtml.md +239 -0
- package/content/display-blocks/dangeroushtml.md +1 -1
- package/content/display-blocks/difflist.md +1 -1
- package/content/display-blocks/difftimeline.md +1 -1
- package/content/display-blocks/divider.md +64 -3
- package/content/display-blocks/dropdownbutton.md +81 -30
- package/content/display-blocks/echart.md +35 -1
- package/content/display-blocks/eventlog.md +363 -0
- package/content/display-blocks/floatbutton.md +129 -42
- package/content/display-blocks/html.md +61 -1
- package/content/display-blocks/icon.md +250 -67
- package/content/display-blocks/img.md +2 -2
- package/content/display-blocks/menu.md +146 -73
- package/content/display-blocks/message.md +38 -124
- package/content/display-blocks/notification.md +94 -222
- package/content/display-blocks/paragraph.md +59 -9
- package/content/display-blocks/pollingtimer.md +263 -0
- package/content/display-blocks/progress.md +96 -17
- package/content/display-blocks/qrcode.md +19 -4
- package/content/display-blocks/s3download.md +1 -1
- package/content/display-blocks/search.md +19 -9
- package/content/display-blocks/skeletonbutton.md +1 -0
- package/content/display-blocks/skeletoninput.md +1 -0
- package/content/display-blocks/statistic.md +75 -17
- package/content/display-blocks/steps.md +58 -25
- package/content/display-blocks/table.md +2527 -0
- package/content/display-blocks/tablelight.md +621 -0
- package/content/display-blocks/tag.md +102 -17
- package/content/display-blocks/title.md +50 -11
- package/content/display-blocks/tour.md +33 -23
- package/content/input-blocks/autocomplete.md +81 -9
- package/content/input-blocks/buttonselector.md +45 -8
- package/content/input-blocks/captcha.md +40 -0
- package/content/input-blocks/checkboxselector.md +97 -7
- package/content/input-blocks/checkboxswitch.md +33 -3
- package/content/input-blocks/colorselector.md +63 -14
- package/content/input-blocks/daterangeselector.md +165 -45
- package/content/input-blocks/dateselector.md +139 -41
- package/content/input-blocks/datetimeselector.md +158 -49
- package/content/input-blocks/inputgallery.md +3 -3
- package/content/input-blocks/intentinput.md +207 -0
- package/content/input-blocks/monthselector.md +120 -52
- package/content/input-blocks/multipleselector.md +150 -39
- package/content/input-blocks/numberinput.md +98 -12
- package/content/input-blocks/pagination.md +70 -14
- package/content/input-blocks/paragraphinput.md +51 -37
- package/content/input-blocks/passwordinput.md +60 -6
- package/content/input-blocks/phonenumberinput.md +59 -26
- package/content/input-blocks/placesautocomplete.md +319 -0
- package/content/input-blocks/radioselector.md +83 -7
- package/content/input-blocks/ratingslider.md +57 -26
- package/content/input-blocks/s3uploadbutton.md +24 -24
- package/content/input-blocks/s3uploaddragger.md +3 -3
- package/content/input-blocks/s3uploadphoto.md +5 -5
- package/content/input-blocks/segmentedselector.md +72 -32
- package/content/input-blocks/selector.md +109 -21
- package/content/input-blocks/switch.md +65 -17
- package/content/input-blocks/tableinput.md +445 -0
- package/content/input-blocks/tagmultipleselector.md +114 -0
- package/content/input-blocks/tagselector.md +114 -0
- package/content/input-blocks/textarea.md +32 -3
- package/content/input-blocks/textinput.md +70 -29
- package/content/input-blocks/tiptapinput.md +1 -1
- package/content/input-blocks/tiptapmentioninput.md +2 -2
- package/content/input-blocks/titleinput.md +39 -12
- package/content/input-blocks/treeinput.md +49 -25
- package/content/input-blocks/treemultipleselector.md +127 -10
- package/content/input-blocks/treeselector.md +97 -9
- package/content/input-blocks/upload.md +64 -15
- package/content/input-blocks/uploaddragger.md +17 -1
- package/content/input-blocks/uploadphoto.md +18 -1
- package/content/input-blocks/weekselector.md +120 -55
- package/content/learn/introduction.md +27 -0
- package/content/learn/quickstart.md +53 -0
- package/content/list-blocks/controlledlist.md +24 -15
- package/content/list-blocks/list.md +11 -11
- package/content/list-blocks/masonrylist.md +7 -34
- package/content/migration/auth-upgrade.md +337 -0
- package/content/migration/upgrade-guide.md +1 -0
- package/content/migration/v3-to-v4.md +417 -0
- package/content/migration/v6-to-v7.md +620 -0
- package/content/operators/_agent.md +155 -0
- package/content/operators/_app.md +2 -1
- package/content/operators/_array.md +122 -1
- package/content/operators/_build.md +1 -0
- package/content/operators/_credential.md +57 -0
- package/content/operators/_cron.md +292 -0
- package/content/operators/_date.md +2 -0
- package/content/operators/_error.md +24 -1
- package/content/operators/_get.md +6 -6
- package/content/operators/_hmac.md +78 -0
- package/content/operators/_js.md +2 -1
- package/content/operators/_location.md +1 -1
- package/content/operators/_media.md +13 -0
- package/content/operators/_module.md +56 -2
- package/content/operators/_operator.md +17 -3
- package/content/operators/_path_params.md +82 -0
- package/content/operators/_ref.md +258 -0
- package/content/operators/_request.md +1 -1
- package/content/operators/_request_details.md +6 -0
- package/content/operators/_type.md +14 -3
- package/content/operators/_url_query.md +2 -0
- package/content/operators/_user.md +3 -3
- package/content/plugins/plugins-actions.md +10 -0
- package/content/plugins/plugins-connections.md +25 -0
- package/content/plugins/plugins-dev.md +66 -0
- package/content/plugins/plugins-icon-sets.md +267 -0
- package/content/plugins/plugins-introduction.md +27 -1
- package/content/plugins/plugins.md +19 -0
- package/content/plugins/posthog.md +359 -0
- package/content/provider-reference/auth-js-providers.md +107 -0
- package/content/provider-reference/openidconnectprovider.md +44 -0
- package/content/recipes/recipes.md +16 -0
- package/content/reference/actions-reference.md +31 -0
- package/content/reference/blocks-reference.md +35 -0
- package/content/reference/cli.md +403 -0
- package/content/reference/connections-reference.md +23 -0
- package/content/reference/operators-reference.md +47 -0
- package/content/reference/reference.md +16 -0
- package/content/reference/schema-reference.md +12 -0
- package/content/testing/config-tests.md +677 -0
- package/content/testing/e2e-configuration.md +31 -1
- package/content/testing/e2e-getting-started.md +1 -1
- package/content/testing/e2e-introduction.md +1 -1
- package/content/testing/e2e-writing-tests.md +12 -1
- package/content/testing/explore-pull-request.md +136 -0
- package/content/testing/journey-data-sets.md +326 -0
- package/content/tutorial/tutorial-actions-operators.md +2 -2
- package/content/tutorial/tutorial-add-blocks.md +2 -2
- package/content/tutorial/tutorial-create-page.md +48 -2
- package/content/tutorial/tutorial-display-data-page.md +3 -3
- package/content/tutorial/tutorial-requests-api.md +155 -0
- package/content/tutorial/tutorial-requests-sql.md +153 -0
- package/content/tutorial/tutorial-start.md +66 -1
- package/content/user-authentication/auth-configuration.md +267 -0
- package/content/user-authentication/auth-providers.md +24 -0
- package/content/user-authentication/auth-steps.md +141 -0
- package/content/user-authentication/login-and-logout.md +160 -8
- package/content/user-authentication/mcp-oauth.md +424 -0
- package/content/user-authentication/organizations.md +246 -0
- package/content/user-authentication/protected-pages-apis.md +97 -0
- package/content/user-authentication/roles.md +49 -0
- package/content/user-authentication/two-factor.md +229 -0
- package/content/user-authentication/user-object.md +58 -0
- package/content/user-authentication/users-introduction.md +8 -0
- package/content/websockets/websocket-publish.md +105 -0
- package/content/websockets/websocket-subscriptions.md +136 -0
- package/content/websockets/websockets-introduction.md +101 -0
- package/hazards.json +44 -0
- package/index.json +3691 -14
- package/package.json +11 -1
- package/scripts/collectImportedFiles.js +80 -0
- package/scripts/extractAgentDocs.js +41 -30
- package/scripts/hashDocSources.js +38 -0
- package/scripts/isRedirectPage.js +26 -0
- package/scripts/recordSourceHashes.js +100 -0
- package/scripts/resolvePageSections.js +42 -0
- package/scripts/sectionKind.js +27 -0
- package/content/concepts/cli.md +0 -223
- package/content/other/introduction.md +0 -39
- package/content/other/next-auth-providers.md +0 -3
- /package/content/{other → actions}/updatesession.md +0 -0
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# TagMultipleSelector
|
|
2
|
+
|
|
3
|
+
Multi-select input rendered as a row of toggleable, colored tag pills.
|
|
4
|
+
|
|
5
|
+
```yaml
|
|
6
|
+
- id: basic_strings
|
|
7
|
+
type: TagMultipleSelector
|
|
8
|
+
properties:
|
|
9
|
+
title: Domains
|
|
10
|
+
options:
|
|
11
|
+
- Ethics
|
|
12
|
+
- Environment
|
|
13
|
+
- Governance
|
|
14
|
+
- Social
|
|
15
|
+
- Data Privacy
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
```yaml
|
|
19
|
+
- id: label_value
|
|
20
|
+
type: TagMultipleSelector
|
|
21
|
+
properties:
|
|
22
|
+
title: Status Filter
|
|
23
|
+
options:
|
|
24
|
+
- label: Draft
|
|
25
|
+
value: draft
|
|
26
|
+
- label: In Review
|
|
27
|
+
value: in_review
|
|
28
|
+
- label: Published
|
|
29
|
+
value: published
|
|
30
|
+
- label: Archived
|
|
31
|
+
value: archived
|
|
32
|
+
disabled: true
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
```yaml
|
|
36
|
+
- id: explicit_colors
|
|
37
|
+
type: TagMultipleSelector
|
|
38
|
+
properties:
|
|
39
|
+
title: Priorities
|
|
40
|
+
options:
|
|
41
|
+
- label: Low
|
|
42
|
+
value: low
|
|
43
|
+
color: "#59A14F"
|
|
44
|
+
- label: Medium
|
|
45
|
+
value: medium
|
|
46
|
+
color: "#EDC948"
|
|
47
|
+
- label: High
|
|
48
|
+
value: high
|
|
49
|
+
color: "#E15759"
|
|
50
|
+
- id: single_accent
|
|
51
|
+
type: TagMultipleSelector
|
|
52
|
+
properties:
|
|
53
|
+
title: Interests
|
|
54
|
+
colored: false
|
|
55
|
+
options:
|
|
56
|
+
- Design
|
|
57
|
+
- Engineering
|
|
58
|
+
- Product
|
|
59
|
+
- Research
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
| Property | Type | Default | Description |
|
|
63
|
+
| --- | --- | --- | --- |
|
|
64
|
+
| `options` | array | - | Options to select from. Primitives, or { label, value, color, disabled } - an explicit color overrides the stable palette color. |
|
|
65
|
+
| `options.$.label` | string | - | Tag label. Defaults to the value. |
|
|
66
|
+
| `options.$.value` | - | - | Option value written into the selection array. |
|
|
67
|
+
| `options.$.color` | string | - | Explicit tag color (hex or CSS color). Overrides the stable palette color. |
|
|
68
|
+
| `options.$.disabled` | boolean | `false` | Disable this tag. |
|
|
69
|
+
| `colored` | boolean | `true` | Give each option a stable color (hash of its value over a fixed palette). false = single primary accent. |
|
|
70
|
+
| `disabled` | boolean | `false` | Disable the block if true. |
|
|
71
|
+
| `size` | string | `"default"` | Size of the block. Enum: `small`, `default`, `large`. |
|
|
72
|
+
| `label` | object | - | Label properties. |
|
|
73
|
+
| `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
|
|
74
|
+
| `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
75
|
+
| `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. |
|
|
76
|
+
| `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
77
|
+
| `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
|
|
78
|
+
| `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
79
|
+
| `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
|
|
80
|
+
| `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
81
|
+
| `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
|
|
82
|
+
| `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
83
|
+
| `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
|
|
84
|
+
| `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
85
|
+
| `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
|
|
86
|
+
| `label.colon` | boolean | `true` | Append label with colon. |
|
|
87
|
+
| `label.extra` | string | - | Extra text to display beneath the content - supports html. |
|
|
88
|
+
| `label.title` | string | - | Label title - supports html. |
|
|
89
|
+
| `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. |
|
|
90
|
+
| `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
|
|
91
|
+
| `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`. |
|
|
92
|
+
| `label.tooltip.color` | string | - | Color of the tooltip icon. |
|
|
93
|
+
| `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. |
|
|
94
|
+
| `label.disabled` | boolean | `false` | Hide input label. |
|
|
95
|
+
| `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
|
|
96
|
+
| `label.inline` | boolean | `false` | Render input and label inline. |
|
|
97
|
+
| `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
|
|
98
|
+
| `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
|
|
99
|
+
|
|
100
|
+
| Event | Event Data | Description |
|
|
101
|
+
| --- | --- | --- |
|
|
102
|
+
| `onChange` | `{ value }` | Trigger actions when the selection is changed. |
|
|
103
|
+
| `onTooltipClick` | \- | Trigger actions when the tooltip icon is clicked. |
|
|
104
|
+
|
|
105
|
+
| Key | Target |
|
|
106
|
+
| --- | --- |
|
|
107
|
+
| `/block` | Outer block wrapper (always available). |
|
|
108
|
+
| `/element` | The TagMultipleSelector tag row. |
|
|
109
|
+
| `/tag` | Each tag pill. |
|
|
110
|
+
| `/label` | The TagMultipleSelector label. |
|
|
111
|
+
| `/extra` | The TagMultipleSelector extra content. |
|
|
112
|
+
| `/feedback` | The TagMultipleSelector validation feedback. |
|
|
113
|
+
|
|
114
|
+
No slots defined.
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# TagSelector
|
|
2
|
+
|
|
3
|
+
Single-select input rendered as a row of toggleable, colored tag pills.
|
|
4
|
+
|
|
5
|
+
```yaml
|
|
6
|
+
- id: basic_strings
|
|
7
|
+
type: TagSelector
|
|
8
|
+
properties:
|
|
9
|
+
title: Domain
|
|
10
|
+
options:
|
|
11
|
+
- Ethics
|
|
12
|
+
- Environment
|
|
13
|
+
- Governance
|
|
14
|
+
- Social
|
|
15
|
+
- Data Privacy
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
```yaml
|
|
19
|
+
- id: label_value
|
|
20
|
+
type: TagSelector
|
|
21
|
+
properties:
|
|
22
|
+
title: Status
|
|
23
|
+
options:
|
|
24
|
+
- label: Draft
|
|
25
|
+
value: draft
|
|
26
|
+
- label: In Review
|
|
27
|
+
value: in_review
|
|
28
|
+
- label: Published
|
|
29
|
+
value: published
|
|
30
|
+
- label: Archived
|
|
31
|
+
value: archived
|
|
32
|
+
disabled: true
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
```yaml
|
|
36
|
+
- id: explicit_colors
|
|
37
|
+
type: TagSelector
|
|
38
|
+
properties:
|
|
39
|
+
title: Priority
|
|
40
|
+
options:
|
|
41
|
+
- label: Low
|
|
42
|
+
value: low
|
|
43
|
+
color: "#59A14F"
|
|
44
|
+
- label: Medium
|
|
45
|
+
value: medium
|
|
46
|
+
color: "#EDC948"
|
|
47
|
+
- label: High
|
|
48
|
+
value: high
|
|
49
|
+
color: "#E15759"
|
|
50
|
+
- id: single_accent
|
|
51
|
+
type: TagSelector
|
|
52
|
+
properties:
|
|
53
|
+
title: Interest
|
|
54
|
+
colored: false
|
|
55
|
+
options:
|
|
56
|
+
- Design
|
|
57
|
+
- Engineering
|
|
58
|
+
- Product
|
|
59
|
+
- Research
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
| Property | Type | Default | Description |
|
|
63
|
+
| --- | --- | --- | --- |
|
|
64
|
+
| `options` | array | - | Options to select from. Primitives, or { label, value, color, disabled } - an explicit color overrides the stable palette color. |
|
|
65
|
+
| `options.$.label` | string | - | Tag label. Defaults to the value. |
|
|
66
|
+
| `options.$.value` | - | - | Option value set as the selection when the tag is selected. |
|
|
67
|
+
| `options.$.color` | string | - | Explicit tag color (hex or CSS color). Overrides the stable palette color. |
|
|
68
|
+
| `options.$.disabled` | boolean | `false` | Disable this tag. |
|
|
69
|
+
| `colored` | boolean | `true` | Give each option a stable color (hash of its value over a fixed palette). false = single primary accent. |
|
|
70
|
+
| `disabled` | boolean | `false` | Disable the block if true. |
|
|
71
|
+
| `size` | string | `"default"` | Size of the block. Enum: `small`, `default`, `large`. |
|
|
72
|
+
| `label` | object | - | Label properties. |
|
|
73
|
+
| `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
|
|
74
|
+
| `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
75
|
+
| `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. |
|
|
76
|
+
| `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
77
|
+
| `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
|
|
78
|
+
| `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
79
|
+
| `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
|
|
80
|
+
| `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
81
|
+
| `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
|
|
82
|
+
| `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
83
|
+
| `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
|
|
84
|
+
| `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
85
|
+
| `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
|
|
86
|
+
| `label.colon` | boolean | `true` | Append label with colon. |
|
|
87
|
+
| `label.extra` | string | - | Extra text to display beneath the content - supports html. |
|
|
88
|
+
| `label.title` | string | - | Label title - supports html. |
|
|
89
|
+
| `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. |
|
|
90
|
+
| `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
|
|
91
|
+
| `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`. |
|
|
92
|
+
| `label.tooltip.color` | string | - | Color of the tooltip icon. |
|
|
93
|
+
| `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. |
|
|
94
|
+
| `label.disabled` | boolean | `false` | Hide input label. |
|
|
95
|
+
| `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
|
|
96
|
+
| `label.inline` | boolean | `false` | Render input and label inline. |
|
|
97
|
+
| `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
|
|
98
|
+
| `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
|
|
99
|
+
|
|
100
|
+
| Event | Event Data | Description |
|
|
101
|
+
| --- | --- | --- |
|
|
102
|
+
| `onChange` | `{ value }` | Trigger actions when the selection is changed. |
|
|
103
|
+
| `onTooltipClick` | \- | Trigger actions when the tooltip icon is clicked. |
|
|
104
|
+
|
|
105
|
+
| Key | Target |
|
|
106
|
+
| --- | --- |
|
|
107
|
+
| `/block` | Outer block wrapper (always available). |
|
|
108
|
+
| `/element` | The TagSelector tag row. |
|
|
109
|
+
| `/tag` | Each tag pill. |
|
|
110
|
+
| `/label` | The TagSelector label. |
|
|
111
|
+
| `/extra` | The TagSelector extra content. |
|
|
112
|
+
| `/feedback` | The TagSelector validation feedback. |
|
|
113
|
+
|
|
114
|
+
No slots defined.
|
|
@@ -241,6 +241,21 @@ Multi-line text input with auto-sizing, character count, and clear button.
|
|
|
241
241
|
placeholder: Larger borderless textarea
|
|
242
242
|
```
|
|
243
243
|
|
|
244
|
+
```yaml
|
|
245
|
+
- id: variant_filled
|
|
246
|
+
type: TextArea
|
|
247
|
+
properties:
|
|
248
|
+
title: Filled
|
|
249
|
+
variant: filled
|
|
250
|
+
placeholder: Filled variant
|
|
251
|
+
- id: variant_underlined
|
|
252
|
+
type: TextArea
|
|
253
|
+
properties:
|
|
254
|
+
title: Underlined
|
|
255
|
+
variant: underlined
|
|
256
|
+
placeholder: Underlined variant
|
|
257
|
+
```
|
|
258
|
+
|
|
244
259
|
```yaml
|
|
245
260
|
- id: disabled_empty
|
|
246
261
|
type: TextArea
|
|
@@ -643,25 +658,38 @@ Multi-line text input with auto-sizing, character count, and clear button.
|
|
|
643
658
|
| `bordered` | boolean | `true` | Whether or not the textarea has a border style. Deprecated, use variant instead. |
|
|
644
659
|
| `disabled` | boolean | `false` | Disable the block if true. |
|
|
645
660
|
| `label` | object | - | Label properties. |
|
|
661
|
+
| `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
|
|
662
|
+
| `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
663
|
+
| `label.sm` | object | - | Label width on small screens (576px and up) when the label is not inline. Also applies below 576px unless `xs` is set. |
|
|
664
|
+
| `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
665
|
+
| `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
|
|
666
|
+
| `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
667
|
+
| `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
|
|
668
|
+
| `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
669
|
+
| `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
|
|
670
|
+
| `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
671
|
+
| `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
|
|
672
|
+
| `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
646
673
|
| `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
|
|
647
674
|
| `label.colon` | boolean | `true` | Append label with colon. |
|
|
648
675
|
| `label.extra` | string | - | Extra text to display beneath the content - supports html. |
|
|
649
676
|
| `label.title` | string | - | Label title - supports html. |
|
|
650
677
|
| `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. |
|
|
651
678
|
| `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
|
|
652
|
-
| `label.tooltip.icon` | string | `"
|
|
679
|
+
| `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`. |
|
|
653
680
|
| `label.tooltip.color` | string | - | Color of the tooltip icon. |
|
|
654
|
-
| `label.span` | number | - | Label inline
|
|
681
|
+
| `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. |
|
|
655
682
|
| `label.disabled` | boolean | `false` | Hide input label. |
|
|
656
683
|
| `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
|
|
657
684
|
| `label.inline` | boolean | `false` | Render input and label inline. |
|
|
685
|
+
| `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
|
|
658
686
|
| `maxLength` | integer | - | The max number of input characters. |
|
|
659
687
|
| `placeholder` | string | - | Placeholder text inside the block before user types input. |
|
|
660
688
|
| `rows` | integer | - | Number of rows in the block, should be greater or equal to 1. Defining rows disables any prefix. |
|
|
661
689
|
| `size` | string | `"middle"` | Size of the block. Enum: `small`, `middle`, `large`. |
|
|
662
690
|
| `showCount` | boolean \| object | `false` | Show input character count. |
|
|
663
691
|
| `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
|
|
664
|
-
| `variant` | string | - | Input visual variant.
|
|
692
|
+
| `variant` | string | - | Input visual variant. The deprecated bordered: false takes precedence and renders the input as 'borderless'. Enum: `outlined`, `filled`, `borderless`, `underlined`. |
|
|
665
693
|
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design input tokens](https://ant.design/components/input#design-token). |
|
|
666
694
|
| `theme.activeBorderColor` | string | - | Border color when the input is active/focused. |
|
|
667
695
|
| `theme.hoverBorderColor` | string | - | Border color when the input is hovered. |
|
|
@@ -699,6 +727,7 @@ Multi-line text input with auto-sizing, character count, and clear button.
|
|
|
699
727
|
| --- | --- | --- |
|
|
700
728
|
| `onBlur` | \- | Trigger action event occurs when text input loses focus. |
|
|
701
729
|
| `onChange` | `{ value }` | Trigger action when text input is changed. |
|
|
730
|
+
| `onClear` | \- | Trigger action when the clear button is clicked. |
|
|
702
731
|
| `onFocus` | \- | Trigger action when text input gets focus. |
|
|
703
732
|
| `onPressEnter` | \- | Trigger action when enter is pressed while text input is focused. |
|
|
704
733
|
| `onTooltipClick` | \- | Trigger actions when the tooltip icon is clicked. |
|
|
@@ -65,6 +65,12 @@ Single-line text input with sizes, prefix/suffix icons, character count, and cle
|
|
|
65
65
|
title: Borderless
|
|
66
66
|
variant: borderless
|
|
67
67
|
placeholder: Borderless variant
|
|
68
|
+
- id: variant_underlined
|
|
69
|
+
type: TextInput
|
|
70
|
+
properties:
|
|
71
|
+
title: Underlined
|
|
72
|
+
variant: underlined
|
|
73
|
+
placeholder: Underlined variant
|
|
68
74
|
```
|
|
69
75
|
|
|
70
76
|
```yaml
|
|
@@ -79,28 +85,28 @@ Single-line text input with sizes, prefix/suffix icons, character count, and cle
|
|
|
79
85
|
properties:
|
|
80
86
|
title: Email
|
|
81
87
|
type: email
|
|
82
|
-
prefixIcon:
|
|
88
|
+
prefixIcon: mail
|
|
83
89
|
placeholder: user@example.com
|
|
84
90
|
- id: type_password
|
|
85
91
|
type: TextInput
|
|
86
92
|
properties:
|
|
87
93
|
title: Password
|
|
88
94
|
type: password
|
|
89
|
-
prefixIcon:
|
|
95
|
+
prefixIcon: lock
|
|
90
96
|
placeholder: Enter password
|
|
91
97
|
- id: type_tel
|
|
92
98
|
type: TextInput
|
|
93
99
|
properties:
|
|
94
100
|
title: Telephone
|
|
95
101
|
type: tel
|
|
96
|
-
prefixIcon:
|
|
102
|
+
prefixIcon: phone
|
|
97
103
|
placeholder: +1 (555) 123-4567
|
|
98
104
|
- id: type_url
|
|
99
105
|
type: TextInput
|
|
100
106
|
properties:
|
|
101
107
|
title: URL
|
|
102
108
|
type: url
|
|
103
|
-
prefixIcon:
|
|
109
|
+
prefixIcon: globe
|
|
104
110
|
placeholder: https://example.com
|
|
105
111
|
```
|
|
106
112
|
|
|
@@ -128,13 +134,13 @@ Single-line text input with sizes, prefix/suffix icons, character count, and cle
|
|
|
128
134
|
type: TextInput
|
|
129
135
|
properties:
|
|
130
136
|
title: Prefix Icon
|
|
131
|
-
prefixIcon:
|
|
137
|
+
prefixIcon: user
|
|
132
138
|
placeholder: Enter username
|
|
133
139
|
- id: adorn_suffix_icon
|
|
134
140
|
type: TextInput
|
|
135
141
|
properties:
|
|
136
142
|
title: Suffix Icon
|
|
137
|
-
suffixIcon:
|
|
143
|
+
suffixIcon: info
|
|
138
144
|
placeholder: Enter value
|
|
139
145
|
```
|
|
140
146
|
|
|
@@ -144,21 +150,21 @@ Single-line text input with sizes, prefix/suffix icons, character count, and cle
|
|
|
144
150
|
properties:
|
|
145
151
|
title: Custom Color Icon
|
|
146
152
|
prefixIcon:
|
|
147
|
-
name:
|
|
153
|
+
name: user
|
|
148
154
|
color: "#1677ff"
|
|
149
155
|
placeholder: Blue user icon
|
|
150
156
|
- id: icon_both_custom
|
|
151
157
|
type: TextInput
|
|
152
158
|
properties:
|
|
153
159
|
title: Both Icons
|
|
154
|
-
prefixIcon:
|
|
155
|
-
suffixIcon:
|
|
160
|
+
prefixIcon: link
|
|
161
|
+
suffixIcon: arrow-right
|
|
156
162
|
placeholder: Enter link
|
|
157
163
|
- id: icon_mixed
|
|
158
164
|
type: TextInput
|
|
159
165
|
properties:
|
|
160
166
|
title: Icon Prefix + Text Suffix
|
|
161
|
-
prefixIcon:
|
|
167
|
+
prefixIcon: globe
|
|
162
168
|
suffix: .com
|
|
163
169
|
placeholder: domain
|
|
164
170
|
```
|
|
@@ -180,7 +186,7 @@ Single-line text input with sizes, prefix/suffix icons, character count, and cle
|
|
|
180
186
|
properties:
|
|
181
187
|
title: Allow Clear + Prefix Icon
|
|
182
188
|
allowClear: true
|
|
183
|
-
prefixIcon:
|
|
189
|
+
prefixIcon: user
|
|
184
190
|
events:
|
|
185
191
|
onMount:
|
|
186
192
|
- id: set_default
|
|
@@ -308,7 +314,7 @@ Single-line text input with sizes, prefix/suffix icons, character count, and cle
|
|
|
308
314
|
properties:
|
|
309
315
|
title: Disabled (With Prefix)
|
|
310
316
|
disabled: true
|
|
311
|
-
prefixIcon:
|
|
317
|
+
prefixIcon: user
|
|
312
318
|
events:
|
|
313
319
|
onMount:
|
|
314
320
|
- id: set_default
|
|
@@ -349,7 +355,7 @@ Single-line text input with sizes, prefix/suffix icons, character count, and cle
|
|
|
349
355
|
title: Fully Customized
|
|
350
356
|
placeholder: Orange theme via style
|
|
351
357
|
prefixIcon:
|
|
352
|
-
name:
|
|
358
|
+
name: star
|
|
353
359
|
color: "#fa8c16"
|
|
354
360
|
```
|
|
355
361
|
|
|
@@ -366,7 +372,7 @@ Single-line text input with sizes, prefix/suffix icons, character count, and cle
|
|
|
366
372
|
properties:
|
|
367
373
|
title: Green Theme
|
|
368
374
|
placeholder: Custom green colors
|
|
369
|
-
prefixIcon:
|
|
375
|
+
prefixIcon: check
|
|
370
376
|
theme:
|
|
371
377
|
colorPrimary: "#52c41a"
|
|
372
378
|
colorBorder: "#b7eb8f"
|
|
@@ -379,7 +385,7 @@ Single-line text input with sizes, prefix/suffix icons, character count, and cle
|
|
|
379
385
|
properties:
|
|
380
386
|
title: Purple Theme
|
|
381
387
|
placeholder: Custom purple colors
|
|
382
|
-
prefixIcon:
|
|
388
|
+
prefixIcon: star
|
|
383
389
|
theme:
|
|
384
390
|
colorPrimary: "#722ed1"
|
|
385
391
|
colorBorder: "#d3adf7"
|
|
@@ -405,7 +411,7 @@ Single-line text input with sizes, prefix/suffix icons, character count, and cle
|
|
|
405
411
|
required: true
|
|
406
412
|
properties:
|
|
407
413
|
title: Full Name
|
|
408
|
-
prefixIcon:
|
|
414
|
+
prefixIcon: user
|
|
409
415
|
placeholder: John Doe
|
|
410
416
|
label:
|
|
411
417
|
colon: false
|
|
@@ -415,7 +421,7 @@ Single-line text input with sizes, prefix/suffix icons, character count, and cle
|
|
|
415
421
|
properties:
|
|
416
422
|
title: Email Address
|
|
417
423
|
type: email
|
|
418
|
-
prefixIcon:
|
|
424
|
+
prefixIcon: mail
|
|
419
425
|
placeholder: john@example.com
|
|
420
426
|
label:
|
|
421
427
|
colon: false
|
|
@@ -426,7 +432,7 @@ Single-line text input with sizes, prefix/suffix icons, character count, and cle
|
|
|
426
432
|
properties:
|
|
427
433
|
title: Password
|
|
428
434
|
type: password
|
|
429
|
-
prefixIcon:
|
|
435
|
+
prefixIcon: lock
|
|
430
436
|
placeholder: At least 8 characters
|
|
431
437
|
showCount: true
|
|
432
438
|
maxLength: 64
|
|
@@ -478,7 +484,7 @@ Single-line text input with sizes, prefix/suffix icons, character count, and cle
|
|
|
478
484
|
title: Create Account
|
|
479
485
|
color: primary
|
|
480
486
|
variant: solid
|
|
481
|
-
icon:
|
|
487
|
+
icon: arrow-right
|
|
482
488
|
events:
|
|
483
489
|
onClick:
|
|
484
490
|
- id: submit_validate
|
|
@@ -499,7 +505,7 @@ Single-line text input with sizes, prefix/suffix icons, character count, and cle
|
|
|
499
505
|
- id: search_bar
|
|
500
506
|
type: TextInput
|
|
501
507
|
properties:
|
|
502
|
-
prefixIcon:
|
|
508
|
+
prefixIcon: search
|
|
503
509
|
allowClear: true
|
|
504
510
|
placeholder: Search products, categories, or brands...
|
|
505
511
|
size: large
|
|
@@ -552,37 +558,68 @@ Single-line text input with sizes, prefix/suffix icons, character count, and cle
|
|
|
552
558
|
| Property | Type | Default | Description |
|
|
553
559
|
| --- | --- | --- | --- |
|
|
554
560
|
| `allowClear` | boolean | `false` | Allow the user to clear their input. |
|
|
555
|
-
| `type` | string | `"text"` | The type of input, (see MDN). Enum: `text`, `number`, `password`, `tel`, `email`, `url`. |
|
|
561
|
+
| `type` | string | `"text"` | The type of input, (see [MDN](https://developer.mozilla.org/docs/Web/HTML/Element/input#Form_%3Cinput%3E_types)). Enum: `text`, `number`, `password`, `tel`, `email`, `url`. |
|
|
556
562
|
| `autoFocus` | boolean | `false` | Autofocus to the block on page load. |
|
|
557
563
|
| `bordered` | boolean | `true` | Whether or not the text input has a border style. |
|
|
558
564
|
| `disabled` | boolean | `false` | Disable the block if true. |
|
|
559
565
|
| `maxLength` | integer | - | The max number of input characters. |
|
|
560
566
|
| `placeholder` | string | - | Placeholder text inside the block before user types input. |
|
|
561
|
-
| `prefix` | string | - | Prefix text for the block, priority over
|
|
562
|
-
| `prefixIcon` | string \| object | - |
|
|
567
|
+
| `prefix` | string | - | Prefix text for the block, priority over prefixIcon. |
|
|
568
|
+
| `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 to prefix the text input. |
|
|
569
|
+
| `prefixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
570
|
+
| `prefixIcon.color` | string | - | Icon color. |
|
|
571
|
+
| `prefixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
572
|
+
| `prefixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
573
|
+
| `prefixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
574
|
+
| `prefixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
575
|
+
| `prefixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
576
|
+
| `prefixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
577
|
+
| `prefixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
563
578
|
| `label` | object | - | Label properties. |
|
|
579
|
+
| `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
|
|
580
|
+
| `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
581
|
+
| `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. |
|
|
582
|
+
| `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
583
|
+
| `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
|
|
584
|
+
| `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
585
|
+
| `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
|
|
586
|
+
| `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
587
|
+
| `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
|
|
588
|
+
| `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
589
|
+
| `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
|
|
590
|
+
| `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
564
591
|
| `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
|
|
565
592
|
| `label.colon` | boolean | `true` | Append label with colon. |
|
|
566
593
|
| `label.extra` | string | - | Extra text to display beneath the content - supports html. |
|
|
567
594
|
| `label.title` | string | - | Label title - supports html. |
|
|
568
595
|
| `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. |
|
|
569
596
|
| `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
|
|
570
|
-
| `label.tooltip.icon` | string | `"
|
|
597
|
+
| `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`. |
|
|
571
598
|
| `label.tooltip.color` | string | - | Color of the tooltip icon. |
|
|
572
|
-
| `label.span` | number | - | Label inline
|
|
599
|
+
| `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. |
|
|
573
600
|
| `label.disabled` | boolean | `false` | Hide input label. |
|
|
574
601
|
| `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
|
|
575
602
|
| `label.inline` | boolean | `false` | Render input and label inline. |
|
|
603
|
+
| `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
|
|
576
604
|
| `replaceInput` | object | - | Regex used to sanitize input. |
|
|
577
605
|
| `replaceInput.pattern` | string | - | The regular expression pattern to use to sanitize input. |
|
|
578
606
|
| `replaceInput.flags` | string | - | The regex flags to use. The default value is 'gm'. |
|
|
579
607
|
| `replaceInput.replacement` | string | - | The string used to replace the input that matches the pattern. The default value is ''. |
|
|
580
608
|
| `size` | string | `"middle"` | Size of the block. Enum: `small`, `middle`, `large`. |
|
|
581
|
-
| `showCount` | boolean | `false` | Show text character count |
|
|
582
|
-
| `suffix` | string | - | Suffix text for the block,
|
|
583
|
-
| `suffixIcon` | string \| object | - |
|
|
609
|
+
| `showCount` | boolean | `false` | Show text character count. |
|
|
610
|
+
| `suffix` | string | - | Suffix text for the block, shown before suffixIcon. |
|
|
611
|
+
| `suffixIcon` | 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 to suffix the text input. |
|
|
612
|
+
| `suffixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
613
|
+
| `suffixIcon.color` | string | - | Icon color. |
|
|
614
|
+
| `suffixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
615
|
+
| `suffixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
616
|
+
| `suffixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
617
|
+
| `suffixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
618
|
+
| `suffixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
619
|
+
| `suffixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
620
|
+
| `suffixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
584
621
|
| `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
|
|
585
|
-
| `variant` | string | - | Input visual variant.
|
|
622
|
+
| `variant` | string | - | Input visual variant. The deprecated bordered: false takes precedence and renders the input as 'borderless'. Enum: `outlined`, `filled`, `borderless`, `underlined`. |
|
|
586
623
|
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design input tokens](https://ant.design/components/input#design-token). |
|
|
587
624
|
| `theme.activeBorderColor` | string | - | Border color when the input is focused. |
|
|
588
625
|
| `theme.activeShadow` | string | - | Box shadow when the input is focused. |
|
|
@@ -609,6 +646,9 @@ Single-line text input with sizes, prefix/suffix icons, character count, and cle
|
|
|
609
646
|
| `theme.hoverBorderColor` | string | - | Border color when the input is hovered. |
|
|
610
647
|
| `theme.hoverBg` | string | - | Background color when the input is hovered. |
|
|
611
648
|
| `theme.activeBg` | string | - | Background color when the input is focused. |
|
|
649
|
+
| `theme.inputFontSize` | number | `14` | Font size of the input text. |
|
|
650
|
+
| `theme.inputFontSizeLG` | number | `16` | Font size of the input text for large inputs. |
|
|
651
|
+
| `theme.inputFontSizeSM` | number | `14` | Font size of the input text for small inputs. |
|
|
612
652
|
| `theme.lineWidth` | number | `1` | Border width. |
|
|
613
653
|
| `theme.paddingBlock` | number | `4` | Vertical padding. |
|
|
614
654
|
| `theme.paddingBlockLG` | number | `7` | Vertical padding for large inputs. |
|
|
@@ -622,6 +662,7 @@ Single-line text input with sizes, prefix/suffix icons, character count, and cle
|
|
|
622
662
|
| --- | --- | --- |
|
|
623
663
|
| `onBlur` | \- | Trigger action event occurs when text input loses focus. |
|
|
624
664
|
| `onChange` | `{ value }` | Trigger action when text input is changed. |
|
|
665
|
+
| `onClear` | \- | Trigger action when the clear button is clicked. |
|
|
625
666
|
| `onFocus` | \- | Trigger action when text input gets focus. |
|
|
626
667
|
| `onPressEnter` | \- | Trigger action when enter is pressed while text input is focused. |
|
|
627
668
|
| `onTooltipClick` | \- | Trigger actions when the tooltip icon is clicked. |
|
|
@@ -209,7 +209,7 @@ Rich-text editor built on TipTap. Supports bold, italic, strike-through, highlig
|
|
|
209
209
|
| `rows` | integer | - | Fix the editor height to exactly this many rows. Takes precedence over autoSize. |
|
|
210
210
|
| `downloadPolicyRequestId` | string | - | Id of a download request (e.g. AwsS3PresignedGetObject) used to resolve the inserted image URL after upload. Inline images persist in saved content, so the request should set public: true (and the upload request the provider public-read acl) to return a stable, non-expiring URL. When unset, a legacy unsigned object URL is constructed from the upload response (S3-shaped, deprecated). |
|
|
211
211
|
| `s3PostPolicyRequestId` | string | - | Deprecated — use uploadPolicyRequestId instead. |
|
|
212
|
-
| `uploadPolicyRequestId` | string | - | Id of an upload-policy request (e.g. AwsS3PresignedPostPolicy, GcsSignedPostPolicy, AzureBlobUploadSas). When set, images dragged or pasted into the editor are uploaded via that request and inserted as
|
|
212
|
+
| `uploadPolicyRequestId` | string | - | Id of an upload-policy request (e.g. AwsS3PresignedPostPolicy, GcsSignedPostPolicy, AzureBlobUploadSas). When set, images dragged or pasted into the editor are uploaded via that request and inserted as <img> nodes. Leave unset to disable image uploads. |
|
|
213
213
|
| `size` | string | - | Label size forwarded to the Label block. Enum: `small`, `middle`, `large`. |
|
|
214
214
|
| `starterKit` | object | - | Options forwarded to TipTap StarterKit (https://tiptap.dev/docs/editor/extensions/functionality/starterkit). Use this to disable bundled extensions (e.g. {heading: false, codeBlock: false}). |
|
|
215
215
|
| `table` | object | - | Table extension settings. |
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# TiptapMentionInput
|
|
2
2
|
|
|
3
|
-
Rich-text editor with @-mention support. Same feature set as TiptapInput, plus a mention dropdown populated from a static options list or a request. Mention options can be marked as groups (roles, teams, queues) to render under their own menu section, as distinctly coloured chips, and with a hover popover listing the group
|
|
3
|
+
Rich-text editor with @-mention support. Same feature set as TiptapInput, plus a mention dropdown populated from a static options list or a request. Mention options can be marked as groups (roles, teams, queues) to render under their own menu section, as distinctly coloured chips, and with a hover popover listing the group's current members. See the guide below.
|
|
4
4
|
|
|
5
5
|
## Group mentions
|
|
6
6
|
|
|
@@ -446,7 +446,7 @@ A mixed `options` array — people alongside group options carrying `tag.section
|
|
|
446
446
|
| `mentions.char` | string | `"@"` | Trigger character that opens the mention dropdown. Change to "#" for hashtags, etc. |
|
|
447
447
|
| `mentions.allowSpaces` | boolean | `true` | Allow spaces inside a mention query before it is committed. |
|
|
448
448
|
| `mentions.options` | array | - | Array of mention items. Each item may be a string, or an object with a "label" (matched against user input) and a "value" (stored on the node). |
|
|
449
|
-
| `mentions.getHref` | object | - | Optional _function that receives the selected mention option and returns an href. A non-nullish return renders the mention as an ; a nullish return renders a plain
|
|
449
|
+
| `mentions.getHref` | object | - | Optional _function that receives the selected mention option and returns an href. A non-nullish return renders the mention as an <a>; a nullish return renders a plain <span> (use this for options with no link, e.g. group mentions). |
|
|
450
450
|
| `mentions.limit` | integer | `5` | Maximum suggestions shown — per section when options declare sections, otherwise across the flat list. |
|
|
451
451
|
| `mentions.groupMembers` | object | - | Map of group key → array of { name, email } shown in a hover popover on that group's chips (live editor only). |
|
|
452
452
|
| `mentionsRequestId` | string | - | Id of a request used to populate mention options. When set, the block registers a __getTipTapMentions event that calls that request. |
|