@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
|
@@ -18,17 +18,17 @@ PageSidebarLayout provides a full-page layout with a full-height sidebar. The si
|
|
|
18
18
|
type: MenuLink
|
|
19
19
|
properties:
|
|
20
20
|
title: Dashboard
|
|
21
|
-
icon:
|
|
21
|
+
icon: Gauge
|
|
22
22
|
- id: psl_basic_users
|
|
23
23
|
type: MenuLink
|
|
24
24
|
properties:
|
|
25
25
|
title: Users
|
|
26
|
-
icon:
|
|
26
|
+
icon: user
|
|
27
27
|
- id: psl_basic_settings
|
|
28
28
|
type: MenuLink
|
|
29
29
|
properties:
|
|
30
30
|
title: Settings
|
|
31
|
-
icon:
|
|
31
|
+
icon: settings
|
|
32
32
|
blocks:
|
|
33
33
|
- id: psl_basic_content
|
|
34
34
|
type: Paragraph
|
|
@@ -39,6 +39,65 @@ PageSidebarLayout provides a full-page layout with a full-height sidebar. The si
|
|
|
39
39
|
drawer replaces the sider.
|
|
40
40
|
```
|
|
41
41
|
|
|
42
|
+
padding: none removes the content padding, so tables and grids can run edge to edge. Blocks set their own spacing.
|
|
43
|
+
|
|
44
|
+
```yaml
|
|
45
|
+
- id: psl_flush
|
|
46
|
+
type: PageSidebarLayout
|
|
47
|
+
properties:
|
|
48
|
+
siderStorageKey: psl_flush
|
|
49
|
+
padding: none
|
|
50
|
+
menu:
|
|
51
|
+
links:
|
|
52
|
+
- id: psl_flush_dashboard
|
|
53
|
+
type: MenuLink
|
|
54
|
+
properties:
|
|
55
|
+
title: Dashboard
|
|
56
|
+
- id: psl_flush_invoices
|
|
57
|
+
type: MenuLink
|
|
58
|
+
properties:
|
|
59
|
+
title: Invoices
|
|
60
|
+
blocks:
|
|
61
|
+
- id: psl_flush_text
|
|
62
|
+
type: Paragraph
|
|
63
|
+
class: px-4
|
|
64
|
+
properties:
|
|
65
|
+
content: "padding: none removes the content padding, so tables and grids can run
|
|
66
|
+
edge to edge. Blocks set their own spacing."
|
|
67
|
+
- id: psl_flush_card
|
|
68
|
+
type: Card
|
|
69
|
+
properties:
|
|
70
|
+
title: Recent invoices
|
|
71
|
+
padding: none
|
|
72
|
+
variant: borderless
|
|
73
|
+
blocks:
|
|
74
|
+
- id: psl_flush_card_rows
|
|
75
|
+
type: Html
|
|
76
|
+
properties:
|
|
77
|
+
html: >
|
|
78
|
+
<div style="display: flex; justify-content: space-between;
|
|
79
|
+
padding: 8px 24px; border-bottom: 1px solid
|
|
80
|
+
var(--ant-color-border-secondary);"><span>INV-1042</span><span
|
|
81
|
+
style="color:
|
|
82
|
+
var(--ant-color-text-secondary);">$1,280.00</span></div>
|
|
83
|
+
|
|
84
|
+
<div style="display: flex; justify-content: space-between;
|
|
85
|
+
padding: 8px 24px; border-bottom: 1px solid
|
|
86
|
+
var(--ant-color-border-secondary);"><span>INV-1041</span><span
|
|
87
|
+
style="color:
|
|
88
|
+
var(--ant-color-text-secondary);">$640.00</span></div>
|
|
89
|
+
|
|
90
|
+
<div style="display: flex; justify-content: space-between;
|
|
91
|
+
padding: 8px 24px; border-bottom: 1px solid
|
|
92
|
+
var(--ant-color-border-secondary);"><span>INV-1040</span><span
|
|
93
|
+
style="color:
|
|
94
|
+
var(--ant-color-text-secondary);">$2,115.50</span></div>
|
|
95
|
+
|
|
96
|
+
<div style="display: flex; justify-content: space-between;
|
|
97
|
+
padding: 8px 24px;"><span>INV-1039</span><span style="color:
|
|
98
|
+
var(--ant-color-text-secondary);">$96.00</span></div>
|
|
99
|
+
```
|
|
100
|
+
|
|
42
101
|
Sider starts collapsed. Click the toggle button to expand. The collapsed state is persisted in localStorage.
|
|
43
102
|
|
|
44
103
|
```yaml
|
|
@@ -54,12 +113,12 @@ Sider starts collapsed. Click the toggle button to expand. The collapsed state i
|
|
|
54
113
|
type: MenuLink
|
|
55
114
|
properties:
|
|
56
115
|
title: Dashboard
|
|
57
|
-
icon:
|
|
116
|
+
icon: Gauge
|
|
58
117
|
- id: psl_collapsed_users
|
|
59
118
|
type: MenuLink
|
|
60
119
|
properties:
|
|
61
120
|
title: Users
|
|
62
|
-
icon:
|
|
121
|
+
icon: user
|
|
63
122
|
blocks:
|
|
64
123
|
- id: psl_collapsed_content
|
|
65
124
|
type: Paragraph
|
|
@@ -86,12 +145,12 @@ Optional desktop header with custom content. The header sits inside the content
|
|
|
86
145
|
type: MenuLink
|
|
87
146
|
properties:
|
|
88
147
|
title: Dashboard
|
|
89
|
-
icon:
|
|
148
|
+
icon: Gauge
|
|
90
149
|
- id: psl_header_settings
|
|
91
150
|
type: MenuLink
|
|
92
151
|
properties:
|
|
93
152
|
title: Settings
|
|
94
|
-
icon:
|
|
153
|
+
icon: settings
|
|
95
154
|
slots:
|
|
96
155
|
header:
|
|
97
156
|
blocks:
|
|
@@ -101,7 +160,7 @@ Optional desktop header with custom content. The header sits inside the content
|
|
|
101
160
|
flex: 0 0 auto
|
|
102
161
|
properties:
|
|
103
162
|
title: Search
|
|
104
|
-
icon:
|
|
163
|
+
icon: search
|
|
105
164
|
color: default
|
|
106
165
|
variant: outlined
|
|
107
166
|
size: small
|
|
@@ -113,6 +172,93 @@ Optional desktop header with custom content. The header sits inside the content
|
|
|
113
172
|
content area, not above the sider.
|
|
114
173
|
```
|
|
115
174
|
|
|
175
|
+
The siderHeader slot sits above the menu and stays in place while a long menu scrolls. siderHeaderClosed takes its place while the sider is collapsed, and mobileDrawerHeader puts content above the menu in the mobile drawer.
|
|
176
|
+
|
|
177
|
+
Acme Inc
|
|
178
|
+
|
|
179
|
+
```yaml
|
|
180
|
+
- id: psl_sider_header
|
|
181
|
+
type: PageSidebarLayout
|
|
182
|
+
properties:
|
|
183
|
+
siderStorageKey: psl_sider_header
|
|
184
|
+
sider:
|
|
185
|
+
width: 240
|
|
186
|
+
menu:
|
|
187
|
+
links:
|
|
188
|
+
- id: psl_sider_header_general
|
|
189
|
+
type: MenuLink
|
|
190
|
+
properties:
|
|
191
|
+
title: General
|
|
192
|
+
icon: settings
|
|
193
|
+
- id: psl_sider_header_members
|
|
194
|
+
type: MenuLink
|
|
195
|
+
properties:
|
|
196
|
+
title: Members
|
|
197
|
+
icon: users
|
|
198
|
+
- id: psl_sider_header_billing
|
|
199
|
+
type: MenuLink
|
|
200
|
+
properties:
|
|
201
|
+
title: Billing
|
|
202
|
+
icon: CreditCard
|
|
203
|
+
slots:
|
|
204
|
+
siderHeader:
|
|
205
|
+
blocks:
|
|
206
|
+
- id: psl_sider_header_open
|
|
207
|
+
type: Box
|
|
208
|
+
style:
|
|
209
|
+
padding: 8px 16px
|
|
210
|
+
blocks:
|
|
211
|
+
- id: psl_sider_header_back
|
|
212
|
+
type: Button
|
|
213
|
+
properties:
|
|
214
|
+
title: Back to app
|
|
215
|
+
icon: arrow-left
|
|
216
|
+
type: link
|
|
217
|
+
size: small
|
|
218
|
+
- id: psl_sider_header_title
|
|
219
|
+
type: Title
|
|
220
|
+
properties:
|
|
221
|
+
content: Acme Inc
|
|
222
|
+
level: 5
|
|
223
|
+
siderHeaderClosed:
|
|
224
|
+
blocks:
|
|
225
|
+
- id: psl_sider_header_closed
|
|
226
|
+
type: Box
|
|
227
|
+
style:
|
|
228
|
+
padding: 8px
|
|
229
|
+
textAlign: center
|
|
230
|
+
blocks:
|
|
231
|
+
- id: psl_sider_header_back_icon
|
|
232
|
+
type: Button
|
|
233
|
+
properties:
|
|
234
|
+
hideTitle: true
|
|
235
|
+
title: Back to app
|
|
236
|
+
icon: arrow-left
|
|
237
|
+
type: link
|
|
238
|
+
mobileDrawerHeader:
|
|
239
|
+
blocks:
|
|
240
|
+
- id: psl_sider_header_drawer
|
|
241
|
+
type: Box
|
|
242
|
+
style:
|
|
243
|
+
padding: 0 24px
|
|
244
|
+
blocks:
|
|
245
|
+
- id: psl_sider_header_drawer_back
|
|
246
|
+
type: Button
|
|
247
|
+
properties:
|
|
248
|
+
title: Back to app
|
|
249
|
+
icon: arrow-left
|
|
250
|
+
type: link
|
|
251
|
+
size: small
|
|
252
|
+
blocks:
|
|
253
|
+
- id: psl_sider_header_content
|
|
254
|
+
type: Paragraph
|
|
255
|
+
properties:
|
|
256
|
+
content: The siderHeader slot sits above the menu and stays in place while a
|
|
257
|
+
long menu scrolls. siderHeaderClosed takes its place while the sider
|
|
258
|
+
is collapsed, and mobileDrawerHeader puts content above the menu in
|
|
259
|
+
the mobile drawer.
|
|
260
|
+
```
|
|
261
|
+
|
|
116
262
|
Custom logo with style overrides. The full logo (src) shows when the sider is expanded, and the square logo (srcMobile) shows when collapsed.
|
|
117
263
|
|
|
118
264
|
```yaml
|
|
@@ -132,7 +278,7 @@ Custom logo with style overrides. The full logo (src) shows when the sider is ex
|
|
|
132
278
|
type: MenuLink
|
|
133
279
|
properties:
|
|
134
280
|
title: Dashboard
|
|
135
|
-
icon:
|
|
281
|
+
icon: Gauge
|
|
136
282
|
blocks:
|
|
137
283
|
- id: psl_logo_content
|
|
138
284
|
type: Paragraph
|
|
@@ -161,19 +307,19 @@ Dashboard Overview
|
|
|
161
307
|
type: MenuLink
|
|
162
308
|
properties:
|
|
163
309
|
title: My Profile
|
|
164
|
-
icon:
|
|
310
|
+
icon: user
|
|
165
311
|
- id: psl_admin_prof_settings
|
|
166
312
|
type: MenuLink
|
|
167
313
|
properties:
|
|
168
314
|
title: Settings
|
|
169
|
-
icon:
|
|
315
|
+
icon: settings
|
|
170
316
|
- id: psl_admin_prof_divider
|
|
171
317
|
type: MenuDivider
|
|
172
318
|
- id: psl_admin_prof_logout
|
|
173
319
|
type: MenuLink
|
|
174
320
|
properties:
|
|
175
321
|
title: Sign Out
|
|
176
|
-
icon:
|
|
322
|
+
icon: logout
|
|
177
323
|
danger: true
|
|
178
324
|
sider:
|
|
179
325
|
width: 240
|
|
@@ -189,12 +335,12 @@ Dashboard Overview
|
|
|
189
335
|
type: MenuLink
|
|
190
336
|
properties:
|
|
191
337
|
title: Dashboard
|
|
192
|
-
icon:
|
|
338
|
+
icon: Gauge
|
|
193
339
|
- id: psl_admin_users_group
|
|
194
340
|
type: MenuGroup
|
|
195
341
|
properties:
|
|
196
342
|
title: User Management
|
|
197
|
-
icon:
|
|
343
|
+
icon: users
|
|
198
344
|
links:
|
|
199
345
|
- id: psl_admin_all_users
|
|
200
346
|
type: MenuLink
|
|
@@ -208,12 +354,12 @@ Dashboard Overview
|
|
|
208
354
|
type: MenuLink
|
|
209
355
|
properties:
|
|
210
356
|
title: Analytics
|
|
211
|
-
icon:
|
|
357
|
+
icon: chart
|
|
212
358
|
- id: psl_admin_settings
|
|
213
359
|
type: MenuLink
|
|
214
360
|
properties:
|
|
215
361
|
title: Settings
|
|
216
|
-
icon:
|
|
362
|
+
icon: settings
|
|
217
363
|
slots:
|
|
218
364
|
siderOpen:
|
|
219
365
|
blocks:
|
|
@@ -227,7 +373,7 @@ Dashboard Overview
|
|
|
227
373
|
properties:
|
|
228
374
|
title: Production
|
|
229
375
|
color: green
|
|
230
|
-
icon:
|
|
376
|
+
icon: Server
|
|
231
377
|
siderClosed:
|
|
232
378
|
blocks:
|
|
233
379
|
- id: psl_admin_sider_closed
|
|
@@ -247,7 +393,8 @@ Dashboard Overview
|
|
|
247
393
|
type: Paragraph
|
|
248
394
|
properties:
|
|
249
395
|
content: Admin Panel v2.4.1
|
|
250
|
-
|
|
396
|
+
style:
|
|
397
|
+
.element:
|
|
251
398
|
textAlign: center
|
|
252
399
|
margin: 0
|
|
253
400
|
color: "#999"
|
|
@@ -275,7 +422,7 @@ Dashboard Overview
|
|
|
275
422
|
properties:
|
|
276
423
|
title: Total Users
|
|
277
424
|
value: 2847
|
|
278
|
-
prefixIcon:
|
|
425
|
+
prefixIcon: user
|
|
279
426
|
- id: psl_admin_stat_revenue
|
|
280
427
|
type: Card
|
|
281
428
|
layout:
|
|
@@ -306,7 +453,7 @@ Dashboard Overview
|
|
|
306
453
|
| Property | Type | Default | Description |
|
|
307
454
|
| --- | --- | --- | --- |
|
|
308
455
|
| `title` | string | - | Page title. Accepted for compatibility. |
|
|
309
|
-
| `theme` | object | - | Antd design token overrides
|
|
456
|
+
| `theme` | object | - | Antd global design token overrides, such as colorPrimary or borderRadius, applied to everything in the page layout. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design component tokens](https://ant.design/docs/react/customize-theme#seedtoken). |
|
|
310
457
|
| `logo` | object | - | Header logo settings. By default, images are served from the app public folder and auto-swap between light and dark variants based on dark mode. See [Hosting Files](/hosting-files) for details. |
|
|
311
458
|
| `logo.src` | string | - | Logo image URL for desktop. Defaults to logo-light-theme.png or logo-dark-theme.png from the public folder (~250x72px), auto-selected based on dark mode. |
|
|
312
459
|
| `logo.srcMobile` | string | - | Logo image URL for mobile. Defaults to logo-square-light-theme.png or logo-square-dark-theme.png from the public folder (~125x125px), auto-selected based on dark mode. |
|
|
@@ -314,16 +461,17 @@ Dashboard Overview
|
|
|
314
461
|
| `logo.style` | object | - | Css style object to apply to logo. |
|
|
315
462
|
| `sider` | object | - | Sider properties. |
|
|
316
463
|
| `sider.collapsedWidth` | integer | - | Width of the collapsed sidebar, by setting to 0 a special trigger will appear. |
|
|
317
|
-
| `sider.collapsible` | boolean | `
|
|
464
|
+
| `sider.collapsible` | boolean | `false` | Show a trigger at the bottom of the sider that collapses and expands it, like the toggle button. |
|
|
318
465
|
| `sider.initialCollapsed` | boolean | `false` | Set the initial collapsed state. |
|
|
319
466
|
| `sider.width` | string \| number | - | Width of the sidebar. |
|
|
320
467
|
| `sider.hideToggleButton` | boolean | `false` | Hide toggle button in sider. |
|
|
321
|
-
| `siderStorageKey` | string | `"sider"` | localStorage key suffix for sider state persistence. Produces key 'lf-{siderStorageKey}-open'. |
|
|
468
|
+
| `siderStorageKey` | string | `"sider"` | localStorage key suffix for sider state persistence. Produces key 'lf-{siderStorageKey}-open', kept per app. |
|
|
322
469
|
| `header` | object | - | Header properties. |
|
|
323
470
|
| `header.contentStyle` | object | - | Header content css style object. |
|
|
324
471
|
| `toggleSiderButton` | object | - | Toggle sider button properties. |
|
|
325
472
|
| `footer` | object | - | Footer properties. |
|
|
326
473
|
| `footer.style` | object | - | Footer css style object. |
|
|
474
|
+
| `padding` | string | `"default"` | Space around the page content. `compact` tightens it to 16px for dense, data-heavy pages. `none` removes it so content such as a table or grid runs edge to edge; the breadcrumb keeps its own inset. Enum: `default`, `compact`, `none`. |
|
|
327
475
|
| `content` | object | - | Content properties. |
|
|
328
476
|
| `content.style` | object | - | Content css style object. |
|
|
329
477
|
| `breadcrumb` | object | - | Breadcrumb properties. |
|
|
@@ -333,14 +481,36 @@ Dashboard Overview
|
|
|
333
481
|
| `breadcrumb.list.$.pageId` | string | - | Page id to link to when clicked. |
|
|
334
482
|
| `breadcrumb.list.$.url` | string | - | External url link. |
|
|
335
483
|
| `breadcrumb.list.$.style` | object | - | Css style to apply to link. |
|
|
336
|
-
| `breadcrumb.list.$.icon` | string \| object | - |
|
|
484
|
+
| `breadcrumb.list.$.icon` | 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 use an icon in breadcrumb link. |
|
|
485
|
+
| `breadcrumb.list.$.icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
486
|
+
| `breadcrumb.list.$.icon.color` | string | - | Icon color. |
|
|
487
|
+
| `breadcrumb.list.$.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
488
|
+
| `breadcrumb.list.$.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
489
|
+
| `breadcrumb.list.$.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
490
|
+
| `breadcrumb.list.$.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
491
|
+
| `breadcrumb.list.$.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
492
|
+
| `breadcrumb.list.$.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
493
|
+
| `breadcrumb.list.$.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
494
|
+
| `breadcrumb.list.$.links` | array | - | Links shown in a dropdown menu on the breadcrumb item. |
|
|
495
|
+
| `breadcrumb.list.$.links.$.label` | string | - | Label of the dropdown link. |
|
|
496
|
+
| `breadcrumb.list.$.links.$.pageId` | string | - | Page id to link to when clicked. |
|
|
497
|
+
| `breadcrumb.list.$.links.$.url` | string | - | External url link. |
|
|
337
498
|
| `menu` | object | - | Menu properties. |
|
|
338
499
|
| `menu.links` | array | - | |
|
|
339
500
|
| `menu.links.$.id` | string | - | Menu item id. |
|
|
340
501
|
| `menu.links.$.pageId` | string | - | Page to link to. |
|
|
341
502
|
| `menu.links.$.properties` | object | - | properties from menu item. |
|
|
342
503
|
| `menu.links.$.properties.title` | string | - | Menu item title. |
|
|
343
|
-
| `menu.links.$.properties.icon` | string \| object | - |
|
|
504
|
+
| `menu.links.$.properties.icon` | string \| object | - | Icon name (a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`) or properties of an Icon block to customize icon on menu item. |
|
|
505
|
+
| `menu.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`. |
|
|
506
|
+
| `menu.links.$.properties.icon.color` | string | - | Icon color. |
|
|
507
|
+
| `menu.links.$.properties.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
508
|
+
| `menu.links.$.properties.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
509
|
+
| `menu.links.$.properties.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
510
|
+
| `menu.links.$.properties.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
511
|
+
| `menu.links.$.properties.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
512
|
+
| `menu.links.$.properties.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
513
|
+
| `menu.links.$.properties.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
344
514
|
| `menuLg` | object | - | Menu large screen properties. Overwrites menu properties on desktop screen sizes. |
|
|
345
515
|
| `menuMd` | object | - | Mobile menu properties. Overwrites menu properties on mobile screen sizes. |
|
|
346
516
|
| `notifications` | object | - | Notification bell icon with badge. Shown in the sider on desktop and the mobile header on small screens. Renders when configured. Use the link property to navigate when clicked. |
|
|
@@ -354,16 +524,34 @@ Dashboard Overview
|
|
|
354
524
|
| `notifications.showZero` | boolean | `false` | Show badge when count is zero. |
|
|
355
525
|
| `notifications.overflowCount` | number | `99` | Max count to show. Values above this display as "N+". |
|
|
356
526
|
| `notifications.color` | string | - | Badge color. |
|
|
357
|
-
| `notifications.icon` | string \| object | - | Icon for the notification button. Defaults to
|
|
527
|
+
| `notifications.icon` | string \| object | - | Icon for the notification button. Defaults to `bell`. |
|
|
528
|
+
| `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`. |
|
|
529
|
+
| `notifications.icon.color` | string | - | Icon color. |
|
|
530
|
+
| `notifications.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
531
|
+
| `notifications.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
532
|
+
| `notifications.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
533
|
+
| `notifications.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
534
|
+
| `notifications.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
535
|
+
| `notifications.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
536
|
+
| `notifications.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
358
537
|
| `notifications.size` | string | `"small"` | Size of the notification button. Enum: `small`, `default`, `large`. |
|
|
359
538
|
| `profile` | object | - | Profile avatar with optional dropdown menu. Shown in the sider on desktop and the mobile header on small screens. Renders when configured. Use with the _user operator to populate from the authenticated user. |
|
|
360
539
|
| `profile.title` | string | `"Profile"` | Label shown next to the avatar when the sider is expanded. Hidden on mobile header and collapsed sider. |
|
|
361
540
|
| `profile.avatar` | object | - | Avatar display properties. |
|
|
362
541
|
| `profile.avatar.src` | string | - | Image URL for the avatar. Typically bound to _user: image. |
|
|
363
542
|
| `profile.avatar.content` | string | - | Text content inside the avatar (e.g. user initials). Shown when no src is provided. |
|
|
364
|
-
| `profile.avatar.icon` | string \| object | - | Icon to display in avatar when no src or content is set. Defaults to
|
|
543
|
+
| `profile.avatar.icon` | string \| object | - | Icon to display in avatar when no src or content is set. Defaults to `user`. |
|
|
544
|
+
| `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`. |
|
|
545
|
+
| `profile.avatar.icon.color` | string | - | Icon color. |
|
|
546
|
+
| `profile.avatar.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
547
|
+
| `profile.avatar.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
548
|
+
| `profile.avatar.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
549
|
+
| `profile.avatar.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
550
|
+
| `profile.avatar.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
551
|
+
| `profile.avatar.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
552
|
+
| `profile.avatar.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
365
553
|
| `profile.avatar.color` | string | - | Background color of the avatar when not using src. |
|
|
366
|
-
| `profile.avatar.size` | string \| number | `"small"` | Size of the avatar
|
|
554
|
+
| `profile.avatar.size` | string \| number | `"small"` | Size of the avatar: default, small, large or a pixel number. |
|
|
367
555
|
| `profile.avatar.shape` | string | `"circle"` | Shape of the avatar. Enum: `circle`, `square`. |
|
|
368
556
|
| `profile.links` | array | - | Dropdown menu items. Uses the same MenuLink/MenuGroup/MenuDivider schema as Menu. Compatible with _menu operator output for access-filtered menus. |
|
|
369
557
|
| `profile.links.$.id` | string | - | Menu item id. |
|
|
@@ -375,6 +563,15 @@ Dashboard Overview
|
|
|
375
563
|
| `profile.links.$.properties` | object | - | Properties for the menu item. |
|
|
376
564
|
| `profile.links.$.properties.title` | string | - | Menu item title. |
|
|
377
565
|
| `profile.links.$.properties.icon` | string \| object | - | Icon for the menu item. |
|
|
566
|
+
| `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`. |
|
|
567
|
+
| `profile.links.$.properties.icon.color` | string | - | Icon color. |
|
|
568
|
+
| `profile.links.$.properties.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
569
|
+
| `profile.links.$.properties.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
570
|
+
| `profile.links.$.properties.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
571
|
+
| `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). |
|
|
572
|
+
| `profile.links.$.properties.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
573
|
+
| `profile.links.$.properties.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
574
|
+
| `profile.links.$.properties.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
378
575
|
| `profile.links.$.properties.danger` | boolean | `false` | Apply danger style to menu item. |
|
|
379
576
|
| `profile.links.$.properties.disabled` | boolean | `false` | Disable the menu item. |
|
|
380
577
|
| `profile.links.$.properties.dashed` | boolean | `false` | Whether the divider line is dashed. |
|
|
@@ -406,11 +603,14 @@ Dashboard Overview
|
|
|
406
603
|
| `/block` | Outer block wrapper (always available). |
|
|
407
604
|
| `/element` | The PageSidebarLayout element. |
|
|
408
605
|
| `/sider` | The PageSidebarLayout sider. |
|
|
606
|
+
| `/siderBody` | The box inside the sider that holds the toggle button, menu and sider slots. |
|
|
607
|
+
| `/siderHeader` | The box above the sider menu that holds the siderHeader or siderHeaderClosed slot. |
|
|
409
608
|
| `/menu` | The PageSidebarLayout menu. |
|
|
410
609
|
| `/mobileHeader` | The PageSidebarLayout mobile header. |
|
|
411
610
|
| `/mobileMenu` | The PageSidebarLayout mobile menu. |
|
|
412
611
|
| `/header` | The PageSidebarLayout header. |
|
|
413
612
|
| `/headerActions` | The header actions container (notifications, profile, dark mode toggle). |
|
|
613
|
+
| `/headerContent` | The PageSidebarLayout header content area (the header slot row). |
|
|
414
614
|
| `/logo` | The PageSidebarLayout logo. |
|
|
415
615
|
| `/notifications` | The notification bell button. |
|
|
416
616
|
| `/notificationsBadge` | The notification badge wrapper. |
|
|
@@ -433,6 +633,9 @@ Dashboard Overview
|
|
|
433
633
|
| `header` | Additional header content. |
|
|
434
634
|
| `mobileDrawerContent` | Content in the mobile menu drawer. |
|
|
435
635
|
| `mobileDrawerFooter` | Footer in the mobile menu drawer. |
|
|
636
|
+
| `mobileDrawerHeader` | Content above the menu in the mobile menu drawer. |
|
|
436
637
|
| `mobileExtra` | Extra content in the mobile header bar. |
|
|
437
638
|
| `siderClosed` | Content shown in the sider when collapsed. |
|
|
639
|
+
| `siderHeader` | Content above the sider menu when expanded. It stays in place while the menu scrolls. |
|
|
640
|
+
| `siderHeaderClosed` | Content above the sider menu when collapsed. |
|
|
438
641
|
| `siderOpen` | Content shown in the sider when expanded. |
|