@momentum-design/components 0.16.9 → 0.16.11
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/browser/index.js +3 -0
- package/dist/browser/index.js.map +2 -2
- package/dist/components/labelandhelper/index.d.ts +9 -0
- package/dist/components/labelandhelper/index.js +6 -0
- package/dist/components/labelandhelper/labelandhelper.component.d.ts +72 -0
- package/dist/components/labelandhelper/labelandhelper.component.js +137 -0
- package/dist/components/labelandhelper/labelandhelper.constants.d.ts +19 -0
- package/dist/components/labelandhelper/labelandhelper.constants.js +21 -0
- package/dist/components/labelandhelper/labelandhelper.styles.d.ts +2 -0
- package/dist/components/labelandhelper/labelandhelper.styles.js +48 -0
- package/dist/components/labelandhelper/labelandhelper.types.d.ts +4 -0
- package/dist/components/labelandhelper/labelandhelper.types.js +1 -0
- package/dist/components/labelandhelper/labelandhelper.utils.d.ts +4 -0
- package/dist/components/labelandhelper/labelandhelper.utils.js +12 -0
- package/dist/components/text/fonts.styles.js +3 -0
- package/dist/custom-elements.json +906 -578
- package/dist/react/index.d.ts +2 -1
- package/dist/react/index.js +2 -1
- package/dist/react/labelandhelper/index.d.ts +11 -0
- package/dist/react/labelandhelper/index.js +20 -0
- package/dist/utils/mixins/NameMixin.d.ts +6 -0
- package/dist/utils/mixins/{LabelMixin.js → NameMixin.js} +6 -16
- package/dist/utils/mixins/ReadonlyMixin.d.ts +6 -0
- package/dist/utils/mixins/ReadonlyMixin.js +29 -0
- package/dist/utils/mixins/RequiredMixin.d.ts +6 -0
- package/dist/utils/mixins/RequiredMixin.js +29 -0
- package/dist/utils/mixins/ValueMixin.d.ts +6 -0
- package/dist/utils/mixins/ValueMixin.js +28 -0
- package/package.json +3 -2
- package/dist/utils/mixins/LabelMixin.d.ts +0 -7
@@ -244,798 +244,798 @@
|
|
244
244
|
},
|
245
245
|
{
|
246
246
|
"kind": "javascript-module",
|
247
|
-
"path": "components/
|
247
|
+
"path": "components/avatarbutton/avatarbutton.component.js",
|
248
248
|
"declarations": [
|
249
249
|
{
|
250
250
|
"kind": "class",
|
251
|
-
"description": "The `mdc-
|
252
|
-
"name": "
|
251
|
+
"description": "The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n\nThis component is made by extending `buttonsimple` class.\nThe button component acts as a wrapper for the avatar component.",
|
252
|
+
"name": "AvatarButton",
|
253
253
|
"members": [
|
254
|
+
{
|
255
|
+
"kind": "field",
|
256
|
+
"name": "ariaLabel",
|
257
|
+
"type": {
|
258
|
+
"text": "string | null"
|
259
|
+
},
|
260
|
+
"default": "null",
|
261
|
+
"description": "Aria-label attribute to be set for accessibility",
|
262
|
+
"attribute": "aria-label"
|
263
|
+
},
|
264
|
+
{
|
265
|
+
"kind": "method",
|
266
|
+
"name": "setSize",
|
267
|
+
"privacy": "private",
|
268
|
+
"parameters": [
|
269
|
+
{
|
270
|
+
"name": "size",
|
271
|
+
"type": {
|
272
|
+
"text": "AvatarSize"
|
273
|
+
}
|
274
|
+
}
|
275
|
+
]
|
276
|
+
},
|
277
|
+
{
|
278
|
+
"kind": "field",
|
279
|
+
"name": "active",
|
280
|
+
"type": {
|
281
|
+
"text": "boolean"
|
282
|
+
},
|
283
|
+
"default": "undefined as unknown",
|
284
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
|
285
|
+
"attribute": "active",
|
286
|
+
"inheritedFrom": {
|
287
|
+
"name": "Buttonsimple",
|
288
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
289
|
+
}
|
290
|
+
},
|
291
|
+
{
|
292
|
+
"kind": "field",
|
293
|
+
"name": "disabled",
|
294
|
+
"type": {
|
295
|
+
"text": "boolean"
|
296
|
+
},
|
297
|
+
"default": "undefined as unknown",
|
298
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
299
|
+
"attribute": "disabled",
|
300
|
+
"reflects": true,
|
301
|
+
"inheritedFrom": {
|
302
|
+
"name": "DisabledMixin",
|
303
|
+
"module": "utils/mixins/DisabledMixin.js"
|
304
|
+
}
|
305
|
+
},
|
306
|
+
{
|
307
|
+
"kind": "field",
|
308
|
+
"name": "softDisabled",
|
309
|
+
"type": {
|
310
|
+
"text": "boolean"
|
311
|
+
},
|
312
|
+
"default": "undefined as unknown",
|
313
|
+
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
314
|
+
"attribute": "soft-disabled",
|
315
|
+
"inheritedFrom": {
|
316
|
+
"name": "Buttonsimple",
|
317
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
318
|
+
}
|
319
|
+
},
|
320
|
+
{
|
321
|
+
"kind": "field",
|
322
|
+
"name": "role",
|
323
|
+
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
324
|
+
"default": "'button'",
|
325
|
+
"attribute": "role",
|
326
|
+
"reflects": true,
|
327
|
+
"type": {
|
328
|
+
"text": "string"
|
329
|
+
},
|
330
|
+
"inheritedFrom": {
|
331
|
+
"name": "Buttonsimple",
|
332
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
333
|
+
}
|
334
|
+
},
|
254
335
|
{
|
255
336
|
"kind": "field",
|
256
337
|
"name": "type",
|
257
338
|
"type": {
|
258
|
-
"text": "
|
339
|
+
"text": "ButtonType"
|
259
340
|
},
|
260
|
-
"description": "
|
341
|
+
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
342
|
+
"default": "button",
|
261
343
|
"attribute": "type",
|
262
|
-
"reflects": true
|
344
|
+
"reflects": true,
|
345
|
+
"inheritedFrom": {
|
346
|
+
"name": "Buttonsimple",
|
347
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
348
|
+
}
|
263
349
|
},
|
264
350
|
{
|
265
351
|
"kind": "field",
|
266
|
-
"name": "
|
352
|
+
"name": "src",
|
267
353
|
"type": {
|
268
|
-
"text": "
|
354
|
+
"text": "string | undefined"
|
269
355
|
},
|
270
|
-
"description": "
|
271
|
-
"attribute": "
|
356
|
+
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
357
|
+
"attribute": "src",
|
358
|
+
"inheritedFrom": {
|
359
|
+
"name": "AvatarComponentMixin",
|
360
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
361
|
+
}
|
272
362
|
},
|
273
363
|
{
|
274
364
|
"kind": "field",
|
275
|
-
"name": "
|
365
|
+
"name": "initials",
|
276
366
|
"type": {
|
277
|
-
"text": "
|
367
|
+
"text": "string | undefined"
|
278
368
|
},
|
279
|
-
"description": "
|
280
|
-
"
|
281
|
-
"
|
282
|
-
|
369
|
+
"description": "The initials to be displayed for the avatar.",
|
370
|
+
"attribute": "initials",
|
371
|
+
"inheritedFrom": {
|
372
|
+
"name": "AvatarComponentMixin",
|
373
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
374
|
+
}
|
283
375
|
},
|
284
376
|
{
|
285
377
|
"kind": "field",
|
286
|
-
"name": "
|
378
|
+
"name": "presence",
|
287
379
|
"type": {
|
288
|
-
"text": "
|
380
|
+
"text": "PresenceType | undefined"
|
289
381
|
},
|
290
|
-
"description": "
|
291
|
-
"attribute": "
|
382
|
+
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
383
|
+
"attribute": "presence",
|
384
|
+
"inheritedFrom": {
|
385
|
+
"name": "AvatarComponentMixin",
|
386
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
387
|
+
}
|
292
388
|
},
|
293
389
|
{
|
294
390
|
"kind": "field",
|
295
|
-
"name": "
|
391
|
+
"name": "size",
|
296
392
|
"type": {
|
297
|
-
"text": "
|
393
|
+
"text": "ButtonSize"
|
298
394
|
},
|
299
|
-
"description": "
|
300
|
-
"default": "
|
301
|
-
"attribute": "
|
302
|
-
"reflects": true
|
395
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
396
|
+
"default": "32",
|
397
|
+
"attribute": "size",
|
398
|
+
"reflects": true,
|
399
|
+
"inheritedFrom": {
|
400
|
+
"name": "Buttonsimple",
|
401
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
402
|
+
}
|
303
403
|
},
|
304
404
|
{
|
305
405
|
"kind": "field",
|
306
|
-
"name": "
|
406
|
+
"name": "iconName",
|
407
|
+
"type": {
|
408
|
+
"text": "IconNames | undefined"
|
409
|
+
},
|
410
|
+
"description": "Name of the icon to be displayed inside the Avatar.\nMust be a valid icon name.",
|
411
|
+
"attribute": "icon-name",
|
412
|
+
"inheritedFrom": {
|
413
|
+
"name": "AvatarComponentMixin",
|
414
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
415
|
+
}
|
416
|
+
},
|
417
|
+
{
|
418
|
+
"kind": "field",
|
419
|
+
"name": "counter",
|
420
|
+
"type": {
|
421
|
+
"text": "number | undefined"
|
422
|
+
},
|
423
|
+
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
424
|
+
"attribute": "counter",
|
425
|
+
"inheritedFrom": {
|
426
|
+
"name": "AvatarComponentMixin",
|
427
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
428
|
+
}
|
429
|
+
},
|
430
|
+
{
|
431
|
+
"kind": "field",
|
432
|
+
"name": "isTyping",
|
307
433
|
"type": {
|
308
434
|
"text": "boolean"
|
309
435
|
},
|
310
436
|
"default": "false",
|
311
|
-
"description": "
|
312
|
-
"attribute": "
|
437
|
+
"description": "Represents the typing indicator when the user is typing.",
|
438
|
+
"attribute": "is-typing",
|
439
|
+
"inheritedFrom": {
|
440
|
+
"name": "AvatarComponentMixin",
|
441
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
442
|
+
}
|
313
443
|
},
|
314
444
|
{
|
315
445
|
"kind": "field",
|
316
|
-
"name": "
|
446
|
+
"name": "tabIndex",
|
317
447
|
"type": {
|
318
|
-
"text": "
|
448
|
+
"text": "number"
|
319
449
|
},
|
320
|
-
"default": "
|
321
|
-
"description": "
|
322
|
-
"attribute": "
|
450
|
+
"default": "0",
|
451
|
+
"description": "This property specifies the tab order of the element.",
|
452
|
+
"attribute": "tabIndex",
|
453
|
+
"reflects": true,
|
454
|
+
"inheritedFrom": {
|
455
|
+
"name": "TabIndexMixin",
|
456
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
457
|
+
}
|
323
458
|
},
|
324
459
|
{
|
325
460
|
"kind": "method",
|
326
|
-
"name": "
|
461
|
+
"name": "executeAction",
|
462
|
+
"privacy": "private",
|
463
|
+
"inheritedFrom": {
|
464
|
+
"name": "Buttonsimple",
|
465
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
466
|
+
}
|
467
|
+
},
|
468
|
+
{
|
469
|
+
"kind": "method",
|
470
|
+
"name": "setAriaPressed",
|
327
471
|
"privacy": "private",
|
328
|
-
"return": {
|
329
|
-
"type": {
|
330
|
-
"text": ""
|
331
|
-
}
|
332
|
-
},
|
333
472
|
"parameters": [
|
334
473
|
{
|
335
|
-
"name": "
|
474
|
+
"name": "element",
|
336
475
|
"type": {
|
337
|
-
"text": "
|
476
|
+
"text": "HTMLElement"
|
338
477
|
},
|
339
|
-
"description": "
|
478
|
+
"description": "The target element."
|
340
479
|
},
|
341
480
|
{
|
342
|
-
"name": "
|
343
|
-
"optional": true,
|
481
|
+
"name": "active",
|
344
482
|
"type": {
|
345
|
-
"text": "
|
483
|
+
"text": "boolean"
|
346
484
|
},
|
347
|
-
"description": "
|
485
|
+
"description": "The active state."
|
348
486
|
}
|
349
487
|
],
|
350
|
-
"description": "
|
488
|
+
"description": "Sets the aria-pressed attribute based on the active state.",
|
489
|
+
"inheritedFrom": {
|
490
|
+
"name": "Buttonsimple",
|
491
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
492
|
+
}
|
351
493
|
},
|
352
494
|
{
|
353
495
|
"kind": "method",
|
354
|
-
"name": "
|
496
|
+
"name": "setSoftDisabled",
|
355
497
|
"privacy": "private",
|
356
|
-
"return": {
|
357
|
-
"type": {
|
358
|
-
"text": ""
|
359
|
-
}
|
360
|
-
},
|
361
498
|
"parameters": [
|
362
499
|
{
|
363
|
-
"name": "
|
500
|
+
"name": "element",
|
364
501
|
"type": {
|
365
|
-
"text": "
|
502
|
+
"text": "HTMLElement"
|
366
503
|
},
|
367
|
-
"description": "
|
504
|
+
"description": "The button element."
|
368
505
|
},
|
369
506
|
{
|
370
|
-
"name": "
|
507
|
+
"name": "softDisabled",
|
371
508
|
"type": {
|
372
|
-
"text": "
|
509
|
+
"text": "boolean"
|
373
510
|
},
|
374
|
-
"description": "
|
511
|
+
"description": "The soft-disabled state."
|
375
512
|
}
|
376
513
|
],
|
377
|
-
"description": "
|
514
|
+
"description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
|
515
|
+
"inheritedFrom": {
|
516
|
+
"name": "Buttonsimple",
|
517
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
518
|
+
}
|
378
519
|
},
|
379
520
|
{
|
380
521
|
"kind": "method",
|
381
|
-
"name": "
|
522
|
+
"name": "setDisabled",
|
382
523
|
"privacy": "private",
|
383
|
-
"
|
384
|
-
|
385
|
-
"
|
524
|
+
"parameters": [
|
525
|
+
{
|
526
|
+
"name": "element",
|
527
|
+
"type": {
|
528
|
+
"text": "HTMLElement"
|
529
|
+
},
|
530
|
+
"description": "The button element."
|
531
|
+
},
|
532
|
+
{
|
533
|
+
"name": "disabled",
|
534
|
+
"type": {
|
535
|
+
"text": "boolean"
|
536
|
+
},
|
537
|
+
"description": "The disabled state."
|
386
538
|
}
|
387
|
-
|
388
|
-
"description": "
|
539
|
+
],
|
540
|
+
"description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
|
541
|
+
"inheritedFrom": {
|
542
|
+
"name": "Buttonsimple",
|
543
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
544
|
+
}
|
389
545
|
},
|
390
546
|
{
|
391
547
|
"kind": "method",
|
392
|
-
"name": "
|
548
|
+
"name": "triggerClickEvent",
|
393
549
|
"privacy": "private",
|
394
|
-
"
|
395
|
-
"
|
396
|
-
|
397
|
-
|
398
|
-
},
|
399
|
-
"description": "Method to generate the badge text and counter template."
|
550
|
+
"inheritedFrom": {
|
551
|
+
"name": "Buttonsimple",
|
552
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
553
|
+
}
|
400
554
|
},
|
401
555
|
{
|
402
556
|
"kind": "method",
|
403
|
-
"name": "
|
557
|
+
"name": "handleKeyDown",
|
404
558
|
"privacy": "private",
|
405
|
-
"
|
406
|
-
|
407
|
-
"
|
559
|
+
"parameters": [
|
560
|
+
{
|
561
|
+
"name": "event",
|
562
|
+
"type": {
|
563
|
+
"text": "KeyboardEvent"
|
564
|
+
},
|
565
|
+
"description": "The keyboard event."
|
408
566
|
}
|
409
|
-
|
410
|
-
"description": "
|
567
|
+
],
|
568
|
+
"description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.",
|
569
|
+
"inheritedFrom": {
|
570
|
+
"name": "Buttonsimple",
|
571
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
572
|
+
}
|
411
573
|
},
|
412
574
|
{
|
413
575
|
"kind": "method",
|
414
|
-
"name": "
|
576
|
+
"name": "handleKeyUp",
|
415
577
|
"privacy": "private",
|
416
|
-
"
|
417
|
-
|
418
|
-
"
|
578
|
+
"parameters": [
|
579
|
+
{
|
580
|
+
"name": "event",
|
581
|
+
"type": {
|
582
|
+
"text": "KeyboardEvent"
|
583
|
+
},
|
584
|
+
"description": "The keyboard event."
|
419
585
|
}
|
420
|
-
|
421
|
-
"description": "
|
586
|
+
],
|
587
|
+
"description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
|
588
|
+
"inheritedFrom": {
|
589
|
+
"name": "Buttonsimple",
|
590
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
591
|
+
}
|
422
592
|
}
|
423
593
|
],
|
424
594
|
"attributes": [
|
425
595
|
{
|
426
|
-
"name": "
|
596
|
+
"name": "aria-label",
|
427
597
|
"type": {
|
428
|
-
"text": "
|
598
|
+
"text": "string | null"
|
429
599
|
},
|
430
|
-
"
|
431
|
-
"
|
600
|
+
"default": "null",
|
601
|
+
"description": "Aria-label attribute to be set for accessibility",
|
602
|
+
"fieldName": "ariaLabel"
|
603
|
+
},
|
604
|
+
{
|
605
|
+
"name": "src",
|
606
|
+
"type": {
|
607
|
+
"text": "string | undefined"
|
608
|
+
},
|
609
|
+
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
610
|
+
"fieldName": "src",
|
611
|
+
"inheritedFrom": {
|
612
|
+
"name": "AvatarComponentMixin",
|
613
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
614
|
+
}
|
615
|
+
},
|
616
|
+
{
|
617
|
+
"name": "initials",
|
618
|
+
"type": {
|
619
|
+
"text": "string | undefined"
|
620
|
+
},
|
621
|
+
"description": "The initials to be displayed for the avatar.",
|
622
|
+
"fieldName": "initials",
|
623
|
+
"inheritedFrom": {
|
624
|
+
"name": "AvatarComponentMixin",
|
625
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
626
|
+
}
|
432
627
|
},
|
433
628
|
{
|
434
|
-
"name": "
|
629
|
+
"name": "presence",
|
435
630
|
"type": {
|
436
|
-
"text": "
|
631
|
+
"text": "PresenceType | undefined"
|
437
632
|
},
|
438
|
-
"description": "
|
439
|
-
"fieldName": "
|
633
|
+
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
634
|
+
"fieldName": "presence",
|
635
|
+
"inheritedFrom": {
|
636
|
+
"name": "AvatarComponentMixin",
|
637
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
638
|
+
}
|
440
639
|
},
|
441
640
|
{
|
442
|
-
"name": "
|
641
|
+
"name": "size",
|
443
642
|
"type": {
|
444
|
-
"text": "
|
643
|
+
"text": "ButtonSize"
|
445
644
|
},
|
446
|
-
"description": "
|
447
|
-
"default": "
|
448
|
-
"fieldName": "
|
645
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
646
|
+
"default": "32",
|
647
|
+
"fieldName": "size",
|
648
|
+
"inheritedFrom": {
|
649
|
+
"name": "Buttonsimple",
|
650
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
651
|
+
}
|
449
652
|
},
|
450
653
|
{
|
451
|
-
"name": "
|
654
|
+
"name": "icon-name",
|
452
655
|
"type": {
|
453
|
-
"text": "
|
656
|
+
"text": "IconNames | undefined"
|
454
657
|
},
|
455
|
-
"description": "
|
456
|
-
"fieldName": "
|
658
|
+
"description": "Name of the icon to be displayed inside the Avatar.\nMust be a valid icon name.",
|
659
|
+
"fieldName": "iconName",
|
660
|
+
"inheritedFrom": {
|
661
|
+
"name": "AvatarComponentMixin",
|
662
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
663
|
+
}
|
457
664
|
},
|
458
665
|
{
|
459
|
-
"name": "
|
666
|
+
"name": "counter",
|
460
667
|
"type": {
|
461
|
-
"text": "number"
|
668
|
+
"text": "number | undefined"
|
462
669
|
},
|
463
|
-
"description": "The
|
464
|
-
"
|
465
|
-
"
|
670
|
+
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
671
|
+
"fieldName": "counter",
|
672
|
+
"inheritedFrom": {
|
673
|
+
"name": "AvatarComponentMixin",
|
674
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
675
|
+
}
|
466
676
|
},
|
467
677
|
{
|
468
|
-
"name": "
|
678
|
+
"name": "is-typing",
|
469
679
|
"type": {
|
470
680
|
"text": "boolean"
|
471
681
|
},
|
472
682
|
"default": "false",
|
473
|
-
"description": "
|
474
|
-
"fieldName": "
|
683
|
+
"description": "Represents the typing indicator when the user is typing.",
|
684
|
+
"fieldName": "isTyping",
|
685
|
+
"inheritedFrom": {
|
686
|
+
"name": "AvatarComponentMixin",
|
687
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
688
|
+
}
|
475
689
|
},
|
476
690
|
{
|
477
|
-
"name": "
|
478
|
-
"type": {
|
479
|
-
"text": "string | null"
|
480
|
-
},
|
481
|
-
"default": "null",
|
482
|
-
"description": "Aria-label attribute to be set for accessibility",
|
483
|
-
"fieldName": "ariaLabel"
|
484
|
-
}
|
485
|
-
],
|
486
|
-
"superclass": {
|
487
|
-
"name": "Component",
|
488
|
-
"module": "/src/models"
|
489
|
-
},
|
490
|
-
"tagName": "mdc-badge",
|
491
|
-
"jsDoc": "/**\n * The `mdc-badge` component is a versatile UI element used to\n * display dot, icons, counters, success, warning and error type badge.\n *\n * Supported badge types:\n * - `dot`: Displays a dot notification badge with a blue color.\n * - `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n * - `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\n * it shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n * - `success`: Displays a success badge with a check circle icon and green color.\n * - `warning`: Displays a warning badge with a warning icon and yellow color.\n * - `error`: Displays a error badge with a error legacy icon and red color.\n *\n * For `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n *\n * For the `counter` type, the `mdc-text` component is used to render the counter value.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-badge\n */",
|
492
|
-
"customElement": true
|
493
|
-
}
|
494
|
-
],
|
495
|
-
"exports": [
|
496
|
-
{
|
497
|
-
"kind": "js",
|
498
|
-
"name": "default",
|
499
|
-
"declaration": {
|
500
|
-
"name": "Badge",
|
501
|
-
"module": "components/badge/badge.component.js"
|
502
|
-
}
|
503
|
-
}
|
504
|
-
]
|
505
|
-
},
|
506
|
-
{
|
507
|
-
"kind": "javascript-module",
|
508
|
-
"path": "components/avatarbutton/avatarbutton.component.js",
|
509
|
-
"declarations": [
|
510
|
-
{
|
511
|
-
"kind": "class",
|
512
|
-
"description": "The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n\nThis component is made by extending `buttonsimple` class.\nThe button component acts as a wrapper for the avatar component.",
|
513
|
-
"name": "AvatarButton",
|
514
|
-
"members": [
|
515
|
-
{
|
516
|
-
"kind": "field",
|
517
|
-
"name": "ariaLabel",
|
691
|
+
"name": "tabIndex",
|
518
692
|
"type": {
|
519
|
-
"text": "
|
693
|
+
"text": "number"
|
520
694
|
},
|
521
|
-
"default": "
|
522
|
-
"description": "
|
523
|
-
"
|
524
|
-
|
525
|
-
|
526
|
-
|
527
|
-
|
528
|
-
"privacy": "private",
|
529
|
-
"parameters": [
|
530
|
-
{
|
531
|
-
"name": "size",
|
532
|
-
"type": {
|
533
|
-
"text": "AvatarSize"
|
534
|
-
}
|
535
|
-
}
|
536
|
-
]
|
695
|
+
"default": "0",
|
696
|
+
"description": "This property specifies the tab order of the element.",
|
697
|
+
"fieldName": "tabIndex",
|
698
|
+
"inheritedFrom": {
|
699
|
+
"name": "TabIndexMixin",
|
700
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
701
|
+
}
|
537
702
|
},
|
538
703
|
{
|
539
|
-
"
|
540
|
-
"name": "active",
|
704
|
+
"name": "disabled",
|
541
705
|
"type": {
|
542
706
|
"text": "boolean"
|
543
707
|
},
|
544
|
-
"default": "
|
545
|
-
"description": "
|
546
|
-
"
|
708
|
+
"default": "false",
|
709
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
710
|
+
"fieldName": "disabled",
|
547
711
|
"inheritedFrom": {
|
548
|
-
"name": "
|
549
|
-
"module": "
|
712
|
+
"name": "DisabledMixin",
|
713
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
550
714
|
}
|
551
715
|
},
|
552
716
|
{
|
553
|
-
"
|
554
|
-
"name": "disabled",
|
717
|
+
"name": "active",
|
555
718
|
"type": {
|
556
719
|
"text": "boolean"
|
557
720
|
},
|
558
|
-
"default": "
|
559
|
-
"description": "
|
560
|
-
"
|
561
|
-
"reflects": true,
|
721
|
+
"default": "false",
|
722
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
|
723
|
+
"fieldName": "active",
|
562
724
|
"inheritedFrom": {
|
563
|
-
"name": "
|
564
|
-
"module": "
|
725
|
+
"name": "Buttonsimple",
|
726
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
565
727
|
}
|
566
728
|
},
|
567
729
|
{
|
568
|
-
"
|
569
|
-
"name": "softDisabled",
|
730
|
+
"name": "soft-disabled",
|
570
731
|
"type": {
|
571
732
|
"text": "boolean"
|
572
733
|
},
|
573
|
-
"default": "
|
734
|
+
"default": "false",
|
574
735
|
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
575
|
-
"
|
736
|
+
"fieldName": "softDisabled",
|
576
737
|
"inheritedFrom": {
|
577
738
|
"name": "Buttonsimple",
|
578
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
739
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
579
740
|
}
|
580
741
|
},
|
581
742
|
{
|
582
|
-
"kind": "field",
|
583
743
|
"name": "role",
|
584
744
|
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
585
|
-
"default": "
|
586
|
-
"
|
587
|
-
"reflects": true,
|
588
|
-
"type": {
|
589
|
-
"text": "string"
|
590
|
-
},
|
745
|
+
"default": "button",
|
746
|
+
"fieldName": "role",
|
591
747
|
"inheritedFrom": {
|
592
748
|
"name": "Buttonsimple",
|
593
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
749
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
594
750
|
}
|
595
751
|
},
|
596
752
|
{
|
597
|
-
"kind": "field",
|
598
753
|
"name": "type",
|
599
754
|
"type": {
|
600
755
|
"text": "ButtonType"
|
601
756
|
},
|
602
757
|
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
603
758
|
"default": "button",
|
604
|
-
"
|
605
|
-
"reflects": true,
|
759
|
+
"fieldName": "type",
|
606
760
|
"inheritedFrom": {
|
607
761
|
"name": "Buttonsimple",
|
608
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
762
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
609
763
|
}
|
610
|
-
}
|
764
|
+
}
|
765
|
+
],
|
766
|
+
"mixins": [
|
611
767
|
{
|
612
|
-
"
|
613
|
-
"
|
614
|
-
|
615
|
-
|
616
|
-
|
617
|
-
|
618
|
-
|
619
|
-
|
620
|
-
|
621
|
-
|
622
|
-
|
623
|
-
|
768
|
+
"name": "AvatarComponentMixin",
|
769
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
770
|
+
}
|
771
|
+
],
|
772
|
+
"superclass": {
|
773
|
+
"name": "Buttonsimple",
|
774
|
+
"module": "/src/components/buttonsimple"
|
775
|
+
},
|
776
|
+
"tagName": "mdc-avatarbutton",
|
777
|
+
"jsDoc": "/**\n * The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n *\n * This component is made by extending `buttonsimple` class.\n * The button component acts as a wrapper for the avatar component.\n *\n * @dependency mdc-avatar\n *\n * @tagname mdc-avatarbutton\n */",
|
778
|
+
"customElement": true
|
779
|
+
}
|
780
|
+
],
|
781
|
+
"exports": [
|
782
|
+
{
|
783
|
+
"kind": "js",
|
784
|
+
"name": "default",
|
785
|
+
"declaration": {
|
786
|
+
"name": "AvatarButton",
|
787
|
+
"module": "components/avatarbutton/avatarbutton.component.js"
|
788
|
+
}
|
789
|
+
}
|
790
|
+
]
|
791
|
+
},
|
792
|
+
{
|
793
|
+
"kind": "javascript-module",
|
794
|
+
"path": "components/badge/badge.component.js",
|
795
|
+
"declarations": [
|
796
|
+
{
|
797
|
+
"kind": "class",
|
798
|
+
"description": "The `mdc-badge` component is a versatile UI element used to\ndisplay dot, icons, counters, success, warning and error type badge.\n\nSupported badge types:\n- `dot`: Displays a dot notification badge with a blue color.\n- `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n- `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\nit shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n- `success`: Displays a success badge with a check circle icon and green color.\n- `warning`: Displays a warning badge with a warning icon and yellow color.\n- `error`: Displays a error badge with a error legacy icon and red color.\n\nFor `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n\nFor the `counter` type, the `mdc-text` component is used to render the counter value.",
|
799
|
+
"name": "Badge",
|
800
|
+
"members": [
|
624
801
|
{
|
625
802
|
"kind": "field",
|
626
|
-
"name": "
|
803
|
+
"name": "type",
|
627
804
|
"type": {
|
628
|
-
"text": "
|
805
|
+
"text": "BadgeType | undefined"
|
629
806
|
},
|
630
|
-
"description": "
|
631
|
-
"attribute": "
|
632
|
-
"
|
633
|
-
"name": "AvatarComponentMixin",
|
634
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
635
|
-
}
|
807
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
808
|
+
"attribute": "type",
|
809
|
+
"reflects": true
|
636
810
|
},
|
637
811
|
{
|
638
812
|
"kind": "field",
|
639
|
-
"name": "
|
813
|
+
"name": "iconName",
|
640
814
|
"type": {
|
641
|
-
"text": "
|
642
|
-
},
|
643
|
-
"description": "
|
644
|
-
"attribute": "
|
645
|
-
"inheritedFrom": {
|
646
|
-
"name": "AvatarComponentMixin",
|
647
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
648
|
-
}
|
815
|
+
"text": "IconNames | undefined"
|
816
|
+
},
|
817
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
818
|
+
"attribute": "icon-name"
|
649
819
|
},
|
650
820
|
{
|
651
821
|
"kind": "field",
|
652
|
-
"name": "
|
822
|
+
"name": "variant",
|
653
823
|
"type": {
|
654
|
-
"text": "
|
824
|
+
"text": "IconVariant"
|
655
825
|
},
|
656
|
-
"description": "
|
657
|
-
"default": "
|
658
|
-
"attribute": "
|
659
|
-
"reflects": true
|
660
|
-
"inheritedFrom": {
|
661
|
-
"name": "Buttonsimple",
|
662
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
663
|
-
}
|
826
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
827
|
+
"default": "primary",
|
828
|
+
"attribute": "variant",
|
829
|
+
"reflects": true
|
664
830
|
},
|
665
831
|
{
|
666
832
|
"kind": "field",
|
667
|
-
"name": "
|
833
|
+
"name": "counter",
|
668
834
|
"type": {
|
669
|
-
"text": "
|
835
|
+
"text": "number | undefined"
|
670
836
|
},
|
671
|
-
"description": "
|
672
|
-
"attribute": "
|
673
|
-
"inheritedFrom": {
|
674
|
-
"name": "AvatarComponentMixin",
|
675
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
676
|
-
}
|
837
|
+
"description": "Counter is the number which can be provided in the badge.",
|
838
|
+
"attribute": "counter"
|
677
839
|
},
|
678
840
|
{
|
679
841
|
"kind": "field",
|
680
|
-
"name": "
|
842
|
+
"name": "maxCounter",
|
681
843
|
"type": {
|
682
|
-
"text": "number
|
844
|
+
"text": "number"
|
683
845
|
},
|
684
|
-
"description": "The
|
685
|
-
"
|
686
|
-
"
|
687
|
-
|
688
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
689
|
-
}
|
846
|
+
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
847
|
+
"default": "99",
|
848
|
+
"attribute": "max-counter",
|
849
|
+
"reflects": true
|
690
850
|
},
|
691
851
|
{
|
692
852
|
"kind": "field",
|
693
|
-
"name": "
|
853
|
+
"name": "overlay",
|
694
854
|
"type": {
|
695
855
|
"text": "boolean"
|
696
856
|
},
|
697
857
|
"default": "false",
|
698
|
-
"description": "
|
699
|
-
"attribute": "
|
700
|
-
"inheritedFrom": {
|
701
|
-
"name": "AvatarComponentMixin",
|
702
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
703
|
-
}
|
858
|
+
"description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
|
859
|
+
"attribute": "overlay"
|
704
860
|
},
|
705
861
|
{
|
706
862
|
"kind": "field",
|
707
|
-
"name": "
|
863
|
+
"name": "ariaLabel",
|
708
864
|
"type": {
|
709
|
-
"text": "
|
865
|
+
"text": "string | null"
|
710
866
|
},
|
711
|
-
"default": "
|
712
|
-
"description": "
|
713
|
-
"attribute": "
|
714
|
-
"reflects": true,
|
715
|
-
"inheritedFrom": {
|
716
|
-
"name": "TabIndexMixin",
|
717
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
718
|
-
}
|
719
|
-
},
|
720
|
-
{
|
721
|
-
"kind": "method",
|
722
|
-
"name": "executeAction",
|
723
|
-
"privacy": "private",
|
724
|
-
"inheritedFrom": {
|
725
|
-
"name": "Buttonsimple",
|
726
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
727
|
-
}
|
867
|
+
"default": "null",
|
868
|
+
"description": "Aria-label attribute to be set for accessibility",
|
869
|
+
"attribute": "aria-label"
|
728
870
|
},
|
729
871
|
{
|
730
872
|
"kind": "method",
|
731
|
-
"name": "
|
873
|
+
"name": "getCounterText",
|
732
874
|
"privacy": "private",
|
875
|
+
"return": {
|
876
|
+
"type": {
|
877
|
+
"text": ""
|
878
|
+
}
|
879
|
+
},
|
733
880
|
"parameters": [
|
734
881
|
{
|
735
|
-
"name": "
|
882
|
+
"name": "maxCounter",
|
736
883
|
"type": {
|
737
|
-
"text": "
|
884
|
+
"text": "number"
|
738
885
|
},
|
739
|
-
"description": "
|
886
|
+
"description": "the maximum limit which can be displayed on the badge"
|
740
887
|
},
|
741
888
|
{
|
742
|
-
"name": "
|
889
|
+
"name": "counter",
|
890
|
+
"optional": true,
|
743
891
|
"type": {
|
744
|
-
"text": "
|
892
|
+
"text": "number"
|
745
893
|
},
|
746
|
-
"description": "
|
894
|
+
"description": "the number to be displayed on the badge"
|
747
895
|
}
|
748
896
|
],
|
749
|
-
"description": "
|
750
|
-
"inheritedFrom": {
|
751
|
-
"name": "Buttonsimple",
|
752
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
753
|
-
}
|
897
|
+
"description": "If `type` is set to `counter` and if `counter` is greater than `maxCounter`,\nthen it will return a string the maxCounter value as string.\nOtherwise, it will return a string representation of `counter`.\nIf `counter` is not a number, it will return an empty string."
|
754
898
|
},
|
755
899
|
{
|
756
900
|
"kind": "method",
|
757
|
-
"name": "
|
901
|
+
"name": "getBadgeIcon",
|
758
902
|
"privacy": "private",
|
903
|
+
"return": {
|
904
|
+
"type": {
|
905
|
+
"text": ""
|
906
|
+
}
|
907
|
+
},
|
759
908
|
"parameters": [
|
760
909
|
{
|
761
|
-
"name": "
|
910
|
+
"name": "iconName",
|
762
911
|
"type": {
|
763
|
-
"text": "
|
912
|
+
"text": "string"
|
764
913
|
},
|
765
|
-
"description": "
|
914
|
+
"description": "the name of the icon from the icon set"
|
766
915
|
},
|
767
916
|
{
|
768
|
-
"name": "
|
917
|
+
"name": "backgroundClassPostfix",
|
769
918
|
"type": {
|
770
|
-
"text": "
|
919
|
+
"text": "string"
|
771
920
|
},
|
772
|
-
"description": "
|
921
|
+
"description": "postfix for the class to style the badge icon."
|
773
922
|
}
|
774
923
|
],
|
775
|
-
"description": "
|
776
|
-
"inheritedFrom": {
|
777
|
-
"name": "Buttonsimple",
|
778
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
779
|
-
}
|
924
|
+
"description": "Method to generate the badge icon."
|
780
925
|
},
|
781
926
|
{
|
782
927
|
"kind": "method",
|
783
|
-
"name": "
|
928
|
+
"name": "getBadgeDot",
|
784
929
|
"privacy": "private",
|
785
|
-
"
|
786
|
-
{
|
787
|
-
"
|
788
|
-
"type": {
|
789
|
-
"text": "HTMLElement"
|
790
|
-
},
|
791
|
-
"description": "The button element."
|
792
|
-
},
|
793
|
-
{
|
794
|
-
"name": "disabled",
|
795
|
-
"type": {
|
796
|
-
"text": "boolean"
|
797
|
-
},
|
798
|
-
"description": "The disabled state."
|
930
|
+
"return": {
|
931
|
+
"type": {
|
932
|
+
"text": ""
|
799
933
|
}
|
800
|
-
|
801
|
-
"description": "
|
802
|
-
"inheritedFrom": {
|
803
|
-
"name": "Buttonsimple",
|
804
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
805
|
-
}
|
934
|
+
},
|
935
|
+
"description": "Method to generate the badge dot template."
|
806
936
|
},
|
807
937
|
{
|
808
938
|
"kind": "method",
|
809
|
-
"name": "
|
939
|
+
"name": "getBadgeCounterText",
|
810
940
|
"privacy": "private",
|
811
|
-
"
|
812
|
-
"
|
813
|
-
|
814
|
-
|
941
|
+
"return": {
|
942
|
+
"type": {
|
943
|
+
"text": ""
|
944
|
+
}
|
945
|
+
},
|
946
|
+
"description": "Method to generate the badge text and counter template."
|
815
947
|
},
|
816
948
|
{
|
817
949
|
"kind": "method",
|
818
|
-
"name": "
|
950
|
+
"name": "setRoleByAriaLabel",
|
819
951
|
"privacy": "private",
|
820
|
-
"
|
821
|
-
{
|
822
|
-
"
|
823
|
-
"type": {
|
824
|
-
"text": "KeyboardEvent"
|
825
|
-
},
|
826
|
-
"description": "The keyboard event."
|
952
|
+
"return": {
|
953
|
+
"type": {
|
954
|
+
"text": "void"
|
827
955
|
}
|
828
|
-
|
829
|
-
"description": "
|
830
|
-
"inheritedFrom": {
|
831
|
-
"name": "Buttonsimple",
|
832
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
833
|
-
}
|
956
|
+
},
|
957
|
+
"description": "Method to set the role based on the aria-label provided.\nIf the aria-label is provided, the role of the element will be 'img'.\nOtherwise, the role will be null."
|
834
958
|
},
|
835
959
|
{
|
836
960
|
"kind": "method",
|
837
|
-
"name": "
|
961
|
+
"name": "getBadgeContentBasedOnType",
|
838
962
|
"privacy": "private",
|
839
|
-
"
|
840
|
-
{
|
841
|
-
"
|
842
|
-
"type": {
|
843
|
-
"text": "KeyboardEvent"
|
844
|
-
},
|
845
|
-
"description": "The keyboard event."
|
963
|
+
"return": {
|
964
|
+
"type": {
|
965
|
+
"text": ""
|
846
966
|
}
|
847
|
-
|
848
|
-
"description": "
|
849
|
-
"inheritedFrom": {
|
850
|
-
"name": "Buttonsimple",
|
851
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
852
|
-
}
|
967
|
+
},
|
968
|
+
"description": "Generates the badge content based on the badge type.\nUtilizes various helper methods to create the appropriate badge template based on the\ncurrent badge type. Supports 'dot', 'icon', 'counter', 'success', 'warning', and 'error'\ntypes, returning the corresponding template result for each type."
|
853
969
|
}
|
854
970
|
],
|
855
971
|
"attributes": [
|
856
972
|
{
|
857
|
-
"name": "
|
858
|
-
"type": {
|
859
|
-
"text": "string | null"
|
860
|
-
},
|
861
|
-
"default": "null",
|
862
|
-
"description": "Aria-label attribute to be set for accessibility",
|
863
|
-
"fieldName": "ariaLabel"
|
864
|
-
},
|
865
|
-
{
|
866
|
-
"name": "src",
|
867
|
-
"type": {
|
868
|
-
"text": "string | undefined"
|
869
|
-
},
|
870
|
-
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
871
|
-
"fieldName": "src",
|
872
|
-
"inheritedFrom": {
|
873
|
-
"name": "AvatarComponentMixin",
|
874
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
875
|
-
}
|
876
|
-
},
|
877
|
-
{
|
878
|
-
"name": "initials",
|
879
|
-
"type": {
|
880
|
-
"text": "string | undefined"
|
881
|
-
},
|
882
|
-
"description": "The initials to be displayed for the avatar.",
|
883
|
-
"fieldName": "initials",
|
884
|
-
"inheritedFrom": {
|
885
|
-
"name": "AvatarComponentMixin",
|
886
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
887
|
-
}
|
888
|
-
},
|
889
|
-
{
|
890
|
-
"name": "presence",
|
891
|
-
"type": {
|
892
|
-
"text": "PresenceType | undefined"
|
893
|
-
},
|
894
|
-
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
895
|
-
"fieldName": "presence",
|
896
|
-
"inheritedFrom": {
|
897
|
-
"name": "AvatarComponentMixin",
|
898
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
899
|
-
}
|
900
|
-
},
|
901
|
-
{
|
902
|
-
"name": "size",
|
973
|
+
"name": "type",
|
903
974
|
"type": {
|
904
|
-
"text": "
|
975
|
+
"text": "BadgeType | undefined"
|
905
976
|
},
|
906
|
-
"description": "
|
907
|
-
"
|
908
|
-
"fieldName": "size",
|
909
|
-
"inheritedFrom": {
|
910
|
-
"name": "Buttonsimple",
|
911
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
912
|
-
}
|
977
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
978
|
+
"fieldName": "type"
|
913
979
|
},
|
914
980
|
{
|
915
981
|
"name": "icon-name",
|
916
982
|
"type": {
|
917
983
|
"text": "IconNames | undefined"
|
918
984
|
},
|
919
|
-
"description": "Name of the icon
|
920
|
-
"fieldName": "iconName"
|
921
|
-
"inheritedFrom": {
|
922
|
-
"name": "AvatarComponentMixin",
|
923
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
924
|
-
}
|
985
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
986
|
+
"fieldName": "iconName"
|
925
987
|
},
|
926
988
|
{
|
927
|
-
"name": "
|
989
|
+
"name": "variant",
|
928
990
|
"type": {
|
929
|
-
"text": "
|
991
|
+
"text": "IconVariant"
|
930
992
|
},
|
931
|
-
"description": "
|
932
|
-
"
|
933
|
-
"
|
934
|
-
"name": "AvatarComponentMixin",
|
935
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
936
|
-
}
|
993
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
994
|
+
"default": "primary",
|
995
|
+
"fieldName": "variant"
|
937
996
|
},
|
938
997
|
{
|
939
|
-
"name": "
|
998
|
+
"name": "counter",
|
940
999
|
"type": {
|
941
|
-
"text": "
|
1000
|
+
"text": "number | undefined"
|
942
1001
|
},
|
943
|
-
"
|
944
|
-
"
|
945
|
-
"fieldName": "isTyping",
|
946
|
-
"inheritedFrom": {
|
947
|
-
"name": "AvatarComponentMixin",
|
948
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
949
|
-
}
|
1002
|
+
"description": "Counter is the number which can be provided in the badge.",
|
1003
|
+
"fieldName": "counter"
|
950
1004
|
},
|
951
1005
|
{
|
952
|
-
"name": "
|
1006
|
+
"name": "max-counter",
|
953
1007
|
"type": {
|
954
1008
|
"text": "number"
|
955
1009
|
},
|
956
|
-
"
|
957
|
-
"
|
958
|
-
"fieldName": "
|
959
|
-
"inheritedFrom": {
|
960
|
-
"name": "TabIndexMixin",
|
961
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
962
|
-
}
|
963
|
-
},
|
964
|
-
{
|
965
|
-
"name": "disabled",
|
966
|
-
"type": {
|
967
|
-
"text": "boolean"
|
968
|
-
},
|
969
|
-
"default": "false",
|
970
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
971
|
-
"fieldName": "disabled",
|
972
|
-
"inheritedFrom": {
|
973
|
-
"name": "DisabledMixin",
|
974
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
975
|
-
}
|
976
|
-
},
|
977
|
-
{
|
978
|
-
"name": "active",
|
979
|
-
"type": {
|
980
|
-
"text": "boolean"
|
981
|
-
},
|
982
|
-
"default": "false",
|
983
|
-
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
|
984
|
-
"fieldName": "active",
|
985
|
-
"inheritedFrom": {
|
986
|
-
"name": "Buttonsimple",
|
987
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
988
|
-
}
|
1010
|
+
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
1011
|
+
"default": "99",
|
1012
|
+
"fieldName": "maxCounter"
|
989
1013
|
},
|
990
1014
|
{
|
991
|
-
"name": "
|
1015
|
+
"name": "overlay",
|
992
1016
|
"type": {
|
993
1017
|
"text": "boolean"
|
994
1018
|
},
|
995
1019
|
"default": "false",
|
996
|
-
"description": "
|
997
|
-
"fieldName": "
|
998
|
-
"inheritedFrom": {
|
999
|
-
"name": "Buttonsimple",
|
1000
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1001
|
-
}
|
1002
|
-
},
|
1003
|
-
{
|
1004
|
-
"name": "role",
|
1005
|
-
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
1006
|
-
"default": "button",
|
1007
|
-
"fieldName": "role",
|
1008
|
-
"inheritedFrom": {
|
1009
|
-
"name": "Buttonsimple",
|
1010
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1011
|
-
}
|
1020
|
+
"description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
|
1021
|
+
"fieldName": "overlay"
|
1012
1022
|
},
|
1013
1023
|
{
|
1014
|
-
"name": "
|
1024
|
+
"name": "aria-label",
|
1015
1025
|
"type": {
|
1016
|
-
"text": "
|
1026
|
+
"text": "string | null"
|
1017
1027
|
},
|
1018
|
-
"
|
1019
|
-
"
|
1020
|
-
"fieldName": "
|
1021
|
-
"inheritedFrom": {
|
1022
|
-
"name": "Buttonsimple",
|
1023
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1024
|
-
}
|
1025
|
-
}
|
1026
|
-
],
|
1027
|
-
"mixins": [
|
1028
|
-
{
|
1029
|
-
"name": "AvatarComponentMixin",
|
1030
|
-
"module": "/src/utils/mixins/AvatarComponentMixin"
|
1028
|
+
"default": "null",
|
1029
|
+
"description": "Aria-label attribute to be set for accessibility",
|
1030
|
+
"fieldName": "ariaLabel"
|
1031
1031
|
}
|
1032
1032
|
],
|
1033
1033
|
"superclass": {
|
1034
|
-
"name": "
|
1035
|
-
"module": "/src/
|
1034
|
+
"name": "Component",
|
1035
|
+
"module": "/src/models"
|
1036
1036
|
},
|
1037
|
-
"tagName": "mdc-
|
1038
|
-
"jsDoc": "/**\n * The `mdc-
|
1037
|
+
"tagName": "mdc-badge",
|
1038
|
+
"jsDoc": "/**\n * The `mdc-badge` component is a versatile UI element used to\n * display dot, icons, counters, success, warning and error type badge.\n *\n * Supported badge types:\n * - `dot`: Displays a dot notification badge with a blue color.\n * - `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n * - `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\n * it shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n * - `success`: Displays a success badge with a check circle icon and green color.\n * - `warning`: Displays a warning badge with a warning icon and yellow color.\n * - `error`: Displays a error badge with a error legacy icon and red color.\n *\n * For `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n *\n * For the `counter` type, the `mdc-text` component is used to render the counter value.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-badge\n */",
|
1039
1039
|
"customElement": true
|
1040
1040
|
}
|
1041
1041
|
],
|
@@ -1044,8 +1044,8 @@
|
|
1044
1044
|
"kind": "js",
|
1045
1045
|
"name": "default",
|
1046
1046
|
"declaration": {
|
1047
|
-
"name": "
|
1048
|
-
"module": "components/
|
1047
|
+
"name": "Badge",
|
1048
|
+
"module": "components/badge/badge.component.js"
|
1049
1049
|
}
|
1050
1050
|
}
|
1051
1051
|
]
|
@@ -2405,105 +2405,285 @@
|
|
2405
2405
|
},
|
2406
2406
|
{
|
2407
2407
|
"kind": "field",
|
2408
|
-
"name": "url",
|
2408
|
+
"name": "url",
|
2409
|
+
"type": {
|
2410
|
+
"text": "string | undefined"
|
2411
|
+
},
|
2412
|
+
"description": "Url of where icons will be fetched from",
|
2413
|
+
"attribute": "url"
|
2414
|
+
},
|
2415
|
+
{
|
2416
|
+
"kind": "field",
|
2417
|
+
"name": "fileExtension",
|
2418
|
+
"type": {
|
2419
|
+
"text": "string | undefined"
|
2420
|
+
},
|
2421
|
+
"description": "File extension of icons",
|
2422
|
+
"default": "svg",
|
2423
|
+
"attribute": "file-extension",
|
2424
|
+
"reflects": true
|
2425
|
+
},
|
2426
|
+
{
|
2427
|
+
"kind": "field",
|
2428
|
+
"name": "lengthUnit",
|
2429
|
+
"type": {
|
2430
|
+
"text": "string"
|
2431
|
+
},
|
2432
|
+
"description": "Length unit used for sizing of icons",
|
2433
|
+
"default": "em",
|
2434
|
+
"attribute": "length-unit",
|
2435
|
+
"reflects": true
|
2436
|
+
},
|
2437
|
+
{
|
2438
|
+
"kind": "field",
|
2439
|
+
"name": "size",
|
2440
|
+
"type": {
|
2441
|
+
"text": "number | undefined"
|
2442
|
+
},
|
2443
|
+
"description": "The default size of the icon.\nIf not set, it falls back to the size defined by the length unit.",
|
2444
|
+
"default": "1",
|
2445
|
+
"attribute": "size",
|
2446
|
+
"reflects": true
|
2447
|
+
},
|
2448
|
+
{
|
2449
|
+
"kind": "method",
|
2450
|
+
"name": "updateValuesInContext",
|
2451
|
+
"privacy": "private"
|
2452
|
+
},
|
2453
|
+
{
|
2454
|
+
"kind": "method",
|
2455
|
+
"name": "updateContext",
|
2456
|
+
"privacy": "protected",
|
2457
|
+
"return": {
|
2458
|
+
"type": {
|
2459
|
+
"text": "void"
|
2460
|
+
}
|
2461
|
+
}
|
2462
|
+
}
|
2463
|
+
],
|
2464
|
+
"attributes": [
|
2465
|
+
{
|
2466
|
+
"name": "url",
|
2467
|
+
"type": {
|
2468
|
+
"text": "string | undefined"
|
2469
|
+
},
|
2470
|
+
"description": "Url of where icons will be fetched from",
|
2471
|
+
"fieldName": "url"
|
2472
|
+
},
|
2473
|
+
{
|
2474
|
+
"name": "file-extension",
|
2475
|
+
"type": {
|
2476
|
+
"text": "string | undefined"
|
2477
|
+
},
|
2478
|
+
"description": "File extension of icons",
|
2479
|
+
"default": "svg",
|
2480
|
+
"fieldName": "fileExtension"
|
2481
|
+
},
|
2482
|
+
{
|
2483
|
+
"name": "length-unit",
|
2484
|
+
"type": {
|
2485
|
+
"text": "string"
|
2486
|
+
},
|
2487
|
+
"description": "Length unit used for sizing of icons",
|
2488
|
+
"default": "em",
|
2489
|
+
"fieldName": "lengthUnit"
|
2490
|
+
},
|
2491
|
+
{
|
2492
|
+
"name": "size",
|
2493
|
+
"type": {
|
2494
|
+
"text": "number | undefined"
|
2495
|
+
},
|
2496
|
+
"description": "The default size of the icon.\nIf not set, it falls back to the size defined by the length unit.",
|
2497
|
+
"default": "1",
|
2498
|
+
"fieldName": "size"
|
2499
|
+
}
|
2500
|
+
],
|
2501
|
+
"superclass": {
|
2502
|
+
"name": "Provider",
|
2503
|
+
"module": "/src/models"
|
2504
|
+
},
|
2505
|
+
"tagName": "mdc-iconprovider",
|
2506
|
+
"jsDoc": "/**\n * IconProvider component, which allows to be consumed from sub components\n * (see `providerUtils.consume` for how to consume)\n *\n * Bundling icons will be up to the consumer of this component, such\n * that only a url has to be passed in from which the icons will be\n * fetched.\n *\n * @tagname mdc-iconprovider\n *\n * @slot - children\n */",
|
2507
|
+
"customElement": true
|
2508
|
+
}
|
2509
|
+
],
|
2510
|
+
"exports": [
|
2511
|
+
{
|
2512
|
+
"kind": "js",
|
2513
|
+
"name": "default",
|
2514
|
+
"declaration": {
|
2515
|
+
"name": "IconProvider",
|
2516
|
+
"module": "components/iconprovider/iconprovider.component.js"
|
2517
|
+
}
|
2518
|
+
}
|
2519
|
+
]
|
2520
|
+
},
|
2521
|
+
{
|
2522
|
+
"kind": "javascript-module",
|
2523
|
+
"path": "components/labelandhelper/labelandhelper.component.js",
|
2524
|
+
"declarations": [
|
2525
|
+
{
|
2526
|
+
"kind": "class",
|
2527
|
+
"description": "labelandhelper is a component that contains the label and helper/validation text\n that can be configured in various ways to suit different use cases (most of the input related components).\nIt is used as an internal component and is not intended to be used directly by consumers.",
|
2528
|
+
"name": "LabelAndHelper",
|
2529
|
+
"members": [
|
2530
|
+
{
|
2531
|
+
"kind": "field",
|
2532
|
+
"name": "label",
|
2409
2533
|
"type": {
|
2410
2534
|
"text": "string | undefined"
|
2411
2535
|
},
|
2412
|
-
"description": "
|
2413
|
-
"attribute": "
|
2536
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
2537
|
+
"attribute": "label",
|
2538
|
+
"reflects": true
|
2414
2539
|
},
|
2415
2540
|
{
|
2416
2541
|
"kind": "field",
|
2417
|
-
"name": "
|
2542
|
+
"name": "id",
|
2543
|
+
"default": "`mdc-input-${uuidv4()}`",
|
2544
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2545
|
+
"attribute": "id"
|
2546
|
+
},
|
2547
|
+
{
|
2548
|
+
"kind": "field",
|
2549
|
+
"name": "helpTextType",
|
2418
2550
|
"type": {
|
2419
|
-
"text": "
|
2551
|
+
"text": "ValidationType"
|
2420
2552
|
},
|
2421
|
-
"description": "
|
2422
|
-
"
|
2423
|
-
"attribute": "file-extension",
|
2553
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
2554
|
+
"attribute": "help-text-type",
|
2424
2555
|
"reflects": true
|
2425
2556
|
},
|
2426
2557
|
{
|
2427
2558
|
"kind": "field",
|
2428
|
-
"name": "
|
2559
|
+
"name": "helpText",
|
2429
2560
|
"type": {
|
2430
|
-
"text": "string"
|
2561
|
+
"text": "string | undefined"
|
2431
2562
|
},
|
2432
|
-
"description": "
|
2433
|
-
"
|
2434
|
-
"attribute": "length-unit",
|
2563
|
+
"description": "The help text that is displayed below the input field.",
|
2564
|
+
"attribute": "help-text",
|
2435
2565
|
"reflects": true
|
2436
2566
|
},
|
2437
2567
|
{
|
2438
2568
|
"kind": "field",
|
2439
|
-
"name": "
|
2569
|
+
"name": "labelInfoText",
|
2440
2570
|
"type": {
|
2441
|
-
"text": "
|
2571
|
+
"text": "string | undefined"
|
2442
2572
|
},
|
2443
|
-
"
|
2444
|
-
"default": "1",
|
2445
|
-
"attribute": "size",
|
2446
|
-
"reflects": true
|
2573
|
+
"attribute": "label-info-text"
|
2447
2574
|
},
|
2448
2575
|
{
|
2449
2576
|
"kind": "method",
|
2450
|
-
"name": "
|
2451
|
-
"privacy": "
|
2577
|
+
"name": "renderLabelElement",
|
2578
|
+
"privacy": "protected",
|
2579
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
2580
|
+
"return": {
|
2581
|
+
"type": {
|
2582
|
+
"text": ""
|
2583
|
+
}
|
2584
|
+
}
|
2452
2585
|
},
|
2453
2586
|
{
|
2454
2587
|
"kind": "method",
|
2455
|
-
"name": "
|
2588
|
+
"name": "renderLabelInfoToggleTip",
|
2456
2589
|
"privacy": "protected",
|
2590
|
+
"description": "displays a info icon, which when hovered over, displays the labelInfoText.\nThis is in beta and is subject to change once the toggletip component is ready.",
|
2457
2591
|
"return": {
|
2458
2592
|
"type": {
|
2459
|
-
"text": "
|
2593
|
+
"text": ""
|
2594
|
+
}
|
2595
|
+
}
|
2596
|
+
},
|
2597
|
+
{
|
2598
|
+
"kind": "method",
|
2599
|
+
"name": "renderHelpTextIcon",
|
2600
|
+
"privacy": "protected",
|
2601
|
+
"description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
|
2602
|
+
"return": {
|
2603
|
+
"type": {
|
2604
|
+
"text": ""
|
2605
|
+
}
|
2606
|
+
}
|
2607
|
+
},
|
2608
|
+
{
|
2609
|
+
"kind": "method",
|
2610
|
+
"name": "renderHelpText",
|
2611
|
+
"privacy": "protected",
|
2612
|
+
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
2613
|
+
"return": {
|
2614
|
+
"type": {
|
2615
|
+
"text": ""
|
2616
|
+
}
|
2617
|
+
}
|
2618
|
+
},
|
2619
|
+
{
|
2620
|
+
"kind": "method",
|
2621
|
+
"name": "renderLabel",
|
2622
|
+
"privacy": "protected",
|
2623
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
2624
|
+
"return": {
|
2625
|
+
"type": {
|
2626
|
+
"text": ""
|
2627
|
+
}
|
2628
|
+
}
|
2629
|
+
},
|
2630
|
+
{
|
2631
|
+
"kind": "method",
|
2632
|
+
"name": "renderHelperText",
|
2633
|
+
"privacy": "protected",
|
2634
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
2635
|
+
"return": {
|
2636
|
+
"type": {
|
2637
|
+
"text": ""
|
2460
2638
|
}
|
2461
2639
|
}
|
2462
2640
|
}
|
2463
2641
|
],
|
2464
2642
|
"attributes": [
|
2465
2643
|
{
|
2466
|
-
"name": "
|
2644
|
+
"name": "label",
|
2467
2645
|
"type": {
|
2468
2646
|
"text": "string | undefined"
|
2469
2647
|
},
|
2470
|
-
"description": "
|
2471
|
-
"fieldName": "
|
2648
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
2649
|
+
"fieldName": "label"
|
2472
2650
|
},
|
2473
2651
|
{
|
2474
|
-
"name": "
|
2652
|
+
"name": "id",
|
2653
|
+
"default": "`mdc-input-${uuidv4()}`",
|
2654
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2655
|
+
"fieldName": "id"
|
2656
|
+
},
|
2657
|
+
{
|
2658
|
+
"name": "help-text-type",
|
2475
2659
|
"type": {
|
2476
|
-
"text": "
|
2660
|
+
"text": "ValidationType"
|
2477
2661
|
},
|
2478
|
-
"description": "
|
2479
|
-
"
|
2480
|
-
"fieldName": "fileExtension"
|
2662
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
2663
|
+
"fieldName": "helpTextType"
|
2481
2664
|
},
|
2482
2665
|
{
|
2483
|
-
"name": "
|
2666
|
+
"name": "help-text",
|
2484
2667
|
"type": {
|
2485
|
-
"text": "string"
|
2668
|
+
"text": "string | undefined"
|
2486
2669
|
},
|
2487
|
-
"description": "
|
2488
|
-
"
|
2489
|
-
"fieldName": "lengthUnit"
|
2670
|
+
"description": "The help text that is displayed below the input field.",
|
2671
|
+
"fieldName": "helpText"
|
2490
2672
|
},
|
2491
2673
|
{
|
2492
|
-
"name": "
|
2674
|
+
"name": "label-info-text",
|
2493
2675
|
"type": {
|
2494
|
-
"text": "
|
2676
|
+
"text": "string | undefined"
|
2495
2677
|
},
|
2496
|
-
"
|
2497
|
-
"default": "1",
|
2498
|
-
"fieldName": "size"
|
2678
|
+
"fieldName": "labelInfoText"
|
2499
2679
|
}
|
2500
2680
|
],
|
2501
2681
|
"superclass": {
|
2502
|
-
"name": "
|
2682
|
+
"name": "Component",
|
2503
2683
|
"module": "/src/models"
|
2504
2684
|
},
|
2505
|
-
"tagName": "mdc-
|
2506
|
-
"jsDoc": "/**\n *
|
2685
|
+
"tagName": "mdc-labelandhelper",
|
2686
|
+
"jsDoc": "/**\n * labelandhelper is a component that contains the label and helper/validation text\n * that can be configured in various ways to suit different use cases (most of the input related components).\n * It is used as an internal component and is not intended to be used directly by consumers.\n *\n * @tagname mdc-labelandhelper\n *\n */",
|
2507
2687
|
"customElement": true
|
2508
2688
|
}
|
2509
2689
|
],
|
@@ -2512,8 +2692,8 @@
|
|
2512
2692
|
"kind": "js",
|
2513
2693
|
"name": "default",
|
2514
2694
|
"declaration": {
|
2515
|
-
"name": "
|
2516
|
-
"module": "components/
|
2695
|
+
"name": "LabelAndHelper",
|
2696
|
+
"module": "components/labelandhelper/labelandhelper.component.js"
|
2517
2697
|
}
|
2518
2698
|
}
|
2519
2699
|
]
|
@@ -3091,45 +3271,140 @@
|
|
3091
3271
|
},
|
3092
3272
|
{
|
3093
3273
|
"kind": "javascript-module",
|
3094
|
-
"path": "utils/mixins/
|
3274
|
+
"path": "utils/mixins/NameMixin.js",
|
3095
3275
|
"declarations": [
|
3096
3276
|
{
|
3097
3277
|
"kind": "mixin",
|
3098
3278
|
"description": "",
|
3099
|
-
"name": "
|
3279
|
+
"name": "NameMixin",
|
3100
3280
|
"members": [
|
3101
3281
|
{
|
3102
3282
|
"kind": "field",
|
3103
|
-
"name": "
|
3283
|
+
"name": "name",
|
3104
3284
|
"type": {
|
3105
3285
|
"text": "string"
|
3106
3286
|
},
|
3107
3287
|
"default": "''",
|
3108
|
-
"description": "
|
3109
|
-
"attribute": "
|
3288
|
+
"description": "Indicates the name of the component group (ex: checkbox, radio group).\nThey are used to group elements in a form together.",
|
3289
|
+
"attribute": "name",
|
3110
3290
|
"reflects": true
|
3111
|
-
},
|
3112
|
-
{
|
3113
|
-
"kind": "method",
|
3114
|
-
"name": "renderLabel",
|
3115
|
-
"privacy": "public",
|
3116
|
-
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
3117
|
-
"return": {
|
3118
|
-
"type": {
|
3119
|
-
"text": ""
|
3120
|
-
}
|
3121
|
-
}
|
3122
3291
|
}
|
3123
3292
|
],
|
3124
3293
|
"attributes": [
|
3125
3294
|
{
|
3126
|
-
"name": "
|
3295
|
+
"name": "name",
|
3127
3296
|
"type": {
|
3128
3297
|
"text": "string"
|
3129
3298
|
},
|
3130
3299
|
"default": "''",
|
3131
|
-
"description": "
|
3132
|
-
"fieldName": "
|
3300
|
+
"description": "Indicates the name of the component group (ex: checkbox, radio group).\nThey are used to group elements in a form together.",
|
3301
|
+
"fieldName": "name"
|
3302
|
+
}
|
3303
|
+
],
|
3304
|
+
"parameters": [
|
3305
|
+
{
|
3306
|
+
"name": "superClass",
|
3307
|
+
"type": {
|
3308
|
+
"text": "T"
|
3309
|
+
}
|
3310
|
+
}
|
3311
|
+
]
|
3312
|
+
}
|
3313
|
+
],
|
3314
|
+
"exports": [
|
3315
|
+
{
|
3316
|
+
"kind": "js",
|
3317
|
+
"name": "NameMixin",
|
3318
|
+
"declaration": {
|
3319
|
+
"name": "NameMixin",
|
3320
|
+
"module": "utils/mixins/NameMixin.js"
|
3321
|
+
}
|
3322
|
+
}
|
3323
|
+
]
|
3324
|
+
},
|
3325
|
+
{
|
3326
|
+
"kind": "javascript-module",
|
3327
|
+
"path": "utils/mixins/ReadonlyMixin.js",
|
3328
|
+
"declarations": [
|
3329
|
+
{
|
3330
|
+
"kind": "mixin",
|
3331
|
+
"description": "",
|
3332
|
+
"name": "ReadonlyMixin",
|
3333
|
+
"members": [
|
3334
|
+
{
|
3335
|
+
"kind": "field",
|
3336
|
+
"name": "readonly",
|
3337
|
+
"type": {
|
3338
|
+
"text": "boolean"
|
3339
|
+
},
|
3340
|
+
"default": "false",
|
3341
|
+
"description": "Indicates whether the component is readonly.\nWhen the component is readonly, it is not editable.",
|
3342
|
+
"attribute": "readonly",
|
3343
|
+
"reflects": true
|
3344
|
+
}
|
3345
|
+
],
|
3346
|
+
"attributes": [
|
3347
|
+
{
|
3348
|
+
"name": "readonly",
|
3349
|
+
"type": {
|
3350
|
+
"text": "boolean"
|
3351
|
+
},
|
3352
|
+
"default": "false",
|
3353
|
+
"description": "Indicates whether the component is readonly.\nWhen the component is readonly, it is not editable.",
|
3354
|
+
"fieldName": "readonly"
|
3355
|
+
}
|
3356
|
+
],
|
3357
|
+
"parameters": [
|
3358
|
+
{
|
3359
|
+
"name": "superClass",
|
3360
|
+
"type": {
|
3361
|
+
"text": "T"
|
3362
|
+
}
|
3363
|
+
}
|
3364
|
+
]
|
3365
|
+
}
|
3366
|
+
],
|
3367
|
+
"exports": [
|
3368
|
+
{
|
3369
|
+
"kind": "js",
|
3370
|
+
"name": "ReadonlyMixin",
|
3371
|
+
"declaration": {
|
3372
|
+
"name": "ReadonlyMixin",
|
3373
|
+
"module": "utils/mixins/ReadonlyMixin.js"
|
3374
|
+
}
|
3375
|
+
}
|
3376
|
+
]
|
3377
|
+
},
|
3378
|
+
{
|
3379
|
+
"kind": "javascript-module",
|
3380
|
+
"path": "utils/mixins/RequiredMixin.js",
|
3381
|
+
"declarations": [
|
3382
|
+
{
|
3383
|
+
"kind": "mixin",
|
3384
|
+
"description": "",
|
3385
|
+
"name": "RequiredMixin",
|
3386
|
+
"members": [
|
3387
|
+
{
|
3388
|
+
"kind": "field",
|
3389
|
+
"name": "required",
|
3390
|
+
"type": {
|
3391
|
+
"text": "boolean"
|
3392
|
+
},
|
3393
|
+
"default": "false",
|
3394
|
+
"description": "Indicates whether the component is required.\nWhen the component is required, it is a mandatory field.",
|
3395
|
+
"attribute": "required",
|
3396
|
+
"reflects": true
|
3397
|
+
}
|
3398
|
+
],
|
3399
|
+
"attributes": [
|
3400
|
+
{
|
3401
|
+
"name": "required",
|
3402
|
+
"type": {
|
3403
|
+
"text": "boolean"
|
3404
|
+
},
|
3405
|
+
"default": "false",
|
3406
|
+
"description": "Indicates whether the component is required.\nWhen the component is required, it is a mandatory field.",
|
3407
|
+
"fieldName": "required"
|
3133
3408
|
}
|
3134
3409
|
],
|
3135
3410
|
"parameters": [
|
@@ -3145,10 +3420,10 @@
|
|
3145
3420
|
"exports": [
|
3146
3421
|
{
|
3147
3422
|
"kind": "js",
|
3148
|
-
"name": "
|
3423
|
+
"name": "RequiredMixin",
|
3149
3424
|
"declaration": {
|
3150
|
-
"name": "
|
3151
|
-
"module": "utils/mixins/
|
3425
|
+
"name": "RequiredMixin",
|
3426
|
+
"module": "utils/mixins/RequiredMixin.js"
|
3152
3427
|
}
|
3153
3428
|
}
|
3154
3429
|
]
|
@@ -3206,6 +3481,59 @@
|
|
3206
3481
|
}
|
3207
3482
|
]
|
3208
3483
|
},
|
3484
|
+
{
|
3485
|
+
"kind": "javascript-module",
|
3486
|
+
"path": "utils/mixins/ValueMixin.js",
|
3487
|
+
"declarations": [
|
3488
|
+
{
|
3489
|
+
"kind": "mixin",
|
3490
|
+
"description": "",
|
3491
|
+
"name": "ValueMixin",
|
3492
|
+
"members": [
|
3493
|
+
{
|
3494
|
+
"kind": "field",
|
3495
|
+
"name": "value",
|
3496
|
+
"type": {
|
3497
|
+
"text": "string"
|
3498
|
+
},
|
3499
|
+
"default": "''",
|
3500
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
3501
|
+
"attribute": "value",
|
3502
|
+
"reflects": true
|
3503
|
+
}
|
3504
|
+
],
|
3505
|
+
"attributes": [
|
3506
|
+
{
|
3507
|
+
"name": "value",
|
3508
|
+
"type": {
|
3509
|
+
"text": "string"
|
3510
|
+
},
|
3511
|
+
"default": "''",
|
3512
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
3513
|
+
"fieldName": "value"
|
3514
|
+
}
|
3515
|
+
],
|
3516
|
+
"parameters": [
|
3517
|
+
{
|
3518
|
+
"name": "superClass",
|
3519
|
+
"type": {
|
3520
|
+
"text": "T"
|
3521
|
+
}
|
3522
|
+
}
|
3523
|
+
]
|
3524
|
+
}
|
3525
|
+
],
|
3526
|
+
"exports": [
|
3527
|
+
{
|
3528
|
+
"kind": "js",
|
3529
|
+
"name": "ValueMixin",
|
3530
|
+
"declaration": {
|
3531
|
+
"name": "ValueMixin",
|
3532
|
+
"module": "utils/mixins/ValueMixin.js"
|
3533
|
+
}
|
3534
|
+
}
|
3535
|
+
]
|
3536
|
+
},
|
3209
3537
|
{
|
3210
3538
|
"kind": "javascript-module",
|
3211
3539
|
"path": "utils/mixins/index.types.js",
|