@dereekb/dbx-components-mcp 13.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +75 -0
- package/dbx-components-mcp.js +21503 -0
- package/generated/dereekb-date.semantic-types.mcp.generated.json +234 -0
- package/generated/dereekb-dbx-core.actions.mcp.generated.json +751 -0
- package/generated/dereekb-dbx-core.filters.mcp.generated.json +179 -0
- package/generated/dereekb-dbx-core.pipes.mcp.generated.json +681 -0
- package/generated/dereekb-dbx-form.forge-fields.mcp.generated.json +2556 -0
- package/generated/dereekb-dbx-web.ui-components.mcp.generated.json +2853 -0
- package/generated/dereekb-firebase-server.semantic-types.mcp.generated.json +66 -0
- package/generated/dereekb-firebase.semantic-types.mcp.generated.json +702 -0
- package/generated/dereekb-model.semantic-types.mcp.generated.json +365 -0
- package/generated/dereekb-util.semantic-types.mcp.generated.json +1997 -0
- package/package.json +13 -0
|
@@ -0,0 +1,2853 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 1,
|
|
3
|
+
"source": "@dereekb/dbx-web",
|
|
4
|
+
"module": "@dereekb/dbx-web",
|
|
5
|
+
"generatedAt": "1970-01-01T00:00:00.000Z",
|
|
6
|
+
"generator": "@dereekb/dbx-components-mcp/scripts/generate-manifests.mjs",
|
|
7
|
+
"entries": [
|
|
8
|
+
{
|
|
9
|
+
"slug": "action-confirm",
|
|
10
|
+
"category": "action",
|
|
11
|
+
"kind": "directive",
|
|
12
|
+
"selector": "[dbxActionConfirm]",
|
|
13
|
+
"className": "DbxActionConfirmDirective",
|
|
14
|
+
"module": "@dereekb/dbx-web",
|
|
15
|
+
"description": "Displays a confirmation dialog when the action is triggered. If the user confirms,\nthe configured ready value is passed to the action. If the user cancels, the action is rejected.\n\nThis directive works with action triggering only, not button clicks.\nFor button-based confirmation, use an appPromptConfirmButton directive instead.",
|
|
16
|
+
"inputs": [
|
|
17
|
+
{
|
|
18
|
+
"name": "dbxActionConfirm",
|
|
19
|
+
"type": "Maybe<DbxActionConfirmConfig<T>>",
|
|
20
|
+
"description": "",
|
|
21
|
+
"required": false,
|
|
22
|
+
"default": "undefined"
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"name": "dbxActionConfirmSkip",
|
|
26
|
+
"type": "boolean",
|
|
27
|
+
"description": "When true, the confirmation dialog is disabled and the action proceeds without prompting.",
|
|
28
|
+
"required": false,
|
|
29
|
+
"default": "false"
|
|
30
|
+
}
|
|
31
|
+
],
|
|
32
|
+
"outputs": [],
|
|
33
|
+
"relatedSlugs": [
|
|
34
|
+
"action-snackbar",
|
|
35
|
+
"prompt-confirm"
|
|
36
|
+
],
|
|
37
|
+
"skillRefs": [
|
|
38
|
+
"dbx__ref__dbx-component-patterns"
|
|
39
|
+
],
|
|
40
|
+
"sourcePath": "lib/action/action.confirm.directive.ts",
|
|
41
|
+
"example": "<button [dbxAction]=\"deleteAction\" [dbxActionConfirm]=\"{ header: 'Delete account?', confirmText: 'Delete' }\">Delete</button>",
|
|
42
|
+
"minimalExample": "<div [dbxActionConfirm]=\"cfg\"></div>",
|
|
43
|
+
"sourceLocation": {
|
|
44
|
+
"file": "src/lib/action/action.confirm.directive.ts",
|
|
45
|
+
"line": 39
|
|
46
|
+
}
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
"slug": "action-key-trigger",
|
|
50
|
+
"category": "action",
|
|
51
|
+
"kind": "directive",
|
|
52
|
+
"selector": "[dbxActionKeyTrigger]",
|
|
53
|
+
"className": "DbxActionKeyTriggerDirective",
|
|
54
|
+
"module": "@dereekb/dbx-web",
|
|
55
|
+
"description": "Triggers the parent action context when a specific keyboard key is released.\nDefaults to the \"enter\" key. Key names should be lowercase.",
|
|
56
|
+
"inputs": [
|
|
57
|
+
{
|
|
58
|
+
"name": "dbxActionKeyTrigger",
|
|
59
|
+
"type": "string",
|
|
60
|
+
"description": "",
|
|
61
|
+
"required": false,
|
|
62
|
+
"default": "DEFAULT_ACTION_KEY_TRIGGER"
|
|
63
|
+
}
|
|
64
|
+
],
|
|
65
|
+
"outputs": [],
|
|
66
|
+
"relatedSlugs": [
|
|
67
|
+
"action-confirm",
|
|
68
|
+
"action-snackbar"
|
|
69
|
+
],
|
|
70
|
+
"skillRefs": [
|
|
71
|
+
"dbx__ref__dbx-component-patterns"
|
|
72
|
+
],
|
|
73
|
+
"sourcePath": "lib/action/key.trigger.directive.ts",
|
|
74
|
+
"example": "<form [dbxAction]=\"saveAction\" [dbxActionKeyTrigger]=\"'cmd+s'\">...</form>",
|
|
75
|
+
"minimalExample": "<div [dbxActionKeyTrigger]=\"'enter'\"></div>",
|
|
76
|
+
"sourceLocation": {
|
|
77
|
+
"file": "src/lib/action/key.trigger.directive.ts",
|
|
78
|
+
"line": 25
|
|
79
|
+
}
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"slug": "button",
|
|
83
|
+
"category": "button",
|
|
84
|
+
"kind": "component",
|
|
85
|
+
"selector": "dbx-button",
|
|
86
|
+
"className": "DbxButtonComponent",
|
|
87
|
+
"module": "@dereekb/dbx-web",
|
|
88
|
+
"description": "Feature-rich button component that supports loading indicators, multiple Material button styles,\ncustom colors, icons, and floating action button (FAB) mode. Integrates with the dbxAction system\nfor automatic working/disabled state management.",
|
|
89
|
+
"inputs": [
|
|
90
|
+
{
|
|
91
|
+
"name": "bar",
|
|
92
|
+
"type": "boolean",
|
|
93
|
+
"description": "",
|
|
94
|
+
"required": false,
|
|
95
|
+
"default": "false"
|
|
96
|
+
},
|
|
97
|
+
{
|
|
98
|
+
"name": "type",
|
|
99
|
+
"type": "Maybe<DbxButtonType>",
|
|
100
|
+
"description": "",
|
|
101
|
+
"required": false
|
|
102
|
+
},
|
|
103
|
+
{
|
|
104
|
+
"name": "buttonStyle",
|
|
105
|
+
"type": "Maybe<DbxButtonStyle>",
|
|
106
|
+
"description": "",
|
|
107
|
+
"required": false
|
|
108
|
+
},
|
|
109
|
+
{
|
|
110
|
+
"name": "color",
|
|
111
|
+
"type": "Maybe<ThemePalette | DbxThemeColor>",
|
|
112
|
+
"description": "",
|
|
113
|
+
"required": false
|
|
114
|
+
},
|
|
115
|
+
{
|
|
116
|
+
"name": "spinnerColor",
|
|
117
|
+
"type": "Maybe<ThemePalette | DbxThemeColor>",
|
|
118
|
+
"description": "",
|
|
119
|
+
"required": false
|
|
120
|
+
},
|
|
121
|
+
{
|
|
122
|
+
"name": "customButtonColor",
|
|
123
|
+
"type": "Maybe<string>",
|
|
124
|
+
"description": "",
|
|
125
|
+
"required": false
|
|
126
|
+
},
|
|
127
|
+
{
|
|
128
|
+
"name": "customTextColor",
|
|
129
|
+
"type": "Maybe<string>",
|
|
130
|
+
"description": "",
|
|
131
|
+
"required": false
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"name": "customSpinnerColor",
|
|
135
|
+
"type": "Maybe<string>",
|
|
136
|
+
"description": "",
|
|
137
|
+
"required": false
|
|
138
|
+
},
|
|
139
|
+
{
|
|
140
|
+
"name": "basic",
|
|
141
|
+
"type": "boolean",
|
|
142
|
+
"description": "",
|
|
143
|
+
"required": false,
|
|
144
|
+
"default": "false"
|
|
145
|
+
},
|
|
146
|
+
{
|
|
147
|
+
"name": "tonal",
|
|
148
|
+
"type": "boolean",
|
|
149
|
+
"description": "",
|
|
150
|
+
"required": false,
|
|
151
|
+
"default": "false"
|
|
152
|
+
},
|
|
153
|
+
{
|
|
154
|
+
"name": "raised",
|
|
155
|
+
"type": "boolean",
|
|
156
|
+
"description": "",
|
|
157
|
+
"required": false,
|
|
158
|
+
"default": "false"
|
|
159
|
+
},
|
|
160
|
+
{
|
|
161
|
+
"name": "stroked",
|
|
162
|
+
"type": "boolean",
|
|
163
|
+
"description": "",
|
|
164
|
+
"required": false,
|
|
165
|
+
"default": "false"
|
|
166
|
+
},
|
|
167
|
+
{
|
|
168
|
+
"name": "flat",
|
|
169
|
+
"type": "boolean",
|
|
170
|
+
"description": "",
|
|
171
|
+
"required": false,
|
|
172
|
+
"default": "false"
|
|
173
|
+
},
|
|
174
|
+
{
|
|
175
|
+
"name": "iconOnly",
|
|
176
|
+
"type": "boolean",
|
|
177
|
+
"description": "",
|
|
178
|
+
"required": false,
|
|
179
|
+
"default": "false"
|
|
180
|
+
},
|
|
181
|
+
{
|
|
182
|
+
"name": "fab",
|
|
183
|
+
"type": "boolean",
|
|
184
|
+
"description": "",
|
|
185
|
+
"required": false,
|
|
186
|
+
"default": "false"
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"name": "customContent",
|
|
190
|
+
"type": "boolean",
|
|
191
|
+
"description": "",
|
|
192
|
+
"required": false,
|
|
193
|
+
"default": "false"
|
|
194
|
+
},
|
|
195
|
+
{
|
|
196
|
+
"name": "allowClickPropagation",
|
|
197
|
+
"type": "boolean",
|
|
198
|
+
"description": "",
|
|
199
|
+
"required": false,
|
|
200
|
+
"default": "false"
|
|
201
|
+
},
|
|
202
|
+
{
|
|
203
|
+
"name": "mode",
|
|
204
|
+
"type": "Maybe<ProgressSpinnerMode>",
|
|
205
|
+
"description": "",
|
|
206
|
+
"required": false
|
|
207
|
+
}
|
|
208
|
+
],
|
|
209
|
+
"outputs": [],
|
|
210
|
+
"contentProjection": "<ng-content></ng-content>",
|
|
211
|
+
"relatedSlugs": [
|
|
212
|
+
"icon-button",
|
|
213
|
+
"progress-spinner-button",
|
|
214
|
+
"progress-bar-button"
|
|
215
|
+
],
|
|
216
|
+
"skillRefs": [
|
|
217
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
218
|
+
],
|
|
219
|
+
"sourcePath": "lib/button/button.component.ts",
|
|
220
|
+
"example": "<dbx-button [text]=\"'Save'\" raised [dbxAction]=\"saveAction\">\n</dbx-button>",
|
|
221
|
+
"minimalExample": "<dbx-button text=\"Save\" raised [dbxAction]=\"saveAction\"></dbx-button>",
|
|
222
|
+
"sourceLocation": {
|
|
223
|
+
"file": "src/lib/button/button.component.ts",
|
|
224
|
+
"line": 45
|
|
225
|
+
}
|
|
226
|
+
},
|
|
227
|
+
{
|
|
228
|
+
"slug": "button-spacer",
|
|
229
|
+
"category": "button",
|
|
230
|
+
"kind": "directive",
|
|
231
|
+
"selector": "dbx-button-spacer,[dbxButtonSpacer]",
|
|
232
|
+
"className": "DbxButtonSpacerDirective",
|
|
233
|
+
"module": "@dereekb/dbx-web",
|
|
234
|
+
"description": "Adds inline spacing between adjacent buttons. Can be used as an element or attribute.",
|
|
235
|
+
"inputs": [],
|
|
236
|
+
"outputs": [],
|
|
237
|
+
"relatedSlugs": [
|
|
238
|
+
"bar",
|
|
239
|
+
"spacer",
|
|
240
|
+
"button"
|
|
241
|
+
],
|
|
242
|
+
"skillRefs": [
|
|
243
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
244
|
+
],
|
|
245
|
+
"sourcePath": "lib/button/button.spacer.directive.ts",
|
|
246
|
+
"example": "<dbx-bar>\n <dbx-button text=\"Save\" raised></dbx-button>\n <dbx-button-spacer></dbx-button-spacer>\n <dbx-button text=\"Cancel\"></dbx-button>\n</dbx-bar>",
|
|
247
|
+
"minimalExample": "<dbx-button-spacer></dbx-button-spacer>",
|
|
248
|
+
"sourceLocation": {
|
|
249
|
+
"file": "src/lib/button/button.spacer.directive.ts",
|
|
250
|
+
"line": 24
|
|
251
|
+
}
|
|
252
|
+
},
|
|
253
|
+
{
|
|
254
|
+
"slug": "error",
|
|
255
|
+
"category": "feedback",
|
|
256
|
+
"kind": "component",
|
|
257
|
+
"selector": "dbx-error",
|
|
258
|
+
"className": "DbxErrorComponent",
|
|
259
|
+
"module": "@dereekb/dbx-web",
|
|
260
|
+
"description": "Root error component that displays content related to an error.\n\nConverts an {@link ErrorInput} into a {@link ReadableError} and renders either a default error view\nwith an icon and message, or a custom error widget registered via {@link DbxErrorWidgetService}.\nClicking the error icon opens a popover with detailed error information.",
|
|
261
|
+
"inputs": [
|
|
262
|
+
{
|
|
263
|
+
"name": "error",
|
|
264
|
+
"type": "Maybe<ErrorInput>",
|
|
265
|
+
"description": "",
|
|
266
|
+
"required": false
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
"name": "iconOnly",
|
|
270
|
+
"type": "Maybe<boolean>",
|
|
271
|
+
"description": "",
|
|
272
|
+
"required": false,
|
|
273
|
+
"default": "false"
|
|
274
|
+
}
|
|
275
|
+
],
|
|
276
|
+
"outputs": [
|
|
277
|
+
{
|
|
278
|
+
"name": "popoverOpened",
|
|
279
|
+
"emits": "NgPopoverRef",
|
|
280
|
+
"description": ""
|
|
281
|
+
}
|
|
282
|
+
],
|
|
283
|
+
"relatedSlugs": [
|
|
284
|
+
"error-snackbar",
|
|
285
|
+
"error-view",
|
|
286
|
+
"loading"
|
|
287
|
+
],
|
|
288
|
+
"skillRefs": [
|
|
289
|
+
"dbx__ref__dbx-component-patterns"
|
|
290
|
+
],
|
|
291
|
+
"sourcePath": "lib/error/error.component.ts",
|
|
292
|
+
"example": "<dbx-error [error]=\"error$ | async\"></dbx-error>",
|
|
293
|
+
"minimalExample": "<dbx-error [error]=\"error\"></dbx-error>",
|
|
294
|
+
"sourceLocation": {
|
|
295
|
+
"file": "src/lib/error/error.component.ts",
|
|
296
|
+
"line": 52
|
|
297
|
+
}
|
|
298
|
+
},
|
|
299
|
+
{
|
|
300
|
+
"slug": "action-snackbar-error",
|
|
301
|
+
"category": "action",
|
|
302
|
+
"kind": "directive",
|
|
303
|
+
"selector": "[dbxActionSnackbarError]",
|
|
304
|
+
"className": "DbxActionSnackbarErrorDirective",
|
|
305
|
+
"module": "@dereekb/dbx-web",
|
|
306
|
+
"description": "Displays action errors in a snackbar notification.\n\nSubscribes to the action context's error stream and shows a snackbar via {@link DbxErrorSnackbarService}\nwhenever an error occurs. Accepts an optional configuration or a duration in milliseconds as input.",
|
|
307
|
+
"inputs": [
|
|
308
|
+
{
|
|
309
|
+
"name": "dbxActionSnackbarError",
|
|
310
|
+
"type": "Maybe<DbxErrorSnackbarConfig> | Milliseconds | ''",
|
|
311
|
+
"description": "",
|
|
312
|
+
"required": false,
|
|
313
|
+
"default": "undefined"
|
|
314
|
+
}
|
|
315
|
+
],
|
|
316
|
+
"outputs": [],
|
|
317
|
+
"relatedSlugs": [
|
|
318
|
+
"action-snackbar"
|
|
319
|
+
],
|
|
320
|
+
"skillRefs": [
|
|
321
|
+
"dbx__ref__dbx-component-patterns"
|
|
322
|
+
],
|
|
323
|
+
"sourcePath": "lib/error/error.snackbar.action.directive.ts",
|
|
324
|
+
"example": "<button [dbxAction]=\"saveAction\" dbxActionSnackbarError>Save</button>",
|
|
325
|
+
"minimalExample": "<div [dbxActionSnackbarError]></div>",
|
|
326
|
+
"sourceLocation": {
|
|
327
|
+
"file": "src/lib/error/error.snackbar.action.directive.ts",
|
|
328
|
+
"line": 28
|
|
329
|
+
}
|
|
330
|
+
},
|
|
331
|
+
{
|
|
332
|
+
"slug": "error-snackbar",
|
|
333
|
+
"category": "feedback",
|
|
334
|
+
"kind": "component",
|
|
335
|
+
"selector": "dbx-error-snackbar",
|
|
336
|
+
"className": "DbxErrorSnackbarComponent",
|
|
337
|
+
"module": "@dereekb/dbx-web",
|
|
338
|
+
"description": "Snackbar component that displays an error with a dismiss button.\n\nSupports an optional auto-dismiss timer that pauses while an error detail popover is open.\nTypically opened via {@link DbxErrorSnackbarService} or the static {@link DbxErrorSnackbarComponent.showErrorSnackbar} method.",
|
|
339
|
+
"inputs": [],
|
|
340
|
+
"outputs": [],
|
|
341
|
+
"relatedSlugs": [
|
|
342
|
+
"error"
|
|
343
|
+
],
|
|
344
|
+
"skillRefs": [
|
|
345
|
+
"dbx__ref__dbx-component-patterns"
|
|
346
|
+
],
|
|
347
|
+
"sourcePath": "lib/error/error.snackbar.component.ts",
|
|
348
|
+
"example": "// Triggered via DbxErrorSnackbarService.showError(error)",
|
|
349
|
+
"minimalExample": "<dbx-error-snackbar></dbx-error-snackbar>",
|
|
350
|
+
"sourceLocation": {
|
|
351
|
+
"file": "src/lib/error/error.snackbar.component.ts",
|
|
352
|
+
"line": 51
|
|
353
|
+
}
|
|
354
|
+
},
|
|
355
|
+
{
|
|
356
|
+
"slug": "error-view",
|
|
357
|
+
"category": "feedback",
|
|
358
|
+
"kind": "component",
|
|
359
|
+
"selector": "dbx-error-view",
|
|
360
|
+
"className": "DbxErrorViewComponent",
|
|
361
|
+
"module": "@dereekb/dbx-web",
|
|
362
|
+
"description": "Low-level error view that renders a Material icon button and an optional error message.\n\nEmits a {@link DbxErrorViewButtonEvent} when the button is clicked, which is typically used\nto open an error detail popover. Used internally by {@link DbxErrorComponent}.",
|
|
363
|
+
"inputs": [
|
|
364
|
+
{
|
|
365
|
+
"name": "icon",
|
|
366
|
+
"type": "string",
|
|
367
|
+
"description": "",
|
|
368
|
+
"required": false,
|
|
369
|
+
"default": "'error'"
|
|
370
|
+
},
|
|
371
|
+
{
|
|
372
|
+
"name": "message",
|
|
373
|
+
"type": "Maybe<string>",
|
|
374
|
+
"description": "",
|
|
375
|
+
"required": false
|
|
376
|
+
},
|
|
377
|
+
{
|
|
378
|
+
"name": "buttonDisabled",
|
|
379
|
+
"type": "Maybe<boolean>",
|
|
380
|
+
"description": "Whether or not the error button is disabled.",
|
|
381
|
+
"required": false
|
|
382
|
+
}
|
|
383
|
+
],
|
|
384
|
+
"outputs": [
|
|
385
|
+
{
|
|
386
|
+
"name": "buttonClick",
|
|
387
|
+
"emits": "DbxErrorViewButtonEvent",
|
|
388
|
+
"description": ""
|
|
389
|
+
}
|
|
390
|
+
],
|
|
391
|
+
"relatedSlugs": [
|
|
392
|
+
"error",
|
|
393
|
+
"error-snackbar"
|
|
394
|
+
],
|
|
395
|
+
"skillRefs": [
|
|
396
|
+
"dbx__ref__dbx-component-patterns"
|
|
397
|
+
],
|
|
398
|
+
"sourcePath": "lib/error/error.view.component.ts",
|
|
399
|
+
"example": "<dbx-error-view [error]=\"error\">\n <dbx-button text=\"Retry\" [dbxAction]=\"retryAction\"></dbx-button>\n</dbx-error-view>",
|
|
400
|
+
"minimalExample": "<dbx-error-view [error]=\"error\"></dbx-error-view>",
|
|
401
|
+
"sourceLocation": {
|
|
402
|
+
"file": "src/lib/error/error.view.component.ts",
|
|
403
|
+
"line": 39
|
|
404
|
+
}
|
|
405
|
+
},
|
|
406
|
+
{
|
|
407
|
+
"slug": "basic-loading",
|
|
408
|
+
"category": "feedback",
|
|
409
|
+
"kind": "component",
|
|
410
|
+
"selector": "dbx-basic-loading",
|
|
411
|
+
"className": "DbxBasicLoadingComponent",
|
|
412
|
+
"module": "@dereekb/dbx-web",
|
|
413
|
+
"description": "Low-level loading component that renders a spinner or progress bar, error state, and projected content.\n\nPrefer using {@link DbxLoadingComponent} (`<dbx-loading>`) which wraps this component with\nsupport for {@link LoadingContext} streams.",
|
|
414
|
+
"inputs": [
|
|
415
|
+
{
|
|
416
|
+
"name": "diameter",
|
|
417
|
+
"type": "Maybe<number>",
|
|
418
|
+
"description": "",
|
|
419
|
+
"required": false
|
|
420
|
+
},
|
|
421
|
+
{
|
|
422
|
+
"name": "mode",
|
|
423
|
+
"type": "Maybe<ProgressBarMode | ProgressSpinnerMode>",
|
|
424
|
+
"description": "",
|
|
425
|
+
"required": false
|
|
426
|
+
},
|
|
427
|
+
{
|
|
428
|
+
"name": "color",
|
|
429
|
+
"type": "ThemePalette | DbxThemeColor",
|
|
430
|
+
"description": "",
|
|
431
|
+
"required": false,
|
|
432
|
+
"default": "'primary'"
|
|
433
|
+
},
|
|
434
|
+
{
|
|
435
|
+
"name": "text",
|
|
436
|
+
"type": "Maybe<string>",
|
|
437
|
+
"description": "",
|
|
438
|
+
"required": false
|
|
439
|
+
},
|
|
440
|
+
{
|
|
441
|
+
"name": "linear",
|
|
442
|
+
"type": "Maybe<boolean>",
|
|
443
|
+
"description": "",
|
|
444
|
+
"required": false,
|
|
445
|
+
"default": "false"
|
|
446
|
+
},
|
|
447
|
+
{
|
|
448
|
+
"name": "show",
|
|
449
|
+
"type": "Maybe<boolean>",
|
|
450
|
+
"description": "",
|
|
451
|
+
"required": false,
|
|
452
|
+
"default": "true"
|
|
453
|
+
},
|
|
454
|
+
{
|
|
455
|
+
"name": "loading",
|
|
456
|
+
"type": "Maybe<DbxLoadingIsLoadingOrProgress>",
|
|
457
|
+
"description": "",
|
|
458
|
+
"required": false
|
|
459
|
+
},
|
|
460
|
+
{
|
|
461
|
+
"name": "error",
|
|
462
|
+
"type": "Maybe<ErrorInput>",
|
|
463
|
+
"description": "",
|
|
464
|
+
"required": false
|
|
465
|
+
}
|
|
466
|
+
],
|
|
467
|
+
"outputs": [],
|
|
468
|
+
"relatedSlugs": [
|
|
469
|
+
"loading",
|
|
470
|
+
"loading-progress",
|
|
471
|
+
"error"
|
|
472
|
+
],
|
|
473
|
+
"skillRefs": [
|
|
474
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
475
|
+
],
|
|
476
|
+
"sourcePath": "lib/loading/basic-loading.component.ts",
|
|
477
|
+
"example": "<dbx-basic-loading [loading]=\"true\" color=\"accent\" text=\"Loading data...\">\n <p>Content appears here when loading is false.</p>\n</dbx-basic-loading>",
|
|
478
|
+
"minimalExample": "<dbx-basic-loading [loading]=\"true\"><p>Content</p></dbx-basic-loading>",
|
|
479
|
+
"sourceLocation": {
|
|
480
|
+
"file": "src/lib/loading/basic-loading.component.ts",
|
|
481
|
+
"line": 45
|
|
482
|
+
}
|
|
483
|
+
},
|
|
484
|
+
{
|
|
485
|
+
"slug": "loading-progress",
|
|
486
|
+
"category": "feedback",
|
|
487
|
+
"kind": "component",
|
|
488
|
+
"selector": "dbx-loading-progress",
|
|
489
|
+
"className": "DbxLoadingProgressComponent",
|
|
490
|
+
"module": "@dereekb/dbx-web",
|
|
491
|
+
"description": "Renders a Material progress spinner or progress bar to indicate loading.\n\nSupports both linear (bar) and circular (spinner) modes with configurable\ndiameter, color, and optional hint text below the indicator.",
|
|
492
|
+
"inputs": [
|
|
493
|
+
{
|
|
494
|
+
"name": "diameter",
|
|
495
|
+
"type": "Maybe<number>",
|
|
496
|
+
"description": "",
|
|
497
|
+
"required": false,
|
|
498
|
+
"default": "this.defaultDiameter"
|
|
499
|
+
},
|
|
500
|
+
{
|
|
501
|
+
"name": "text",
|
|
502
|
+
"type": "Maybe<string>",
|
|
503
|
+
"description": "",
|
|
504
|
+
"required": false
|
|
505
|
+
},
|
|
506
|
+
{
|
|
507
|
+
"name": "linear",
|
|
508
|
+
"type": "Maybe<boolean>",
|
|
509
|
+
"description": "",
|
|
510
|
+
"required": false
|
|
511
|
+
},
|
|
512
|
+
{
|
|
513
|
+
"name": "mode",
|
|
514
|
+
"type": "ProgressBarMode | ProgressSpinnerMode",
|
|
515
|
+
"description": "",
|
|
516
|
+
"required": false,
|
|
517
|
+
"default": "'indeterminate'"
|
|
518
|
+
},
|
|
519
|
+
{
|
|
520
|
+
"name": "color",
|
|
521
|
+
"type": "ThemePalette | DbxThemeColor",
|
|
522
|
+
"description": "",
|
|
523
|
+
"required": false,
|
|
524
|
+
"default": "'primary'"
|
|
525
|
+
},
|
|
526
|
+
{
|
|
527
|
+
"name": "value",
|
|
528
|
+
"type": "Maybe<number>",
|
|
529
|
+
"description": "",
|
|
530
|
+
"required": false
|
|
531
|
+
},
|
|
532
|
+
{
|
|
533
|
+
"name": "bufferValue",
|
|
534
|
+
"type": "Maybe<number>",
|
|
535
|
+
"description": "",
|
|
536
|
+
"required": false
|
|
537
|
+
}
|
|
538
|
+
],
|
|
539
|
+
"outputs": [],
|
|
540
|
+
"relatedSlugs": [
|
|
541
|
+
"loading",
|
|
542
|
+
"basic-loading"
|
|
543
|
+
],
|
|
544
|
+
"skillRefs": [
|
|
545
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
546
|
+
],
|
|
547
|
+
"sourcePath": "lib/loading/loading-progress.component.ts",
|
|
548
|
+
"example": "<dbx-loading-progress mode=\"bar\"></dbx-loading-progress>",
|
|
549
|
+
"minimalExample": "<dbx-loading-progress></dbx-loading-progress>",
|
|
550
|
+
"sourceLocation": {
|
|
551
|
+
"file": "src/lib/loading/loading-progress.component.ts",
|
|
552
|
+
"line": 35
|
|
553
|
+
}
|
|
554
|
+
},
|
|
555
|
+
{
|
|
556
|
+
"slug": "action-loading-context",
|
|
557
|
+
"category": "action",
|
|
558
|
+
"kind": "directive",
|
|
559
|
+
"selector": "[dbxActionLoadingContext]",
|
|
560
|
+
"className": "DbxActionLoadingContextDirective",
|
|
561
|
+
"module": "@dereekb/dbx-web",
|
|
562
|
+
"description": "Links a {@link DbxLoadingComponent} to a {@link DbxActionContextStoreSourceInstance} by forwarding its loading state.\n\nApply to a `<dbx-loading>` element that is within an action context to automatically\nreflect the action's loading state in the loading component.",
|
|
563
|
+
"inputs": [],
|
|
564
|
+
"outputs": [],
|
|
565
|
+
"relatedSlugs": [
|
|
566
|
+
"loading",
|
|
567
|
+
"action-snackbar"
|
|
568
|
+
],
|
|
569
|
+
"skillRefs": [
|
|
570
|
+
"dbx__ref__dbx-component-patterns"
|
|
571
|
+
],
|
|
572
|
+
"sourcePath": "lib/loading/loading.action.directive.ts",
|
|
573
|
+
"example": "<dbx-loading [state]=\"ctx.state$ | async\">\n <button [dbxAction]=\"saveAction\" dbxActionLoadingContext>Save</button>\n</dbx-loading>",
|
|
574
|
+
"minimalExample": "<button [dbxActionLoadingContext]></button>",
|
|
575
|
+
"sourceLocation": {
|
|
576
|
+
"file": "src/lib/loading/loading.action.directive.ts",
|
|
577
|
+
"line": 27
|
|
578
|
+
}
|
|
579
|
+
},
|
|
580
|
+
{
|
|
581
|
+
"slug": "loading",
|
|
582
|
+
"category": "feedback",
|
|
583
|
+
"kind": "component",
|
|
584
|
+
"selector": "dbx-loading",
|
|
585
|
+
"className": "DbxLoadingComponent",
|
|
586
|
+
"module": "@dereekb/dbx-web",
|
|
587
|
+
"description": "Primary loading wrapper that shows a spinner/progress bar while data is being fetched,\nthen reveals projected content on completion, or displays an error state.\n\nAccepts a {@link LoadingContext} observable via the `context` input to automatically\ntrack loading and error state from reactive streams. Also supports manual `loading`\nand `error` inputs for simpler use cases.",
|
|
588
|
+
"inputs": [
|
|
589
|
+
{
|
|
590
|
+
"name": "padding",
|
|
591
|
+
"type": "Maybe<boolean>",
|
|
592
|
+
"description": "Whether or not to add padding to the linear presentation when linear is complete. This prevents the linear bar from pushing content around.",
|
|
593
|
+
"required": false,
|
|
594
|
+
"default": "false"
|
|
595
|
+
},
|
|
596
|
+
{
|
|
597
|
+
"name": "show",
|
|
598
|
+
"type": "Maybe<boolean>",
|
|
599
|
+
"description": "",
|
|
600
|
+
"required": false
|
|
601
|
+
},
|
|
602
|
+
{
|
|
603
|
+
"name": "text",
|
|
604
|
+
"type": "Maybe<string>",
|
|
605
|
+
"description": "",
|
|
606
|
+
"required": false
|
|
607
|
+
},
|
|
608
|
+
{
|
|
609
|
+
"name": "mode",
|
|
610
|
+
"type": "Maybe<ProgressBarMode>",
|
|
611
|
+
"description": "",
|
|
612
|
+
"required": false
|
|
613
|
+
},
|
|
614
|
+
{
|
|
615
|
+
"name": "color",
|
|
616
|
+
"type": "ThemePalette | DbxThemeColor",
|
|
617
|
+
"description": "",
|
|
618
|
+
"required": false,
|
|
619
|
+
"default": "'primary'"
|
|
620
|
+
},
|
|
621
|
+
{
|
|
622
|
+
"name": "diameter",
|
|
623
|
+
"type": "Maybe<number>",
|
|
624
|
+
"description": "",
|
|
625
|
+
"required": false
|
|
626
|
+
},
|
|
627
|
+
{
|
|
628
|
+
"name": "linear",
|
|
629
|
+
"type": "Maybe<boolean>",
|
|
630
|
+
"description": "",
|
|
631
|
+
"required": false
|
|
632
|
+
},
|
|
633
|
+
{
|
|
634
|
+
"name": "loading",
|
|
635
|
+
"type": "Maybe<DbxLoadingIsLoadingOrProgress>",
|
|
636
|
+
"description": "",
|
|
637
|
+
"required": false
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
"name": "error",
|
|
641
|
+
"type": "Maybe<ErrorInput>",
|
|
642
|
+
"description": "",
|
|
643
|
+
"required": false
|
|
644
|
+
},
|
|
645
|
+
{
|
|
646
|
+
"name": "context",
|
|
647
|
+
"type": "MaybeObservableOrValue<LoadingContext>",
|
|
648
|
+
"description": "",
|
|
649
|
+
"required": false
|
|
650
|
+
}
|
|
651
|
+
],
|
|
652
|
+
"outputs": [],
|
|
653
|
+
"contentProjection": "<ng-content></ng-content>",
|
|
654
|
+
"relatedSlugs": [
|
|
655
|
+
"basic-loading",
|
|
656
|
+
"loading-progress",
|
|
657
|
+
"error"
|
|
658
|
+
],
|
|
659
|
+
"skillRefs": [
|
|
660
|
+
"dbx__ref__dbx-component-patterns"
|
|
661
|
+
],
|
|
662
|
+
"sourcePath": "lib/loading/loading.component.ts",
|
|
663
|
+
"example": "<dbx-loading [state]=\"state$ | async\" text=\"Loading items...\">\n <dbx-list [state$]=\"state$\" [config]=\"listConfig\"></dbx-list>\n</dbx-loading>",
|
|
664
|
+
"minimalExample": "<dbx-loading [state]=\"state$ | async\">Body</dbx-loading>",
|
|
665
|
+
"sourceLocation": {
|
|
666
|
+
"file": "src/lib/loading/loading.component.ts",
|
|
667
|
+
"line": 44
|
|
668
|
+
}
|
|
669
|
+
},
|
|
670
|
+
{
|
|
671
|
+
"slug": "resized",
|
|
672
|
+
"category": "screen",
|
|
673
|
+
"kind": "directive",
|
|
674
|
+
"selector": "[dbxResized]",
|
|
675
|
+
"className": "DbxResizedDirective",
|
|
676
|
+
"module": "@dereekb/dbx-web",
|
|
677
|
+
"description": "Emits {@link ResizedEvent} values whenever the host element is resized.\n\nUses a `ResizeObserver` internally via {@link resizeSignal}.",
|
|
678
|
+
"inputs": [],
|
|
679
|
+
"outputs": [
|
|
680
|
+
{
|
|
681
|
+
"name": "dbxResized",
|
|
682
|
+
"emits": "ResizedEvent",
|
|
683
|
+
"description": ""
|
|
684
|
+
}
|
|
685
|
+
],
|
|
686
|
+
"relatedSlugs": [
|
|
687
|
+
"flex-group"
|
|
688
|
+
],
|
|
689
|
+
"skillRefs": [
|
|
690
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
691
|
+
],
|
|
692
|
+
"sourcePath": "lib/screen/resize.directive.ts",
|
|
693
|
+
"example": "<div (dbxResized)=\"onResized($event)\" class=\"resizable-panel\"></div>",
|
|
694
|
+
"minimalExample": "<div (dbxResized)=\"handle($event)\"></div>",
|
|
695
|
+
"sourceLocation": {
|
|
696
|
+
"file": "src/lib/screen/resize.directive.ts",
|
|
697
|
+
"line": 23
|
|
698
|
+
}
|
|
699
|
+
},
|
|
700
|
+
{
|
|
701
|
+
"slug": "action-snackbar",
|
|
702
|
+
"category": "action",
|
|
703
|
+
"kind": "directive",
|
|
704
|
+
"selector": "[dbxActionSnackbar]",
|
|
705
|
+
"className": "DbxActionSnackbarDirective",
|
|
706
|
+
"module": "@dereekb/dbx-web",
|
|
707
|
+
"description": "Displays a Material snackbar notification when the parent action transitions between loading states\n(loading, success, error). Supports built-in message presets via `dbxActionSnackbarDefault` and\ncustom generator functions via the `dbxActionSnackbar` input.",
|
|
708
|
+
"inputs": [
|
|
709
|
+
{
|
|
710
|
+
"name": "dbxActionSnackbarDefault",
|
|
711
|
+
"type": "Maybe<DbxActionSnackbarType>",
|
|
712
|
+
"description": "",
|
|
713
|
+
"required": false
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
"name": "dbxActionSnackbarUndo",
|
|
717
|
+
"type": "Maybe<DbxActionSnackbarGeneratorUndoInput<T, O>>",
|
|
718
|
+
"description": "",
|
|
719
|
+
"required": false
|
|
720
|
+
},
|
|
721
|
+
{
|
|
722
|
+
"name": "dbxActionSnackbar",
|
|
723
|
+
"type": "Maybe<DbxActionSnackbarDisplayConfigGeneratorFunction>",
|
|
724
|
+
"description": "",
|
|
725
|
+
"required": false,
|
|
726
|
+
"default": "undefined"
|
|
727
|
+
}
|
|
728
|
+
],
|
|
729
|
+
"outputs": [],
|
|
730
|
+
"relatedSlugs": [
|
|
731
|
+
"action-snackbar-error",
|
|
732
|
+
"action-confirm",
|
|
733
|
+
"error-snackbar"
|
|
734
|
+
],
|
|
735
|
+
"skillRefs": [
|
|
736
|
+
"dbx__ref__dbx-component-patterns"
|
|
737
|
+
],
|
|
738
|
+
"sourcePath": "lib/action/snackbar/action.snackbar.directive.ts",
|
|
739
|
+
"example": "<button [dbxAction]=\"saveAction\" [dbxActionSnackbar]=\"snackbarFn\">Save</button>",
|
|
740
|
+
"minimalExample": "<div [dbxActionSnackbar]=\"fn\"></div>",
|
|
741
|
+
"sourceLocation": {
|
|
742
|
+
"file": "src/lib/action/snackbar/action.snackbar.directive.ts",
|
|
743
|
+
"line": 28
|
|
744
|
+
}
|
|
745
|
+
},
|
|
746
|
+
{
|
|
747
|
+
"slug": "action-transition-safety",
|
|
748
|
+
"category": "action",
|
|
749
|
+
"kind": "directive",
|
|
750
|
+
"selector": "[dbxActionTransitionSafety]",
|
|
751
|
+
"className": "DbxActionTransitionSafetyDirective",
|
|
752
|
+
"module": "@dereekb/dbx-web",
|
|
753
|
+
"description": "Prevents UI Router transitions when the action has unsaved changes. Depending on the\nconfigured safety type, it can auto-trigger the action, show a confirmation dialog,\nor allow the transition without intervention.\n\nNOTE: This directive only works with UI-Router (not Angular Router).",
|
|
754
|
+
"inputs": [
|
|
755
|
+
{
|
|
756
|
+
"name": "dbxActionTransitionSafety",
|
|
757
|
+
"type": "DbxActionTransitionSafetyType",
|
|
758
|
+
"description": "",
|
|
759
|
+
"required": false
|
|
760
|
+
}
|
|
761
|
+
],
|
|
762
|
+
"outputs": [],
|
|
763
|
+
"relatedSlugs": [
|
|
764
|
+
"action-confirm"
|
|
765
|
+
],
|
|
766
|
+
"skillRefs": [
|
|
767
|
+
"dbx__ref__dbx-component-patterns"
|
|
768
|
+
],
|
|
769
|
+
"sourcePath": "lib/action/transition/transition.safety.directive.ts",
|
|
770
|
+
"example": "<form [dbxAction]=\"formAction\" dbxActionTransitionSafety>...</form>",
|
|
771
|
+
"minimalExample": "<form [dbxActionTransitionSafety]></form>",
|
|
772
|
+
"sourceLocation": {
|
|
773
|
+
"file": "src/lib/action/transition/transition.safety.directive.ts",
|
|
774
|
+
"line": 39
|
|
775
|
+
}
|
|
776
|
+
},
|
|
777
|
+
{
|
|
778
|
+
"slug": "icon-button",
|
|
779
|
+
"category": "button",
|
|
780
|
+
"kind": "component",
|
|
781
|
+
"selector": "dbx-icon-button",
|
|
782
|
+
"className": "DbxIconButtonComponent",
|
|
783
|
+
"module": "@dereekb/dbx-web",
|
|
784
|
+
"description": "Lightweight button that renders as either an icon-only Material icon button or a text button\nwith an icon prefix, depending on whether text is provided.",
|
|
785
|
+
"inputs": [],
|
|
786
|
+
"outputs": [],
|
|
787
|
+
"contentProjection": "<ng-content></ng-content>",
|
|
788
|
+
"relatedSlugs": [
|
|
789
|
+
"button"
|
|
790
|
+
],
|
|
791
|
+
"skillRefs": [
|
|
792
|
+
"dbx__migration__migrate-dbx-icon-button"
|
|
793
|
+
],
|
|
794
|
+
"sourcePath": "lib/button/icon/icon.button.component.ts",
|
|
795
|
+
"example": "<dbx-icon-button icon=\"delete\" color=\"warn\" [dbxAction]=\"deleteAction\"></dbx-icon-button>",
|
|
796
|
+
"minimalExample": "<dbx-icon-button icon=\"add\"></dbx-icon-button>",
|
|
797
|
+
"sourceLocation": {
|
|
798
|
+
"file": "src/lib/button/icon/icon.button.component.ts",
|
|
799
|
+
"line": 25
|
|
800
|
+
}
|
|
801
|
+
},
|
|
802
|
+
{
|
|
803
|
+
"slug": "progress-bar-button",
|
|
804
|
+
"category": "button",
|
|
805
|
+
"kind": "component",
|
|
806
|
+
"selector": "dbx-progress-bar-button,dbx-bar-button",
|
|
807
|
+
"className": "DbxProgressBarButtonComponent",
|
|
808
|
+
"module": "@dereekb/dbx-web",
|
|
809
|
+
"description": "Progress button that displays a Material progress bar beneath the button while working.",
|
|
810
|
+
"inputs": [
|
|
811
|
+
{
|
|
812
|
+
"name": "config",
|
|
813
|
+
"type": "Maybe<DbxProgressButtonConfig>",
|
|
814
|
+
"description": "",
|
|
815
|
+
"required": true
|
|
816
|
+
},
|
|
817
|
+
{
|
|
818
|
+
"name": "buttonId",
|
|
819
|
+
"type": "Maybe<string>",
|
|
820
|
+
"description": "",
|
|
821
|
+
"required": false
|
|
822
|
+
},
|
|
823
|
+
{
|
|
824
|
+
"name": "working",
|
|
825
|
+
"type": "Maybe<DbxButtonWorking>",
|
|
826
|
+
"description": "",
|
|
827
|
+
"required": false
|
|
828
|
+
},
|
|
829
|
+
{
|
|
830
|
+
"name": "disabled",
|
|
831
|
+
"type": "Maybe<boolean>",
|
|
832
|
+
"description": "",
|
|
833
|
+
"required": false
|
|
834
|
+
},
|
|
835
|
+
{
|
|
836
|
+
"name": "allowClickPropagation",
|
|
837
|
+
"type": "boolean",
|
|
838
|
+
"description": "When true, the click handler will not call `stopImmediatePropagation()`,\nallowing the click event to continue bubbling. Needed for components like\nfile upload buttons where a parent must handle the click synchronously.",
|
|
839
|
+
"required": false,
|
|
840
|
+
"default": "false"
|
|
841
|
+
}
|
|
842
|
+
],
|
|
843
|
+
"outputs": [
|
|
844
|
+
{
|
|
845
|
+
"name": "btnClick",
|
|
846
|
+
"emits": "MouseEvent",
|
|
847
|
+
"description": ""
|
|
848
|
+
}
|
|
849
|
+
],
|
|
850
|
+
"relatedSlugs": [
|
|
851
|
+
"button",
|
|
852
|
+
"progress-spinner-button"
|
|
853
|
+
],
|
|
854
|
+
"skillRefs": [
|
|
855
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
856
|
+
],
|
|
857
|
+
"sourcePath": "lib/button/progress/bar.button.component.ts",
|
|
858
|
+
"example": "<dbx-progress-bar-button [config]=\"cfg\" (btnClick)=\"onClick()\"></dbx-progress-bar-button>",
|
|
859
|
+
"minimalExample": "<dbx-progress-bar-button [config]=\"cfg\"></dbx-progress-bar-button>",
|
|
860
|
+
"sourceLocation": {
|
|
861
|
+
"file": "src/lib/button/progress/bar.button.component.ts",
|
|
862
|
+
"line": 30
|
|
863
|
+
}
|
|
864
|
+
},
|
|
865
|
+
{
|
|
866
|
+
"slug": "progress-spinner-button",
|
|
867
|
+
"category": "button",
|
|
868
|
+
"kind": "component",
|
|
869
|
+
"selector": "dbx-progress-spinner-button,dbx-spinner-button",
|
|
870
|
+
"className": "DbxProgressSpinnerButtonComponent",
|
|
871
|
+
"module": "@dereekb/dbx-web",
|
|
872
|
+
"description": "Progress button that overlays a Material progress spinner on the button while working.\nSupports icon-only, FAB, and text button modes with automatic spinner sizing.",
|
|
873
|
+
"inputs": [
|
|
874
|
+
{
|
|
875
|
+
"name": "config",
|
|
876
|
+
"type": "Maybe<DbxProgressButtonConfig>",
|
|
877
|
+
"description": "",
|
|
878
|
+
"required": true
|
|
879
|
+
},
|
|
880
|
+
{
|
|
881
|
+
"name": "buttonId",
|
|
882
|
+
"type": "Maybe<string>",
|
|
883
|
+
"description": "",
|
|
884
|
+
"required": false
|
|
885
|
+
},
|
|
886
|
+
{
|
|
887
|
+
"name": "working",
|
|
888
|
+
"type": "Maybe<DbxButtonWorking>",
|
|
889
|
+
"description": "",
|
|
890
|
+
"required": false
|
|
891
|
+
},
|
|
892
|
+
{
|
|
893
|
+
"name": "disabled",
|
|
894
|
+
"type": "Maybe<boolean>",
|
|
895
|
+
"description": "",
|
|
896
|
+
"required": false
|
|
897
|
+
},
|
|
898
|
+
{
|
|
899
|
+
"name": "allowClickPropagation",
|
|
900
|
+
"type": "boolean",
|
|
901
|
+
"description": "When true, the click handler will not call `stopImmediatePropagation()`,\nallowing the click event to continue bubbling. Needed for components like\nfile upload buttons where a parent must handle the click synchronously.",
|
|
902
|
+
"required": false,
|
|
903
|
+
"default": "false"
|
|
904
|
+
}
|
|
905
|
+
],
|
|
906
|
+
"outputs": [
|
|
907
|
+
{
|
|
908
|
+
"name": "btnClick",
|
|
909
|
+
"emits": "MouseEvent",
|
|
910
|
+
"description": ""
|
|
911
|
+
}
|
|
912
|
+
],
|
|
913
|
+
"relatedSlugs": [
|
|
914
|
+
"button",
|
|
915
|
+
"progress-bar-button"
|
|
916
|
+
],
|
|
917
|
+
"skillRefs": [
|
|
918
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
919
|
+
],
|
|
920
|
+
"sourcePath": "lib/button/progress/spinner.button.component.ts",
|
|
921
|
+
"example": "<dbx-progress-spinner-button [config]=\"cfg\" (btnClick)=\"onClick()\"></dbx-progress-spinner-button>",
|
|
922
|
+
"minimalExample": "<dbx-progress-spinner-button [config]=\"cfg\"></dbx-progress-spinner-button>",
|
|
923
|
+
"sourceLocation": {
|
|
924
|
+
"file": "src/lib/button/progress/spinner.button.component.ts",
|
|
925
|
+
"line": 30
|
|
926
|
+
}
|
|
927
|
+
},
|
|
928
|
+
{
|
|
929
|
+
"slug": "dialog-content",
|
|
930
|
+
"category": "overlay",
|
|
931
|
+
"kind": "directive",
|
|
932
|
+
"selector": "dbx-dialog-content,[dbxDialogContent],.dbx-dialog-content",
|
|
933
|
+
"className": "DbxDialogContentDirective",
|
|
934
|
+
"module": "@dereekb/dbx-web",
|
|
935
|
+
"description": "Directive that applies standard dialog content styling and width configuration.\n\nCan be used as an element, attribute, or CSS class selector.",
|
|
936
|
+
"inputs": [
|
|
937
|
+
{
|
|
938
|
+
"name": "width",
|
|
939
|
+
"type": "DbxDialogContentContainerWidth",
|
|
940
|
+
"description": "",
|
|
941
|
+
"required": false,
|
|
942
|
+
"default": "'normal'"
|
|
943
|
+
}
|
|
944
|
+
],
|
|
945
|
+
"outputs": [],
|
|
946
|
+
"relatedSlugs": [
|
|
947
|
+
"popover",
|
|
948
|
+
"popup",
|
|
949
|
+
"prompt"
|
|
950
|
+
],
|
|
951
|
+
"skillRefs": [
|
|
952
|
+
"dbx__ref__dbx-app-structure"
|
|
953
|
+
],
|
|
954
|
+
"sourcePath": "lib/interaction/dialog/dialog.content.directive.ts",
|
|
955
|
+
"example": "<dbx-dialog-content>\n <h2>Confirm</h2>\n <p>Are you sure?</p>\n</dbx-dialog-content>",
|
|
956
|
+
"minimalExample": "<div dbxDialogContent>Body</div>",
|
|
957
|
+
"sourceLocation": {
|
|
958
|
+
"file": "src/lib/interaction/dialog/dialog.content.directive.ts",
|
|
959
|
+
"line": 31
|
|
960
|
+
}
|
|
961
|
+
},
|
|
962
|
+
{
|
|
963
|
+
"slug": "popover",
|
|
964
|
+
"category": "overlay",
|
|
965
|
+
"kind": "component",
|
|
966
|
+
"selector": "",
|
|
967
|
+
"className": "DbxPopoverComponent",
|
|
968
|
+
"module": "@dereekb/dbx-web",
|
|
969
|
+
"description": "Core popover component that renders injected content with position strategy, transition watching, and keyboard close support.\n\nCoordinates with {@link DbxPopoverCoordinatorService} to ensure only one popover per key is active at a time.",
|
|
970
|
+
"inputs": [],
|
|
971
|
+
"outputs": [],
|
|
972
|
+
"relatedSlugs": [
|
|
973
|
+
"popup",
|
|
974
|
+
"prompt-confirm",
|
|
975
|
+
"dialog-content"
|
|
976
|
+
],
|
|
977
|
+
"skillRefs": [
|
|
978
|
+
"dbx__ref__dbx-app-structure"
|
|
979
|
+
],
|
|
980
|
+
"sourcePath": "lib/interaction/popover/popover.component.ts",
|
|
981
|
+
"example": "// In a service: this.popoverService.open({ content: MyContentComponent, origin })",
|
|
982
|
+
"minimalExample": "<dbx-popover></dbx-popover>",
|
|
983
|
+
"sourceLocation": {
|
|
984
|
+
"file": "src/lib/interaction/popover/popover.component.ts",
|
|
985
|
+
"line": 89
|
|
986
|
+
}
|
|
987
|
+
},
|
|
988
|
+
{
|
|
989
|
+
"slug": "popup",
|
|
990
|
+
"category": "overlay",
|
|
991
|
+
"kind": "component",
|
|
992
|
+
"selector": "",
|
|
993
|
+
"className": "DbxPopupComponent",
|
|
994
|
+
"module": "@dereekb/dbx-web",
|
|
995
|
+
"description": "Core popup component that renders injected content with support for minimize, fullscreen, and normal window states.\n\nCoordinates with {@link DbxPopupCoordinatorService} to ensure only one popup per key is active at a time.",
|
|
996
|
+
"inputs": [],
|
|
997
|
+
"outputs": [],
|
|
998
|
+
"relatedSlugs": [
|
|
999
|
+
"popover"
|
|
1000
|
+
],
|
|
1001
|
+
"skillRefs": [
|
|
1002
|
+
"dbx__ref__dbx-app-structure"
|
|
1003
|
+
],
|
|
1004
|
+
"sourcePath": "lib/interaction/popup/popup.component.ts",
|
|
1005
|
+
"example": "// In a service: this.popupService.open({ content: MyContentComponent })",
|
|
1006
|
+
"minimalExample": "<dbx-popup></dbx-popup>",
|
|
1007
|
+
"sourceLocation": {
|
|
1008
|
+
"file": "src/lib/interaction/popup/popup.component.ts",
|
|
1009
|
+
"line": 63
|
|
1010
|
+
}
|
|
1011
|
+
},
|
|
1012
|
+
{
|
|
1013
|
+
"slug": "prompt",
|
|
1014
|
+
"category": "overlay",
|
|
1015
|
+
"kind": "component",
|
|
1016
|
+
"selector": "dbx-prompt",
|
|
1017
|
+
"className": "DbxPromptComponent",
|
|
1018
|
+
"module": "@dereekb/dbx-web",
|
|
1019
|
+
"description": "Renders a styled prompt section with a header, descriptive text, and a hero content slot.",
|
|
1020
|
+
"inputs": [
|
|
1021
|
+
{
|
|
1022
|
+
"name": "header",
|
|
1023
|
+
"type": "Maybe<string>",
|
|
1024
|
+
"description": "",
|
|
1025
|
+
"required": false
|
|
1026
|
+
},
|
|
1027
|
+
{
|
|
1028
|
+
"name": "prompt",
|
|
1029
|
+
"type": "Maybe<string>",
|
|
1030
|
+
"description": "",
|
|
1031
|
+
"required": false
|
|
1032
|
+
}
|
|
1033
|
+
],
|
|
1034
|
+
"outputs": [],
|
|
1035
|
+
"contentProjection": "<ng-content select=\"[hero]\"></ng-content>; <ng-content></ng-content>",
|
|
1036
|
+
"relatedSlugs": [
|
|
1037
|
+
"prompt-confirm",
|
|
1038
|
+
"dialog-content"
|
|
1039
|
+
],
|
|
1040
|
+
"skillRefs": [
|
|
1041
|
+
"dbx__ref__dbx-app-structure"
|
|
1042
|
+
],
|
|
1043
|
+
"sourcePath": "lib/interaction/prompt/prompt.component.ts",
|
|
1044
|
+
"example": "<dbx-prompt header=\"Delete account\" prompt=\"This cannot be undone.\">\n <button mat-button (click)=\"cancel()\">Cancel</button>\n <button mat-flat-button color=\"warn\" (click)=\"confirm()\">Delete</button>\n</dbx-prompt>",
|
|
1045
|
+
"minimalExample": "<dbx-prompt header=\"Confirm\"></dbx-prompt>",
|
|
1046
|
+
"sourceLocation": {
|
|
1047
|
+
"file": "src/lib/interaction/prompt/prompt.component.ts",
|
|
1048
|
+
"line": 25
|
|
1049
|
+
}
|
|
1050
|
+
},
|
|
1051
|
+
{
|
|
1052
|
+
"slug": "prompt-confirm",
|
|
1053
|
+
"category": "overlay",
|
|
1054
|
+
"kind": "component",
|
|
1055
|
+
"selector": "dbx-prompt-confirm",
|
|
1056
|
+
"className": "DbxPromptConfirmComponent",
|
|
1057
|
+
"module": "@dereekb/dbx-web",
|
|
1058
|
+
"description": "Renders a confirmation prompt with customizable title, message, confirm, and cancel buttons.",
|
|
1059
|
+
"inputs": [
|
|
1060
|
+
{
|
|
1061
|
+
"name": "config",
|
|
1062
|
+
"type": "Maybe<DbxPromptConfirmConfig>",
|
|
1063
|
+
"description": "",
|
|
1064
|
+
"required": false,
|
|
1065
|
+
"default": "{}"
|
|
1066
|
+
}
|
|
1067
|
+
],
|
|
1068
|
+
"outputs": [
|
|
1069
|
+
{
|
|
1070
|
+
"name": "confirm",
|
|
1071
|
+
"emits": "void",
|
|
1072
|
+
"description": ""
|
|
1073
|
+
},
|
|
1074
|
+
{
|
|
1075
|
+
"name": "cancel",
|
|
1076
|
+
"emits": "void",
|
|
1077
|
+
"description": ""
|
|
1078
|
+
}
|
|
1079
|
+
],
|
|
1080
|
+
"contentProjection": "<ng-content></ng-content>",
|
|
1081
|
+
"relatedSlugs": [
|
|
1082
|
+
"prompt",
|
|
1083
|
+
"action-confirm"
|
|
1084
|
+
],
|
|
1085
|
+
"skillRefs": [
|
|
1086
|
+
"dbx__ref__dbx-app-structure"
|
|
1087
|
+
],
|
|
1088
|
+
"sourcePath": "lib/interaction/prompt/prompt.confirm.component.ts",
|
|
1089
|
+
"example": "<dbx-prompt-confirm [config]=\"{ header: 'Delete?', confirmText: 'Delete', cancelText: 'Cancel' }\"></dbx-prompt-confirm>",
|
|
1090
|
+
"minimalExample": "<dbx-prompt-confirm [config]=\"cfg\"></dbx-prompt-confirm>",
|
|
1091
|
+
"sourceLocation": {
|
|
1092
|
+
"file": "src/lib/interaction/prompt/prompt.confirm.component.ts",
|
|
1093
|
+
"line": 34
|
|
1094
|
+
}
|
|
1095
|
+
},
|
|
1096
|
+
{
|
|
1097
|
+
"slug": "bar",
|
|
1098
|
+
"category": "layout",
|
|
1099
|
+
"kind": "directive",
|
|
1100
|
+
"selector": "dbx-bar,[dbxBar]",
|
|
1101
|
+
"className": "DbxBarDirective",
|
|
1102
|
+
"module": "@dereekb/dbx-web",
|
|
1103
|
+
"description": "Renders a horizontal bar with a themed background color, used to visually group or separate content.",
|
|
1104
|
+
"inputs": [
|
|
1105
|
+
{
|
|
1106
|
+
"name": "color",
|
|
1107
|
+
"type": "Maybe<DbxBarColor>",
|
|
1108
|
+
"description": "",
|
|
1109
|
+
"required": false
|
|
1110
|
+
}
|
|
1111
|
+
],
|
|
1112
|
+
"outputs": [],
|
|
1113
|
+
"relatedSlugs": [
|
|
1114
|
+
"bar-header",
|
|
1115
|
+
"pagebar",
|
|
1116
|
+
"button-spacer"
|
|
1117
|
+
],
|
|
1118
|
+
"skillRefs": [
|
|
1119
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
1120
|
+
],
|
|
1121
|
+
"sourcePath": "lib/layout/bar/bar.directive.ts",
|
|
1122
|
+
"example": "<dbx-bar>\n <dbx-button text=\"Save\" raised color=\"primary\"></dbx-button>\n <dbx-button-spacer></dbx-button-spacer>\n <dbx-button text=\"Cancel\" stroked></dbx-button>\n</dbx-bar>",
|
|
1123
|
+
"minimalExample": "<dbx-bar><button>A</button><button>B</button></dbx-bar>",
|
|
1124
|
+
"sourceLocation": {
|
|
1125
|
+
"file": "src/lib/layout/bar/bar.directive.ts",
|
|
1126
|
+
"line": 27
|
|
1127
|
+
}
|
|
1128
|
+
},
|
|
1129
|
+
{
|
|
1130
|
+
"slug": "bar-header",
|
|
1131
|
+
"category": "layout",
|
|
1132
|
+
"kind": "component",
|
|
1133
|
+
"selector": "dbx-bar-header",
|
|
1134
|
+
"className": "DbxBarHeaderComponent",
|
|
1135
|
+
"module": "@dereekb/dbx-web",
|
|
1136
|
+
"description": "A themed header bar displaying an optional icon and text label, useful as a section divider.",
|
|
1137
|
+
"inputs": [
|
|
1138
|
+
{
|
|
1139
|
+
"name": "text",
|
|
1140
|
+
"type": "Maybe<string>",
|
|
1141
|
+
"description": "",
|
|
1142
|
+
"required": false
|
|
1143
|
+
},
|
|
1144
|
+
{
|
|
1145
|
+
"name": "icon",
|
|
1146
|
+
"type": "Maybe<string>",
|
|
1147
|
+
"description": "",
|
|
1148
|
+
"required": false
|
|
1149
|
+
},
|
|
1150
|
+
{
|
|
1151
|
+
"name": "color",
|
|
1152
|
+
"type": "Maybe<DbxBarColor>",
|
|
1153
|
+
"description": "",
|
|
1154
|
+
"required": false
|
|
1155
|
+
}
|
|
1156
|
+
],
|
|
1157
|
+
"outputs": [],
|
|
1158
|
+
"contentProjection": "<ng-content></ng-content>",
|
|
1159
|
+
"relatedSlugs": [
|
|
1160
|
+
"bar",
|
|
1161
|
+
"pagebar"
|
|
1162
|
+
],
|
|
1163
|
+
"skillRefs": [
|
|
1164
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
1165
|
+
],
|
|
1166
|
+
"sourcePath": "lib/layout/bar/bar.header.component.ts",
|
|
1167
|
+
"example": "<dbx-bar-header header=\"Members\" icon=\"group\">\n <button mat-icon-button><mat-icon>add</mat-icon></button>\n</dbx-bar-header>",
|
|
1168
|
+
"minimalExample": "<dbx-bar-header header=\"Title\"></dbx-bar-header>",
|
|
1169
|
+
"sourceLocation": {
|
|
1170
|
+
"file": "src/lib/layout/bar/bar.header.component.ts",
|
|
1171
|
+
"line": 26
|
|
1172
|
+
}
|
|
1173
|
+
},
|
|
1174
|
+
{
|
|
1175
|
+
"slug": "pagebar",
|
|
1176
|
+
"category": "layout",
|
|
1177
|
+
"kind": "component",
|
|
1178
|
+
"selector": "dbx-pagebar",
|
|
1179
|
+
"className": "DbxPagebarComponent",
|
|
1180
|
+
"module": "@dereekb/dbx-web",
|
|
1181
|
+
"description": "A page-level toolbar with left and right content slots, built on Angular Material's mat-toolbar.",
|
|
1182
|
+
"inputs": [
|
|
1183
|
+
{
|
|
1184
|
+
"name": "color",
|
|
1185
|
+
"type": "Maybe<DbxBarColor>",
|
|
1186
|
+
"description": "",
|
|
1187
|
+
"required": false
|
|
1188
|
+
}
|
|
1189
|
+
],
|
|
1190
|
+
"outputs": [],
|
|
1191
|
+
"contentProjection": "<ng-content select=\"[left]\"></ng-content>; <ng-content select=\"[right]\"></ng-content>",
|
|
1192
|
+
"relatedSlugs": [
|
|
1193
|
+
"bar",
|
|
1194
|
+
"navbar"
|
|
1195
|
+
],
|
|
1196
|
+
"skillRefs": [
|
|
1197
|
+
"dbx__ref__dbx-ui-building-blocks",
|
|
1198
|
+
"dbx__ref__dbx-app-structure"
|
|
1199
|
+
],
|
|
1200
|
+
"sourcePath": "lib/layout/bar/pagebar.component.ts",
|
|
1201
|
+
"example": "<dbx-pagebar>\n <h2>Settings</h2>\n <span class=\"spacer\"></span>\n <button mat-stroked-button>Save</button>\n</dbx-pagebar>",
|
|
1202
|
+
"minimalExample": "<dbx-pagebar>Title</dbx-pagebar>",
|
|
1203
|
+
"sourceLocation": {
|
|
1204
|
+
"file": "src/lib/layout/bar/pagebar.component.ts",
|
|
1205
|
+
"line": 28
|
|
1206
|
+
}
|
|
1207
|
+
},
|
|
1208
|
+
{
|
|
1209
|
+
"slug": "card-box",
|
|
1210
|
+
"category": "card",
|
|
1211
|
+
"kind": "component",
|
|
1212
|
+
"selector": "dbx-card-box",
|
|
1213
|
+
"className": "DbxCardBoxComponent",
|
|
1214
|
+
"module": "@dereekb/dbx-web",
|
|
1215
|
+
"description": "Displays a card-style box with an optional section header, icon, and projected content.\n\nSupports a named content slot `[sectionHeader]` for custom header actions beside the title.",
|
|
1216
|
+
"inputs": [
|
|
1217
|
+
{
|
|
1218
|
+
"name": "header",
|
|
1219
|
+
"type": "string",
|
|
1220
|
+
"description": "",
|
|
1221
|
+
"required": false
|
|
1222
|
+
},
|
|
1223
|
+
{
|
|
1224
|
+
"name": "icon",
|
|
1225
|
+
"type": "string",
|
|
1226
|
+
"description": "",
|
|
1227
|
+
"required": false
|
|
1228
|
+
}
|
|
1229
|
+
],
|
|
1230
|
+
"outputs": [],
|
|
1231
|
+
"contentProjection": "<ng-content select=\"[sectionHeader]\"></ng-content>; <ng-content></ng-content>",
|
|
1232
|
+
"relatedSlugs": [
|
|
1233
|
+
"card-box-container",
|
|
1234
|
+
"section"
|
|
1235
|
+
],
|
|
1236
|
+
"skillRefs": [
|
|
1237
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
1238
|
+
],
|
|
1239
|
+
"sourcePath": "lib/layout/card/card.box.component.ts",
|
|
1240
|
+
"example": "<dbx-card-box [header]=\"'Settings'\" [icon]=\"'settings'\">\n <button sectionHeader mat-icon-button><mat-icon>edit</mat-icon></button>\n <p>Card body content goes here.</p>\n</dbx-card-box>",
|
|
1241
|
+
"minimalExample": "<dbx-card-box header=\"Title\"><p>Body</p></dbx-card-box>",
|
|
1242
|
+
"sourceLocation": {
|
|
1243
|
+
"file": "src/lib/layout/card/card.box.component.ts",
|
|
1244
|
+
"line": 26
|
|
1245
|
+
}
|
|
1246
|
+
},
|
|
1247
|
+
{
|
|
1248
|
+
"slug": "card-box-container",
|
|
1249
|
+
"category": "card",
|
|
1250
|
+
"kind": "directive",
|
|
1251
|
+
"selector": "dbx-card-box-container, [dbxCardBoxContainer]",
|
|
1252
|
+
"className": "DbxCardBoxContainerDirective",
|
|
1253
|
+
"module": "@dereekb/dbx-web",
|
|
1254
|
+
"description": "Adds content padding around a card box section.\n\nCan be used as an element or as an attribute directive on any host element.",
|
|
1255
|
+
"inputs": [],
|
|
1256
|
+
"outputs": [],
|
|
1257
|
+
"relatedSlugs": [
|
|
1258
|
+
"card-box"
|
|
1259
|
+
],
|
|
1260
|
+
"skillRefs": [
|
|
1261
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
1262
|
+
],
|
|
1263
|
+
"sourcePath": "lib/layout/card/card.box.container.directive.ts",
|
|
1264
|
+
"example": "<dbx-card-box-container>\n <dbx-card-box header=\"One\"></dbx-card-box>\n <dbx-card-box header=\"Two\"></dbx-card-box>\n</dbx-card-box-container>",
|
|
1265
|
+
"minimalExample": "<div dbxCardBoxContainer><dbx-card-box></dbx-card-box></div>",
|
|
1266
|
+
"sourceLocation": {
|
|
1267
|
+
"file": "src/lib/layout/card/card.box.container.directive.ts",
|
|
1268
|
+
"line": 25
|
|
1269
|
+
}
|
|
1270
|
+
},
|
|
1271
|
+
{
|
|
1272
|
+
"slug": "content-box",
|
|
1273
|
+
"category": "layout",
|
|
1274
|
+
"kind": "directive",
|
|
1275
|
+
"selector": "dbx-content-box, [dbxContentBox]",
|
|
1276
|
+
"className": "DbxContentBoxDirective",
|
|
1277
|
+
"module": "@dereekb/dbx-web",
|
|
1278
|
+
"description": "Wraps content in a box container with optional elevation (card-like shadow) and wide layout.\nBoth `elevate` and `wide` default to `true`.",
|
|
1279
|
+
"inputs": [
|
|
1280
|
+
{
|
|
1281
|
+
"name": "elevate",
|
|
1282
|
+
"type": "boolean",
|
|
1283
|
+
"description": "",
|
|
1284
|
+
"required": false,
|
|
1285
|
+
"default": "true"
|
|
1286
|
+
},
|
|
1287
|
+
{
|
|
1288
|
+
"name": "wide",
|
|
1289
|
+
"type": "boolean",
|
|
1290
|
+
"description": "",
|
|
1291
|
+
"required": false,
|
|
1292
|
+
"default": "true"
|
|
1293
|
+
}
|
|
1294
|
+
],
|
|
1295
|
+
"outputs": [],
|
|
1296
|
+
"relatedSlugs": [
|
|
1297
|
+
"content",
|
|
1298
|
+
"content-elevate",
|
|
1299
|
+
"content-pit"
|
|
1300
|
+
],
|
|
1301
|
+
"skillRefs": [
|
|
1302
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
1303
|
+
],
|
|
1304
|
+
"sourcePath": "lib/layout/content/content.box.directive.ts",
|
|
1305
|
+
"example": "<dbx-content-box>\n <p>Summary content</p>\n</dbx-content-box>",
|
|
1306
|
+
"minimalExample": "<div dbxContentBox>Body</div>",
|
|
1307
|
+
"sourceLocation": {
|
|
1308
|
+
"file": "src/lib/layout/content/content.box.directive.ts",
|
|
1309
|
+
"line": 23
|
|
1310
|
+
}
|
|
1311
|
+
},
|
|
1312
|
+
{
|
|
1313
|
+
"slug": "content-container",
|
|
1314
|
+
"category": "layout",
|
|
1315
|
+
"kind": "directive",
|
|
1316
|
+
"selector": "dbx-content-container,[dbxContentContainer],.dbx-content-container",
|
|
1317
|
+
"className": "DbxContentContainerDirective",
|
|
1318
|
+
"module": "@dereekb/dbx-web",
|
|
1319
|
+
"description": "Constrains content to a maximum width with configurable padding. Useful for centering\npage content and maintaining readable line lengths.",
|
|
1320
|
+
"inputs": [
|
|
1321
|
+
{
|
|
1322
|
+
"name": "grow",
|
|
1323
|
+
"type": "DbxContentContainerWidth",
|
|
1324
|
+
"description": "",
|
|
1325
|
+
"required": false,
|
|
1326
|
+
"default": "'wide'"
|
|
1327
|
+
},
|
|
1328
|
+
{
|
|
1329
|
+
"name": "padding",
|
|
1330
|
+
"type": "DbxContentContainerPadding",
|
|
1331
|
+
"description": "",
|
|
1332
|
+
"required": false,
|
|
1333
|
+
"default": "'normal'"
|
|
1334
|
+
},
|
|
1335
|
+
{
|
|
1336
|
+
"name": "topPadding",
|
|
1337
|
+
"type": "DbxContentContainerPadding",
|
|
1338
|
+
"description": "",
|
|
1339
|
+
"required": false,
|
|
1340
|
+
"default": "'none'"
|
|
1341
|
+
}
|
|
1342
|
+
],
|
|
1343
|
+
"outputs": [],
|
|
1344
|
+
"relatedSlugs": [
|
|
1345
|
+
"content",
|
|
1346
|
+
"content-page",
|
|
1347
|
+
"content-box"
|
|
1348
|
+
],
|
|
1349
|
+
"skillRefs": [
|
|
1350
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
1351
|
+
],
|
|
1352
|
+
"sourcePath": "lib/layout/content/content.container.directive.ts",
|
|
1353
|
+
"example": "<dbx-content-container grow=\"full\" padding=\"normal\">\n <p>Page body</p>\n</dbx-content-container>",
|
|
1354
|
+
"minimalExample": "<div dbxContentContainer>Body</div>",
|
|
1355
|
+
"sourceLocation": {
|
|
1356
|
+
"file": "src/lib/layout/content/content.container.directive.ts",
|
|
1357
|
+
"line": 33
|
|
1358
|
+
}
|
|
1359
|
+
},
|
|
1360
|
+
{
|
|
1361
|
+
"slug": "content",
|
|
1362
|
+
"category": "layout",
|
|
1363
|
+
"kind": "directive",
|
|
1364
|
+
"selector": "dbx-content,[dbxContent]",
|
|
1365
|
+
"className": "DbxContentDirective",
|
|
1366
|
+
"module": "@dereekb/dbx-web",
|
|
1367
|
+
"description": "Sets the host element to fill the available page height. Use as a wrapper for page-level content blocks.",
|
|
1368
|
+
"inputs": [],
|
|
1369
|
+
"outputs": [],
|
|
1370
|
+
"relatedSlugs": [
|
|
1371
|
+
"content-container",
|
|
1372
|
+
"content-page",
|
|
1373
|
+
"content-box"
|
|
1374
|
+
],
|
|
1375
|
+
"skillRefs": [
|
|
1376
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
1377
|
+
],
|
|
1378
|
+
"sourcePath": "lib/layout/content/content.directive.ts",
|
|
1379
|
+
"example": "<div dbxContent>\n <p>Standard content body</p>\n</div>",
|
|
1380
|
+
"minimalExample": "<dbx-content>Body</dbx-content>",
|
|
1381
|
+
"sourceLocation": {
|
|
1382
|
+
"file": "src/lib/layout/content/content.directive.ts",
|
|
1383
|
+
"line": 22
|
|
1384
|
+
}
|
|
1385
|
+
},
|
|
1386
|
+
{
|
|
1387
|
+
"slug": "content-elevate",
|
|
1388
|
+
"category": "layout",
|
|
1389
|
+
"kind": "directive",
|
|
1390
|
+
"selector": "dbx-content-elevate,[dbxContentElevate]",
|
|
1391
|
+
"className": "DbxContentElevateDirective",
|
|
1392
|
+
"module": "@dereekb/dbx-web",
|
|
1393
|
+
"description": "Applies elevation (box-shadow) styling to the host element, giving it a raised card appearance.\nElevation is enabled by default and can be toggled off.",
|
|
1394
|
+
"inputs": [
|
|
1395
|
+
{
|
|
1396
|
+
"name": "elevate",
|
|
1397
|
+
"type": "boolean",
|
|
1398
|
+
"description": "",
|
|
1399
|
+
"required": false,
|
|
1400
|
+
"default": "true"
|
|
1401
|
+
}
|
|
1402
|
+
],
|
|
1403
|
+
"outputs": [],
|
|
1404
|
+
"relatedSlugs": [
|
|
1405
|
+
"content-box",
|
|
1406
|
+
"content-pit"
|
|
1407
|
+
],
|
|
1408
|
+
"skillRefs": [
|
|
1409
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
1410
|
+
],
|
|
1411
|
+
"sourcePath": "lib/layout/content/content.elevate.directive.ts",
|
|
1412
|
+
"example": "<div dbxContentElevate>Highlighted block</div>",
|
|
1413
|
+
"minimalExample": "<dbx-content-elevate>Body</dbx-content-elevate>",
|
|
1414
|
+
"sourceLocation": {
|
|
1415
|
+
"file": "src/lib/layout/content/content.elevate.directive.ts",
|
|
1416
|
+
"line": 21
|
|
1417
|
+
}
|
|
1418
|
+
},
|
|
1419
|
+
{
|
|
1420
|
+
"slug": "content-page",
|
|
1421
|
+
"category": "layout",
|
|
1422
|
+
"kind": "directive",
|
|
1423
|
+
"selector": "dbx-content-page,[dbxContentPage]",
|
|
1424
|
+
"className": "DbxContentPageDirective",
|
|
1425
|
+
"module": "@dereekb/dbx-web",
|
|
1426
|
+
"description": "Sets the host element to fill the full page height with page-level content styling.\nSimilar to `DbxContentDirective` but applies the `dbx-content-page` class for page-specific layout.",
|
|
1427
|
+
"inputs": [],
|
|
1428
|
+
"outputs": [],
|
|
1429
|
+
"relatedSlugs": [
|
|
1430
|
+
"content-container",
|
|
1431
|
+
"section-page"
|
|
1432
|
+
],
|
|
1433
|
+
"skillRefs": [
|
|
1434
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
1435
|
+
],
|
|
1436
|
+
"sourcePath": "lib/layout/content/content.page.directive.ts",
|
|
1437
|
+
"example": "<div dbxContentPage>\n <dbx-section-page header=\"Dashboard\"><p>...</p></dbx-section-page>\n</div>",
|
|
1438
|
+
"minimalExample": "<dbx-content-page>Page</dbx-content-page>",
|
|
1439
|
+
"sourceLocation": {
|
|
1440
|
+
"file": "src/lib/layout/content/content.page.directive.ts",
|
|
1441
|
+
"line": 23
|
|
1442
|
+
}
|
|
1443
|
+
},
|
|
1444
|
+
{
|
|
1445
|
+
"slug": "content-pit",
|
|
1446
|
+
"category": "layout",
|
|
1447
|
+
"kind": "directive",
|
|
1448
|
+
"selector": "dbx-content-pit, [dbxContentPit]",
|
|
1449
|
+
"className": "DbxContentPitDirective",
|
|
1450
|
+
"module": "@dereekb/dbx-web",
|
|
1451
|
+
"description": "Wraps content in a recessed \"pit\" container with optional scrollable overflow and rounded corners.\nUseful for displaying bounded content areas such as lists or previews with a constrained height.",
|
|
1452
|
+
"inputs": [
|
|
1453
|
+
{
|
|
1454
|
+
"name": "scrollable",
|
|
1455
|
+
"type": "Maybe<DbxContentPitScrollableInput>",
|
|
1456
|
+
"description": "",
|
|
1457
|
+
"required": false
|
|
1458
|
+
},
|
|
1459
|
+
{
|
|
1460
|
+
"name": "rounded",
|
|
1461
|
+
"type": "boolean",
|
|
1462
|
+
"description": "",
|
|
1463
|
+
"required": false,
|
|
1464
|
+
"default": "false"
|
|
1465
|
+
}
|
|
1466
|
+
],
|
|
1467
|
+
"outputs": [],
|
|
1468
|
+
"relatedSlugs": [
|
|
1469
|
+
"content-box",
|
|
1470
|
+
"content-elevate"
|
|
1471
|
+
],
|
|
1472
|
+
"skillRefs": [
|
|
1473
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
1474
|
+
],
|
|
1475
|
+
"sourcePath": "lib/layout/content/content.pit.directive.ts",
|
|
1476
|
+
"example": "<div dbxContentPit>Inset block</div>",
|
|
1477
|
+
"minimalExample": "<dbx-content-pit>Body</dbx-content-pit>",
|
|
1478
|
+
"sourceLocation": {
|
|
1479
|
+
"file": "src/lib/layout/content/content.pit.directive.ts",
|
|
1480
|
+
"line": 38
|
|
1481
|
+
}
|
|
1482
|
+
},
|
|
1483
|
+
{
|
|
1484
|
+
"slug": "flex-group",
|
|
1485
|
+
"category": "layout",
|
|
1486
|
+
"kind": "directive",
|
|
1487
|
+
"selector": "[dbxFlexGroup]",
|
|
1488
|
+
"className": "DbxFlexGroupDirective",
|
|
1489
|
+
"module": "@dereekb/dbx-web",
|
|
1490
|
+
"description": "Creates a flex group container that arranges child elements in a responsive row layout.\n\nOn small screens (below the configured breakpoint), the group applies a small-screen CSS class\nthat can be used to adjust styling. When `breakToColumn` is enabled, items will stack vertically\non small screens.",
|
|
1491
|
+
"inputs": [
|
|
1492
|
+
{
|
|
1493
|
+
"name": "content",
|
|
1494
|
+
"type": "boolean",
|
|
1495
|
+
"description": "Whether to apply the flex group content styling. Defaults to `true`.",
|
|
1496
|
+
"required": false,
|
|
1497
|
+
"default": "true"
|
|
1498
|
+
},
|
|
1499
|
+
{
|
|
1500
|
+
"name": "breakToColumn",
|
|
1501
|
+
"type": "boolean",
|
|
1502
|
+
"description": "Whether child items should break to a column layout on small screens.",
|
|
1503
|
+
"required": false,
|
|
1504
|
+
"default": "false"
|
|
1505
|
+
},
|
|
1506
|
+
{
|
|
1507
|
+
"name": "relative",
|
|
1508
|
+
"type": "boolean",
|
|
1509
|
+
"description": "Whether the flex group should use relative positioning.",
|
|
1510
|
+
"required": false,
|
|
1511
|
+
"default": "false"
|
|
1512
|
+
},
|
|
1513
|
+
{
|
|
1514
|
+
"name": "breakpoint",
|
|
1515
|
+
"type": "ScreenMediaWidthType",
|
|
1516
|
+
"description": "Screen width breakpoint below which the group is considered \"small\". Defaults to `'tablet'`.",
|
|
1517
|
+
"required": false,
|
|
1518
|
+
"default": "'tablet'"
|
|
1519
|
+
}
|
|
1520
|
+
],
|
|
1521
|
+
"outputs": [],
|
|
1522
|
+
"relatedSlugs": [
|
|
1523
|
+
"flex-size",
|
|
1524
|
+
"bar"
|
|
1525
|
+
],
|
|
1526
|
+
"skillRefs": [
|
|
1527
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
1528
|
+
],
|
|
1529
|
+
"sourcePath": "lib/layout/flex/flex.group.directive.ts",
|
|
1530
|
+
"example": "<div dbxFlexGroup breakpoint=\"sm\">\n <div dbxFlexSize=\"2\">Wide</div>\n <div dbxFlexSize=\"1\">Narrow</div>\n</div>",
|
|
1531
|
+
"minimalExample": "<div dbxFlexGroup><div dbxFlexSize=\"1\">A</div></div>",
|
|
1532
|
+
"sourceLocation": {
|
|
1533
|
+
"file": "src/lib/layout/flex/flex.group.directive.ts",
|
|
1534
|
+
"line": 33
|
|
1535
|
+
}
|
|
1536
|
+
},
|
|
1537
|
+
{
|
|
1538
|
+
"slug": "flex-size",
|
|
1539
|
+
"category": "layout",
|
|
1540
|
+
"kind": "directive",
|
|
1541
|
+
"selector": "[dbxFlexSize]",
|
|
1542
|
+
"className": "DbxFlexSizeDirective",
|
|
1543
|
+
"module": "@dereekb/dbx-web",
|
|
1544
|
+
"description": "Applies a `dbx-flex-{size}` CSS class to the host element based on the given {@link DbxFlexSize} value.\nUse within a {@link DbxFlexGroupDirective} to control how much row width this element occupies.",
|
|
1545
|
+
"inputs": [
|
|
1546
|
+
{
|
|
1547
|
+
"name": "dbxFlexSize",
|
|
1548
|
+
"type": "DbxFlexSize",
|
|
1549
|
+
"description": "The flex size to apply, from 1 (1/6 width) to 6 (full width).",
|
|
1550
|
+
"required": true
|
|
1551
|
+
}
|
|
1552
|
+
],
|
|
1553
|
+
"outputs": [],
|
|
1554
|
+
"relatedSlugs": [
|
|
1555
|
+
"flex-group"
|
|
1556
|
+
],
|
|
1557
|
+
"skillRefs": [
|
|
1558
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
1559
|
+
],
|
|
1560
|
+
"sourcePath": "lib/layout/flex/flex.size.directive.ts",
|
|
1561
|
+
"example": "<div dbxFlexGroup>\n <div dbxFlexSize=\"2\">Twice as wide</div>\n <div dbxFlexSize=\"1\">Narrow</div>\n</div>",
|
|
1562
|
+
"minimalExample": "<div dbxFlexSize=\"1\"></div>",
|
|
1563
|
+
"sourceLocation": {
|
|
1564
|
+
"file": "src/lib/layout/flex/flex.size.directive.ts",
|
|
1565
|
+
"line": 25
|
|
1566
|
+
}
|
|
1567
|
+
},
|
|
1568
|
+
{
|
|
1569
|
+
"slug": "list",
|
|
1570
|
+
"category": "list",
|
|
1571
|
+
"kind": "component",
|
|
1572
|
+
"selector": "dbx-list",
|
|
1573
|
+
"className": "DbxListComponent",
|
|
1574
|
+
"module": "@dereekb/dbx-web",
|
|
1575
|
+
"description": "Displays a potentially infinitely scrollable list of content. Supports load-more triggers, selection modes, and empty/loading states.\n\nThis component is typically wrapped by a higher-level component that provides its configuration via the `config` input.",
|
|
1576
|
+
"inputs": [
|
|
1577
|
+
{
|
|
1578
|
+
"name": "padded",
|
|
1579
|
+
"type": "boolean",
|
|
1580
|
+
"description": "Whether or not to add bottom padding to the list content.",
|
|
1581
|
+
"required": false,
|
|
1582
|
+
"default": "true"
|
|
1583
|
+
},
|
|
1584
|
+
{
|
|
1585
|
+
"name": "state",
|
|
1586
|
+
"type": "Maybe<Observable<Maybe<S>>>",
|
|
1587
|
+
"description": "",
|
|
1588
|
+
"required": false,
|
|
1589
|
+
"default": "undefined"
|
|
1590
|
+
},
|
|
1591
|
+
{
|
|
1592
|
+
"name": "config",
|
|
1593
|
+
"type": "Maybe<DbxListConfig<T, V>>",
|
|
1594
|
+
"description": "",
|
|
1595
|
+
"required": false,
|
|
1596
|
+
"default": "undefined"
|
|
1597
|
+
},
|
|
1598
|
+
{
|
|
1599
|
+
"name": "disabled",
|
|
1600
|
+
"type": "Maybe<boolean>",
|
|
1601
|
+
"description": "",
|
|
1602
|
+
"required": false,
|
|
1603
|
+
"default": "false"
|
|
1604
|
+
},
|
|
1605
|
+
{
|
|
1606
|
+
"name": "selectionMode",
|
|
1607
|
+
"type": "Maybe<DbxListSelectionMode>",
|
|
1608
|
+
"description": "",
|
|
1609
|
+
"required": false,
|
|
1610
|
+
"default": "undefined"
|
|
1611
|
+
},
|
|
1612
|
+
{
|
|
1613
|
+
"name": "hasMore",
|
|
1614
|
+
"type": "Maybe<boolean>",
|
|
1615
|
+
"description": "",
|
|
1616
|
+
"required": false,
|
|
1617
|
+
"default": "undefined"
|
|
1618
|
+
}
|
|
1619
|
+
],
|
|
1620
|
+
"outputs": [
|
|
1621
|
+
{
|
|
1622
|
+
"name": "contentScrolled",
|
|
1623
|
+
"emits": "DbxListComponentScrolledEventPosition",
|
|
1624
|
+
"description": "Emitted when content is scrolled."
|
|
1625
|
+
}
|
|
1626
|
+
],
|
|
1627
|
+
"relatedSlugs": [
|
|
1628
|
+
"list-view",
|
|
1629
|
+
"list-empty-content",
|
|
1630
|
+
"list-grid-view",
|
|
1631
|
+
"list-accordion-view",
|
|
1632
|
+
"selection-list-view"
|
|
1633
|
+
],
|
|
1634
|
+
"skillRefs": [
|
|
1635
|
+
"dbx__ref__dbx-component-patterns"
|
|
1636
|
+
],
|
|
1637
|
+
"sourcePath": "lib/layout/list/list.component.ts",
|
|
1638
|
+
"example": "<dbx-list [state$]=\"items$\" [config]=\"listConfig\" (contentScrolled)=\"onScroll($event)\"></dbx-list>",
|
|
1639
|
+
"minimalExample": "<dbx-list [state$]=\"items$\" [config]=\"listConfig\"></dbx-list>",
|
|
1640
|
+
"sourceLocation": {
|
|
1641
|
+
"file": "src/lib/layout/list/list.component.ts",
|
|
1642
|
+
"line": 138
|
|
1643
|
+
}
|
|
1644
|
+
},
|
|
1645
|
+
{
|
|
1646
|
+
"slug": "list-empty-content",
|
|
1647
|
+
"category": "list",
|
|
1648
|
+
"kind": "component",
|
|
1649
|
+
"selector": "dbx-list-empty-content",
|
|
1650
|
+
"className": "DbxListEmptyContentComponent",
|
|
1651
|
+
"module": "@dereekb/dbx-web",
|
|
1652
|
+
"description": "Displays centered placeholder content within an empty list. Projects its content into a styled container.",
|
|
1653
|
+
"inputs": [],
|
|
1654
|
+
"outputs": [],
|
|
1655
|
+
"contentProjection": "<ng-content></ng-content>",
|
|
1656
|
+
"relatedSlugs": [
|
|
1657
|
+
"list"
|
|
1658
|
+
],
|
|
1659
|
+
"skillRefs": [
|
|
1660
|
+
"dbx__ref__dbx-component-patterns"
|
|
1661
|
+
],
|
|
1662
|
+
"sourcePath": "lib/layout/list/list.content.empty.component.ts",
|
|
1663
|
+
"example": "<dbx-list [state$]=\"items$\" [config]=\"listConfig\">\n <dbx-list-empty-content>\n <p>No items yet — add one to get started.</p>\n </dbx-list-empty-content>\n</dbx-list>",
|
|
1664
|
+
"minimalExample": "<dbx-list-empty-content>Empty</dbx-list-empty-content>",
|
|
1665
|
+
"sourceLocation": {
|
|
1666
|
+
"file": "src/lib/layout/list/list.content.empty.component.ts",
|
|
1667
|
+
"line": 24
|
|
1668
|
+
}
|
|
1669
|
+
},
|
|
1670
|
+
{
|
|
1671
|
+
"slug": "list-view",
|
|
1672
|
+
"category": "list",
|
|
1673
|
+
"kind": "component",
|
|
1674
|
+
"selector": "dbx-list-view",
|
|
1675
|
+
"className": "DbxValueListViewComponent",
|
|
1676
|
+
"module": "@dereekb/dbx-web",
|
|
1677
|
+
"description": "Renders a value-based list view using a configuration input. Must be used within a parent {@link DbxListView} context.",
|
|
1678
|
+
"inputs": [
|
|
1679
|
+
{
|
|
1680
|
+
"name": "config",
|
|
1681
|
+
"type": "C",
|
|
1682
|
+
"description": "",
|
|
1683
|
+
"required": true
|
|
1684
|
+
}
|
|
1685
|
+
],
|
|
1686
|
+
"outputs": [],
|
|
1687
|
+
"relatedSlugs": [
|
|
1688
|
+
"list",
|
|
1689
|
+
"selection-list-view",
|
|
1690
|
+
"list-grid-view",
|
|
1691
|
+
"list-accordion-view"
|
|
1692
|
+
],
|
|
1693
|
+
"skillRefs": [
|
|
1694
|
+
"dbx__ref__dbx-component-patterns"
|
|
1695
|
+
],
|
|
1696
|
+
"sourcePath": "lib/layout/list/list.view.value.component.ts",
|
|
1697
|
+
"example": "<dbx-list-view [config]=\"rowConfig\"></dbx-list-view>",
|
|
1698
|
+
"minimalExample": "<dbx-list-view [config]=\"rowConfig\"></dbx-list-view>",
|
|
1699
|
+
"sourceLocation": {
|
|
1700
|
+
"file": "src/lib/layout/list/list.view.value.component.ts",
|
|
1701
|
+
"line": 194
|
|
1702
|
+
}
|
|
1703
|
+
},
|
|
1704
|
+
{
|
|
1705
|
+
"slug": "selection-list-view",
|
|
1706
|
+
"category": "list",
|
|
1707
|
+
"kind": "component",
|
|
1708
|
+
"selector": "dbx-selection-list-view",
|
|
1709
|
+
"className": "DbxSelectionValueListViewComponent",
|
|
1710
|
+
"module": "@dereekb/dbx-web",
|
|
1711
|
+
"description": "Renders a selection-capable list view using a configuration input. Requires a parent {@link DbxListView} context.\nSwitches between selection mode (with checkboxes) and view mode (standard list) based on the parent's selection mode.",
|
|
1712
|
+
"inputs": [
|
|
1713
|
+
{
|
|
1714
|
+
"name": "config",
|
|
1715
|
+
"type": "C",
|
|
1716
|
+
"description": "",
|
|
1717
|
+
"required": true
|
|
1718
|
+
}
|
|
1719
|
+
],
|
|
1720
|
+
"outputs": [],
|
|
1721
|
+
"relatedSlugs": [
|
|
1722
|
+
"list",
|
|
1723
|
+
"list-view"
|
|
1724
|
+
],
|
|
1725
|
+
"skillRefs": [
|
|
1726
|
+
"dbx__ref__dbx-component-patterns"
|
|
1727
|
+
],
|
|
1728
|
+
"sourcePath": "lib/layout/list/list.view.value.selection.component.ts",
|
|
1729
|
+
"example": "<dbx-selection-list-view [config]=\"rowConfig\" selectionMode=\"multi\"></dbx-selection-list-view>",
|
|
1730
|
+
"minimalExample": "<dbx-selection-list-view [config]=\"rowConfig\"></dbx-selection-list-view>",
|
|
1731
|
+
"sourceLocation": {
|
|
1732
|
+
"file": "src/lib/layout/list/list.view.value.selection.component.ts",
|
|
1733
|
+
"line": 104
|
|
1734
|
+
}
|
|
1735
|
+
},
|
|
1736
|
+
{
|
|
1737
|
+
"slug": "section",
|
|
1738
|
+
"category": "layout",
|
|
1739
|
+
"kind": "component",
|
|
1740
|
+
"selector": "dbx-section",
|
|
1741
|
+
"className": "DbxSectionComponent",
|
|
1742
|
+
"module": "@dereekb/dbx-web",
|
|
1743
|
+
"description": "Displays a content section with a header and body area. The header defaults to an h3 heading\nand supports optional elevation styling.",
|
|
1744
|
+
"inputs": [
|
|
1745
|
+
{
|
|
1746
|
+
"name": "elevate",
|
|
1747
|
+
"type": "boolean",
|
|
1748
|
+
"description": "Apply elevated card styling.",
|
|
1749
|
+
"required": false,
|
|
1750
|
+
"default": "false"
|
|
1751
|
+
},
|
|
1752
|
+
{
|
|
1753
|
+
"name": "headerConfig",
|
|
1754
|
+
"type": "Maybe<DbxSectionHeaderConfig>",
|
|
1755
|
+
"description": "",
|
|
1756
|
+
"required": false
|
|
1757
|
+
},
|
|
1758
|
+
{
|
|
1759
|
+
"name": "h",
|
|
1760
|
+
"type": "Maybe<DbxSectionHeaderHType>",
|
|
1761
|
+
"description": "",
|
|
1762
|
+
"required": false
|
|
1763
|
+
},
|
|
1764
|
+
{
|
|
1765
|
+
"name": "paddedHeader",
|
|
1766
|
+
"type": "Maybe<boolean>",
|
|
1767
|
+
"description": "",
|
|
1768
|
+
"required": false
|
|
1769
|
+
},
|
|
1770
|
+
{
|
|
1771
|
+
"name": "header",
|
|
1772
|
+
"type": "Maybe<string>",
|
|
1773
|
+
"description": "",
|
|
1774
|
+
"required": false
|
|
1775
|
+
},
|
|
1776
|
+
{
|
|
1777
|
+
"name": "onlyHeader",
|
|
1778
|
+
"type": "Maybe<boolean>",
|
|
1779
|
+
"description": "",
|
|
1780
|
+
"required": false
|
|
1781
|
+
},
|
|
1782
|
+
{
|
|
1783
|
+
"name": "icon",
|
|
1784
|
+
"type": "Maybe<string>",
|
|
1785
|
+
"description": "",
|
|
1786
|
+
"required": false
|
|
1787
|
+
},
|
|
1788
|
+
{
|
|
1789
|
+
"name": "hint",
|
|
1790
|
+
"type": "Maybe<string>",
|
|
1791
|
+
"description": "",
|
|
1792
|
+
"required": false
|
|
1793
|
+
},
|
|
1794
|
+
{
|
|
1795
|
+
"name": "hintInline",
|
|
1796
|
+
"type": "Maybe<boolean>",
|
|
1797
|
+
"description": "",
|
|
1798
|
+
"required": false
|
|
1799
|
+
}
|
|
1800
|
+
],
|
|
1801
|
+
"outputs": [],
|
|
1802
|
+
"contentProjection": "<ng-content select=\"[sectionHeader]\"></ng-content>; <ng-content></ng-content>",
|
|
1803
|
+
"relatedSlugs": [
|
|
1804
|
+
"subsection",
|
|
1805
|
+
"section-page",
|
|
1806
|
+
"section-header",
|
|
1807
|
+
"intro-action-section"
|
|
1808
|
+
],
|
|
1809
|
+
"skillRefs": [
|
|
1810
|
+
"dbx__ref__dbx-ui-building-blocks",
|
|
1811
|
+
"dbx__ref__dbx-component-patterns"
|
|
1812
|
+
],
|
|
1813
|
+
"sourcePath": "lib/layout/section/section.component.ts",
|
|
1814
|
+
"example": "<dbx-section header=\"My Section\" icon=\"info\" hint=\"Additional context\">\n <p>Section body content here.</p>\n</dbx-section>\n\n<dbx-section header=\"Elevated Section\" [elevate]=\"true\">\n <button sectionHeader>Custom Header Action</button>\n <p>Body content with elevated card styling.</p>\n</dbx-section>",
|
|
1815
|
+
"minimalExample": "<dbx-section header=\"My Section\"><p>Body</p></dbx-section>",
|
|
1816
|
+
"sourceLocation": {
|
|
1817
|
+
"file": "src/lib/layout/section/section.component.ts",
|
|
1818
|
+
"line": 29
|
|
1819
|
+
}
|
|
1820
|
+
},
|
|
1821
|
+
{
|
|
1822
|
+
"slug": "section-header",
|
|
1823
|
+
"category": "layout",
|
|
1824
|
+
"kind": "component",
|
|
1825
|
+
"selector": "dbx-section-header,.dbx-section-header",
|
|
1826
|
+
"className": "DbxSectionHeaderComponent",
|
|
1827
|
+
"module": "@dereekb/dbx-web",
|
|
1828
|
+
"description": "Renders a section header with a configurable heading level (h1-h5), optional icon, and hint text.\nCan be used as a standalone element or as an attribute directive on elements with the `.dbx-section-header` class.\nServes as the base class for `DbxSectionComponent` and `DbxSectionPageComponent`.",
|
|
1829
|
+
"inputs": [
|
|
1830
|
+
{
|
|
1831
|
+
"name": "headerConfig",
|
|
1832
|
+
"type": "Maybe<DbxSectionHeaderConfig>",
|
|
1833
|
+
"description": "",
|
|
1834
|
+
"required": false
|
|
1835
|
+
},
|
|
1836
|
+
{
|
|
1837
|
+
"name": "h",
|
|
1838
|
+
"type": "Maybe<DbxSectionHeaderHType>",
|
|
1839
|
+
"description": "",
|
|
1840
|
+
"required": false
|
|
1841
|
+
},
|
|
1842
|
+
{
|
|
1843
|
+
"name": "paddedHeader",
|
|
1844
|
+
"type": "Maybe<boolean>",
|
|
1845
|
+
"description": "",
|
|
1846
|
+
"required": false
|
|
1847
|
+
},
|
|
1848
|
+
{
|
|
1849
|
+
"name": "header",
|
|
1850
|
+
"type": "Maybe<string>",
|
|
1851
|
+
"description": "",
|
|
1852
|
+
"required": false
|
|
1853
|
+
},
|
|
1854
|
+
{
|
|
1855
|
+
"name": "onlyHeader",
|
|
1856
|
+
"type": "Maybe<boolean>",
|
|
1857
|
+
"description": "",
|
|
1858
|
+
"required": false
|
|
1859
|
+
},
|
|
1860
|
+
{
|
|
1861
|
+
"name": "icon",
|
|
1862
|
+
"type": "Maybe<string>",
|
|
1863
|
+
"description": "",
|
|
1864
|
+
"required": false
|
|
1865
|
+
},
|
|
1866
|
+
{
|
|
1867
|
+
"name": "hint",
|
|
1868
|
+
"type": "Maybe<string>",
|
|
1869
|
+
"description": "",
|
|
1870
|
+
"required": false
|
|
1871
|
+
},
|
|
1872
|
+
{
|
|
1873
|
+
"name": "hintInline",
|
|
1874
|
+
"type": "Maybe<boolean>",
|
|
1875
|
+
"description": "",
|
|
1876
|
+
"required": false
|
|
1877
|
+
}
|
|
1878
|
+
],
|
|
1879
|
+
"outputs": [],
|
|
1880
|
+
"contentProjection": "<ng-content></ng-content>",
|
|
1881
|
+
"relatedSlugs": [
|
|
1882
|
+
"section",
|
|
1883
|
+
"subsection"
|
|
1884
|
+
],
|
|
1885
|
+
"skillRefs": [
|
|
1886
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
1887
|
+
],
|
|
1888
|
+
"sourcePath": "lib/layout/section/section.header.component.ts",
|
|
1889
|
+
"example": "<div class=\"dbx-section-header\" header=\"Custom Layout\" [h]=\"2\" icon=\"info\"></div>",
|
|
1890
|
+
"minimalExample": "<dbx-section-header header=\"My Header\"></dbx-section-header>",
|
|
1891
|
+
"sourceLocation": {
|
|
1892
|
+
"file": "src/lib/layout/section/section.header.component.ts",
|
|
1893
|
+
"line": 26
|
|
1894
|
+
}
|
|
1895
|
+
},
|
|
1896
|
+
{
|
|
1897
|
+
"slug": "intro-action-section",
|
|
1898
|
+
"category": "feedback",
|
|
1899
|
+
"kind": "component",
|
|
1900
|
+
"selector": "dbx-intro-action-section",
|
|
1901
|
+
"className": "DbxIntroActionSectionComponent",
|
|
1902
|
+
"module": "@dereekb/dbx-web",
|
|
1903
|
+
"description": "Displays an introductory message with a call-to-action button. When the button is clicked,\nthe intro is replaced by the projected content. Useful for onboarding or first-time-use flows.",
|
|
1904
|
+
"inputs": [
|
|
1905
|
+
{
|
|
1906
|
+
"name": "hint",
|
|
1907
|
+
"type": "Maybe<string>",
|
|
1908
|
+
"description": "",
|
|
1909
|
+
"required": false
|
|
1910
|
+
},
|
|
1911
|
+
{
|
|
1912
|
+
"name": "showIntro",
|
|
1913
|
+
"type": "Maybe<boolean>",
|
|
1914
|
+
"description": "",
|
|
1915
|
+
"required": false,
|
|
1916
|
+
"default": "true"
|
|
1917
|
+
},
|
|
1918
|
+
{
|
|
1919
|
+
"name": "action",
|
|
1920
|
+
"type": "Maybe<string>",
|
|
1921
|
+
"description": "",
|
|
1922
|
+
"required": false
|
|
1923
|
+
}
|
|
1924
|
+
],
|
|
1925
|
+
"outputs": [
|
|
1926
|
+
{
|
|
1927
|
+
"name": "showAction",
|
|
1928
|
+
"emits": "void",
|
|
1929
|
+
"description": ""
|
|
1930
|
+
}
|
|
1931
|
+
],
|
|
1932
|
+
"contentProjection": "<ng-content select=\"[info]\"></ng-content>; <ng-content></ng-content>",
|
|
1933
|
+
"relatedSlugs": [
|
|
1934
|
+
"section",
|
|
1935
|
+
"list-empty-content"
|
|
1936
|
+
],
|
|
1937
|
+
"skillRefs": [
|
|
1938
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
1939
|
+
],
|
|
1940
|
+
"sourcePath": "lib/layout/section/section.intro.component.ts",
|
|
1941
|
+
"example": "<dbx-intro-action-section\n hint=\"Welcome! Click below to get started.\"\n action=\"Get Started\"\n [showIntro]=\"!hasOnboarded\"\n (showAction)=\"markOnboarded()\">\n <p>Main content shown after the action.</p>\n</dbx-intro-action-section>",
|
|
1942
|
+
"minimalExample": "<dbx-intro-action-section hint=\"Welcome\" action=\"Start\"><p>Body</p></dbx-intro-action-section>",
|
|
1943
|
+
"sourceLocation": {
|
|
1944
|
+
"file": "src/lib/layout/section/section.intro.component.ts",
|
|
1945
|
+
"line": 29
|
|
1946
|
+
}
|
|
1947
|
+
},
|
|
1948
|
+
{
|
|
1949
|
+
"slug": "section-page",
|
|
1950
|
+
"category": "layout",
|
|
1951
|
+
"kind": "component",
|
|
1952
|
+
"selector": "dbx-section-page",
|
|
1953
|
+
"className": "DbxSectionPageComponent",
|
|
1954
|
+
"module": "@dereekb/dbx-web",
|
|
1955
|
+
"description": "Renders a full page section with a header (defaulting to h2) and scrollable body area.\nSupports nested section pages that retain proper fixed-height layout. Use for top-level\npage content that needs a prominent heading.",
|
|
1956
|
+
"inputs": [
|
|
1957
|
+
{
|
|
1958
|
+
"name": "scroll",
|
|
1959
|
+
"type": "DbxSectionPageScrollLockedMode",
|
|
1960
|
+
"description": "",
|
|
1961
|
+
"required": false,
|
|
1962
|
+
"default": "'all'"
|
|
1963
|
+
},
|
|
1964
|
+
{
|
|
1965
|
+
"name": "headerConfig",
|
|
1966
|
+
"type": "Maybe<DbxSectionHeaderConfig>",
|
|
1967
|
+
"description": "",
|
|
1968
|
+
"required": false
|
|
1969
|
+
},
|
|
1970
|
+
{
|
|
1971
|
+
"name": "h",
|
|
1972
|
+
"type": "Maybe<DbxSectionHeaderHType>",
|
|
1973
|
+
"description": "",
|
|
1974
|
+
"required": false
|
|
1975
|
+
},
|
|
1976
|
+
{
|
|
1977
|
+
"name": "paddedHeader",
|
|
1978
|
+
"type": "Maybe<boolean>",
|
|
1979
|
+
"description": "",
|
|
1980
|
+
"required": false
|
|
1981
|
+
},
|
|
1982
|
+
{
|
|
1983
|
+
"name": "header",
|
|
1984
|
+
"type": "Maybe<string>",
|
|
1985
|
+
"description": "",
|
|
1986
|
+
"required": false
|
|
1987
|
+
},
|
|
1988
|
+
{
|
|
1989
|
+
"name": "onlyHeader",
|
|
1990
|
+
"type": "Maybe<boolean>",
|
|
1991
|
+
"description": "",
|
|
1992
|
+
"required": false
|
|
1993
|
+
},
|
|
1994
|
+
{
|
|
1995
|
+
"name": "icon",
|
|
1996
|
+
"type": "Maybe<string>",
|
|
1997
|
+
"description": "",
|
|
1998
|
+
"required": false
|
|
1999
|
+
},
|
|
2000
|
+
{
|
|
2001
|
+
"name": "hint",
|
|
2002
|
+
"type": "Maybe<string>",
|
|
2003
|
+
"description": "",
|
|
2004
|
+
"required": false
|
|
2005
|
+
},
|
|
2006
|
+
{
|
|
2007
|
+
"name": "hintInline",
|
|
2008
|
+
"type": "Maybe<boolean>",
|
|
2009
|
+
"description": "",
|
|
2010
|
+
"required": false
|
|
2011
|
+
}
|
|
2012
|
+
],
|
|
2013
|
+
"outputs": [],
|
|
2014
|
+
"contentProjection": "<ng-content select=\"[sectionHeader]\"></ng-content>; <ng-content></ng-content>",
|
|
2015
|
+
"relatedSlugs": [
|
|
2016
|
+
"section",
|
|
2017
|
+
"content-page"
|
|
2018
|
+
],
|
|
2019
|
+
"skillRefs": [
|
|
2020
|
+
"dbx__ref__dbx-ui-building-blocks",
|
|
2021
|
+
"dbx__ref__dbx-app-structure"
|
|
2022
|
+
],
|
|
2023
|
+
"sourcePath": "lib/layout/section/section.page.component.ts",
|
|
2024
|
+
"example": "<dbx-section-page header=\"Dashboard\" icon=\"dashboard\" scroll=\"body\">\n <p>Top-level page content.</p>\n</dbx-section-page>",
|
|
2025
|
+
"minimalExample": "<dbx-section-page header=\"Page\"><p>Body</p></dbx-section-page>",
|
|
2026
|
+
"sourceLocation": {
|
|
2027
|
+
"file": "src/lib/layout/section/section.page.component.ts",
|
|
2028
|
+
"line": 34
|
|
2029
|
+
}
|
|
2030
|
+
},
|
|
2031
|
+
{
|
|
2032
|
+
"slug": "subsection",
|
|
2033
|
+
"category": "layout",
|
|
2034
|
+
"kind": "component",
|
|
2035
|
+
"selector": "dbx-subsection",
|
|
2036
|
+
"className": "DbxSubSectionComponent",
|
|
2037
|
+
"module": "@dereekb/dbx-web",
|
|
2038
|
+
"description": "Renders a subsection within a parent section, using a smaller heading (defaults to h4).\nUseful for grouping related content under a `dbx-section`.",
|
|
2039
|
+
"inputs": [
|
|
2040
|
+
{
|
|
2041
|
+
"name": "elevate",
|
|
2042
|
+
"type": "boolean",
|
|
2043
|
+
"description": "Apply elevated card styling.",
|
|
2044
|
+
"required": false,
|
|
2045
|
+
"default": "false"
|
|
2046
|
+
},
|
|
2047
|
+
{
|
|
2048
|
+
"name": "headerConfig",
|
|
2049
|
+
"type": "Maybe<DbxSectionHeaderConfig>",
|
|
2050
|
+
"description": "",
|
|
2051
|
+
"required": false
|
|
2052
|
+
},
|
|
2053
|
+
{
|
|
2054
|
+
"name": "h",
|
|
2055
|
+
"type": "Maybe<DbxSectionHeaderHType>",
|
|
2056
|
+
"description": "",
|
|
2057
|
+
"required": false
|
|
2058
|
+
},
|
|
2059
|
+
{
|
|
2060
|
+
"name": "paddedHeader",
|
|
2061
|
+
"type": "Maybe<boolean>",
|
|
2062
|
+
"description": "",
|
|
2063
|
+
"required": false
|
|
2064
|
+
},
|
|
2065
|
+
{
|
|
2066
|
+
"name": "header",
|
|
2067
|
+
"type": "Maybe<string>",
|
|
2068
|
+
"description": "",
|
|
2069
|
+
"required": false
|
|
2070
|
+
},
|
|
2071
|
+
{
|
|
2072
|
+
"name": "onlyHeader",
|
|
2073
|
+
"type": "Maybe<boolean>",
|
|
2074
|
+
"description": "",
|
|
2075
|
+
"required": false
|
|
2076
|
+
},
|
|
2077
|
+
{
|
|
2078
|
+
"name": "icon",
|
|
2079
|
+
"type": "Maybe<string>",
|
|
2080
|
+
"description": "",
|
|
2081
|
+
"required": false
|
|
2082
|
+
},
|
|
2083
|
+
{
|
|
2084
|
+
"name": "hint",
|
|
2085
|
+
"type": "Maybe<string>",
|
|
2086
|
+
"description": "",
|
|
2087
|
+
"required": false
|
|
2088
|
+
},
|
|
2089
|
+
{
|
|
2090
|
+
"name": "hintInline",
|
|
2091
|
+
"type": "Maybe<boolean>",
|
|
2092
|
+
"description": "",
|
|
2093
|
+
"required": false
|
|
2094
|
+
}
|
|
2095
|
+
],
|
|
2096
|
+
"outputs": [],
|
|
2097
|
+
"contentProjection": "<ng-content select=\"[sectionHeader]\"></ng-content>; <ng-content></ng-content>",
|
|
2098
|
+
"relatedSlugs": [
|
|
2099
|
+
"section",
|
|
2100
|
+
"section-header"
|
|
2101
|
+
],
|
|
2102
|
+
"skillRefs": [
|
|
2103
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
2104
|
+
],
|
|
2105
|
+
"sourcePath": "lib/layout/section/subsection.component.ts",
|
|
2106
|
+
"example": "<dbx-section header=\"Settings\">\n <dbx-subsection header=\"Notifications\" icon=\"notifications\">\n <p>Subsection body.</p>\n </dbx-subsection>\n</dbx-section>",
|
|
2107
|
+
"minimalExample": "<dbx-subsection header=\"Details\"><p>Body</p></dbx-subsection>",
|
|
2108
|
+
"sourceLocation": {
|
|
2109
|
+
"file": "src/lib/layout/section/subsection.component.ts",
|
|
2110
|
+
"line": 27
|
|
2111
|
+
}
|
|
2112
|
+
},
|
|
2113
|
+
{
|
|
2114
|
+
"slug": "spacer",
|
|
2115
|
+
"category": "layout",
|
|
2116
|
+
"kind": "directive",
|
|
2117
|
+
"selector": "dbx-spacer, [dbxSpacer]",
|
|
2118
|
+
"className": "DbxSpacerDirective",
|
|
2119
|
+
"module": "@dereekb/dbx-web",
|
|
2120
|
+
"description": "Adds flexible spacing between sibling elements in a flex container.",
|
|
2121
|
+
"inputs": [],
|
|
2122
|
+
"outputs": [],
|
|
2123
|
+
"relatedSlugs": [
|
|
2124
|
+
"bar",
|
|
2125
|
+
"button-spacer"
|
|
2126
|
+
],
|
|
2127
|
+
"skillRefs": [
|
|
2128
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
2129
|
+
],
|
|
2130
|
+
"sourcePath": "lib/layout/style/spacer.directive.ts",
|
|
2131
|
+
"example": "<dbx-bar>\n <span>Title</span>\n <dbx-spacer></dbx-spacer>\n <button mat-button>Action</button>\n</dbx-bar>",
|
|
2132
|
+
"minimalExample": "<dbx-spacer></dbx-spacer>",
|
|
2133
|
+
"sourceLocation": {
|
|
2134
|
+
"file": "src/lib/layout/style/spacer.directive.ts",
|
|
2135
|
+
"line": 24
|
|
2136
|
+
}
|
|
2137
|
+
},
|
|
2138
|
+
{
|
|
2139
|
+
"slug": "click-to-copy-text",
|
|
2140
|
+
"category": "text",
|
|
2141
|
+
"kind": "component",
|
|
2142
|
+
"selector": "dbx-click-to-copy-text",
|
|
2143
|
+
"className": "DbxClickToCopyTextComponent",
|
|
2144
|
+
"module": "@dereekb/dbx-web",
|
|
2145
|
+
"description": "Wraps projected content with click-to-copy functionality and a copy icon button.\n\nClicking the text or the icon copies the text to the clipboard and optionally shows a snackbar confirmation.",
|
|
2146
|
+
"inputs": [
|
|
2147
|
+
{
|
|
2148
|
+
"name": "copyText",
|
|
2149
|
+
"type": "Maybe<string>",
|
|
2150
|
+
"description": "",
|
|
2151
|
+
"required": false,
|
|
2152
|
+
"default": "undefined"
|
|
2153
|
+
},
|
|
2154
|
+
{
|
|
2155
|
+
"name": "showIcon",
|
|
2156
|
+
"type": "Maybe<boolean>",
|
|
2157
|
+
"description": "",
|
|
2158
|
+
"required": false,
|
|
2159
|
+
"default": "true"
|
|
2160
|
+
},
|
|
2161
|
+
{
|
|
2162
|
+
"name": "highlighted",
|
|
2163
|
+
"type": "boolean",
|
|
2164
|
+
"description": "",
|
|
2165
|
+
"required": false,
|
|
2166
|
+
"default": "false"
|
|
2167
|
+
},
|
|
2168
|
+
{
|
|
2169
|
+
"name": "clipboardSnackbarMessagesConfig",
|
|
2170
|
+
"type": "Maybe<CopyToClipboardFunctionWithSnackbarMessageSnackbarConfig>",
|
|
2171
|
+
"description": "",
|
|
2172
|
+
"required": false,
|
|
2173
|
+
"default": "undefined"
|
|
2174
|
+
},
|
|
2175
|
+
{
|
|
2176
|
+
"name": "clipboardSnackbarMessagesEnabled",
|
|
2177
|
+
"type": "boolean",
|
|
2178
|
+
"description": "",
|
|
2179
|
+
"required": false,
|
|
2180
|
+
"default": "true"
|
|
2181
|
+
},
|
|
2182
|
+
{
|
|
2183
|
+
"name": "clickToCopyIcon",
|
|
2184
|
+
"type": "string",
|
|
2185
|
+
"description": "",
|
|
2186
|
+
"required": false,
|
|
2187
|
+
"default": "'content_copy'"
|
|
2188
|
+
},
|
|
2189
|
+
{
|
|
2190
|
+
"name": "clickIconToCopyOnly",
|
|
2191
|
+
"type": "boolean",
|
|
2192
|
+
"description": "",
|
|
2193
|
+
"required": false,
|
|
2194
|
+
"default": "false"
|
|
2195
|
+
}
|
|
2196
|
+
],
|
|
2197
|
+
"outputs": [],
|
|
2198
|
+
"contentProjection": "<ng-content></ng-content>",
|
|
2199
|
+
"relatedSlugs": [
|
|
2200
|
+
"chip"
|
|
2201
|
+
],
|
|
2202
|
+
"skillRefs": [
|
|
2203
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
2204
|
+
],
|
|
2205
|
+
"sourcePath": "lib/layout/text/copy.text.component.ts",
|
|
2206
|
+
"example": "<dbx-click-to-copy-text [text]=\"userId\"></dbx-click-to-copy-text>",
|
|
2207
|
+
"minimalExample": "<dbx-click-to-copy-text [text]=\"value\"></dbx-click-to-copy-text>",
|
|
2208
|
+
"sourceLocation": {
|
|
2209
|
+
"file": "src/lib/layout/text/copy.text.component.ts",
|
|
2210
|
+
"line": 26
|
|
2211
|
+
}
|
|
2212
|
+
},
|
|
2213
|
+
{
|
|
2214
|
+
"slug": "detail-block",
|
|
2215
|
+
"category": "text",
|
|
2216
|
+
"kind": "component",
|
|
2217
|
+
"selector": "dbx-detail-block",
|
|
2218
|
+
"className": "DbxDetailBlockComponent",
|
|
2219
|
+
"module": "@dereekb/dbx-web",
|
|
2220
|
+
"description": "A structured content block with a header row (icon + label) and a detail content area below.\n\nUse the `[header]` content slot for extra header-level content and default content for the detail area.",
|
|
2221
|
+
"inputs": [
|
|
2222
|
+
{
|
|
2223
|
+
"name": "icon",
|
|
2224
|
+
"type": "Maybe<string>",
|
|
2225
|
+
"description": "",
|
|
2226
|
+
"required": false
|
|
2227
|
+
},
|
|
2228
|
+
{
|
|
2229
|
+
"name": "header",
|
|
2230
|
+
"type": "Maybe<string>",
|
|
2231
|
+
"description": "",
|
|
2232
|
+
"required": false
|
|
2233
|
+
},
|
|
2234
|
+
{
|
|
2235
|
+
"name": "alignHeader",
|
|
2236
|
+
"type": "boolean",
|
|
2237
|
+
"description": "",
|
|
2238
|
+
"required": false,
|
|
2239
|
+
"default": "false"
|
|
2240
|
+
},
|
|
2241
|
+
{
|
|
2242
|
+
"name": "bigHeader",
|
|
2243
|
+
"type": "boolean",
|
|
2244
|
+
"description": "",
|
|
2245
|
+
"required": false,
|
|
2246
|
+
"default": "false"
|
|
2247
|
+
}
|
|
2248
|
+
],
|
|
2249
|
+
"outputs": [],
|
|
2250
|
+
"contentProjection": "<ng-content select=\"[header]\"></ng-content>; <ng-content></ng-content>",
|
|
2251
|
+
"relatedSlugs": [
|
|
2252
|
+
"label-block"
|
|
2253
|
+
],
|
|
2254
|
+
"skillRefs": [
|
|
2255
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
2256
|
+
],
|
|
2257
|
+
"sourcePath": "lib/layout/text/detail.block.component.ts",
|
|
2258
|
+
"example": "<dbx-detail-block header=\"Email\" icon=\"mail\">\n <p>{{ user.email }}</p>\n</dbx-detail-block>",
|
|
2259
|
+
"minimalExample": "<dbx-detail-block header=\"Label\">Body</dbx-detail-block>",
|
|
2260
|
+
"sourceLocation": {
|
|
2261
|
+
"file": "src/lib/layout/text/detail.block.component.ts",
|
|
2262
|
+
"line": 26
|
|
2263
|
+
}
|
|
2264
|
+
},
|
|
2265
|
+
{
|
|
2266
|
+
"slug": "label-block",
|
|
2267
|
+
"category": "text",
|
|
2268
|
+
"kind": "component",
|
|
2269
|
+
"selector": "dbx-label-block",
|
|
2270
|
+
"className": "DbxLabelBlockComponent",
|
|
2271
|
+
"module": "@dereekb/dbx-web",
|
|
2272
|
+
"description": "Displays a label header above projected content, useful for labeling form fields or data sections.",
|
|
2273
|
+
"inputs": [
|
|
2274
|
+
{
|
|
2275
|
+
"name": "header",
|
|
2276
|
+
"type": "Maybe<string>",
|
|
2277
|
+
"description": "",
|
|
2278
|
+
"required": false
|
|
2279
|
+
}
|
|
2280
|
+
],
|
|
2281
|
+
"outputs": [],
|
|
2282
|
+
"contentProjection": "<ng-content></ng-content>",
|
|
2283
|
+
"relatedSlugs": [
|
|
2284
|
+
"detail-block"
|
|
2285
|
+
],
|
|
2286
|
+
"skillRefs": [
|
|
2287
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
2288
|
+
],
|
|
2289
|
+
"sourcePath": "lib/layout/text/label.block.component.ts",
|
|
2290
|
+
"example": "<dbx-label-block header=\"Status\"><span>Active</span></dbx-label-block>",
|
|
2291
|
+
"minimalExample": "<dbx-label-block header=\"Label\">Body</dbx-label-block>",
|
|
2292
|
+
"sourceLocation": {
|
|
2293
|
+
"file": "src/lib/layout/text/label.block.component.ts",
|
|
2294
|
+
"line": 21
|
|
2295
|
+
}
|
|
2296
|
+
},
|
|
2297
|
+
{
|
|
2298
|
+
"slug": "chip",
|
|
2299
|
+
"category": "text",
|
|
2300
|
+
"kind": "directive",
|
|
2301
|
+
"selector": "dbx-chip",
|
|
2302
|
+
"className": "DbxChipDirective",
|
|
2303
|
+
"module": "@dereekb/dbx-web",
|
|
2304
|
+
"description": "Renders a styled chip element with optional small, block, and color modes.",
|
|
2305
|
+
"inputs": [
|
|
2306
|
+
{
|
|
2307
|
+
"name": "small",
|
|
2308
|
+
"type": "Maybe<boolean>",
|
|
2309
|
+
"description": "",
|
|
2310
|
+
"required": false
|
|
2311
|
+
},
|
|
2312
|
+
{
|
|
2313
|
+
"name": "block",
|
|
2314
|
+
"type": "Maybe<boolean>",
|
|
2315
|
+
"description": "",
|
|
2316
|
+
"required": false
|
|
2317
|
+
},
|
|
2318
|
+
{
|
|
2319
|
+
"name": "color",
|
|
2320
|
+
"type": "Maybe<DbxThemeColor>",
|
|
2321
|
+
"description": "Theme color applied to the chip background via {@link dbxColorBackground}.\n\nWhen {@link display} is also set, its color is used as a fallback.",
|
|
2322
|
+
"required": false
|
|
2323
|
+
},
|
|
2324
|
+
{
|
|
2325
|
+
"name": "display",
|
|
2326
|
+
"type": "Maybe<DbxChipDisplay>",
|
|
2327
|
+
"description": "Display configuration that provides color (and optionally label/value metadata).\n\nThe color from `display` is used as a fallback when `color` is not explicitly set.",
|
|
2328
|
+
"required": false
|
|
2329
|
+
},
|
|
2330
|
+
{
|
|
2331
|
+
"name": "tone",
|
|
2332
|
+
"type": "Maybe<DbxColorTone>",
|
|
2333
|
+
"description": "Background tone level for tonal appearance. Defaults to {@link DBX_CHIP_DEFAULT_TONE}.\n\nSet to `100` for fully opaque background.",
|
|
2334
|
+
"required": false
|
|
2335
|
+
}
|
|
2336
|
+
],
|
|
2337
|
+
"outputs": [],
|
|
2338
|
+
"relatedSlugs": [
|
|
2339
|
+
"chip-list"
|
|
2340
|
+
],
|
|
2341
|
+
"skillRefs": [
|
|
2342
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
2343
|
+
],
|
|
2344
|
+
"sourcePath": "lib/layout/text/text.chip.directive.ts",
|
|
2345
|
+
"example": "<dbx-chip text=\"Active\" icon=\"check\" color=\"primary\"></dbx-chip>",
|
|
2346
|
+
"minimalExample": "<dbx-chip text=\"Tag\"></dbx-chip>",
|
|
2347
|
+
"sourceLocation": {
|
|
2348
|
+
"file": "src/lib/layout/text/text.chip.directive.ts",
|
|
2349
|
+
"line": 55
|
|
2350
|
+
}
|
|
2351
|
+
},
|
|
2352
|
+
{
|
|
2353
|
+
"slug": "chip-list",
|
|
2354
|
+
"category": "text",
|
|
2355
|
+
"kind": "component",
|
|
2356
|
+
"selector": "dbx-chip-list",
|
|
2357
|
+
"className": "DbxChipListComponent",
|
|
2358
|
+
"module": "@dereekb/dbx-web",
|
|
2359
|
+
"description": "Renders a row of colored chips from an array of {@link DbxChipDisplay} items.\n\nUses {@link DbxChipDirective} internally with `dbx-chip-spacer` class for spacing.",
|
|
2360
|
+
"inputs": [
|
|
2361
|
+
{
|
|
2362
|
+
"name": "chips",
|
|
2363
|
+
"type": "Maybe<DbxChipDisplay[]>",
|
|
2364
|
+
"description": "",
|
|
2365
|
+
"required": false
|
|
2366
|
+
},
|
|
2367
|
+
{
|
|
2368
|
+
"name": "small",
|
|
2369
|
+
"type": "Maybe<boolean>",
|
|
2370
|
+
"description": "",
|
|
2371
|
+
"required": false
|
|
2372
|
+
}
|
|
2373
|
+
],
|
|
2374
|
+
"outputs": [],
|
|
2375
|
+
"relatedSlugs": [
|
|
2376
|
+
"chip"
|
|
2377
|
+
],
|
|
2378
|
+
"skillRefs": [
|
|
2379
|
+
"dbx__ref__dbx-ui-building-blocks"
|
|
2380
|
+
],
|
|
2381
|
+
"sourcePath": "lib/layout/text/text.chip.list.component.ts",
|
|
2382
|
+
"example": "<dbx-chip-list>\n <dbx-chip text=\"Tag1\"></dbx-chip>\n <dbx-chip text=\"Tag2\"></dbx-chip>\n</dbx-chip-list>",
|
|
2383
|
+
"minimalExample": "<dbx-chip-list></dbx-chip-list>",
|
|
2384
|
+
"sourceLocation": {
|
|
2385
|
+
"file": "src/lib/layout/text/text.chip.list.component.ts",
|
|
2386
|
+
"line": 27
|
|
2387
|
+
}
|
|
2388
|
+
},
|
|
2389
|
+
{
|
|
2390
|
+
"slug": "two-column",
|
|
2391
|
+
"category": "layout",
|
|
2392
|
+
"kind": "component",
|
|
2393
|
+
"selector": "dbx-two-column",
|
|
2394
|
+
"className": "DbxTwoColumnComponent",
|
|
2395
|
+
"module": "@dereekb/dbx-web",
|
|
2396
|
+
"description": "Responsive two-column layout that splits content into a narrower left column and a wider right column.\n\nThe right column contains the primary content. When the viewport is too narrow to fit both columns,\nthe left column can be automatically hidden based on the configured minimum right width.\n\nRequires a {@link TwoColumnsContextStore} to be provided by a parent component or directive.",
|
|
2397
|
+
"inputs": [
|
|
2398
|
+
{
|
|
2399
|
+
"name": "reverseSizing",
|
|
2400
|
+
"type": "boolean",
|
|
2401
|
+
"description": "Whether to reverse the default column sizing so the left column is larger than the right.",
|
|
2402
|
+
"required": false,
|
|
2403
|
+
"default": "false"
|
|
2404
|
+
},
|
|
2405
|
+
{
|
|
2406
|
+
"name": "inSectionPage",
|
|
2407
|
+
"type": "boolean",
|
|
2408
|
+
"description": "Whether this two-column layout is rendered within a section page context.",
|
|
2409
|
+
"required": false,
|
|
2410
|
+
"default": "false"
|
|
2411
|
+
},
|
|
2412
|
+
{
|
|
2413
|
+
"name": "hasRightContent",
|
|
2414
|
+
"type": "boolean",
|
|
2415
|
+
"description": "Acts as an override to show the right column without having to use dbx-two-column-right or update the context store directly.",
|
|
2416
|
+
"required": false,
|
|
2417
|
+
"default": "false"
|
|
2418
|
+
}
|
|
2419
|
+
],
|
|
2420
|
+
"outputs": [],
|
|
2421
|
+
"contentProjection": "<ng-content select=\"[left]\"></ng-content>; <ng-content select=\"[right]\"></ng-content>",
|
|
2422
|
+
"relatedSlugs": [
|
|
2423
|
+
"two-column-right"
|
|
2424
|
+
],
|
|
2425
|
+
"skillRefs": [
|
|
2426
|
+
"dbx__ref__dbx-ui-building-blocks",
|
|
2427
|
+
"dbx__ref__dbx-app-structure"
|
|
2428
|
+
],
|
|
2429
|
+
"sourcePath": "lib/layout/column/two/two.column.component.ts",
|
|
2430
|
+
"example": "<dbx-two-column [inSectionPage]=\"true\">\n <dbx-list left [state$]=\"state$\" [config]=\"listConfig\" />\n <dbx-two-column-right right header=\"Detail\">\n <p>Selected item detail.</p>\n </dbx-two-column-right>\n</dbx-two-column>",
|
|
2431
|
+
"minimalExample": "<dbx-two-column>\n<div left>Sidebar</div>\n<div right>Main</div>\n</dbx-two-column>",
|
|
2432
|
+
"sourceLocation": {
|
|
2433
|
+
"file": "src/lib/layout/column/two/two.column.component.ts",
|
|
2434
|
+
"line": 53
|
|
2435
|
+
}
|
|
2436
|
+
},
|
|
2437
|
+
{
|
|
2438
|
+
"slug": "two-column-right",
|
|
2439
|
+
"category": "layout",
|
|
2440
|
+
"kind": "component",
|
|
2441
|
+
"selector": "dbx-two-column-right",
|
|
2442
|
+
"className": "DbxTwoColumnRightComponent",
|
|
2443
|
+
"module": "@dereekb/dbx-web",
|
|
2444
|
+
"description": "Wraps right-column content within a {@link DbxTwoColumnComponent} and renders a navigation bar with a back button.\n\nWhen this component is created, it automatically registers itself with the {@link TwoColumnsContextStore}\nto indicate that right-side content is present.",
|
|
2445
|
+
"inputs": [
|
|
2446
|
+
{
|
|
2447
|
+
"name": "full",
|
|
2448
|
+
"type": "boolean",
|
|
2449
|
+
"description": "Whether the header area should expand to full width.",
|
|
2450
|
+
"required": false,
|
|
2451
|
+
"default": "false"
|
|
2452
|
+
},
|
|
2453
|
+
{
|
|
2454
|
+
"name": "header",
|
|
2455
|
+
"type": "Maybe<string>",
|
|
2456
|
+
"description": "Optional title text displayed in the navigation bar header.",
|
|
2457
|
+
"required": false
|
|
2458
|
+
},
|
|
2459
|
+
{
|
|
2460
|
+
"name": "block",
|
|
2461
|
+
"type": "Maybe<boolean>",
|
|
2462
|
+
"description": "Whether the header should use block-level display.",
|
|
2463
|
+
"required": false
|
|
2464
|
+
},
|
|
2465
|
+
{
|
|
2466
|
+
"name": "showBack",
|
|
2467
|
+
"type": "boolean",
|
|
2468
|
+
"description": "Whether to show the default back button. Defaults to `true`.\nIf a `backRef` is set on the store, that anchor is used instead.",
|
|
2469
|
+
"required": false,
|
|
2470
|
+
"default": "true"
|
|
2471
|
+
},
|
|
2472
|
+
{
|
|
2473
|
+
"name": "minRightWidth",
|
|
2474
|
+
"type": "Maybe<number>",
|
|
2475
|
+
"description": "Minimum right-side width allowed in pixels.",
|
|
2476
|
+
"required": false
|
|
2477
|
+
}
|
|
2478
|
+
],
|
|
2479
|
+
"outputs": [],
|
|
2480
|
+
"contentProjection": "<ng-content select=\"[nav]\"></ng-content>; <ng-content></ng-content>",
|
|
2481
|
+
"relatedSlugs": [
|
|
2482
|
+
"two-column"
|
|
2483
|
+
],
|
|
2484
|
+
"skillRefs": [
|
|
2485
|
+
"dbx__ref__dbx-ui-building-blocks",
|
|
2486
|
+
"dbx__ref__dbx-app-structure"
|
|
2487
|
+
],
|
|
2488
|
+
"sourcePath": "lib/layout/column/two/two.column.right.component.ts",
|
|
2489
|
+
"example": "<dbx-two-column-right header=\"Item Detail\">\n <button nav mat-icon-button><mat-icon>delete</mat-icon></button>\n <p>Body content</p>\n</dbx-two-column-right>",
|
|
2490
|
+
"minimalExample": "<dbx-two-column-right>Body</dbx-two-column-right>",
|
|
2491
|
+
"sourceLocation": {
|
|
2492
|
+
"file": "src/lib/layout/column/two/two.column.right.component.ts",
|
|
2493
|
+
"line": 35
|
|
2494
|
+
}
|
|
2495
|
+
},
|
|
2496
|
+
{
|
|
2497
|
+
"slug": "list-accordion-view",
|
|
2498
|
+
"category": "list",
|
|
2499
|
+
"kind": "component",
|
|
2500
|
+
"selector": "dbx-list-accordion-view",
|
|
2501
|
+
"className": "DbxValueListAccordionViewComponent",
|
|
2502
|
+
"module": "@dereekb/dbx-web",
|
|
2503
|
+
"description": "Renders a value list as an accordion using a configuration input. Each item renders its own expansion panel.\nRequires a parent {@link DbxListView} context.",
|
|
2504
|
+
"inputs": [
|
|
2505
|
+
{
|
|
2506
|
+
"name": "config",
|
|
2507
|
+
"type": "C",
|
|
2508
|
+
"description": "",
|
|
2509
|
+
"required": true
|
|
2510
|
+
}
|
|
2511
|
+
],
|
|
2512
|
+
"outputs": [],
|
|
2513
|
+
"relatedSlugs": [
|
|
2514
|
+
"list",
|
|
2515
|
+
"list-view"
|
|
2516
|
+
],
|
|
2517
|
+
"skillRefs": [
|
|
2518
|
+
"dbx__ref__dbx-component-patterns"
|
|
2519
|
+
],
|
|
2520
|
+
"sourcePath": "lib/layout/list/accordion/list.accordion.view.component.ts",
|
|
2521
|
+
"example": "<dbx-list-accordion-view [config]=\"rowConfig\"></dbx-list-accordion-view>",
|
|
2522
|
+
"minimalExample": "<dbx-list-accordion-view [config]=\"rowConfig\"></dbx-list-accordion-view>",
|
|
2523
|
+
"sourceLocation": {
|
|
2524
|
+
"file": "src/lib/layout/list/accordion/list.accordion.view.component.ts",
|
|
2525
|
+
"line": 228
|
|
2526
|
+
}
|
|
2527
|
+
},
|
|
2528
|
+
{
|
|
2529
|
+
"slug": "list-grid-view",
|
|
2530
|
+
"category": "list",
|
|
2531
|
+
"kind": "component",
|
|
2532
|
+
"selector": "dbx-list-grid-view",
|
|
2533
|
+
"className": "DbxValueListGridViewComponent",
|
|
2534
|
+
"module": "@dereekb/dbx-web",
|
|
2535
|
+
"description": "Renders a value list as a CSS grid using a configuration input. Requires a parent {@link DbxListView} context.",
|
|
2536
|
+
"inputs": [
|
|
2537
|
+
{
|
|
2538
|
+
"name": "config",
|
|
2539
|
+
"type": "C",
|
|
2540
|
+
"description": "",
|
|
2541
|
+
"required": true
|
|
2542
|
+
}
|
|
2543
|
+
],
|
|
2544
|
+
"outputs": [],
|
|
2545
|
+
"relatedSlugs": [
|
|
2546
|
+
"list",
|
|
2547
|
+
"list-view"
|
|
2548
|
+
],
|
|
2549
|
+
"skillRefs": [
|
|
2550
|
+
"dbx__ref__dbx-component-patterns"
|
|
2551
|
+
],
|
|
2552
|
+
"sourcePath": "lib/layout/list/grid/list.grid.view.component.ts",
|
|
2553
|
+
"example": "<dbx-list-grid-view [config]=\"cellConfig\" dbxListGridSize=\"md\"></dbx-list-grid-view>",
|
|
2554
|
+
"minimalExample": "<dbx-list-grid-view [config]=\"cellConfig\"></dbx-list-grid-view>",
|
|
2555
|
+
"sourceLocation": {
|
|
2556
|
+
"file": "src/lib/layout/list/grid/list.grid.view.component.ts",
|
|
2557
|
+
"line": 182
|
|
2558
|
+
}
|
|
2559
|
+
},
|
|
2560
|
+
{
|
|
2561
|
+
"slug": "list-title-group-header",
|
|
2562
|
+
"category": "list",
|
|
2563
|
+
"kind": "component",
|
|
2564
|
+
"selector": "dbx-list-title-group-header",
|
|
2565
|
+
"className": "DbxListTitleGroupHeaderComponent",
|
|
2566
|
+
"module": "@dereekb/dbx-web",
|
|
2567
|
+
"description": "Default group header component that displays a title, optional icon, and optional hint text.\nUsed automatically by {@link DbxListTitleGroupDirective} unless a custom header component is specified.",
|
|
2568
|
+
"inputs": [],
|
|
2569
|
+
"outputs": [],
|
|
2570
|
+
"relatedSlugs": [
|
|
2571
|
+
"list",
|
|
2572
|
+
"list-view"
|
|
2573
|
+
],
|
|
2574
|
+
"skillRefs": [
|
|
2575
|
+
"dbx__ref__dbx-component-patterns"
|
|
2576
|
+
],
|
|
2577
|
+
"sourcePath": "lib/layout/list/group/list.view.value.group.title.header.component.ts",
|
|
2578
|
+
"example": "<dbx-list-view [config]=\"rowConfig\" dbxListTitleGroup></dbx-list-view>",
|
|
2579
|
+
"minimalExample": "<dbx-list-title-group-header></dbx-list-title-group-header>",
|
|
2580
|
+
"sourceLocation": {
|
|
2581
|
+
"file": "src/lib/layout/list/group/list.view.value.group.title.header.component.ts",
|
|
2582
|
+
"line": 38
|
|
2583
|
+
}
|
|
2584
|
+
},
|
|
2585
|
+
{
|
|
2586
|
+
"slug": "anchor",
|
|
2587
|
+
"category": "router",
|
|
2588
|
+
"kind": "component",
|
|
2589
|
+
"selector": "dbx-anchor, [dbx-anchor]",
|
|
2590
|
+
"className": "DbxAnchorComponent",
|
|
2591
|
+
"module": "@dereekb/dbx-web",
|
|
2592
|
+
"description": "Renders an anchor element that adapts its presentation based on the type of navigation link provided.\n\nSupports plain content, clickable actions, router segue references, external hrefs, and disabled states.",
|
|
2593
|
+
"inputs": [
|
|
2594
|
+
{
|
|
2595
|
+
"name": "block",
|
|
2596
|
+
"type": "Maybe<boolean>",
|
|
2597
|
+
"description": "",
|
|
2598
|
+
"required": false
|
|
2599
|
+
}
|
|
2600
|
+
],
|
|
2601
|
+
"outputs": [],
|
|
2602
|
+
"contentProjection": "<ng-content></ng-content>",
|
|
2603
|
+
"relatedSlugs": [
|
|
2604
|
+
"anchor-list",
|
|
2605
|
+
"navbar",
|
|
2606
|
+
"sidenav"
|
|
2607
|
+
],
|
|
2608
|
+
"skillRefs": [
|
|
2609
|
+
"dbx__ref__dbx-app-structure"
|
|
2610
|
+
],
|
|
2611
|
+
"sourcePath": "lib/router/layout/anchor/anchor.component.ts",
|
|
2612
|
+
"example": "<dbx-anchor [anchor]=\"{ ref: 'app.home' }\">\n <button mat-button>Home</button>\n</dbx-anchor>",
|
|
2613
|
+
"minimalExample": "<dbx-anchor [anchor]=\"{ url: '/' }\">Home</dbx-anchor>",
|
|
2614
|
+
"sourceLocation": {
|
|
2615
|
+
"file": "src/lib/router/layout/anchor/anchor.component.ts",
|
|
2616
|
+
"line": 32
|
|
2617
|
+
}
|
|
2618
|
+
},
|
|
2619
|
+
{
|
|
2620
|
+
"slug": "anchor-list",
|
|
2621
|
+
"category": "router",
|
|
2622
|
+
"kind": "component",
|
|
2623
|
+
"selector": "dbx-anchor-list",
|
|
2624
|
+
"className": "DbxAnchorListComponent",
|
|
2625
|
+
"module": "@dereekb/dbx-web",
|
|
2626
|
+
"description": "Displays a hierarchical list of {@link ClickableAnchorLinkTree} items inside a Material navigation list.\n\nEach anchor is expanded and assigned depth-based CSS classes for nested styling.",
|
|
2627
|
+
"inputs": [
|
|
2628
|
+
{
|
|
2629
|
+
"name": "anchors",
|
|
2630
|
+
"type": "ClickableAnchorLinkTree[]",
|
|
2631
|
+
"description": "",
|
|
2632
|
+
"required": true
|
|
2633
|
+
}
|
|
2634
|
+
],
|
|
2635
|
+
"outputs": [],
|
|
2636
|
+
"relatedSlugs": [
|
|
2637
|
+
"anchor",
|
|
2638
|
+
"sidenav"
|
|
2639
|
+
],
|
|
2640
|
+
"skillRefs": [
|
|
2641
|
+
"dbx__ref__dbx-app-structure"
|
|
2642
|
+
],
|
|
2643
|
+
"sourcePath": "lib/router/layout/anchorlist/anchorlist.component.ts",
|
|
2644
|
+
"example": "<dbx-anchor-list [anchors]=\"navAnchors\"></dbx-anchor-list>",
|
|
2645
|
+
"minimalExample": "<dbx-anchor-list [anchors]=\"anchors\"></dbx-anchor-list>",
|
|
2646
|
+
"sourceLocation": {
|
|
2647
|
+
"file": "src/lib/router/layout/anchorlist/anchorlist.component.ts",
|
|
2648
|
+
"line": 36
|
|
2649
|
+
}
|
|
2650
|
+
},
|
|
2651
|
+
{
|
|
2652
|
+
"slug": "navbar",
|
|
2653
|
+
"category": "navigation",
|
|
2654
|
+
"kind": "component",
|
|
2655
|
+
"selector": "dbx-navbar",
|
|
2656
|
+
"className": "DbxNavbarComponent",
|
|
2657
|
+
"module": "@dereekb/dbx-web",
|
|
2658
|
+
"description": "Responsive navigation bar that displays anchor links as Material tabs, collapsing to a button menu or icon on smaller screens.\n\nAutomatically selects the active anchor based on the current route and supports configurable breakpoints.",
|
|
2659
|
+
"inputs": [
|
|
2660
|
+
{
|
|
2661
|
+
"name": "showMenuCaret",
|
|
2662
|
+
"type": "boolean",
|
|
2663
|
+
"description": "Whether or not to show the dropwdown caret for a menu",
|
|
2664
|
+
"required": false,
|
|
2665
|
+
"default": "false"
|
|
2666
|
+
},
|
|
2667
|
+
{
|
|
2668
|
+
"name": "fab",
|
|
2669
|
+
"type": "boolean",
|
|
2670
|
+
"description": "",
|
|
2671
|
+
"required": false,
|
|
2672
|
+
"default": "false"
|
|
2673
|
+
},
|
|
2674
|
+
{
|
|
2675
|
+
"name": "navAlign",
|
|
2676
|
+
"type": "HorizontalConnectionPos",
|
|
2677
|
+
"description": "",
|
|
2678
|
+
"required": false,
|
|
2679
|
+
"default": "'center'"
|
|
2680
|
+
},
|
|
2681
|
+
{
|
|
2682
|
+
"name": "icon",
|
|
2683
|
+
"type": "Maybe<string>",
|
|
2684
|
+
"description": "",
|
|
2685
|
+
"required": false
|
|
2686
|
+
},
|
|
2687
|
+
{
|
|
2688
|
+
"name": "defaultIcon",
|
|
2689
|
+
"type": "Maybe<string>",
|
|
2690
|
+
"description": "",
|
|
2691
|
+
"required": false,
|
|
2692
|
+
"default": "'menu'"
|
|
2693
|
+
},
|
|
2694
|
+
{
|
|
2695
|
+
"name": "defaultText",
|
|
2696
|
+
"type": "Maybe<string>",
|
|
2697
|
+
"description": "",
|
|
2698
|
+
"required": false
|
|
2699
|
+
},
|
|
2700
|
+
{
|
|
2701
|
+
"name": "mode",
|
|
2702
|
+
"type": "Maybe<NavbarMode>",
|
|
2703
|
+
"description": "",
|
|
2704
|
+
"required": false
|
|
2705
|
+
},
|
|
2706
|
+
{
|
|
2707
|
+
"name": "buttonMode",
|
|
2708
|
+
"type": "NavbarButtonMode",
|
|
2709
|
+
"description": "",
|
|
2710
|
+
"required": false,
|
|
2711
|
+
"default": "'menu'"
|
|
2712
|
+
},
|
|
2713
|
+
{
|
|
2714
|
+
"name": "breakpoint",
|
|
2715
|
+
"type": "ScreenMediaWidthType",
|
|
2716
|
+
"description": "",
|
|
2717
|
+
"required": false,
|
|
2718
|
+
"default": "'large'"
|
|
2719
|
+
},
|
|
2720
|
+
{
|
|
2721
|
+
"name": "anchors",
|
|
2722
|
+
"type": "Maybe<ClickableAnchorLinkSegueRef[]>",
|
|
2723
|
+
"description": "",
|
|
2724
|
+
"required": false,
|
|
2725
|
+
"default": "[]"
|
|
2726
|
+
}
|
|
2727
|
+
],
|
|
2728
|
+
"outputs": [],
|
|
2729
|
+
"relatedSlugs": [
|
|
2730
|
+
"anchor",
|
|
2731
|
+
"sidenav",
|
|
2732
|
+
"pagebar"
|
|
2733
|
+
],
|
|
2734
|
+
"skillRefs": [
|
|
2735
|
+
"dbx__ref__dbx-app-structure"
|
|
2736
|
+
],
|
|
2737
|
+
"sourcePath": "lib/router/layout/navbar/navbar.component.ts",
|
|
2738
|
+
"example": "<dbx-navbar [anchors]=\"topNav\"></dbx-navbar>",
|
|
2739
|
+
"minimalExample": "<dbx-navbar [anchors]=\"anchors\"></dbx-navbar>",
|
|
2740
|
+
"sourceLocation": {
|
|
2741
|
+
"file": "src/lib/router/layout/navbar/navbar.component.ts",
|
|
2742
|
+
"line": 58
|
|
2743
|
+
}
|
|
2744
|
+
},
|
|
2745
|
+
{
|
|
2746
|
+
"slug": "sidenav",
|
|
2747
|
+
"category": "navigation",
|
|
2748
|
+
"kind": "component",
|
|
2749
|
+
"selector": "dbx-sidenav",
|
|
2750
|
+
"className": "DbxSidenavComponent",
|
|
2751
|
+
"module": "@dereekb/dbx-web",
|
|
2752
|
+
"description": "Responsive side navigation component that adapts its display mode based on screen width.\n\nRenders a Material sidenav with an anchor list and automatically transitions between mobile overlay, icon rail, and full sidebar modes.\nCloses automatically on route transitions in mobile mode.",
|
|
2753
|
+
"inputs": [
|
|
2754
|
+
{
|
|
2755
|
+
"name": "color",
|
|
2756
|
+
"type": "ThemePalette | DbxThemeColor",
|
|
2757
|
+
"description": "",
|
|
2758
|
+
"required": false,
|
|
2759
|
+
"default": "undefined"
|
|
2760
|
+
},
|
|
2761
|
+
{
|
|
2762
|
+
"name": "position",
|
|
2763
|
+
"type": "DbxSidenavPosition",
|
|
2764
|
+
"description": "",
|
|
2765
|
+
"required": false,
|
|
2766
|
+
"default": "'start'"
|
|
2767
|
+
},
|
|
2768
|
+
{
|
|
2769
|
+
"name": "displayMode",
|
|
2770
|
+
"type": "Maybe<SideNavDisplayModeString>",
|
|
2771
|
+
"description": "Overrides the responsive display mode. When set, the sidenav ignores screen-width breakpoints and uses this mode instead.\n\nSet to `'mobile'` to keep the sidenav always hidden as an overlay that only opens when toggled.",
|
|
2772
|
+
"required": false,
|
|
2773
|
+
"default": "undefined"
|
|
2774
|
+
},
|
|
2775
|
+
{
|
|
2776
|
+
"name": "allowedModes",
|
|
2777
|
+
"type": "Maybe<SideNavDisplayModeString[]>",
|
|
2778
|
+
"description": "Restricts which {@link SideNavDisplayMode} values are permitted.\n\nWhen set, any responsive or overridden mode not in this set is rounded down to the nearest\nallowed mode in the {@link SIDE_NAV_DISPLAY_MODE_ORDER} hierarchy.",
|
|
2779
|
+
"required": false,
|
|
2780
|
+
"default": "undefined"
|
|
2781
|
+
},
|
|
2782
|
+
{
|
|
2783
|
+
"name": "anchors",
|
|
2784
|
+
"type": "Maybe<ClickableAnchorLinkTree[]>",
|
|
2785
|
+
"description": "",
|
|
2786
|
+
"required": false
|
|
2787
|
+
}
|
|
2788
|
+
],
|
|
2789
|
+
"outputs": [],
|
|
2790
|
+
"contentProjection": "<ng-content select=\"[top]\"></ng-content>; <ng-content select=\"[bottom]\"></ng-content>; <ng-content></ng-content>",
|
|
2791
|
+
"relatedSlugs": [
|
|
2792
|
+
"sidenav-page",
|
|
2793
|
+
"anchor-list"
|
|
2794
|
+
],
|
|
2795
|
+
"skillRefs": [
|
|
2796
|
+
"dbx__ref__dbx-app-structure"
|
|
2797
|
+
],
|
|
2798
|
+
"sourcePath": "lib/router/layout/sidenav/sidenav.component.ts",
|
|
2799
|
+
"example": "<dbx-sidenav [anchors]=\"sidenavAnchors\"></dbx-sidenav>",
|
|
2800
|
+
"minimalExample": "<dbx-sidenav [anchors]=\"anchors\"></dbx-sidenav>",
|
|
2801
|
+
"sourceLocation": {
|
|
2802
|
+
"file": "src/lib/router/layout/sidenav/sidenav.component.ts",
|
|
2803
|
+
"line": 45
|
|
2804
|
+
}
|
|
2805
|
+
},
|
|
2806
|
+
{
|
|
2807
|
+
"slug": "sidenav-page",
|
|
2808
|
+
"category": "navigation",
|
|
2809
|
+
"kind": "component",
|
|
2810
|
+
"selector": "dbx-sidenav-page",
|
|
2811
|
+
"className": "DbxSidenavPageComponent",
|
|
2812
|
+
"module": "@dereekb/dbx-web",
|
|
2813
|
+
"description": "Page layout component designed for use inside a {@link DbxSidenavComponent}. Includes a sidenav-aware pagebar and a content area.\n\nWhen `mobileOnly` is true, the pagebar is hidden on non-mobile screen sizes.",
|
|
2814
|
+
"inputs": [
|
|
2815
|
+
{
|
|
2816
|
+
"name": "color",
|
|
2817
|
+
"type": "Maybe<DbxBarColor>",
|
|
2818
|
+
"description": "",
|
|
2819
|
+
"required": false
|
|
2820
|
+
},
|
|
2821
|
+
{
|
|
2822
|
+
"name": "sidenavMenuIcon",
|
|
2823
|
+
"type": "Maybe<string>",
|
|
2824
|
+
"description": "",
|
|
2825
|
+
"required": false
|
|
2826
|
+
},
|
|
2827
|
+
{
|
|
2828
|
+
"name": "mobileOnly",
|
|
2829
|
+
"type": "boolean",
|
|
2830
|
+
"description": "",
|
|
2831
|
+
"required": false,
|
|
2832
|
+
"default": "false"
|
|
2833
|
+
}
|
|
2834
|
+
],
|
|
2835
|
+
"outputs": [],
|
|
2836
|
+
"contentProjection": "<ng-content select=\"[navRight]\"></ng-content>; <ng-content></ng-content>",
|
|
2837
|
+
"relatedSlugs": [
|
|
2838
|
+
"sidenav",
|
|
2839
|
+
"navbar"
|
|
2840
|
+
],
|
|
2841
|
+
"skillRefs": [
|
|
2842
|
+
"dbx__ref__dbx-app-structure"
|
|
2843
|
+
],
|
|
2844
|
+
"sourcePath": "lib/router/layout/sidenav/sidenav.page.component.ts",
|
|
2845
|
+
"example": "<dbx-sidenav-page>\n <ui-view></ui-view>\n</dbx-sidenav-page>",
|
|
2846
|
+
"minimalExample": "<dbx-sidenav-page>Content</dbx-sidenav-page>",
|
|
2847
|
+
"sourceLocation": {
|
|
2848
|
+
"file": "src/lib/router/layout/sidenav/sidenav.page.component.ts",
|
|
2849
|
+
"line": 31
|
|
2850
|
+
}
|
|
2851
|
+
}
|
|
2852
|
+
]
|
|
2853
|
+
}
|