@lowdefy/docs-content 6.1.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 +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 +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 +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 +56 -0
- package/index.json +3458 -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
|
@@ -90,7 +90,8 @@ Made with Lowdefy
|
|
|
90
90
|
type: Paragraph
|
|
91
91
|
properties:
|
|
92
92
|
content: Made with Lowdefy
|
|
93
|
-
|
|
93
|
+
style:
|
|
94
|
+
.element:
|
|
94
95
|
marginTop: 8px
|
|
95
96
|
color: "#999"
|
|
96
97
|
```
|
|
@@ -125,7 +126,7 @@ Company
|
|
|
125
126
|
- id: footer_corp_el
|
|
126
127
|
type: Footer
|
|
127
128
|
class:
|
|
128
|
-
element: bg-bg-layout
|
|
129
|
+
.element: bg-bg-layout
|
|
129
130
|
style:
|
|
130
131
|
padding: 40px 50px 24px
|
|
131
132
|
blocks:
|
|
@@ -151,7 +152,8 @@ Company
|
|
|
151
152
|
type: Paragraph
|
|
152
153
|
properties:
|
|
153
154
|
content: Building better tools for modern teams since 2020.
|
|
154
|
-
|
|
155
|
+
style:
|
|
156
|
+
.element:
|
|
155
157
|
color: "#666"
|
|
156
158
|
- id: footer_corp_col2
|
|
157
159
|
type: Box
|
|
@@ -233,7 +235,8 @@ Company
|
|
|
233
235
|
flex: 0 0 auto
|
|
234
236
|
properties:
|
|
235
237
|
content: © 2026 Acme Corp. All rights reserved.
|
|
236
|
-
|
|
238
|
+
style:
|
|
239
|
+
.element:
|
|
237
240
|
color: "#999"
|
|
238
241
|
margin: 0
|
|
239
242
|
- id: footer_corp_social
|
|
@@ -247,7 +250,7 @@ Company
|
|
|
247
250
|
layout:
|
|
248
251
|
flex: 0 0 auto
|
|
249
252
|
properties:
|
|
250
|
-
icon:
|
|
253
|
+
icon: GitBranch
|
|
251
254
|
color: default
|
|
252
255
|
variant: text
|
|
253
256
|
size: small
|
|
@@ -257,7 +260,7 @@ Company
|
|
|
257
260
|
layout:
|
|
258
261
|
flex: 0 0 auto
|
|
259
262
|
properties:
|
|
260
|
-
icon:
|
|
263
|
+
icon: Bird
|
|
261
264
|
color: default
|
|
262
265
|
variant: text
|
|
263
266
|
size: small
|
|
@@ -294,17 +297,17 @@ Admin Portal v2.4.1 - Powered by Lowdefy
|
|
|
294
297
|
type: MenuLink
|
|
295
298
|
properties:
|
|
296
299
|
title: Dashboard
|
|
297
|
-
icon:
|
|
300
|
+
icon: Gauge
|
|
298
301
|
- id: footer_admin_menu_users
|
|
299
302
|
type: MenuLink
|
|
300
303
|
properties:
|
|
301
304
|
title: Users
|
|
302
|
-
icon:
|
|
305
|
+
icon: user
|
|
303
306
|
- id: footer_admin_menu_settings
|
|
304
307
|
type: MenuLink
|
|
305
308
|
properties:
|
|
306
309
|
title: Settings
|
|
307
|
-
icon:
|
|
310
|
+
icon: settings
|
|
308
311
|
- id: footer_admin_inner_layout
|
|
309
312
|
type: Layout
|
|
310
313
|
layout:
|
|
@@ -358,7 +361,8 @@ Admin Portal v2.4.1 - Powered by Lowdefy
|
|
|
358
361
|
type: Paragraph
|
|
359
362
|
properties:
|
|
360
363
|
content: Admin Portal v2.4.1 - Powered by Lowdefy
|
|
361
|
-
|
|
364
|
+
style:
|
|
365
|
+
.element:
|
|
362
366
|
color: "#999"
|
|
363
367
|
margin: 0
|
|
364
368
|
fontSize: 12px
|
|
@@ -366,7 +370,7 @@ Admin Portal v2.4.1 - Powered by Lowdefy
|
|
|
366
370
|
|
|
367
371
|
| Property | Type | Default | Description |
|
|
368
372
|
| --- | --- | --- | --- |
|
|
369
|
-
| `theme` | object | - |
|
|
373
|
+
| `theme` | object | - | Not applied: antd scopes Layout design tokens to the Layout element, so set tokens such as headerHeight or footerBg on the parent Layout block theme. |
|
|
370
374
|
|
|
371
375
|
No events defined.
|
|
372
376
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# GoogleMapsScript
|
|
2
2
|
|
|
3
|
-
Loads the Google Maps JavaScript API and wraps `GoogleMaps` and `
|
|
3
|
+
Loads the Google Maps JavaScript API and wraps `GoogleMaps`, `GoogleMapsHeatmap` and `PlacesAutocomplete` blocks as a parent container. Configure the API key, language, region, libraries, and API version. Blocks that use an optional library should be wrapped in a GoogleMapsScript that loads it — list `libraries: [places]` for `PlacesAutocomplete` so the library is ready on first render. When it is not listed, `PlacesAutocomplete` imports it on demand through `google.maps.importLibrary`.
|
|
4
4
|
|
|
5
|
-
> GoogleMapsScript loads the Google Maps JavaScript API. Only one GoogleMapsScript should be used per page. It must wrap GoogleMaps or
|
|
5
|
+
> GoogleMapsScript loads the Google Maps JavaScript API. Only one GoogleMapsScript should be used per page. It must wrap GoogleMaps, GoogleMapsHeatmap or PlacesAutocomplete blocks as a parent container. The examples below show configuration patterns — maps require a valid API key to render.
|
|
6
6
|
|
|
7
7
|
```yaml
|
|
8
8
|
- id: gms_full_config
|
|
@@ -34,7 +34,7 @@ Page header layout section. Supports built-in notifications, profile avatar, and
|
|
|
34
34
|
flex: 0 0 auto
|
|
35
35
|
properties:
|
|
36
36
|
title: Home
|
|
37
|
-
icon:
|
|
37
|
+
icon: home
|
|
38
38
|
color: default
|
|
39
39
|
variant: link
|
|
40
40
|
- id: header_nav_about
|
|
@@ -71,19 +71,19 @@ Page header layout section. Supports built-in notifications, profile avatar, and
|
|
|
71
71
|
type: MenuLink
|
|
72
72
|
properties:
|
|
73
73
|
title: My Profile
|
|
74
|
-
icon:
|
|
74
|
+
icon: user
|
|
75
75
|
- id: header_prof_settings
|
|
76
76
|
type: MenuLink
|
|
77
77
|
properties:
|
|
78
78
|
title: Settings
|
|
79
|
-
icon:
|
|
79
|
+
icon: settings
|
|
80
80
|
- id: header_prof_divider
|
|
81
81
|
type: MenuDivider
|
|
82
82
|
- id: header_prof_logout
|
|
83
83
|
type: MenuLink
|
|
84
84
|
properties:
|
|
85
85
|
title: Logout
|
|
86
|
-
icon:
|
|
86
|
+
icon: logout
|
|
87
87
|
danger: true
|
|
88
88
|
style:
|
|
89
89
|
borderBottom: 1px solid var(--ant-color-border)
|
|
@@ -100,7 +100,7 @@ Page header layout section. Supports built-in notifications, profile avatar, and
|
|
|
100
100
|
flex: 0 0 auto
|
|
101
101
|
properties:
|
|
102
102
|
title: Overview
|
|
103
|
-
icon:
|
|
103
|
+
icon: Gauge
|
|
104
104
|
color: default
|
|
105
105
|
variant: link
|
|
106
106
|
- id: header_profile_projects
|
|
@@ -109,7 +109,7 @@ Page header layout section. Supports built-in notifications, profile avatar, and
|
|
|
109
109
|
flex: 0 0 auto
|
|
110
110
|
properties:
|
|
111
111
|
title: Projects
|
|
112
|
-
icon:
|
|
112
|
+
icon: SquareKanban
|
|
113
113
|
color: default
|
|
114
114
|
variant: link
|
|
115
115
|
```
|
|
@@ -198,43 +198,51 @@ A Header for marketing pages with button navigation and call-to-action buttons.
|
|
|
198
198
|
```
|
|
199
199
|
|
|
200
200
|
```yaml
|
|
201
|
-
- id:
|
|
202
|
-
type:
|
|
201
|
+
- id: header_token_branded_layout
|
|
202
|
+
type: Layout
|
|
203
203
|
properties:
|
|
204
204
|
theme:
|
|
205
|
-
headerBg: "#0958d9"
|
|
206
205
|
headerHeight: 56
|
|
207
206
|
headerPadding: 0 24px
|
|
208
207
|
blocks:
|
|
209
|
-
- id:
|
|
210
|
-
type:
|
|
211
|
-
layout:
|
|
212
|
-
flex: 0 0 auto
|
|
213
|
-
properties:
|
|
214
|
-
html: <span class="text-white text-lg font-bold">Branded Header</span>
|
|
215
|
-
- id: header_token_branded_spacer
|
|
216
|
-
type: Box
|
|
217
|
-
layout:
|
|
218
|
-
flex: 1 1 0
|
|
219
|
-
- id: header_token_branded_subtitle
|
|
220
|
-
type: Html
|
|
221
|
-
layout:
|
|
222
|
-
flex: 0 0 auto
|
|
208
|
+
- id: header_token_branded
|
|
209
|
+
type: Header
|
|
223
210
|
properties:
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
211
|
+
color: "#0958d9"
|
|
212
|
+
blocks:
|
|
213
|
+
- id: header_token_branded_title
|
|
214
|
+
type: Html
|
|
215
|
+
layout:
|
|
216
|
+
flex: 0 0 auto
|
|
217
|
+
properties:
|
|
218
|
+
html: <span class="text-white text-lg font-bold">Branded Header</span>
|
|
219
|
+
- id: header_token_branded_spacer
|
|
220
|
+
type: Box
|
|
221
|
+
layout:
|
|
222
|
+
flex: 1 1 0
|
|
223
|
+
- id: header_token_branded_subtitle
|
|
224
|
+
type: Html
|
|
225
|
+
layout:
|
|
226
|
+
flex: 0 0 auto
|
|
227
|
+
properties:
|
|
228
|
+
html: <span style="color:#bae0ff">color property with Layout headerHeight and
|
|
229
|
+
headerPadding tokens</span>
|
|
230
|
+
- id: header_token_compact_layout
|
|
231
|
+
type: Layout
|
|
227
232
|
properties:
|
|
228
233
|
theme:
|
|
229
234
|
headerHeight: 40
|
|
230
235
|
headerPadding: 0 16px
|
|
231
|
-
style:
|
|
232
|
-
borderBottom: 1px solid var(--ant-color-border)
|
|
233
236
|
blocks:
|
|
234
|
-
- id:
|
|
235
|
-
type:
|
|
236
|
-
|
|
237
|
-
|
|
237
|
+
- id: header_token_compact
|
|
238
|
+
type: Header
|
|
239
|
+
style:
|
|
240
|
+
borderBottom: 1px solid var(--ant-color-border)
|
|
241
|
+
blocks:
|
|
242
|
+
- id: header_token_compact_title
|
|
243
|
+
type: Html
|
|
244
|
+
properties:
|
|
245
|
+
html: <span class="text-sm">Compact Header (40px height)</span>
|
|
238
246
|
```
|
|
239
247
|
|
|
240
248
|
| Property | Type | Default | Description |
|
|
@@ -251,15 +259,33 @@ A Header for marketing pages with button navigation and call-to-action buttons.
|
|
|
251
259
|
| `notifications.showZero` | boolean | `false` | Show badge when count is zero. |
|
|
252
260
|
| `notifications.overflowCount` | number | `99` | Max count to show. Values above this display as "N+". |
|
|
253
261
|
| `notifications.color` | string | - | Badge color. |
|
|
254
|
-
| `notifications.icon` | string \| object | - | Icon for the notification button. Defaults to
|
|
262
|
+
| `notifications.icon` | string \| object | - | Icon for the notification button. Defaults to `bell`. |
|
|
263
|
+
| `notifications.icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
264
|
+
| `notifications.icon.color` | string | - | Icon color. |
|
|
265
|
+
| `notifications.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
266
|
+
| `notifications.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
267
|
+
| `notifications.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
268
|
+
| `notifications.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
269
|
+
| `notifications.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
270
|
+
| `notifications.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
271
|
+
| `notifications.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
255
272
|
| `notifications.size` | string | `"small"` | Size of the notification button. Enum: `small`, `default`, `large`. |
|
|
256
273
|
| `profile` | object | - | Profile avatar with optional dropdown menu in the header. Renders when configured. Use with the _user operator to populate from the authenticated user. |
|
|
257
274
|
| `profile.avatar` | object | - | Avatar display properties. |
|
|
258
275
|
| `profile.avatar.src` | string | - | Image URL for the avatar. Typically bound to _user: image. |
|
|
259
276
|
| `profile.avatar.content` | string | - | Text content inside the avatar (e.g. user initials). Shown when no src is provided. |
|
|
260
|
-
| `profile.avatar.icon` | string \| object | - | Icon to display in avatar when no src or content is set. Defaults to
|
|
277
|
+
| `profile.avatar.icon` | string \| object | - | Icon to display in avatar when no src or content is set. Defaults to `user`. |
|
|
278
|
+
| `profile.avatar.icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
279
|
+
| `profile.avatar.icon.color` | string | - | Icon color. |
|
|
280
|
+
| `profile.avatar.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
281
|
+
| `profile.avatar.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
282
|
+
| `profile.avatar.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
283
|
+
| `profile.avatar.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
284
|
+
| `profile.avatar.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
285
|
+
| `profile.avatar.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
286
|
+
| `profile.avatar.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
261
287
|
| `profile.avatar.color` | string | - | Background color of the avatar when not using src. |
|
|
262
|
-
| `profile.avatar.size` | string \| number | `"small"` | Size of the avatar
|
|
288
|
+
| `profile.avatar.size` | string \| number | `"small"` | Size of the avatar: default, small, large or a pixel number. |
|
|
263
289
|
| `profile.avatar.shape` | string | `"circle"` | Shape of the avatar. Enum: `circle`, `square`. |
|
|
264
290
|
| `profile.links` | array | - | Dropdown menu items. Uses the same MenuLink/MenuGroup/MenuDivider pattern as DropdownMenu. When links are provided, clicking the avatar opens a dropdown menu. |
|
|
265
291
|
| `profile.links.$.id` | string | - | Menu item id. |
|
|
@@ -270,6 +296,15 @@ A Header for marketing pages with button navigation and call-to-action buttons.
|
|
|
270
296
|
| `profile.links.$.properties` | object | - | Properties for the menu item. |
|
|
271
297
|
| `profile.links.$.properties.title` | string | - | Menu item title. |
|
|
272
298
|
| `profile.links.$.properties.icon` | string \| object | - | Icon for the menu item. |
|
|
299
|
+
| `profile.links.$.properties.icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
300
|
+
| `profile.links.$.properties.icon.color` | string | - | Icon color. |
|
|
301
|
+
| `profile.links.$.properties.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
302
|
+
| `profile.links.$.properties.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
303
|
+
| `profile.links.$.properties.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
304
|
+
| `profile.links.$.properties.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
305
|
+
| `profile.links.$.properties.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
306
|
+
| `profile.links.$.properties.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
307
|
+
| `profile.links.$.properties.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
273
308
|
| `profile.links.$.properties.danger` | boolean | `false` | Apply danger style to menu item. |
|
|
274
309
|
| `profile.links.$.properties.disabled` | boolean | `false` | Disable the menu item. |
|
|
275
310
|
| `profile.trigger` | string | `"hover"` | How the profile dropdown opens. Enum: `click`, `hover`. |
|
|
@@ -277,7 +312,7 @@ A Header for marketing pages with button navigation and call-to-action buttons.
|
|
|
277
312
|
| `profile.arrow` | boolean \| object | `false` | Show arrow on the dropdown. |
|
|
278
313
|
| `profile.arrow.pointAtCenter` | boolean | - | |
|
|
279
314
|
| `darkModeToggle` | boolean | `false` | Show a dark mode toggle icon in the header. Toggles the Ant Design dark theme for the entire page. Preference is persisted to localStorage. |
|
|
280
|
-
| `theme` | object | - |
|
|
315
|
+
| `theme` | object | - | Not applied: antd scopes Layout design tokens to the Layout element, so set tokens such as headerHeight or footerBg on the parent Layout block theme. |
|
|
281
316
|
|
|
282
317
|
| Event | Event Data | Description |
|
|
283
318
|
| --- | --- | --- |
|
|
@@ -205,6 +205,20 @@ Form label wrapper with title, description, and validation feedback.
|
|
|
205
205
|
type: TextInput
|
|
206
206
|
```
|
|
207
207
|
|
|
208
|
+
```yaml
|
|
209
|
+
- id: label_wrap_inline
|
|
210
|
+
type: Label
|
|
211
|
+
layout:
|
|
212
|
+
span: 12
|
|
213
|
+
properties:
|
|
214
|
+
title: A long inline label that wraps onto a second line when space runs out
|
|
215
|
+
inline: true
|
|
216
|
+
wrap: true
|
|
217
|
+
blocks:
|
|
218
|
+
- id: label_wrap_inline_input
|
|
219
|
+
type: TextInput
|
|
220
|
+
```
|
|
221
|
+
|
|
208
222
|
```yaml
|
|
209
223
|
- id: label_inline_small
|
|
210
224
|
type: Label
|
|
@@ -342,8 +356,8 @@ Form label wrapper with title, description, and validation feedback.
|
|
|
342
356
|
title: Styled Label Text
|
|
343
357
|
extra: Styled extra text
|
|
344
358
|
class:
|
|
345
|
-
label: text-purple-600 font-bold
|
|
346
|
-
extra: text-purple-400 italic
|
|
359
|
+
.label: text-purple-600 font-bold
|
|
360
|
+
.extra: text-purple-400 italic
|
|
347
361
|
blocks:
|
|
348
362
|
- id: label_css_label_input
|
|
349
363
|
type: TextInput
|
|
@@ -352,7 +366,7 @@ Form label wrapper with title, description, and validation feedback.
|
|
|
352
366
|
properties:
|
|
353
367
|
title: Bordered Container
|
|
354
368
|
class:
|
|
355
|
-
element: border border-border p-3 rounded-lg
|
|
369
|
+
.element: border border-border p-3 rounded-lg
|
|
356
370
|
blocks:
|
|
357
371
|
- id: label_css_element_input
|
|
358
372
|
type: TextInput
|
|
@@ -361,7 +375,7 @@ Form label wrapper with title, description, and validation feedback.
|
|
|
361
375
|
properties:
|
|
362
376
|
title: Feedback Styling
|
|
363
377
|
class:
|
|
364
|
-
feedback: font-semibold text-xs
|
|
378
|
+
.feedback: font-semibold text-xs
|
|
365
379
|
blocks:
|
|
366
380
|
- id: label_css_feedback_input
|
|
367
381
|
type: TextInput
|
|
@@ -379,7 +393,7 @@ Form label wrapper with title, description, and validation feedback.
|
|
|
379
393
|
color: "#d48806"
|
|
380
394
|
fontStyle: italic
|
|
381
395
|
.element:
|
|
382
|
-
border: 1px solid
|
|
396
|
+
border: "1px solid #ffd591"
|
|
383
397
|
padding: 12px
|
|
384
398
|
borderRadius: 8px
|
|
385
399
|
blocks:
|
|
@@ -697,6 +711,18 @@ Form label wrapper with title, description, and validation feedback.
|
|
|
697
711
|
|
|
698
712
|
| Property | Type | Default | Description |
|
|
699
713
|
| --- | --- | --- | --- |
|
|
714
|
+
| `xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
|
|
715
|
+
| `xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
716
|
+
| `sm` | object | - | Label width on small screens (576px and up) when the label is not inline. Also applies below 576px unless `xs` is set. |
|
|
717
|
+
| `sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
718
|
+
| `md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
|
|
719
|
+
| `md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
720
|
+
| `lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
|
|
721
|
+
| `lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
722
|
+
| `xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
|
|
723
|
+
| `xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
724
|
+
| `xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
|
|
725
|
+
| `xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
|
|
700
726
|
| `align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
|
|
701
727
|
| `colon` | boolean | `true` | Append label with colon. |
|
|
702
728
|
| `disabled` | boolean | `false` | Disable to not render a label title. |
|
|
@@ -705,10 +731,11 @@ Form label wrapper with title, description, and validation feedback.
|
|
|
705
731
|
| `title` | string | - | Label title - supports html. |
|
|
706
732
|
| `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. |
|
|
707
733
|
| `tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
|
|
708
|
-
| `tooltip.icon` | string | `"
|
|
734
|
+
| `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`. |
|
|
709
735
|
| `tooltip.color` | string | - | Color of the tooltip icon. |
|
|
710
|
-
| `span` | number | - | Label inline
|
|
736
|
+
| `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. |
|
|
711
737
|
| `inline` | boolean | `false` | Render input and label inline. |
|
|
738
|
+
| `wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their content always wrap. |
|
|
712
739
|
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design form tokens](https://ant.design/components/form#design-token). |
|
|
713
740
|
| `theme.labelFontSize` | number | `14` | Font size of the label text. |
|
|
714
741
|
| `theme.labelColor` | string | `"rgba(0,0,0,0.88)"` | Text color of the label. |
|
|
@@ -87,12 +87,12 @@ Footer
|
|
|
87
87
|
type: MenuLink
|
|
88
88
|
properties:
|
|
89
89
|
title: Dashboard
|
|
90
|
-
icon:
|
|
90
|
+
icon: Gauge
|
|
91
91
|
- id: layout_sider_nav_2
|
|
92
92
|
type: MenuLink
|
|
93
93
|
properties:
|
|
94
94
|
title: Settings
|
|
95
|
-
icon:
|
|
95
|
+
icon: settings
|
|
96
96
|
- id: layout_sider_content
|
|
97
97
|
type: Content
|
|
98
98
|
layout:
|
|
@@ -155,7 +155,7 @@ Right side panel for supplementary content, filters, or navigation.
|
|
|
155
155
|
width: 250
|
|
156
156
|
reverseArrow: true
|
|
157
157
|
style:
|
|
158
|
-
borderLeft: 1px solid
|
|
158
|
+
borderLeft: "1px solid #f0f0f0"
|
|
159
159
|
blocks:
|
|
160
160
|
- id: layout_right_sider_side_text
|
|
161
161
|
type: Paragraph
|
|
@@ -165,11 +165,11 @@ Right side panel for supplementary content, filters, or navigation.
|
|
|
165
165
|
content: Right side panel for supplementary content, filters, or navigation.
|
|
166
166
|
```
|
|
167
167
|
|
|
168
|
-
|
|
168
|
+
The collapse trigger uses the lightTriggerBg and lightTriggerColor tokens.
|
|
169
169
|
|
|
170
|
-
The Layout theme property accepts antd design tokens like
|
|
170
|
+
The Layout theme property accepts antd Layout design tokens like bodyBg, headerHeight, footerBg and the Sider trigger tokens. They apply to the Header, Footer and Sider blocks inside the layout.
|
|
171
171
|
|
|
172
|
-
Footer styled with footerBg
|
|
172
|
+
Footer styled with the footerBg and footerPadding tokens
|
|
173
173
|
|
|
174
174
|
```yaml
|
|
175
175
|
- id: layout_theme_outer
|
|
@@ -178,10 +178,13 @@ Footer styled with footerBg token
|
|
|
178
178
|
minHeight: 280px
|
|
179
179
|
properties:
|
|
180
180
|
theme:
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
181
|
+
bodyBg: "#f0f5ff"
|
|
182
|
+
headerHeight: 48
|
|
183
|
+
headerColor: "#1d39c4"
|
|
184
|
+
footerBg: "#d6e4ff"
|
|
185
|
+
footerPadding: 12px 24px
|
|
186
|
+
lightTriggerBg: "#adc6ff"
|
|
187
|
+
lightTriggerColor: "#1d39c4"
|
|
185
188
|
blocks:
|
|
186
189
|
- id: layout_theme_header
|
|
187
190
|
type: Header
|
|
@@ -191,8 +194,8 @@ Footer styled with footerBg token
|
|
|
191
194
|
- id: layout_theme_header_text
|
|
192
195
|
type: Html
|
|
193
196
|
properties:
|
|
194
|
-
html: <span class="text-base font-semibold">
|
|
195
|
-
|
|
197
|
+
html: <span class="text-base font-semibold">48px header from the headerHeight
|
|
198
|
+
token</span>
|
|
196
199
|
- id: layout_theme_inner
|
|
197
200
|
type: Layout
|
|
198
201
|
properties:
|
|
@@ -205,14 +208,16 @@ Footer styled with footerBg token
|
|
|
205
208
|
properties:
|
|
206
209
|
theme: light
|
|
207
210
|
width: 180
|
|
211
|
+
collapsible: true
|
|
212
|
+
initialCollapsed: false
|
|
208
213
|
blocks:
|
|
209
214
|
- id: layout_theme_sider_text
|
|
210
215
|
type: Paragraph
|
|
211
216
|
style:
|
|
212
217
|
padding: 16px
|
|
213
218
|
properties:
|
|
214
|
-
content:
|
|
215
|
-
|
|
219
|
+
content: The collapse trigger uses the lightTriggerBg and lightTriggerColor
|
|
220
|
+
tokens.
|
|
216
221
|
- id: layout_theme_content
|
|
217
222
|
type: Content
|
|
218
223
|
layout:
|
|
@@ -223,10 +228,10 @@ Footer styled with footerBg token
|
|
|
223
228
|
- id: layout_theme_content_text
|
|
224
229
|
type: Paragraph
|
|
225
230
|
properties:
|
|
226
|
-
content: The Layout theme property accepts antd design tokens like
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
231
|
+
content: The Layout theme property accepts antd Layout design tokens like
|
|
232
|
+
bodyBg, headerHeight, footerBg and the Sider trigger tokens.
|
|
233
|
+
They apply to the Header, Footer and Sider blocks inside the
|
|
234
|
+
layout.
|
|
230
235
|
- id: layout_theme_footer
|
|
231
236
|
type: Footer
|
|
232
237
|
style:
|
|
@@ -235,7 +240,7 @@ Footer styled with footerBg token
|
|
|
235
240
|
- id: layout_theme_footer_text
|
|
236
241
|
type: Paragraph
|
|
237
242
|
properties:
|
|
238
|
-
content: Footer styled with footerBg
|
|
243
|
+
content: Footer styled with the footerBg and footerPadding tokens
|
|
239
244
|
```
|
|
240
245
|
|
|
241
246
|
The Layout block has a single cssKey called "element". Use the class property to apply Tailwind utility classes directly to the Layout wrapper. Here the outer Layout uses rounded corners, shadow, and a border. Child blocks like Header, Content, and Footer can each have their own class applied.
|
|
@@ -305,7 +310,7 @@ Acme Corp Admin Panel - Version 3.2.1
|
|
|
305
310
|
count: 5
|
|
306
311
|
profile:
|
|
307
312
|
avatar:
|
|
308
|
-
icon:
|
|
313
|
+
icon: user
|
|
309
314
|
style:
|
|
310
315
|
paddingInline: 24px
|
|
311
316
|
borderBottom: 1px solid var(--ant-color-border)
|
|
@@ -340,27 +345,27 @@ Acme Corp Admin Panel - Version 3.2.1
|
|
|
340
345
|
type: MenuLink
|
|
341
346
|
properties:
|
|
342
347
|
title: Dashboard
|
|
343
|
-
icon:
|
|
348
|
+
icon: Gauge
|
|
344
349
|
- id: layout_admin_menu_users
|
|
345
350
|
type: MenuLink
|
|
346
351
|
properties:
|
|
347
352
|
title: Users
|
|
348
|
-
icon:
|
|
353
|
+
icon: users
|
|
349
354
|
- id: layout_admin_menu_orders
|
|
350
355
|
type: MenuLink
|
|
351
356
|
properties:
|
|
352
357
|
title: Orders
|
|
353
|
-
icon:
|
|
358
|
+
icon: ShoppingCart
|
|
354
359
|
- id: layout_admin_menu_reports
|
|
355
360
|
type: MenuLink
|
|
356
361
|
properties:
|
|
357
362
|
title: Reports
|
|
358
|
-
icon:
|
|
363
|
+
icon: chart
|
|
359
364
|
- id: layout_admin_menu_settings
|
|
360
365
|
type: MenuLink
|
|
361
366
|
properties:
|
|
362
367
|
title: Settings
|
|
363
|
-
icon:
|
|
368
|
+
icon: settings
|
|
364
369
|
- id: layout_admin_content_area
|
|
365
370
|
type: Content
|
|
366
371
|
layout:
|
|
@@ -470,7 +475,8 @@ Welcome to DevDocs. This guide walks you through setting up your first project.
|
|
|
470
475
|
properties:
|
|
471
476
|
content: DevDocs
|
|
472
477
|
level: 4
|
|
473
|
-
|
|
478
|
+
style:
|
|
479
|
+
.element:
|
|
474
480
|
margin: 0
|
|
475
481
|
- id: layout_docs_version_tag
|
|
476
482
|
type: Tag
|
|
@@ -488,7 +494,7 @@ Welcome to DevDocs. This guide walks you through setting up your first project.
|
|
|
488
494
|
layout:
|
|
489
495
|
flex: 0 0 auto
|
|
490
496
|
properties:
|
|
491
|
-
icon:
|
|
497
|
+
icon: search
|
|
492
498
|
title: Search docs...
|
|
493
499
|
color: default
|
|
494
500
|
variant: outlined
|
|
@@ -497,7 +503,7 @@ Welcome to DevDocs. This guide walks you through setting up your first project.
|
|
|
497
503
|
layout:
|
|
498
504
|
flex: 0 0 auto
|
|
499
505
|
properties:
|
|
500
|
-
icon:
|
|
506
|
+
icon: GitBranch
|
|
501
507
|
color: default
|
|
502
508
|
variant: text
|
|
503
509
|
hideTitle: true
|
|
@@ -515,7 +521,7 @@ Welcome to DevDocs. This guide walks you through setting up your first project.
|
|
|
515
521
|
width: 260
|
|
516
522
|
breakpoint: md
|
|
517
523
|
style:
|
|
518
|
-
borderRight: 1px solid
|
|
524
|
+
borderRight: "1px solid #f0f0f0"
|
|
519
525
|
blocks:
|
|
520
526
|
- id: layout_docs_nav_title
|
|
521
527
|
type: Paragraph
|
|
@@ -534,22 +540,22 @@ Welcome to DevDocs. This guide walks you through setting up your first project.
|
|
|
534
540
|
type: MenuLink
|
|
535
541
|
properties:
|
|
536
542
|
title: Introduction
|
|
537
|
-
icon:
|
|
543
|
+
icon: BookOpen
|
|
538
544
|
- id: layout_docs_nav_install
|
|
539
545
|
type: MenuLink
|
|
540
546
|
properties:
|
|
541
547
|
title: Installation
|
|
542
|
-
icon:
|
|
548
|
+
icon: download
|
|
543
549
|
- id: layout_docs_nav_config
|
|
544
550
|
type: MenuLink
|
|
545
551
|
properties:
|
|
546
552
|
title: Configuration
|
|
547
|
-
icon:
|
|
553
|
+
icon: Wrench
|
|
548
554
|
- id: layout_docs_nav_deploy
|
|
549
555
|
type: MenuLink
|
|
550
556
|
properties:
|
|
551
557
|
title: Deployment
|
|
552
|
-
icon:
|
|
558
|
+
icon: CloudUpload
|
|
553
559
|
- id: layout_docs_content_area
|
|
554
560
|
type: Content
|
|
555
561
|
layout:
|
|
@@ -590,7 +596,19 @@ Welcome to DevDocs. This guide walks you through setting up your first project.
|
|
|
590
596
|
|
|
591
597
|
| Property | Type | Default | Description |
|
|
592
598
|
| --- | --- | --- | --- |
|
|
593
|
-
| `
|
|
599
|
+
| `hasSider` | boolean | `false` | Lay the child blocks out in a row when the layout contains a Sider. |
|
|
600
|
+
| `theme` | object | - | Antd Layout design token overrides for this block. Header, Footer and Sider blocks inside the layout use them too. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design layout tokens](https://ant.design/components/layout#design-token). |
|
|
601
|
+
| `theme.bodyBg` | string | `"#f5f5f5"` | Background color of the layout. |
|
|
602
|
+
| `theme.headerHeight` | number | `64` | Height of Header blocks. |
|
|
603
|
+
| `theme.headerPadding` | string | `"0 50px"` | Padding of Header blocks. |
|
|
604
|
+
| `theme.headerColor` | string | `"rgba(0, 0, 0, 0.88)"` | Text color of Header blocks. |
|
|
605
|
+
| `theme.footerBg` | string | `"#f5f5f5"` | Background color of Footer blocks. |
|
|
606
|
+
| `theme.footerPadding` | string | `"24px 50px"` | Padding of Footer blocks. |
|
|
607
|
+
| `theme.triggerHeight` | number | `48` | Height of the collapse trigger of a collapsible Sider. |
|
|
608
|
+
| `theme.triggerBg` | string | `"#002140"` | Background color of the collapse trigger of a dark Sider. |
|
|
609
|
+
| `theme.triggerColor` | string | `"#fff"` | Color of the collapse trigger of a dark Sider. |
|
|
610
|
+
| `theme.lightTriggerBg` | string | `"#ffffff"` | Background color of the collapse trigger of a light Sider. |
|
|
611
|
+
| `theme.lightTriggerColor` | string | `"rgba(0, 0, 0, 0.88)"` | Color of the collapse trigger of a light Sider. |
|
|
594
612
|
|
|
595
613
|
No events defined.
|
|
596
614
|
|