@lowdefy/docs-content 6.1.0 → 7.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -0
- package/content/actions/downloadcsv.md +1 -1
- package/content/actions/emailotpsend.md +58 -0
- package/content/actions/emailotpverify.md +79 -0
- package/content/actions/getlocalstorage.md +43 -0
- package/content/actions/link.md +47 -1
- package/content/actions/login.md +25 -5
- package/content/actions/logout.md +7 -5
- package/content/actions/magiclinkverify.md +117 -0
- package/content/actions/pdfmake.md +2 -2
- package/content/actions/posthogalias.md +29 -0
- package/content/actions/posthogcapture.md +49 -0
- package/content/actions/posthogcapturepageleave.md +38 -0
- package/content/actions/posthogfeatureflag.md +50 -0
- package/content/actions/posthoggroup.md +37 -0
- package/content/actions/posthogidentify.md +54 -0
- package/content/actions/posthoginit.md +96 -0
- package/content/actions/posthogoptin.md +29 -0
- package/content/actions/posthogoptout.md +29 -0
- package/content/actions/posthogpageview.md +37 -0
- package/content/actions/posthogreloadfeatureflags.md +47 -0
- package/content/actions/posthogreset.md +28 -0
- package/content/actions/posthogsetpersonproperties.md +36 -0
- package/content/actions/removelocalstorage.md +28 -0
- package/content/actions/resetvalidation.md +7 -3
- package/content/actions/setdarkmode.md +3 -3
- package/content/actions/setglobal.md +2 -0
- package/content/actions/setlocale.md +1 -1
- package/content/actions/setlocalstorage.md +34 -0
- package/content/actions/validate.md +7 -4
- package/content/adapter-reference/mongodbauthadapter.md +46 -0
- package/content/agents/agent-endpoint-tools.md +24 -0
- package/content/agents/agent-properties.md +13 -3
- package/content/agents/agent-server-hooks.md +1 -1
- package/content/agents/agentchat.md +43 -7
- package/content/agents/agentconversations.md +42 -8
- package/content/agents/agents-introduction.md +107 -0
- package/content/callback-reference/auth0logoutcallback.md +54 -0
- package/content/concepts/ai-agent-docs.md +455 -106
- package/content/concepts/blocks.md +150 -0
- package/content/concepts/connections-and-requests.md +402 -0
- package/content/concepts/custom-html.md +42 -0
- package/content/concepts/custom-styling.md +50 -5
- package/content/concepts/dynamic-page-content.md +309 -0
- package/content/concepts/events-and-actions.md +154 -2
- package/content/concepts/four-primitives.md +31 -0
- package/content/concepts/html-attributes.md +293 -0
- package/content/concepts/i18n.md +8 -3
- package/content/concepts/keyboard-shortcuts.md +2 -2
- package/content/concepts/layout-overview.md +1 -1
- package/content/concepts/logger.md +99 -0
- package/content/concepts/lowdefy-api.md +1319 -0
- package/content/concepts/lowdefy-schema.md +136 -3
- package/content/concepts/menus.md +8 -7
- package/content/concepts/module-authoring.md +76 -5
- package/content/concepts/modules.md +3 -1
- package/content/concepts/notifications.md +180 -0
- package/content/concepts/operators.md +7 -0
- package/content/concepts/page-and-app-state.md +252 -0
- package/content/concepts/page-paths.md +209 -0
- package/content/concepts/theming.md +582 -0
- package/content/connections/aigateway.md +375 -0
- package/content/connections/anthropic.md +169 -2
- package/content/connections/awss3.md +178 -2
- package/content/connections/axioshttp.md +181 -0
- package/content/connections/google.md +169 -2
- package/content/connections/mongodb.md +1014 -3
- package/content/connections/openai-connection.md +169 -2
- package/content/connections/sendgridmail.md +2 -0
- package/content/connections/smtp.md +3 -1
- package/content/connections/treg.md +329 -0
- package/content/container-blocks/affix.md +47 -7
- package/content/container-blocks/alert.md +76 -24
- package/content/container-blocks/badge.md +100 -24
- package/content/container-blocks/box.md +9 -9
- package/content/container-blocks/card.md +132 -27
- package/content/container-blocks/carousel.md +60 -7
- package/content/container-blocks/collapse.md +153 -9
- package/content/container-blocks/configprovider.md +35 -13
- package/content/container-blocks/confirmmodal.md +69 -23
- package/content/container-blocks/content.md +62 -98
- package/content/container-blocks/descriptions.md +45 -4
- package/content/container-blocks/drawer.md +139 -28
- package/content/container-blocks/dropdownmenu.md +119 -31
- package/content/container-blocks/flex.md +40 -62
- package/content/container-blocks/footer.md +15 -11
- package/content/container-blocks/googlemapsheatmap.md +1 -1
- package/content/container-blocks/googlemapsscript.md +2 -2
- package/content/container-blocks/header.md +71 -36
- package/content/container-blocks/label.md +34 -7
- package/content/container-blocks/layout.md +52 -34
- package/content/container-blocks/masonry.md +17 -71
- package/content/container-blocks/mobilemenu.md +131 -88
- package/content/container-blocks/modal.md +161 -26
- package/content/container-blocks/pageheadermenu.md +138 -31
- package/content/container-blocks/pagesidebarlayout.md +230 -27
- package/content/container-blocks/pagesidermenu.md +153 -43
- package/content/container-blocks/popover.md +34 -31
- package/content/container-blocks/result.md +32 -21
- package/content/container-blocks/sider.md +85 -122
- package/content/container-blocks/span.md +7 -7
- package/content/container-blocks/spinner.md +3 -3
- package/content/container-blocks/splitter.md +150 -68
- package/content/container-blocks/tabs.md +64 -12
- package/content/container-blocks/tooltip.md +22 -46
- package/content/container-blocks/watermark.md +22 -4
- package/content/controls/parallel_for.md +21 -2
- package/content/controls/reject.md +24 -3
- package/content/controls/return.md +17 -1
- package/content/controls/throw.md +1 -0
- package/content/controls/try.md +4 -2
- package/content/controls/while.md +46 -0
- package/content/deployment/deployment-environments.md +10 -7
- package/content/deployment/docker.md +22 -7
- package/content/deployment/node-server.md +4 -0
- package/content/deployment/vercel.md +17 -6
- package/content/display-blocks/aggrid.md +36 -19
- package/content/display-blocks/anchor.md +16 -15
- package/content/display-blocks/avatar.md +57 -37
- package/content/display-blocks/breadcrumb.md +70 -21
- package/content/display-blocks/button.md +93 -19
- package/content/display-blocks/calendar.md +12 -0
- package/content/display-blocks/clickablehtml.md +239 -0
- package/content/display-blocks/dangeroushtml.md +1 -1
- package/content/display-blocks/difflist.md +1 -1
- package/content/display-blocks/difftimeline.md +1 -1
- package/content/display-blocks/divider.md +64 -3
- package/content/display-blocks/dropdownbutton.md +81 -30
- package/content/display-blocks/echart.md +35 -1
- package/content/display-blocks/eventlog.md +363 -0
- package/content/display-blocks/floatbutton.md +129 -42
- package/content/display-blocks/html.md +61 -1
- package/content/display-blocks/icon.md +250 -67
- package/content/display-blocks/img.md +2 -2
- package/content/display-blocks/menu.md +146 -73
- package/content/display-blocks/message.md +38 -124
- package/content/display-blocks/notification.md +94 -222
- package/content/display-blocks/paragraph.md +59 -9
- package/content/display-blocks/pollingtimer.md +263 -0
- package/content/display-blocks/progress.md +96 -17
- package/content/display-blocks/qrcode.md +19 -4
- package/content/display-blocks/s3download.md +1 -1
- package/content/display-blocks/search.md +19 -9
- package/content/display-blocks/skeletonbutton.md +1 -0
- package/content/display-blocks/skeletoninput.md +1 -0
- package/content/display-blocks/statistic.md +75 -17
- package/content/display-blocks/steps.md +58 -25
- package/content/display-blocks/table.md +2527 -0
- package/content/display-blocks/tablelight.md +621 -0
- package/content/display-blocks/tag.md +102 -17
- package/content/display-blocks/title.md +50 -11
- package/content/display-blocks/tour.md +33 -23
- package/content/input-blocks/autocomplete.md +81 -9
- package/content/input-blocks/buttonselector.md +45 -8
- package/content/input-blocks/captcha.md +40 -0
- package/content/input-blocks/checkboxselector.md +97 -7
- package/content/input-blocks/checkboxswitch.md +33 -3
- package/content/input-blocks/colorselector.md +63 -14
- package/content/input-blocks/daterangeselector.md +165 -45
- package/content/input-blocks/dateselector.md +139 -41
- package/content/input-blocks/datetimeselector.md +158 -49
- package/content/input-blocks/inputgallery.md +3 -3
- package/content/input-blocks/intentinput.md +207 -0
- package/content/input-blocks/monthselector.md +120 -52
- package/content/input-blocks/multipleselector.md +150 -39
- package/content/input-blocks/numberinput.md +98 -12
- package/content/input-blocks/pagination.md +70 -14
- package/content/input-blocks/paragraphinput.md +51 -37
- package/content/input-blocks/passwordinput.md +60 -6
- package/content/input-blocks/phonenumberinput.md +59 -26
- package/content/input-blocks/placesautocomplete.md +319 -0
- package/content/input-blocks/radioselector.md +83 -7
- package/content/input-blocks/ratingslider.md +57 -26
- package/content/input-blocks/s3uploadbutton.md +24 -24
- package/content/input-blocks/s3uploaddragger.md +3 -3
- package/content/input-blocks/s3uploadphoto.md +5 -5
- package/content/input-blocks/segmentedselector.md +72 -32
- package/content/input-blocks/selector.md +109 -21
- package/content/input-blocks/switch.md +65 -17
- package/content/input-blocks/tableinput.md +445 -0
- package/content/input-blocks/tagmultipleselector.md +114 -0
- package/content/input-blocks/tagselector.md +114 -0
- package/content/input-blocks/textarea.md +32 -3
- package/content/input-blocks/textinput.md +70 -29
- package/content/input-blocks/tiptapinput.md +1 -1
- package/content/input-blocks/tiptapmentioninput.md +2 -2
- package/content/input-blocks/titleinput.md +39 -12
- package/content/input-blocks/treeinput.md +49 -25
- package/content/input-blocks/treemultipleselector.md +127 -10
- package/content/input-blocks/treeselector.md +97 -9
- package/content/input-blocks/upload.md +64 -15
- package/content/input-blocks/uploaddragger.md +17 -1
- package/content/input-blocks/uploadphoto.md +18 -1
- package/content/input-blocks/weekselector.md +120 -55
- package/content/learn/introduction.md +27 -0
- package/content/learn/quickstart.md +53 -0
- package/content/list-blocks/controlledlist.md +24 -15
- package/content/list-blocks/list.md +11 -11
- package/content/list-blocks/masonrylist.md +7 -34
- package/content/migration/auth-upgrade.md +337 -0
- package/content/migration/upgrade-guide.md +1 -0
- package/content/migration/v3-to-v4.md +417 -0
- package/content/migration/v6-to-v7.md +620 -0
- package/content/operators/_agent.md +155 -0
- package/content/operators/_app.md +2 -1
- package/content/operators/_array.md +122 -1
- package/content/operators/_build.md +1 -0
- package/content/operators/_credential.md +57 -0
- package/content/operators/_cron.md +292 -0
- package/content/operators/_date.md +2 -0
- package/content/operators/_error.md +24 -1
- package/content/operators/_get.md +6 -6
- package/content/operators/_hmac.md +78 -0
- package/content/operators/_js.md +2 -1
- package/content/operators/_location.md +1 -1
- package/content/operators/_media.md +13 -0
- package/content/operators/_module.md +56 -2
- package/content/operators/_operator.md +17 -3
- package/content/operators/_path_params.md +82 -0
- package/content/operators/_ref.md +258 -0
- package/content/operators/_request.md +1 -1
- package/content/operators/_request_details.md +6 -0
- package/content/operators/_type.md +14 -3
- package/content/operators/_url_query.md +2 -0
- package/content/operators/_user.md +3 -3
- package/content/plugins/plugins-actions.md +10 -0
- package/content/plugins/plugins-connections.md +25 -0
- package/content/plugins/plugins-dev.md +66 -0
- package/content/plugins/plugins-icon-sets.md +267 -0
- package/content/plugins/plugins-introduction.md +27 -1
- package/content/plugins/plugins.md +19 -0
- package/content/plugins/posthog.md +359 -0
- package/content/provider-reference/auth-js-providers.md +107 -0
- package/content/provider-reference/openidconnectprovider.md +44 -0
- package/content/recipes/recipes.md +16 -0
- package/content/reference/actions-reference.md +31 -0
- package/content/reference/blocks-reference.md +35 -0
- package/content/reference/cli.md +403 -0
- package/content/reference/connections-reference.md +23 -0
- package/content/reference/operators-reference.md +47 -0
- package/content/reference/reference.md +16 -0
- package/content/reference/schema-reference.md +12 -0
- package/content/testing/config-tests.md +677 -0
- package/content/testing/e2e-configuration.md +31 -1
- package/content/testing/e2e-getting-started.md +1 -1
- package/content/testing/e2e-introduction.md +1 -1
- package/content/testing/e2e-writing-tests.md +12 -1
- package/content/testing/explore-pull-request.md +136 -0
- package/content/testing/journey-data-sets.md +326 -0
- package/content/tutorial/tutorial-actions-operators.md +2 -2
- package/content/tutorial/tutorial-add-blocks.md +2 -2
- package/content/tutorial/tutorial-create-page.md +48 -2
- package/content/tutorial/tutorial-display-data-page.md +3 -3
- package/content/tutorial/tutorial-requests-api.md +155 -0
- package/content/tutorial/tutorial-requests-sql.md +153 -0
- package/content/tutorial/tutorial-start.md +66 -1
- package/content/user-authentication/auth-configuration.md +267 -0
- package/content/user-authentication/auth-providers.md +24 -0
- package/content/user-authentication/auth-steps.md +141 -0
- package/content/user-authentication/login-and-logout.md +160 -8
- package/content/user-authentication/mcp-oauth.md +424 -0
- package/content/user-authentication/organizations.md +246 -0
- package/content/user-authentication/protected-pages-apis.md +97 -0
- package/content/user-authentication/roles.md +49 -0
- package/content/user-authentication/two-factor.md +229 -0
- package/content/user-authentication/user-object.md +58 -0
- package/content/user-authentication/users-introduction.md +8 -0
- package/content/websockets/websocket-publish.md +105 -0
- package/content/websockets/websocket-subscriptions.md +136 -0
- package/content/websockets/websockets-introduction.md +101 -0
- package/hazards.json +44 -0
- package/index.json +3691 -14
- package/package.json +11 -1
- package/scripts/collectImportedFiles.js +80 -0
- package/scripts/extractAgentDocs.js +41 -30
- package/scripts/hashDocSources.js +38 -0
- package/scripts/isRedirectPage.js +26 -0
- package/scripts/recordSourceHashes.js +100 -0
- package/scripts/resolvePageSections.js +42 -0
- package/scripts/sectionKind.js +27 -0
- package/content/concepts/cli.md +0 -223
- package/content/other/introduction.md +0 -39
- package/content/other/next-auth-providers.md +0 -3
- /package/content/{other → actions}/updatesession.md +0 -0
|
@@ -26,17 +26,17 @@ The Sider block provides a sidebar within a Layout. It supports collapsing, them
|
|
|
26
26
|
type: MenuLink
|
|
27
27
|
properties:
|
|
28
28
|
title: Home
|
|
29
|
-
icon:
|
|
29
|
+
icon: home
|
|
30
30
|
- id: basic_users
|
|
31
31
|
type: MenuLink
|
|
32
32
|
properties:
|
|
33
33
|
title: Users
|
|
34
|
-
icon:
|
|
34
|
+
icon: user
|
|
35
35
|
- id: basic_settings
|
|
36
36
|
type: MenuLink
|
|
37
37
|
properties:
|
|
38
38
|
title: Settings
|
|
39
|
-
icon:
|
|
39
|
+
icon: settings
|
|
40
40
|
- id: basic_content
|
|
41
41
|
type: Content
|
|
42
42
|
style:
|
|
@@ -75,17 +75,17 @@ Setting theme to "dark" gives the sider a dark background with light text. Match
|
|
|
75
75
|
type: MenuLink
|
|
76
76
|
properties:
|
|
77
77
|
title: Dashboard
|
|
78
|
-
icon:
|
|
78
|
+
icon: Gauge
|
|
79
79
|
- id: dark_analytics
|
|
80
80
|
type: MenuLink
|
|
81
81
|
properties:
|
|
82
82
|
title: Analytics
|
|
83
|
-
icon:
|
|
83
|
+
icon: chart
|
|
84
84
|
- id: dark_files
|
|
85
85
|
type: MenuLink
|
|
86
86
|
properties:
|
|
87
87
|
title: Files
|
|
88
|
-
icon:
|
|
88
|
+
icon: file
|
|
89
89
|
- id: dark_content
|
|
90
90
|
type: Content
|
|
91
91
|
style:
|
|
@@ -126,17 +126,17 @@ With collapsible set to true a collapse trigger appears at the bottom. Toggle be
|
|
|
126
126
|
type: MenuLink
|
|
127
127
|
properties:
|
|
128
128
|
title: Inbox
|
|
129
|
-
icon:
|
|
129
|
+
icon: Inbox
|
|
130
130
|
- id: col_starred
|
|
131
131
|
type: MenuLink
|
|
132
132
|
properties:
|
|
133
133
|
title: Starred
|
|
134
|
-
icon:
|
|
134
|
+
icon: star
|
|
135
135
|
- id: col_sent
|
|
136
136
|
type: MenuLink
|
|
137
137
|
properties:
|
|
138
138
|
title: Sent
|
|
139
|
-
icon:
|
|
139
|
+
icon: send
|
|
140
140
|
- id: collapsible_content
|
|
141
141
|
type: Content
|
|
142
142
|
style:
|
|
@@ -177,17 +177,17 @@ This sider starts collapsed with initialCollapsed set to true. Click the collaps
|
|
|
177
177
|
type: MenuLink
|
|
178
178
|
properties:
|
|
179
179
|
title: Overview
|
|
180
|
-
icon:
|
|
180
|
+
icon: grid
|
|
181
181
|
- id: ic_reports
|
|
182
182
|
type: MenuLink
|
|
183
183
|
properties:
|
|
184
184
|
title: Reports
|
|
185
|
-
icon:
|
|
185
|
+
icon: document
|
|
186
186
|
- id: ic_config
|
|
187
187
|
type: MenuLink
|
|
188
188
|
properties:
|
|
189
189
|
title: Configuration
|
|
190
|
-
icon:
|
|
190
|
+
icon: Wrench
|
|
191
191
|
- id: init_collapsed_content
|
|
192
192
|
type: Content
|
|
193
193
|
style:
|
|
@@ -228,12 +228,12 @@ Setting collapsedWidth to 0 completely hides the sider when collapsed and shows
|
|
|
228
228
|
type: MenuLink
|
|
229
229
|
properties:
|
|
230
230
|
title: Projects
|
|
231
|
-
icon:
|
|
231
|
+
icon: SquareKanban
|
|
232
232
|
- id: cw_tasks
|
|
233
233
|
type: MenuLink
|
|
234
234
|
properties:
|
|
235
235
|
title: Tasks
|
|
236
|
-
icon:
|
|
236
|
+
icon: SquareCheck
|
|
237
237
|
- id: cw_content
|
|
238
238
|
type: Content
|
|
239
239
|
style:
|
|
@@ -277,7 +277,7 @@ The Sider is placed on the right side of the layout with reverseArrow set to tru
|
|
|
277
277
|
initialCollapsed: false
|
|
278
278
|
reverseArrow: true
|
|
279
279
|
style:
|
|
280
|
-
borderLeft: 1px solid
|
|
280
|
+
borderLeft: "1px solid #f0f0f0"
|
|
281
281
|
blocks:
|
|
282
282
|
- id: reverse_menu
|
|
283
283
|
type: Menu
|
|
@@ -289,15 +289,15 @@ The Sider is placed on the right side of the layout with reverseArrow set to tru
|
|
|
289
289
|
type: MenuLink
|
|
290
290
|
properties:
|
|
291
291
|
title: Details
|
|
292
|
-
icon:
|
|
292
|
+
icon: info
|
|
293
293
|
- id: rev_history
|
|
294
294
|
type: MenuLink
|
|
295
295
|
properties:
|
|
296
296
|
title: History
|
|
297
|
-
icon:
|
|
297
|
+
icon: history
|
|
298
298
|
```
|
|
299
299
|
|
|
300
|
-
The
|
|
300
|
+
The onBreakpoint event fires when the viewport crosses the breakpoint, with `broken` true below it. Here it calls the sider's setOpen method, so the sider collapses below the large (lg) breakpoint. Supported values are xs, sm, md, lg, xl, xxl and xxxl.
|
|
301
301
|
|
|
302
302
|
```yaml
|
|
303
303
|
- id: bp_layout
|
|
@@ -315,10 +315,15 @@ The breakpoint property controls when the sider automatically collapses on small
|
|
|
315
315
|
breakpoint: lg
|
|
316
316
|
events:
|
|
317
317
|
onBreakpoint:
|
|
318
|
-
- id:
|
|
319
|
-
type:
|
|
318
|
+
- id: bp_sider_set_open
|
|
319
|
+
type: CallMethod
|
|
320
320
|
params:
|
|
321
|
-
|
|
321
|
+
blockId: bp_sider
|
|
322
|
+
method: setOpen
|
|
323
|
+
args:
|
|
324
|
+
- open:
|
|
325
|
+
_not:
|
|
326
|
+
_event: broken
|
|
322
327
|
blocks:
|
|
323
328
|
- id: bp_menu
|
|
324
329
|
type: Menu
|
|
@@ -330,12 +335,12 @@ The breakpoint property controls when the sider automatically collapses on small
|
|
|
330
335
|
type: MenuLink
|
|
331
336
|
properties:
|
|
332
337
|
title: Home
|
|
333
|
-
icon:
|
|
338
|
+
icon: home
|
|
334
339
|
- id: bp_search
|
|
335
340
|
type: MenuLink
|
|
336
341
|
properties:
|
|
337
342
|
title: Search
|
|
338
|
-
icon:
|
|
343
|
+
icon: search
|
|
339
344
|
- id: bp_content
|
|
340
345
|
type: Content
|
|
341
346
|
style:
|
|
@@ -345,10 +350,10 @@ The breakpoint property controls when the sider automatically collapses on small
|
|
|
345
350
|
- id: bp_content_text
|
|
346
351
|
type: Paragraph
|
|
347
352
|
properties:
|
|
348
|
-
content: The
|
|
349
|
-
|
|
350
|
-
the
|
|
351
|
-
xs, sm, md, lg, xl, and
|
|
353
|
+
content: The onBreakpoint event fires when the viewport crosses the breakpoint,
|
|
354
|
+
with `broken` true below it. Here it calls the sider's setOpen
|
|
355
|
+
method, so the sider collapses below the large (lg) breakpoint.
|
|
356
|
+
Supported values are xs, sm, md, lg, xl, xxl and xxxl.
|
|
352
357
|
```
|
|
353
358
|
|
|
354
359
|
The width property accepts a number (pixels) or string value. Here the sider is set to 300px wide, providing more room for longer menu labels or nested navigation.
|
|
@@ -377,17 +382,17 @@ The width property accepts a number (pixels) or string value. Here the sider is
|
|
|
377
382
|
type: MenuLink
|
|
378
383
|
properties:
|
|
379
384
|
title: Getting Started
|
|
380
|
-
icon:
|
|
385
|
+
icon: Rocket
|
|
381
386
|
- id: width_nav2
|
|
382
387
|
type: MenuLink
|
|
383
388
|
properties:
|
|
384
389
|
title: Documentation
|
|
385
|
-
icon:
|
|
390
|
+
icon: Book
|
|
386
391
|
- id: width_nav3
|
|
387
392
|
type: MenuLink
|
|
388
393
|
properties:
|
|
389
394
|
title: API Reference
|
|
390
|
-
icon:
|
|
395
|
+
icon: CodeXml
|
|
391
396
|
- id: width_content
|
|
392
397
|
type: Content
|
|
393
398
|
style:
|
|
@@ -439,12 +444,12 @@ The Sider fires onOpen and onClose events when it expands or collapses. Use thes
|
|
|
439
444
|
type: MenuLink
|
|
440
445
|
properties:
|
|
441
446
|
title: Home
|
|
442
|
-
icon:
|
|
447
|
+
icon: home
|
|
443
448
|
- id: events_nav_alerts
|
|
444
449
|
type: MenuLink
|
|
445
450
|
properties:
|
|
446
451
|
title: Alerts
|
|
447
|
-
icon:
|
|
452
|
+
icon: bell
|
|
448
453
|
- id: events_content
|
|
449
454
|
type: Content
|
|
450
455
|
style:
|
|
@@ -467,9 +472,7 @@ The Sider fires onOpen and onClose events when it expands or collapses. Use thes
|
|
|
467
472
|
state changes. Toggle the sider to see the state update above.
|
|
468
473
|
```
|
|
469
474
|
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
Token overrides work with both light and dark themes. This dark sider uses a custom navy background and green primary color for the active menu item highlight.
|
|
475
|
+
The Sider theme takes antd Layout design tokens. Here lightTriggerBg, lightTriggerColor and triggerHeight style the collapse trigger, and the Menu theme styles the selected item.
|
|
473
476
|
|
|
474
477
|
```yaml
|
|
475
478
|
- id: token_layout
|
|
@@ -480,35 +483,37 @@ Token overrides work with both light and dark themes. This dark sider uses a cus
|
|
|
480
483
|
- id: token_sider
|
|
481
484
|
type: Sider
|
|
482
485
|
properties:
|
|
483
|
-
theme: light
|
|
484
486
|
width: 220
|
|
485
487
|
collapsible: true
|
|
486
488
|
initialCollapsed: false
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
489
|
+
theme:
|
|
490
|
+
lightTriggerBg: "#f9f0ff"
|
|
491
|
+
lightTriggerColor: "#722ed1"
|
|
492
|
+
triggerHeight: 40
|
|
490
493
|
blocks:
|
|
491
494
|
- id: token_menu
|
|
492
495
|
type: Menu
|
|
493
496
|
properties:
|
|
494
497
|
mode: inline
|
|
495
|
-
theme:
|
|
498
|
+
theme:
|
|
499
|
+
itemSelectedBg: "#f9f0ff"
|
|
500
|
+
itemSelectedColor: "#722ed1"
|
|
496
501
|
links:
|
|
497
502
|
- id: token_nav_explore
|
|
498
503
|
type: MenuLink
|
|
499
504
|
properties:
|
|
500
505
|
title: Explore
|
|
501
|
-
icon:
|
|
506
|
+
icon: Compass
|
|
502
507
|
- id: token_nav_favorites
|
|
503
508
|
type: MenuLink
|
|
504
509
|
properties:
|
|
505
510
|
title: Favorites
|
|
506
|
-
icon:
|
|
511
|
+
icon: heart
|
|
507
512
|
- id: token_nav_settings
|
|
508
513
|
type: MenuLink
|
|
509
514
|
properties:
|
|
510
515
|
title: Settings
|
|
511
|
-
icon:
|
|
516
|
+
icon: settings
|
|
512
517
|
- id: token_content
|
|
513
518
|
type: Content
|
|
514
519
|
style:
|
|
@@ -518,59 +523,9 @@ Token overrides work with both light and dark themes. This dark sider uses a cus
|
|
|
518
523
|
- id: token_content_text
|
|
519
524
|
type: Paragraph
|
|
520
525
|
properties:
|
|
521
|
-
content:
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
menu text color.
|
|
525
|
-
- id: token_dark_layout
|
|
526
|
-
type: Layout
|
|
527
|
-
style:
|
|
528
|
-
minHeight: 300px
|
|
529
|
-
blocks:
|
|
530
|
-
- id: token_dark_sider
|
|
531
|
-
type: Sider
|
|
532
|
-
properties:
|
|
533
|
-
theme: dark
|
|
534
|
-
width: 220
|
|
535
|
-
collapsible: true
|
|
536
|
-
initialCollapsed: false
|
|
537
|
-
designTokens:
|
|
538
|
-
colorPrimary: "#52c41a"
|
|
539
|
-
colorBgContainer: "#1a1a2e"
|
|
540
|
-
blocks:
|
|
541
|
-
- id: token_dark_menu
|
|
542
|
-
type: Menu
|
|
543
|
-
properties:
|
|
544
|
-
mode: inline
|
|
545
|
-
theme: dark
|
|
546
|
-
links:
|
|
547
|
-
- id: token_dark_nav_status
|
|
548
|
-
type: MenuLink
|
|
549
|
-
properties:
|
|
550
|
-
title: Status
|
|
551
|
-
icon: AiOutlineCheckCircle
|
|
552
|
-
- id: token_dark_nav_logs
|
|
553
|
-
type: MenuLink
|
|
554
|
-
properties:
|
|
555
|
-
title: Logs
|
|
556
|
-
icon: AiOutlineFileText
|
|
557
|
-
- id: token_dark_nav_deploy
|
|
558
|
-
type: MenuLink
|
|
559
|
-
properties:
|
|
560
|
-
title: Deploy
|
|
561
|
-
icon: AiOutlineCloudUpload
|
|
562
|
-
- id: token_dark_content
|
|
563
|
-
type: Content
|
|
564
|
-
style:
|
|
565
|
-
padding: 24px
|
|
566
|
-
background: var(--ant-color-bg-container)
|
|
567
|
-
blocks:
|
|
568
|
-
- id: token_dark_content_text
|
|
569
|
-
type: Paragraph
|
|
570
|
-
properties:
|
|
571
|
-
content: Token overrides work with both light and dark themes. This dark sider
|
|
572
|
-
uses a custom navy background and green primary color for the
|
|
573
|
-
active menu item highlight.
|
|
526
|
+
content: The Sider theme takes antd Layout design tokens. Here lightTriggerBg,
|
|
527
|
+
lightTriggerColor and triggerHeight style the collapse trigger,
|
|
528
|
+
and the Menu theme styles the selected item.
|
|
574
529
|
```
|
|
575
530
|
|
|
576
531
|
The Sider has a single CSS key called "element" which targets the entire sider container. Use it with Tailwind classes for gradients, borders, shadows, and other visual effects.
|
|
@@ -591,7 +546,7 @@ A shadow-lg class on the element CSS key gives the sider an elevated appearance
|
|
|
591
546
|
collapsible: false
|
|
592
547
|
initialCollapsed: false
|
|
593
548
|
class:
|
|
594
|
-
element: bg-gradient-to-b from-primary/10 to-bg-container border-r border-border
|
|
549
|
+
.element: bg-gradient-to-b from-primary/10 to-bg-container border-r border-border
|
|
595
550
|
blocks:
|
|
596
551
|
- id: css_menu
|
|
597
552
|
type: Menu
|
|
@@ -603,17 +558,17 @@ A shadow-lg class on the element CSS key gives the sider an elevated appearance
|
|
|
603
558
|
type: MenuLink
|
|
604
559
|
properties:
|
|
605
560
|
title: Workspace
|
|
606
|
-
icon:
|
|
561
|
+
icon: grid
|
|
607
562
|
- id: css_nav_members
|
|
608
563
|
type: MenuLink
|
|
609
564
|
properties:
|
|
610
565
|
title: Members
|
|
611
|
-
icon:
|
|
566
|
+
icon: users
|
|
612
567
|
- id: css_nav_billing
|
|
613
568
|
type: MenuLink
|
|
614
569
|
properties:
|
|
615
570
|
title: Billing
|
|
616
|
-
icon:
|
|
571
|
+
icon: CreditCard
|
|
617
572
|
- id: css_content
|
|
618
573
|
type: Content
|
|
619
574
|
style:
|
|
@@ -639,7 +594,7 @@ A shadow-lg class on the element CSS key gives the sider an elevated appearance
|
|
|
639
594
|
collapsible: false
|
|
640
595
|
initialCollapsed: false
|
|
641
596
|
class:
|
|
642
|
-
element: shadow-lg bg-bg-container
|
|
597
|
+
.element: shadow-lg bg-bg-container
|
|
643
598
|
blocks:
|
|
644
599
|
- id: css_shadow_menu
|
|
645
600
|
type: Menu
|
|
@@ -651,12 +606,12 @@ A shadow-lg class on the element CSS key gives the sider an elevated appearance
|
|
|
651
606
|
type: MenuLink
|
|
652
607
|
properties:
|
|
653
608
|
title: Dashboard
|
|
654
|
-
icon:
|
|
609
|
+
icon: Gauge
|
|
655
610
|
- id: css_sh_analytics
|
|
656
611
|
type: MenuLink
|
|
657
612
|
properties:
|
|
658
613
|
title: Analytics
|
|
659
|
-
icon:
|
|
614
|
+
icon: ChartLine
|
|
660
615
|
- id: css_shadow_content
|
|
661
616
|
type: Content
|
|
662
617
|
style:
|
|
@@ -721,12 +676,12 @@ Dashboard
|
|
|
721
676
|
type: MenuLink
|
|
722
677
|
properties:
|
|
723
678
|
title: Dashboard
|
|
724
|
-
icon:
|
|
679
|
+
icon: Gauge
|
|
725
680
|
- id: admin_nav_users
|
|
726
681
|
type: MenuGroup
|
|
727
682
|
properties:
|
|
728
683
|
title: User Management
|
|
729
|
-
icon:
|
|
684
|
+
icon: users
|
|
730
685
|
links:
|
|
731
686
|
- id: admin_nav_all_users
|
|
732
687
|
type: MenuLink
|
|
@@ -740,7 +695,7 @@ Dashboard
|
|
|
740
695
|
type: MenuGroup
|
|
741
696
|
properties:
|
|
742
697
|
title: Content
|
|
743
|
-
icon:
|
|
698
|
+
icon: document
|
|
744
699
|
links:
|
|
745
700
|
- id: admin_nav_pages
|
|
746
701
|
type: MenuLink
|
|
@@ -754,7 +709,7 @@ Dashboard
|
|
|
754
709
|
type: MenuLink
|
|
755
710
|
properties:
|
|
756
711
|
title: Settings
|
|
757
|
-
icon:
|
|
712
|
+
icon: settings
|
|
758
713
|
- id: admin_content
|
|
759
714
|
type: Content
|
|
760
715
|
style:
|
|
@@ -786,7 +741,7 @@ Dashboard
|
|
|
786
741
|
layout:
|
|
787
742
|
flex: 0 0 auto
|
|
788
743
|
properties:
|
|
789
|
-
icon:
|
|
744
|
+
icon: bell
|
|
790
745
|
color: default
|
|
791
746
|
variant: text
|
|
792
747
|
hideTitle: true
|
|
@@ -795,7 +750,7 @@ Dashboard
|
|
|
795
750
|
layout:
|
|
796
751
|
flex: 0 0 auto
|
|
797
752
|
properties:
|
|
798
|
-
icon:
|
|
753
|
+
icon: user
|
|
799
754
|
color: default
|
|
800
755
|
variant: text
|
|
801
756
|
hideTitle: true
|
|
@@ -863,7 +818,7 @@ Manage your personal information and preferences.
|
|
|
863
818
|
collapsible: false
|
|
864
819
|
initialCollapsed: false
|
|
865
820
|
style:
|
|
866
|
-
borderRight: 1px solid
|
|
821
|
+
borderRight: "1px solid #f0f0f0"
|
|
867
822
|
blocks:
|
|
868
823
|
- id: settings_heading
|
|
869
824
|
type: Title
|
|
@@ -882,27 +837,27 @@ Manage your personal information and preferences.
|
|
|
882
837
|
type: MenuLink
|
|
883
838
|
properties:
|
|
884
839
|
title: Profile
|
|
885
|
-
icon:
|
|
840
|
+
icon: user
|
|
886
841
|
- id: settings_nav_account
|
|
887
842
|
type: MenuLink
|
|
888
843
|
properties:
|
|
889
844
|
title: Account
|
|
890
|
-
icon:
|
|
845
|
+
icon: Shield
|
|
891
846
|
- id: settings_nav_notifications
|
|
892
847
|
type: MenuLink
|
|
893
848
|
properties:
|
|
894
849
|
title: Notifications
|
|
895
|
-
icon:
|
|
850
|
+
icon: bell
|
|
896
851
|
- id: settings_nav_appearance
|
|
897
852
|
type: MenuLink
|
|
898
853
|
properties:
|
|
899
854
|
title: Appearance
|
|
900
|
-
icon:
|
|
855
|
+
icon: PaintBucket
|
|
901
856
|
- id: settings_nav_integrations
|
|
902
857
|
type: MenuLink
|
|
903
858
|
properties:
|
|
904
859
|
title: Integrations
|
|
905
|
-
icon:
|
|
860
|
+
icon: Plug
|
|
906
861
|
- id: settings_content
|
|
907
862
|
type: Content
|
|
908
863
|
style:
|
|
@@ -941,7 +896,7 @@ Manage your personal information and preferences.
|
|
|
941
896
|
title: Save Changes
|
|
942
897
|
color: primary
|
|
943
898
|
variant: solid
|
|
944
|
-
icon:
|
|
899
|
+
icon: save
|
|
945
900
|
```
|
|
946
901
|
|
|
947
902
|
Introduction
|
|
@@ -965,7 +920,7 @@ Use the sidebar on the left to browse through different sections. On smaller scr
|
|
|
965
920
|
initialCollapsed: false
|
|
966
921
|
breakpoint: md
|
|
967
922
|
class:
|
|
968
|
-
element: border-r border-border
|
|
923
|
+
.element: border-r border-border
|
|
969
924
|
blocks:
|
|
970
925
|
- id: docs_search
|
|
971
926
|
type: TextInput
|
|
@@ -973,7 +928,7 @@ Use the sidebar on the left to browse through different sections. On smaller scr
|
|
|
973
928
|
padding: 12px 16px
|
|
974
929
|
properties:
|
|
975
930
|
placeholder: Search docs...
|
|
976
|
-
prefixIcon:
|
|
931
|
+
prefixIcon: search
|
|
977
932
|
- id: docs_menu
|
|
978
933
|
type: Menu
|
|
979
934
|
properties:
|
|
@@ -1040,24 +995,32 @@ Use the sidebar on the left to browse through different sections. On smaller scr
|
|
|
1040
995
|
|
|
1041
996
|
| Property | Type | Default | Description |
|
|
1042
997
|
| --- | --- | --- | --- |
|
|
1043
|
-
| `breakpoint` | string |
|
|
998
|
+
| `breakpoint` | string | - | Breakpoint of the responsive layout. Crossing it fires onBreakpoint. Enum: `xs`, `sm`, `md`, `lg`, `xl`, `xxl`, `xxxl`. |
|
|
1044
999
|
| `collapsedWidth` | integer | - | Width of the collapsed sidebar, by setting to 0 a special trigger will appear |
|
|
1045
|
-
| `collapsible` | boolean |
|
|
1000
|
+
| `collapsible` | boolean | `false` | Show a trigger at the bottom of the sider that collapses and expands it. |
|
|
1046
1001
|
| `initialCollapsed` | boolean | `true` | Set the initial collapsed state |
|
|
1047
1002
|
| `reverseArrow` | boolean | `false` | Direction of arrow, for a sider that expands from the right |
|
|
1048
1003
|
| `width` | string \| number | - | width of the sidebar |
|
|
1049
|
-
| `theme` | object | - |
|
|
1004
|
+
| `theme` | string \| object | - | The Sider color theme, light or dark, or antd Layout design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design layout tokens](https://ant.design/components/layout#design-token). |
|
|
1005
|
+
| `theme.triggerHeight` | number | `48` | Height of the collapse trigger of a collapsible Sider. |
|
|
1006
|
+
| `theme.triggerBg` | string | `"#002140"` | Background color of the collapse trigger of a dark Sider. |
|
|
1007
|
+
| `theme.triggerColor` | string | `"#fff"` | Color of the collapse trigger of a dark Sider. |
|
|
1008
|
+
| `theme.lightTriggerBg` | string | `"#ffffff"` | Background color of the collapse trigger of a light Sider. |
|
|
1009
|
+
| `theme.lightTriggerColor` | string | `"rgba(0, 0, 0, 0.88)"` | Color of the collapse trigger of a light Sider. |
|
|
1010
|
+
| `theme.zeroTriggerWidth` | number | `40` | Width of the trigger shown when collapsedWidth is 0. |
|
|
1011
|
+
| `theme.zeroTriggerHeight` | number | `40` | Height of the trigger shown when collapsedWidth is 0. |
|
|
1050
1012
|
|
|
1051
1013
|
| Event | Event Data | Description |
|
|
1052
1014
|
| --- | --- | --- |
|
|
1053
1015
|
| `onClose` | \- | Trigger actions when sider is closed. |
|
|
1054
1016
|
| `onOpen` | \- | Trigger actions when sider is opened. |
|
|
1055
|
-
| `onBreakpoint` |
|
|
1017
|
+
| `onBreakpoint` | `{ broken }` | Trigger actions when the screen width crosses the breakpoint. Use it with the setOpen method to collapse the sider on small screens. |
|
|
1056
1018
|
|
|
1057
1019
|
| Key | Target |
|
|
1058
1020
|
| --- | --- |
|
|
1059
1021
|
| `/block` | Outer block wrapper (always available). |
|
|
1060
1022
|
| `/element` | The Sider element. |
|
|
1023
|
+
| `/body` | The box inside the Sider that holds its child blocks. |
|
|
1061
1024
|
|
|
1062
1025
|
| Slot | Description |
|
|
1063
1026
|
| --- | --- |
|
|
@@ -53,7 +53,7 @@ This content property overrides the content area below.
|
|
|
53
53
|
layout:
|
|
54
54
|
flex: 0 0 auto
|
|
55
55
|
properties:
|
|
56
|
-
name:
|
|
56
|
+
name: info
|
|
57
57
|
size: 14
|
|
58
58
|
color: "#1677ff"
|
|
59
59
|
- id: span_content_area_text
|
|
@@ -338,7 +338,7 @@ Status:
|
|
|
338
338
|
layout:
|
|
339
339
|
flex: 0 0 auto
|
|
340
340
|
properties:
|
|
341
|
-
name:
|
|
341
|
+
name: check-circle
|
|
342
342
|
size: 14
|
|
343
343
|
color: "#52c41a"
|
|
344
344
|
- id: span_nested_value_text
|
|
@@ -465,7 +465,7 @@ LIVE
|
|
|
465
465
|
layout:
|
|
466
466
|
flex: 0 0 auto
|
|
467
467
|
properties:
|
|
468
|
-
name:
|
|
468
|
+
name: FaceSlightlySmiling
|
|
469
469
|
size: 16
|
|
470
470
|
color: "#faad14"
|
|
471
471
|
- id: span_icon_smile_label
|
|
@@ -487,7 +487,7 @@ LIVE
|
|
|
487
487
|
layout:
|
|
488
488
|
flex: 0 0 auto
|
|
489
489
|
properties:
|
|
490
|
-
name:
|
|
490
|
+
name: check-circle
|
|
491
491
|
size: 16
|
|
492
492
|
color: "#52c41a"
|
|
493
493
|
- id: span_icon_check_label
|
|
@@ -509,7 +509,7 @@ LIVE
|
|
|
509
509
|
layout:
|
|
510
510
|
flex: 0 0 auto
|
|
511
511
|
properties:
|
|
512
|
-
name:
|
|
512
|
+
name: warning
|
|
513
513
|
size: 16
|
|
514
514
|
color: "#ff4d4f"
|
|
515
515
|
- id: span_icon_warning_label
|
|
@@ -563,7 +563,7 @@ Estimated delivery Mar 18, 2026
|
|
|
563
563
|
layout:
|
|
564
564
|
flex: 0 0 auto
|
|
565
565
|
properties:
|
|
566
|
-
name:
|
|
566
|
+
name: check-circle
|
|
567
567
|
size: 14
|
|
568
568
|
color: "#52c41a"
|
|
569
569
|
- id: span_order_shipped_text
|
|
@@ -679,7 +679,7 @@ Admin
|
|
|
679
679
|
layout:
|
|
680
680
|
flex: 0 0 auto
|
|
681
681
|
properties:
|
|
682
|
-
name:
|
|
682
|
+
name: user
|
|
683
683
|
size: 20
|
|
684
684
|
color: "#1677ff"
|
|
685
685
|
- id: span_profile_name
|
|
@@ -150,7 +150,7 @@ Loading orders...
|
|
|
150
150
|
flex: 0 0 auto
|
|
151
151
|
properties:
|
|
152
152
|
title: Refresh
|
|
153
|
-
icon:
|
|
153
|
+
icon: refresh
|
|
154
154
|
color: primary
|
|
155
155
|
variant: outlined
|
|
156
156
|
size: small
|
|
@@ -239,7 +239,7 @@ Loading orders...
|
|
|
239
239
|
title: Submit
|
|
240
240
|
color: primary
|
|
241
241
|
variant: solid
|
|
242
|
-
icon:
|
|
242
|
+
icon: send
|
|
243
243
|
events:
|
|
244
244
|
onClick:
|
|
245
245
|
- id: spinner_btn_loading_set_state
|
|
@@ -255,7 +255,7 @@ Loading orders...
|
|
|
255
255
|
|
|
256
256
|
| Property | Type | Default | Description |
|
|
257
257
|
| --- | --- | --- | --- |
|
|
258
|
-
| `size` | string | - | Size of the icon spinner
|
|
258
|
+
| `size` | string \| number | - | Size of the icon spinner: small, medium, large, or a pixel number. |
|
|
259
259
|
|
|
260
260
|
No events defined.
|
|
261
261
|
|