@lowdefy/docs-content 6.0.0 → 7.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -0
- package/content/actions/downloadcsv.md +1 -1
- package/content/actions/emailotpsend.md +58 -0
- package/content/actions/emailotpverify.md +79 -0
- package/content/actions/getlocalstorage.md +43 -0
- package/content/actions/link.md +47 -1
- package/content/actions/login.md +25 -5
- package/content/actions/logout.md +7 -5
- package/content/actions/magiclinkverify.md +117 -0
- package/content/actions/pdfmake.md +2 -2
- package/content/actions/posthogalias.md +29 -0
- package/content/actions/posthogcapture.md +49 -0
- package/content/actions/posthogcapturepageleave.md +38 -0
- package/content/actions/posthogfeatureflag.md +50 -0
- package/content/actions/posthoggroup.md +37 -0
- package/content/actions/posthogidentify.md +54 -0
- package/content/actions/posthoginit.md +96 -0
- package/content/actions/posthogoptin.md +29 -0
- package/content/actions/posthogoptout.md +29 -0
- package/content/actions/posthogpageview.md +37 -0
- package/content/actions/posthogreloadfeatureflags.md +47 -0
- package/content/actions/posthogreset.md +28 -0
- package/content/actions/posthogsetpersonproperties.md +36 -0
- package/content/actions/removelocalstorage.md +28 -0
- package/content/actions/resetvalidation.md +5 -3
- package/content/actions/setdarkmode.md +3 -3
- package/content/actions/setglobal.md +2 -0
- package/content/actions/setlocale.md +1 -1
- package/content/actions/setlocalstorage.md +34 -0
- package/content/actions/setstate.md +2 -0
- package/content/actions/validate.md +7 -4
- package/content/adapter-reference/mongodbauthadapter.md +46 -0
- package/content/agents/agent-endpoint-tools.md +24 -0
- package/content/agents/agent-properties.md +13 -3
- package/content/agents/agent-server-hooks.md +1 -1
- package/content/agents/agentchat.md +41 -4
- package/content/agents/agentconversations.md +42 -8
- package/content/agents/agents-introduction.md +107 -0
- package/content/callback-reference/auth0logoutcallback.md +54 -0
- package/content/concepts/ai-agent-docs.md +455 -106
- package/content/concepts/blocks.md +150 -0
- package/content/concepts/connections-and-requests.md +402 -0
- package/content/concepts/custom-html.md +42 -0
- package/content/concepts/custom-styling.md +50 -5
- package/content/concepts/dynamic-page-content.md +309 -0
- package/content/concepts/events-and-actions.md +185 -2
- package/content/concepts/four-primitives.md +31 -0
- package/content/concepts/html-attributes.md +293 -0
- package/content/concepts/i18n.md +12 -3
- package/content/concepts/keyboard-shortcuts.md +2 -2
- package/content/concepts/layout-overview.md +1 -1
- package/content/concepts/logger.md +99 -0
- package/content/concepts/lowdefy-api.md +1319 -0
- package/content/concepts/lowdefy-schema.md +144 -3
- package/content/concepts/menus.md +8 -7
- package/content/concepts/module-authoring.md +76 -5
- package/content/concepts/modules.md +3 -1
- package/content/concepts/notifications.md +180 -0
- package/content/concepts/operators.md +7 -0
- package/content/concepts/page-and-app-state.md +252 -0
- package/content/concepts/page-paths.md +209 -0
- package/content/concepts/theming.md +582 -0
- package/content/connections/aigateway.md +375 -0
- package/content/connections/anthropic.md +169 -2
- package/content/connections/awss3.md +178 -2
- package/content/connections/axioshttp.md +181 -0
- package/content/connections/google.md +169 -2
- package/content/connections/mongodb.md +1014 -3
- package/content/connections/openai-connection.md +169 -2
- package/content/connections/sendgridmail.md +3 -0
- package/content/connections/smtp.md +16 -0
- package/content/connections/treg.md +329 -0
- package/content/container-blocks/affix.md +47 -7
- package/content/container-blocks/alert.md +76 -24
- package/content/container-blocks/badge.md +100 -24
- package/content/container-blocks/box.md +9 -9
- package/content/container-blocks/card.md +132 -27
- package/content/container-blocks/carousel.md +60 -7
- package/content/container-blocks/collapse.md +153 -9
- package/content/container-blocks/configprovider.md +35 -13
- package/content/container-blocks/confirmmodal.md +69 -23
- package/content/container-blocks/content.md +62 -98
- package/content/container-blocks/descriptions.md +45 -4
- package/content/container-blocks/drawer.md +139 -28
- package/content/container-blocks/dropdownmenu.md +119 -31
- package/content/container-blocks/flex.md +40 -62
- package/content/container-blocks/footer.md +15 -11
- package/content/container-blocks/googlemapsheatmap.md +1 -1
- package/content/container-blocks/googlemapsscript.md +2 -2
- package/content/container-blocks/header.md +71 -36
- package/content/container-blocks/label.md +34 -7
- package/content/container-blocks/layout.md +52 -34
- package/content/container-blocks/masonry.md +17 -71
- package/content/container-blocks/mobilemenu.md +131 -88
- package/content/container-blocks/modal.md +161 -26
- package/content/container-blocks/pageheadermenu.md +138 -31
- package/content/container-blocks/pagesidebarlayout.md +230 -27
- package/content/container-blocks/pagesidermenu.md +153 -43
- package/content/container-blocks/popover.md +34 -31
- package/content/container-blocks/result.md +32 -21
- package/content/container-blocks/sider.md +85 -122
- package/content/container-blocks/span.md +7 -7
- package/content/container-blocks/spinner.md +3 -3
- package/content/container-blocks/splitter.md +150 -68
- package/content/container-blocks/tabs.md +64 -12
- package/content/container-blocks/tooltip.md +22 -46
- package/content/container-blocks/watermark.md +22 -4
- package/content/controls/parallel_for.md +21 -2
- package/content/controls/reject.md +26 -3
- package/content/controls/return.md +17 -1
- package/content/controls/throw.md +30 -2
- package/content/controls/try.md +24 -2
- package/content/controls/while.md +46 -0
- package/content/deployment/deployment-environments.md +146 -0
- package/content/deployment/docker.md +23 -7
- package/content/deployment/node-server.md +4 -0
- package/content/deployment/vercel.md +25 -19
- package/content/display-blocks/aggrid.md +33 -16
- package/content/display-blocks/anchor.md +16 -15
- package/content/display-blocks/avatar.md +57 -37
- package/content/display-blocks/breadcrumb.md +70 -21
- package/content/display-blocks/button.md +93 -19
- package/content/display-blocks/calendar.md +12 -0
- package/content/display-blocks/clickablehtml.md +239 -0
- package/content/display-blocks/dangeroushtml.md +1 -1
- package/content/display-blocks/difflist.md +1 -1
- package/content/display-blocks/difftimeline.md +1 -1
- package/content/display-blocks/divider.md +64 -3
- package/content/display-blocks/dropdownbutton.md +81 -30
- package/content/display-blocks/echart.md +35 -1
- package/content/display-blocks/eventlog.md +363 -0
- package/content/display-blocks/floatbutton.md +129 -42
- package/content/display-blocks/html.md +61 -1
- package/content/display-blocks/icon.md +250 -67
- package/content/display-blocks/img.md +2 -2
- package/content/display-blocks/menu.md +146 -73
- package/content/display-blocks/message.md +38 -124
- package/content/display-blocks/notification.md +94 -222
- package/content/display-blocks/paragraph.md +59 -9
- package/content/display-blocks/pollingtimer.md +263 -0
- package/content/display-blocks/progress.md +96 -17
- package/content/display-blocks/qrcode.md +19 -4
- package/content/display-blocks/s3download.md +1 -1
- package/content/display-blocks/search.md +19 -9
- package/content/display-blocks/skeletonbutton.md +1 -0
- package/content/display-blocks/skeletoninput.md +1 -0
- package/content/display-blocks/statistic.md +75 -17
- package/content/display-blocks/steps.md +58 -25
- package/content/display-blocks/table.md +2527 -0
- package/content/display-blocks/tablelight.md +621 -0
- package/content/display-blocks/tag.md +102 -17
- package/content/display-blocks/title.md +50 -11
- package/content/display-blocks/tour.md +33 -23
- package/content/input-blocks/autocomplete.md +81 -9
- package/content/input-blocks/buttonselector.md +45 -8
- package/content/input-blocks/captcha.md +40 -0
- package/content/input-blocks/checkboxselector.md +97 -7
- package/content/input-blocks/checkboxswitch.md +33 -3
- package/content/input-blocks/colorselector.md +63 -14
- package/content/input-blocks/daterangeselector.md +165 -45
- package/content/input-blocks/dateselector.md +139 -41
- package/content/input-blocks/datetimeselector.md +158 -49
- package/content/input-blocks/inputgallery.md +3 -3
- package/content/input-blocks/intentinput.md +207 -0
- package/content/input-blocks/monthselector.md +120 -52
- package/content/input-blocks/multipleselector.md +150 -39
- package/content/input-blocks/numberinput.md +98 -12
- package/content/input-blocks/pagination.md +70 -14
- package/content/input-blocks/paragraphinput.md +51 -37
- package/content/input-blocks/passwordinput.md +60 -6
- package/content/input-blocks/phonenumberinput.md +59 -26
- package/content/input-blocks/placesautocomplete.md +319 -0
- package/content/input-blocks/radioselector.md +83 -7
- package/content/input-blocks/ratingslider.md +57 -26
- package/content/input-blocks/s3uploadbutton.md +24 -24
- package/content/input-blocks/s3uploaddragger.md +3 -3
- package/content/input-blocks/s3uploadphoto.md +5 -5
- package/content/input-blocks/segmentedselector.md +72 -32
- package/content/input-blocks/selector.md +109 -21
- package/content/input-blocks/switch.md +65 -17
- package/content/input-blocks/tableinput.md +445 -0
- package/content/input-blocks/tagmultipleselector.md +114 -0
- package/content/input-blocks/tagselector.md +114 -0
- package/content/input-blocks/textarea.md +32 -3
- package/content/input-blocks/textinput.md +70 -29
- package/content/input-blocks/tiptapinput.md +1 -1
- package/content/input-blocks/tiptapmentioninput.md +2 -2
- package/content/input-blocks/titleinput.md +39 -12
- package/content/input-blocks/treeinput.md +49 -25
- package/content/input-blocks/treemultipleselector.md +127 -10
- package/content/input-blocks/treeselector.md +97 -9
- package/content/input-blocks/upload.md +64 -15
- package/content/input-blocks/uploaddragger.md +17 -1
- package/content/input-blocks/uploadphoto.md +18 -1
- package/content/input-blocks/weekselector.md +120 -55
- package/content/learn/introduction.md +27 -0
- package/content/learn/quickstart.md +53 -0
- package/content/learn/showcase.md +8 -0
- package/content/list-blocks/controlledlist.md +24 -15
- package/content/list-blocks/list.md +11 -11
- package/content/list-blocks/masonrylist.md +7 -34
- package/content/migration/auth-upgrade.md +337 -0
- package/content/migration/upgrade-guide.md +1 -0
- package/content/migration/v3-to-v4.md +417 -0
- package/content/migration/v6-to-v7.md +620 -0
- package/content/operators/_agent.md +155 -0
- package/content/operators/_app.md +2 -1
- package/content/operators/_array.md +122 -1
- package/content/operators/_build.md +1 -0
- package/content/operators/_credential.md +57 -0
- package/content/operators/_cron.md +292 -0
- package/content/operators/_date.md +2 -0
- package/content/operators/_error.md +196 -0
- package/content/operators/_get.md +6 -6
- package/content/operators/_hmac.md +78 -0
- package/content/operators/_js.md +2 -1
- package/content/operators/_location.md +1 -1
- package/content/operators/_media.md +13 -0
- package/content/operators/_module.md +56 -2
- package/content/operators/_operator.md +17 -3
- package/content/operators/_path_params.md +82 -0
- package/content/operators/_ref.md +258 -0
- package/content/operators/_request.md +1 -1
- package/content/operators/_request_details.md +6 -0
- package/content/operators/_type.md +14 -3
- package/content/operators/_url_query.md +2 -0
- package/content/operators/_user.md +3 -3
- package/content/plugins/plugins-actions.md +10 -0
- package/content/plugins/plugins-connections.md +25 -0
- package/content/plugins/plugins-dev.md +66 -0
- package/content/plugins/plugins-icon-sets.md +267 -0
- package/content/plugins/plugins-introduction.md +27 -1
- package/content/plugins/plugins.md +19 -0
- package/content/plugins/posthog.md +359 -0
- package/content/provider-reference/auth-js-providers.md +107 -0
- package/content/provider-reference/openidconnectprovider.md +44 -0
- package/content/recipes/recipes.md +16 -0
- package/content/reference/actions-reference.md +31 -0
- package/content/reference/blocks-reference.md +35 -0
- package/content/reference/cli.md +403 -0
- package/content/reference/connections-reference.md +23 -0
- package/content/reference/operators-reference.md +47 -0
- package/content/reference/reference.md +16 -0
- package/content/reference/schema-reference.md +12 -0
- package/content/testing/config-tests.md +677 -0
- package/content/testing/e2e-configuration.md +31 -1
- package/content/testing/e2e-getting-started.md +1 -1
- package/content/testing/e2e-introduction.md +1 -1
- package/content/testing/e2e-writing-tests.md +12 -1
- package/content/testing/explore-pull-request.md +136 -0
- package/content/testing/journey-data-sets.md +326 -0
- package/content/tutorial/tutorial-actions-operators.md +2 -2
- package/content/tutorial/tutorial-add-blocks.md +2 -2
- package/content/tutorial/tutorial-create-page.md +48 -2
- package/content/tutorial/tutorial-display-data-page.md +3 -3
- package/content/tutorial/tutorial-requests-api.md +155 -0
- package/content/tutorial/tutorial-requests-sql.md +153 -0
- package/content/tutorial/tutorial-start.md +66 -1
- package/content/user-authentication/auth-configuration.md +267 -0
- package/content/user-authentication/auth-providers.md +24 -0
- package/content/user-authentication/auth-steps.md +141 -0
- package/content/user-authentication/login-and-logout.md +160 -8
- package/content/user-authentication/mcp-oauth.md +424 -0
- package/content/user-authentication/organizations.md +246 -0
- package/content/user-authentication/protected-pages-apis.md +97 -0
- package/content/user-authentication/roles.md +49 -0
- package/content/user-authentication/two-factor.md +229 -0
- package/content/user-authentication/user-object.md +58 -0
- package/content/user-authentication/users-introduction.md +8 -0
- package/content/websockets/websocket-publish.md +105 -0
- package/content/websockets/websocket-subscriptions.md +136 -0
- package/content/websockets/websockets-introduction.md +101 -0
- package/hazards.json +56 -0
- package/index.json +3472 -14
- package/package.json +10 -1
- package/scripts/extractAgentDocs.js +41 -30
- package/scripts/hashDocSources.js +38 -0
- package/scripts/isRedirectPage.js +26 -0
- package/scripts/recordSourceHashes.js +97 -0
- package/scripts/resolvePageSections.js +42 -0
- package/scripts/sectionKind.js +27 -0
- package/content/concepts/cli.md +0 -223
- package/content/other/introduction.md +0 -39
- package/content/other/next-auth-providers.md +0 -3
- /package/content/{other → actions}/updatesession.md +0 -0
|
@@ -91,6 +91,25 @@ Description list with configurable layout and columns.
|
|
|
91
91
|
value: 0.5 kg
|
|
92
92
|
- label: In Stock
|
|
93
93
|
value: 1,250 units
|
|
94
|
+
- id: size_medium
|
|
95
|
+
type: Descriptions
|
|
96
|
+
properties:
|
|
97
|
+
title: Medium Size
|
|
98
|
+
size: medium
|
|
99
|
+
bordered: true
|
|
100
|
+
items:
|
|
101
|
+
- label: Product
|
|
102
|
+
value: Widget Plus
|
|
103
|
+
- label: SKU
|
|
104
|
+
value: WGT-PLS-003
|
|
105
|
+
- label: Price
|
|
106
|
+
value: $34.99
|
|
107
|
+
- label: Category
|
|
108
|
+
value: Electronics
|
|
109
|
+
- label: Weight
|
|
110
|
+
value: 0.4 kg
|
|
111
|
+
- label: In Stock
|
|
112
|
+
value: 2,015 units
|
|
94
113
|
- id: size_small
|
|
95
114
|
type: Descriptions
|
|
96
115
|
properties:
|
|
@@ -304,6 +323,24 @@ Description list with configurable layout and columns.
|
|
|
304
323
|
value: Database connection pool exhausted. Increased max_connections from 100 to
|
|
305
324
|
250 and implemented connection retry logic with exponential backoff.
|
|
306
325
|
span: 3
|
|
326
|
+
- id: spanning_filled
|
|
327
|
+
type: Descriptions
|
|
328
|
+
properties:
|
|
329
|
+
title: Shipment
|
|
330
|
+
bordered: true
|
|
331
|
+
column: 3
|
|
332
|
+
items:
|
|
333
|
+
- label: Carrier
|
|
334
|
+
value: Road freight
|
|
335
|
+
- label: Tracking
|
|
336
|
+
value: Use span filled to take the rest of the row, whatever the column count.
|
|
337
|
+
span: filled
|
|
338
|
+
- label: Weight
|
|
339
|
+
value: 12 kg
|
|
340
|
+
- label: Pieces
|
|
341
|
+
value: 3
|
|
342
|
+
- label: Insured
|
|
343
|
+
value: Yes
|
|
307
344
|
```
|
|
308
345
|
|
|
309
346
|
```yaml
|
|
@@ -585,7 +622,7 @@ Description list with configurable layout and columns.
|
|
|
585
622
|
value: +1 (555) 444-7890
|
|
586
623
|
style:
|
|
587
624
|
.element:
|
|
588
|
-
border: 2px solid
|
|
625
|
+
border: "2px solid #1677ff"
|
|
589
626
|
borderRadius: 8px
|
|
590
627
|
padding: 4px
|
|
591
628
|
- id: css_label_content
|
|
@@ -828,9 +865,11 @@ Description list with configurable layout and columns.
|
|
|
828
865
|
| `column.md` | integer | - | The number of description items in a row for 'md' media size. |
|
|
829
866
|
| `column.lg` | integer | - | The number of description items in a row for 'lg' media size. |
|
|
830
867
|
| `column.xl` | integer | - | The number of description items in a row for 'xl' media size. |
|
|
868
|
+
| `column.xxl` | integer | - | The number of description items in a row for 'xxl' media size. |
|
|
869
|
+
| `column.xxxl` | integer | - | The number of description items in a row for 'xxxl' media size. |
|
|
831
870
|
| `itemOptions` | array | - | |
|
|
832
871
|
| `itemOptions.$.key` | string | - | Item key to which these settings should apply. |
|
|
833
|
-
| `itemOptions.$.span` | number \| object | - | Item span for this key. Can also be a function that receives item and index. |
|
|
872
|
+
| `itemOptions.$.span` | number \| string \| object | - | Item span for this key, or 'filled' to fill the rest of the row. Can also be a function that receives item and index. |
|
|
834
873
|
| `itemOptions.$.style` | object | - | Item css style for this key. Can also be a function that receives item and index. |
|
|
835
874
|
| `itemOptions.$.transformLabel` | object | - | Function to transform item key or label. Function receives arguments label, item and index. |
|
|
836
875
|
| `itemOptions.$.transformValue` | object | - | Function to transform item value. Function receives arguments value, item and index. |
|
|
@@ -839,10 +878,10 @@ Description list with configurable layout and columns.
|
|
|
839
878
|
| `items.$.labelStyle` | object | - | Customize label style. |
|
|
840
879
|
| `items.$.label` | string | - | Item label - supports html. |
|
|
841
880
|
| `items.$.value` | string \| number | - | Value of item - supports html. |
|
|
842
|
-
| `items.$.span` | integer | - | Number of columns for this item to span. |
|
|
881
|
+
| `items.$.span` | integer \| string \| object | - | Number of columns for this item to span. Set to 'filled' to fill the rest of the row, or an object of breakpoint spans like `{ xs: 1, md: 2 }`. |
|
|
843
882
|
| `items.$.style` | object | - | Css style object to applied to item. |
|
|
844
883
|
| `layout` | string | `"horizontal"` | Put values next to or below their labels. Enum: `horizontal`, `vertical`. |
|
|
845
|
-
| `size` | string | `"default"` | Size of the block. Enum: `default`, `small`. |
|
|
884
|
+
| `size` | string | `"default"` | Size of the block. `default` is the largest size. Enum: `default`, `medium`, `small`. |
|
|
846
885
|
| `title` | string | - | The title of the description block, placed at the top - supports html. |
|
|
847
886
|
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design descriptions tokens](https://ant.design/components/descriptions#design-token). |
|
|
848
887
|
| `theme.labelBg` | string | `"rgba(0, 0, 0, 0.02)"` | Background color for labels in bordered mode. |
|
|
@@ -862,6 +901,8 @@ No events defined.
|
|
|
862
901
|
| --- | --- |
|
|
863
902
|
| `/block` | Outer block wrapper (always available). |
|
|
864
903
|
| `/element` | The Descriptions element. |
|
|
904
|
+
| `/header` | The header row with the title and extra content. |
|
|
905
|
+
| `/title` | The Descriptions title. |
|
|
865
906
|
| `/content` | The Descriptions content. |
|
|
866
907
|
| `/label` | The Descriptions label. |
|
|
867
908
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Panel that slides in from the edge of the screen.
|
|
4
4
|
|
|
5
|
-
This is a basic drawer with a title and default settings. It opens from the right side with
|
|
5
|
+
This is a basic drawer with a title and default settings. It opens from the right side with the default width of 378px.
|
|
6
6
|
|
|
7
7
|
Click the X button or the mask area to close it.
|
|
8
8
|
|
|
@@ -33,7 +33,7 @@ Click the X button or the mask area to close it.
|
|
|
33
33
|
type: Paragraph
|
|
34
34
|
properties:
|
|
35
35
|
content: This is a basic drawer with a title and default settings. It opens from
|
|
36
|
-
the right side with
|
|
36
|
+
the right side with the default width of 378px.
|
|
37
37
|
- id: drawer_basic_p2
|
|
38
38
|
type: Paragraph
|
|
39
39
|
properties:
|
|
@@ -259,6 +259,52 @@ Using a percentage width makes the drawer responsive. This drawer takes up 60% o
|
|
|
259
259
|
up 60% of the viewport width.
|
|
260
260
|
```
|
|
261
261
|
|
|
262
|
+
```yaml
|
|
263
|
+
- id: drawer_padding_btn
|
|
264
|
+
type: Button
|
|
265
|
+
layout:
|
|
266
|
+
flex: 0 0 auto
|
|
267
|
+
properties:
|
|
268
|
+
title: Open Drawer with padding none
|
|
269
|
+
events:
|
|
270
|
+
onClick:
|
|
271
|
+
- id: drawer_padding_open
|
|
272
|
+
type: CallMethod
|
|
273
|
+
params:
|
|
274
|
+
blockId: drawer_padding
|
|
275
|
+
method: setOpen
|
|
276
|
+
args:
|
|
277
|
+
- open: true
|
|
278
|
+
- id: drawer_padding
|
|
279
|
+
type: Drawer
|
|
280
|
+
properties:
|
|
281
|
+
title: Recent invoices
|
|
282
|
+
padding: none
|
|
283
|
+
blocks:
|
|
284
|
+
- id: drawer_padding_rows
|
|
285
|
+
type: Html
|
|
286
|
+
properties:
|
|
287
|
+
html: >
|
|
288
|
+
<div style="display: flex; justify-content: space-between; padding:
|
|
289
|
+
8px 24px; border-bottom: 1px solid
|
|
290
|
+
var(--ant-color-border-secondary);"><span>INV-1042</span><span
|
|
291
|
+
style="color: var(--ant-color-text-secondary);">$1,280.00</span></div>
|
|
292
|
+
|
|
293
|
+
<div style="display: flex; justify-content: space-between; padding:
|
|
294
|
+
8px 24px; border-bottom: 1px solid
|
|
295
|
+
var(--ant-color-border-secondary);"><span>INV-1041</span><span
|
|
296
|
+
style="color: var(--ant-color-text-secondary);">$640.00</span></div>
|
|
297
|
+
|
|
298
|
+
<div style="display: flex; justify-content: space-between; padding:
|
|
299
|
+
8px 24px; border-bottom: 1px solid
|
|
300
|
+
var(--ant-color-border-secondary);"><span>INV-1040</span><span
|
|
301
|
+
style="color: var(--ant-color-text-secondary);">$2,115.50</span></div>
|
|
302
|
+
|
|
303
|
+
<div style="display: flex; justify-content: space-between; padding:
|
|
304
|
+
8px 24px;"><span>INV-1039</span><span style="color:
|
|
305
|
+
var(--ant-color-text-secondary);">$96.00</span></div>
|
|
306
|
+
```
|
|
307
|
+
|
|
262
308
|
The close button is visible in the top right corner. This is the default behavior.
|
|
263
309
|
|
|
264
310
|
The close (x) button is hidden. Users can still close by clicking the mask or pressing Escape.
|
|
@@ -432,6 +478,52 @@ The mask is visible but clicking it does not close the drawer. Users must use th
|
|
|
432
478
|
must use the close button or Escape key.
|
|
433
479
|
```
|
|
434
480
|
|
|
481
|
+
Drag the left edge to resize the drawer. The onResizeEnd event receives the new size, so it can be saved as a user preference.
|
|
482
|
+
|
|
483
|
+
```yaml
|
|
484
|
+
- id: drawer_resizable_trigger
|
|
485
|
+
type: Button
|
|
486
|
+
layout:
|
|
487
|
+
flex: 0 0 auto
|
|
488
|
+
properties:
|
|
489
|
+
title: Open Resizable Drawer
|
|
490
|
+
color: primary
|
|
491
|
+
variant: outlined
|
|
492
|
+
events:
|
|
493
|
+
onClick:
|
|
494
|
+
- id: drawer_resizable_open
|
|
495
|
+
type: CallMethod
|
|
496
|
+
params:
|
|
497
|
+
blockId: drawer_resizable
|
|
498
|
+
method: setOpen
|
|
499
|
+
args:
|
|
500
|
+
- open: true
|
|
501
|
+
- id: drawer_resizable
|
|
502
|
+
type: Drawer
|
|
503
|
+
properties:
|
|
504
|
+
title: Resizable Drawer
|
|
505
|
+
size: 480
|
|
506
|
+
resizable: true
|
|
507
|
+
maxSize: 900
|
|
508
|
+
closable:
|
|
509
|
+
placement: end
|
|
510
|
+
mask:
|
|
511
|
+
blur: true
|
|
512
|
+
events:
|
|
513
|
+
onResizeEnd:
|
|
514
|
+
- id: drawer_resizable_save_size
|
|
515
|
+
type: SetState
|
|
516
|
+
params:
|
|
517
|
+
drawer_size:
|
|
518
|
+
_event: size
|
|
519
|
+
blocks:
|
|
520
|
+
- id: drawer_resizable_p1
|
|
521
|
+
type: Paragraph
|
|
522
|
+
properties:
|
|
523
|
+
content: Drag the left edge to resize the drawer. The onResizeEnd event receives
|
|
524
|
+
the new size, so it can be saved as a user preference.
|
|
525
|
+
```
|
|
526
|
+
|
|
435
527
|
Pressing the Escape key closes this drawer. This is the default behavior.
|
|
436
528
|
|
|
437
529
|
Pressing Escape does not close this drawer. The user must click the close button or mask to dismiss.
|
|
@@ -682,7 +774,7 @@ This drawer uses the toggleOpen method. Each click of the button alternates betw
|
|
|
682
774
|
title: Toggle Drawer
|
|
683
775
|
color: primary
|
|
684
776
|
variant: solid
|
|
685
|
-
icon:
|
|
777
|
+
icon: menu
|
|
686
778
|
events:
|
|
687
779
|
onClick:
|
|
688
780
|
- id: drawer_toggle_call
|
|
@@ -790,8 +882,10 @@ This drawer uses style.header and style.body to apply custom background colors t
|
|
|
790
882
|
title: Styled Drawer
|
|
791
883
|
style:
|
|
792
884
|
.header:
|
|
793
|
-
|
|
794
|
-
|
|
885
|
+
backgroundColor: var(--ant-color-primary-bg)
|
|
886
|
+
borderBottom: 1px solid var(--ant-color-primary-border)
|
|
887
|
+
.body:
|
|
888
|
+
backgroundColor: var(--ant-color-fill-quaternary)
|
|
795
889
|
blocks:
|
|
796
890
|
- id: drawer_inline_style_content
|
|
797
891
|
type: Paragraph
|
|
@@ -829,8 +923,8 @@ The mask CSS key applies a backdrop blur effect, and the content CSS key adds ro
|
|
|
829
923
|
properties:
|
|
830
924
|
title: Tailwind CSS Keys
|
|
831
925
|
class:
|
|
832
|
-
header: bg-bg-layout
|
|
833
|
-
body: bg-bg-layout
|
|
926
|
+
.header: bg-bg-layout
|
|
927
|
+
.body: bg-bg-layout
|
|
834
928
|
blocks:
|
|
835
929
|
- id: drawer_css_keys_content
|
|
836
930
|
type: Paragraph
|
|
@@ -860,8 +954,8 @@ The mask CSS key applies a backdrop blur effect, and the content CSS key adds ro
|
|
|
860
954
|
properties:
|
|
861
955
|
title: Accent Header
|
|
862
956
|
class:
|
|
863
|
-
header: bg-gradient-to-r from-primary/100 to-indigo-600 text-white
|
|
864
|
-
body: bg-bg-layout
|
|
957
|
+
.header: bg-gradient-to-r from-primary/100 to-indigo-600 text-white
|
|
958
|
+
.body: bg-bg-layout
|
|
865
959
|
blocks:
|
|
866
960
|
- id: drawer_css_accent_content
|
|
867
961
|
type: Paragraph
|
|
@@ -890,8 +984,8 @@ The mask CSS key applies a backdrop blur effect, and the content CSS key adds ro
|
|
|
890
984
|
properties:
|
|
891
985
|
title: Custom Mask Style
|
|
892
986
|
class:
|
|
893
|
-
mask: backdrop-blur-sm
|
|
894
|
-
content: rounded-l-xl
|
|
987
|
+
.mask: backdrop-blur-sm
|
|
988
|
+
.content: rounded-l-xl
|
|
895
989
|
blocks:
|
|
896
990
|
- id: drawer_css_mask_content
|
|
897
991
|
type: Paragraph
|
|
@@ -1014,7 +1108,7 @@ Overrides footerPaddingBlock, footerPaddingInline, and zIndexPopup design tokens
|
|
|
1014
1108
|
title: Edit Record
|
|
1015
1109
|
color: primary
|
|
1016
1110
|
variant: solid
|
|
1017
|
-
icon:
|
|
1111
|
+
icon: edit
|
|
1018
1112
|
events:
|
|
1019
1113
|
onClick:
|
|
1020
1114
|
- id: drawer_edit_form_open
|
|
@@ -1124,7 +1218,7 @@ Overrides footerPaddingBlock, footerPaddingInline, and zIndexPopup design tokens
|
|
|
1124
1218
|
title: Filters
|
|
1125
1219
|
color: default
|
|
1126
1220
|
variant: outlined
|
|
1127
|
-
icon:
|
|
1221
|
+
icon: filter
|
|
1128
1222
|
events:
|
|
1129
1223
|
onClick:
|
|
1130
1224
|
- id: drawer_filter_panel_open
|
|
@@ -1200,7 +1294,7 @@ Overrides footerPaddingBlock, footerPaddingInline, and zIndexPopup design tokens
|
|
|
1200
1294
|
value: 3
|
|
1201
1295
|
- label: 4+
|
|
1202
1296
|
value: 4
|
|
1203
|
-
- label: 5
|
|
1297
|
+
- label: "5"
|
|
1204
1298
|
value: 5
|
|
1205
1299
|
- id: drawer_filter_panel_in_stock
|
|
1206
1300
|
type: Switch
|
|
@@ -1241,7 +1335,7 @@ Jane Cooper
|
|
|
1241
1335
|
title: View Profile
|
|
1242
1336
|
color: primary
|
|
1243
1337
|
variant: solid
|
|
1244
|
-
icon:
|
|
1338
|
+
icon: user
|
|
1245
1339
|
events:
|
|
1246
1340
|
onClick:
|
|
1247
1341
|
- id: drawer_profile_open
|
|
@@ -1268,10 +1362,9 @@ Jane Cooper
|
|
|
1268
1362
|
layout:
|
|
1269
1363
|
flex: 0 0 auto
|
|
1270
1364
|
properties:
|
|
1271
|
-
icon:
|
|
1365
|
+
icon: user
|
|
1272
1366
|
size: 64
|
|
1273
|
-
color: "#
|
|
1274
|
-
backgroundColor: "#1677ff"
|
|
1367
|
+
color: "#1677ff"
|
|
1275
1368
|
- id: drawer_profile_info
|
|
1276
1369
|
type: Box
|
|
1277
1370
|
layout:
|
|
@@ -1322,7 +1415,7 @@ Jane Cooper
|
|
|
1322
1415
|
title: Edit Profile
|
|
1323
1416
|
color: primary
|
|
1324
1417
|
variant: outlined
|
|
1325
|
-
icon:
|
|
1418
|
+
icon: edit
|
|
1326
1419
|
- id: drawer_profile_message_btn
|
|
1327
1420
|
type: Button
|
|
1328
1421
|
layout:
|
|
@@ -1331,20 +1424,36 @@ Jane Cooper
|
|
|
1331
1424
|
title: Send Message
|
|
1332
1425
|
color: primary
|
|
1333
1426
|
variant: solid
|
|
1334
|
-
icon:
|
|
1427
|
+
icon: mail
|
|
1335
1428
|
```
|
|
1336
1429
|
|
|
1337
1430
|
| Property | Type | Default | Description |
|
|
1338
1431
|
| --- | --- | --- | --- |
|
|
1339
|
-
| `closable` | boolean | `true` | Whether a close (x) button is visible
|
|
1340
|
-
| `
|
|
1341
|
-
| `
|
|
1342
|
-
| `
|
|
1343
|
-
| `
|
|
1344
|
-
| `
|
|
1432
|
+
| `closable` | boolean \| object | `true` | Whether a close (x) button is visible in the Drawer header or not. Set an object to disable the button or to move it to the end of the header. |
|
|
1433
|
+
| `closable.disabled` | boolean | `false` | Show the close button, but disabled. |
|
|
1434
|
+
| `closable.placement` | string | `"start"` | Place the close button at the start or the end of the header. Enum: `start`, `end`. |
|
|
1435
|
+
| `destroyOnHidden` | boolean | `false` | Unmount the blocks inside the Drawer when it closes, so they mount again (and their onMount events run) each time it opens. Their state is kept. |
|
|
1436
|
+
| `focusable` | object | - | Focus management of the dialog. |
|
|
1437
|
+
| `focusable.trap` | boolean | `true` | Keep keyboard focus inside the dialog while it is open. |
|
|
1438
|
+
| `focusable.focusTriggerAfterClose` | boolean | `true` | Return focus to the element that opened the dialog after it closes. |
|
|
1439
|
+
| `forceRender` | boolean | `false` | Render the blocks inside the Drawer before it is first opened, so their methods can be called and their onMount events run while it is still closed. |
|
|
1440
|
+
| `getContainer` | string \| boolean | - | Where the Drawer is mounted. By default it is mounted on the page body. Set to `false` to render it in place, inside the nearest positioned parent (give that parent `position: relative`), or to a CSS selector to mount it in the first matching element. |
|
|
1441
|
+
| `loading` | boolean | `false` | Show a loading skeleton in place of the Drawer body. |
|
|
1442
|
+
| `mask` | boolean \| object | `true` | Whether to show the mask. Set an object to configure the mask with `enabled`, `blur` and `closable`. |
|
|
1443
|
+
| `mask.enabled` | boolean | `true` | Whether to show the mask. |
|
|
1444
|
+
| `mask.blur` | boolean | `false` | Blur the page behind the mask. |
|
|
1445
|
+
| `mask.closable` | boolean | - | Whether clicking the mask closes the dialog. Takes precedence over `maskClosable`. |
|
|
1446
|
+
| `maskClosable` | boolean | `true` | Clicking on the mask (area outside the Drawer) to close the Drawer or not. `mask.closable` takes precedence. |
|
|
1447
|
+
| `maxSize` | number | - | Maximum size in pixels a resizable Drawer can be dragged to. |
|
|
1448
|
+
| `padding` | string | `"default"` | Space inside the drawer. `compact` tightens the header and body. `none` removes the body padding so content such as a table or list runs edge to edge; the header and footer keep their padding. Enum: `default`, `compact`, `none`. |
|
|
1449
|
+
| `resizable` | boolean | `false` | Let the user resize the Drawer by dragging its edge. The configured size is the starting size. |
|
|
1450
|
+
| `size` | string \| number | - | Size of the Drawer: width for left and right placements, height for top and bottom. `default` (378px), `large` (736px), a number of pixels or a CSS length. Takes precedence over width and height. |
|
|
1451
|
+
| `title` | string | - | The title of the Drawer - supports html. |
|
|
1452
|
+
| `width` | string \| number | `378` | Width of the Drawer dialog. |
|
|
1453
|
+
| `height` | string \| number | `378` | When placement is top or bottom, height of the Drawer dialog. |
|
|
1345
1454
|
| `zIndex` | integer | `1000` | The z-index of the Drawer. |
|
|
1346
1455
|
| `placement` | string | `"right"` | The placement of the Drawer. Enum: `top`, `right`, `bottom`, `left`. |
|
|
1347
|
-
| `keyboard` | boolean | `true` | Whether
|
|
1456
|
+
| `keyboard` | boolean | `true` | Whether pressing Esc closes the Drawer. |
|
|
1348
1457
|
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design drawer tokens](https://ant.design/components/drawer#design-token). |
|
|
1349
1458
|
| `theme.footerPaddingBlock` | number | `8` | Vertical padding of the footer. |
|
|
1350
1459
|
| `theme.footerPaddingInline` | number | `16` | Horizontal padding of the footer. |
|
|
@@ -1359,13 +1468,15 @@ Jane Cooper
|
|
|
1359
1468
|
| `onClose` | \- | Trigger actions when drawer is closed. |
|
|
1360
1469
|
| `onOpen` | \- | Trigger actions when drawer is opened. |
|
|
1361
1470
|
| `afterClose` | \- | Trigger actions after drawer is closed. |
|
|
1362
|
-
| `afterOpenChange` |
|
|
1471
|
+
| `afterOpenChange` | `{ open, drawerOpen }` | Trigger actions after the open or close animation of the drawer has finished. |
|
|
1472
|
+
| `onResizeEnd` | `{ size }` | Trigger actions when the user finishes resizing a resizable drawer. Not triggered when the resize handle is clicked without dragging. |
|
|
1363
1473
|
|
|
1364
1474
|
| Key | Target |
|
|
1365
1475
|
| --- | --- |
|
|
1366
1476
|
| `/block` | Outer block wrapper (always available). |
|
|
1367
1477
|
| `/element` | The Drawer element. |
|
|
1368
1478
|
| `/header` | The Drawer header. |
|
|
1479
|
+
| `/title` | The Drawer title. |
|
|
1369
1480
|
| `/body` | The Drawer body. |
|
|
1370
1481
|
| `/footer` | The Drawer footer. |
|
|
1371
1482
|
| `/mask` | The Drawer mask. |
|