@dereekb/dbx-web 13.9.0 → 13.10.1
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/fesm2022/dereekb-dbx-web-calendar.mjs +11 -11
- package/fesm2022/dereekb-dbx-web-calendar.mjs.map +1 -1
- package/fesm2022/dereekb-dbx-web-mapbox.mjs +53 -55
- package/fesm2022/dereekb-dbx-web-mapbox.mjs.map +1 -1
- package/fesm2022/dereekb-dbx-web-table.mjs +78 -78
- package/fesm2022/dereekb-dbx-web-table.mjs.map +1 -1
- package/fesm2022/dereekb-dbx-web.mjs +1525 -1088
- package/fesm2022/dereekb-dbx-web.mjs.map +1 -1
- package/package.json +23 -22
- package/types/dereekb-dbx-web.d.ts +651 -211
|
@@ -47,6 +47,15 @@ type LoadingComponentState = 'none' | 'loading' | 'content' | 'error';
|
|
|
47
47
|
* Prefer using {@link DbxLoadingComponent} (`<dbx-loading>`) which wraps this component with
|
|
48
48
|
* support for {@link LoadingContext} streams.
|
|
49
49
|
*
|
|
50
|
+
* @dbxWebComponent
|
|
51
|
+
* @dbxWebSlug basic-loading
|
|
52
|
+
* @dbxWebCategory feedback
|
|
53
|
+
* @dbxWebRelated loading, loading-progress, error
|
|
54
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
55
|
+
* @dbxWebMinimalExample ```html
|
|
56
|
+
* <dbx-basic-loading [loading]="true"><p>Content</p></dbx-basic-loading>
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
50
59
|
* @example
|
|
51
60
|
* ```html
|
|
52
61
|
* <dbx-basic-loading [loading]="true" color="accent" text="Loading data...">
|
|
@@ -85,13 +94,18 @@ declare const DEFAULT_LOADING_PROGRESS_DIAMETER = 96;
|
|
|
85
94
|
* Supports both linear (bar) and circular (spinner) modes with configurable
|
|
86
95
|
* diameter, color, and optional hint text below the indicator.
|
|
87
96
|
*
|
|
88
|
-
* @
|
|
89
|
-
*
|
|
90
|
-
*
|
|
97
|
+
* @dbxWebComponent
|
|
98
|
+
* @dbxWebSlug loading-progress
|
|
99
|
+
* @dbxWebCategory feedback
|
|
100
|
+
* @dbxWebRelated loading, basic-loading
|
|
101
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
102
|
+
* @dbxWebMinimalExample ```html
|
|
91
103
|
* <dbx-loading-progress></dbx-loading-progress>
|
|
104
|
+
* ```
|
|
92
105
|
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
106
|
+
* @example
|
|
107
|
+
* ```html
|
|
108
|
+
* <dbx-loading-progress mode="bar"></dbx-loading-progress>
|
|
95
109
|
* ```
|
|
96
110
|
*/
|
|
97
111
|
declare class DbxLoadingProgressComponent {
|
|
@@ -138,19 +152,19 @@ interface DbxLoadingComponentState {
|
|
|
138
152
|
* track loading and error state from reactive streams. Also supports manual `loading`
|
|
139
153
|
* and `error` inputs for simpler use cases.
|
|
140
154
|
*
|
|
155
|
+
* @dbxWebComponent
|
|
156
|
+
* @dbxWebSlug loading
|
|
157
|
+
* @dbxWebCategory feedback
|
|
158
|
+
* @dbxWebRelated basic-loading, loading-progress, error
|
|
159
|
+
* @dbxWebSkillRefs dbx__ref__dbx-component-patterns
|
|
160
|
+
* @dbxWebMinimalExample ```html
|
|
161
|
+
* <dbx-loading [state]="state$ | async">Body</dbx-loading>
|
|
162
|
+
* ```
|
|
163
|
+
*
|
|
141
164
|
* @example
|
|
142
165
|
* ```html
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
* <p>Data loaded successfully.</p>
|
|
146
|
-
* </dbx-loading>
|
|
147
|
-
*
|
|
148
|
-
* <!-- With manual loading/error inputs -->
|
|
149
|
-
* <dbx-loading [loading]="isLoading" [error]="loadError" linear [padding]="true">
|
|
150
|
-
* <p>Content here.</p>
|
|
151
|
-
* <ng-container error>
|
|
152
|
-
* <p>Custom error message.</p>
|
|
153
|
-
* </ng-container>
|
|
166
|
+
* <dbx-loading [state]="state$ | async" text="Loading items...">
|
|
167
|
+
* <dbx-list [state$]="state$" [config]="listConfig"></dbx-list>
|
|
154
168
|
* </dbx-loading>
|
|
155
169
|
* ```
|
|
156
170
|
*/
|
|
@@ -190,10 +204,19 @@ declare class DbxLoadingComponent {
|
|
|
190
204
|
* Apply to a `<dbx-loading>` element that is within an action context to automatically
|
|
191
205
|
* reflect the action's loading state in the loading component.
|
|
192
206
|
*
|
|
207
|
+
* @dbxWebComponent
|
|
208
|
+
* @dbxWebSlug action-loading-context
|
|
209
|
+
* @dbxWebCategory action
|
|
210
|
+
* @dbxWebRelated loading, action-snackbar
|
|
211
|
+
* @dbxWebSkillRefs dbx__ref__dbx-component-patterns
|
|
212
|
+
* @dbxWebMinimalExample ```html
|
|
213
|
+
* <button [dbxActionLoadingContext]></button>
|
|
214
|
+
* ```
|
|
215
|
+
*
|
|
193
216
|
* @example
|
|
194
217
|
* ```html
|
|
195
|
-
* <dbx-loading
|
|
196
|
-
* <
|
|
218
|
+
* <dbx-loading [state]="ctx.state$ | async">
|
|
219
|
+
* <button [dbxAction]="saveAction" dbxActionLoadingContext>Save</button>
|
|
197
220
|
* </dbx-loading>
|
|
198
221
|
* ```
|
|
199
222
|
*/
|
|
@@ -484,18 +507,18 @@ declare const DBX_ACTION_SNACKBAR_DEFAULTS: DbxActionSnackbarEventMakeConfig;
|
|
|
484
507
|
* (loading, success, error). Supports built-in message presets via `dbxActionSnackbarDefault` and
|
|
485
508
|
* custom generator functions via the `dbxActionSnackbar` input.
|
|
486
509
|
*
|
|
487
|
-
* @
|
|
488
|
-
*
|
|
489
|
-
*
|
|
490
|
-
*
|
|
491
|
-
*
|
|
510
|
+
* @dbxWebComponent
|
|
511
|
+
* @dbxWebSlug action-snackbar
|
|
512
|
+
* @dbxWebCategory action
|
|
513
|
+
* @dbxWebRelated action-snackbar-error, action-confirm, error-snackbar
|
|
514
|
+
* @dbxWebSkillRefs dbx__ref__dbx-component-patterns
|
|
515
|
+
* @dbxWebMinimalExample ```html
|
|
516
|
+
* <div [dbxActionSnackbar]="fn"></div>
|
|
492
517
|
* ```
|
|
493
518
|
*
|
|
494
519
|
* @example
|
|
495
520
|
* ```html
|
|
496
|
-
* <
|
|
497
|
-
* <!-- Custom snackbar with undo support -->
|
|
498
|
-
* </div>
|
|
521
|
+
* <button [dbxAction]="saveAction" [dbxActionSnackbar]="snackbarFn">Save</button>
|
|
499
522
|
* ```
|
|
500
523
|
*/
|
|
501
524
|
declare class DbxActionSnackbarDirective<T = unknown, O = unknown> implements OnInit {
|
|
@@ -548,11 +571,18 @@ interface DbxPromptConfirmConfig {
|
|
|
548
571
|
/**
|
|
549
572
|
* Renders a confirmation prompt with customizable title, message, confirm, and cancel buttons.
|
|
550
573
|
*
|
|
574
|
+
* @dbxWebComponent
|
|
575
|
+
* @dbxWebSlug prompt-confirm
|
|
576
|
+
* @dbxWebCategory overlay
|
|
577
|
+
* @dbxWebRelated prompt, action-confirm
|
|
578
|
+
* @dbxWebSkillRefs dbx__ref__dbx-app-structure
|
|
579
|
+
* @dbxWebMinimalExample ```html
|
|
580
|
+
* <dbx-prompt-confirm [config]="cfg"></dbx-prompt-confirm>
|
|
581
|
+
* ```
|
|
582
|
+
*
|
|
551
583
|
* @example
|
|
552
584
|
* ```html
|
|
553
|
-
* <dbx-prompt-confirm [config]="{
|
|
554
|
-
* <p>Additional content here.</p>
|
|
555
|
-
* </dbx-prompt-confirm>
|
|
585
|
+
* <dbx-prompt-confirm [config]="{ header: 'Delete?', confirmText: 'Delete', cancelText: 'Cancel' }"></dbx-prompt-confirm>
|
|
556
586
|
* ```
|
|
557
587
|
*/
|
|
558
588
|
declare class DbxPromptConfirmComponent {
|
|
@@ -604,18 +634,18 @@ type DbxActionTransitionSafetyType = 'none' | 'dialog' | 'auto';
|
|
|
604
634
|
*
|
|
605
635
|
* NOTE: This directive only works with UI-Router (not Angular Router).
|
|
606
636
|
*
|
|
607
|
-
* @
|
|
608
|
-
*
|
|
609
|
-
*
|
|
610
|
-
*
|
|
611
|
-
*
|
|
637
|
+
* @dbxWebComponent
|
|
638
|
+
* @dbxWebSlug action-transition-safety
|
|
639
|
+
* @dbxWebCategory action
|
|
640
|
+
* @dbxWebRelated action-confirm
|
|
641
|
+
* @dbxWebSkillRefs dbx__ref__dbx-component-patterns
|
|
642
|
+
* @dbxWebMinimalExample ```html
|
|
643
|
+
* <form [dbxActionTransitionSafety]></form>
|
|
612
644
|
* ```
|
|
613
645
|
*
|
|
614
646
|
* @example
|
|
615
647
|
* ```html
|
|
616
|
-
* <form [dbxAction]="
|
|
617
|
-
* <!-- Auto-triggers save on navigation if possible, otherwise shows dialog -->
|
|
618
|
-
* </form>
|
|
648
|
+
* <form [dbxAction]="formAction" dbxActionTransitionSafety>...</form>
|
|
619
649
|
* ```
|
|
620
650
|
*/
|
|
621
651
|
declare class DbxActionTransitionSafetyDirective<T, O> implements OnInit, OnDestroy {
|
|
@@ -708,11 +738,18 @@ interface DbxActionConfirmConfig<T = unknown> extends DbxPromptConfirmConfig {
|
|
|
708
738
|
* This directive works with action triggering only, not button clicks.
|
|
709
739
|
* For button-based confirmation, use an appPromptConfirmButton directive instead.
|
|
710
740
|
*
|
|
741
|
+
* @dbxWebComponent
|
|
742
|
+
* @dbxWebSlug action-confirm
|
|
743
|
+
* @dbxWebCategory action
|
|
744
|
+
* @dbxWebRelated action-snackbar, prompt-confirm
|
|
745
|
+
* @dbxWebSkillRefs dbx__ref__dbx-component-patterns
|
|
746
|
+
* @dbxWebMinimalExample ```html
|
|
747
|
+
* <div [dbxActionConfirm]="cfg"></div>
|
|
748
|
+
* ```
|
|
749
|
+
*
|
|
711
750
|
* @example
|
|
712
751
|
* ```html
|
|
713
|
-
* <
|
|
714
|
-
* ...
|
|
715
|
-
* </form>
|
|
752
|
+
* <button [dbxAction]="deleteAction" [dbxActionConfirm]="{ header: 'Delete account?', confirmText: 'Delete' }">Delete</button>
|
|
716
753
|
* ```
|
|
717
754
|
*/
|
|
718
755
|
declare class DbxActionConfirmDirective<T = unknown, O = unknown> extends AbstractPromptConfirmDirective {
|
|
@@ -733,18 +770,18 @@ declare class DbxActionConfirmDirective<T = unknown, O = unknown> extends Abstra
|
|
|
733
770
|
* Triggers the parent action context when a specific keyboard key is released.
|
|
734
771
|
* Defaults to the "enter" key. Key names should be lowercase.
|
|
735
772
|
*
|
|
736
|
-
* @
|
|
737
|
-
*
|
|
738
|
-
*
|
|
739
|
-
*
|
|
740
|
-
*
|
|
773
|
+
* @dbxWebComponent
|
|
774
|
+
* @dbxWebSlug action-key-trigger
|
|
775
|
+
* @dbxWebCategory action
|
|
776
|
+
* @dbxWebRelated action-confirm, action-snackbar
|
|
777
|
+
* @dbxWebSkillRefs dbx__ref__dbx-component-patterns
|
|
778
|
+
* @dbxWebMinimalExample ```html
|
|
779
|
+
* <div [dbxActionKeyTrigger]="'enter'"></div>
|
|
741
780
|
* ```
|
|
742
781
|
*
|
|
743
782
|
* @example
|
|
744
783
|
* ```html
|
|
745
|
-
* <
|
|
746
|
-
* <!-- Pressing Escape triggers the action -->
|
|
747
|
-
* </div>
|
|
784
|
+
* <form [dbxAction]="saveAction" [dbxActionKeyTrigger]="'cmd+s'">...</form>
|
|
748
785
|
* ```
|
|
749
786
|
*/
|
|
750
787
|
declare class DbxActionKeyTriggerDirective<T = unknown, O = unknown> {
|
|
@@ -769,18 +806,18 @@ declare class DbxActionModule {
|
|
|
769
806
|
* Lightweight button that renders as either an icon-only Material icon button or a text button
|
|
770
807
|
* with an icon prefix, depending on whether text is provided.
|
|
771
808
|
*
|
|
772
|
-
* @
|
|
773
|
-
*
|
|
774
|
-
*
|
|
775
|
-
*
|
|
776
|
-
* @
|
|
777
|
-
* ```html
|
|
778
|
-
* <dbx-icon-button icon="
|
|
809
|
+
* @dbxWebComponent
|
|
810
|
+
* @dbxWebSlug icon-button
|
|
811
|
+
* @dbxWebCategory button
|
|
812
|
+
* @dbxWebRelated button
|
|
813
|
+
* @dbxWebSkillRefs dbx__migration__migrate-dbx-icon-button
|
|
814
|
+
* @dbxWebMinimalExample ```html
|
|
815
|
+
* <dbx-icon-button icon="add"></dbx-icon-button>
|
|
779
816
|
* ```
|
|
780
817
|
*
|
|
781
818
|
* @example
|
|
782
819
|
* ```html
|
|
783
|
-
* <dbx-icon-button icon="
|
|
820
|
+
* <dbx-icon-button icon="delete" color="warn" [dbxAction]="deleteAction"></dbx-icon-button>
|
|
784
821
|
* ```
|
|
785
822
|
*/
|
|
786
823
|
declare class DbxIconButtonComponent extends AbstractDbxButtonDirective {
|
|
@@ -1198,10 +1235,21 @@ declare class DbxAvatarComponent {
|
|
|
1198
1235
|
/**
|
|
1199
1236
|
* Renders a horizontal bar with a themed background color, used to visually group or separate content.
|
|
1200
1237
|
*
|
|
1238
|
+
* @dbxWebComponent
|
|
1239
|
+
* @dbxWebSlug bar
|
|
1240
|
+
* @dbxWebCategory layout
|
|
1241
|
+
* @dbxWebRelated bar-header, pagebar, button-spacer
|
|
1242
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
1243
|
+
* @dbxWebMinimalExample ```html
|
|
1244
|
+
* <dbx-bar><button>A</button><button>B</button></dbx-bar>
|
|
1245
|
+
* ```
|
|
1246
|
+
*
|
|
1201
1247
|
* @example
|
|
1202
1248
|
* ```html
|
|
1203
|
-
* <dbx-bar
|
|
1204
|
-
* <
|
|
1249
|
+
* <dbx-bar>
|
|
1250
|
+
* <dbx-button text="Save" raised color="primary"></dbx-button>
|
|
1251
|
+
* <dbx-button-spacer></dbx-button-spacer>
|
|
1252
|
+
* <dbx-button text="Cancel" stroked></dbx-button>
|
|
1205
1253
|
* </dbx-bar>
|
|
1206
1254
|
* ```
|
|
1207
1255
|
*/
|
|
@@ -1215,9 +1263,20 @@ declare class DbxBarDirective {
|
|
|
1215
1263
|
/**
|
|
1216
1264
|
* A themed header bar displaying an optional icon and text label, useful as a section divider.
|
|
1217
1265
|
*
|
|
1266
|
+
* @dbxWebComponent
|
|
1267
|
+
* @dbxWebSlug bar-header
|
|
1268
|
+
* @dbxWebCategory layout
|
|
1269
|
+
* @dbxWebRelated bar, pagebar
|
|
1270
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
1271
|
+
* @dbxWebMinimalExample ```html
|
|
1272
|
+
* <dbx-bar-header header="Title"></dbx-bar-header>
|
|
1273
|
+
* ```
|
|
1274
|
+
*
|
|
1218
1275
|
* @example
|
|
1219
1276
|
* ```html
|
|
1220
|
-
* <dbx-bar-header
|
|
1277
|
+
* <dbx-bar-header header="Members" icon="group">
|
|
1278
|
+
* <button mat-icon-button><mat-icon>add</mat-icon></button>
|
|
1279
|
+
* </dbx-bar-header>
|
|
1221
1280
|
* ```
|
|
1222
1281
|
*/
|
|
1223
1282
|
declare class DbxBarHeaderComponent {
|
|
@@ -1231,11 +1290,21 @@ declare class DbxBarHeaderComponent {
|
|
|
1231
1290
|
/**
|
|
1232
1291
|
* A page-level toolbar with left and right content slots, built on Angular Material's mat-toolbar.
|
|
1233
1292
|
*
|
|
1293
|
+
* @dbxWebComponent
|
|
1294
|
+
* @dbxWebSlug pagebar
|
|
1295
|
+
* @dbxWebCategory layout
|
|
1296
|
+
* @dbxWebRelated bar, navbar
|
|
1297
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks, dbx__ref__dbx-app-structure
|
|
1298
|
+
* @dbxWebMinimalExample ```html
|
|
1299
|
+
* <dbx-pagebar>Title</dbx-pagebar>
|
|
1300
|
+
* ```
|
|
1301
|
+
*
|
|
1234
1302
|
* @example
|
|
1235
1303
|
* ```html
|
|
1236
|
-
* <dbx-pagebar
|
|
1237
|
-
* <
|
|
1238
|
-
* <
|
|
1304
|
+
* <dbx-pagebar>
|
|
1305
|
+
* <h2>Settings</h2>
|
|
1306
|
+
* <span class="spacer"></span>
|
|
1307
|
+
* <button mat-stroked-button>Save</button>
|
|
1239
1308
|
* </dbx-pagebar>
|
|
1240
1309
|
* ```
|
|
1241
1310
|
*/
|
|
@@ -1317,6 +1386,15 @@ declare class DbxTwoBlockComponent {
|
|
|
1317
1386
|
*
|
|
1318
1387
|
* Supports a named content slot `[sectionHeader]` for custom header actions beside the title.
|
|
1319
1388
|
*
|
|
1389
|
+
* @dbxWebComponent
|
|
1390
|
+
* @dbxWebSlug card-box
|
|
1391
|
+
* @dbxWebCategory card
|
|
1392
|
+
* @dbxWebRelated card-box-container, section
|
|
1393
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
1394
|
+
* @dbxWebMinimalExample ```html
|
|
1395
|
+
* <dbx-card-box header="Title"><p>Body</p></dbx-card-box>
|
|
1396
|
+
* ```
|
|
1397
|
+
*
|
|
1320
1398
|
* @example
|
|
1321
1399
|
* ```html
|
|
1322
1400
|
* <dbx-card-box [header]="'Settings'" [icon]="'settings'">
|
|
@@ -1337,18 +1415,21 @@ declare class DbxCardBoxComponent {
|
|
|
1337
1415
|
*
|
|
1338
1416
|
* Can be used as an element or as an attribute directive on any host element.
|
|
1339
1417
|
*
|
|
1340
|
-
* @
|
|
1341
|
-
*
|
|
1342
|
-
*
|
|
1343
|
-
*
|
|
1344
|
-
*
|
|
1418
|
+
* @dbxWebComponent
|
|
1419
|
+
* @dbxWebSlug card-box-container
|
|
1420
|
+
* @dbxWebCategory card
|
|
1421
|
+
* @dbxWebRelated card-box
|
|
1422
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
1423
|
+
* @dbxWebMinimalExample ```html
|
|
1424
|
+
* <div dbxCardBoxContainer><dbx-card-box></dbx-card-box></div>
|
|
1345
1425
|
* ```
|
|
1346
1426
|
*
|
|
1347
1427
|
* @example
|
|
1348
1428
|
* ```html
|
|
1349
|
-
* <
|
|
1350
|
-
* <
|
|
1351
|
-
*
|
|
1429
|
+
* <dbx-card-box-container>
|
|
1430
|
+
* <dbx-card-box header="One"></dbx-card-box>
|
|
1431
|
+
* <dbx-card-box header="Two"></dbx-card-box>
|
|
1432
|
+
* </dbx-card-box-container>
|
|
1352
1433
|
* ```
|
|
1353
1434
|
*/
|
|
1354
1435
|
declare class DbxCardBoxContainerDirective {
|
|
@@ -1595,11 +1676,25 @@ interface DbxTwoColumnViewState {
|
|
|
1595
1676
|
*
|
|
1596
1677
|
* Requires a {@link TwoColumnsContextStore} to be provided by a parent component or directive.
|
|
1597
1678
|
*
|
|
1679
|
+
* @dbxWebComponent
|
|
1680
|
+
* @dbxWebSlug two-column
|
|
1681
|
+
* @dbxWebCategory layout
|
|
1682
|
+
* @dbxWebRelated two-column-right
|
|
1683
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks, dbx__ref__dbx-app-structure
|
|
1684
|
+
* @dbxWebMinimalExample ```html
|
|
1685
|
+
* <dbx-two-column>
|
|
1686
|
+
* <div left>Sidebar</div>
|
|
1687
|
+
* <div right>Main</div>
|
|
1688
|
+
* </dbx-two-column>
|
|
1689
|
+
* ```
|
|
1690
|
+
*
|
|
1598
1691
|
* @example
|
|
1599
1692
|
* ```html
|
|
1600
|
-
* <dbx-two-column [
|
|
1601
|
-
* <
|
|
1602
|
-
* <
|
|
1693
|
+
* <dbx-two-column [inSectionPage]="true">
|
|
1694
|
+
* <dbx-list left [state$]="state$" [config]="listConfig" />
|
|
1695
|
+
* <dbx-two-column-right right header="Detail">
|
|
1696
|
+
* <p>Selected item detail.</p>
|
|
1697
|
+
* </dbx-two-column-right>
|
|
1603
1698
|
* </dbx-two-column>
|
|
1604
1699
|
* ```
|
|
1605
1700
|
*/
|
|
@@ -1730,13 +1825,20 @@ declare class DbxTwoColumnColumnHeadDirective {
|
|
|
1730
1825
|
* When this component is created, it automatically registers itself with the {@link TwoColumnsContextStore}
|
|
1731
1826
|
* to indicate that right-side content is present.
|
|
1732
1827
|
*
|
|
1828
|
+
* @dbxWebComponent
|
|
1829
|
+
* @dbxWebSlug two-column-right
|
|
1830
|
+
* @dbxWebCategory layout
|
|
1831
|
+
* @dbxWebRelated two-column
|
|
1832
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks, dbx__ref__dbx-app-structure
|
|
1833
|
+
* @dbxWebMinimalExample ```html
|
|
1834
|
+
* <dbx-two-column-right>Body</dbx-two-column-right>
|
|
1835
|
+
* ```
|
|
1836
|
+
*
|
|
1733
1837
|
* @example
|
|
1734
1838
|
* ```html
|
|
1735
|
-
* <dbx-two-column-right header="Detail
|
|
1736
|
-
* <
|
|
1737
|
-
*
|
|
1738
|
-
* </div>
|
|
1739
|
-
* <p>Right column content here</p>
|
|
1839
|
+
* <dbx-two-column-right header="Item Detail">
|
|
1840
|
+
* <button nav mat-icon-button><mat-icon>delete</mat-icon></button>
|
|
1841
|
+
* <p>Body content</p>
|
|
1740
1842
|
* </dbx-two-column-right>
|
|
1741
1843
|
* ```
|
|
1742
1844
|
*/
|
|
@@ -1991,15 +2093,20 @@ declare class DbxContentBorderDirective {
|
|
|
1991
2093
|
* Wraps content in a box container with optional elevation (card-like shadow) and wide layout.
|
|
1992
2094
|
* Both `elevate` and `wide` default to `true`.
|
|
1993
2095
|
*
|
|
2096
|
+
* @dbxWebComponent
|
|
2097
|
+
* @dbxWebSlug content-box
|
|
2098
|
+
* @dbxWebCategory layout
|
|
2099
|
+
* @dbxWebRelated content, content-elevate, content-pit
|
|
2100
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
2101
|
+
* @dbxWebMinimalExample ```html
|
|
2102
|
+
* <div dbxContentBox>Body</div>
|
|
2103
|
+
* ```
|
|
2104
|
+
*
|
|
1994
2105
|
* @example
|
|
1995
2106
|
* ```html
|
|
1996
2107
|
* <dbx-content-box>
|
|
1997
|
-
* <p>
|
|
2108
|
+
* <p>Summary content</p>
|
|
1998
2109
|
* </dbx-content-box>
|
|
1999
|
-
*
|
|
2000
|
-
* <div dbxContentBox [elevate]="false" [wide]="false">
|
|
2001
|
-
* <p>Flat, non-wide box content.</p>
|
|
2002
|
-
* </div>
|
|
2003
2110
|
* ```
|
|
2004
2111
|
*/
|
|
2005
2112
|
declare class DbxContentBoxDirective {
|
|
@@ -2012,14 +2119,19 @@ declare class DbxContentBoxDirective {
|
|
|
2012
2119
|
/**
|
|
2013
2120
|
* Sets the host element to fill the available page height. Use as a wrapper for page-level content blocks.
|
|
2014
2121
|
*
|
|
2122
|
+
* @dbxWebComponent
|
|
2123
|
+
* @dbxWebSlug content
|
|
2124
|
+
* @dbxWebCategory layout
|
|
2125
|
+
* @dbxWebRelated content-container, content-page, content-box
|
|
2126
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
2127
|
+
* @dbxWebMinimalExample ```html
|
|
2128
|
+
* <dbx-content>Body</dbx-content>
|
|
2129
|
+
* ```
|
|
2130
|
+
*
|
|
2015
2131
|
* @example
|
|
2016
2132
|
* ```html
|
|
2017
|
-
* <dbx-content>
|
|
2018
|
-
* <p>This content fills the page height.</p>
|
|
2019
|
-
* </dbx-content>
|
|
2020
|
-
*
|
|
2021
2133
|
* <div dbxContent>
|
|
2022
|
-
* <p>
|
|
2134
|
+
* <p>Standard content body</p>
|
|
2023
2135
|
* </div>
|
|
2024
2136
|
* ```
|
|
2025
2137
|
*/
|
|
@@ -2040,15 +2152,20 @@ type DbxContentContainerWidth = 'small' | 'medium' | 'large' | 'wide' | 'full';
|
|
|
2040
2152
|
* Constrains content to a maximum width with configurable padding. Useful for centering
|
|
2041
2153
|
* page content and maintaining readable line lengths.
|
|
2042
2154
|
*
|
|
2155
|
+
* @dbxWebComponent
|
|
2156
|
+
* @dbxWebSlug content-container
|
|
2157
|
+
* @dbxWebCategory layout
|
|
2158
|
+
* @dbxWebRelated content, content-page, content-box
|
|
2159
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
2160
|
+
* @dbxWebMinimalExample ```html
|
|
2161
|
+
* <div dbxContentContainer>Body</div>
|
|
2162
|
+
* ```
|
|
2163
|
+
*
|
|
2043
2164
|
* @example
|
|
2044
2165
|
* ```html
|
|
2045
|
-
* <dbx-content-container grow="
|
|
2046
|
-
* <p>
|
|
2166
|
+
* <dbx-content-container grow="full" padding="normal">
|
|
2167
|
+
* <p>Page body</p>
|
|
2047
2168
|
* </dbx-content-container>
|
|
2048
|
-
*
|
|
2049
|
-
* <div dbxContentContainer grow="full" padding="none" topPadding="small">
|
|
2050
|
-
* <p>Full-width content with top padding.</p>
|
|
2051
|
-
* </div>
|
|
2052
2169
|
* ```
|
|
2053
2170
|
*/
|
|
2054
2171
|
declare class DbxContentContainerDirective {
|
|
@@ -2064,15 +2181,18 @@ declare class DbxContentContainerDirective {
|
|
|
2064
2181
|
* Applies elevation (box-shadow) styling to the host element, giving it a raised card appearance.
|
|
2065
2182
|
* Elevation is enabled by default and can be toggled off.
|
|
2066
2183
|
*
|
|
2184
|
+
* @dbxWebComponent
|
|
2185
|
+
* @dbxWebSlug content-elevate
|
|
2186
|
+
* @dbxWebCategory layout
|
|
2187
|
+
* @dbxWebRelated content-box, content-pit
|
|
2188
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
2189
|
+
* @dbxWebMinimalExample ```html
|
|
2190
|
+
* <dbx-content-elevate>Body</dbx-content-elevate>
|
|
2191
|
+
* ```
|
|
2192
|
+
*
|
|
2067
2193
|
* @example
|
|
2068
2194
|
* ```html
|
|
2069
|
-
* <
|
|
2070
|
-
* <p>Elevated content with shadow.</p>
|
|
2071
|
-
* </dbx-content-elevate>
|
|
2072
|
-
*
|
|
2073
|
-
* <div dbxContentElevate [elevate]="false">
|
|
2074
|
-
* <p>Flat content, no elevation.</p>
|
|
2075
|
-
* </div>
|
|
2195
|
+
* <div dbxContentElevate>Highlighted block</div>
|
|
2076
2196
|
* ```
|
|
2077
2197
|
*/
|
|
2078
2198
|
declare class DbxContentElevateDirective {
|
|
@@ -2085,14 +2205,19 @@ declare class DbxContentElevateDirective {
|
|
|
2085
2205
|
* Sets the host element to fill the full page height with page-level content styling.
|
|
2086
2206
|
* Similar to `DbxContentDirective` but applies the `dbx-content-page` class for page-specific layout.
|
|
2087
2207
|
*
|
|
2208
|
+
* @dbxWebComponent
|
|
2209
|
+
* @dbxWebSlug content-page
|
|
2210
|
+
* @dbxWebCategory layout
|
|
2211
|
+
* @dbxWebRelated content-container, section-page
|
|
2212
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
2213
|
+
* @dbxWebMinimalExample ```html
|
|
2214
|
+
* <dbx-content-page>Page</dbx-content-page>
|
|
2215
|
+
* ```
|
|
2216
|
+
*
|
|
2088
2217
|
* @example
|
|
2089
2218
|
* ```html
|
|
2090
|
-
* <dbx-content-page>
|
|
2091
|
-
* <p>Full-page content layout.</p>
|
|
2092
|
-
* </dbx-content-page>
|
|
2093
|
-
*
|
|
2094
2219
|
* <div dbxContentPage>
|
|
2095
|
-
* <
|
|
2220
|
+
* <dbx-section-page header="Dashboard"><p>...</p></dbx-section-page>
|
|
2096
2221
|
* </div>
|
|
2097
2222
|
* ```
|
|
2098
2223
|
*/
|
|
@@ -2118,15 +2243,18 @@ type DbxContentPitScrollableHeightSetting = 'small' | 'medium' | 'large';
|
|
|
2118
2243
|
* Wraps content in a recessed "pit" container with optional scrollable overflow and rounded corners.
|
|
2119
2244
|
* Useful for displaying bounded content areas such as lists or previews with a constrained height.
|
|
2120
2245
|
*
|
|
2246
|
+
* @dbxWebComponent
|
|
2247
|
+
* @dbxWebSlug content-pit
|
|
2248
|
+
* @dbxWebCategory layout
|
|
2249
|
+
* @dbxWebRelated content-box, content-elevate
|
|
2250
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
2251
|
+
* @dbxWebMinimalExample ```html
|
|
2252
|
+
* <dbx-content-pit>Body</dbx-content-pit>
|
|
2253
|
+
* ```
|
|
2254
|
+
*
|
|
2121
2255
|
* @example
|
|
2122
2256
|
* ```html
|
|
2123
|
-
* <
|
|
2124
|
-
* <p>Scrollable pit with medium height and rounded corners.</p>
|
|
2125
|
-
* </dbx-content-pit>
|
|
2126
|
-
*
|
|
2127
|
-
* <div dbxContentPit scrollable="large">
|
|
2128
|
-
* <p>Large scrollable pit area.</p>
|
|
2129
|
-
* </div>
|
|
2257
|
+
* <div dbxContentPit>Inset block</div>
|
|
2130
2258
|
* ```
|
|
2131
2259
|
*/
|
|
2132
2260
|
declare class DbxContentPitDirective {
|
|
@@ -2252,11 +2380,20 @@ declare function compareScreenMediaWidthTypes(a: ScreenMediaWidthType, b: Screen
|
|
|
2252
2380
|
* that can be used to adjust styling. When `breakToColumn` is enabled, items will stack vertically
|
|
2253
2381
|
* on small screens.
|
|
2254
2382
|
*
|
|
2383
|
+
* @dbxWebComponent
|
|
2384
|
+
* @dbxWebSlug flex-group
|
|
2385
|
+
* @dbxWebCategory layout
|
|
2386
|
+
* @dbxWebRelated flex-size, bar
|
|
2387
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
2388
|
+
* @dbxWebMinimalExample ```html
|
|
2389
|
+
* <div dbxFlexGroup><div dbxFlexSize="1">A</div></div>
|
|
2390
|
+
* ```
|
|
2391
|
+
*
|
|
2255
2392
|
* @example
|
|
2256
2393
|
* ```html
|
|
2257
|
-
* <div dbxFlexGroup
|
|
2258
|
-
* <div
|
|
2259
|
-
* <div
|
|
2394
|
+
* <div dbxFlexGroup breakpoint="sm">
|
|
2395
|
+
* <div dbxFlexSize="2">Wide</div>
|
|
2396
|
+
* <div dbxFlexSize="1">Narrow</div>
|
|
2260
2397
|
* </div>
|
|
2261
2398
|
* ```
|
|
2262
2399
|
*/
|
|
@@ -2296,11 +2433,20 @@ type DbxFlexSize = 1 | 2 | 3 | 4 | 5 | 6;
|
|
|
2296
2433
|
* Applies a `dbx-flex-{size}` CSS class to the host element based on the given {@link DbxFlexSize} value.
|
|
2297
2434
|
* Use within a {@link DbxFlexGroupDirective} to control how much row width this element occupies.
|
|
2298
2435
|
*
|
|
2436
|
+
* @dbxWebComponent
|
|
2437
|
+
* @dbxWebSlug flex-size
|
|
2438
|
+
* @dbxWebCategory layout
|
|
2439
|
+
* @dbxWebRelated flex-group
|
|
2440
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
2441
|
+
* @dbxWebMinimalExample ```html
|
|
2442
|
+
* <div dbxFlexSize="1"></div>
|
|
2443
|
+
* ```
|
|
2444
|
+
*
|
|
2299
2445
|
* @example
|
|
2300
2446
|
* ```html
|
|
2301
2447
|
* <div dbxFlexGroup>
|
|
2302
|
-
* <div
|
|
2303
|
-
* <div
|
|
2448
|
+
* <div dbxFlexSize="2">Twice as wide</div>
|
|
2449
|
+
* <div dbxFlexSize="1">Narrow</div>
|
|
2304
2450
|
* </div>
|
|
2305
2451
|
* ```
|
|
2306
2452
|
*/
|
|
@@ -2787,9 +2933,18 @@ declare class DbxValueListViewContentComponent<T, I extends DbxValueListItem<T>
|
|
|
2787
2933
|
/**
|
|
2788
2934
|
* Renders a value-based list view using a configuration input. Must be used within a parent {@link DbxListView} context.
|
|
2789
2935
|
*
|
|
2936
|
+
* @dbxWebComponent
|
|
2937
|
+
* @dbxWebSlug list-view
|
|
2938
|
+
* @dbxWebCategory list
|
|
2939
|
+
* @dbxWebRelated list, selection-list-view, list-grid-view, list-accordion-view
|
|
2940
|
+
* @dbxWebSkillRefs dbx__ref__dbx-component-patterns
|
|
2941
|
+
* @dbxWebMinimalExample ```html
|
|
2942
|
+
* <dbx-list-view [config]="rowConfig"></dbx-list-view>
|
|
2943
|
+
* ```
|
|
2944
|
+
*
|
|
2790
2945
|
* @example
|
|
2791
2946
|
* ```html
|
|
2792
|
-
* <dbx-list-view [config]="
|
|
2947
|
+
* <dbx-list-view [config]="rowConfig"></dbx-list-view>
|
|
2793
2948
|
* ```
|
|
2794
2949
|
*/
|
|
2795
2950
|
declare class DbxValueListViewComponent<T, I extends DbxValueListItem<T> = DbxValueListItem<T>, V = unknown, C extends DbxValueListViewConfig<T, I, V> = DbxValueListViewConfig<T, I, V>> extends AbstractDbxValueListViewDirective<T, I, V, C> {
|
|
@@ -2893,9 +3048,18 @@ declare class DbxValueListAccordionViewContentComponent<T, I extends DbxValueLis
|
|
|
2893
3048
|
* Renders a value list as an accordion using a configuration input. Each item renders its own expansion panel.
|
|
2894
3049
|
* Requires a parent {@link DbxListView} context.
|
|
2895
3050
|
*
|
|
3051
|
+
* @dbxWebComponent
|
|
3052
|
+
* @dbxWebSlug list-accordion-view
|
|
3053
|
+
* @dbxWebCategory list
|
|
3054
|
+
* @dbxWebRelated list, list-view
|
|
3055
|
+
* @dbxWebSkillRefs dbx__ref__dbx-component-patterns
|
|
3056
|
+
* @dbxWebMinimalExample ```html
|
|
3057
|
+
* <dbx-list-accordion-view [config]="rowConfig"></dbx-list-accordion-view>
|
|
3058
|
+
* ```
|
|
3059
|
+
*
|
|
2896
3060
|
* @example
|
|
2897
3061
|
* ```html
|
|
2898
|
-
* <dbx-list-accordion-view [config]="
|
|
3062
|
+
* <dbx-list-accordion-view [config]="rowConfig"></dbx-list-accordion-view>
|
|
2899
3063
|
* ```
|
|
2900
3064
|
*/
|
|
2901
3065
|
declare class DbxValueListAccordionViewComponent<T, I extends DbxValueListItem<T> = DbxValueListItem<T>, V = unknown, C extends DbxValueListAccordionViewConfig<T, I, V> = DbxValueListAccordionViewConfig<T, I, V>> extends AbstractDbxValueListViewDirective<T, I, V, C> {
|
|
@@ -3059,9 +3223,18 @@ declare class DbxValueListGridViewContentComponent<T, I extends DbxValueListItem
|
|
|
3059
3223
|
/**
|
|
3060
3224
|
* Renders a value list as a CSS grid using a configuration input. Requires a parent {@link DbxListView} context.
|
|
3061
3225
|
*
|
|
3226
|
+
* @dbxWebComponent
|
|
3227
|
+
* @dbxWebSlug list-grid-view
|
|
3228
|
+
* @dbxWebCategory list
|
|
3229
|
+
* @dbxWebRelated list, list-view
|
|
3230
|
+
* @dbxWebSkillRefs dbx__ref__dbx-component-patterns
|
|
3231
|
+
* @dbxWebMinimalExample ```html
|
|
3232
|
+
* <dbx-list-grid-view [config]="cellConfig"></dbx-list-grid-view>
|
|
3233
|
+
* ```
|
|
3234
|
+
*
|
|
3062
3235
|
* @example
|
|
3063
3236
|
* ```html
|
|
3064
|
-
* <dbx-list-grid-view [config]="
|
|
3237
|
+
* <dbx-list-grid-view [config]="cellConfig" dbxListGridSize="md"></dbx-list-grid-view>
|
|
3065
3238
|
* ```
|
|
3066
3239
|
*/
|
|
3067
3240
|
declare class DbxValueListGridViewComponent<T, I extends DbxValueListItem<T> = DbxValueListItem<T>, V = unknown, C extends DbxValueListGridViewConfig<T, I, V> = DbxValueListGridViewConfig<T, I, V>> extends AbstractDbxValueListViewDirective<T, I, V, C> {
|
|
@@ -3305,11 +3478,22 @@ declare class DbxListModifierModule {
|
|
|
3305
3478
|
/**
|
|
3306
3479
|
* Displays centered placeholder content within an empty list. Projects its content into a styled container.
|
|
3307
3480
|
*
|
|
3481
|
+
* @dbxWebComponent
|
|
3482
|
+
* @dbxWebSlug list-empty-content
|
|
3483
|
+
* @dbxWebCategory list
|
|
3484
|
+
* @dbxWebRelated list
|
|
3485
|
+
* @dbxWebSkillRefs dbx__ref__dbx-component-patterns
|
|
3486
|
+
* @dbxWebMinimalExample ```html
|
|
3487
|
+
* <dbx-list-empty-content>Empty</dbx-list-empty-content>
|
|
3488
|
+
* ```
|
|
3489
|
+
*
|
|
3308
3490
|
* @example
|
|
3309
3491
|
* ```html
|
|
3310
|
-
* <dbx-list
|
|
3311
|
-
* <
|
|
3312
|
-
*
|
|
3492
|
+
* <dbx-list [state$]="items$" [config]="listConfig">
|
|
3493
|
+
* <dbx-list-empty-content>
|
|
3494
|
+
* <p>No items yet — add one to get started.</p>
|
|
3495
|
+
* </dbx-list-empty-content>
|
|
3496
|
+
* </dbx-list>
|
|
3313
3497
|
* ```
|
|
3314
3498
|
*/
|
|
3315
3499
|
declare class DbxListEmptyContentComponent {
|
|
@@ -3398,11 +3582,18 @@ declare const DBX_LIST_DEFAULT_THROTTLE_SCROLL = 50;
|
|
|
3398
3582
|
*
|
|
3399
3583
|
* This component is typically wrapped by a higher-level component that provides its configuration via the `config` input.
|
|
3400
3584
|
*
|
|
3585
|
+
* @dbxWebComponent
|
|
3586
|
+
* @dbxWebSlug list
|
|
3587
|
+
* @dbxWebCategory list
|
|
3588
|
+
* @dbxWebRelated list-view, list-empty-content, list-grid-view, list-accordion-view, selection-list-view
|
|
3589
|
+
* @dbxWebSkillRefs dbx__ref__dbx-component-patterns
|
|
3590
|
+
* @dbxWebMinimalExample ```html
|
|
3591
|
+
* <dbx-list [state$]="items$" [config]="listConfig"></dbx-list>
|
|
3592
|
+
* ```
|
|
3593
|
+
*
|
|
3401
3594
|
* @example
|
|
3402
3595
|
* ```html
|
|
3403
|
-
* <dbx-list [state]="
|
|
3404
|
-
* <ng-container empty>No items found.</ng-container>
|
|
3405
|
-
* </dbx-list>
|
|
3596
|
+
* <dbx-list [state$]="items$" [config]="listConfig" (contentScrolled)="onScroll($event)"></dbx-list>
|
|
3406
3597
|
* ```
|
|
3407
3598
|
*/
|
|
3408
3599
|
declare class DbxListComponent<T = unknown, V extends DbxListView<T> = DbxListView<T>, S extends ListLoadingState<T> = ListLoadingState<T>> implements OnDestroy {
|
|
@@ -3638,9 +3829,18 @@ declare class DbxSelectionValueListViewContentComponent<T, I extends DbxValueLis
|
|
|
3638
3829
|
* Renders a selection-capable list view using a configuration input. Requires a parent {@link DbxListView} context.
|
|
3639
3830
|
* Switches between selection mode (with checkboxes) and view mode (standard list) based on the parent's selection mode.
|
|
3640
3831
|
*
|
|
3832
|
+
* @dbxWebComponent
|
|
3833
|
+
* @dbxWebSlug selection-list-view
|
|
3834
|
+
* @dbxWebCategory list
|
|
3835
|
+
* @dbxWebRelated list, list-view
|
|
3836
|
+
* @dbxWebSkillRefs dbx__ref__dbx-component-patterns
|
|
3837
|
+
* @dbxWebMinimalExample ```html
|
|
3838
|
+
* <dbx-selection-list-view [config]="rowConfig"></dbx-selection-list-view>
|
|
3839
|
+
* ```
|
|
3840
|
+
*
|
|
3641
3841
|
* @example
|
|
3642
3842
|
* ```html
|
|
3643
|
-
* <dbx-selection-list-view [config]="
|
|
3843
|
+
* <dbx-selection-list-view [config]="rowConfig" selectionMode="multi"></dbx-selection-list-view>
|
|
3644
3844
|
* ```
|
|
3645
3845
|
*/
|
|
3646
3846
|
declare class DbxSelectionValueListViewComponent<T, I extends DbxValueListItem<T> = DbxValueListItem<T>, V = unknown> extends AbstractDbxValueListViewDirective<T, I, V, DbxSelectionValueListViewConfig<T, I, V>> {
|
|
@@ -3738,13 +3938,18 @@ interface DbxSectionHeaderConfig {
|
|
|
3738
3938
|
* Can be used as a standalone element or as an attribute directive on elements with the `.dbx-section-header` class.
|
|
3739
3939
|
* Serves as the base class for `DbxSectionComponent` and `DbxSectionPageComponent`.
|
|
3740
3940
|
*
|
|
3941
|
+
* @dbxWebComponent
|
|
3942
|
+
* @dbxWebSlug section-header
|
|
3943
|
+
* @dbxWebCategory layout
|
|
3944
|
+
* @dbxWebRelated section, subsection
|
|
3945
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
3946
|
+
* @dbxWebMinimalExample ```html
|
|
3947
|
+
* <dbx-section-header header="My Header"></dbx-section-header>
|
|
3948
|
+
* ```
|
|
3949
|
+
*
|
|
3741
3950
|
* @example
|
|
3742
3951
|
* ```html
|
|
3743
|
-
* <dbx-section-header header="
|
|
3744
|
-
*
|
|
3745
|
-
* <div class="dbx-section-header" header="Attribute Usage" [h]="3"></div>
|
|
3746
|
-
*
|
|
3747
|
-
* <dbx-section-header [headerConfig]="{ header: 'Config Object', h: 2, icon: 'info' }"></dbx-section-header>
|
|
3952
|
+
* <div class="dbx-section-header" header="Custom Layout" [h]="2" icon="info"></div>
|
|
3748
3953
|
* ```
|
|
3749
3954
|
*/
|
|
3750
3955
|
declare class DbxSectionHeaderComponent {
|
|
@@ -3767,6 +3972,15 @@ declare class DbxSectionHeaderComponent {
|
|
|
3767
3972
|
* Displays a content section with a header and body area. The header defaults to an h3 heading
|
|
3768
3973
|
* and supports optional elevation styling.
|
|
3769
3974
|
*
|
|
3975
|
+
* @dbxWebComponent
|
|
3976
|
+
* @dbxWebSlug section
|
|
3977
|
+
* @dbxWebCategory layout
|
|
3978
|
+
* @dbxWebRelated subsection, section-page, section-header, intro-action-section
|
|
3979
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks, dbx__ref__dbx-component-patterns
|
|
3980
|
+
* @dbxWebMinimalExample ```html
|
|
3981
|
+
* <dbx-section header="My Section"><p>Body</p></dbx-section>
|
|
3982
|
+
* ```
|
|
3983
|
+
*
|
|
3770
3984
|
* @example
|
|
3771
3985
|
* ```html
|
|
3772
3986
|
* <dbx-section header="My Section" icon="info" hint="Additional context">
|
|
@@ -3780,6 +3994,9 @@ declare class DbxSectionHeaderComponent {
|
|
|
3780
3994
|
* ```
|
|
3781
3995
|
*/
|
|
3782
3996
|
declare class DbxSectionComponent extends DbxSectionHeaderComponent {
|
|
3997
|
+
/**
|
|
3998
|
+
* Apply elevated card styling.
|
|
3999
|
+
*/
|
|
3783
4000
|
readonly elevate: _angular_core.InputSignal<boolean>;
|
|
3784
4001
|
readonly classConfig: _angular_core.Signal<"" | "dbx-section-elevate dbx-content-elevate">;
|
|
3785
4002
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxSectionComponent, never>;
|
|
@@ -3790,15 +4007,23 @@ declare class DbxSectionComponent extends DbxSectionHeaderComponent {
|
|
|
3790
4007
|
* Displays an introductory message with a call-to-action button. When the button is clicked,
|
|
3791
4008
|
* the intro is replaced by the projected content. Useful for onboarding or first-time-use flows.
|
|
3792
4009
|
*
|
|
4010
|
+
* @dbxWebComponent
|
|
4011
|
+
* @dbxWebSlug intro-action-section
|
|
4012
|
+
* @dbxWebCategory feedback
|
|
4013
|
+
* @dbxWebRelated section, list-empty-content
|
|
4014
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
4015
|
+
* @dbxWebMinimalExample ```html
|
|
4016
|
+
* <dbx-intro-action-section hint="Welcome" action="Start"><p>Body</p></dbx-intro-action-section>
|
|
4017
|
+
* ```
|
|
4018
|
+
*
|
|
3793
4019
|
* @example
|
|
3794
4020
|
* ```html
|
|
3795
4021
|
* <dbx-intro-action-section
|
|
3796
4022
|
* hint="Welcome! Click below to get started."
|
|
3797
4023
|
* action="Get Started"
|
|
3798
|
-
* [showIntro]="
|
|
3799
|
-
* (showAction)="
|
|
3800
|
-
* <
|
|
3801
|
-
* <p>Main content shown after the action is clicked.</p>
|
|
4024
|
+
* [showIntro]="!hasOnboarded"
|
|
4025
|
+
* (showAction)="markOnboarded()">
|
|
4026
|
+
* <p>Main content shown after the action.</p>
|
|
3802
4027
|
* </dbx-intro-action-section>
|
|
3803
4028
|
* ```
|
|
3804
4029
|
*/
|
|
@@ -3825,14 +4050,19 @@ type DbxSectionPageScrollLockedMode = 'all' | 'body' | 'locked';
|
|
|
3825
4050
|
* Supports nested section pages that retain proper fixed-height layout. Use for top-level
|
|
3826
4051
|
* page content that needs a prominent heading.
|
|
3827
4052
|
*
|
|
4053
|
+
* @dbxWebComponent
|
|
4054
|
+
* @dbxWebSlug section-page
|
|
4055
|
+
* @dbxWebCategory layout
|
|
4056
|
+
* @dbxWebRelated section, content-page
|
|
4057
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks, dbx__ref__dbx-app-structure
|
|
4058
|
+
* @dbxWebMinimalExample ```html
|
|
4059
|
+
* <dbx-section-page header="Page"><p>Body</p></dbx-section-page>
|
|
4060
|
+
* ```
|
|
4061
|
+
*
|
|
3828
4062
|
* @example
|
|
3829
4063
|
* ```html
|
|
3830
|
-
* <dbx-section-page header="
|
|
3831
|
-
* <p>
|
|
3832
|
-
* </dbx-section-page>
|
|
3833
|
-
*
|
|
3834
|
-
* <dbx-section-page header="Scrollable Body" scroll="body" hint="Only the body scrolls">
|
|
3835
|
-
* <div style="height: 2000px">Tall content</div>
|
|
4064
|
+
* <dbx-section-page header="Dashboard" icon="dashboard" scroll="body">
|
|
4065
|
+
* <p>Top-level page content.</p>
|
|
3836
4066
|
* </dbx-section-page>
|
|
3837
4067
|
* ```
|
|
3838
4068
|
*/
|
|
@@ -3848,11 +4078,20 @@ declare class DbxSectionPageComponent extends DbxSectionHeaderComponent {
|
|
|
3848
4078
|
* Renders a subsection within a parent section, using a smaller heading (defaults to h4).
|
|
3849
4079
|
* Useful for grouping related content under a `dbx-section`.
|
|
3850
4080
|
*
|
|
4081
|
+
* @dbxWebComponent
|
|
4082
|
+
* @dbxWebSlug subsection
|
|
4083
|
+
* @dbxWebCategory layout
|
|
4084
|
+
* @dbxWebRelated section, section-header
|
|
4085
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
4086
|
+
* @dbxWebMinimalExample ```html
|
|
4087
|
+
* <dbx-subsection header="Details"><p>Body</p></dbx-subsection>
|
|
4088
|
+
* ```
|
|
4089
|
+
*
|
|
3851
4090
|
* @example
|
|
3852
4091
|
* ```html
|
|
3853
|
-
* <dbx-section header="
|
|
3854
|
-
* <dbx-subsection header="
|
|
3855
|
-
* <p>Subsection
|
|
4092
|
+
* <dbx-section header="Settings">
|
|
4093
|
+
* <dbx-subsection header="Notifications" icon="notifications">
|
|
4094
|
+
* <p>Subsection body.</p>
|
|
3856
4095
|
* </dbx-subsection>
|
|
3857
4096
|
* </dbx-section>
|
|
3858
4097
|
* ```
|
|
@@ -3910,13 +4149,22 @@ declare class DbxColorDirective {
|
|
|
3910
4149
|
/**
|
|
3911
4150
|
* Adds flexible spacing between sibling elements in a flex container.
|
|
3912
4151
|
*
|
|
4152
|
+
* @dbxWebComponent
|
|
4153
|
+
* @dbxWebSlug spacer
|
|
4154
|
+
* @dbxWebCategory layout
|
|
4155
|
+
* @dbxWebRelated bar, button-spacer
|
|
4156
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
4157
|
+
* @dbxWebMinimalExample ```html
|
|
4158
|
+
* <dbx-spacer></dbx-spacer>
|
|
4159
|
+
* ```
|
|
4160
|
+
*
|
|
3913
4161
|
* @example
|
|
3914
4162
|
* ```html
|
|
3915
|
-
* <
|
|
3916
|
-
* <span>
|
|
4163
|
+
* <dbx-bar>
|
|
4164
|
+
* <span>Title</span>
|
|
3917
4165
|
* <dbx-spacer></dbx-spacer>
|
|
3918
|
-
* <
|
|
3919
|
-
* </
|
|
4166
|
+
* <button mat-button>Action</button>
|
|
4167
|
+
* </dbx-bar>
|
|
3920
4168
|
* ```
|
|
3921
4169
|
*/
|
|
3922
4170
|
declare class DbxSpacerDirective {
|
|
@@ -4158,11 +4406,19 @@ declare class DbxUnitedStatesAddressComponent {
|
|
|
4158
4406
|
*
|
|
4159
4407
|
* Use the `[header]` content slot for extra header-level content and default content for the detail area.
|
|
4160
4408
|
*
|
|
4409
|
+
* @dbxWebComponent
|
|
4410
|
+
* @dbxWebSlug detail-block
|
|
4411
|
+
* @dbxWebCategory text
|
|
4412
|
+
* @dbxWebRelated label-block
|
|
4413
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
4414
|
+
* @dbxWebMinimalExample ```html
|
|
4415
|
+
* <dbx-detail-block header="Label">Body</dbx-detail-block>
|
|
4416
|
+
* ```
|
|
4417
|
+
*
|
|
4161
4418
|
* @example
|
|
4162
4419
|
* ```html
|
|
4163
|
-
* <dbx-detail-block
|
|
4164
|
-
* <
|
|
4165
|
-
* <p>Detail content goes here.</p>
|
|
4420
|
+
* <dbx-detail-block header="Email" icon="mail">
|
|
4421
|
+
* <p>{{ user.email }}</p>
|
|
4166
4422
|
* </dbx-detail-block>
|
|
4167
4423
|
* ```
|
|
4168
4424
|
*/
|
|
@@ -4283,11 +4539,18 @@ declare class DbxIconSpacerDirective {
|
|
|
4283
4539
|
/**
|
|
4284
4540
|
* Displays a label header above projected content, useful for labeling form fields or data sections.
|
|
4285
4541
|
*
|
|
4542
|
+
* @dbxWebComponent
|
|
4543
|
+
* @dbxWebSlug label-block
|
|
4544
|
+
* @dbxWebCategory text
|
|
4545
|
+
* @dbxWebRelated detail-block
|
|
4546
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
4547
|
+
* @dbxWebMinimalExample ```html
|
|
4548
|
+
* <dbx-label-block header="Label">Body</dbx-label-block>
|
|
4549
|
+
* ```
|
|
4550
|
+
*
|
|
4286
4551
|
* @example
|
|
4287
4552
|
* ```html
|
|
4288
|
-
* <dbx-label-block header="
|
|
4289
|
-
* <span>user@example.com</span>
|
|
4290
|
-
* </dbx-label-block>
|
|
4553
|
+
* <dbx-label-block header="Status"><span>Active</span></dbx-label-block>
|
|
4291
4554
|
* ```
|
|
4292
4555
|
*/
|
|
4293
4556
|
declare class DbxLabelBlockComponent {
|
|
@@ -4487,11 +4750,18 @@ declare const DBX_CHIP_DEFAULT_TONE = 18;
|
|
|
4487
4750
|
/**
|
|
4488
4751
|
* Renders a styled chip element with optional small, block, and color modes.
|
|
4489
4752
|
*
|
|
4753
|
+
* @dbxWebComponent
|
|
4754
|
+
* @dbxWebSlug chip
|
|
4755
|
+
* @dbxWebCategory text
|
|
4756
|
+
* @dbxWebRelated chip-list
|
|
4757
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
4758
|
+
* @dbxWebMinimalExample ```html
|
|
4759
|
+
* <dbx-chip text="Tag"></dbx-chip>
|
|
4760
|
+
* ```
|
|
4761
|
+
*
|
|
4490
4762
|
* @example
|
|
4491
4763
|
* ```html
|
|
4492
|
-
* <dbx-chip
|
|
4493
|
-
* <dbx-chip [block]="true">Full Width</dbx-chip>
|
|
4494
|
-
* <dbx-chip [color]="'primary'">Primary</dbx-chip>
|
|
4764
|
+
* <dbx-chip text="Active" icon="check" color="primary"></dbx-chip>
|
|
4495
4765
|
* ```
|
|
4496
4766
|
*/
|
|
4497
4767
|
declare class DbxChipDirective {
|
|
@@ -4538,10 +4808,21 @@ declare class DbxChipDirective {
|
|
|
4538
4808
|
*
|
|
4539
4809
|
* Uses {@link DbxChipDirective} internally with `dbx-chip-spacer` class for spacing.
|
|
4540
4810
|
*
|
|
4811
|
+
* @dbxWebComponent
|
|
4812
|
+
* @dbxWebSlug chip-list
|
|
4813
|
+
* @dbxWebCategory text
|
|
4814
|
+
* @dbxWebRelated chip
|
|
4815
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
4816
|
+
* @dbxWebMinimalExample ```html
|
|
4817
|
+
* <dbx-chip-list></dbx-chip-list>
|
|
4818
|
+
* ```
|
|
4819
|
+
*
|
|
4541
4820
|
* @example
|
|
4542
4821
|
* ```html
|
|
4543
|
-
* <dbx-chip-list
|
|
4544
|
-
*
|
|
4822
|
+
* <dbx-chip-list>
|
|
4823
|
+
* <dbx-chip text="Tag1"></dbx-chip>
|
|
4824
|
+
* <dbx-chip text="Tag2"></dbx-chip>
|
|
4825
|
+
* </dbx-chip-list>
|
|
4545
4826
|
* ```
|
|
4546
4827
|
*/
|
|
4547
4828
|
declare class DbxChipListComponent {
|
|
@@ -4863,10 +5144,18 @@ declare function overrideClickElementEffect(config: OverrideClickElementEffectCo
|
|
|
4863
5144
|
*
|
|
4864
5145
|
* Clicking the text or the icon copies the text to the clipboard and optionally shows a snackbar confirmation.
|
|
4865
5146
|
*
|
|
5147
|
+
* @dbxWebComponent
|
|
5148
|
+
* @dbxWebSlug click-to-copy-text
|
|
5149
|
+
* @dbxWebCategory text
|
|
5150
|
+
* @dbxWebRelated chip
|
|
5151
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
5152
|
+
* @dbxWebMinimalExample ```html
|
|
5153
|
+
* <dbx-click-to-copy-text [text]="value"></dbx-click-to-copy-text>
|
|
5154
|
+
* ```
|
|
5155
|
+
*
|
|
4866
5156
|
* @example
|
|
4867
5157
|
* ```html
|
|
4868
|
-
* <dbx-click-to-copy-text
|
|
4869
|
-
* <dbx-click-to-copy-text [clickIconToCopyOnly]="true">Click icon only</dbx-click-to-copy-text>
|
|
5158
|
+
* <dbx-click-to-copy-text [text]="userId"></dbx-click-to-copy-text>
|
|
4870
5159
|
* ```
|
|
4871
5160
|
*/
|
|
4872
5161
|
declare class DbxClickToCopyTextComponent {
|
|
@@ -5145,11 +5434,18 @@ declare abstract class AbstractProgressButtonDirective {
|
|
|
5145
5434
|
/**
|
|
5146
5435
|
* Progress button that displays a Material progress bar beneath the button while working.
|
|
5147
5436
|
*
|
|
5437
|
+
* @dbxWebComponent
|
|
5438
|
+
* @dbxWebSlug progress-bar-button
|
|
5439
|
+
* @dbxWebCategory button
|
|
5440
|
+
* @dbxWebRelated button, progress-spinner-button
|
|
5441
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
5442
|
+
* @dbxWebMinimalExample ```html
|
|
5443
|
+
* <dbx-progress-bar-button [config]="cfg"></dbx-progress-bar-button>
|
|
5444
|
+
* ```
|
|
5445
|
+
*
|
|
5148
5446
|
* @example
|
|
5149
5447
|
* ```html
|
|
5150
|
-
* <dbx-progress-bar-button [config]="
|
|
5151
|
-
* Save
|
|
5152
|
-
* </dbx-progress-bar-button>
|
|
5448
|
+
* <dbx-progress-bar-button [config]="cfg" (btnClick)="onClick()"></dbx-progress-bar-button>
|
|
5153
5449
|
* ```
|
|
5154
5450
|
*/
|
|
5155
5451
|
declare class DbxProgressBarButtonComponent extends AbstractProgressButtonDirective {
|
|
@@ -5163,11 +5459,18 @@ declare class DbxProgressBarButtonComponent extends AbstractProgressButtonDirect
|
|
|
5163
5459
|
* Progress button that overlays a Material progress spinner on the button while working.
|
|
5164
5460
|
* Supports icon-only, FAB, and text button modes with automatic spinner sizing.
|
|
5165
5461
|
*
|
|
5462
|
+
* @dbxWebComponent
|
|
5463
|
+
* @dbxWebSlug progress-spinner-button
|
|
5464
|
+
* @dbxWebCategory button
|
|
5465
|
+
* @dbxWebRelated button, progress-bar-button
|
|
5466
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
5467
|
+
* @dbxWebMinimalExample ```html
|
|
5468
|
+
* <dbx-progress-spinner-button [config]="cfg"></dbx-progress-spinner-button>
|
|
5469
|
+
* ```
|
|
5470
|
+
*
|
|
5166
5471
|
* @example
|
|
5167
5472
|
* ```html
|
|
5168
|
-
* <dbx-progress-spinner-button [config]="
|
|
5169
|
-
* Submit
|
|
5170
|
-
* </dbx-progress-spinner-button>
|
|
5473
|
+
* <dbx-progress-spinner-button [config]="cfg" (btnClick)="onClick()"></dbx-progress-spinner-button>
|
|
5171
5474
|
* ```
|
|
5172
5475
|
*/
|
|
5173
5476
|
declare class DbxProgressSpinnerButtonComponent extends AbstractProgressButtonDirective {
|
|
@@ -5223,6 +5526,15 @@ declare function provideDbxProgressButtonGlobalConfig(config: DbxProgressButtonG
|
|
|
5223
5526
|
* custom colors, icons, and floating action button (FAB) mode. Integrates with the dbxAction system
|
|
5224
5527
|
* for automatic working/disabled state management.
|
|
5225
5528
|
*
|
|
5529
|
+
* @dbxWebComponent
|
|
5530
|
+
* @dbxWebSlug button
|
|
5531
|
+
* @dbxWebCategory button
|
|
5532
|
+
* @dbxWebRelated icon-button, progress-spinner-button, progress-bar-button
|
|
5533
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
5534
|
+
* @dbxWebMinimalExample ```html
|
|
5535
|
+
* <dbx-button text="Save" raised [dbxAction]="saveAction"></dbx-button>
|
|
5536
|
+
* ```
|
|
5537
|
+
*
|
|
5226
5538
|
* @example
|
|
5227
5539
|
* ```html
|
|
5228
5540
|
* <dbx-button [text]="'Save'" raised [dbxAction]="saveAction">
|
|
@@ -5276,16 +5588,22 @@ declare class DbxButtonComponent extends AbstractDbxButtonDirective {
|
|
|
5276
5588
|
/**
|
|
5277
5589
|
* Adds inline spacing between adjacent buttons. Can be used as an element or attribute.
|
|
5278
5590
|
*
|
|
5279
|
-
* @
|
|
5280
|
-
*
|
|
5281
|
-
*
|
|
5591
|
+
* @dbxWebComponent
|
|
5592
|
+
* @dbxWebSlug button-spacer
|
|
5593
|
+
* @dbxWebCategory button
|
|
5594
|
+
* @dbxWebRelated bar, spacer, button
|
|
5595
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
5596
|
+
* @dbxWebMinimalExample ```html
|
|
5282
5597
|
* <dbx-button-spacer></dbx-button-spacer>
|
|
5283
|
-
* <dbx-button text="Save" raised></dbx-button>
|
|
5284
5598
|
* ```
|
|
5285
5599
|
*
|
|
5286
5600
|
* @example
|
|
5287
5601
|
* ```html
|
|
5288
|
-
* <
|
|
5602
|
+
* <dbx-bar>
|
|
5603
|
+
* <dbx-button text="Save" raised></dbx-button>
|
|
5604
|
+
* <dbx-button-spacer></dbx-button-spacer>
|
|
5605
|
+
* <dbx-button text="Cancel"></dbx-button>
|
|
5606
|
+
* </dbx-bar>
|
|
5289
5607
|
* ```
|
|
5290
5608
|
*/
|
|
5291
5609
|
declare class DbxButtonSpacerDirective {
|
|
@@ -5352,9 +5670,20 @@ interface DbxErrorViewButtonEvent {
|
|
|
5352
5670
|
* Emits a {@link DbxErrorViewButtonEvent} when the button is clicked, which is typically used
|
|
5353
5671
|
* to open an error detail popover. Used internally by {@link DbxErrorComponent}.
|
|
5354
5672
|
*
|
|
5673
|
+
* @dbxWebComponent
|
|
5674
|
+
* @dbxWebSlug error-view
|
|
5675
|
+
* @dbxWebCategory feedback
|
|
5676
|
+
* @dbxWebRelated error, error-snackbar
|
|
5677
|
+
* @dbxWebSkillRefs dbx__ref__dbx-component-patterns
|
|
5678
|
+
* @dbxWebMinimalExample ```html
|
|
5679
|
+
* <dbx-error-view [error]="error"></dbx-error-view>
|
|
5680
|
+
* ```
|
|
5681
|
+
*
|
|
5355
5682
|
* @example
|
|
5356
5683
|
* ```html
|
|
5357
|
-
* <dbx-error-view
|
|
5684
|
+
* <dbx-error-view [error]="error">
|
|
5685
|
+
* <dbx-button text="Retry" [dbxAction]="retryAction"></dbx-button>
|
|
5686
|
+
* </dbx-error-view>
|
|
5358
5687
|
* ```
|
|
5359
5688
|
*/
|
|
5360
5689
|
declare class DbxErrorViewComponent {
|
|
@@ -5397,12 +5726,18 @@ interface DbxErrorComponentState {
|
|
|
5397
5726
|
* with an icon and message, or a custom error widget registered via {@link DbxErrorWidgetService}.
|
|
5398
5727
|
* Clicking the error icon opens a popover with detailed error information.
|
|
5399
5728
|
*
|
|
5729
|
+
* @dbxWebComponent
|
|
5730
|
+
* @dbxWebSlug error
|
|
5731
|
+
* @dbxWebCategory feedback
|
|
5732
|
+
* @dbxWebRelated error-snackbar, error-view, loading
|
|
5733
|
+
* @dbxWebSkillRefs dbx__ref__dbx-component-patterns
|
|
5734
|
+
* @dbxWebMinimalExample ```html
|
|
5735
|
+
* <dbx-error [error]="error"></dbx-error>
|
|
5736
|
+
* ```
|
|
5737
|
+
*
|
|
5400
5738
|
* @example
|
|
5401
5739
|
* ```html
|
|
5402
|
-
* <dbx-error [error]="
|
|
5403
|
-
*
|
|
5404
|
-
* <!-- Icon-only mode, no message text -->
|
|
5405
|
-
* <dbx-error [error]="myError" [iconOnly]="true"></dbx-error>
|
|
5740
|
+
* <dbx-error [error]="error$ | async"></dbx-error>
|
|
5406
5741
|
* ```
|
|
5407
5742
|
*/
|
|
5408
5743
|
declare class DbxErrorComponent {
|
|
@@ -5542,9 +5877,18 @@ interface DbxErrorSnackbarData<T extends ErrorInput = ErrorInput> {
|
|
|
5542
5877
|
* Supports an optional auto-dismiss timer that pauses while an error detail popover is open.
|
|
5543
5878
|
* Typically opened via {@link DbxErrorSnackbarService} or the static {@link DbxErrorSnackbarComponent.showErrorSnackbar} method.
|
|
5544
5879
|
*
|
|
5880
|
+
* @dbxWebComponent
|
|
5881
|
+
* @dbxWebSlug error-snackbar
|
|
5882
|
+
* @dbxWebCategory feedback
|
|
5883
|
+
* @dbxWebRelated error
|
|
5884
|
+
* @dbxWebSkillRefs dbx__ref__dbx-component-patterns
|
|
5885
|
+
* @dbxWebMinimalExample ```html
|
|
5886
|
+
* <dbx-error-snackbar></dbx-error-snackbar>
|
|
5887
|
+
* ```
|
|
5888
|
+
*
|
|
5545
5889
|
* @example
|
|
5546
|
-
* ```
|
|
5547
|
-
*
|
|
5890
|
+
* ```html
|
|
5891
|
+
* // Triggered via DbxErrorSnackbarService.showError(error)
|
|
5548
5892
|
* ```
|
|
5549
5893
|
*/
|
|
5550
5894
|
declare class DbxErrorSnackbarComponent {
|
|
@@ -5597,13 +5941,18 @@ declare class DbxErrorSnackbarService {
|
|
|
5597
5941
|
* Subscribes to the action context's error stream and shows a snackbar via {@link DbxErrorSnackbarService}
|
|
5598
5942
|
* whenever an error occurs. Accepts an optional configuration or a duration in milliseconds as input.
|
|
5599
5943
|
*
|
|
5944
|
+
* @dbxWebComponent
|
|
5945
|
+
* @dbxWebSlug action-snackbar-error
|
|
5946
|
+
* @dbxWebCategory action
|
|
5947
|
+
* @dbxWebRelated action-snackbar
|
|
5948
|
+
* @dbxWebSkillRefs dbx__ref__dbx-component-patterns
|
|
5949
|
+
* @dbxWebMinimalExample ```html
|
|
5950
|
+
* <div [dbxActionSnackbarError]></div>
|
|
5951
|
+
* ```
|
|
5952
|
+
*
|
|
5600
5953
|
* @example
|
|
5601
5954
|
* ```html
|
|
5602
|
-
*
|
|
5603
|
-
* <div dbxAction [dbxActionSnackbarError]="5000">...</div>
|
|
5604
|
-
*
|
|
5605
|
-
* <!-- Default behavior, no auto-dismiss -->
|
|
5606
|
-
* <div dbxAction dbxActionSnackbarError>...</div>
|
|
5955
|
+
* <button [dbxAction]="saveAction" dbxActionSnackbarError>Save</button>
|
|
5607
5956
|
* ```
|
|
5608
5957
|
*/
|
|
5609
5958
|
declare class DbxActionSnackbarErrorDirective {
|
|
@@ -5693,6 +6042,20 @@ interface FullDbxPopoverComponentConfig<O, I, T> extends DbxPopoverComponentConf
|
|
|
5693
6042
|
* Core popover component that renders injected content with position strategy, transition watching, and keyboard close support.
|
|
5694
6043
|
*
|
|
5695
6044
|
* Coordinates with {@link DbxPopoverCoordinatorService} to ensure only one popover per key is active at a time.
|
|
6045
|
+
*
|
|
6046
|
+
* @dbxWebComponent
|
|
6047
|
+
* @dbxWebSlug popover
|
|
6048
|
+
* @dbxWebCategory overlay
|
|
6049
|
+
* @dbxWebRelated popup, prompt-confirm, dialog-content
|
|
6050
|
+
* @dbxWebSkillRefs dbx__ref__dbx-app-structure
|
|
6051
|
+
* @dbxWebMinimalExample ```html
|
|
6052
|
+
* <dbx-popover></dbx-popover>
|
|
6053
|
+
* ```
|
|
6054
|
+
*
|
|
6055
|
+
* @example
|
|
6056
|
+
* ```html
|
|
6057
|
+
* // In a service: this.popoverService.open({ content: MyContentComponent, origin })
|
|
6058
|
+
* ```
|
|
5696
6059
|
*/
|
|
5697
6060
|
declare class DbxPopoverComponent<O = unknown, I = unknown, T = unknown> extends AbstractTransitionWatcherDirective implements DbxPopoverController<O, I>, OnInit, OnDestroy {
|
|
5698
6061
|
private readonly popoverRef;
|
|
@@ -6855,10 +7218,20 @@ declare function dbxZipBlobPreviewEntryTreeFromEntries(entries: Maybe<Entry[]>):
|
|
|
6855
7218
|
*
|
|
6856
7219
|
* Supports plain content, clickable actions, router segue references, external hrefs, and disabled states.
|
|
6857
7220
|
*
|
|
7221
|
+
* @dbxWebComponent
|
|
7222
|
+
* @dbxWebSlug anchor
|
|
7223
|
+
* @dbxWebCategory router
|
|
7224
|
+
* @dbxWebRelated anchor-list, navbar, sidenav
|
|
7225
|
+
* @dbxWebSkillRefs dbx__ref__dbx-app-structure
|
|
7226
|
+
* @dbxWebMinimalExample ```html
|
|
7227
|
+
* <dbx-anchor [anchor]="{ url: '/' }">Home</dbx-anchor>
|
|
7228
|
+
* ```
|
|
7229
|
+
*
|
|
6858
7230
|
* @example
|
|
6859
7231
|
* ```html
|
|
6860
|
-
* <dbx-anchor [anchor]="
|
|
6861
|
-
*
|
|
7232
|
+
* <dbx-anchor [anchor]="{ ref: 'app.home' }">
|
|
7233
|
+
* <button mat-button>Home</button>
|
|
7234
|
+
* </dbx-anchor>
|
|
6862
7235
|
* ```
|
|
6863
7236
|
*/
|
|
6864
7237
|
declare class DbxAnchorComponent extends AbstractDbxAnchorDirective {
|
|
@@ -6983,9 +7356,18 @@ interface DbxAnchorListExpandedAnchor extends ExpandedClickableAnchorLinkTree {
|
|
|
6983
7356
|
*
|
|
6984
7357
|
* Each anchor is expanded and assigned depth-based CSS classes for nested styling.
|
|
6985
7358
|
*
|
|
7359
|
+
* @dbxWebComponent
|
|
7360
|
+
* @dbxWebSlug anchor-list
|
|
7361
|
+
* @dbxWebCategory router
|
|
7362
|
+
* @dbxWebRelated anchor, sidenav
|
|
7363
|
+
* @dbxWebSkillRefs dbx__ref__dbx-app-structure
|
|
7364
|
+
* @dbxWebMinimalExample ```html
|
|
7365
|
+
* <dbx-anchor-list [anchors]="anchors"></dbx-anchor-list>
|
|
7366
|
+
* ```
|
|
7367
|
+
*
|
|
6986
7368
|
* @example
|
|
6987
7369
|
* ```html
|
|
6988
|
-
* <dbx-anchor-list [anchors]="
|
|
7370
|
+
* <dbx-anchor-list [anchors]="navAnchors"></dbx-anchor-list>
|
|
6989
7371
|
* ```
|
|
6990
7372
|
*/
|
|
6991
7373
|
declare class DbxAnchorListComponent {
|
|
@@ -7051,10 +7433,18 @@ type NavbarButtonMode = 'menu' | 'rotate';
|
|
|
7051
7433
|
*
|
|
7052
7434
|
* Automatically selects the active anchor based on the current route and supports configurable breakpoints.
|
|
7053
7435
|
*
|
|
7436
|
+
* @dbxWebComponent
|
|
7437
|
+
* @dbxWebSlug navbar
|
|
7438
|
+
* @dbxWebCategory navigation
|
|
7439
|
+
* @dbxWebRelated anchor, sidenav, pagebar
|
|
7440
|
+
* @dbxWebSkillRefs dbx__ref__dbx-app-structure
|
|
7441
|
+
* @dbxWebMinimalExample ```html
|
|
7442
|
+
* <dbx-navbar [anchors]="anchors"></dbx-navbar>
|
|
7443
|
+
* ```
|
|
7444
|
+
*
|
|
7054
7445
|
* @example
|
|
7055
7446
|
* ```html
|
|
7056
|
-
* <dbx-navbar [anchors]="
|
|
7057
|
-
* <dbx-navbar [anchors]="navAnchors" mode="icon" [showMenuCaret]="true"></dbx-navbar>
|
|
7447
|
+
* <dbx-navbar [anchors]="topNav"></dbx-navbar>
|
|
7058
7448
|
* ```
|
|
7059
7449
|
*/
|
|
7060
7450
|
declare class DbxNavbarComponent extends AbstractTransitionDirective {
|
|
@@ -7159,13 +7549,18 @@ interface DbxSidenavSidebarState {
|
|
|
7159
7549
|
* Renders a Material sidenav with an anchor list and automatically transitions between mobile overlay, icon rail, and full sidebar modes.
|
|
7160
7550
|
* Closes automatically on route transitions in mobile mode.
|
|
7161
7551
|
*
|
|
7552
|
+
* @dbxWebComponent
|
|
7553
|
+
* @dbxWebSlug sidenav
|
|
7554
|
+
* @dbxWebCategory navigation
|
|
7555
|
+
* @dbxWebRelated sidenav-page, anchor-list
|
|
7556
|
+
* @dbxWebSkillRefs dbx__ref__dbx-app-structure
|
|
7557
|
+
* @dbxWebMinimalExample ```html
|
|
7558
|
+
* <dbx-sidenav [anchors]="anchors"></dbx-sidenav>
|
|
7559
|
+
* ```
|
|
7560
|
+
*
|
|
7162
7561
|
* @example
|
|
7163
7562
|
* ```html
|
|
7164
|
-
* <dbx-sidenav [anchors]="
|
|
7165
|
-
* <div top>Header Content</div>
|
|
7166
|
-
* <div bottom>Footer Content</div>
|
|
7167
|
-
* <router-outlet></router-outlet>
|
|
7168
|
-
* </dbx-sidenav>
|
|
7563
|
+
* <dbx-sidenav [anchors]="sidenavAnchors"></dbx-sidenav>
|
|
7169
7564
|
* ```
|
|
7170
7565
|
*/
|
|
7171
7566
|
declare class DbxSidenavComponent extends AbstractTransitionWatcherDirective implements OnInit {
|
|
@@ -7291,15 +7686,20 @@ declare class DbxSidenavPagebarComponent extends DbxPagebarComponent {
|
|
|
7291
7686
|
*
|
|
7292
7687
|
* When `mobileOnly` is true, the pagebar is hidden on non-mobile screen sizes.
|
|
7293
7688
|
*
|
|
7689
|
+
* @dbxWebComponent
|
|
7690
|
+
* @dbxWebSlug sidenav-page
|
|
7691
|
+
* @dbxWebCategory navigation
|
|
7692
|
+
* @dbxWebRelated sidenav, navbar
|
|
7693
|
+
* @dbxWebSkillRefs dbx__ref__dbx-app-structure
|
|
7694
|
+
* @dbxWebMinimalExample ```html
|
|
7695
|
+
* <dbx-sidenav-page>Content</dbx-sidenav-page>
|
|
7696
|
+
* ```
|
|
7697
|
+
*
|
|
7294
7698
|
* @example
|
|
7295
7699
|
* ```html
|
|
7296
|
-
* <dbx-sidenav
|
|
7297
|
-
* <
|
|
7298
|
-
*
|
|
7299
|
-
* <span navRight>Right Nav Content</span>
|
|
7300
|
-
* <p>Page body content</p>
|
|
7301
|
-
* </dbx-sidenav-page>
|
|
7302
|
-
* </dbx-sidenav>
|
|
7700
|
+
* <dbx-sidenav-page>
|
|
7701
|
+
* <ui-view></ui-view>
|
|
7702
|
+
* </dbx-sidenav-page>
|
|
7303
7703
|
* ```
|
|
7304
7704
|
*/
|
|
7305
7705
|
declare class DbxSidenavPageComponent {
|
|
@@ -7548,10 +7948,20 @@ type DbxDialogContentContainerWidth = 'normal' | 'wide';
|
|
|
7548
7948
|
*
|
|
7549
7949
|
* Can be used as an element, attribute, or CSS class selector.
|
|
7550
7950
|
*
|
|
7951
|
+
* @dbxWebComponent
|
|
7952
|
+
* @dbxWebSlug dialog-content
|
|
7953
|
+
* @dbxWebCategory overlay
|
|
7954
|
+
* @dbxWebRelated popover, popup, prompt
|
|
7955
|
+
* @dbxWebSkillRefs dbx__ref__dbx-app-structure
|
|
7956
|
+
* @dbxWebMinimalExample ```html
|
|
7957
|
+
* <div dbxDialogContent>Body</div>
|
|
7958
|
+
* ```
|
|
7959
|
+
*
|
|
7551
7960
|
* @example
|
|
7552
7961
|
* ```html
|
|
7553
|
-
* <dbx-dialog-content
|
|
7554
|
-
* <
|
|
7962
|
+
* <dbx-dialog-content>
|
|
7963
|
+
* <h2>Confirm</h2>
|
|
7964
|
+
* <p>Are you sure?</p>
|
|
7555
7965
|
* </dbx-dialog-content>
|
|
7556
7966
|
* ```
|
|
7557
7967
|
*/
|
|
@@ -9287,6 +9697,20 @@ interface DbxPopupComponentConfig<O, I, T> {
|
|
|
9287
9697
|
* Core popup component that renders injected content with support for minimize, fullscreen, and normal window states.
|
|
9288
9698
|
*
|
|
9289
9699
|
* Coordinates with {@link DbxPopupCoordinatorService} to ensure only one popup per key is active at a time.
|
|
9700
|
+
*
|
|
9701
|
+
* @dbxWebComponent
|
|
9702
|
+
* @dbxWebSlug popup
|
|
9703
|
+
* @dbxWebCategory overlay
|
|
9704
|
+
* @dbxWebRelated popover
|
|
9705
|
+
* @dbxWebSkillRefs dbx__ref__dbx-app-structure
|
|
9706
|
+
* @dbxWebMinimalExample ```html
|
|
9707
|
+
* <dbx-popup></dbx-popup>
|
|
9708
|
+
* ```
|
|
9709
|
+
*
|
|
9710
|
+
* @example
|
|
9711
|
+
* ```html
|
|
9712
|
+
* // In a service: this.popupService.open({ content: MyContentComponent })
|
|
9713
|
+
* ```
|
|
9290
9714
|
*/
|
|
9291
9715
|
declare class DbxPopupComponent<O = unknown, I = unknown, T = unknown> extends AbstractTransitionWatcherDirective implements DbxPopupController<O, I> {
|
|
9292
9716
|
private readonly popoverRef;
|
|
@@ -9486,11 +9910,20 @@ declare class DbxPromptConfirmButtonDirective implements OnInit, DbxButtonInterc
|
|
|
9486
9910
|
/**
|
|
9487
9911
|
* Renders a styled prompt section with a header, descriptive text, and a hero content slot.
|
|
9488
9912
|
*
|
|
9913
|
+
* @dbxWebComponent
|
|
9914
|
+
* @dbxWebSlug prompt
|
|
9915
|
+
* @dbxWebCategory overlay
|
|
9916
|
+
* @dbxWebRelated prompt-confirm, dialog-content
|
|
9917
|
+
* @dbxWebSkillRefs dbx__ref__dbx-app-structure
|
|
9918
|
+
* @dbxWebMinimalExample ```html
|
|
9919
|
+
* <dbx-prompt header="Confirm"></dbx-prompt>
|
|
9920
|
+
* ```
|
|
9921
|
+
*
|
|
9489
9922
|
* @example
|
|
9490
9923
|
* ```html
|
|
9491
|
-
* <dbx-prompt
|
|
9492
|
-
* <
|
|
9493
|
-
* <button mat-
|
|
9924
|
+
* <dbx-prompt header="Delete account" prompt="This cannot be undone.">
|
|
9925
|
+
* <button mat-button (click)="cancel()">Cancel</button>
|
|
9926
|
+
* <button mat-flat-button color="warn" (click)="confirm()">Delete</button>
|
|
9494
9927
|
* </dbx-prompt>
|
|
9495
9928
|
* ```
|
|
9496
9929
|
*/
|
|
@@ -9963,11 +10396,18 @@ declare class DbxWindowKeyDownListenerDirective {
|
|
|
9963
10396
|
*
|
|
9964
10397
|
* Uses a `ResizeObserver` internally via {@link resizeSignal}.
|
|
9965
10398
|
*
|
|
10399
|
+
* @dbxWebComponent
|
|
10400
|
+
* @dbxWebSlug resized
|
|
10401
|
+
* @dbxWebCategory screen
|
|
10402
|
+
* @dbxWebRelated flex-group
|
|
10403
|
+
* @dbxWebSkillRefs dbx__ref__dbx-ui-building-blocks
|
|
10404
|
+
* @dbxWebMinimalExample ```html
|
|
10405
|
+
* <div (dbxResized)="handle($event)"></div>
|
|
10406
|
+
* ```
|
|
10407
|
+
*
|
|
9966
10408
|
* @example
|
|
9967
10409
|
* ```html
|
|
9968
|
-
* <div
|
|
9969
|
-
* Resizable content
|
|
9970
|
-
* </div>
|
|
10410
|
+
* <div (dbxResized)="onResized($event)" class="resizable-panel"></div>
|
|
9971
10411
|
* ```
|
|
9972
10412
|
*/
|
|
9973
10413
|
declare class DbxResizedDirective {
|