@lowdefy/docs-content 6.1.0 → 7.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -0
- package/content/actions/downloadcsv.md +1 -1
- package/content/actions/emailotpsend.md +58 -0
- package/content/actions/emailotpverify.md +79 -0
- package/content/actions/getlocalstorage.md +43 -0
- package/content/actions/link.md +47 -1
- package/content/actions/login.md +25 -5
- package/content/actions/logout.md +7 -5
- package/content/actions/magiclinkverify.md +117 -0
- package/content/actions/pdfmake.md +2 -2
- package/content/actions/posthogalias.md +29 -0
- package/content/actions/posthogcapture.md +49 -0
- package/content/actions/posthogcapturepageleave.md +38 -0
- package/content/actions/posthogfeatureflag.md +50 -0
- package/content/actions/posthoggroup.md +37 -0
- package/content/actions/posthogidentify.md +54 -0
- package/content/actions/posthoginit.md +96 -0
- package/content/actions/posthogoptin.md +29 -0
- package/content/actions/posthogoptout.md +29 -0
- package/content/actions/posthogpageview.md +37 -0
- package/content/actions/posthogreloadfeatureflags.md +47 -0
- package/content/actions/posthogreset.md +28 -0
- package/content/actions/posthogsetpersonproperties.md +36 -0
- package/content/actions/removelocalstorage.md +28 -0
- package/content/actions/resetvalidation.md +5 -3
- package/content/actions/setdarkmode.md +3 -3
- package/content/actions/setglobal.md +2 -0
- package/content/actions/setlocale.md +1 -1
- package/content/actions/setlocalstorage.md +34 -0
- package/content/actions/setstate.md +2 -0
- package/content/actions/validate.md +7 -4
- package/content/adapter-reference/mongodbauthadapter.md +46 -0
- package/content/agents/agent-endpoint-tools.md +24 -0
- package/content/agents/agent-properties.md +13 -3
- package/content/agents/agent-server-hooks.md +1 -1
- package/content/agents/agentchat.md +43 -7
- package/content/agents/agentconversations.md +42 -8
- package/content/agents/agents-introduction.md +107 -0
- package/content/callback-reference/auth0logoutcallback.md +54 -0
- package/content/concepts/ai-agent-docs.md +455 -106
- package/content/concepts/blocks.md +150 -0
- package/content/concepts/connections-and-requests.md +402 -0
- package/content/concepts/custom-html.md +42 -0
- package/content/concepts/custom-styling.md +50 -5
- package/content/concepts/dynamic-page-content.md +309 -0
- package/content/concepts/events-and-actions.md +154 -2
- package/content/concepts/four-primitives.md +31 -0
- package/content/concepts/html-attributes.md +293 -0
- package/content/concepts/i18n.md +8 -3
- package/content/concepts/keyboard-shortcuts.md +2 -2
- package/content/concepts/layout-overview.md +1 -1
- package/content/concepts/logger.md +99 -0
- package/content/concepts/lowdefy-api.md +1319 -0
- package/content/concepts/lowdefy-schema.md +136 -3
- package/content/concepts/menus.md +8 -7
- package/content/concepts/module-authoring.md +76 -5
- package/content/concepts/modules.md +3 -1
- package/content/concepts/notifications.md +180 -0
- package/content/concepts/operators.md +7 -0
- package/content/concepts/page-and-app-state.md +252 -0
- package/content/concepts/page-paths.md +209 -0
- package/content/concepts/theming.md +582 -0
- package/content/connections/aigateway.md +375 -0
- package/content/connections/anthropic.md +169 -2
- package/content/connections/awss3.md +178 -2
- package/content/connections/axioshttp.md +181 -0
- package/content/connections/google.md +169 -2
- package/content/connections/mongodb.md +1014 -3
- package/content/connections/openai-connection.md +169 -2
- package/content/connections/sendgridmail.md +2 -0
- package/content/connections/smtp.md +3 -1
- package/content/connections/treg.md +329 -0
- package/content/container-blocks/affix.md +47 -7
- package/content/container-blocks/alert.md +76 -24
- package/content/container-blocks/badge.md +100 -24
- package/content/container-blocks/box.md +9 -9
- package/content/container-blocks/card.md +132 -27
- package/content/container-blocks/carousel.md +60 -7
- package/content/container-blocks/collapse.md +153 -9
- package/content/container-blocks/configprovider.md +35 -13
- package/content/container-blocks/confirmmodal.md +69 -23
- package/content/container-blocks/content.md +62 -98
- package/content/container-blocks/descriptions.md +45 -4
- package/content/container-blocks/drawer.md +139 -28
- package/content/container-blocks/dropdownmenu.md +119 -31
- package/content/container-blocks/flex.md +40 -62
- package/content/container-blocks/footer.md +15 -11
- package/content/container-blocks/googlemapsheatmap.md +1 -1
- package/content/container-blocks/googlemapsscript.md +2 -2
- package/content/container-blocks/header.md +71 -36
- package/content/container-blocks/label.md +34 -7
- package/content/container-blocks/layout.md +52 -34
- package/content/container-blocks/masonry.md +17 -71
- package/content/container-blocks/mobilemenu.md +131 -88
- package/content/container-blocks/modal.md +161 -26
- package/content/container-blocks/pageheadermenu.md +138 -31
- package/content/container-blocks/pagesidebarlayout.md +230 -27
- package/content/container-blocks/pagesidermenu.md +153 -43
- package/content/container-blocks/popover.md +34 -31
- package/content/container-blocks/result.md +32 -21
- package/content/container-blocks/sider.md +85 -122
- package/content/container-blocks/span.md +7 -7
- package/content/container-blocks/spinner.md +3 -3
- package/content/container-blocks/splitter.md +150 -68
- package/content/container-blocks/tabs.md +64 -12
- package/content/container-blocks/tooltip.md +22 -46
- package/content/container-blocks/watermark.md +22 -4
- package/content/controls/parallel_for.md +21 -2
- package/content/controls/reject.md +24 -3
- package/content/controls/return.md +17 -1
- package/content/controls/throw.md +1 -0
- package/content/controls/try.md +4 -2
- package/content/controls/while.md +46 -0
- package/content/deployment/deployment-environments.md +10 -7
- package/content/deployment/docker.md +22 -7
- package/content/deployment/node-server.md +4 -0
- package/content/deployment/vercel.md +17 -6
- package/content/display-blocks/aggrid.md +33 -16
- package/content/display-blocks/anchor.md +16 -15
- package/content/display-blocks/avatar.md +57 -37
- package/content/display-blocks/breadcrumb.md +70 -21
- package/content/display-blocks/button.md +93 -19
- package/content/display-blocks/calendar.md +12 -0
- package/content/display-blocks/clickablehtml.md +239 -0
- package/content/display-blocks/dangeroushtml.md +1 -1
- package/content/display-blocks/difflist.md +1 -1
- package/content/display-blocks/difftimeline.md +1 -1
- package/content/display-blocks/divider.md +64 -3
- package/content/display-blocks/dropdownbutton.md +81 -30
- package/content/display-blocks/echart.md +35 -1
- package/content/display-blocks/eventlog.md +363 -0
- package/content/display-blocks/floatbutton.md +129 -42
- package/content/display-blocks/html.md +61 -1
- package/content/display-blocks/icon.md +250 -67
- package/content/display-blocks/img.md +2 -2
- package/content/display-blocks/menu.md +146 -73
- package/content/display-blocks/message.md +38 -124
- package/content/display-blocks/notification.md +94 -222
- package/content/display-blocks/paragraph.md +59 -9
- package/content/display-blocks/pollingtimer.md +263 -0
- package/content/display-blocks/progress.md +96 -17
- package/content/display-blocks/qrcode.md +19 -4
- package/content/display-blocks/s3download.md +1 -1
- package/content/display-blocks/search.md +19 -9
- package/content/display-blocks/skeletonbutton.md +1 -0
- package/content/display-blocks/skeletoninput.md +1 -0
- package/content/display-blocks/statistic.md +75 -17
- package/content/display-blocks/steps.md +58 -25
- package/content/display-blocks/table.md +2527 -0
- package/content/display-blocks/tablelight.md +621 -0
- package/content/display-blocks/tag.md +102 -17
- package/content/display-blocks/title.md +50 -11
- package/content/display-blocks/tour.md +33 -23
- package/content/input-blocks/autocomplete.md +81 -9
- package/content/input-blocks/buttonselector.md +45 -8
- package/content/input-blocks/captcha.md +40 -0
- package/content/input-blocks/checkboxselector.md +97 -7
- package/content/input-blocks/checkboxswitch.md +33 -3
- package/content/input-blocks/colorselector.md +63 -14
- package/content/input-blocks/daterangeselector.md +165 -45
- package/content/input-blocks/dateselector.md +139 -41
- package/content/input-blocks/datetimeselector.md +158 -49
- package/content/input-blocks/inputgallery.md +3 -3
- package/content/input-blocks/intentinput.md +207 -0
- package/content/input-blocks/monthselector.md +120 -52
- package/content/input-blocks/multipleselector.md +150 -39
- package/content/input-blocks/numberinput.md +98 -12
- package/content/input-blocks/pagination.md +70 -14
- package/content/input-blocks/paragraphinput.md +51 -37
- package/content/input-blocks/passwordinput.md +60 -6
- package/content/input-blocks/phonenumberinput.md +59 -26
- package/content/input-blocks/placesautocomplete.md +319 -0
- package/content/input-blocks/radioselector.md +83 -7
- package/content/input-blocks/ratingslider.md +57 -26
- package/content/input-blocks/s3uploadbutton.md +24 -24
- package/content/input-blocks/s3uploaddragger.md +3 -3
- package/content/input-blocks/s3uploadphoto.md +5 -5
- package/content/input-blocks/segmentedselector.md +72 -32
- package/content/input-blocks/selector.md +109 -21
- package/content/input-blocks/switch.md +65 -17
- package/content/input-blocks/tableinput.md +445 -0
- package/content/input-blocks/tagmultipleselector.md +114 -0
- package/content/input-blocks/tagselector.md +114 -0
- package/content/input-blocks/textarea.md +32 -3
- package/content/input-blocks/textinput.md +70 -29
- package/content/input-blocks/tiptapinput.md +1 -1
- package/content/input-blocks/tiptapmentioninput.md +2 -2
- package/content/input-blocks/titleinput.md +39 -12
- package/content/input-blocks/treeinput.md +49 -25
- package/content/input-blocks/treemultipleselector.md +127 -10
- package/content/input-blocks/treeselector.md +97 -9
- package/content/input-blocks/upload.md +64 -15
- package/content/input-blocks/uploaddragger.md +17 -1
- package/content/input-blocks/uploadphoto.md +18 -1
- package/content/input-blocks/weekselector.md +120 -55
- package/content/learn/introduction.md +27 -0
- package/content/learn/quickstart.md +53 -0
- package/content/learn/showcase.md +8 -0
- package/content/list-blocks/controlledlist.md +24 -15
- package/content/list-blocks/list.md +11 -11
- package/content/list-blocks/masonrylist.md +7 -34
- package/content/migration/auth-upgrade.md +337 -0
- package/content/migration/upgrade-guide.md +1 -0
- package/content/migration/v3-to-v4.md +417 -0
- package/content/migration/v6-to-v7.md +620 -0
- package/content/operators/_agent.md +155 -0
- package/content/operators/_app.md +2 -1
- package/content/operators/_array.md +122 -1
- package/content/operators/_build.md +1 -0
- package/content/operators/_credential.md +57 -0
- package/content/operators/_cron.md +292 -0
- package/content/operators/_date.md +2 -0
- package/content/operators/_error.md +24 -1
- package/content/operators/_get.md +6 -6
- package/content/operators/_hmac.md +78 -0
- package/content/operators/_js.md +2 -1
- package/content/operators/_location.md +1 -1
- package/content/operators/_media.md +13 -0
- package/content/operators/_module.md +56 -2
- package/content/operators/_operator.md +17 -3
- package/content/operators/_path_params.md +82 -0
- package/content/operators/_ref.md +258 -0
- package/content/operators/_request.md +1 -1
- package/content/operators/_request_details.md +6 -0
- package/content/operators/_type.md +14 -3
- package/content/operators/_url_query.md +2 -0
- package/content/operators/_user.md +3 -3
- package/content/plugins/plugins-actions.md +10 -0
- package/content/plugins/plugins-connections.md +25 -0
- package/content/plugins/plugins-dev.md +66 -0
- package/content/plugins/plugins-icon-sets.md +267 -0
- package/content/plugins/plugins-introduction.md +27 -1
- package/content/plugins/plugins.md +19 -0
- package/content/plugins/posthog.md +359 -0
- package/content/provider-reference/auth-js-providers.md +107 -0
- package/content/provider-reference/openidconnectprovider.md +44 -0
- package/content/recipes/recipes.md +16 -0
- package/content/reference/actions-reference.md +31 -0
- package/content/reference/blocks-reference.md +35 -0
- package/content/reference/cli.md +403 -0
- package/content/reference/connections-reference.md +23 -0
- package/content/reference/operators-reference.md +47 -0
- package/content/reference/reference.md +16 -0
- package/content/reference/schema-reference.md +12 -0
- package/content/testing/config-tests.md +677 -0
- package/content/testing/e2e-configuration.md +31 -1
- package/content/testing/e2e-getting-started.md +1 -1
- package/content/testing/e2e-introduction.md +1 -1
- package/content/testing/e2e-writing-tests.md +12 -1
- package/content/testing/explore-pull-request.md +136 -0
- package/content/testing/journey-data-sets.md +326 -0
- package/content/tutorial/tutorial-actions-operators.md +2 -2
- package/content/tutorial/tutorial-add-blocks.md +2 -2
- package/content/tutorial/tutorial-create-page.md +48 -2
- package/content/tutorial/tutorial-display-data-page.md +3 -3
- package/content/tutorial/tutorial-requests-api.md +155 -0
- package/content/tutorial/tutorial-requests-sql.md +153 -0
- package/content/tutorial/tutorial-start.md +66 -1
- package/content/user-authentication/auth-configuration.md +267 -0
- package/content/user-authentication/auth-providers.md +24 -0
- package/content/user-authentication/auth-steps.md +141 -0
- package/content/user-authentication/login-and-logout.md +160 -8
- package/content/user-authentication/mcp-oauth.md +424 -0
- package/content/user-authentication/organizations.md +246 -0
- package/content/user-authentication/protected-pages-apis.md +97 -0
- package/content/user-authentication/roles.md +49 -0
- package/content/user-authentication/two-factor.md +229 -0
- package/content/user-authentication/user-object.md +58 -0
- package/content/user-authentication/users-introduction.md +8 -0
- package/content/websockets/websocket-publish.md +105 -0
- package/content/websockets/websocket-subscriptions.md +136 -0
- package/content/websockets/websockets-introduction.md +101 -0
- package/hazards.json +56 -0
- package/index.json +3458 -14
- package/package.json +10 -1
- package/scripts/extractAgentDocs.js +41 -30
- package/scripts/hashDocSources.js +38 -0
- package/scripts/isRedirectPage.js +26 -0
- package/scripts/recordSourceHashes.js +97 -0
- package/scripts/resolvePageSections.js +42 -0
- package/scripts/sectionKind.js +27 -0
- package/content/concepts/cli.md +0 -223
- package/content/other/introduction.md +0 -39
- package/content/other/next-auth-providers.md +0 -3
- /package/content/{other → actions}/updatesession.md +0 -0
|
@@ -18,12 +18,12 @@ Browse the full API reference and configuration guides.
|
|
|
18
18
|
type: MenuLink
|
|
19
19
|
properties:
|
|
20
20
|
title: Home
|
|
21
|
-
icon:
|
|
21
|
+
icon: home
|
|
22
22
|
- id: phm_basic_products
|
|
23
23
|
type: MenuLink
|
|
24
24
|
properties:
|
|
25
25
|
title: Products
|
|
26
|
-
icon:
|
|
26
|
+
icon: grid
|
|
27
27
|
- id: phm_basic_pricing
|
|
28
28
|
type: MenuLink
|
|
29
29
|
properties:
|
|
@@ -67,6 +67,62 @@ Browse the full API reference and configuration guides.
|
|
|
67
67
|
content: Browse the full API reference and configuration guides.
|
|
68
68
|
```
|
|
69
69
|
|
|
70
|
+
padding: compact trims the content padding from 40px to 16px, so data-heavy pages show more.
|
|
71
|
+
|
|
72
|
+
```yaml
|
|
73
|
+
- id: phm_compact
|
|
74
|
+
type: PageHeaderMenu
|
|
75
|
+
properties:
|
|
76
|
+
padding: compact
|
|
77
|
+
menu:
|
|
78
|
+
links:
|
|
79
|
+
- id: phm_compact_home
|
|
80
|
+
type: MenuLink
|
|
81
|
+
properties:
|
|
82
|
+
title: Home
|
|
83
|
+
- id: phm_compact_invoices
|
|
84
|
+
type: MenuLink
|
|
85
|
+
properties:
|
|
86
|
+
title: Invoices
|
|
87
|
+
blocks:
|
|
88
|
+
- id: phm_compact_text
|
|
89
|
+
type: Paragraph
|
|
90
|
+
properties:
|
|
91
|
+
content: "padding: compact trims the content padding from 40px to 16px, so
|
|
92
|
+
data-heavy pages show more."
|
|
93
|
+
- id: phm_compact_card
|
|
94
|
+
type: Card
|
|
95
|
+
properties:
|
|
96
|
+
title: Recent invoices
|
|
97
|
+
padding: none
|
|
98
|
+
blocks:
|
|
99
|
+
- id: phm_compact_card_rows
|
|
100
|
+
type: Html
|
|
101
|
+
properties:
|
|
102
|
+
html: >
|
|
103
|
+
<div style="display: flex; justify-content: space-between;
|
|
104
|
+
padding: 8px 24px; border-bottom: 1px solid
|
|
105
|
+
var(--ant-color-border-secondary);"><span>INV-1042</span><span
|
|
106
|
+
style="color:
|
|
107
|
+
var(--ant-color-text-secondary);">$1,280.00</span></div>
|
|
108
|
+
|
|
109
|
+
<div style="display: flex; justify-content: space-between;
|
|
110
|
+
padding: 8px 24px; border-bottom: 1px solid
|
|
111
|
+
var(--ant-color-border-secondary);"><span>INV-1041</span><span
|
|
112
|
+
style="color:
|
|
113
|
+
var(--ant-color-text-secondary);">$640.00</span></div>
|
|
114
|
+
|
|
115
|
+
<div style="display: flex; justify-content: space-between;
|
|
116
|
+
padding: 8px 24px; border-bottom: 1px solid
|
|
117
|
+
var(--ant-color-border-secondary);"><span>INV-1040</span><span
|
|
118
|
+
style="color:
|
|
119
|
+
var(--ant-color-text-secondary);">$2,115.50</span></div>
|
|
120
|
+
|
|
121
|
+
<div style="display: flex; justify-content: space-between;
|
|
122
|
+
padding: 8px 24px;"><span>INV-1039</span><span style="color:
|
|
123
|
+
var(--ant-color-text-secondary);">$96.00</span></div>
|
|
124
|
+
```
|
|
125
|
+
|
|
70
126
|
Analytics Overview
|
|
71
127
|
|
|
72
128
|
```yaml
|
|
@@ -78,7 +134,7 @@ Analytics Overview
|
|
|
78
134
|
separator: /
|
|
79
135
|
list:
|
|
80
136
|
- label: Home
|
|
81
|
-
icon:
|
|
137
|
+
icon: home
|
|
82
138
|
- label: Analytics
|
|
83
139
|
- label: Overview
|
|
84
140
|
menu:
|
|
@@ -87,12 +143,12 @@ Analytics Overview
|
|
|
87
143
|
type: MenuLink
|
|
88
144
|
properties:
|
|
89
145
|
title: Dashboard
|
|
90
|
-
icon:
|
|
146
|
+
icon: Gauge
|
|
91
147
|
- id: phm_g_analytics
|
|
92
148
|
type: MenuGroup
|
|
93
149
|
properties:
|
|
94
150
|
title: Analytics
|
|
95
|
-
icon:
|
|
151
|
+
icon: chart
|
|
96
152
|
links:
|
|
97
153
|
- id: phm_g_overview
|
|
98
154
|
type: MenuLink
|
|
@@ -110,7 +166,7 @@ Analytics Overview
|
|
|
110
166
|
type: MenuLink
|
|
111
167
|
properties:
|
|
112
168
|
title: Settings
|
|
113
|
-
icon:
|
|
169
|
+
icon: settings
|
|
114
170
|
blocks:
|
|
115
171
|
- id: phm_g_title
|
|
116
172
|
type: Title
|
|
@@ -179,19 +235,19 @@ Dashboard
|
|
|
179
235
|
type: MenuLink
|
|
180
236
|
properties:
|
|
181
237
|
title: My Profile
|
|
182
|
-
icon:
|
|
238
|
+
icon: user
|
|
183
239
|
- id: phm_prof_settings
|
|
184
240
|
type: MenuLink
|
|
185
241
|
properties:
|
|
186
242
|
title: Settings
|
|
187
|
-
icon:
|
|
243
|
+
icon: settings
|
|
188
244
|
- id: phm_prof_divider
|
|
189
245
|
type: MenuDivider
|
|
190
246
|
- id: phm_prof_logout
|
|
191
247
|
type: MenuLink
|
|
192
248
|
properties:
|
|
193
249
|
title: Logout
|
|
194
|
-
icon:
|
|
250
|
+
icon: logout
|
|
195
251
|
danger: true
|
|
196
252
|
menu:
|
|
197
253
|
links:
|
|
@@ -199,17 +255,17 @@ Dashboard
|
|
|
199
255
|
type: MenuLink
|
|
200
256
|
properties:
|
|
201
257
|
title: Home
|
|
202
|
-
icon:
|
|
258
|
+
icon: home
|
|
203
259
|
- id: phm_prof_projects
|
|
204
260
|
type: MenuLink
|
|
205
261
|
properties:
|
|
206
262
|
title: Projects
|
|
207
|
-
icon:
|
|
263
|
+
icon: SquareKanban
|
|
208
264
|
- id: phm_prof_reports
|
|
209
265
|
type: MenuLink
|
|
210
266
|
properties:
|
|
211
267
|
title: Reports
|
|
212
|
-
icon:
|
|
268
|
+
icon: chart
|
|
213
269
|
blocks:
|
|
214
270
|
- id: phm_prof_title
|
|
215
271
|
type: Title
|
|
@@ -268,7 +324,7 @@ View Expense Reports
|
|
|
268
324
|
dot: true
|
|
269
325
|
profile:
|
|
270
326
|
avatar:
|
|
271
|
-
icon:
|
|
327
|
+
icon: user
|
|
272
328
|
breadcrumb:
|
|
273
329
|
list:
|
|
274
330
|
- Intranet
|
|
@@ -279,17 +335,17 @@ View Expense Reports
|
|
|
279
335
|
type: MenuLink
|
|
280
336
|
properties:
|
|
281
337
|
title: Home
|
|
282
|
-
icon:
|
|
338
|
+
icon: home
|
|
283
339
|
- id: phm_full_directory
|
|
284
340
|
type: MenuLink
|
|
285
341
|
properties:
|
|
286
342
|
title: Directory
|
|
287
|
-
icon:
|
|
343
|
+
icon: users
|
|
288
344
|
- id: phm_full_resources
|
|
289
345
|
type: MenuGroup
|
|
290
346
|
properties:
|
|
291
347
|
title: Resources
|
|
292
|
-
icon:
|
|
348
|
+
icon: Book
|
|
293
349
|
links:
|
|
294
350
|
- id: phm_full_policies
|
|
295
351
|
type: MenuLink
|
|
@@ -303,7 +359,7 @@ View Expense Reports
|
|
|
303
359
|
type: MenuLink
|
|
304
360
|
properties:
|
|
305
361
|
title: IT Support
|
|
306
|
-
icon:
|
|
362
|
+
icon: help
|
|
307
363
|
slots:
|
|
308
364
|
footer:
|
|
309
365
|
blocks:
|
|
@@ -311,7 +367,8 @@ View Expense Reports
|
|
|
311
367
|
type: Paragraph
|
|
312
368
|
properties:
|
|
313
369
|
content: Acme Corp Intranet - Internal Use Only
|
|
314
|
-
|
|
370
|
+
style:
|
|
371
|
+
.element:
|
|
315
372
|
margin: 0
|
|
316
373
|
color: "#888"
|
|
317
374
|
textAlign: center
|
|
@@ -381,22 +438,22 @@ Get started by installing the framework via npm or yarn. Follow the steps below
|
|
|
381
438
|
type: MenuLink
|
|
382
439
|
properties:
|
|
383
440
|
title: Guide
|
|
384
|
-
icon:
|
|
441
|
+
icon: Book
|
|
385
442
|
- id: phm_light_api
|
|
386
443
|
type: MenuLink
|
|
387
444
|
properties:
|
|
388
445
|
title: API Reference
|
|
389
|
-
icon:
|
|
446
|
+
icon: Plug
|
|
390
447
|
- id: phm_light_examples
|
|
391
448
|
type: MenuLink
|
|
392
449
|
properties:
|
|
393
450
|
title: Examples
|
|
394
|
-
icon:
|
|
451
|
+
icon: CodeXml
|
|
395
452
|
- id: phm_light_community
|
|
396
453
|
type: MenuLink
|
|
397
454
|
properties:
|
|
398
455
|
title: Community
|
|
399
|
-
icon:
|
|
456
|
+
icon: globe
|
|
400
457
|
breadcrumb:
|
|
401
458
|
separator: /
|
|
402
459
|
list:
|
|
@@ -412,7 +469,7 @@ Get started by installing the framework via npm or yarn. Follow the steps below
|
|
|
412
469
|
flex: 0 0 auto
|
|
413
470
|
properties:
|
|
414
471
|
title: Search
|
|
415
|
-
icon:
|
|
472
|
+
icon: search
|
|
416
473
|
color: default
|
|
417
474
|
variant: outlined
|
|
418
475
|
size: small
|
|
@@ -480,12 +537,12 @@ Profile from _menu
|
|
|
480
537
|
type: MenuLink
|
|
481
538
|
properties:
|
|
482
539
|
title: Home
|
|
483
|
-
icon:
|
|
540
|
+
icon: home
|
|
484
541
|
- id: phm_mo_settings
|
|
485
542
|
type: MenuLink
|
|
486
543
|
properties:
|
|
487
544
|
title: Settings
|
|
488
|
-
icon:
|
|
545
|
+
icon: settings
|
|
489
546
|
blocks:
|
|
490
547
|
- id: phm_mo_title
|
|
491
548
|
type: Title
|
|
@@ -511,6 +568,7 @@ Profile from _menu
|
|
|
511
568
|
| `logo.alt` | string | `"Lowdefy"` | Logo image alt text. |
|
|
512
569
|
| `header` | object | - | Header properties. |
|
|
513
570
|
| `footer` | object | - | Footer properties. |
|
|
571
|
+
| `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`. |
|
|
514
572
|
| `content` | object | - | Content properties. |
|
|
515
573
|
| `breadcrumb` | object | - | Breadcrumb properties. |
|
|
516
574
|
| `breadcrumb.separator` | string | `"/"` | Use a custom separator string. |
|
|
@@ -519,14 +577,36 @@ Profile from _menu
|
|
|
519
577
|
| `breadcrumb.list.$.pageId` | string | - | Page id to link to when clicked. |
|
|
520
578
|
| `breadcrumb.list.$.url` | string | - | External url link. |
|
|
521
579
|
| `breadcrumb.list.$.style` | object | - | Css style to apply to link. |
|
|
522
|
-
| `breadcrumb.list.$.icon` | string \| object | - |
|
|
580
|
+
| `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. |
|
|
581
|
+
| `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`. |
|
|
582
|
+
| `breadcrumb.list.$.icon.color` | string | - | Icon color. |
|
|
583
|
+
| `breadcrumb.list.$.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
584
|
+
| `breadcrumb.list.$.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
585
|
+
| `breadcrumb.list.$.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
586
|
+
| `breadcrumb.list.$.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
587
|
+
| `breadcrumb.list.$.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
588
|
+
| `breadcrumb.list.$.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
589
|
+
| `breadcrumb.list.$.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
590
|
+
| `breadcrumb.list.$.links` | array | - | Links shown in a dropdown menu on the breadcrumb item. |
|
|
591
|
+
| `breadcrumb.list.$.links.$.label` | string | - | Label of the dropdown link. |
|
|
592
|
+
| `breadcrumb.list.$.links.$.pageId` | string | - | Page id to link to when clicked. |
|
|
593
|
+
| `breadcrumb.list.$.links.$.url` | string | - | External url link. |
|
|
523
594
|
| `menu` | object | - | Menu properties. |
|
|
524
595
|
| `menu.links` | array | - | |
|
|
525
596
|
| `menu.links.$.id` | string | - | Menu item id. |
|
|
526
597
|
| `menu.links.$.pageId` | string | - | Page to link to. |
|
|
527
598
|
| `menu.links.$.properties` | object | - | properties from menu item. |
|
|
528
599
|
| `menu.links.$.properties.title` | string | - | Menu item title. |
|
|
529
|
-
| `menu.links.$.properties.icon` | string \| object | - |
|
|
600
|
+
| `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. |
|
|
601
|
+
| `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`. |
|
|
602
|
+
| `menu.links.$.properties.icon.color` | string | - | Icon color. |
|
|
603
|
+
| `menu.links.$.properties.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
604
|
+
| `menu.links.$.properties.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
605
|
+
| `menu.links.$.properties.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
606
|
+
| `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). |
|
|
607
|
+
| `menu.links.$.properties.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
608
|
+
| `menu.links.$.properties.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
609
|
+
| `menu.links.$.properties.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
530
610
|
| `menuLg` | object | - | Menu large screen properties. Overwrites menu properties on desktop screen sizes. |
|
|
531
611
|
| `menuMd` | object | - | Mobile menu properties. Overwrites menu properties on mobile screen sizes. |
|
|
532
612
|
| `notifications` | object | - | Notification bell icon with badge in the header. Renders when configured. Use the link property to navigate when clicked. |
|
|
@@ -539,15 +619,33 @@ Profile from _menu
|
|
|
539
619
|
| `notifications.showZero` | boolean | `false` | Show badge when count is zero. |
|
|
540
620
|
| `notifications.overflowCount` | number | `99` | Max count to show. Values above this display as "N+". |
|
|
541
621
|
| `notifications.color` | string | - | Badge color. |
|
|
542
|
-
| `notifications.icon` | string \| object | - | Icon for the notification button. Defaults to
|
|
622
|
+
| `notifications.icon` | string \| object | - | Icon for the notification button. Defaults to `bell`. |
|
|
623
|
+
| `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`. |
|
|
624
|
+
| `notifications.icon.color` | string | - | Icon color. |
|
|
625
|
+
| `notifications.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
626
|
+
| `notifications.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
627
|
+
| `notifications.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
628
|
+
| `notifications.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
629
|
+
| `notifications.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
630
|
+
| `notifications.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
631
|
+
| `notifications.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
543
632
|
| `notifications.size` | string | `"small"` | Size of the notification button. Enum: `small`, `default`, `large`. |
|
|
544
633
|
| `profile` | object | - | Profile avatar with optional dropdown menu in the header. Renders when configured. Use with the _user operator to populate from the authenticated user. |
|
|
545
634
|
| `profile.avatar` | object | - | Avatar display properties. |
|
|
546
635
|
| `profile.avatar.src` | string | - | Image URL for the avatar. Typically bound to _user: image. |
|
|
547
636
|
| `profile.avatar.content` | string | - | Text content inside the avatar (e.g. user initials). Shown when no src is provided. |
|
|
548
|
-
| `profile.avatar.icon` | string \| object | - | Icon to display in avatar when no src or content is set. Defaults to
|
|
637
|
+
| `profile.avatar.icon` | string \| object | - | Icon to display in avatar when no src or content is set. Defaults to `user`. |
|
|
638
|
+
| `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`. |
|
|
639
|
+
| `profile.avatar.icon.color` | string | - | Icon color. |
|
|
640
|
+
| `profile.avatar.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
641
|
+
| `profile.avatar.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
642
|
+
| `profile.avatar.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
643
|
+
| `profile.avatar.icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
644
|
+
| `profile.avatar.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
645
|
+
| `profile.avatar.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
646
|
+
| `profile.avatar.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
549
647
|
| `profile.avatar.color` | string | - | Background color of the avatar when not using src. |
|
|
550
|
-
| `profile.avatar.size` | string \| number | `"small"` | Size of the avatar
|
|
648
|
+
| `profile.avatar.size` | string \| number | `"small"` | Size of the avatar: default, small, large or a pixel number. |
|
|
551
649
|
| `profile.avatar.shape` | string | `"circle"` | Shape of the avatar. Enum: `circle`, `square`. |
|
|
552
650
|
| `profile.links` | array | - | Dropdown menu items. Uses the same MenuLink/MenuGroup/MenuDivider schema as Menu. Compatible with _menu operator output for access-filtered menus. |
|
|
553
651
|
| `profile.links.$.id` | string | - | Menu item id. |
|
|
@@ -559,6 +657,15 @@ Profile from _menu
|
|
|
559
657
|
| `profile.links.$.properties` | object | - | Properties for the menu item. |
|
|
560
658
|
| `profile.links.$.properties.title` | string | - | Menu item title. |
|
|
561
659
|
| `profile.links.$.properties.icon` | string \| object | - | Icon for the menu item. |
|
|
660
|
+
| `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`. |
|
|
661
|
+
| `profile.links.$.properties.icon.color` | string | - | Icon color. |
|
|
662
|
+
| `profile.links.$.properties.icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
663
|
+
| `profile.links.$.properties.icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
664
|
+
| `profile.links.$.properties.icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
665
|
+
| `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). |
|
|
666
|
+
| `profile.links.$.properties.icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
667
|
+
| `profile.links.$.properties.icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
668
|
+
| `profile.links.$.properties.icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
562
669
|
| `profile.links.$.properties.danger` | boolean | `false` | Apply danger style to menu item. |
|
|
563
670
|
| `profile.links.$.properties.disabled` | boolean | `false` | Disable the menu item. |
|
|
564
671
|
| `profile.links.$.properties.dashed` | boolean | `false` | Whether the divider line is dashed. |
|
|
@@ -570,7 +677,7 @@ Profile from _menu
|
|
|
570
677
|
| `profile.arrow.pointAtCenter` | boolean | - | |
|
|
571
678
|
| `darkModeToggle` | boolean | `false` | Show a dark mode toggle button in the header. Toggles the Ant Design dark theme for the entire page. Preference is persisted to localStorage. |
|
|
572
679
|
| `localeSelector` | boolean | `false` | Show a locale picker dropdown in the header. Lists locales declared in `config.i18n.locales` and dispatches `SetLocale` on selection. Renders nothing when `config.i18n` is not configured. |
|
|
573
|
-
| `theme` | object | - | Antd design token overrides
|
|
680
|
+
| `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). |
|
|
574
681
|
|
|
575
682
|
| Event | Event Data | Description |
|
|
576
683
|
| --- | --- | --- |
|