@dereekb/dbx-web 13.4.1 → 13.4.2
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 +51 -17
- package/fesm2022/dereekb-dbx-web-calendar.mjs.map +1 -1
- package/fesm2022/dereekb-dbx-web-mapbox.mjs +44 -12
- package/fesm2022/dereekb-dbx-web-mapbox.mjs.map +1 -1
- package/fesm2022/dereekb-dbx-web-table.mjs +48 -10
- package/fesm2022/dereekb-dbx-web-table.mjs.map +1 -1
- package/fesm2022/dereekb-dbx-web.mjs +398 -149
- package/fesm2022/dereekb-dbx-web.mjs.map +1 -1
- package/package.json +6 -6
- package/types/dereekb-dbx-web-calendar.d.ts +40 -2
- package/types/dereekb-dbx-web-mapbox.d.ts +27 -1
- package/types/dereekb-dbx-web-table.d.ts +47 -6
- package/types/dereekb-dbx-web.d.ts +445 -89
|
@@ -311,9 +311,13 @@ declare class DbxActionSnackbarComponent implements AfterViewInit {
|
|
|
311
311
|
* action event and optional undo configuration.
|
|
312
312
|
*/
|
|
313
313
|
interface DbxActionSnackbarGeneratorInput<T = unknown, O = unknown> {
|
|
314
|
-
/**
|
|
314
|
+
/**
|
|
315
|
+
* The action snackbar event that triggered the generator.
|
|
316
|
+
*/
|
|
315
317
|
readonly event: DbxActionSnackbarEvent<O>;
|
|
316
|
-
/**
|
|
318
|
+
/**
|
|
319
|
+
* Optional undo action configuration, only applied on success events.
|
|
320
|
+
*/
|
|
317
321
|
readonly undo?: Maybe<DbxActionSnackbarGeneratorUndoInput<T, O>>;
|
|
318
322
|
}
|
|
319
323
|
/**
|
|
@@ -326,9 +330,13 @@ type DbxActionSnackbarGeneratorUndoInput<T = unknown, O = unknown> = Getter<DbxA
|
|
|
326
330
|
* and how to obtain the undo action source reference.
|
|
327
331
|
*/
|
|
328
332
|
interface DbxActionSnackbarGeneratorUndoInputConfig<T = unknown, O = unknown> {
|
|
329
|
-
/**
|
|
333
|
+
/**
|
|
334
|
+
* How long the undo button remains visible in the snackbar.
|
|
335
|
+
*/
|
|
330
336
|
readonly duration?: Milliseconds;
|
|
331
|
-
/**
|
|
337
|
+
/**
|
|
338
|
+
* Factory that returns the action context source reference to trigger for undo.
|
|
339
|
+
*/
|
|
332
340
|
readonly getUndoAction: Getter<DbxActionContextSourceReference<T, O>>;
|
|
333
341
|
}
|
|
334
342
|
/**
|
|
@@ -341,13 +349,21 @@ type DbxActionSnackbarDisplayConfigGeneratorFunction = <T = unknown, O = unknown
|
|
|
341
349
|
* Each property maps a loading state (idle, loading, success, error) to its message configuration.
|
|
342
350
|
*/
|
|
343
351
|
interface DbxMakeActionSnackbarGeneratorConfiguration {
|
|
344
|
-
/**
|
|
352
|
+
/**
|
|
353
|
+
* Configuration shown when the action is idle.
|
|
354
|
+
*/
|
|
345
355
|
readonly idle?: GetterOrValue<DbxMakeActionSnackbarGeneratorEventConfiguration>;
|
|
346
|
-
/**
|
|
356
|
+
/**
|
|
357
|
+
* Configuration shown while the action is loading.
|
|
358
|
+
*/
|
|
347
359
|
readonly loading?: GetterOrValue<DbxMakeActionSnackbarGeneratorEventConfiguration>;
|
|
348
|
-
/**
|
|
360
|
+
/**
|
|
361
|
+
* Configuration shown when the action succeeds.
|
|
362
|
+
*/
|
|
349
363
|
readonly success?: GetterOrValue<DbxMakeActionSnackbarGeneratorEventConfiguration>;
|
|
350
|
-
/**
|
|
364
|
+
/**
|
|
365
|
+
* Configuration shown when the action fails.
|
|
366
|
+
*/
|
|
351
367
|
readonly error?: GetterOrValue<DbxMakeActionSnackbarGeneratorEventConfiguration>;
|
|
352
368
|
}
|
|
353
369
|
/**
|
|
@@ -400,15 +416,25 @@ interface DbxActionSnackbarEventMakeConfig {
|
|
|
400
416
|
* positioning, default durations, and per-type message configurations.
|
|
401
417
|
*/
|
|
402
418
|
interface DbxActionSnackbarServiceConfig<C = unknown> {
|
|
403
|
-
/**
|
|
419
|
+
/**
|
|
420
|
+
* Component class to render inside the snackbar. Defaults to {@link DbxActionSnackbarComponent}.
|
|
421
|
+
*/
|
|
404
422
|
readonly componentClass: Type<C>;
|
|
405
|
-
/**
|
|
423
|
+
/**
|
|
424
|
+
* Snackbar positioning overrides.
|
|
425
|
+
*/
|
|
406
426
|
readonly snackbar?: Pick<MatSnackBarConfig, 'horizontalPosition' | 'verticalPosition'>;
|
|
407
|
-
/**
|
|
427
|
+
/**
|
|
428
|
+
* Default duration for snackbars without an action.
|
|
429
|
+
*/
|
|
408
430
|
readonly defaultDuration?: Milliseconds;
|
|
409
|
-
/**
|
|
431
|
+
/**
|
|
432
|
+
* Default duration for snackbars that include an undo action.
|
|
433
|
+
*/
|
|
410
434
|
readonly defaultUndoDuration?: Milliseconds;
|
|
411
|
-
/**
|
|
435
|
+
/**
|
|
436
|
+
* Per-type message configurations (e.g. "save", "create", "delete").
|
|
437
|
+
*/
|
|
412
438
|
readonly eventTypeConfigs: DbxActionSnackbarEventMakeConfig;
|
|
413
439
|
}
|
|
414
440
|
/**
|
|
@@ -439,6 +465,7 @@ declare class DbxActionSnackbarService<C = DbxActionSnackbarComponent> {
|
|
|
439
465
|
*
|
|
440
466
|
* @param type - The snackbar type key (e.g. "save", "delete"), or undefined to use "none".
|
|
441
467
|
* @param input - The generator input containing the event and optional undo configuration.
|
|
468
|
+
* @returns The generated display configuration, or `undefined` if no config is registered for the given type.
|
|
442
469
|
*/
|
|
443
470
|
generateDisplayConfig<T = unknown, O = unknown>(type: Maybe<DbxActionSnackbarType>, input: DbxActionSnackbarGeneratorInput<T, O>): Maybe<DbxActionSnackbarDisplayConfig<T, O>>;
|
|
444
471
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxActionSnackbarService<any>, never>;
|
|
@@ -480,7 +507,7 @@ declare class DbxActionSnackbarDirective<T = unknown, O = unknown> implements On
|
|
|
480
507
|
protected readonly _sub: _dereekb_rxjs.SubscriptionObject<rxjs.Unsubscribable>;
|
|
481
508
|
ngOnInit(): void;
|
|
482
509
|
protected buildConfigurationForEvent(event: DbxActionSnackbarEvent<O>): Maybe<DbxActionSnackbarDisplayConfig<T, O>>;
|
|
483
|
-
protected showSnackbarForConfiguration(config: DbxActionSnackbarDisplayConfig<T, O>,
|
|
510
|
+
protected showSnackbarForConfiguration(config: DbxActionSnackbarDisplayConfig<T, O>, _event: DbxActionSnackbarEvent<O>): void;
|
|
484
511
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxActionSnackbarDirective<any, any>, never>;
|
|
485
512
|
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<DbxActionSnackbarDirective<any, any>, "[dbxActionSnackbar]", never, { "dbxActionSnackbarDefault": { "alias": "dbxActionSnackbarDefault"; "required": false; "isSignal": true; }; "dbxActionSnackbarUndo": { "alias": "dbxActionSnackbarUndo"; "required": false; "isSignal": true; }; "dbxActionSnackbar": { "alias": "dbxActionSnackbar"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
|
|
486
513
|
}
|
|
@@ -623,6 +650,9 @@ declare abstract class DbxPromptConfirm {
|
|
|
623
650
|
/**
|
|
624
651
|
* Provides a {@link DbxPromptConfirm} implementation for dependency injection.
|
|
625
652
|
*
|
|
653
|
+
* @param sourceType - The concrete class that implements {@link DbxPromptConfirm}
|
|
654
|
+
* @returns An array of providers that register the given type as the {@link DbxPromptConfirm} implementation
|
|
655
|
+
*
|
|
626
656
|
* @example
|
|
627
657
|
* ```ts
|
|
628
658
|
* @Directive({ providers: provideDbxPromptConfirm(MyConfirmDirective) })
|
|
@@ -847,6 +877,9 @@ declare const DBX_THEME_COLORS: DbxThemeColor[];
|
|
|
847
877
|
* dbxColorBackground('primary'); // 'dbx-primary-bg'
|
|
848
878
|
* dbxColorBackground(undefined); // 'dbx-default'
|
|
849
879
|
* ```
|
|
880
|
+
*
|
|
881
|
+
* @param color - the theme color to convert, or nullish/empty for the default class
|
|
882
|
+
* @returns the CSS class name for the themed background (e.g., `'dbx-primary-bg'` or `'dbx-default'`)
|
|
850
883
|
*/
|
|
851
884
|
declare function dbxColorBackground(color: Maybe<DbxThemeColor | ''>): CssClass;
|
|
852
885
|
|
|
@@ -1028,18 +1061,37 @@ declare class DbxAvatarViewService {
|
|
|
1028
1061
|
* Resolves the injection component configuration for the given avatar context.
|
|
1029
1062
|
*
|
|
1030
1063
|
* Falls back to the default component config if no custom resolver is configured or if it returns null.
|
|
1064
|
+
*
|
|
1065
|
+
* @param context - the avatar context used to resolve the appropriate component configuration
|
|
1066
|
+
* @returns the resolved injection component config, or the default if no custom resolver matches
|
|
1031
1067
|
*/
|
|
1032
1068
|
avatarComponentForContext(context: DbxAvatarContext): DbxAvatarInjectionComponentConfig;
|
|
1033
1069
|
get defaultAvatarUrl(): Maybe<string>;
|
|
1034
1070
|
get defaultAvatarIcon(): Maybe<string>;
|
|
1035
1071
|
get defaultAvatarErrorIcon(): Maybe<string>;
|
|
1036
|
-
/**
|
|
1072
|
+
/**
|
|
1073
|
+
* Sets the default avatar image URL used when no context-specific URL is provided.
|
|
1074
|
+
*
|
|
1075
|
+
* @param url - the URL to use as the default avatar image, or nullish to clear
|
|
1076
|
+
*/
|
|
1037
1077
|
setDefaultAvatarUrl(url: Maybe<WebsitePath | WebsiteUrlWithPrefix>): void;
|
|
1038
|
-
/**
|
|
1078
|
+
/**
|
|
1079
|
+
* Sets the default Material icon name used as a fallback when no avatar image is available.
|
|
1080
|
+
*
|
|
1081
|
+
* @param icon - the Material icon name to use, or nullish to clear
|
|
1082
|
+
*/
|
|
1039
1083
|
setDefaultAvatarIcon(icon: Maybe<string>): void;
|
|
1040
|
-
/**
|
|
1084
|
+
/**
|
|
1085
|
+
* Sets the Material icon name displayed when the avatar image fails to load.
|
|
1086
|
+
*
|
|
1087
|
+
* @param icon - the Material icon name to display on image load error, or nullish to clear
|
|
1088
|
+
*/
|
|
1041
1089
|
setDefaultAvatarErrorIcon(icon: Maybe<string>): void;
|
|
1042
|
-
/**
|
|
1090
|
+
/**
|
|
1091
|
+
* Overrides the default component used to render avatars when no context-specific component is resolved.
|
|
1092
|
+
*
|
|
1093
|
+
* @param config - the injection component config to use as the new default
|
|
1094
|
+
*/
|
|
1043
1095
|
setDefaultAvatarComponentConfig(config: DbxAvatarInjectionComponentConfig): void;
|
|
1044
1096
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxAvatarViewService, never>;
|
|
1045
1097
|
static ɵprov: _angular_core.ɵɵInjectableDeclaration<DbxAvatarViewService>;
|
|
@@ -1400,6 +1452,8 @@ declare class TwoColumnsContextStore extends ComponentStore<TwoColumnsState> {
|
|
|
1400
1452
|
* })
|
|
1401
1453
|
* export class MyColumnLayoutComponent { }
|
|
1402
1454
|
* ```
|
|
1455
|
+
*
|
|
1456
|
+
* @returns an array of Angular providers that supply a new {@link TwoColumnsContextStore}
|
|
1403
1457
|
*/
|
|
1404
1458
|
declare function provideTwoColumnsContext(): Provider[];
|
|
1405
1459
|
|
|
@@ -1532,7 +1586,7 @@ declare class DbxTwoColumnComponent {
|
|
|
1532
1586
|
} | undefined>;
|
|
1533
1587
|
protected readonly _reverseSizingEffect: _angular_core.EffectRef;
|
|
1534
1588
|
protected readonly _hasRightContentEffect: _angular_core.EffectRef;
|
|
1535
|
-
viewResized(
|
|
1589
|
+
viewResized(_event: ResizedEvent): void;
|
|
1536
1590
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxTwoColumnComponent, never>;
|
|
1537
1591
|
static ɵcmp: _angular_core.ɵɵComponentDeclaration<DbxTwoColumnComponent, "dbx-two-column", ["columns"], { "reverseSizing": { "alias": "reverseSizing"; "required": false; "isSignal": true; }; "inSectionPage": { "alias": "inSectionPage"; "required": false; "isSignal": true; }; "hasRightContent": { "alias": "hasRightContent"; "required": false; "isSignal": true; }; }, {}, never, ["[left]", "[right]"], true, never>;
|
|
1538
1592
|
}
|
|
@@ -1761,6 +1815,9 @@ type CompactModeOption = CompactMode | boolean;
|
|
|
1761
1815
|
* compactModeFromInput(true); // CompactMode.COMPACT
|
|
1762
1816
|
* compactModeFromInput(CompactMode.FULL); // CompactMode.FULL
|
|
1763
1817
|
* ```
|
|
1818
|
+
*
|
|
1819
|
+
* @param input - a boolean or CompactMode value to normalize
|
|
1820
|
+
* @returns the normalized CompactMode enum value
|
|
1764
1821
|
*/
|
|
1765
1822
|
declare function compactModeFromInput(input: CompactMode | boolean): CompactMode;
|
|
1766
1823
|
/**
|
|
@@ -1775,6 +1832,10 @@ declare function compactModeFromInput(input: CompactMode | boolean): CompactMode
|
|
|
1775
1832
|
* defaultMode: CompactMode.FULL
|
|
1776
1833
|
* });
|
|
1777
1834
|
* ```
|
|
1835
|
+
*
|
|
1836
|
+
* @param mode$ - an observable of the current compact mode, or nullish to use the default
|
|
1837
|
+
* @param config - the mapping configuration containing values for each mode and an optional default
|
|
1838
|
+
* @returns an observable emitting the mapped value corresponding to the current compact mode
|
|
1778
1839
|
*/
|
|
1779
1840
|
declare function mapCompactModeObs<T>(mode$: Maybe<Observable<CompactMode>>, config: CompactModeDefaultOptions<T>): Observable<Maybe<T>>;
|
|
1780
1841
|
|
|
@@ -2097,10 +2158,17 @@ type ScreenMediaHeightType = 'tiny' | 'normal';
|
|
|
2097
2158
|
* screenMediaWidthTypeIsActive('tablet', 'small'); // true
|
|
2098
2159
|
* screenMediaWidthTypeIsActive('micro', 'tablet'); // false
|
|
2099
2160
|
* ```
|
|
2161
|
+
*
|
|
2162
|
+
* @returns `true` if the current width type meets or exceeds the breakpoint
|
|
2100
2163
|
*/
|
|
2101
2164
|
declare function screenMediaWidthTypeIsActive(current: ScreenMediaWidthType, breakpoint: ScreenMediaWidthType): boolean;
|
|
2102
2165
|
/**
|
|
2103
2166
|
* Compares two {@link ScreenMediaWidthType} values using a custom comparator on their numeric sizes.
|
|
2167
|
+
*
|
|
2168
|
+
* @param a - the first screen width type
|
|
2169
|
+
* @param b - the second screen width type
|
|
2170
|
+
* @param compare - a comparator function applied to the numeric size values of `a` and `b`
|
|
2171
|
+
* @returns the result of applying the comparator to the mapped numeric sizes
|
|
2104
2172
|
*/
|
|
2105
2173
|
declare function compareScreenMediaWidthTypes(a: ScreenMediaWidthType, b: ScreenMediaWidthType, compare: (a: number, b: number) => boolean): boolean;
|
|
2106
2174
|
|
|
@@ -2258,6 +2326,7 @@ interface DbxValueListItem<T, M = unknown> {
|
|
|
2258
2326
|
type DbxValueListItemDecisionFunction<T> = DecisionFunction<DbxValueListItem<T>>;
|
|
2259
2327
|
/**
|
|
2260
2328
|
* Convenience function for mapping a DecisionFunction for a value to a DecisionFunction for a DbxValueListItem with the same value type.
|
|
2329
|
+
*
|
|
2261
2330
|
* @param decisionFunction
|
|
2262
2331
|
* @returns
|
|
2263
2332
|
*/
|
|
@@ -2278,6 +2347,9 @@ interface AbstractDbxValueListViewConfig<T, I extends DbxValueListItem<T> = DbxV
|
|
|
2278
2347
|
}
|
|
2279
2348
|
/**
|
|
2280
2349
|
* Default mapping function that wraps each raw value into a {@link DbxValueListItem} with only the `itemValue` property set.
|
|
2350
|
+
*
|
|
2351
|
+
* @param itemValues The raw values to wrap as list items
|
|
2352
|
+
* @returns An observable emitting the values wrapped in {@link DbxValueListItem} objects
|
|
2281
2353
|
*/
|
|
2282
2354
|
declare const DEFAULT_DBX_VALUE_LIST_CONFIG_MAP_VALUES: <T, I extends DbxValueListItem<T>>(itemValues: T[]) => Observable<I[]>;
|
|
2283
2355
|
/**
|
|
@@ -2290,6 +2362,10 @@ type DbxValueListItemConfig<T, I extends DbxValueListItem<T> = DbxValueListItem<
|
|
|
2290
2362
|
/**
|
|
2291
2363
|
* Maps raw values into an observable of {@link DbxValueListItemConfig} items, applying the list view config's mapping function and attaching injection configuration.
|
|
2292
2364
|
*
|
|
2365
|
+
* @param listViewConfig The list view configuration containing the component and optional mapping function
|
|
2366
|
+
* @param itemValues The raw values to map into configured list items
|
|
2367
|
+
* @returns An observable emitting the mapped and configured list item configs
|
|
2368
|
+
*
|
|
2293
2369
|
* @example
|
|
2294
2370
|
* ```ts
|
|
2295
2371
|
* const items$ = mapValuesToValuesListItemConfigObs(listViewConfig, rawValues);
|
|
@@ -2297,11 +2373,11 @@ type DbxValueListItemConfig<T, I extends DbxValueListItem<T> = DbxValueListItem<
|
|
|
2297
2373
|
*/
|
|
2298
2374
|
declare function mapValuesToValuesListItemConfigObs<T, I extends DbxValueListItem<T>, V = unknown>(listViewConfig: AbstractDbxValueListViewConfig<T, I, V>, itemValues: T[]): Observable<DbxValueListItemConfig<T, I, V>[]>;
|
|
2299
2375
|
/**
|
|
2300
|
-
* Adds
|
|
2376
|
+
* Adds injection component configuration and meta configuration to each list item, producing fully configured {@link DbxValueListItemConfig} entries ready for rendering.
|
|
2301
2377
|
*
|
|
2302
|
-
* @param listViewConfig
|
|
2303
|
-
* @param listItems
|
|
2304
|
-
* @returns
|
|
2378
|
+
* @param listViewConfig The list view configuration providing injection component config and optional meta config
|
|
2379
|
+
* @param listItems The list items to augment with configuration
|
|
2380
|
+
* @returns The list items extended with injection component configuration attached
|
|
2305
2381
|
*/
|
|
2306
2382
|
declare function addConfigToValueListItems<T, I extends DbxValueListItem<T>, V = unknown>(listViewConfig: AbstractDbxValueListViewConfig<T, I, V>, listItems: I[]): DbxValueListItemConfig<T, I, V>[];
|
|
2307
2383
|
/**
|
|
@@ -2314,6 +2390,9 @@ declare abstract class DbxValueListView<T, I extends DbxValueListItem<T> = DbxVa
|
|
|
2314
2390
|
/**
|
|
2315
2391
|
* Registers a component as a {@link DbxValueListView} provider for dependency injection.
|
|
2316
2392
|
*
|
|
2393
|
+
* @param sourceType The component class type to register as the list view provider
|
|
2394
|
+
* @returns An array of Angular providers that bind the given component to {@link DbxValueListView}
|
|
2395
|
+
*
|
|
2317
2396
|
* @example
|
|
2318
2397
|
* ```ts
|
|
2319
2398
|
* @Component({
|
|
@@ -2398,6 +2477,9 @@ declare abstract class DbxListView<T, S extends ListLoadingState<T> = ListLoadin
|
|
|
2398
2477
|
* })
|
|
2399
2478
|
* export class MyCustomListViewComponent extends DbxListView<MyItem> { ... }
|
|
2400
2479
|
* ```
|
|
2480
|
+
*
|
|
2481
|
+
* @param sourceType - the component class to register as the DbxListView provider
|
|
2482
|
+
* @returns an array of Angular providers that wire up the component as a DbxListView
|
|
2401
2483
|
*/
|
|
2402
2484
|
declare function provideDbxListView<V extends DbxListView<any>>(sourceType: Type<V>): Provider[];
|
|
2403
2485
|
|
|
@@ -2420,6 +2502,9 @@ declare abstract class DbxValueListItemModifier<T = unknown, I extends DbxValueL
|
|
|
2420
2502
|
* })
|
|
2421
2503
|
* export class MyModifierDirective extends DbxValueListItemModifier<MyItem> { ... }
|
|
2422
2504
|
* ```
|
|
2505
|
+
*
|
|
2506
|
+
* @param sourceType - the directive class to register as the DbxValueListItemModifier provider
|
|
2507
|
+
* @returns an array of Angular providers that wire up the directive as a DbxValueListItemModifier
|
|
2423
2508
|
*/
|
|
2424
2509
|
declare function provideDbxValueListViewModifier<V extends DbxValueListItemModifier>(sourceType: Type<V>): Provider[];
|
|
2425
2510
|
/**
|
|
@@ -2435,6 +2520,10 @@ type ListItemModifier<T, I extends DbxValueListItem<T> = DbxValueListItem<T>> =
|
|
|
2435
2520
|
* item.selected = item.itemValue.isImportant;
|
|
2436
2521
|
* });
|
|
2437
2522
|
* ```
|
|
2523
|
+
*
|
|
2524
|
+
* @param key - a unique string identifier for this modifier in the modifier map
|
|
2525
|
+
* @param modify - the function that mutates list item properties during rendering
|
|
2526
|
+
* @returns a new ListItemModifier with the given key and modification function
|
|
2438
2527
|
*/
|
|
2439
2528
|
declare function listItemModifier<T, I extends DbxValueListItem<T> = DbxValueListItem<T>>(key: string, modify: ModifierFunction<I>): ListItemModifier<T, I>;
|
|
2440
2529
|
|
|
@@ -2458,7 +2547,7 @@ declare abstract class AbstractDbxValueListViewDirective<T, I extends DbxValueLi
|
|
|
2458
2547
|
/**
|
|
2459
2548
|
* A group of DbxValueListItem values, grouped by common data, name, and id.
|
|
2460
2549
|
*/
|
|
2461
|
-
interface DbxValueListItemGroup<G, T, I extends DbxValueListItem<T>, H = unknown, F = unknown> extends Omit<DbxValueListItem<
|
|
2550
|
+
interface DbxValueListItemGroup<G, T, I extends DbxValueListItem<T>, H = unknown, F = unknown> extends Omit<DbxValueListItem<unknown>, 'itemValue' | 'icon'>, Readonly<Required<UniqueModel>> {
|
|
2462
2551
|
readonly data: G;
|
|
2463
2552
|
readonly items: DbxValueListItemConfig<T, I>[];
|
|
2464
2553
|
/**
|
|
@@ -2484,6 +2573,9 @@ interface DbxValueListItemGroup<G, T, I extends DbxValueListItem<T>, H = unknown
|
|
|
2484
2573
|
type DbxValueListViewGroupValuesFunction<G, T, I extends DbxValueListItem<T>, H = unknown, F = unknown> = (items: DbxValueListItemConfig<T, I>[]) => ObservableOrValue<DbxValueListItemGroup<G, T, I, H, F>[]>;
|
|
2485
2574
|
/**
|
|
2486
2575
|
* Default grouping function that places all items into a single unnamed group.
|
|
2576
|
+
*
|
|
2577
|
+
* @param items The flat list of configured list items to group
|
|
2578
|
+
* @returns An array containing a single group with all input items
|
|
2487
2579
|
*/
|
|
2488
2580
|
declare const defaultDbxValueListViewGroupValuesFunction: <T, I extends DbxValueListItem<T>>(items: DbxValueListItemConfig<T, I>[]) => DbxValueListItemGroup<unknown, T, I, unknown, unknown>[];
|
|
2489
2581
|
/**
|
|
@@ -2499,15 +2591,20 @@ declare abstract class DbxValueListViewGroupDelegate<G, T, I extends DbxValueLis
|
|
|
2499
2591
|
/**
|
|
2500
2592
|
* Creates a default {@link DbxValueListViewGroupDelegate} that places all items into a single ungrouped list.
|
|
2501
2593
|
*
|
|
2594
|
+
* @returns A group delegate that places all items into one unnamed group
|
|
2595
|
+
*
|
|
2502
2596
|
* @example
|
|
2503
2597
|
* ```ts
|
|
2504
2598
|
* const delegate = defaultDbxValueListViewGroupDelegate<MyItem>();
|
|
2505
2599
|
* ```
|
|
2506
2600
|
*/
|
|
2507
|
-
declare function defaultDbxValueListViewGroupDelegate<T, I extends DbxValueListItem<T>>(): DbxValueListViewGroupDelegate<
|
|
2601
|
+
declare function defaultDbxValueListViewGroupDelegate<T, I extends DbxValueListItem<T>>(): DbxValueListViewGroupDelegate<unknown, T, I>;
|
|
2508
2602
|
/**
|
|
2509
2603
|
* Registers a class as a {@link DbxValueListViewGroupDelegate} provider for dependency injection.
|
|
2510
2604
|
*
|
|
2605
|
+
* @param sourceType The class type to register as the group delegate provider
|
|
2606
|
+
* @returns An array of Angular providers that bind the given class to {@link DbxValueListViewGroupDelegate}
|
|
2607
|
+
*
|
|
2511
2608
|
* @example
|
|
2512
2609
|
* ```ts
|
|
2513
2610
|
* @Directive({
|
|
@@ -2555,6 +2652,10 @@ declare class DbxValueListViewContentGroupComponent<G, T, I extends DbxValueList
|
|
|
2555
2652
|
*
|
|
2556
2653
|
* Uses the item's {@link DbxValueListItem.key} when available for stable identity across
|
|
2557
2654
|
* data updates, falling back to a prefixed index string to avoid collisions with key values.
|
|
2655
|
+
*
|
|
2656
|
+
* @param index - the item's position index in the list
|
|
2657
|
+
* @param item - the list item whose identity key is resolved
|
|
2658
|
+
* @returns the item's key, itemValue key/id, or a prefixed index string as a fallback
|
|
2558
2659
|
*/
|
|
2559
2660
|
declare const DEFAULT_VALUE_LIST_VIEW_CONTENT_COMPONENT_TRACK_BY_FUNCTION: TrackByFunction<DbxValueListItem<unknown>>;
|
|
2560
2661
|
/**
|
|
@@ -2992,6 +3093,9 @@ declare const DBX_LIST_ITEM_DISABLE_RIPPLE_LIST_ITEM_MODIFIER_KEY = "disable_rip
|
|
|
2992
3093
|
/**
|
|
2993
3094
|
* Default decision function that disables ripple on items that already have ripple disabled,
|
|
2994
3095
|
* lack an anchor, or have an anchor with no navigation target.
|
|
3096
|
+
*
|
|
3097
|
+
* @param item - the list item to evaluate for ripple disabling
|
|
3098
|
+
* @returns `true` if the ripple should be disabled for this item
|
|
2995
3099
|
*/
|
|
2996
3100
|
declare const DBX_LIST_ITEM_DEFAULT_DISABLE_FUNCTION: DbxValueListItemDecisionFunction<unknown>;
|
|
2997
3101
|
/**
|
|
@@ -3017,6 +3121,9 @@ declare class DbxListItemDisableRippleModifierDirective<T> extends AbstractDbxVa
|
|
|
3017
3121
|
declare const DBX_LIST_ITEM_IS_SELECTED_ITEM_MODIFIER_KEY = "is_selected_item_modifier";
|
|
3018
3122
|
/**
|
|
3019
3123
|
* Default decision function that returns the item's current `selected` state (defaulting to false).
|
|
3124
|
+
*
|
|
3125
|
+
* @param item - the list item to check for selection
|
|
3126
|
+
* @returns `true` if the item is currently selected, `false` otherwise
|
|
3020
3127
|
*/
|
|
3021
3128
|
declare const DEFAULT_DBX_LIST_ITEM_IS_SELECTED_FUNCTION: DbxValueListItemDecisionFunction<unknown>;
|
|
3022
3129
|
/**
|
|
@@ -3234,6 +3341,9 @@ declare abstract class DbxListViewWrapper<T = unknown, S extends ListLoadingStat
|
|
|
3234
3341
|
* })
|
|
3235
3342
|
* export class MyListWrapperComponent extends DbxListViewWrapper<MyItem> { ... }
|
|
3236
3343
|
* ```
|
|
3344
|
+
*
|
|
3345
|
+
* @param sourceType - the component class to register as the DbxListViewWrapper provider
|
|
3346
|
+
* @returns an array of Angular providers that wire up the component as a DbxListViewWrapper
|
|
3237
3347
|
*/
|
|
3238
3348
|
declare function provideDbxListViewWrapper<V extends DbxListViewWrapper>(sourceType: Type<V>): Provider[];
|
|
3239
3349
|
|
|
@@ -3306,6 +3416,10 @@ declare class DbxListModule {
|
|
|
3306
3416
|
|
|
3307
3417
|
/**
|
|
3308
3418
|
* Angular {@link TrackByFunction} that tracks {@link UniqueModel} items by their `id` property.
|
|
3419
|
+
*
|
|
3420
|
+
* @param index - the item's index in the iterable
|
|
3421
|
+
* @param model - the model whose `id` is used as the tracking identity
|
|
3422
|
+
* @returns the model's unique `id` value
|
|
3309
3423
|
*/
|
|
3310
3424
|
declare const TRACK_BY_MODEL_ID: TrackByFunction<UniqueModel>;
|
|
3311
3425
|
/**
|
|
@@ -3315,10 +3429,16 @@ declare const TRACK_BY_MODEL_ID: TrackByFunction<UniqueModel>;
|
|
|
3315
3429
|
* ```ts
|
|
3316
3430
|
* readonly trackBy = trackByUniqueIdentifier<MyModel>();
|
|
3317
3431
|
* ```
|
|
3432
|
+
*
|
|
3433
|
+
* @returns a TrackByFunction that uses the item's `id` for identity tracking
|
|
3318
3434
|
*/
|
|
3319
3435
|
declare function trackByUniqueIdentifier<T extends UniqueModel>(): TrackByFunction<T>;
|
|
3320
3436
|
/**
|
|
3321
3437
|
* Angular {@link TrackByFunction} that tracks {@link ModelKeyRef} items by their `key` property.
|
|
3438
|
+
*
|
|
3439
|
+
* @param index - the item's index in the iterable
|
|
3440
|
+
* @param model - the model whose `key` is used as the tracking identity
|
|
3441
|
+
* @returns the model's `key` value
|
|
3322
3442
|
*/
|
|
3323
3443
|
declare const TRACK_BY_MODEL_KEY: TrackByFunction<ModelKeyRef>;
|
|
3324
3444
|
/**
|
|
@@ -3328,6 +3448,8 @@ declare const TRACK_BY_MODEL_KEY: TrackByFunction<ModelKeyRef>;
|
|
|
3328
3448
|
* ```ts
|
|
3329
3449
|
* readonly trackBy = trackByModelKeyRef<MyModelRef>();
|
|
3330
3450
|
* ```
|
|
3451
|
+
*
|
|
3452
|
+
* @returns a TrackByFunction that uses the item's `key` for identity tracking
|
|
3331
3453
|
*/
|
|
3332
3454
|
declare function trackByModelKeyRef<T extends ModelKeyRef>(): TrackByFunction<T>;
|
|
3333
3455
|
|
|
@@ -3813,22 +3935,32 @@ declare class DbxStyleService implements Destroyable {
|
|
|
3813
3935
|
toggleSuffix(suffix: DbxStyleClassSuffix, toggle?: Maybe<boolean>): void;
|
|
3814
3936
|
/**
|
|
3815
3937
|
* Returns the current style class suffix, if one is set.
|
|
3938
|
+
*
|
|
3939
|
+
* @returns the currently active style class suffix, or undefined if none is set
|
|
3816
3940
|
*/
|
|
3817
3941
|
get currentStyleClassSuffix(): Maybe<DbxStyleClassCleanSuffix>;
|
|
3818
3942
|
/**
|
|
3819
3943
|
* Directly sets the active style class suffix, or clears it if null/undefined.
|
|
3944
|
+
*
|
|
3945
|
+
* @param suffix - the suffix to activate, or nullish to clear the current suffix
|
|
3820
3946
|
*/
|
|
3821
3947
|
setStyleClassSuffix(suffix: Maybe<DbxStyleClassSuffix>): void;
|
|
3822
3948
|
/**
|
|
3823
3949
|
* Updates the default style configuration used when no override config is set.
|
|
3950
|
+
*
|
|
3951
|
+
* @param defaultConfig - the style configuration to use as the new default
|
|
3824
3952
|
*/
|
|
3825
3953
|
setDefaultConfig(defaultConfig: DbxStyleConfig): void;
|
|
3826
3954
|
/**
|
|
3827
3955
|
* Overrides the active style configuration with the given value or observable.
|
|
3956
|
+
*
|
|
3957
|
+
* @param config - a style configuration value or observable to set as the active override
|
|
3828
3958
|
*/
|
|
3829
3959
|
setConfig(config: ObservableOrValue<DbxStyleConfig>): void;
|
|
3830
3960
|
/**
|
|
3831
3961
|
* Clears the active config override if it matches the given reference, reverting to the default config.
|
|
3962
|
+
*
|
|
3963
|
+
* @param config - the config reference to compare against the current override
|
|
3832
3964
|
*/
|
|
3833
3965
|
unsetConfig(config: ObservableOrValue<DbxStyleConfig>): void;
|
|
3834
3966
|
destroy(): void;
|
|
@@ -3854,6 +3986,9 @@ interface ProvideDbxStyleServiceConfig {
|
|
|
3854
3986
|
* ```ts
|
|
3855
3987
|
* provideDbxStyleService({ dbxStyleConfig: { style: 'my-app', suffixes: new Set(['dark']) } });
|
|
3856
3988
|
* ```
|
|
3989
|
+
*
|
|
3990
|
+
* @param config - configuration specifying the default style and its allowed suffixes
|
|
3991
|
+
* @returns environment providers for the DbxStyleService and its default config token
|
|
3857
3992
|
*/
|
|
3858
3993
|
declare function provideDbxStyleService(config: ProvideDbxStyleServiceConfig): EnvironmentProviders;
|
|
3859
3994
|
|
|
@@ -4047,14 +4182,22 @@ declare class DbxLinkifyService {
|
|
|
4047
4182
|
register(entries: ArrayOrValue<DbxLinkifyServiceEntry>, override?: boolean): void;
|
|
4048
4183
|
/**
|
|
4049
4184
|
* Returns the default entry.
|
|
4185
|
+
*
|
|
4186
|
+
* @returns the default linkify service entry, or undefined if none is registered
|
|
4050
4187
|
*/
|
|
4051
4188
|
getDefaultEntry(): Maybe<DbxLinkifyServiceEntry>;
|
|
4052
4189
|
/**
|
|
4053
4190
|
* Returns the entry for the given type.
|
|
4191
|
+
*
|
|
4192
|
+
* @param type - the linkify string type to look up
|
|
4193
|
+
* @returns the registered entry for the given type, or undefined if not found
|
|
4054
4194
|
*/
|
|
4055
4195
|
getEntryRegisteredForType(type: DbxLinkifyStringType): Maybe<DbxLinkifyServiceEntry>;
|
|
4056
4196
|
/**
|
|
4057
4197
|
* Returns the entry for the given type, or the default type if there is no entry registered or the input type is null/undefined.
|
|
4198
|
+
*
|
|
4199
|
+
* @param type - the linkify string type to look up, or nullish to retrieve the default entry
|
|
4200
|
+
* @returns the matching entry, or the default entry if the type is not provided
|
|
4058
4201
|
*/
|
|
4059
4202
|
getEntry(type?: Maybe<DbxLinkifyStringType>): Maybe<DbxLinkifyServiceEntry>;
|
|
4060
4203
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxLinkifyService, never>;
|
|
@@ -4086,6 +4229,9 @@ interface ProvideDbxLinkifyConfig {
|
|
|
4086
4229
|
* })
|
|
4087
4230
|
* });
|
|
4088
4231
|
* ```
|
|
4232
|
+
*
|
|
4233
|
+
* @param config - configuration containing the factory function for creating the linkify service config
|
|
4234
|
+
* @returns environment providers that register the DbxLinkifyServiceConfig
|
|
4089
4235
|
*/
|
|
4090
4236
|
declare function provideDbxLinkify(config: ProvideDbxLinkifyConfig): EnvironmentProviders;
|
|
4091
4237
|
|
|
@@ -4110,15 +4256,25 @@ declare class DbxChipDirective {
|
|
|
4110
4256
|
* Configuration for a single chip displayed by {@link DbxTextChipsComponent}.
|
|
4111
4257
|
*/
|
|
4112
4258
|
interface TextChip<T = unknown> {
|
|
4113
|
-
/**
|
|
4259
|
+
/**
|
|
4260
|
+
* Display label for the chip.
|
|
4261
|
+
*/
|
|
4114
4262
|
text: string;
|
|
4115
|
-
/**
|
|
4263
|
+
/**
|
|
4264
|
+
* Optional tooltip shown on hover.
|
|
4265
|
+
*/
|
|
4116
4266
|
tooltip?: string;
|
|
4117
|
-
/**
|
|
4267
|
+
/**
|
|
4268
|
+
* Whether the chip appears selected.
|
|
4269
|
+
*/
|
|
4118
4270
|
selected?: boolean;
|
|
4119
|
-
/**
|
|
4271
|
+
/**
|
|
4272
|
+
* Theme color applied to the chip.
|
|
4273
|
+
*/
|
|
4120
4274
|
color?: 'primary' | 'accent' | 'warn' | undefined;
|
|
4121
|
-
/**
|
|
4275
|
+
/**
|
|
4276
|
+
* Arbitrary data payload associated with the chip.
|
|
4277
|
+
*/
|
|
4122
4278
|
data?: T;
|
|
4123
4279
|
}
|
|
4124
4280
|
/**
|
|
@@ -4392,6 +4548,9 @@ interface OverrideClickElementEffectConfig {
|
|
|
4392
4548
|
* childClickTarget: this.buttonElementRef
|
|
4393
4549
|
* });
|
|
4394
4550
|
* ```
|
|
4551
|
+
*
|
|
4552
|
+
* @param config - configuration specifying the click target, child element to intercept, and optional disabled signal
|
|
4553
|
+
* @returns the created Angular effect reference
|
|
4395
4554
|
*/
|
|
4396
4555
|
declare function overrideClickElementEffect(config: OverrideClickElementEffectConfig): _angular_core.EffectRef;
|
|
4397
4556
|
|
|
@@ -4432,7 +4591,7 @@ declare class DbxTextModule {
|
|
|
4432
4591
|
|
|
4433
4592
|
declare class DbxLayoutModule {
|
|
4434
4593
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxLayoutModule, never>;
|
|
4435
|
-
static ɵmod: _angular_core.ɵɵNgModuleDeclaration<DbxLayoutModule, never,
|
|
4594
|
+
static ɵmod: _angular_core.ɵɵNgModuleDeclaration<DbxLayoutModule, never, [typeof DbxCompactDirective, typeof DbxFlexGroupDirective, typeof DbxFlexSizeDirective], [typeof DbxBarLayoutModule, typeof DbxCardBoxLayoutModule, typeof DbxColumnLayoutModule, typeof DbxCompactDirective, typeof DbxContentLayoutModule, typeof DbxFlagLayoutModule, typeof DbxFlexGroupDirective, typeof DbxFlexSizeDirective, typeof DbxSectionLayoutModule, typeof DbxStyleLayoutModule, typeof DbxTextModule]>;
|
|
4436
4595
|
static ɵinj: _angular_core.ɵɵInjectorDeclaration<DbxLayoutModule>;
|
|
4437
4596
|
}
|
|
4438
4597
|
|
|
@@ -4445,21 +4604,37 @@ type DbxButtonType = 'basic' | 'raised' | 'stroked' | 'flat' | 'tonal' | 'icon';
|
|
|
4445
4604
|
* over button type, colors, spinner appearance, and floating action button mode.
|
|
4446
4605
|
*/
|
|
4447
4606
|
interface DbxButtonStyle {
|
|
4448
|
-
/**
|
|
4607
|
+
/**
|
|
4608
|
+
* Material button variant.
|
|
4609
|
+
*/
|
|
4449
4610
|
readonly type?: DbxButtonType;
|
|
4450
|
-
/**
|
|
4611
|
+
/**
|
|
4612
|
+
* Progress spinner mode (determinate or indeterminate).
|
|
4613
|
+
*/
|
|
4451
4614
|
readonly mode?: ProgressSpinnerMode;
|
|
4452
|
-
/**
|
|
4615
|
+
/**
|
|
4616
|
+
* Material theme palette or custom theme color for the button.
|
|
4617
|
+
*/
|
|
4453
4618
|
readonly color?: ThemePalette | DbxThemeColor;
|
|
4454
|
-
/**
|
|
4619
|
+
/**
|
|
4620
|
+
* Material theme palette or custom theme color for the loading spinner.
|
|
4621
|
+
*/
|
|
4455
4622
|
readonly spinnerColor?: ThemePalette | DbxThemeColor;
|
|
4456
|
-
/**
|
|
4623
|
+
/**
|
|
4624
|
+
* Custom CSS background color for the button.
|
|
4625
|
+
*/
|
|
4457
4626
|
readonly customButtonColor?: string;
|
|
4458
|
-
/**
|
|
4627
|
+
/**
|
|
4628
|
+
* Custom CSS text color for the button label.
|
|
4629
|
+
*/
|
|
4459
4630
|
readonly customTextColor?: string;
|
|
4460
|
-
/**
|
|
4631
|
+
/**
|
|
4632
|
+
* Custom CSS color for the spinner stroke.
|
|
4633
|
+
*/
|
|
4461
4634
|
readonly customSpinnerColor?: string;
|
|
4462
|
-
/**
|
|
4635
|
+
/**
|
|
4636
|
+
* Whether to render as a floating action button (FAB).
|
|
4637
|
+
*/
|
|
4463
4638
|
readonly fab?: boolean;
|
|
4464
4639
|
}
|
|
4465
4640
|
|
|
@@ -4468,64 +4643,116 @@ interface DbxButtonStyle {
|
|
|
4468
4643
|
* colors, spinner behavior, and button type.
|
|
4469
4644
|
*/
|
|
4470
4645
|
interface DbxProgressButtonConfig {
|
|
4471
|
-
/**
|
|
4646
|
+
/**
|
|
4647
|
+
* Current working state. A boolean enables indeterminate mode; a number (0-100) enables determinate mode.
|
|
4648
|
+
*/
|
|
4472
4649
|
readonly working?: Maybe<DbxButtonWorking>;
|
|
4473
|
-
/**
|
|
4650
|
+
/**
|
|
4651
|
+
* Button label text.
|
|
4652
|
+
*/
|
|
4474
4653
|
readonly text?: Maybe<string>;
|
|
4475
|
-
/**
|
|
4654
|
+
/**
|
|
4655
|
+
* Text displayed alongside the spinner while working.
|
|
4656
|
+
*/
|
|
4476
4657
|
readonly spinnerText?: Maybe<string>;
|
|
4477
|
-
/**
|
|
4658
|
+
/**
|
|
4659
|
+
* Theme color for the button itself.
|
|
4660
|
+
*/
|
|
4478
4661
|
readonly buttonColor?: Maybe<ThemePalette | DbxThemeColor>;
|
|
4479
|
-
/**
|
|
4662
|
+
/**
|
|
4663
|
+
* Theme color for the progress spinner.
|
|
4664
|
+
*/
|
|
4480
4665
|
readonly spinnerColor?: Maybe<ThemePalette | DbxThemeColor>;
|
|
4481
|
-
/**
|
|
4666
|
+
/**
|
|
4667
|
+
* Theme color for the progress bar (bar mode only).
|
|
4668
|
+
*/
|
|
4482
4669
|
readonly barColor?: Maybe<ThemePalette | DbxThemeColor>;
|
|
4483
|
-
/**
|
|
4670
|
+
/**
|
|
4671
|
+
* When true, renders only the icon button without text.
|
|
4672
|
+
*/
|
|
4484
4673
|
readonly iconOnly?: Maybe<boolean>;
|
|
4485
|
-
/**
|
|
4674
|
+
/**
|
|
4675
|
+
* Explicit spinner diameter in pixels.
|
|
4676
|
+
*/
|
|
4486
4677
|
readonly spinnerSize?: Maybe<number>;
|
|
4487
|
-
/**
|
|
4678
|
+
/**
|
|
4679
|
+
* Ratio of spinner size relative to button height (0-1).
|
|
4680
|
+
*/
|
|
4488
4681
|
readonly spinnerRatio?: Maybe<number>;
|
|
4489
|
-
/**
|
|
4682
|
+
/**
|
|
4683
|
+
* Spinner mode: determinate or indeterminate.
|
|
4684
|
+
*/
|
|
4490
4685
|
readonly mode?: Maybe<ProgressSpinnerMode>;
|
|
4491
|
-
/**
|
|
4686
|
+
/**
|
|
4687
|
+
* Whether the button stretches to full container width.
|
|
4688
|
+
*/
|
|
4492
4689
|
readonly fullWidth?: Maybe<boolean>;
|
|
4493
|
-
/**
|
|
4690
|
+
/**
|
|
4691
|
+
* Whether the button is disabled.
|
|
4692
|
+
*/
|
|
4494
4693
|
readonly disabled?: Maybe<boolean>;
|
|
4495
|
-
/**
|
|
4694
|
+
/**
|
|
4695
|
+
* Custom inline styles applied to the button element.
|
|
4696
|
+
*/
|
|
4496
4697
|
readonly customStyle?: Maybe<{
|
|
4497
4698
|
[key: string]: string;
|
|
4498
4699
|
}>;
|
|
4499
|
-
/**
|
|
4700
|
+
/**
|
|
4701
|
+
* Custom CSS class applied to the button element.
|
|
4702
|
+
*/
|
|
4500
4703
|
readonly customClass?: Maybe<string>;
|
|
4501
|
-
/**
|
|
4704
|
+
/**
|
|
4705
|
+
* Custom CSS color for the spinner stroke. Overrides `spinnerColor` when provided.
|
|
4706
|
+
*/
|
|
4502
4707
|
readonly customSpinnerColor?: Maybe<string>;
|
|
4503
|
-
/**
|
|
4708
|
+
/**
|
|
4709
|
+
* Icon configuration for the button.
|
|
4710
|
+
*/
|
|
4504
4711
|
readonly buttonIcon?: Maybe<DbxProgressButtonIcon>;
|
|
4505
|
-
/**
|
|
4712
|
+
/**
|
|
4713
|
+
* Identifier used for matching against global configuration.
|
|
4714
|
+
*/
|
|
4506
4715
|
readonly id?: Maybe<string>;
|
|
4507
|
-
/**
|
|
4716
|
+
/**
|
|
4717
|
+
* Material button variant to render.
|
|
4718
|
+
*/
|
|
4508
4719
|
readonly buttonType?: Maybe<DbxButtonType>;
|
|
4509
|
-
/**
|
|
4720
|
+
/**
|
|
4721
|
+
* HTML `type` attribute for the underlying button element (e.g. "submit", "button").
|
|
4722
|
+
*/
|
|
4510
4723
|
readonly buttonTypeAttribute?: Maybe<string>;
|
|
4511
|
-
/**
|
|
4724
|
+
/**
|
|
4725
|
+
* Whether to render as a floating action button (FAB).
|
|
4726
|
+
*/
|
|
4512
4727
|
readonly fab?: Maybe<boolean>;
|
|
4513
4728
|
}
|
|
4514
4729
|
/**
|
|
4515
4730
|
* Configuration for the icon displayed inside a progress button.
|
|
4516
4731
|
*/
|
|
4517
4732
|
interface DbxProgressButtonIcon {
|
|
4518
|
-
/**
|
|
4733
|
+
/**
|
|
4734
|
+
* Theme color for the icon.
|
|
4735
|
+
*/
|
|
4519
4736
|
readonly color?: Maybe<ThemePalette | DbxThemeColor>;
|
|
4520
|
-
/**
|
|
4737
|
+
/**
|
|
4738
|
+
* Material icon font ligature name (e.g. "save", "delete").
|
|
4739
|
+
*/
|
|
4521
4740
|
readonly fontIcon?: Maybe<string>;
|
|
4522
|
-
/**
|
|
4741
|
+
/**
|
|
4742
|
+
* Icon font set to use (e.g. for extended icon libraries).
|
|
4743
|
+
*/
|
|
4523
4744
|
readonly fontSet?: Maybe<string>;
|
|
4524
|
-
/**
|
|
4745
|
+
/**
|
|
4746
|
+
* Whether to render the icon inline with text.
|
|
4747
|
+
*/
|
|
4525
4748
|
readonly inline?: Maybe<boolean>;
|
|
4526
|
-
/**
|
|
4749
|
+
/**
|
|
4750
|
+
* SVG icon name registered with MatIconRegistry.
|
|
4751
|
+
*/
|
|
4527
4752
|
readonly svgIcon?: Maybe<string>;
|
|
4528
|
-
/**
|
|
4753
|
+
/**
|
|
4754
|
+
* Custom CSS class applied to the icon element.
|
|
4755
|
+
*/
|
|
4529
4756
|
readonly customClass?: Maybe<string>;
|
|
4530
4757
|
}
|
|
4531
4758
|
/**
|
|
@@ -4610,7 +4837,7 @@ declare class DbxProgressSpinnerButtonComponent extends AbstractProgressButtonDi
|
|
|
4610
4837
|
readonly buttonCssSignal: _angular_core.Signal<string | undefined>;
|
|
4611
4838
|
readonly showTextContentSignal: _angular_core.Signal<boolean>;
|
|
4612
4839
|
readonly showTextButtonIconSignal: _angular_core.Signal<false | Maybe<_dereekb_dbx_web.DbxProgressButtonIcon>>;
|
|
4613
|
-
readonly showIconSignal: _angular_core.Signal<boolean |
|
|
4840
|
+
readonly showIconSignal: _angular_core.Signal<boolean | _dereekb_util.MaybeNot>;
|
|
4614
4841
|
readonly customSpinnerStyleSignal: _angular_core.Signal<{
|
|
4615
4842
|
stroke: string;
|
|
4616
4843
|
} | undefined>;
|
|
@@ -4765,7 +4992,9 @@ declare class DbxErrorDefaultErrorWidgetComponent extends AbstractDbxErrorWidget
|
|
|
4765
4992
|
* Event emitted when the error icon button is clicked, containing the button's element reference for popover anchoring.
|
|
4766
4993
|
*/
|
|
4767
4994
|
interface DbxErrorViewButtonEvent {
|
|
4768
|
-
/**
|
|
4995
|
+
/**
|
|
4996
|
+
* The element reference of the clicked button, used as the popover origin.
|
|
4997
|
+
*/
|
|
4769
4998
|
readonly origin: ElementRef;
|
|
4770
4999
|
}
|
|
4771
5000
|
/**
|
|
@@ -4876,6 +5105,9 @@ declare class DbxActionErrorDirective {
|
|
|
4876
5105
|
* const pojoError = convertToPOJOServerErrorResponse(httpErrorResponse);
|
|
4877
5106
|
* console.log(pojoError.message);
|
|
4878
5107
|
* ```
|
|
5108
|
+
*
|
|
5109
|
+
* @param httpError - The HTTP error response or generic error object to convert.
|
|
5110
|
+
* @returns A plain JSON-serializable {@link ServerError} object.
|
|
4879
5111
|
*/
|
|
4880
5112
|
declare function convertToPOJOServerErrorResponse(httpError: HttpErrorResponse | object): ServerError;
|
|
4881
5113
|
/**
|
|
@@ -4891,6 +5123,9 @@ declare function convertToPOJOServerErrorResponse(httpError: HttpErrorResponse |
|
|
|
4891
5123
|
* console.log(serverError.status, serverError.message);
|
|
4892
5124
|
* }
|
|
4893
5125
|
* ```
|
|
5126
|
+
*
|
|
5127
|
+
* @param error - The HTTP error response or generic error object to convert.
|
|
5128
|
+
* @returns A {@link ServerErrorResponse} derived from the error, or `undefined` if the input is falsy.
|
|
4894
5129
|
*/
|
|
4895
5130
|
declare function convertToServerErrorResponse(error: HttpErrorResponse | object): ServerErrorResponse | undefined;
|
|
4896
5131
|
|
|
@@ -4938,14 +5173,18 @@ declare class DbxLoadingErrorDirective {
|
|
|
4938
5173
|
/**
|
|
4939
5174
|
* Configuration for error snackbar display, extending Material snackbar config but excluding `data` and `viewContainerRef`.
|
|
4940
5175
|
*/
|
|
4941
|
-
type DbxErrorSnackbarConfig = Omit<MatSnackBarConfig<
|
|
5176
|
+
type DbxErrorSnackbarConfig = Omit<MatSnackBarConfig<unknown>, 'data' | 'viewContainerRef'>;
|
|
4942
5177
|
/**
|
|
4943
5178
|
* Data passed to the error snackbar component via `MAT_SNACK_BAR_DATA`.
|
|
4944
5179
|
*/
|
|
4945
5180
|
interface DbxErrorSnackbarData<T extends ErrorInput = ErrorInput> {
|
|
4946
|
-
/**
|
|
5181
|
+
/**
|
|
5182
|
+
* The error to display in the snackbar.
|
|
5183
|
+
*/
|
|
4947
5184
|
readonly error: T;
|
|
4948
|
-
/**
|
|
5185
|
+
/**
|
|
5186
|
+
* Optional auto-dismiss duration in milliseconds. If omitted, the snackbar persists until manually dismissed.
|
|
5187
|
+
*/
|
|
4949
5188
|
readonly duration?: number;
|
|
4950
5189
|
}
|
|
4951
5190
|
/**
|
|
@@ -5186,9 +5425,13 @@ declare const DEFAULT_ERROR_POPOVER_KEY = "error";
|
|
|
5186
5425
|
* Configuration for opening an error popover via {@link DbxErrorPopoverComponent.openPopover}.
|
|
5187
5426
|
*/
|
|
5188
5427
|
interface DbxErrorPopoverConfig {
|
|
5189
|
-
/**
|
|
5428
|
+
/**
|
|
5429
|
+
* The element that the popover should be anchored to.
|
|
5430
|
+
*/
|
|
5190
5431
|
readonly origin: ElementRef;
|
|
5191
|
-
/**
|
|
5432
|
+
/**
|
|
5433
|
+
* The error to display in the popover.
|
|
5434
|
+
*/
|
|
5192
5435
|
readonly error: ReadableError;
|
|
5193
5436
|
}
|
|
5194
5437
|
/**
|
|
@@ -5336,6 +5579,9 @@ interface ServerErrorParams {
|
|
|
5336
5579
|
* const params = convertServerErrorParams(httpErrorResponse);
|
|
5337
5580
|
* store.dispatch(myErrorAction(params));
|
|
5338
5581
|
* ```
|
|
5582
|
+
*
|
|
5583
|
+
* @param httpError - The HTTP error response or generic error object to convert.
|
|
5584
|
+
* @returns A {@link ServerErrorParams} object wrapping the converted server error.
|
|
5339
5585
|
*/
|
|
5340
5586
|
declare function convertServerErrorParams(httpError: HttpErrorResponse | object): ServerErrorParams;
|
|
5341
5587
|
/**
|
|
@@ -5350,6 +5596,10 @@ declare function convertServerErrorParams(httpError: HttpErrorResponse | object)
|
|
|
5350
5596
|
* ))
|
|
5351
5597
|
* );
|
|
5352
5598
|
* ```
|
|
5599
|
+
*
|
|
5600
|
+
* @param action - The NgRx action creator to dispatch with the converted error params.
|
|
5601
|
+
* @param mapError - Optional function to transform the {@link ServerErrorParams} before dispatching. Defaults to identity.
|
|
5602
|
+
* @returns An RxJS operator that catches errors and emits the corresponding error action.
|
|
5353
5603
|
*/
|
|
5354
5604
|
declare function catchErrorServerParams<E extends ServerErrorParams, T extends string>(action: ActionCreator<T, (props: E) => E & Action<T>>, mapError?: (error: ServerErrorParams) => E): MonoTypeOperatorFunction<E & Action<T>>;
|
|
5355
5605
|
|
|
@@ -5370,6 +5620,13 @@ interface DbxModelState {
|
|
|
5370
5620
|
interface State {
|
|
5371
5621
|
[FEATURE_KEY]: DbxModelState;
|
|
5372
5622
|
}
|
|
5623
|
+
/**
|
|
5624
|
+
* Combined reducer for the DbxModel NgRx feature state, delegating to sub-reducers for each state slice.
|
|
5625
|
+
*
|
|
5626
|
+
* @param state The current DbxModel feature state, or undefined for initial state
|
|
5627
|
+
* @param action The NgRx action to process
|
|
5628
|
+
* @returns The new DbxModelState produced by the combined sub-reducers
|
|
5629
|
+
*/
|
|
5373
5630
|
declare function reducers(state: DbxModelState | undefined, action: Action): {
|
|
5374
5631
|
"model.module.config": DbxModelModuleStateConfiguration;
|
|
5375
5632
|
};
|
|
@@ -5484,6 +5741,9 @@ interface DbxModelViewTrackerEventSet {
|
|
|
5484
5741
|
* ```typescript
|
|
5485
5742
|
* const keys = allDbxModelViewTrackerEventSetModelKeys(eventSet);
|
|
5486
5743
|
* ```
|
|
5744
|
+
*
|
|
5745
|
+
* @param eventSet - The event set from which to extract model keys
|
|
5746
|
+
* @returns Array of model keys from all events in the set
|
|
5487
5747
|
*/
|
|
5488
5748
|
declare function allDbxModelViewTrackerEventSetModelKeys(eventSet: DbxModelViewTrackerEventSet): ModelKey[];
|
|
5489
5749
|
/**
|
|
@@ -5493,6 +5753,9 @@ declare function allDbxModelViewTrackerEventSetModelKeys(eventSet: DbxModelViewT
|
|
|
5493
5753
|
* ```typescript
|
|
5494
5754
|
* const keys = allDbxModelViewTrackerEventModelKeys(events);
|
|
5495
5755
|
* ```
|
|
5756
|
+
*
|
|
5757
|
+
* @param events - Array of view tracker events from which to extract model keys
|
|
5758
|
+
* @returns Array of model keys, one per event
|
|
5496
5759
|
*/
|
|
5497
5760
|
declare function allDbxModelViewTrackerEventModelKeys(events: DbxModelViewTrackerEvent[]): ModelKey[];
|
|
5498
5761
|
|
|
@@ -5503,6 +5766,9 @@ declare function allDbxModelViewTrackerEventModelKeys(events: DbxModelViewTracke
|
|
|
5503
5766
|
* ```typescript
|
|
5504
5767
|
* const accessor = defaultDbxModelViewTrackerStorageAccessorFactory(storageAccessorFactory);
|
|
5505
5768
|
* ```
|
|
5769
|
+
*
|
|
5770
|
+
* @param storageAccessorFactory - The factory used to create typed storage accessors
|
|
5771
|
+
* @returns A storage accessor configured with the `mtvs` prefix for model view tracker events
|
|
5506
5772
|
*/
|
|
5507
5773
|
declare function defaultDbxModelViewTrackerStorageAccessorFactory(storageAccessorFactory: SimpleStorageAccessorFactory): StorageAccessor<DbxModelViewTrackerEventSet>;
|
|
5508
5774
|
/**
|
|
@@ -5519,6 +5785,10 @@ declare class DbxModelObjectStateService {
|
|
|
5519
5785
|
readonly store: Store<any>;
|
|
5520
5786
|
/**
|
|
5521
5787
|
* Emit a model viewed event.
|
|
5788
|
+
*
|
|
5789
|
+
* @param params - The model viewed event parameters
|
|
5790
|
+
* @param params.modelKeyTypeNamePair - Identifies the model that was viewed
|
|
5791
|
+
* @param params.context - Optional context describing how the model was viewed
|
|
5522
5792
|
*/
|
|
5523
5793
|
emitModelViewEvent({ modelKeyTypeNamePair, context }: DbxModelObjectViewedParams): void;
|
|
5524
5794
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxModelObjectStateService, never>;
|
|
@@ -5537,6 +5807,8 @@ declare class DbxModelTrackerService {
|
|
|
5537
5807
|
readonly newEvent$: Observable<DbxModelViewTrackerEvent>;
|
|
5538
5808
|
/**
|
|
5539
5809
|
* The default storage folder used when no folder is specified in tracking calls.
|
|
5810
|
+
*
|
|
5811
|
+
* @returns The current default folder name, or undefined if not set
|
|
5540
5812
|
*/
|
|
5541
5813
|
get defaultFolder(): Maybe<string>;
|
|
5542
5814
|
set defaultFolder(folder: Maybe<string>);
|
|
@@ -5552,12 +5824,14 @@ declare class DbxModelTrackerService {
|
|
|
5552
5824
|
* Returns all recorded view events for the given folder, sorted by most recent first.
|
|
5553
5825
|
*
|
|
5554
5826
|
* @param folder - Storage folder; defaults to {@link defaultFolder}
|
|
5827
|
+
* @returns Observable of view events sorted by most recent first
|
|
5555
5828
|
*/
|
|
5556
5829
|
getAllViewEvents(folder?: Maybe<string>): Observable<DbxModelViewTrackerEvent[]>;
|
|
5557
5830
|
/**
|
|
5558
5831
|
* Returns the complete event set (events and last-update timestamp) for the given folder.
|
|
5559
5832
|
*
|
|
5560
5833
|
* @param folder - Storage folder; defaults to {@link defaultFolder}
|
|
5834
|
+
* @returns Observable of the complete event set including events and last-update timestamp
|
|
5561
5835
|
*/
|
|
5562
5836
|
getViewEventSet(folder?: Maybe<string>): Observable<DbxModelViewTrackerEventSet>;
|
|
5563
5837
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxModelTrackerService, never>;
|
|
@@ -5590,12 +5864,14 @@ declare class DbxModelViewTrackerStorage {
|
|
|
5590
5864
|
* Returns all stored view events for the given folder.
|
|
5591
5865
|
*
|
|
5592
5866
|
* @param folder - Optional folder name; defaults to `'default'`
|
|
5867
|
+
* @returns Observable of all view tracker events in the folder
|
|
5593
5868
|
*/
|
|
5594
5869
|
getAllEvents(folder?: Maybe<string>): Observable<DbxModelViewTrackerEvent[]>;
|
|
5595
5870
|
/**
|
|
5596
5871
|
* Returns the complete event set for the given folder.
|
|
5597
5872
|
*
|
|
5598
5873
|
* @param folder - Optional folder name; defaults to `'default'`
|
|
5874
|
+
* @returns Observable of the event set containing events and the last-update timestamp
|
|
5599
5875
|
*/
|
|
5600
5876
|
getEventSet(folder?: Maybe<string>): Observable<DbxModelViewTrackerEventSet>;
|
|
5601
5877
|
private _getEventSetForStorageKey;
|
|
@@ -5603,6 +5879,7 @@ declare class DbxModelViewTrackerStorage {
|
|
|
5603
5879
|
* Computes the storage key for a given folder name.
|
|
5604
5880
|
*
|
|
5605
5881
|
* @param folder - Optional folder name; defaults to `'default'`
|
|
5882
|
+
* @returns The computed storage key string combining the base key and folder name
|
|
5606
5883
|
*/
|
|
5607
5884
|
getStorageKeyForFolder(folder?: Maybe<string>): string;
|
|
5608
5885
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxModelViewTrackerStorage, never>;
|
|
@@ -5711,6 +5988,7 @@ declare class DbxModelTypesService<I extends DbxModelTypeInfo = DbxModelTypeInfo
|
|
|
5711
5988
|
* Returns an observable of the Material icon name for the given model type.
|
|
5712
5989
|
*
|
|
5713
5990
|
* @param type - The model type string to look up
|
|
5991
|
+
* @returns Observable emitting the icon name for the given model type
|
|
5714
5992
|
*/
|
|
5715
5993
|
iconForType(type: ModelTypeString): Observable<string>;
|
|
5716
5994
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxModelTypesService<any>, never>;
|
|
@@ -5871,7 +6149,7 @@ interface DbxWebFilePreviewServicePreviewDialogFunctionInputWithMatDialog extend
|
|
|
5871
6149
|
/**
|
|
5872
6150
|
* Used for previewing a src url and embedMimeType in a dialog.
|
|
5873
6151
|
*/
|
|
5874
|
-
type DbxWebFilePreviewServicePreviewDialogFunction = (input: DbxWebFilePreviewServicePreviewDialogFunctionInputWithMatDialog) => MatDialogRef<
|
|
6152
|
+
type DbxWebFilePreviewServicePreviewDialogFunction = (input: DbxWebFilePreviewServicePreviewDialogFunctionInputWithMatDialog) => MatDialogRef<unknown, unknown>;
|
|
5875
6153
|
/**
|
|
5876
6154
|
* Configuration for a preview entry.
|
|
5877
6155
|
*/
|
|
@@ -5903,7 +6181,7 @@ interface DbxWebFilePreviewServicePreviewDialogWithComponentFunctionInput extend
|
|
|
5903
6181
|
/**
|
|
5904
6182
|
* Used for previewing a src url and embedMimeType in a dialog.
|
|
5905
6183
|
*/
|
|
5906
|
-
type DbxWebFilePreviewServicePreviewDialogWithComponentFunction = (input: DbxWebFilePreviewServicePreviewDialogWithComponentFunctionInput) => MatDialogRef<
|
|
6184
|
+
type DbxWebFilePreviewServicePreviewDialogWithComponentFunction = (input: DbxWebFilePreviewServicePreviewDialogWithComponentFunctionInput) => MatDialogRef<unknown, unknown>;
|
|
5907
6185
|
/**
|
|
5908
6186
|
* @deprecated use DbxWebFilePreviewServicePreviewDialogFunction instead.
|
|
5909
6187
|
*/
|
|
@@ -5916,6 +6194,9 @@ declare const DBX_WEB_FILE_PREVIEW_SERVICE_ENTRIES_TOKEN: InjectionToken<DbxWebF
|
|
|
5916
6194
|
/**
|
|
5917
6195
|
* Creates a provider that registers the given entries with the {@link DbxWebFilePreviewService} via the {@link DBX_WEB_FILE_PREVIEW_SERVICE_ENTRIES_TOKEN}.
|
|
5918
6196
|
*
|
|
6197
|
+
* @param entries - Array of preview service entries to register, each mapping a MIME type to its preview component
|
|
6198
|
+
* @returns A provider configuration that supplies the entries via the injection token
|
|
6199
|
+
*
|
|
5919
6200
|
* @example
|
|
5920
6201
|
* ```typescript
|
|
5921
6202
|
* provideDbxWebFilePreviewServiceEntries([DBX_WEB_FILE_PREVIEW_SERVICE_ZIP_PRESET_ENTRY]);
|
|
@@ -5925,15 +6206,18 @@ declare function provideDbxWebFilePreviewServiceEntries(entries: DbxWebFilePrevi
|
|
|
5925
6206
|
provide: InjectionToken<DbxWebFilePreviewServiceEntry[]>;
|
|
5926
6207
|
useValue: DbxWebFilePreviewServiceEntry[];
|
|
5927
6208
|
};
|
|
5928
|
-
/**
|
|
5929
|
-
* Default preset for previewing a file using a DbxEmbedDialogComponent.
|
|
5930
|
-
*/
|
|
5931
6209
|
/**
|
|
5932
6210
|
* Default preview component function that embeds files using {@link DbxEmbedComponent}. Images are rendered with an `img` element; all other types use `embed`.
|
|
6211
|
+
*
|
|
6212
|
+
* @param input - The preview input containing blob data, source URL, and MIME type information
|
|
6213
|
+
* @returns An injection component config that initializes a {@link DbxEmbedComponent} with the appropriate embed element and content
|
|
5933
6214
|
*/
|
|
5934
6215
|
declare const DBX_WEB_FILE_PREVIEW_SERVICE_DEFAULT_PREVIEW_COMPONENT_FUNCTION: DbxWebFilePreviewServicePreviewComponentFunction;
|
|
5935
6216
|
/**
|
|
5936
6217
|
* Default dialog-with-component function that opens the preview component inside a {@link DbxInjectionDialogComponent} with a close button.
|
|
6218
|
+
*
|
|
6219
|
+
* @param input - The dialog input containing the MatDialog instance and the component config to display
|
|
6220
|
+
* @returns A MatDialogRef for the opened injection dialog
|
|
5937
6221
|
*/
|
|
5938
6222
|
declare const DBX_WEB_FILE_PREVIEW_SERVICE_DEFAULT_DIALOG_WITH_COMPONENT_FUNCTION: DbxWebFilePreviewServicePreviewDialogWithComponentFunction;
|
|
5939
6223
|
/**
|
|
@@ -5942,7 +6226,7 @@ declare const DBX_WEB_FILE_PREVIEW_SERVICE_DEFAULT_DIALOG_WITH_COMPONENT_FUNCTIO
|
|
|
5942
6226
|
declare class DbxWebFilePreviewService {
|
|
5943
6227
|
readonly matDialog: MatDialog;
|
|
5944
6228
|
private readonly _entries;
|
|
5945
|
-
constructor(
|
|
6229
|
+
constructor();
|
|
5946
6230
|
private _defaultPreviewComponentFunction;
|
|
5947
6231
|
private _defaultPreviewDialogWithComponentFunction;
|
|
5948
6232
|
/**
|
|
@@ -5959,16 +6243,21 @@ declare class DbxWebFilePreviewService {
|
|
|
5959
6243
|
registerPreviewEntry(entry: DbxWebFilePreviewServiceEntry): void;
|
|
5960
6244
|
/**
|
|
5961
6245
|
* Overrides the default preview component function used when no MIME-specific entry is registered.
|
|
6246
|
+
*
|
|
6247
|
+
* @param previewFunction - The preview component function to use as the new default
|
|
5962
6248
|
*/
|
|
5963
6249
|
setDefaultPreviewComponentFunction(previewFunction: DbxWebFilePreviewServicePreviewComponentFunction): void;
|
|
5964
6250
|
/**
|
|
5965
6251
|
* Overrides the default dialog-with-component function used when no MIME-specific dialog handler is registered.
|
|
6252
|
+
*
|
|
6253
|
+
* @param previewDialogWithComponentFunction - The dialog-with-component function to use as the new default
|
|
5966
6254
|
*/
|
|
5967
6255
|
setDefaultPreviewDialogWithComponentFunction(previewDialogWithComponentFunction: DbxWebFilePreviewServicePreviewDialogWithComponentFunction): void;
|
|
5968
6256
|
/**
|
|
5969
6257
|
* Creates an injection component config for previewing a file. Uses a MIME-specific preview function if registered, otherwise falls back to the default.
|
|
5970
6258
|
*
|
|
5971
6259
|
* @param input - The preview input containing blob, URL, and MIME type information
|
|
6260
|
+
* @returns An injection component config suitable for rendering the file preview
|
|
5972
6261
|
*/
|
|
5973
6262
|
createPreviewConfig(input: DbxWebFilePreviewServicePreviewComponentFunctionInput): dist_packages_dbx_core_types_dereekb_dbx_core.DbxInjectionComponentConfig<any>;
|
|
5974
6263
|
/**
|
|
@@ -5977,8 +6266,8 @@ declare class DbxWebFilePreviewService {
|
|
|
5977
6266
|
* @param input - The dialog input containing file data and MIME type
|
|
5978
6267
|
* @returns Reference to the opened dialog
|
|
5979
6268
|
*/
|
|
5980
|
-
openPreviewDialog(input: DbxWebFilePreviewServicePreviewDialogFunctionInput): MatDialogRef<
|
|
5981
|
-
static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxWebFilePreviewService,
|
|
6269
|
+
openPreviewDialog(input: DbxWebFilePreviewServicePreviewDialogFunctionInput): MatDialogRef<unknown, unknown>;
|
|
6270
|
+
static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxWebFilePreviewService, never>;
|
|
5982
6271
|
static ɵprov: _angular_core.ɵɵInjectableDeclaration<DbxWebFilePreviewService>;
|
|
5983
6272
|
}
|
|
5984
6273
|
|
|
@@ -6004,6 +6293,9 @@ declare class DbxWebFilePreviewComponent {
|
|
|
6004
6293
|
|
|
6005
6294
|
/**
|
|
6006
6295
|
* Preview component function preset that renders zip files using {@link DbxZipPreviewComponent}.
|
|
6296
|
+
*
|
|
6297
|
+
* @param input - The preview input containing the source URL and MIME type of the zip file
|
|
6298
|
+
* @returns An injection component config that initializes a {@link DbxZipPreviewComponent} with the given source URL
|
|
6007
6299
|
*/
|
|
6008
6300
|
declare const DBX_WEB_FILE_PREVIEW_SERVICE_ZIP_COMPONENT_PRESET: DbxWebFilePreviewServicePreviewComponentFunction;
|
|
6009
6301
|
/**
|
|
@@ -6100,8 +6392,9 @@ declare class DbxWidgetService {
|
|
|
6100
6392
|
/**
|
|
6101
6393
|
* Used to register an entry. If an entry with the same type is already registered, this will override it by default.
|
|
6102
6394
|
*
|
|
6103
|
-
* @param entry
|
|
6104
|
-
* @param override
|
|
6395
|
+
* @param entry - The widget entry mapping a type identifier to its component class
|
|
6396
|
+
* @param override - Whether to replace an existing entry with the same type. Defaults to true.
|
|
6397
|
+
* @returns True if the entry was registered, false if an entry with the same type already exists and override is false
|
|
6105
6398
|
*/
|
|
6106
6399
|
register(entry: DbxWidgetEntry, override?: boolean): boolean;
|
|
6107
6400
|
getWidgetIdentifiers(): DbxWidgetType[];
|
|
@@ -6197,6 +6490,9 @@ type DbxZipBlobPreviewEntryTreeRoot = SlashPathDirectoryTreeRoot<Entry, DbxZipBl
|
|
|
6197
6490
|
/**
|
|
6198
6491
|
* Builds a directory tree from an array of zip archive entries, enriching each node with MIME type detection and blob retrieval capability.
|
|
6199
6492
|
*
|
|
6493
|
+
* @param entries - Array of zip archive entries to build the tree from, or null/undefined for an empty tree
|
|
6494
|
+
* @returns The root node of the constructed directory tree with MIME types and blob getters attached
|
|
6495
|
+
*
|
|
6200
6496
|
* @example
|
|
6201
6497
|
* ```typescript
|
|
6202
6498
|
* const root = dbxZipBlobPreviewEntryTreeFromEntries(zipEntries);
|
|
@@ -6647,6 +6943,8 @@ declare class DbxAngularRouterSegueAnchorComponent extends AbstractDbxSegueAncho
|
|
|
6647
6943
|
* providers: [provideDbxRouterWebAngularRouterProviderConfig()]
|
|
6648
6944
|
* });
|
|
6649
6945
|
* ```
|
|
6946
|
+
*
|
|
6947
|
+
* @returns environment providers that configure the Angular Router-based segue anchor component
|
|
6650
6948
|
*/
|
|
6651
6949
|
declare function provideDbxRouterWebAngularRouterProviderConfig(): EnvironmentProviders;
|
|
6652
6950
|
|
|
@@ -6677,6 +6975,8 @@ declare class DbxUIRouterSegueAnchorComponent extends AbstractDbxSegueAnchorDire
|
|
|
6677
6975
|
* providers: [provideDbxRouterWebUiRouterProviderConfig()]
|
|
6678
6976
|
* });
|
|
6679
6977
|
* ```
|
|
6978
|
+
*
|
|
6979
|
+
* @returns environment providers that configure the UIRouter-based segue anchor component
|
|
6680
6980
|
*/
|
|
6681
6981
|
declare function provideDbxRouterWebUiRouterProviderConfig(): EnvironmentProviders;
|
|
6682
6982
|
|
|
@@ -6912,6 +7212,9 @@ type DbxDialogContentConfig = Omit<MatDialogConfig, 'viewContainerRef' | 'inject
|
|
|
6912
7212
|
/**
|
|
6913
7213
|
* Sanitizes a {@link DbxDialogContentConfig} by normalizing the panelClass into an array.
|
|
6914
7214
|
*
|
|
7215
|
+
* @param input - The dialog content config to sanitize, or null/undefined
|
|
7216
|
+
* @returns A new config with panelClass normalized to an array of CSS class strings
|
|
7217
|
+
*
|
|
6915
7218
|
* @example
|
|
6916
7219
|
* ```ts
|
|
6917
7220
|
* const config = sanitizeDbxDialogContentConfig({ panelClass: 'my-panel my-other-panel' });
|
|
@@ -7029,6 +7332,9 @@ declare class DbxHelpContextService {
|
|
|
7029
7332
|
* // In a component or directive constructor
|
|
7030
7333
|
* const destroy = registerHelpContextKeysWithDbxHelpContextService(of(['feature-help', 'general-help']));
|
|
7031
7334
|
* ```
|
|
7335
|
+
*
|
|
7336
|
+
* @param helpContextKeys - Observable or static array of help context keys to register with the service
|
|
7337
|
+
* @returns A destroy function that unregisters the help context keys when called
|
|
7032
7338
|
*/
|
|
7033
7339
|
declare function registerHelpContextKeysWithDbxHelpContextService(helpContextKeys: ObservableOrValue<DbxHelpContextKey[]>): DestroyFunction;
|
|
7034
7340
|
|
|
@@ -7128,29 +7434,39 @@ declare class DbxHelpWidgetService {
|
|
|
7128
7434
|
private _helpListFooterComponentConfig;
|
|
7129
7435
|
private _defaultIcon;
|
|
7130
7436
|
private _popoverHeaderComponentConfig;
|
|
7131
|
-
constructor(
|
|
7437
|
+
constructor();
|
|
7132
7438
|
/**
|
|
7133
7439
|
* Returns the component class used for unrecognized help context keys.
|
|
7440
|
+
*
|
|
7441
|
+
* @returns The default widget component class, or undefined if not set
|
|
7134
7442
|
*/
|
|
7135
7443
|
getDefaultWidgetComponentClass(): Maybe<Type<unknown>>;
|
|
7136
7444
|
setDefaultWidgetComponentClass(componentClass: Maybe<Type<unknown>>): void;
|
|
7137
7445
|
/**
|
|
7138
7446
|
* Returns the default icon used for help entries without a specific icon.
|
|
7447
|
+
*
|
|
7448
|
+
* @returns The default icon string, or undefined if not set
|
|
7139
7449
|
*/
|
|
7140
7450
|
getDefaultIcon(): Maybe<string>;
|
|
7141
7451
|
setDefaultIcon(icon: Maybe<string>): void;
|
|
7142
7452
|
/**
|
|
7143
7453
|
* Returns the component config displayed in the popover header, if set.
|
|
7454
|
+
*
|
|
7455
|
+
* @returns The popover header component config, or undefined if not set
|
|
7144
7456
|
*/
|
|
7145
7457
|
getPopoverHeaderComponentConfig(): Maybe<DbxInjectionComponentConfig>;
|
|
7146
7458
|
setPopoverHeaderComponentConfig(componentConfig: Maybe<DbxInjectionComponentConfig>): void;
|
|
7147
7459
|
/**
|
|
7148
7460
|
* Returns the component config displayed at the top of the help list view, if set.
|
|
7461
|
+
*
|
|
7462
|
+
* @returns The help list header component config, or undefined if not set
|
|
7149
7463
|
*/
|
|
7150
7464
|
getHelpListHeaderComponentConfig(): Maybe<DbxInjectionComponentConfig>;
|
|
7151
7465
|
setHelpListHeaderComponentConfig(componentConfig: Maybe<DbxInjectionComponentConfig>): void;
|
|
7152
7466
|
/**
|
|
7153
7467
|
* Returns the component config displayed at the bottom of the help list view, if set.
|
|
7468
|
+
*
|
|
7469
|
+
* @returns The help list footer component config, or undefined if not set
|
|
7154
7470
|
*/
|
|
7155
7471
|
getHelpListFooterComponentConfig(): Maybe<DbxInjectionComponentConfig>;
|
|
7156
7472
|
setHelpListFooterComponentConfig(componentConfig: Maybe<DbxInjectionComponentConfig>): void;
|
|
@@ -7161,33 +7477,43 @@ declare class DbxHelpWidgetService {
|
|
|
7161
7477
|
*
|
|
7162
7478
|
* @param entries The entries to register
|
|
7163
7479
|
* @param override Whether to override existing entries (default: true)
|
|
7480
|
+
* @returns Always returns true after registration completes
|
|
7164
7481
|
*/
|
|
7165
7482
|
register(entries: ArrayOrValue<DbxHelpWidgetServiceEntry>, override?: boolean): boolean;
|
|
7166
7483
|
/**
|
|
7167
7484
|
* Returns all currently registered help context keys.
|
|
7485
|
+
*
|
|
7486
|
+
* @returns Array of all registered help context keys
|
|
7168
7487
|
*/
|
|
7169
7488
|
getAllRegisteredHelpContextKeys(): DbxHelpContextKey[];
|
|
7170
7489
|
/**
|
|
7171
7490
|
* Retrieves the widget entry for a given help context key. Falls back to a default entry if a default widget component class is configured.
|
|
7172
7491
|
*
|
|
7173
7492
|
* @param helpContextKey - The help context key to look up
|
|
7493
|
+
* @returns The matching widget entry, a default entry if a default component class is configured, or undefined
|
|
7174
7494
|
*/
|
|
7175
7495
|
getHelpWidgetEntry(helpContextKey: DbxHelpContextKey): Maybe<DbxHelpWidgetServiceEntry>;
|
|
7176
7496
|
/**
|
|
7177
7497
|
* Retrieves widget entries for multiple help context keys, filtering out any unresolvable keys.
|
|
7178
7498
|
*
|
|
7179
7499
|
* @param helpContextKeys - Array of help context keys to look up
|
|
7500
|
+
* @returns Array of resolved widget entries, excluding any keys that could not be resolved
|
|
7180
7501
|
*/
|
|
7181
7502
|
getHelpWidgetEntriesForHelpContextKeys(helpContextKeys: DbxHelpContextKey[]): DbxHelpWidgetServiceEntry[];
|
|
7182
7503
|
/**
|
|
7183
7504
|
* Checks whether a widget entry is registered for the given help context key.
|
|
7505
|
+
*
|
|
7506
|
+
* @param context - The help context key to check
|
|
7507
|
+
* @returns True if a widget entry exists for the given key
|
|
7184
7508
|
*/
|
|
7185
7509
|
hasHelpWidgetEntry(context: DbxHelpContextKey): boolean;
|
|
7186
7510
|
/**
|
|
7187
7511
|
* Returns a cached map of help context keys to their sort priority values.
|
|
7512
|
+
*
|
|
7513
|
+
* @returns Map of help context keys to their numeric sort priorities
|
|
7188
7514
|
*/
|
|
7189
7515
|
getSortPriorityMap(): Map<string, number>;
|
|
7190
|
-
static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxHelpWidgetService,
|
|
7516
|
+
static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxHelpWidgetService, never>;
|
|
7191
7517
|
static ɵprov: _angular_core.ɵɵInjectableDeclaration<DbxHelpWidgetService>;
|
|
7192
7518
|
}
|
|
7193
7519
|
|
|
@@ -7390,8 +7716,8 @@ declare abstract class AbstractPopoverRefDirective<T = unknown, R = unknown> {
|
|
|
7390
7716
|
showPopover(origin?: ElementRef): void;
|
|
7391
7717
|
private _showPopoverRef;
|
|
7392
7718
|
protected abstract _makePopoverRef(origin?: ElementRef): NgPopoverRef<T, R>;
|
|
7393
|
-
protected _afterOpened(
|
|
7394
|
-
protected _afterClosed(
|
|
7719
|
+
protected _afterOpened(_popoverRef: NgPopoverRef<T, R>): void;
|
|
7720
|
+
protected _afterClosed(_value: NgPopoverCloseEvent<R>): void;
|
|
7395
7721
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<AbstractPopoverRefDirective<any, any>, never>;
|
|
7396
7722
|
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<AbstractPopoverRefDirective<any, any>, never, never, {}, {}, never, never, true, never>;
|
|
7397
7723
|
}
|
|
@@ -7552,6 +7878,11 @@ interface DbxPresetFilterMenuConfig {
|
|
|
7552
7878
|
/**
|
|
7553
7879
|
* Creates an observable that emits the button text for a preset filter menu based on the current selection.
|
|
7554
7880
|
*
|
|
7881
|
+
* @param config$ - Observable of the preset filter menu configuration
|
|
7882
|
+
* @param selection$ - Observable of the currently selected preset, used to derive the display title
|
|
7883
|
+
* @param defaultText - Fallback text when no selection or unknownSelectionText is configured. Defaults to 'Filter'.
|
|
7884
|
+
* @returns An observable emitting the resolved button text string
|
|
7885
|
+
*
|
|
7555
7886
|
* @example
|
|
7556
7887
|
* ```ts
|
|
7557
7888
|
* const text$ = dbxPresetFilterMenuButtonTextObservable(config$, selectedPreset$);
|
|
@@ -7561,6 +7892,11 @@ declare function dbxPresetFilterMenuButtonTextObservable(config$: Observable<Dbx
|
|
|
7561
7892
|
/**
|
|
7562
7893
|
* Creates an observable that emits the button icon for a preset filter menu based on the current selection and config.
|
|
7563
7894
|
*
|
|
7895
|
+
* @param config$ - Observable of the preset filter menu configuration controlling icon behavior
|
|
7896
|
+
* @param selection$ - Observable of the currently selected preset, used to derive the display icon
|
|
7897
|
+
* @param defaultIcon - Fallback icon when no filterIcon is configured. Defaults to 'arrow_drop_down'.
|
|
7898
|
+
* @returns An observable emitting the resolved icon string, or undefined when no icon should be shown
|
|
7899
|
+
*
|
|
7564
7900
|
* @example
|
|
7565
7901
|
* ```ts
|
|
7566
7902
|
* const icon$ = dbxPresetFilterMenuButtonIconObservable(config$, selectedPreset$);
|
|
@@ -7796,6 +8132,10 @@ interface DbxIframeDialogConfig extends Omit<MatDialogConfig, 'data'> {
|
|
|
7796
8132
|
/**
|
|
7797
8133
|
* Opens a dialog containing a {@link DbxIframeComponent} to display a URL in an iframe.
|
|
7798
8134
|
*
|
|
8135
|
+
* @param matDialog - The Angular Material dialog service used to open the dialog
|
|
8136
|
+
* @param config - Configuration specifying the content URL and dialog options
|
|
8137
|
+
* @returns A reference to the opened dialog for controlling or subscribing to its lifecycle
|
|
8138
|
+
*
|
|
7799
8139
|
* @example
|
|
7800
8140
|
* ```ts
|
|
7801
8141
|
* const ref = openIframeDialog(matDialog, { contentUrl: 'https://example.com' });
|
|
@@ -7864,6 +8204,10 @@ interface DbxEmbedDialogConfig extends Omit<MatDialogConfig, 'data'> {
|
|
|
7864
8204
|
/**
|
|
7865
8205
|
* Opens a dialog containing a {@link DbxEmbedComponent} to display embedded content from a URL or Blob.
|
|
7866
8206
|
*
|
|
8207
|
+
* @param matDialog - The Angular Material dialog service used to open the dialog
|
|
8208
|
+
* @param config - Configuration specifying the content source (URL or Blob), MIME type, and dialog options
|
|
8209
|
+
* @returns A reference to the opened dialog for controlling or subscribing to its lifecycle
|
|
8210
|
+
*
|
|
7867
8211
|
* @example
|
|
7868
8212
|
* ```ts
|
|
7869
8213
|
* const ref = openEmbedDialog(matDialog, { srcUrl: 'https://example.com/doc.pdf', embedMimeType: 'application/pdf' });
|
|
@@ -8472,8 +8816,8 @@ type FileAcceptString = string;
|
|
|
8472
8816
|
/**
|
|
8473
8817
|
* Returns a string that can be used as the "accept" attribute of a file input element.
|
|
8474
8818
|
*
|
|
8475
|
-
* @param accept
|
|
8476
|
-
* @returns
|
|
8819
|
+
* @param accept - A file accept string or array of filter type strings to convert
|
|
8820
|
+
* @returns A comma-separated string suitable for the HTML accept attribute
|
|
8477
8821
|
*/
|
|
8478
8822
|
declare function fileAcceptString(accept: FileAcceptString | FileAcceptFilterTypeStringArray): FileAcceptString;
|
|
8479
8823
|
/**
|
|
@@ -8489,6 +8833,9 @@ type FileAcceptFilterTypeStringArray = FileAcceptFilterTypeString[];
|
|
|
8489
8833
|
/**
|
|
8490
8834
|
* Converts a comma-separated accept string or array into a {@link FileAcceptFilterTypeStringArray}.
|
|
8491
8835
|
*
|
|
8836
|
+
* @param accept - A file accept string or array of filter type strings to normalize
|
|
8837
|
+
* @returns An array of individual filter type strings
|
|
8838
|
+
*
|
|
8492
8839
|
* @example
|
|
8493
8840
|
* ```ts
|
|
8494
8841
|
* const types = fileAcceptFilterTypeStringArray('image/png, .pdf');
|
|
@@ -8548,6 +8895,9 @@ type FileArrayAcceptMatchFunction = (input: File[]) => FileArrayAcceptMatchResul
|
|
|
8548
8895
|
/**
|
|
8549
8896
|
* Creates a {@link FileArrayAcceptMatchFunction} that filters and separates files based on accept criteria and multiple file support.
|
|
8550
8897
|
*
|
|
8898
|
+
* @param config - Configuration specifying the accept criteria and whether multiple files are allowed
|
|
8899
|
+
* @returns A function that accepts an array of files and returns the categorized match result
|
|
8900
|
+
*
|
|
8551
8901
|
* @example
|
|
8552
8902
|
* ```ts
|
|
8553
8903
|
* const matchFn = fileArrayAcceptMatchFunction({ accept: 'image/*', multiple: false });
|
|
@@ -8569,6 +8919,9 @@ type FileAcceptFunction = DecisionFunction<FileAcceptFunctionInput>;
|
|
|
8569
8919
|
/**
|
|
8570
8920
|
* Creates a {@link FileAcceptFunction} that checks individual files against accept criteria (MIME types, wildcards, or file extensions).
|
|
8571
8921
|
*
|
|
8922
|
+
* @param accept - A file accept string or array specifying which MIME types, wildcards, or file extensions to allow
|
|
8923
|
+
* @returns A decision function that returns true if a file matches any of the accept criteria
|
|
8924
|
+
*
|
|
8572
8925
|
* @example
|
|
8573
8926
|
* ```ts
|
|
8574
8927
|
* const isAccepted = fileAcceptFunction(['image/*', '.pdf']);
|
|
@@ -8590,6 +8943,9 @@ declare abstract class DbxFileUploadActionCompatable {
|
|
|
8590
8943
|
/**
|
|
8591
8944
|
* Provides a {@link DbxFileUploadActionCompatable} for dependency injection from the given component type.
|
|
8592
8945
|
*
|
|
8946
|
+
* @param sourceType - The concrete component class that implements {@link DbxFileUploadActionCompatable}
|
|
8947
|
+
* @returns An array of providers that register the given type as the {@link DbxFileUploadActionCompatable} implementation
|
|
8948
|
+
*
|
|
8593
8949
|
* @example
|
|
8594
8950
|
* ```ts
|
|
8595
8951
|
* @Component({ providers: provideDbxFileUploadActionCompatable(MyUploadComponent) })
|
|
@@ -8905,7 +9261,7 @@ declare class DbxScreenMediaService implements Destroyable {
|
|
|
8905
9261
|
private readonly _updateHeight;
|
|
8906
9262
|
readonly widthType$: Observable<ScreenMediaWidthType>;
|
|
8907
9263
|
readonly heightType$: Observable<ScreenMediaHeightType>;
|
|
8908
|
-
constructor(
|
|
9264
|
+
constructor();
|
|
8909
9265
|
destroy(): void;
|
|
8910
9266
|
/**
|
|
8911
9267
|
* Returns an observable that emits `true` when the current screen width is at least as wide as the given breakpoint.
|