@lowdefy/docs-content 0.0.0-experimental-20260928120643 → 6.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -1
- package/content/actions/link.md +0 -17
- package/content/actions/login.md +5 -23
- package/content/actions/logout.md +5 -5
- package/content/actions/pdfmake.md +2 -2
- package/content/actions/setdarkmode.md +2 -2
- package/content/agents/agent-properties.md +2 -4
- package/content/agents/agentchat.md +6 -21
- package/content/agents/agentconversations.md +2 -2
- package/content/concepts/ai-agent-docs.md +101 -313
- package/content/concepts/cli.md +3 -34
- package/content/concepts/connections-and-requests.md +0 -402
- package/content/concepts/custom-html.md +0 -40
- package/content/concepts/custom-styling.md +5 -50
- package/content/concepts/events-and-actions.md +2 -64
- package/content/concepts/i18n.md +2 -7
- package/content/concepts/keyboard-shortcuts.md +2 -2
- package/content/concepts/layout-overview.md +1 -1
- package/content/concepts/logger.md +0 -81
- package/content/concepts/lowdefy-schema.md +1 -4
- package/content/concepts/menus.md +7 -7
- package/content/concepts/module-authoring.md +2 -2
- package/content/connections/anthropic.md +2 -162
- package/content/connections/awss3.md +0 -54
- package/content/connections/google.md +2 -162
- package/content/connections/mongodb.md +3 -121
- package/content/connections/openai-connection.md +2 -162
- package/content/container-blocks/affix.md +7 -47
- package/content/container-blocks/alert.md +24 -76
- package/content/container-blocks/badge.md +24 -100
- package/content/container-blocks/box.md +9 -9
- package/content/container-blocks/card.md +25 -80
- package/content/container-blocks/carousel.md +7 -60
- package/content/container-blocks/collapse.md +9 -87
- package/content/container-blocks/configprovider.md +13 -35
- package/content/container-blocks/confirmmodal.md +23 -69
- package/content/container-blocks/content.md +98 -62
- package/content/container-blocks/descriptions.md +4 -45
- package/content/container-blocks/drawer.md +28 -92
- package/content/container-blocks/dropdownmenu.md +31 -119
- package/content/container-blocks/flex.md +62 -40
- package/content/container-blocks/footer.md +11 -15
- package/content/container-blocks/googlemapsheatmap.md +1 -1
- package/content/container-blocks/googlemapsscript.md +2 -2
- package/content/container-blocks/header.md +36 -71
- package/content/container-blocks/label.md +7 -34
- package/content/container-blocks/layout.md +34 -52
- package/content/container-blocks/masonry.md +71 -17
- package/content/container-blocks/mobilemenu.md +88 -131
- package/content/container-blocks/modal.md +26 -114
- package/content/container-blocks/pageheadermenu.md +31 -81
- package/content/container-blocks/pagesidebarlayout.md +26 -169
- package/content/container-blocks/pagesidermenu.md +42 -95
- package/content/container-blocks/popover.md +31 -34
- package/content/container-blocks/result.md +21 -32
- package/content/container-blocks/sider.md +122 -85
- package/content/container-blocks/span.md +7 -7
- package/content/container-blocks/spinner.md +3 -3
- package/content/container-blocks/splitter.md +68 -150
- package/content/container-blocks/tabs.md +12 -64
- package/content/container-blocks/tooltip.md +46 -22
- package/content/container-blocks/watermark.md +4 -22
- package/content/controls/reject.md +2 -4
- package/content/controls/throw.md +0 -1
- package/content/controls/try.md +2 -3
- package/content/deployment/deployment-environments.md +6 -8
- package/content/deployment/docker.md +7 -22
- package/content/deployment/node-server.md +0 -4
- package/content/deployment/vercel.md +6 -13
- package/content/display-blocks/aggrid.md +11 -26
- package/content/display-blocks/anchor.md +15 -15
- package/content/display-blocks/avatar.md +37 -57
- package/content/display-blocks/breadcrumb.md +21 -70
- package/content/display-blocks/button.md +18 -92
- package/content/display-blocks/calendar.md +0 -12
- package/content/display-blocks/dangeroushtml.md +1 -1
- package/content/display-blocks/difflist.md +1 -1
- package/content/display-blocks/difftimeline.md +1 -1
- package/content/display-blocks/divider.md +3 -64
- package/content/display-blocks/dropdownbutton.md +28 -79
- package/content/display-blocks/echart.md +1 -35
- package/content/display-blocks/floatbutton.md +42 -129
- package/content/display-blocks/html.md +1 -61
- package/content/display-blocks/icon.md +67 -250
- package/content/display-blocks/menu.md +73 -145
- package/content/display-blocks/message.md +124 -38
- package/content/display-blocks/notification.md +222 -94
- package/content/display-blocks/paragraph.md +9 -59
- package/content/display-blocks/progress.md +17 -96
- package/content/display-blocks/qrcode.md +4 -19
- package/content/display-blocks/s3download.md +1 -1
- package/content/display-blocks/search.md +7 -17
- package/content/display-blocks/skeletonbutton.md +0 -1
- package/content/display-blocks/skeletoninput.md +0 -1
- package/content/display-blocks/statistic.md +17 -75
- package/content/display-blocks/steps.md +25 -58
- package/content/display-blocks/tag.md +17 -102
- package/content/display-blocks/title.md +11 -50
- package/content/display-blocks/tour.md +23 -33
- package/content/input-blocks/autocomplete.md +9 -81
- package/content/input-blocks/buttonselector.md +8 -45
- package/content/input-blocks/checkboxselector.md +7 -97
- package/content/input-blocks/checkboxswitch.md +3 -33
- package/content/input-blocks/colorselector.md +14 -63
- package/content/input-blocks/daterangeselector.md +45 -165
- package/content/input-blocks/dateselector.md +41 -139
- package/content/input-blocks/datetimeselector.md +49 -158
- package/content/input-blocks/inputgallery.md +3 -3
- package/content/input-blocks/monthselector.md +52 -120
- package/content/input-blocks/multipleselector.md +39 -150
- package/content/input-blocks/numberinput.md +12 -98
- package/content/input-blocks/pagination.md +14 -70
- package/content/input-blocks/paragraphinput.md +37 -51
- package/content/input-blocks/passwordinput.md +6 -60
- package/content/input-blocks/phonenumberinput.md +26 -59
- package/content/input-blocks/radioselector.md +7 -83
- package/content/input-blocks/ratingslider.md +26 -57
- package/content/input-blocks/s3uploadbutton.md +24 -24
- package/content/input-blocks/s3uploaddragger.md +3 -3
- package/content/input-blocks/s3uploadphoto.md +5 -5
- package/content/input-blocks/segmentedselector.md +32 -72
- package/content/input-blocks/selector.md +21 -109
- package/content/input-blocks/switch.md +17 -65
- package/content/input-blocks/textarea.md +3 -32
- package/content/input-blocks/textinput.md +28 -69
- package/content/input-blocks/tiptapmentioninput.md +1 -1
- package/content/input-blocks/titleinput.md +12 -39
- package/content/input-blocks/treeinput.md +25 -49
- package/content/input-blocks/treemultipleselector.md +10 -127
- package/content/input-blocks/treeselector.md +9 -97
- package/content/input-blocks/upload.md +15 -64
- package/content/input-blocks/uploaddragger.md +1 -17
- package/content/input-blocks/uploadphoto.md +1 -18
- package/content/input-blocks/weekselector.md +55 -120
- package/content/list-blocks/controlledlist.md +15 -24
- package/content/list-blocks/list.md +11 -11
- package/content/list-blocks/masonrylist.md +34 -7
- package/content/migration/upgrade-guide.md +0 -1
- package/content/operators/_app.md +1 -2
- package/content/operators/_error.md +1 -23
- package/content/operators/_get.md +6 -6
- package/content/operators/_operator.md +3 -17
- package/content/operators/_ref.md +0 -258
- package/content/operators/_type.md +3 -14
- package/content/operators/_user.md +3 -3
- package/content/other/introduction.md +1 -1
- package/content/plugins/plugins-dev.md +0 -66
- package/content/plugins/plugins-introduction.md +1 -27
- package/content/testing/e2e-configuration.md +1 -8
- package/content/testing/e2e-getting-started.md +1 -1
- package/content/testing/e2e-introduction.md +1 -1
- package/content/tutorial/tutorial-actions-operators.md +2 -2
- package/content/tutorial/tutorial-add-blocks.md +2 -2
- package/content/tutorial/tutorial-create-page.md +2 -48
- package/content/tutorial/tutorial-display-data-page.md +3 -3
- package/content/tutorial/tutorial-requests-sql.md +0 -153
- package/content/tutorial/tutorial-start.md +1 -66
- package/content/user-authentication/login-and-logout.md +8 -158
- package/content/user-authentication/users-introduction.md +0 -8
- package/index.json +2 -6065
- package/package.json +1 -7
- package/scripts/extractAgentDocs.js +4 -36
- package/content/actions/emailotpsend.md +0 -58
- package/content/actions/emailotpverify.md +0 -77
- package/content/actions/getlocalstorage.md +0 -41
- package/content/actions/magiclinkverify.md +0 -113
- package/content/actions/posthogalias.md +0 -29
- package/content/actions/posthogcapture.md +0 -49
- package/content/actions/posthogcapturepageleave.md +0 -38
- package/content/actions/posthogfeatureflag.md +0 -50
- package/content/actions/posthoggroup.md +0 -37
- package/content/actions/posthogidentify.md +0 -54
- package/content/actions/posthoginit.md +0 -66
- package/content/actions/posthogoptin.md +0 -29
- package/content/actions/posthogoptout.md +0 -29
- package/content/actions/posthogpageview.md +0 -37
- package/content/actions/posthogreloadfeatureflags.md +0 -47
- package/content/actions/posthogreset.md +0 -28
- package/content/actions/posthogsetpersonproperties.md +0 -36
- package/content/actions/removelocalstorage.md +0 -26
- package/content/actions/setlocalstorage.md +0 -32
- package/content/adapter-reference/mongodbauthadapter.md +0 -46
- package/content/agents/agents-introduction.md +0 -107
- package/content/callback-reference/auth0logoutcallback.md +0 -54
- package/content/concepts/blocks.md +0 -150
- package/content/concepts/dynamic-page-content.md +0 -304
- package/content/concepts/html-attributes.md +0 -285
- package/content/concepts/lowdefy-api.md +0 -1110
- package/content/concepts/notifications.md +0 -155
- package/content/concepts/page-and-app-state.md +0 -244
- package/content/concepts/theming.md +0 -582
- package/content/connections/aigateway.md +0 -368
- package/content/connections/axioshttp.md +0 -181
- package/content/controls/while.md +0 -46
- package/content/display-blocks/clickablehtml.md +0 -239
- package/content/display-blocks/eventlog.md +0 -363
- package/content/display-blocks/pollingtimer.md +0 -263
- package/content/input-blocks/captcha.md +0 -40
- package/content/input-blocks/placesautocomplete.md +0 -319
- package/content/input-blocks/tagmultipleselector.md +0 -114
- package/content/input-blocks/tagselector.md +0 -114
- package/content/migration/auth-upgrade.md +0 -327
- package/content/migration/v3-to-v4.md +0 -417
- package/content/migration/v6-to-v7.md +0 -222
- package/content/operators/_cron.md +0 -292
- package/content/other/mongodbadapter.md +0 -3
- package/content/plugins/plugins-icon-sets.md +0 -267
- package/content/plugins/posthog.md +0 -275
- package/content/provider-reference/auth-js-providers.md +0 -107
- package/content/provider-reference/openidconnectprovider.md +0 -44
- package/content/testing/config-tests.md +0 -278
- package/content/tutorial/tutorial-requests-api.md +0 -155
- package/content/user-authentication/auth-configuration.md +0 -266
- package/content/user-authentication/auth-steps.md +0 -138
- package/content/user-authentication/mcp-oauth.md +0 -292
- package/content/user-authentication/organizations.md +0 -221
- package/content/user-authentication/protected-pages-apis.md +0 -97
- package/content/user-authentication/roles.md +0 -49
- package/content/user-authentication/two-factor.md +0 -229
- package/content/user-authentication/user-object.md +0 -58
- package/content/websockets/websocket-publish.md +0 -108
- package/content/websockets/websocket-subscriptions.md +0 -100
- package/content/websockets/websockets-introduction.md +0 -97
- package/hazards.json +0 -44
- package/scripts/hashDocSources.js +0 -38
- package/scripts/recordSourceHashes.js +0 -88
|
@@ -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: AiOutlineDashboard
|
|
22
22
|
- id: psl_basic_users
|
|
23
23
|
type: MenuLink
|
|
24
24
|
properties:
|
|
25
25
|
title: Users
|
|
26
|
-
icon:
|
|
26
|
+
icon: AiOutlineUser
|
|
27
27
|
- id: psl_basic_settings
|
|
28
28
|
type: MenuLink
|
|
29
29
|
properties:
|
|
30
30
|
title: Settings
|
|
31
|
-
icon:
|
|
31
|
+
icon: AiOutlineSetting
|
|
32
32
|
blocks:
|
|
33
33
|
- id: psl_basic_content
|
|
34
34
|
type: Paragraph
|
|
@@ -54,12 +54,12 @@ Sider starts collapsed. Click the toggle button to expand. The collapsed state i
|
|
|
54
54
|
type: MenuLink
|
|
55
55
|
properties:
|
|
56
56
|
title: Dashboard
|
|
57
|
-
icon:
|
|
57
|
+
icon: AiOutlineDashboard
|
|
58
58
|
- id: psl_collapsed_users
|
|
59
59
|
type: MenuLink
|
|
60
60
|
properties:
|
|
61
61
|
title: Users
|
|
62
|
-
icon:
|
|
62
|
+
icon: AiOutlineUser
|
|
63
63
|
blocks:
|
|
64
64
|
- id: psl_collapsed_content
|
|
65
65
|
type: Paragraph
|
|
@@ -86,12 +86,12 @@ Optional desktop header with custom content. The header sits inside the content
|
|
|
86
86
|
type: MenuLink
|
|
87
87
|
properties:
|
|
88
88
|
title: Dashboard
|
|
89
|
-
icon:
|
|
89
|
+
icon: AiOutlineDashboard
|
|
90
90
|
- id: psl_header_settings
|
|
91
91
|
type: MenuLink
|
|
92
92
|
properties:
|
|
93
93
|
title: Settings
|
|
94
|
-
icon:
|
|
94
|
+
icon: AiOutlineSetting
|
|
95
95
|
slots:
|
|
96
96
|
header:
|
|
97
97
|
blocks:
|
|
@@ -101,7 +101,7 @@ Optional desktop header with custom content. The header sits inside the content
|
|
|
101
101
|
flex: 0 0 auto
|
|
102
102
|
properties:
|
|
103
103
|
title: Search
|
|
104
|
-
icon:
|
|
104
|
+
icon: AiOutlineSearch
|
|
105
105
|
color: default
|
|
106
106
|
variant: outlined
|
|
107
107
|
size: small
|
|
@@ -113,93 +113,6 @@ Optional desktop header with custom content. The header sits inside the content
|
|
|
113
113
|
content area, not above the sider.
|
|
114
114
|
```
|
|
115
115
|
|
|
116
|
-
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.
|
|
117
|
-
|
|
118
|
-
Acme Inc
|
|
119
|
-
|
|
120
|
-
```yaml
|
|
121
|
-
- id: psl_sider_header
|
|
122
|
-
type: PageSidebarLayout
|
|
123
|
-
properties:
|
|
124
|
-
siderStorageKey: psl_sider_header
|
|
125
|
-
sider:
|
|
126
|
-
width: 240
|
|
127
|
-
menu:
|
|
128
|
-
links:
|
|
129
|
-
- id: psl_sider_header_general
|
|
130
|
-
type: MenuLink
|
|
131
|
-
properties:
|
|
132
|
-
title: General
|
|
133
|
-
icon: settings
|
|
134
|
-
- id: psl_sider_header_members
|
|
135
|
-
type: MenuLink
|
|
136
|
-
properties:
|
|
137
|
-
title: Members
|
|
138
|
-
icon: users
|
|
139
|
-
- id: psl_sider_header_billing
|
|
140
|
-
type: MenuLink
|
|
141
|
-
properties:
|
|
142
|
-
title: Billing
|
|
143
|
-
icon: CreditCard
|
|
144
|
-
slots:
|
|
145
|
-
siderHeader:
|
|
146
|
-
blocks:
|
|
147
|
-
- id: psl_sider_header_open
|
|
148
|
-
type: Box
|
|
149
|
-
style:
|
|
150
|
-
padding: 8px 16px
|
|
151
|
-
blocks:
|
|
152
|
-
- id: psl_sider_header_back
|
|
153
|
-
type: Button
|
|
154
|
-
properties:
|
|
155
|
-
title: Back to app
|
|
156
|
-
icon: arrow-left
|
|
157
|
-
type: link
|
|
158
|
-
size: small
|
|
159
|
-
- id: psl_sider_header_title
|
|
160
|
-
type: Title
|
|
161
|
-
properties:
|
|
162
|
-
content: Acme Inc
|
|
163
|
-
level: 5
|
|
164
|
-
siderHeaderClosed:
|
|
165
|
-
blocks:
|
|
166
|
-
- id: psl_sider_header_closed
|
|
167
|
-
type: Box
|
|
168
|
-
style:
|
|
169
|
-
padding: 8px
|
|
170
|
-
textAlign: center
|
|
171
|
-
blocks:
|
|
172
|
-
- id: psl_sider_header_back_icon
|
|
173
|
-
type: Button
|
|
174
|
-
properties:
|
|
175
|
-
hideTitle: true
|
|
176
|
-
title: Back to app
|
|
177
|
-
icon: arrow-left
|
|
178
|
-
type: link
|
|
179
|
-
mobileDrawerHeader:
|
|
180
|
-
blocks:
|
|
181
|
-
- id: psl_sider_header_drawer
|
|
182
|
-
type: Box
|
|
183
|
-
style:
|
|
184
|
-
padding: 0 24px
|
|
185
|
-
blocks:
|
|
186
|
-
- id: psl_sider_header_drawer_back
|
|
187
|
-
type: Button
|
|
188
|
-
properties:
|
|
189
|
-
title: Back to app
|
|
190
|
-
icon: arrow-left
|
|
191
|
-
type: link
|
|
192
|
-
size: small
|
|
193
|
-
blocks:
|
|
194
|
-
- id: psl_sider_header_content
|
|
195
|
-
type: Paragraph
|
|
196
|
-
properties:
|
|
197
|
-
content: The siderHeader slot sits above the menu and stays in place while a
|
|
198
|
-
long menu scrolls. siderHeaderClosed takes its place while the sider
|
|
199
|
-
is collapsed, and mobileDrawerHeader puts content above the menu in
|
|
200
|
-
the mobile drawer.
|
|
201
|
-
```
|
|
202
|
-
|
|
203
116
|
Custom logo with style overrides. The full logo (src) shows when the sider is expanded, and the square logo (srcMobile) shows when collapsed.
|
|
204
117
|
|
|
205
118
|
```yaml
|
|
@@ -219,7 +132,7 @@ Custom logo with style overrides. The full logo (src) shows when the sider is ex
|
|
|
219
132
|
type: MenuLink
|
|
220
133
|
properties:
|
|
221
134
|
title: Dashboard
|
|
222
|
-
icon:
|
|
135
|
+
icon: AiOutlineDashboard
|
|
223
136
|
blocks:
|
|
224
137
|
- id: psl_logo_content
|
|
225
138
|
type: Paragraph
|
|
@@ -248,19 +161,19 @@ Dashboard Overview
|
|
|
248
161
|
type: MenuLink
|
|
249
162
|
properties:
|
|
250
163
|
title: My Profile
|
|
251
|
-
icon:
|
|
164
|
+
icon: AiOutlineUser
|
|
252
165
|
- id: psl_admin_prof_settings
|
|
253
166
|
type: MenuLink
|
|
254
167
|
properties:
|
|
255
168
|
title: Settings
|
|
256
|
-
icon:
|
|
169
|
+
icon: AiOutlineSetting
|
|
257
170
|
- id: psl_admin_prof_divider
|
|
258
171
|
type: MenuDivider
|
|
259
172
|
- id: psl_admin_prof_logout
|
|
260
173
|
type: MenuLink
|
|
261
174
|
properties:
|
|
262
175
|
title: Sign Out
|
|
263
|
-
icon:
|
|
176
|
+
icon: AiOutlineLogout
|
|
264
177
|
danger: true
|
|
265
178
|
sider:
|
|
266
179
|
width: 240
|
|
@@ -276,12 +189,12 @@ Dashboard Overview
|
|
|
276
189
|
type: MenuLink
|
|
277
190
|
properties:
|
|
278
191
|
title: Dashboard
|
|
279
|
-
icon:
|
|
192
|
+
icon: AiOutlineDashboard
|
|
280
193
|
- id: psl_admin_users_group
|
|
281
194
|
type: MenuGroup
|
|
282
195
|
properties:
|
|
283
196
|
title: User Management
|
|
284
|
-
icon:
|
|
197
|
+
icon: AiOutlineTeam
|
|
285
198
|
links:
|
|
286
199
|
- id: psl_admin_all_users
|
|
287
200
|
type: MenuLink
|
|
@@ -295,12 +208,12 @@ Dashboard Overview
|
|
|
295
208
|
type: MenuLink
|
|
296
209
|
properties:
|
|
297
210
|
title: Analytics
|
|
298
|
-
icon:
|
|
211
|
+
icon: AiOutlineBarChart
|
|
299
212
|
- id: psl_admin_settings
|
|
300
213
|
type: MenuLink
|
|
301
214
|
properties:
|
|
302
215
|
title: Settings
|
|
303
|
-
icon:
|
|
216
|
+
icon: AiOutlineSetting
|
|
304
217
|
slots:
|
|
305
218
|
siderOpen:
|
|
306
219
|
blocks:
|
|
@@ -314,7 +227,7 @@ Dashboard Overview
|
|
|
314
227
|
properties:
|
|
315
228
|
title: Production
|
|
316
229
|
color: green
|
|
317
|
-
icon:
|
|
230
|
+
icon: AiOutlineCloudServer
|
|
318
231
|
siderClosed:
|
|
319
232
|
blocks:
|
|
320
233
|
- id: psl_admin_sider_closed
|
|
@@ -334,8 +247,7 @@ Dashboard Overview
|
|
|
334
247
|
type: Paragraph
|
|
335
248
|
properties:
|
|
336
249
|
content: Admin Panel v2.4.1
|
|
337
|
-
|
|
338
|
-
.element:
|
|
250
|
+
style:
|
|
339
251
|
textAlign: center
|
|
340
252
|
margin: 0
|
|
341
253
|
color: "#999"
|
|
@@ -363,7 +275,7 @@ Dashboard Overview
|
|
|
363
275
|
properties:
|
|
364
276
|
title: Total Users
|
|
365
277
|
value: 2847
|
|
366
|
-
prefixIcon:
|
|
278
|
+
prefixIcon: AiOutlineUser
|
|
367
279
|
- id: psl_admin_stat_revenue
|
|
368
280
|
type: Card
|
|
369
281
|
layout:
|
|
@@ -394,7 +306,7 @@ Dashboard Overview
|
|
|
394
306
|
| Property | Type | Default | Description |
|
|
395
307
|
| --- | --- | --- | --- |
|
|
396
308
|
| `title` | string | - | Page title. Accepted for compatibility. |
|
|
397
|
-
| `theme` | object | - | Antd
|
|
309
|
+
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). |
|
|
398
310
|
| `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. |
|
|
399
311
|
| `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. |
|
|
400
312
|
| `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. |
|
|
@@ -402,7 +314,7 @@ Dashboard Overview
|
|
|
402
314
|
| `logo.style` | object | - | Css style object to apply to logo. |
|
|
403
315
|
| `sider` | object | - | Sider properties. |
|
|
404
316
|
| `sider.collapsedWidth` | integer | - | Width of the collapsed sidebar, by setting to 0 a special trigger will appear. |
|
|
405
|
-
| `sider.collapsible` | boolean | `
|
|
317
|
+
| `sider.collapsible` | boolean | `true` | Whether can be collapsed. |
|
|
406
318
|
| `sider.initialCollapsed` | boolean | `false` | Set the initial collapsed state. |
|
|
407
319
|
| `sider.width` | string \| number | - | Width of the sidebar. |
|
|
408
320
|
| `sider.hideToggleButton` | boolean | `false` | Hide toggle button in sider. |
|
|
@@ -421,36 +333,14 @@ Dashboard Overview
|
|
|
421
333
|
| `breadcrumb.list.$.pageId` | string | - | Page id to link to when clicked. |
|
|
422
334
|
| `breadcrumb.list.$.url` | string | - | External url link. |
|
|
423
335
|
| `breadcrumb.list.$.style` | object | - | Css style to apply to link. |
|
|
424
|
-
| `breadcrumb.list.$.icon` | string \| object | - |
|
|
425
|
-
| `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`. |
|
|
426
|
-
| `breadcrumb.list.$.icon.color` | string | - | Icon color. |
|
|
427
|
-
| `breadcrumb.list.$.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
428
|
-
| `breadcrumb.list.$.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
429
|
-
| `breadcrumb.list.$.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
430
|
-
| `breadcrumb.list.$.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
431
|
-
| `breadcrumb.list.$.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
432
|
-
| `breadcrumb.list.$.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
433
|
-
| `breadcrumb.list.$.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
434
|
-
| `breadcrumb.list.$.links` | array | - | Links shown in a dropdown menu on the breadcrumb item. |
|
|
435
|
-
| `breadcrumb.list.$.links.$.label` | string | - | Label of the dropdown link. |
|
|
436
|
-
| `breadcrumb.list.$.links.$.pageId` | string | - | Page id to link to when clicked. |
|
|
437
|
-
| `breadcrumb.list.$.links.$.url` | string | - | External url link. |
|
|
336
|
+
| `breadcrumb.list.$.icon` | string \| object | - | Name of an React-Icon (See all icons) or properties of an Icon block to use an icon in breadcrumb link. |
|
|
438
337
|
| `menu` | object | - | Menu properties. |
|
|
439
338
|
| `menu.links` | array | - | |
|
|
440
339
|
| `menu.links.$.id` | string | - | Menu item id. |
|
|
441
340
|
| `menu.links.$.pageId` | string | - | Page to link to. |
|
|
442
341
|
| `menu.links.$.properties` | object | - | properties from menu item. |
|
|
443
342
|
| `menu.links.$.properties.title` | string | - | Menu item title. |
|
|
444
|
-
| `menu.links.$.properties.icon` | string \| object | - |
|
|
445
|
-
| `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`. |
|
|
446
|
-
| `menu.links.$.properties.icon.color` | string | - | Icon color. |
|
|
447
|
-
| `menu.links.$.properties.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
448
|
-
| `menu.links.$.properties.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
449
|
-
| `menu.links.$.properties.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
450
|
-
| `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). |
|
|
451
|
-
| `menu.links.$.properties.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
452
|
-
| `menu.links.$.properties.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
453
|
-
| `menu.links.$.properties.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
343
|
+
| `menu.links.$.properties.icon` | string \| object | - | Name of an React-Icon (See all icons) or properties of an Icon block to customize icon on menu item. |
|
|
454
344
|
| `menuLg` | object | - | Menu large screen properties. Overwrites menu properties on desktop screen sizes. |
|
|
455
345
|
| `menuMd` | object | - | Mobile menu properties. Overwrites menu properties on mobile screen sizes. |
|
|
456
346
|
| `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. |
|
|
@@ -464,34 +354,16 @@ Dashboard Overview
|
|
|
464
354
|
| `notifications.showZero` | boolean | `false` | Show badge when count is zero. |
|
|
465
355
|
| `notifications.overflowCount` | number | `99` | Max count to show. Values above this display as "N+". |
|
|
466
356
|
| `notifications.color` | string | - | Badge color. |
|
|
467
|
-
| `notifications.icon` | string \| object | - | Icon for the notification button. Defaults to
|
|
468
|
-
| `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`. |
|
|
469
|
-
| `notifications.icon.color` | string | - | Icon color. |
|
|
470
|
-
| `notifications.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
471
|
-
| `notifications.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
472
|
-
| `notifications.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
473
|
-
| `notifications.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
474
|
-
| `notifications.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
475
|
-
| `notifications.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
476
|
-
| `notifications.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
357
|
+
| `notifications.icon` | string \| object | - | Icon for the notification button. Defaults to AiOutlineBell. |
|
|
477
358
|
| `notifications.size` | string | `"small"` | Size of the notification button. Enum: `small`, `default`, `large`. |
|
|
478
359
|
| `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. |
|
|
479
360
|
| `profile.title` | string | `"Profile"` | Label shown next to the avatar when the sider is expanded. Hidden on mobile header and collapsed sider. |
|
|
480
361
|
| `profile.avatar` | object | - | Avatar display properties. |
|
|
481
362
|
| `profile.avatar.src` | string | - | Image URL for the avatar. Typically bound to _user: image. |
|
|
482
363
|
| `profile.avatar.content` | string | - | Text content inside the avatar (e.g. user initials). Shown when no src is provided. |
|
|
483
|
-
| `profile.avatar.icon` | string \| object | - | Icon to display in avatar when no src or content is set. Defaults to
|
|
484
|
-
| `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`. |
|
|
485
|
-
| `profile.avatar.icon.color` | string | - | Icon color. |
|
|
486
|
-
| `profile.avatar.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
487
|
-
| `profile.avatar.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
488
|
-
| `profile.avatar.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
489
|
-
| `profile.avatar.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
490
|
-
| `profile.avatar.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
491
|
-
| `profile.avatar.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
492
|
-
| `profile.avatar.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
364
|
+
| `profile.avatar.icon` | string \| object | - | Icon to display in avatar when no src or content is set. Defaults to AiOutlineUser. |
|
|
493
365
|
| `profile.avatar.color` | string | - | Background color of the avatar when not using src. |
|
|
494
|
-
| `profile.avatar.size` | string \| number | `"small"` | Size of the avatar: default
|
|
366
|
+
| `profile.avatar.size` | string \| number | `"small"` | Size of the avatar. Enum: `default`, `small`, `large`. |
|
|
495
367
|
| `profile.avatar.shape` | string | `"circle"` | Shape of the avatar. Enum: `circle`, `square`. |
|
|
496
368
|
| `profile.links` | array | - | Dropdown menu items. Uses the same MenuLink/MenuGroup/MenuDivider schema as Menu. Compatible with _menu operator output for access-filtered menus. |
|
|
497
369
|
| `profile.links.$.id` | string | - | Menu item id. |
|
|
@@ -503,15 +375,6 @@ Dashboard Overview
|
|
|
503
375
|
| `profile.links.$.properties` | object | - | Properties for the menu item. |
|
|
504
376
|
| `profile.links.$.properties.title` | string | - | Menu item title. |
|
|
505
377
|
| `profile.links.$.properties.icon` | string \| object | - | Icon for the menu item. |
|
|
506
|
-
| `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`. |
|
|
507
|
-
| `profile.links.$.properties.icon.color` | string | - | Icon color. |
|
|
508
|
-
| `profile.links.$.properties.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
509
|
-
| `profile.links.$.properties.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
510
|
-
| `profile.links.$.properties.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
511
|
-
| `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). |
|
|
512
|
-
| `profile.links.$.properties.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
513
|
-
| `profile.links.$.properties.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
514
|
-
| `profile.links.$.properties.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
515
378
|
| `profile.links.$.properties.danger` | boolean | `false` | Apply danger style to menu item. |
|
|
516
379
|
| `profile.links.$.properties.disabled` | boolean | `false` | Disable the menu item. |
|
|
517
380
|
| `profile.links.$.properties.dashed` | boolean | `false` | Whether the divider line is dashed. |
|
|
@@ -543,14 +406,11 @@ Dashboard Overview
|
|
|
543
406
|
| `/block` | Outer block wrapper (always available). |
|
|
544
407
|
| `/element` | The PageSidebarLayout element. |
|
|
545
408
|
| `/sider` | The PageSidebarLayout sider. |
|
|
546
|
-
| `/siderBody` | The box inside the sider that holds the toggle button, menu and sider slots. |
|
|
547
|
-
| `/siderHeader` | The box above the sider menu that holds the siderHeader or siderHeaderClosed slot. |
|
|
548
409
|
| `/menu` | The PageSidebarLayout menu. |
|
|
549
410
|
| `/mobileHeader` | The PageSidebarLayout mobile header. |
|
|
550
411
|
| `/mobileMenu` | The PageSidebarLayout mobile menu. |
|
|
551
412
|
| `/header` | The PageSidebarLayout header. |
|
|
552
413
|
| `/headerActions` | The header actions container (notifications, profile, dark mode toggle). |
|
|
553
|
-
| `/headerContent` | The PageSidebarLayout header content area (the header slot row). |
|
|
554
414
|
| `/logo` | The PageSidebarLayout logo. |
|
|
555
415
|
| `/notifications` | The notification bell button. |
|
|
556
416
|
| `/notificationsBadge` | The notification badge wrapper. |
|
|
@@ -573,9 +433,6 @@ Dashboard Overview
|
|
|
573
433
|
| `header` | Additional header content. |
|
|
574
434
|
| `mobileDrawerContent` | Content in the mobile menu drawer. |
|
|
575
435
|
| `mobileDrawerFooter` | Footer in the mobile menu drawer. |
|
|
576
|
-
| `mobileDrawerHeader` | Content above the menu in the mobile menu drawer. |
|
|
577
436
|
| `mobileExtra` | Extra content in the mobile header bar. |
|
|
578
437
|
| `siderClosed` | Content shown in the sider when collapsed. |
|
|
579
|
-
| `siderHeader` | Content above the sider menu when expanded. It stays in place while the menu scrolls. |
|
|
580
|
-
| `siderHeaderClosed` | Content above the sider menu when collapsed. |
|
|
581
438
|
| `siderOpen` | Content shown in the sider when expanded. |
|