@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
|
@@ -225,7 +225,7 @@ Button with colors, variants, sizes, shapes, icons, ghost, and block modes.
|
|
|
225
225
|
layout:
|
|
226
226
|
flex: 0 0 auto
|
|
227
227
|
properties:
|
|
228
|
-
icon:
|
|
228
|
+
icon: search
|
|
229
229
|
shape: circle
|
|
230
230
|
color: primary
|
|
231
231
|
variant: solid
|
|
@@ -235,7 +235,7 @@ Button with colors, variants, sizes, shapes, icons, ghost, and block modes.
|
|
|
235
235
|
layout:
|
|
236
236
|
flex: 0 0 auto
|
|
237
237
|
properties:
|
|
238
|
-
icon:
|
|
238
|
+
icon: add
|
|
239
239
|
shape: circle
|
|
240
240
|
color: primary
|
|
241
241
|
variant: outlined
|
|
@@ -249,7 +249,7 @@ Button with colors, variants, sizes, shapes, icons, ghost, and block modes.
|
|
|
249
249
|
flex: 0 0 auto
|
|
250
250
|
properties:
|
|
251
251
|
title: Download
|
|
252
|
-
icon:
|
|
252
|
+
icon: download
|
|
253
253
|
color: primary
|
|
254
254
|
variant: solid
|
|
255
255
|
- id: icon_search
|
|
@@ -258,7 +258,7 @@ Button with colors, variants, sizes, shapes, icons, ghost, and block modes.
|
|
|
258
258
|
flex: 0 0 auto
|
|
259
259
|
properties:
|
|
260
260
|
title: Search
|
|
261
|
-
icon:
|
|
261
|
+
icon: search
|
|
262
262
|
color: primary
|
|
263
263
|
variant: outlined
|
|
264
264
|
- id: icon_delete
|
|
@@ -267,7 +267,7 @@ Button with colors, variants, sizes, shapes, icons, ghost, and block modes.
|
|
|
267
267
|
flex: 0 0 auto
|
|
268
268
|
properties:
|
|
269
269
|
title: Delete
|
|
270
|
-
icon:
|
|
270
|
+
icon: delete
|
|
271
271
|
color: danger
|
|
272
272
|
variant: solid
|
|
273
273
|
- id: icon_only
|
|
@@ -275,7 +275,7 @@ Button with colors, variants, sizes, shapes, icons, ghost, and block modes.
|
|
|
275
275
|
layout:
|
|
276
276
|
flex: 0 0 auto
|
|
277
277
|
properties:
|
|
278
|
-
icon:
|
|
278
|
+
icon: star
|
|
279
279
|
color: gold
|
|
280
280
|
variant: filled
|
|
281
281
|
hideTitle: true
|
|
@@ -286,12 +286,56 @@ Button with colors, variants, sizes, shapes, icons, ghost, and block modes.
|
|
|
286
286
|
properties:
|
|
287
287
|
title: Custom
|
|
288
288
|
icon:
|
|
289
|
-
name:
|
|
289
|
+
name: Zap
|
|
290
290
|
color: "#faad14"
|
|
291
291
|
color: primary
|
|
292
292
|
variant: outlined
|
|
293
293
|
```
|
|
294
294
|
|
|
295
|
+
```yaml
|
|
296
|
+
- id: placement_back
|
|
297
|
+
type: Button
|
|
298
|
+
layout:
|
|
299
|
+
flex: 0 0 auto
|
|
300
|
+
properties:
|
|
301
|
+
title: Back
|
|
302
|
+
icon: arrow-left
|
|
303
|
+
color: default
|
|
304
|
+
variant: outlined
|
|
305
|
+
- id: placement_next
|
|
306
|
+
type: Button
|
|
307
|
+
layout:
|
|
308
|
+
flex: 0 0 auto
|
|
309
|
+
properties:
|
|
310
|
+
title: Next
|
|
311
|
+
icon: arrow-right
|
|
312
|
+
iconPlacement: end
|
|
313
|
+
color: primary
|
|
314
|
+
variant: outlined
|
|
315
|
+
- id: placement_send
|
|
316
|
+
type: Button
|
|
317
|
+
layout:
|
|
318
|
+
flex: 0 0 auto
|
|
319
|
+
properties:
|
|
320
|
+
title: Send
|
|
321
|
+
icon: send
|
|
322
|
+
iconPlacement: end
|
|
323
|
+
color: primary
|
|
324
|
+
variant: solid
|
|
325
|
+
- id: placement_docs
|
|
326
|
+
type: Button
|
|
327
|
+
layout:
|
|
328
|
+
flex: 0 0 auto
|
|
329
|
+
properties:
|
|
330
|
+
title: Open docs
|
|
331
|
+
icon: external-link
|
|
332
|
+
iconPlacement: end
|
|
333
|
+
href: https://docs.lowdefy.com
|
|
334
|
+
target: _blank
|
|
335
|
+
color: primary
|
|
336
|
+
variant: link
|
|
337
|
+
```
|
|
338
|
+
|
|
295
339
|
```yaml
|
|
296
340
|
- id: ghost_bg
|
|
297
341
|
type: Box
|
|
@@ -336,7 +380,7 @@ Button with colors, variants, sizes, shapes, icons, ghost, and block modes.
|
|
|
336
380
|
block: true
|
|
337
381
|
color: primary
|
|
338
382
|
variant: solid
|
|
339
|
-
icon:
|
|
383
|
+
icon: arrow-right
|
|
340
384
|
- id: block_outlined
|
|
341
385
|
type: Button
|
|
342
386
|
properties:
|
|
@@ -351,7 +395,7 @@ Button with colors, variants, sizes, shapes, icons, ghost, and block modes.
|
|
|
351
395
|
block: true
|
|
352
396
|
color: danger
|
|
353
397
|
variant: solid
|
|
354
|
-
icon:
|
|
398
|
+
icon: warning
|
|
355
399
|
```
|
|
356
400
|
|
|
357
401
|
```yaml
|
|
@@ -403,7 +447,7 @@ Button with colors, variants, sizes, shapes, icons, ghost, and block modes.
|
|
|
403
447
|
href: https://docs.lowdefy.com
|
|
404
448
|
color: primary
|
|
405
449
|
variant: solid
|
|
406
|
-
icon:
|
|
450
|
+
icon: link
|
|
407
451
|
- id: href_text
|
|
408
452
|
type: Button
|
|
409
453
|
layout:
|
|
@@ -449,7 +493,7 @@ Button with colors, variants, sizes, shapes, icons, ghost, and block modes.
|
|
|
449
493
|
flex: 0 0 auto
|
|
450
494
|
properties:
|
|
451
495
|
title: Save
|
|
452
|
-
icon:
|
|
496
|
+
icon: save
|
|
453
497
|
color: primary
|
|
454
498
|
variant: solid
|
|
455
499
|
events:
|
|
@@ -467,7 +511,7 @@ Button with colors, variants, sizes, shapes, icons, ghost, and block modes.
|
|
|
467
511
|
flex: 0 0 auto
|
|
468
512
|
properties:
|
|
469
513
|
title: New Item
|
|
470
|
-
icon:
|
|
514
|
+
icon: add
|
|
471
515
|
color: primary
|
|
472
516
|
variant: outlined
|
|
473
517
|
events:
|
|
@@ -485,7 +529,7 @@ Button with colors, variants, sizes, shapes, icons, ghost, and block modes.
|
|
|
485
529
|
flex: 0 0 auto
|
|
486
530
|
properties:
|
|
487
531
|
title: Delete
|
|
488
|
-
icon:
|
|
532
|
+
icon: delete
|
|
489
533
|
color: danger
|
|
490
534
|
variant: solid
|
|
491
535
|
events:
|
|
@@ -638,7 +682,7 @@ Button with colors, variants, sizes, shapes, icons, ghost, and block modes.
|
|
|
638
682
|
title: Send Message
|
|
639
683
|
color: primary
|
|
640
684
|
variant: solid
|
|
641
|
-
icon:
|
|
685
|
+
icon: send
|
|
642
686
|
events:
|
|
643
687
|
onClick:
|
|
644
688
|
- id: submit_validate
|
|
@@ -694,7 +738,7 @@ Button with colors, variants, sizes, shapes, icons, ghost, and block modes.
|
|
|
694
738
|
title: Delete Permanently
|
|
695
739
|
color: danger
|
|
696
740
|
variant: solid
|
|
697
|
-
icon:
|
|
741
|
+
icon: delete
|
|
698
742
|
events:
|
|
699
743
|
onClick:
|
|
700
744
|
- id: delete_msg
|
|
@@ -716,12 +760,24 @@ Button with colors, variants, sizes, shapes, icons, ghost, and block modes.
|
|
|
716
760
|
| `disabled` | boolean | `false` | Disable the button if true. |
|
|
717
761
|
| `ghost` | boolean | `false` | Make the button's background transparent when true. |
|
|
718
762
|
| `hideTitle` | boolean | `false` | Hide the button's title. |
|
|
763
|
+
| `tooltip` | string | - | Hover text for the button. An icon-only button (`hideTitle: true`) shows its `title` as the tooltip when this is not set. |
|
|
719
764
|
| `href` | string | - | The URL to redirect to when the button is clicked. Useful when used with a type link button. |
|
|
720
|
-
| `
|
|
765
|
+
| `target` | string | - | Where to open the `href` link, the anchor target attribute. For example `_blank` opens it in a new tab. |
|
|
766
|
+
| `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 icon in button. |
|
|
767
|
+
| `icon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
|
|
768
|
+
| `icon.color` | string | - | Icon color. |
|
|
769
|
+
| `icon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
|
|
770
|
+
| `icon.rotate` | number | - | Number of degrees to rotate the icon. |
|
|
771
|
+
| `icon.spin` | boolean | - | Continuously spin the icon with animation. |
|
|
772
|
+
| `icon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
|
|
773
|
+
| `icon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
|
|
774
|
+
| `icon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
|
|
775
|
+
| `icon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
|
|
776
|
+
| `iconPlacement` | string | `"start"` | Place the icon before (start) or after (end) the title. Enum: `start`, `end`. |
|
|
721
777
|
| `shape` | string | `"square"` | Shape of the button. Enum: `circle`, `round`, `square`. |
|
|
722
|
-
| `size` | string | `"default"` | Size of the button. Enum: `small`, `default`, `large`. |
|
|
778
|
+
| `size` | string | `"default"` | Size of the button. `middle` is antd's name for the default size. Enum: `small`, `default`, `middle`, `large`. |
|
|
723
779
|
| `title` | string | - | Title text on the button - supports html. |
|
|
724
|
-
| `type` | string | `"primary"` | Deprecated - use color and variant instead. The button type. Enum: `primary`, `default`, `dashed`, `link`, `text`. |
|
|
780
|
+
| `type` | string | `"primary"` | Deprecated - use color and variant instead. The button type. Enum: `primary`, `default`, `dashed`, `link`, `text`, `danger`. |
|
|
725
781
|
| `variant` | string | - | Button visual variant. When set, takes precedence over type. Enum: `solid`, `outlined`, `dashed`, `filled`, `text`, `link`. |
|
|
726
782
|
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design button tokens](https://ant.design/components/button#design-token). |
|
|
727
783
|
| `theme.borderRadius` | number | `6` | Border radius of the button. |
|
|
@@ -737,13 +793,31 @@ Button with colors, variants, sizes, shapes, icons, ghost, and block modes.
|
|
|
737
793
|
| `theme.paddingInline` | number | `15` | Horizontal padding. |
|
|
738
794
|
| `theme.paddingInlineLG` | number | `15` | Horizontal padding for large buttons. |
|
|
739
795
|
| `theme.paddingInlineSM` | number | `7` | Horizontal padding for small buttons. |
|
|
740
|
-
| `theme.paddingBlock` | number | `0` |
|
|
796
|
+
| `theme.paddingBlock` | number | `0` | Deprecated in antd 6 and has no effect. Use controlHeight instead. |
|
|
741
797
|
| `theme.colorPrimary` | string | - | Primary color override. |
|
|
742
798
|
| `theme.colorPrimaryHover` | string | - | Primary hover color. |
|
|
743
799
|
| `theme.colorPrimaryActive` | string | - | Primary active color. |
|
|
744
800
|
| `theme.colorBgContainer` | string | - | Background color for default buttons. |
|
|
745
801
|
| `theme.colorText` | string | - | Text color for default buttons. |
|
|
746
802
|
| `theme.colorBorder` | string | - | Border color for outlined and dashed buttons. |
|
|
803
|
+
| `theme.fontWeight` | number \| string | `400` | Font weight of the button text. |
|
|
804
|
+
| `theme.iconGap` | number | `8` | Gap between the icon and the title. |
|
|
805
|
+
| `theme.contentFontSize` | number | `14` | Font size of the button content. |
|
|
806
|
+
| `theme.contentFontSizeLG` | number | `16` | Font size of the content of large buttons. |
|
|
807
|
+
| `theme.contentFontSizeSM` | number | `14` | Font size of the content of small buttons. |
|
|
808
|
+
| `theme.onlyIconSize` | number \| string | `"inherit"` | Icon size of a button that only contains an icon. |
|
|
809
|
+
| `theme.primaryColor` | string | `"#fff"` | Text color of primary buttons. |
|
|
810
|
+
| `theme.dangerColor` | string | `"#fff"` | Text color of danger buttons. |
|
|
811
|
+
| `theme.defaultBg` | string | `"#ffffff"` | Background color of default buttons. |
|
|
812
|
+
| `theme.defaultColor` | string | `"rgba(0, 0, 0, 0.88)"` | Text color of default buttons. |
|
|
813
|
+
| `theme.defaultBorderColor` | string | `"#d9d9d9"` | Border color of default buttons. |
|
|
814
|
+
| `theme.defaultHoverBg` | string | `"#ffffff"` | Background color of default buttons on hover. |
|
|
815
|
+
| `theme.defaultHoverColor` | string | `"#4096ff"` | Text color of default buttons on hover. |
|
|
816
|
+
| `theme.defaultHoverBorderColor` | string | `"#4096ff"` | Border color of default buttons on hover. |
|
|
817
|
+
| `theme.textHoverBg` | string | `"rgba(0, 0, 0, 0.04)"` | Background color of text buttons on hover. |
|
|
818
|
+
| `theme.defaultShadow` | string | `"0 2px 0 rgba(0, 0, 0, 0.02)"` | Box shadow of default buttons. |
|
|
819
|
+
| `theme.primaryShadow` | string | `"0 2px 0 rgba(5, 145, 255, 0.1)"` | Box shadow of primary buttons. |
|
|
820
|
+
| `theme.dangerShadow` | string | `"0 2px 0 rgba(255, 38, 5, 0.06)"` | Box shadow of danger buttons. |
|
|
747
821
|
|
|
748
822
|
| Event | Event Data | Description |
|
|
749
823
|
| --- | --- | --- |
|
|
@@ -14,6 +14,14 @@ Full-size or compact calendar for date display and selection, with support for d
|
|
|
14
14
|
fullscreen: false
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
+
```yaml
|
|
18
|
+
- id: week_numbers
|
|
19
|
+
type: Calendar
|
|
20
|
+
properties:
|
|
21
|
+
fullscreen: false
|
|
22
|
+
showWeek: true
|
|
23
|
+
```
|
|
24
|
+
|
|
17
25
|
```yaml
|
|
18
26
|
- id: year_mode
|
|
19
27
|
type: Calendar
|
|
@@ -121,6 +129,7 @@ Full-size or compact calendar for date display and selection, with support for d
|
|
|
121
129
|
| --- | --- | --- | --- |
|
|
122
130
|
| `fullscreen` | boolean | `true` | Whether to display the calendar in full size. Set to false for a compact card-style calendar. |
|
|
123
131
|
| `mode` | string | `"month"` | The display mode of the calendar panel. Enum: `month`, `year`. |
|
|
132
|
+
| `showWeek` | boolean | `false` | Show the week number column. |
|
|
124
133
|
| `disabledDates` | object | - | Disable specific dates so that they can not be chosen. |
|
|
125
134
|
| `disabledDates.min` | string \| object | - | Disable all dates less than the minimum date. Can be a date string or a _date object. |
|
|
126
135
|
| `disabledDates.max` | string \| object | - | Disable all dates greater than the maximum date. Can be a date string or a _date object. |
|
|
@@ -152,5 +161,8 @@ Full-size or compact calendar for date display and selection, with support for d
|
|
|
152
161
|
| --- | --- |
|
|
153
162
|
| `/block` | Outer block wrapper (always available). |
|
|
154
163
|
| `/element` | The Calendar element. |
|
|
164
|
+
| `/header` | The Calendar header with the year, month and mode selectors. |
|
|
165
|
+
| `/item` | Each date or month cell of the Calendar. |
|
|
166
|
+
| `/itemContent` | The content area inside each cell, where dateCellData renders. |
|
|
155
167
|
|
|
156
168
|
No slots defined.
|
|
@@ -0,0 +1,239 @@
|
|
|
1
|
+
# ClickableHtml
|
|
2
|
+
|
|
3
|
+
Render raw HTML content safely, and fire a named event when an element carrying a `data-event` attribute is clicked: `data-event="onEditClick"` fires the block's `onEditClick` event, so every clickable target in one block of markup gets its own action chain without a block per button. The event object holds the element's other `data-*` attributes with snake_case keys (`data-record-id` becomes `record_id`). Only the events listed in `dataEvents` fire, and each can require a confirmation. HTML built from user or request data must escape that data, so it cannot add `data-event` elements of its own: `_nunjucks` escapes `{{ values }}` unless they are marked `safe`, while `_string.concat` and `_js` do not.
|
|
4
|
+
|
|
5
|
+
```yaml
|
|
6
|
+
- id: buttons_basic
|
|
7
|
+
type: ClickableHtml
|
|
8
|
+
properties:
|
|
9
|
+
dataEvents:
|
|
10
|
+
- onSmallClick
|
|
11
|
+
- onLargeClick
|
|
12
|
+
html: '<p>Pick a size: <button data-event="onSmallClick">Small</button> <button
|
|
13
|
+
data-event="onLargeClick">Large</button></p>'
|
|
14
|
+
events:
|
|
15
|
+
onSmallClick:
|
|
16
|
+
- id: set_small
|
|
17
|
+
type: SetState
|
|
18
|
+
params:
|
|
19
|
+
buttons_basic_selected: small
|
|
20
|
+
onLargeClick:
|
|
21
|
+
- id: set_large
|
|
22
|
+
type: SetState
|
|
23
|
+
params:
|
|
24
|
+
buttons_basic_selected: large
|
|
25
|
+
- id: buttons_basic_result
|
|
26
|
+
type: Html
|
|
27
|
+
properties:
|
|
28
|
+
html:
|
|
29
|
+
_string.concat:
|
|
30
|
+
- "<p>State: <code>"
|
|
31
|
+
- _state:
|
|
32
|
+
key: buttons_basic_selected
|
|
33
|
+
default: nothing yet
|
|
34
|
+
- </code></p>
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
```yaml
|
|
38
|
+
- id: list_rows
|
|
39
|
+
type: ClickableHtml
|
|
40
|
+
properties:
|
|
41
|
+
dataEvents:
|
|
42
|
+
- onRowClick
|
|
43
|
+
html: '<ul style="list-style: none; padding: 0; margin: 0;"><li
|
|
44
|
+
data-event="onRowClick" data-record-id="rec_1" style="padding: 8px;
|
|
45
|
+
cursor: pointer; border-bottom: 1px solid var(--ant-color-border);">First
|
|
46
|
+
record</li><li data-event="onRowClick" data-record-id="rec_2"
|
|
47
|
+
style="padding: 8px; cursor: pointer; border-bottom: 1px solid
|
|
48
|
+
var(--ant-color-border);">Second record</li><li data-event="onRowClick"
|
|
49
|
+
data-record-id="rec_3" style="padding: 8px; cursor: pointer;">Third
|
|
50
|
+
record</li></ul>'
|
|
51
|
+
events:
|
|
52
|
+
onRowClick:
|
|
53
|
+
- id: set_clicked
|
|
54
|
+
type: SetState
|
|
55
|
+
params:
|
|
56
|
+
list_rows_clicked:
|
|
57
|
+
_event: true
|
|
58
|
+
- id: list_rows_result
|
|
59
|
+
type: Html
|
|
60
|
+
properties:
|
|
61
|
+
html:
|
|
62
|
+
_string.concat:
|
|
63
|
+
- "<p>Last event: <code>"
|
|
64
|
+
- _json.stringify:
|
|
65
|
+
_state:
|
|
66
|
+
key: list_rows_clicked
|
|
67
|
+
default: {}
|
|
68
|
+
- </code></p>
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
```yaml
|
|
72
|
+
- id: mixed_content
|
|
73
|
+
type: ClickableHtml
|
|
74
|
+
properties:
|
|
75
|
+
dataEvents:
|
|
76
|
+
- onCommentClick
|
|
77
|
+
html: <p>This <a href="https://lowdefy.com" target="_blank">link</a> navigates
|
|
78
|
+
normally, but <a href="#" data-event="onCommentClick"
|
|
79
|
+
data-thread-id="t_9">this one</a> fires onCommentClick instead.</p>
|
|
80
|
+
events:
|
|
81
|
+
onCommentClick:
|
|
82
|
+
- id: set_mixed
|
|
83
|
+
type: SetState
|
|
84
|
+
params:
|
|
85
|
+
mixed_content_thread:
|
|
86
|
+
_event: thread_id
|
|
87
|
+
- id: mixed_content_result
|
|
88
|
+
type: Html
|
|
89
|
+
properties:
|
|
90
|
+
html:
|
|
91
|
+
_string.concat:
|
|
92
|
+
- "<p>Thread: <code>"
|
|
93
|
+
- _state:
|
|
94
|
+
key: mixed_content_thread
|
|
95
|
+
default: none
|
|
96
|
+
- </code></p>
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
```yaml
|
|
100
|
+
- id: style_card
|
|
101
|
+
type: ClickableHtml
|
|
102
|
+
style:
|
|
103
|
+
.element:
|
|
104
|
+
padding: 16
|
|
105
|
+
borderRadius: 8
|
|
106
|
+
border: 1px solid var(--ant-color-border)
|
|
107
|
+
background: var(--ant-color-bg-container)
|
|
108
|
+
properties:
|
|
109
|
+
dataEvents:
|
|
110
|
+
- onEditClick
|
|
111
|
+
- onRemoveClick
|
|
112
|
+
html: '<h4 style="margin: 0 0 8px 0;">Card</h4><p style="margin: 0 0 8px 0;
|
|
113
|
+
color: var(--ant-color-text-secondary);">Yours to change or remove until
|
|
114
|
+
tomorrow.</p><button data-event="onEditClick">Edit</button> <button
|
|
115
|
+
data-event="onRemoveClick">Remove</button>'
|
|
116
|
+
events:
|
|
117
|
+
onEditClick:
|
|
118
|
+
- id: set_card_edit
|
|
119
|
+
type: SetState
|
|
120
|
+
params:
|
|
121
|
+
style_card_action: edit
|
|
122
|
+
onRemoveClick:
|
|
123
|
+
- id: set_card_remove
|
|
124
|
+
type: SetState
|
|
125
|
+
params:
|
|
126
|
+
style_card_action: remove
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
```yaml
|
|
130
|
+
- id: row_actions
|
|
131
|
+
type: ClickableHtml
|
|
132
|
+
properties:
|
|
133
|
+
dataEvents:
|
|
134
|
+
- onEdit
|
|
135
|
+
- onDuplicate
|
|
136
|
+
- name: onDelete
|
|
137
|
+
confirm: Delete invoice INV-042?
|
|
138
|
+
html: '<p>Invoice INV-042 <i data-icon="edit" data-event="onEdit" data-id="42"
|
|
139
|
+
data-tooltip="Edit" style="cursor: pointer"></i> <span data-popover="more"
|
|
140
|
+
style="cursor: pointer"><i data-icon="more-vertical"></i></span></p><div
|
|
141
|
+
data-popover-content="more" hidden><p data-event="onDuplicate"
|
|
142
|
+
data-id="42" style="cursor: pointer; margin: 0 0 8px"><i
|
|
143
|
+
data-icon="copy"></i> Duplicate</p><p data-event="onDelete" data-id="42"
|
|
144
|
+
style="cursor: pointer; margin: 0; color: var(--ant-color-error)"><i
|
|
145
|
+
data-icon="delete"></i> Delete</p></div>'
|
|
146
|
+
events:
|
|
147
|
+
onEdit:
|
|
148
|
+
- id: set_edit
|
|
149
|
+
type: SetState
|
|
150
|
+
params:
|
|
151
|
+
row_actions_last:
|
|
152
|
+
_string.concat:
|
|
153
|
+
- "edit "
|
|
154
|
+
- _event: id
|
|
155
|
+
onDuplicate:
|
|
156
|
+
- id: set_duplicate
|
|
157
|
+
type: SetState
|
|
158
|
+
params:
|
|
159
|
+
row_actions_last:
|
|
160
|
+
_string.concat:
|
|
161
|
+
- "duplicate "
|
|
162
|
+
- _event: id
|
|
163
|
+
onDelete:
|
|
164
|
+
- id: set_delete
|
|
165
|
+
type: SetState
|
|
166
|
+
params:
|
|
167
|
+
row_actions_last:
|
|
168
|
+
_string.concat:
|
|
169
|
+
- "delete "
|
|
170
|
+
- _event: id
|
|
171
|
+
- id: row_actions_result
|
|
172
|
+
type: Html
|
|
173
|
+
properties:
|
|
174
|
+
html:
|
|
175
|
+
_string.concat:
|
|
176
|
+
- "<p>Last action: <code>"
|
|
177
|
+
- _state:
|
|
178
|
+
key: row_actions_last
|
|
179
|
+
default: none yet
|
|
180
|
+
- </code></p>
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
```yaml
|
|
184
|
+
- id: confirm_actions
|
|
185
|
+
type: ClickableHtml
|
|
186
|
+
properties:
|
|
187
|
+
dataEvents:
|
|
188
|
+
- name: onDelete
|
|
189
|
+
confirm: true
|
|
190
|
+
- onArchive
|
|
191
|
+
html: '<p>INV-2026-0042 <i data-icon="delete" data-event="onDelete" data-id="42"
|
|
192
|
+
data-tooltip="Delete" data-confirm="Delete invoice INV-2026-0042?"
|
|
193
|
+
style="cursor: pointer; color: var(--ant-color-error)"></i> <span
|
|
194
|
+
data-event="onArchive" data-id="42" data-confirm style="cursor: pointer;
|
|
195
|
+
color: var(--ant-color-primary)">Archive</span></p>'
|
|
196
|
+
events:
|
|
197
|
+
onDelete:
|
|
198
|
+
- id: deleted
|
|
199
|
+
type: SetState
|
|
200
|
+
params:
|
|
201
|
+
confirm_last:
|
|
202
|
+
_string.concat:
|
|
203
|
+
- "deleted "
|
|
204
|
+
- _event: id
|
|
205
|
+
onArchive:
|
|
206
|
+
- id: archived
|
|
207
|
+
type: SetState
|
|
208
|
+
params:
|
|
209
|
+
confirm_last:
|
|
210
|
+
_string.concat:
|
|
211
|
+
- "archived "
|
|
212
|
+
- _event: id
|
|
213
|
+
- id: confirm_result
|
|
214
|
+
type: Html
|
|
215
|
+
properties:
|
|
216
|
+
html:
|
|
217
|
+
_string.concat:
|
|
218
|
+
- "<p>Last action: <code>"
|
|
219
|
+
- _state:
|
|
220
|
+
key: confirm_last
|
|
221
|
+
default: none yet
|
|
222
|
+
- </code></p>
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
| Property | Type | Default | Description |
|
|
226
|
+
| --- | --- | --- | --- |
|
|
227
|
+
| `dataEvents` | array | - | The events the HTML may fire. A data-event whose name is not listed does nothing, and a click on it logs a console warning; with no dataEvents the HTML fires no events. List an event by name, or as { name, confirm } to make every click on it ask first. |
|
|
228
|
+
| `html` | string | - | Content to be rendered as Html. An element with a data-event attribute fires the event it names when clicked (data-event="onEditClick" fires events.onEditClick), if dataEvents lists it, and its default browser action is prevented. The event object holds the element's other data-* attributes with snake_case keys, so data-event="onEditClick" data-record-id="42" gives { record_id: "42" }. Targets that are not links or buttons become keyboard focusable, and Enter or Space clicks them. A data-event inside popover content fires too, then closes the popover. A link with data-event fires the event and does not navigate. data-confirm="Delete this row?" on a data-event element asks first: only OK fires the event (bare data-confirm asks "Are you sure?"). Escape user and request data in the HTML, so it cannot add data-event elements of its own. All Html block attributes work too: data-icon, data-tooltip, data-popover, data-page-id links, data-new-tab, data-tag, data-status, data-time, data-format, data-avatar, data-copy, data-truncate and data-tone. See the HTML attributes docs page. |
|
|
229
|
+
|
|
230
|
+
| Event | Event Data | Description |
|
|
231
|
+
| --- | --- | --- |
|
|
232
|
+
| `onTextSelection` | \- | Trigger action when text is selected and pass selected text to the event object. |
|
|
233
|
+
|
|
234
|
+
| Key | Target |
|
|
235
|
+
| --- | --- |
|
|
236
|
+
| `/block` | Outer block wrapper (always available). |
|
|
237
|
+
| `/element` | The Html element. |
|
|
238
|
+
|
|
239
|
+
No slots defined.
|
|
@@ -301,7 +301,7 @@ Render raw HTML content without sanitization.
|
|
|
301
301
|
|
|
302
302
|
| Property | Type | Default | Description |
|
|
303
303
|
| --- | --- | --- | --- |
|
|
304
|
-
| `html` | string | - | Content to be rendered as Html. |
|
|
304
|
+
| `html` | string | - | Content to be rendered as Html. The Html block attributes (data-icon, data-tooltip, data-popover, data-page-id links, data-new-tab, data-tag, data-status, data-time, data-format, data-avatar, data-copy, data-truncate, data-tone) work here too, unless DOMPurifyOptions removes data attributes. |
|
|
305
305
|
| `DOMPurifyOptions` | object | - | Customize DOMPurify options. Options are only applied when the block is mounted, thus any parsed settings is only applied at first render. |
|
|
306
306
|
|
|
307
307
|
No events defined.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# DiffList
|
|
2
2
|
|
|
3
|
-
`DiffList` renders a polished, user-friendly diff between a `before` and an `after` object as a grouped table of changes. Built on `microdiff` for the diff engine and antd primitives for rendering, it groups changes by top-level key, tags each row as Added / Removed / Changed, and supports per-path value formatters (`date`, `datetime`, `boolean`, `currency`, `enum`, `json`, `code`), humanised `labels`, and `hide` / `show` glob filtering. All colours come from antd
|
|
3
|
+
`DiffList` renders a polished, user-friendly diff between a `before` and an `after` object as a grouped table of changes. Built on `microdiff` for the diff engine and antd primitives for rendering, it groups changes by top-level key, tags each row as Added / Removed / Changed, and supports per-path value formatters (`date`, `datetime`, `boolean`, `currency`, `enum`, `json`, `code`), humanised `labels`, and `hide` / `show` glob filtering. All colours come from antd's semantic tokens so dark mode and `theme` overrides work automatically.
|
|
4
4
|
|
|
5
5
|
```yaml
|
|
6
6
|
- id: diff_list_profile
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# DiffTimeline
|
|
2
2
|
|
|
3
|
-
`DiffTimeline` renders a diff as a vertical audit trail using Ant Design
|
|
3
|
+
`DiffTimeline` renders a diff as a vertical audit trail using Ant Design's `Timeline` component. Each change becomes a timeline entry with a colour-coded dot (green for added, red for removed, blue for changed) and a breadcrumb-style label that shows the full path to the changed field. Uses the same filtering, labelling, and per-path value formatters as `DiffList`.
|
|
4
4
|
|
|
5
5
|
```yaml
|
|
6
6
|
- id: diff_timeline_order
|
|
@@ -103,6 +103,63 @@ Profile
|
|
|
103
103
|
titlePlacement: start
|
|
104
104
|
```
|
|
105
105
|
|
|
106
|
+
```yaml
|
|
107
|
+
- id: variant_solid
|
|
108
|
+
type: Divider
|
|
109
|
+
properties:
|
|
110
|
+
title: Solid
|
|
111
|
+
variant: solid
|
|
112
|
+
- id: variant_dashed
|
|
113
|
+
type: Divider
|
|
114
|
+
properties:
|
|
115
|
+
title: Dashed
|
|
116
|
+
variant: dashed
|
|
117
|
+
- id: variant_dotted
|
|
118
|
+
type: Divider
|
|
119
|
+
properties:
|
|
120
|
+
title: Dotted
|
|
121
|
+
variant: dotted
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
Small divider below.
|
|
125
|
+
|
|
126
|
+
Medium divider below.
|
|
127
|
+
|
|
128
|
+
Large (default) divider below.
|
|
129
|
+
|
|
130
|
+
End of the size examples.
|
|
131
|
+
|
|
132
|
+
```yaml
|
|
133
|
+
- id: size_small_text
|
|
134
|
+
type: Paragraph
|
|
135
|
+
properties:
|
|
136
|
+
content: Small divider below.
|
|
137
|
+
- id: size_small
|
|
138
|
+
type: Divider
|
|
139
|
+
properties:
|
|
140
|
+
size: small
|
|
141
|
+
- id: size_medium_text
|
|
142
|
+
type: Paragraph
|
|
143
|
+
properties:
|
|
144
|
+
content: Medium divider below.
|
|
145
|
+
- id: size_medium
|
|
146
|
+
type: Divider
|
|
147
|
+
properties:
|
|
148
|
+
size: medium
|
|
149
|
+
- id: size_large_text
|
|
150
|
+
type: Paragraph
|
|
151
|
+
properties:
|
|
152
|
+
content: Large (default) divider below.
|
|
153
|
+
- id: size_large
|
|
154
|
+
type: Divider
|
|
155
|
+
properties:
|
|
156
|
+
size: large
|
|
157
|
+
- id: size_end_text
|
|
158
|
+
type: Paragraph
|
|
159
|
+
properties:
|
|
160
|
+
content: End of the size examples.
|
|
161
|
+
```
|
|
162
|
+
|
|
106
163
|
```yaml
|
|
107
164
|
- id: plain_center
|
|
108
165
|
type: Divider
|
|
@@ -261,7 +318,7 @@ Item B
|
|
|
261
318
|
title: Delete Account
|
|
262
319
|
color: danger
|
|
263
320
|
variant: outlined
|
|
264
|
-
icon:
|
|
321
|
+
icon: delete
|
|
265
322
|
events:
|
|
266
323
|
onClick:
|
|
267
324
|
- id: settings_delete_msg
|
|
@@ -374,7 +431,7 @@ Instead of writing repetitive UI code, developers describe what they want in YAM
|
|
|
374
431
|
title: Share Article
|
|
375
432
|
color: primary
|
|
376
433
|
variant: outlined
|
|
377
|
-
icon:
|
|
434
|
+
icon: share
|
|
378
435
|
events:
|
|
379
436
|
onClick:
|
|
380
437
|
- id: article_share_msg
|
|
@@ -386,11 +443,13 @@ Instead of writing repetitive UI code, developers describe what they want in YAM
|
|
|
386
443
|
|
|
387
444
|
| Property | Type | Default | Description |
|
|
388
445
|
| --- | --- | --- | --- |
|
|
389
|
-
| `dashed` | boolean | `false` | Whether line is dashed. |
|
|
446
|
+
| `dashed` | boolean | `false` | Whether line is dashed. Same as `variant: dashed`. |
|
|
390
447
|
| `orientation` | string | `"horizontal"` | Direction of the divider line. Enum: `horizontal`, `vertical`. |
|
|
391
448
|
| `title` | string | - | Divider title - supports html. |
|
|
392
449
|
| `titlePlacement` | string | `"center"` | Position of title text within the divider. Enum: `start`, `end`, `center`. |
|
|
393
450
|
| `plain` | boolean | `false` | Show text as plain style. |
|
|
451
|
+
| `size` | string | `"large"` | Vertical margin around a horizontal divider. Enum: `small`, `medium`, `large`. |
|
|
452
|
+
| `variant` | string | `"solid"` | Line style of the divider. Enum: `solid`, `dashed`, `dotted`. |
|
|
394
453
|
| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design divider tokens](https://ant.design/components/divider#design-token). |
|
|
395
454
|
| `theme.textPaddingInline` | string | `"1em"` | Horizontal padding of text content in the divider. |
|
|
396
455
|
| `theme.orientationMargin` | number | `0.05` | Distance between text and edge when orientation is left or right. Value between 0 and 1 representing a percentage. |
|
|
@@ -402,5 +461,7 @@ No events defined.
|
|
|
402
461
|
| --- | --- |
|
|
403
462
|
| `/block` | Outer block wrapper (always available). |
|
|
404
463
|
| `/element` | The Divider element. |
|
|
464
|
+
| `/rail` | The Divider line. |
|
|
465
|
+
| `/title` | The Divider title text. |
|
|
405
466
|
|
|
406
467
|
No slots defined.
|