@skyux/avatar 9.0.0-alpha.0 → 9.0.0-alpha.10

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.
Files changed (14) hide show
  1. package/documentation.json +636 -332
  2. package/esm2022/index.mjs +2 -4
  3. package/esm2022/lib/modules/avatar/avatar-adapter.service.mjs +3 -3
  4. package/esm2022/lib/modules/avatar/avatar.component.mjs +3 -3
  5. package/esm2022/lib/modules/avatar/avatar.inner.component.mjs +3 -3
  6. package/esm2022/lib/modules/avatar/avatar.module.mjs +5 -9
  7. package/esm2022/lib/modules/shared/sky-avatar-resources.module.mjs +8 -6
  8. package/esm2022/testing/public-api.mjs +2 -2
  9. package/fesm2022/skyux-avatar.mjs +21 -22
  10. package/fesm2022/skyux-avatar.mjs.map +1 -1
  11. package/index.d.ts +3 -3
  12. package/lib/modules/avatar/avatar.module.d.ts +2 -3
  13. package/package.json +11 -11
  14. package/testing/public-api.d.ts +1 -1
package/documentation.json CHANGED
@@ -2,504 +2,648 @@
2
2
  "anchorIds": {
3
3
  "SkyAvatarModule": "class-skyavatarmodule",
4
4
  "SkyAvatarComponent": "class-skyavatarcomponent",
5
- "SkyAvatarSize": "type-alias-skyavatarsize",
6
- "SkyAvatarSrc": "type-alias-skyavatarsrc"
5
+ "SkyAvatarSize": "typealias-skyavatarsize",
6
+ "SkyAvatarSrc": "typealias-skyavatarsrc"
7
7
  },
8
8
  "typedoc": {
9
9
  "id": 0,
10
10
  "name": "@skyux/avatar",
11
+ "variant": "project",
11
12
  "kind": 1,
12
13
  "flags": {},
13
- "originalName": "",
14
14
  "children": [
15
15
  {
16
- "id": 50,
16
+ "id": 5,
17
17
  "name": "SkyAvatarModule",
18
+ "variant": "declaration",
18
19
  "kind": 128,
19
- "kindString": "Class",
20
20
  "flags": {},
21
- "decorators": [
22
- {
23
- "name": "NgModule",
24
- "type": {
25
- "type": "reference",
26
- "qualifiedName": "NgModuleDecorator",
27
- "package": "@angular/core",
28
- "name": "NgModule"
29
- },
30
- "arguments": {
31
- "obj": "{\n declarations: [SkyAvatarInnerComponent, SkyAvatarComponent],\n imports: [\n CommonModule,\n SkyAvatarResourcesModule,\n SkyErrorModule,\n SkyFileAttachmentsModule,\n SkyI18nModule,\n SkyThemeModule,\n ],\n providers: [SkyFileSizePipe],\n exports: [SkyAvatarComponent],\n}"
32
- }
33
- }
34
- ],
35
21
  "children": [],
36
22
  "groups": [
37
23
  {
38
24
  "title": "Constructors",
39
- "kind": 512,
40
25
  "children": [
41
- 51
26
+ 6
42
27
  ]
43
28
  }
44
29
  ],
45
30
  "sources": [
46
31
  {
47
32
  "fileName": "projects/avatar/src/modules/avatar/avatar.module.ts",
48
- "line": 26,
49
- "character": 13
33
+ "line": 24,
34
+ "character": 13,
35
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.module.ts#L24"
36
+ }
37
+ ],
38
+ "decorators": [
39
+ {
40
+ "name": "NgModule",
41
+ "arguments": {
42
+ "obj": "@NgModule({\n declarations: [SkyAvatarInnerComponent, SkyAvatarComponent],\n imports: [\n CommonModule,\n SkyAvatarResourcesModule,\n SkyErrorModule,\n SkyFileAttachmentsModule,\n SkyThemeModule,\n ],\n providers: [SkyFileSizePipe],\n exports: [SkyAvatarComponent],\n})"
43
+ }
50
44
  }
51
45
  ]
52
46
  },
53
47
  {
54
- "id": 3,
48
+ "id": 8,
55
49
  "name": "SkyAvatarComponent",
50
+ "variant": "declaration",
56
51
  "kind": 128,
57
- "kindString": "Class",
58
52
  "flags": {},
59
- "decorators": [
60
- {
61
- "name": "Component",
62
- "type": {
63
- "type": "reference",
64
- "qualifiedName": "ComponentDecorator",
65
- "package": "@angular/core",
66
- "name": "Component"
67
- },
68
- "arguments": {
69
- "obj": "{\n selector: 'sky-avatar',\n templateUrl: './avatar.component.html',\n styleUrls: ['./avatar.component.scss'],\n encapsulation: ViewEncapsulation.None,\n}"
70
- }
71
- }
72
- ],
73
53
  "children": [
74
54
  {
75
- "id": 4,
55
+ "id": 9,
76
56
  "name": "constructor",
57
+ "variant": "declaration",
77
58
  "kind": 512,
78
- "kindString": "Constructor",
79
59
  "flags": {},
80
60
  "sources": [
81
61
  {
82
62
  "fileName": "projects/avatar/src/modules/avatar/avatar.component.ts",
83
63
  "line": 109,
84
- "character": 2
64
+ "character": 2,
65
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L109"
85
66
  }
86
67
  ],
87
68
  "signatures": [
88
69
  {
89
- "id": 5,
70
+ "id": 10,
90
71
  "name": "SkyAvatarComponent",
72
+ "variant": "signature",
91
73
  "kind": 16384,
92
- "kindString": "Constructor signature",
93
74
  "flags": {},
75
+ "sources": [
76
+ {
77
+ "fileName": "src/lib/modules/avatar/avatar.component.ts",
78
+ "line": 109,
79
+ "character": 2,
80
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L109"
81
+ }
82
+ ],
94
83
  "parameters": [
95
84
  {
96
- "id": 6,
85
+ "id": 11,
97
86
  "name": "errorService",
87
+ "variant": "param",
98
88
  "kind": 32768,
99
- "kindString": "Parameter",
100
89
  "flags": {},
101
90
  "type": {
102
91
  "type": "reference",
103
- "name": "SkyErrorModalService"
92
+ "target": {
93
+ "sourceFileName": "libs/components/errors/src/lib/modules/error/error-modal.service.ts",
94
+ "qualifiedName": "SkyErrorModalService"
95
+ },
96
+ "name": "SkyErrorModalService",
97
+ "package": "@skyux/errors"
104
98
  }
105
99
  },
106
100
  {
107
- "id": 7,
101
+ "id": 12,
108
102
  "name": "fileSizePipe",
103
+ "variant": "param",
109
104
  "kind": 32768,
110
- "kindString": "Parameter",
111
105
  "flags": {},
112
106
  "type": {
113
107
  "type": "reference",
114
- "name": "SkyFileSizePipe"
108
+ "target": {
109
+ "sourceFileName": "libs/components/forms/src/lib/modules/file-attachment/file-size.pipe.ts",
110
+ "qualifiedName": "SkyFileSizePipe"
111
+ },
112
+ "name": "SkyFileSizePipe",
113
+ "package": "@skyux/forms"
115
114
  }
116
115
  },
117
116
  {
118
- "id": 8,
117
+ "id": 13,
119
118
  "name": "resourcesService",
119
+ "variant": "param",
120
120
  "kind": 32768,
121
- "kindString": "Parameter",
122
121
  "flags": {},
123
122
  "type": {
124
123
  "type": "reference",
125
- "name": "SkyLibResourcesService"
124
+ "target": {
125
+ "sourceFileName": "libs/components/i18n/src/lib/modules/i18n/lib-resources.service.ts",
126
+ "qualifiedName": "SkyLibResourcesService"
127
+ },
128
+ "name": "SkyLibResourcesService",
129
+ "package": "@skyux/i18n"
126
130
  }
127
131
  }
128
132
  ],
129
133
  "type": {
130
134
  "type": "reference",
131
- "id": 3,
132
- "name": "SkyAvatarComponent"
135
+ "target": 8,
136
+ "name": "SkyAvatarComponent",
137
+ "package": "@skyux/avatar"
133
138
  }
134
139
  }
135
140
  ]
136
141
  },
137
142
  {
138
- "id": 23,
143
+ "id": 28,
139
144
  "name": "avatarChanged",
145
+ "variant": "declaration",
140
146
  "kind": 1024,
141
- "kindString": "Property",
142
147
  "flags": {
143
148
  "isPublic": true
144
149
  },
145
150
  "comment": {
146
- "shortText": "Emits a `SkyFileItem` object when the image is updated."
147
- },
148
- "decorators": [
149
- {
150
- "name": "Output",
151
- "type": {
152
- "type": "reference",
153
- "qualifiedName": "OutputDecorator",
154
- "package": "@angular/core",
155
- "name": "Output"
151
+ "summary": [
152
+ {
153
+ "kind": "text",
154
+ "text": "Emits a "
156
155
  },
157
- "arguments": {}
158
- }
159
- ],
156
+ {
157
+ "kind": "code",
158
+ "text": "`SkyFileItem`"
159
+ },
160
+ {
161
+ "kind": "text",
162
+ "text": " object when the image is updated."
163
+ }
164
+ ]
165
+ },
160
166
  "sources": [
161
167
  {
162
168
  "fileName": "projects/avatar/src/modules/avatar/avatar.component.ts",
163
169
  "line": 93,
164
- "character": 9
170
+ "character": 9,
171
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L93"
165
172
  }
166
173
  ],
167
174
  "type": {
168
175
  "type": "reference",
176
+ "target": {
177
+ "sourceFileName": "node_modules/@angular/core/index.d.ts",
178
+ "qualifiedName": "EventEmitter"
179
+ },
169
180
  "typeArguments": [
170
181
  {
171
182
  "type": "reference",
172
- "name": "SkyFileItem"
183
+ "target": {
184
+ "sourceFileName": "libs/components/forms/src/lib/modules/file-attachment/file-item.ts",
185
+ "qualifiedName": "SkyFileItem"
186
+ },
187
+ "name": "SkyFileItem",
188
+ "package": "@skyux/forms"
173
189
  }
174
190
  ],
175
- "qualifiedName": "EventEmitter",
176
- "package": "@angular/core",
177
- "name": "EventEmitter"
191
+ "name": "EventEmitter",
192
+ "package": "@angular/core"
178
193
  },
179
- "defaultValue": "..."
194
+ "defaultValue": "...",
195
+ "decorators": [
196
+ {
197
+ "name": "Output"
198
+ }
199
+ ]
180
200
  },
181
201
  {
182
- "id": 21,
202
+ "id": 26,
183
203
  "name": "maxFileSize",
204
+ "variant": "declaration",
184
205
  "kind": 1024,
185
- "kindString": "Property",
186
206
  "flags": {
187
207
  "isPublic": true
188
208
  },
189
209
  "comment": {
190
- "shortText": "The maximum file size for the image in bytes.",
191
- "tags": [
210
+ "summary": [
211
+ {
212
+ "kind": "text",
213
+ "text": "The maximum file size for the image in bytes."
214
+ }
215
+ ],
216
+ "blockTags": [
192
217
  {
193
- "tag": "default",
194
- "text": "500000 bytes\n"
218
+ "tag": "@default",
219
+ "content": [
220
+ {
221
+ "kind": "code",
222
+ "text": "```ts\n500000 bytes\n```"
223
+ }
224
+ ]
195
225
  }
196
226
  ]
197
227
  },
198
- "decorators": [
199
- {
200
- "name": "Input",
201
- "type": {
202
- "type": "reference",
203
- "qualifiedName": "InputDecorator",
204
- "package": "@angular/core",
205
- "name": "Input"
206
- },
207
- "arguments": {}
208
- }
209
- ],
210
228
  "sources": [
211
229
  {
212
230
  "fileName": "projects/avatar/src/modules/avatar/avatar.component.ts",
213
231
  "line": 79,
214
- "character": 9
232
+ "character": 9,
233
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L79"
215
234
  }
216
235
  ],
217
236
  "type": {
218
237
  "type": "intrinsic",
219
238
  "name": "number"
220
239
  },
221
- "defaultValue": "MAX_FILE_SIZE_DEFAULT"
240
+ "defaultValue": "MAX_FILE_SIZE_DEFAULT",
241
+ "decorators": [
242
+ {
243
+ "name": "Input"
244
+ }
245
+ ]
222
246
  },
223
247
  {
224
- "id": 22,
248
+ "id": 27,
225
249
  "name": "size",
250
+ "variant": "declaration",
226
251
  "kind": 1024,
227
- "kindString": "Property",
228
252
  "flags": {
229
253
  "isPublic": true
230
254
  },
231
255
  "comment": {
232
- "shortText": "The size of the avatar.\nAcceptable values are: `\"small\"`, `\"medium\"`, and `\"large\"`.",
233
- "tags": [
256
+ "summary": [
257
+ {
258
+ "kind": "text",
259
+ "text": "The size of the avatar.\nAcceptable values are: "
260
+ },
261
+ {
262
+ "kind": "code",
263
+ "text": "`\"small\"`"
264
+ },
265
+ {
266
+ "kind": "text",
267
+ "text": ", "
268
+ },
269
+ {
270
+ "kind": "code",
271
+ "text": "`\"medium\"`"
272
+ },
273
+ {
274
+ "kind": "text",
275
+ "text": ", and "
276
+ },
234
277
  {
235
- "tag": "default",
236
- "text": "\"large\"\n"
278
+ "kind": "code",
279
+ "text": "`\"large\"`"
280
+ },
281
+ {
282
+ "kind": "text",
283
+ "text": "."
284
+ }
285
+ ],
286
+ "blockTags": [
287
+ {
288
+ "tag": "@default",
289
+ "content": [
290
+ {
291
+ "kind": "code",
292
+ "text": "```ts\n\"large\"\n```"
293
+ }
294
+ ]
237
295
  }
238
296
  ]
239
297
  },
240
- "decorators": [
241
- {
242
- "name": "Input",
243
- "type": {
244
- "type": "reference",
245
- "qualifiedName": "InputDecorator",
246
- "package": "@angular/core",
247
- "name": "Input"
248
- },
249
- "arguments": {}
250
- }
251
- ],
252
298
  "sources": [
253
299
  {
254
300
  "fileName": "projects/avatar/src/modules/avatar/avatar.component.ts",
255
301
  "line": 87,
256
- "character": 9
302
+ "character": 9,
303
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L87"
257
304
  }
258
305
  ],
259
306
  "type": {
260
307
  "type": "reference",
261
- "id": 48,
262
- "name": "SkyAvatarSize"
263
- }
308
+ "target": 3,
309
+ "name": "SkyAvatarSize",
310
+ "package": "@skyux/avatar"
311
+ },
312
+ "decorators": [
313
+ {
314
+ "name": "Input"
315
+ }
316
+ ]
264
317
  },
265
318
  {
266
- "id": 9,
319
+ "id": 14,
267
320
  "name": "canChange",
321
+ "variant": "declaration",
268
322
  "kind": 262144,
269
- "kindString": "Accessor",
270
323
  "flags": {
271
324
  "isPublic": true
272
325
  },
273
- "decorators": [
274
- {
275
- "name": "Input",
276
- "type": {
277
- "type": "reference",
278
- "qualifiedName": "InputDecorator",
279
- "package": "@angular/core",
280
- "name": "Input"
281
- },
282
- "arguments": {}
283
- }
284
- ],
285
326
  "sources": [
286
327
  {
287
328
  "fileName": "projects/avatar/src/modules/avatar/avatar.component.ts",
288
329
  "line": 36,
289
- "character": 13
330
+ "character": 13,
331
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L36"
332
+ },
333
+ {
334
+ "fileName": "projects/avatar/src/modules/avatar/avatar.component.ts",
335
+ "line": 40,
336
+ "character": 13,
337
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L40"
290
338
  }
291
339
  ],
292
- "getSignature": [
293
- {
294
- "id": 10,
295
- "name": "canChange",
296
- "kind": 524288,
297
- "kindString": "Get signature",
298
- "flags": {},
299
- "comment": {
300
- "shortText": "Whether users can change the image. To select a different image,\nusers click the image or drag another image on top of it,\nmuch like the `sky-file-drop` component in the\n[file attachment module](https://developer.blackbaud.com/skyux/components/file-attachments/file-attachment).",
301
- "tags": [
302
- {
303
- "tag": "default",
304
- "text": "false\n"
305
- }
306
- ]
307
- },
308
- "type": {
309
- "type": "intrinsic",
310
- "name": "boolean"
340
+ "getSignature": {
341
+ "id": 15,
342
+ "name": "canChange",
343
+ "variant": "signature",
344
+ "kind": 524288,
345
+ "flags": {},
346
+ "sources": [
347
+ {
348
+ "fileName": "src/lib/modules/avatar/avatar.component.ts",
349
+ "line": 40,
350
+ "character": 2,
351
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L40"
311
352
  }
353
+ ],
354
+ "type": {
355
+ "type": "intrinsic",
356
+ "name": "boolean"
312
357
  }
313
- ],
314
- "setSignature": [
315
- {
316
- "id": 11,
317
- "name": "canChange",
318
- "kind": 1048576,
319
- "kindString": "Set signature",
320
- "flags": {},
321
- "comment": {
322
- "shortText": "Whether users can change the image. To select a different image,\nusers click the image or drag another image on top of it,\nmuch like the `sky-file-drop` component in the\n[file attachment module](https://developer.blackbaud.com/skyux/components/file-attachments/file-attachment).",
323
- "tags": [
324
- {
325
- "tag": "default",
326
- "text": "false\n"
327
- }
328
- ]
329
- },
330
- "parameters": [
358
+ },
359
+ "setSignature": {
360
+ "id": 16,
361
+ "name": "canChange",
362
+ "variant": "signature",
363
+ "kind": 1048576,
364
+ "flags": {},
365
+ "comment": {
366
+ "summary": [
331
367
  {
332
- "id": 12,
333
- "name": "value",
334
- "kind": 32768,
335
- "kindString": "Parameter",
336
- "flags": {},
337
- "type": {
338
- "type": "intrinsic",
339
- "name": "boolean"
340
- }
368
+ "kind": "text",
369
+ "text": "Whether users can change the image. To select a different image,\nusers click the image or drag another image on top of it,\nmuch like the "
370
+ },
371
+ {
372
+ "kind": "code",
373
+ "text": "`sky-file-drop`"
374
+ },
375
+ {
376
+ "kind": "text",
377
+ "text": " component in the\n[file attachment module](https://developer.blackbaud.com/skyux/components/file-attachments/file-attachment)."
341
378
  }
342
379
  ],
343
- "type": {
344
- "type": "intrinsic",
345
- "name": "void"
380
+ "blockTags": [
381
+ {
382
+ "tag": "@default",
383
+ "content": [
384
+ {
385
+ "kind": "code",
386
+ "text": "```ts\nfalse\n```"
387
+ }
388
+ ]
389
+ }
390
+ ]
391
+ },
392
+ "sources": [
393
+ {
394
+ "fileName": "src/lib/modules/avatar/avatar.component.ts",
395
+ "line": 35,
396
+ "character": 2,
397
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L35"
398
+ }
399
+ ],
400
+ "parameters": [
401
+ {
402
+ "id": 17,
403
+ "name": "value",
404
+ "variant": "param",
405
+ "kind": 32768,
406
+ "flags": {},
407
+ "type": {
408
+ "type": "intrinsic",
409
+ "name": "boolean"
410
+ }
346
411
  }
412
+ ],
413
+ "type": {
414
+ "type": "intrinsic",
415
+ "name": "void"
416
+ }
417
+ },
418
+ "decorators": [
419
+ {
420
+ "name": "Input"
347
421
  }
348
422
  ]
349
423
  },
350
424
  {
351
- "id": 13,
425
+ "id": 18,
352
426
  "name": "name",
427
+ "variant": "declaration",
353
428
  "kind": 262144,
354
- "kindString": "Accessor",
355
429
  "flags": {
356
430
  "isPublic": true
357
431
  },
358
- "decorators": [
359
- {
360
- "name": "Input",
361
- "type": {
362
- "type": "reference",
363
- "qualifiedName": "InputDecorator",
364
- "package": "@angular/core",
365
- "name": "Input"
366
- },
367
- "arguments": {}
368
- }
369
- ],
370
432
  "sources": [
371
433
  {
372
434
  "fileName": "projects/avatar/src/modules/avatar/avatar.component.ts",
373
435
  "line": 53,
374
- "character": 13
436
+ "character": 13,
437
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L53"
438
+ },
439
+ {
440
+ "fileName": "projects/avatar/src/modules/avatar/avatar.component.ts",
441
+ "line": 57,
442
+ "character": 13,
443
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L57"
375
444
  }
376
445
  ],
377
- "getSignature": [
378
- {
379
- "id": 14,
380
- "name": "name",
381
- "kind": 524288,
382
- "kindString": "Get signature",
383
- "flags": {},
384
- "comment": {
385
- "shortText": "The name of the record that the avatar represents.\nIf the `src` property does not specify an image, the component displays\ninitials from the first and last words in the name. To ensure\nthat the component extracts the correct initials, specify a name with no prefix\nor suffix, or just specify initials with a space between them. This property is\nnot required, but the component requires either the `name` or `src` property."
386
- },
387
- "type": {
388
- "type": "intrinsic",
389
- "name": "string"
446
+ "getSignature": {
447
+ "id": 19,
448
+ "name": "name",
449
+ "variant": "signature",
450
+ "kind": 524288,
451
+ "flags": {},
452
+ "sources": [
453
+ {
454
+ "fileName": "src/lib/modules/avatar/avatar.component.ts",
455
+ "line": 57,
456
+ "character": 2,
457
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L57"
390
458
  }
459
+ ],
460
+ "type": {
461
+ "type": "intrinsic",
462
+ "name": "string"
391
463
  }
392
- ],
393
- "setSignature": [
394
- {
395
- "id": 15,
396
- "name": "name",
397
- "kind": 1048576,
398
- "kindString": "Set signature",
399
- "flags": {},
400
- "comment": {
401
- "shortText": "The name of the record that the avatar represents.\nIf the `src` property does not specify an image, the component displays\ninitials from the first and last words in the name. To ensure\nthat the component extracts the correct initials, specify a name with no prefix\nor suffix, or just specify initials with a space between them. This property is\nnot required, but the component requires either the `name` or `src` property."
402
- },
403
- "parameters": [
464
+ },
465
+ "setSignature": {
466
+ "id": 20,
467
+ "name": "name",
468
+ "variant": "signature",
469
+ "kind": 1048576,
470
+ "flags": {},
471
+ "comment": {
472
+ "summary": [
404
473
  {
405
- "id": 16,
406
- "name": "value",
407
- "kind": 32768,
408
- "kindString": "Parameter",
409
- "flags": {},
410
- "type": {
411
- "type": "intrinsic",
412
- "name": "string"
413
- }
474
+ "kind": "text",
475
+ "text": "The name of the record that the avatar represents.\nIf the "
476
+ },
477
+ {
478
+ "kind": "code",
479
+ "text": "`src`"
480
+ },
481
+ {
482
+ "kind": "text",
483
+ "text": " property does not specify an image, the component displays\ninitials from the first and last words in the name. To ensure\nthat the component extracts the correct initials, specify a name with no prefix\nor suffix, or just specify initials with a space between them. This property is\nnot required, but the component requires either the "
484
+ },
485
+ {
486
+ "kind": "code",
487
+ "text": "`name`"
488
+ },
489
+ {
490
+ "kind": "text",
491
+ "text": " or "
492
+ },
493
+ {
494
+ "kind": "code",
495
+ "text": "`src`"
496
+ },
497
+ {
498
+ "kind": "text",
499
+ "text": " property."
414
500
  }
415
- ],
416
- "type": {
417
- "type": "intrinsic",
418
- "name": "void"
501
+ ]
502
+ },
503
+ "sources": [
504
+ {
505
+ "fileName": "src/lib/modules/avatar/avatar.component.ts",
506
+ "line": 52,
507
+ "character": 2,
508
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L52"
419
509
  }
510
+ ],
511
+ "parameters": [
512
+ {
513
+ "id": 21,
514
+ "name": "value",
515
+ "variant": "param",
516
+ "kind": 32768,
517
+ "flags": {},
518
+ "type": {
519
+ "type": "intrinsic",
520
+ "name": "string"
521
+ }
522
+ }
523
+ ],
524
+ "type": {
525
+ "type": "intrinsic",
526
+ "name": "void"
527
+ }
528
+ },
529
+ "decorators": [
530
+ {
531
+ "name": "Input"
420
532
  }
421
533
  ]
422
534
  },
423
535
  {
424
- "id": 17,
536
+ "id": 22,
425
537
  "name": "src",
538
+ "variant": "declaration",
426
539
  "kind": 262144,
427
- "kindString": "Accessor",
428
540
  "flags": {
429
541
  "isPublic": true
430
542
  },
431
- "decorators": [
432
- {
433
- "name": "Input",
434
- "type": {
435
- "type": "reference",
436
- "qualifiedName": "InputDecorator",
437
- "package": "@angular/core",
438
- "name": "Input"
439
- },
440
- "arguments": {}
441
- }
442
- ],
443
543
  "sources": [
444
544
  {
445
545
  "fileName": "projects/avatar/src/modules/avatar/avatar.component.ts",
446
546
  "line": 66,
447
- "character": 13
547
+ "character": 13,
548
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L66"
549
+ },
550
+ {
551
+ "fileName": "projects/avatar/src/modules/avatar/avatar.component.ts",
552
+ "line": 70,
553
+ "character": 13,
554
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L70"
448
555
  }
449
556
  ],
450
- "getSignature": [
451
- {
452
- "id": 18,
453
- "name": "src",
454
- "kind": 524288,
455
- "kindString": "Get signature",
456
- "flags": {},
457
- "comment": {
458
- "shortText": "The image to identify a record. This property is\nnot required, but the component requires either the `name` or `src` property."
459
- },
460
- "type": {
461
- "type": "reference",
462
- "id": 49,
463
- "name": "SkyAvatarSrc"
557
+ "getSignature": {
558
+ "id": 23,
559
+ "name": "src",
560
+ "variant": "signature",
561
+ "kind": 524288,
562
+ "flags": {},
563
+ "sources": [
564
+ {
565
+ "fileName": "src/lib/modules/avatar/avatar.component.ts",
566
+ "line": 70,
567
+ "character": 2,
568
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L70"
464
569
  }
570
+ ],
571
+ "type": {
572
+ "type": "reference",
573
+ "target": 4,
574
+ "name": "SkyAvatarSrc",
575
+ "package": "@skyux/avatar"
465
576
  }
466
- ],
467
- "setSignature": [
468
- {
469
- "id": 19,
470
- "name": "src",
471
- "kind": 1048576,
472
- "kindString": "Set signature",
473
- "flags": {},
474
- "comment": {
475
- "shortText": "The image to identify a record. This property is\nnot required, but the component requires either the `name` or `src` property."
476
- },
477
- "parameters": [
577
+ },
578
+ "setSignature": {
579
+ "id": 24,
580
+ "name": "src",
581
+ "variant": "signature",
582
+ "kind": 1048576,
583
+ "flags": {},
584
+ "comment": {
585
+ "summary": [
478
586
  {
479
- "id": 20,
480
- "name": "value",
481
- "kind": 32768,
482
- "kindString": "Parameter",
483
- "flags": {},
484
- "type": {
485
- "type": "reference",
486
- "id": 49,
487
- "name": "SkyAvatarSrc"
488
- }
587
+ "kind": "text",
588
+ "text": "The image to identify a record. This property is\nnot required, but the component requires either the "
589
+ },
590
+ {
591
+ "kind": "code",
592
+ "text": "`name`"
593
+ },
594
+ {
595
+ "kind": "text",
596
+ "text": " or "
597
+ },
598
+ {
599
+ "kind": "code",
600
+ "text": "`src`"
601
+ },
602
+ {
603
+ "kind": "text",
604
+ "text": " property."
489
605
  }
490
- ],
491
- "type": {
492
- "type": "intrinsic",
493
- "name": "void"
606
+ ]
607
+ },
608
+ "sources": [
609
+ {
610
+ "fileName": "src/lib/modules/avatar/avatar.component.ts",
611
+ "line": 65,
612
+ "character": 2,
613
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L65"
494
614
  }
615
+ ],
616
+ "parameters": [
617
+ {
618
+ "id": 25,
619
+ "name": "value",
620
+ "variant": "param",
621
+ "kind": 32768,
622
+ "flags": {},
623
+ "type": {
624
+ "type": "reference",
625
+ "target": 4,
626
+ "name": "SkyAvatarSrc",
627
+ "package": "@skyux/avatar"
628
+ }
629
+ }
630
+ ],
631
+ "type": {
632
+ "type": "intrinsic",
633
+ "name": "void"
634
+ }
635
+ },
636
+ "decorators": [
637
+ {
638
+ "name": "Input"
495
639
  }
496
640
  ]
497
641
  },
498
642
  {
499
- "id": 32,
643
+ "id": 37,
500
644
  "name": "photoDrop",
645
+ "variant": "declaration",
501
646
  "kind": 2048,
502
- "kindString": "Method",
503
647
  "flags": {
504
648
  "isPublic": true
505
649
  },
@@ -507,26 +651,40 @@
507
651
  {
508
652
  "fileName": "projects/avatar/src/modules/avatar/avatar.component.ts",
509
653
  "line": 124,
510
- "character": 9
654
+ "character": 9,
655
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L124"
511
656
  }
512
657
  ],
513
658
  "signatures": [
514
659
  {
515
- "id": 33,
660
+ "id": 38,
516
661
  "name": "photoDrop",
662
+ "variant": "signature",
517
663
  "kind": 4096,
518
- "kindString": "Call signature",
519
664
  "flags": {},
665
+ "sources": [
666
+ {
667
+ "fileName": "src/lib/modules/avatar/avatar.component.ts",
668
+ "line": 124,
669
+ "character": 2,
670
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L124"
671
+ }
672
+ ],
520
673
  "parameters": [
521
674
  {
522
- "id": 34,
675
+ "id": 39,
523
676
  "name": "result",
677
+ "variant": "param",
524
678
  "kind": 32768,
525
- "kindString": "Parameter",
526
679
  "flags": {},
527
680
  "type": {
528
681
  "type": "reference",
529
- "name": "SkyFileDropChange"
682
+ "target": {
683
+ "sourceFileName": "libs/components/forms/src/lib/modules/file-attachment/types/file-drop-change.ts",
684
+ "qualifiedName": "SkyFileDropChange"
685
+ },
686
+ "name": "SkyFileDropChange",
687
+ "package": "@skyux/forms"
530
688
  }
531
689
  }
532
690
  ],
@@ -535,40 +693,37 @@
535
693
  "name": "void"
536
694
  }
537
695
  }
538
- ]
696
+ ],
697
+ "decorators": []
539
698
  }
540
699
  ],
541
700
  "groups": [
542
701
  {
543
702
  "title": "Constructors",
544
- "kind": 512,
545
703
  "children": [
546
- 4
704
+ 9
547
705
  ]
548
706
  },
549
707
  {
550
708
  "title": "Properties",
551
- "kind": 1024,
552
709
  "children": [
553
- 23,
554
- 21,
555
- 22
710
+ 28,
711
+ 26,
712
+ 27
556
713
  ]
557
714
  },
558
715
  {
559
716
  "title": "Accessors",
560
- "kind": 262144,
561
717
  "children": [
562
- 9,
563
- 13,
564
- 17
718
+ 14,
719
+ 18,
720
+ 22
565
721
  ]
566
722
  },
567
723
  {
568
724
  "title": "Methods",
569
- "kind": 2048,
570
725
  "children": [
571
- 32
726
+ 37
572
727
  ]
573
728
  }
574
729
  ],
@@ -576,21 +731,31 @@
576
731
  {
577
732
  "fileName": "projects/avatar/src/modules/avatar/avatar.component.ts",
578
733
  "line": 27,
579
- "character": 13
734
+ "character": 13,
735
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar.component.ts#L27"
736
+ }
737
+ ],
738
+ "decorators": [
739
+ {
740
+ "name": "Component",
741
+ "arguments": {
742
+ "obj": "@Component({\n selector: 'sky-avatar',\n templateUrl: './avatar.component.html',\n styleUrls: ['./avatar.component.scss'],\n encapsulation: ViewEncapsulation.None,\n})"
743
+ }
580
744
  }
581
745
  ]
582
746
  },
583
747
  {
584
- "id": 48,
748
+ "id": 3,
585
749
  "name": "SkyAvatarSize",
750
+ "variant": "declaration",
586
751
  "kind": 4194304,
587
- "kindString": "Type alias",
588
752
  "flags": {},
589
753
  "sources": [
590
754
  {
591
755
  "fileName": "projects/avatar/src/modules/avatar/avatar-size.ts",
592
756
  "line": 1,
593
- "character": 12
757
+ "character": 12,
758
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar-size.ts#L1"
594
759
  }
595
760
  ],
596
761
  "type": {
@@ -612,16 +777,17 @@
612
777
  }
613
778
  },
614
779
  {
615
- "id": 49,
780
+ "id": 4,
616
781
  "name": "SkyAvatarSrc",
782
+ "variant": "declaration",
617
783
  "kind": 4194304,
618
- "kindString": "Type alias",
619
784
  "flags": {},
620
785
  "sources": [
621
786
  {
622
787
  "fileName": "projects/avatar/src/modules/avatar/avatar-src.ts",
623
788
  "line": 1,
624
- "character": 12
789
+ "character": 12,
790
+ "url": "https://github.com/blackbaud/skyux/blob/c621328/libs/components/avatar/src/lib/modules/avatar/avatar-src.ts#L1"
625
791
  }
626
792
  ],
627
793
  "type": {
@@ -633,15 +799,21 @@
633
799
  },
634
800
  {
635
801
  "type": "reference",
636
- "qualifiedName": "Blob",
637
- "package": "typescript",
638
- "name": "Blob"
802
+ "target": {
803
+ "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts",
804
+ "qualifiedName": "Blob"
805
+ },
806
+ "name": "Blob",
807
+ "package": "typescript"
639
808
  },
640
809
  {
641
810
  "type": "reference",
642
- "qualifiedName": "File",
643
- "package": "typescript",
644
- "name": "File"
811
+ "target": {
812
+ "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts",
813
+ "qualifiedName": "File"
814
+ },
815
+ "name": "File",
816
+ "package": "typescript"
645
817
  }
646
818
  ]
647
819
  }
@@ -650,19 +822,151 @@
650
822
  "groups": [
651
823
  {
652
824
  "title": "Modules",
653
- "kind": 2,
654
825
  "children": [
655
826
  1,
656
827
  2
657
828
  ]
658
829
  }
659
- ]
830
+ ],
831
+ "packageName": "@skyux/avatar",
832
+ "readme": [
833
+ {
834
+ "kind": "text",
835
+ "text": "# avatar\n\nThis library was generated with [Nx](https://nx.dev).\n\n## Running unit tests\n\nRun "
836
+ },
837
+ {
838
+ "kind": "code",
839
+ "text": "`nx test avatar`"
840
+ },
841
+ {
842
+ "kind": "text",
843
+ "text": " to execute the unit tests."
844
+ }
845
+ ],
846
+ "symbolIdMap": {
847
+ "1": {
848
+ "sourceFileName": "libs/components/avatar/src/index.ts",
849
+ "qualifiedName": ""
850
+ },
851
+ "2": {
852
+ "sourceFileName": "libs/components/avatar/testing/src/public-api.ts",
853
+ "qualifiedName": ""
854
+ },
855
+ "3": {
856
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar-size.ts",
857
+ "qualifiedName": "SkyAvatarSize"
858
+ },
859
+ "4": {
860
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar-src.ts",
861
+ "qualifiedName": "SkyAvatarSrc"
862
+ },
863
+ "5": {
864
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.module.ts",
865
+ "qualifiedName": "SkyAvatarModule"
866
+ },
867
+ "8": {
868
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
869
+ "qualifiedName": "SkyAvatarComponent"
870
+ },
871
+ "9": {
872
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
873
+ "qualifiedName": "SkyAvatarComponent.__constructor"
874
+ },
875
+ "10": {
876
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
877
+ "qualifiedName": "SkyAvatarComponent"
878
+ },
879
+ "11": {
880
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
881
+ "qualifiedName": "errorService"
882
+ },
883
+ "12": {
884
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
885
+ "qualifiedName": "fileSizePipe"
886
+ },
887
+ "13": {
888
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
889
+ "qualifiedName": "resourcesService"
890
+ },
891
+ "14": {
892
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
893
+ "qualifiedName": "SkyAvatarComponent.canChange"
894
+ },
895
+ "15": {
896
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
897
+ "qualifiedName": "SkyAvatarComponent.canChange"
898
+ },
899
+ "16": {
900
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
901
+ "qualifiedName": "SkyAvatarComponent.canChange"
902
+ },
903
+ "17": {
904
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
905
+ "qualifiedName": "value"
906
+ },
907
+ "18": {
908
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
909
+ "qualifiedName": "SkyAvatarComponent.name"
910
+ },
911
+ "19": {
912
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
913
+ "qualifiedName": "SkyAvatarComponent.name"
914
+ },
915
+ "20": {
916
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
917
+ "qualifiedName": "SkyAvatarComponent.name"
918
+ },
919
+ "21": {
920
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
921
+ "qualifiedName": "value"
922
+ },
923
+ "22": {
924
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
925
+ "qualifiedName": "SkyAvatarComponent.src"
926
+ },
927
+ "23": {
928
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
929
+ "qualifiedName": "SkyAvatarComponent.src"
930
+ },
931
+ "24": {
932
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
933
+ "qualifiedName": "SkyAvatarComponent.src"
934
+ },
935
+ "25": {
936
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
937
+ "qualifiedName": "value"
938
+ },
939
+ "26": {
940
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
941
+ "qualifiedName": "SkyAvatarComponent.maxFileSize"
942
+ },
943
+ "27": {
944
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
945
+ "qualifiedName": "SkyAvatarComponent.size"
946
+ },
947
+ "28": {
948
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
949
+ "qualifiedName": "SkyAvatarComponent.avatarChanged"
950
+ },
951
+ "37": {
952
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
953
+ "qualifiedName": "SkyAvatarComponent.photoDrop"
954
+ },
955
+ "38": {
956
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
957
+ "qualifiedName": "SkyAvatarComponent.photoDrop"
958
+ },
959
+ "39": {
960
+ "sourceFileName": "libs/components/avatar/src/lib/modules/avatar/avatar.component.ts",
961
+ "qualifiedName": "result"
962
+ }
963
+ }
660
964
  },
661
965
  "codeExamples": [
662
966
  {
663
- "fileName": "avatar-demo.component.html",
664
- "filePath": "/projects/avatar/documentation/code-examples/avatar/avatar-demo.component.html",
665
- "rawContents": "<sky-avatar\n [canChange]=\"true\"\n [name]=\"name\"\n [src]=\"avatarUrl\"\n (avatarChanged)=\"updateSrc($event)\"\n>\n</sky-avatar>\n"
967
+ "fileName": "avatar-demo.module.ts",
968
+ "filePath": "/projects/avatar/documentation/code-examples/avatar/avatar-demo.module.ts",
969
+ "rawContents": "import { NgModule } from '@angular/core';\nimport { SkyAvatarModule } from '@skyux/avatar';\n\nimport { AvatarDemoComponent } from './avatar-demo.component';\n\n@NgModule({\n declarations: [AvatarDemoComponent],\n imports: [SkyAvatarModule],\n exports: [AvatarDemoComponent],\n})\nexport class AvatarDemoModule {}\n"
666
970
  },
667
971
  {
668
972
  "fileName": "avatar-demo.component.ts",
@@ -670,9 +974,9 @@
670
974
  "rawContents": "import { Component } from '@angular/core';\nimport { SkyFileItem } from '@skyux/forms';\n\n@Component({\n selector: 'app-avatar-demo',\n templateUrl: './avatar-demo.component.html',\n})\nexport class AvatarDemoComponent {\n public avatarUrl: string | File = 'https://imgur.com/tBiGElW.png';\n\n public name = 'Robert C. Hernandez';\n\n public updateSrc(fileItem: SkyFileItem): void {\n /*\n This is where you might upload the new avatar,\n but for this demo we'll just update it locally.\n */\n if (fileItem) {\n this.avatarUrl = fileItem.file;\n }\n }\n}\n"
671
975
  },
672
976
  {
673
- "fileName": "avatar-demo.module.ts",
674
- "filePath": "/projects/avatar/documentation/code-examples/avatar/avatar-demo.module.ts",
675
- "rawContents": "import { NgModule } from '@angular/core';\nimport { SkyAvatarModule } from '@skyux/avatar';\n\nimport { AvatarDemoComponent } from './avatar-demo.component';\n\n@NgModule({\n declarations: [AvatarDemoComponent],\n imports: [SkyAvatarModule],\n exports: [AvatarDemoComponent],\n})\nexport class AvatarDemoModule {}\n"
977
+ "fileName": "avatar-demo.component.html",
978
+ "filePath": "/projects/avatar/documentation/code-examples/avatar/avatar-demo.component.html",
979
+ "rawContents": "<sky-avatar\n [canChange]=\"true\"\n [name]=\"name\"\n [src]=\"avatarUrl\"\n (avatarChanged)=\"updateSrc($event)\"\n>\n</sky-avatar>\n"
676
980
  }
677
981
  ]
678
982
  }