@momentum-design/components 0.16.0 → 0.16.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -244,797 +244,797 @@
244
244
  },
245
245
  {
246
246
  "kind": "javascript-module",
247
- "path": "components/avatarbutton/avatarbutton.component.js",
247
+ "path": "components/badge/badge.component.js",
248
248
  "declarations": [
249
249
  {
250
250
  "kind": "class",
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",
251
+ "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.",
252
+ "name": "Badge",
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 button is disabled.\nWhen the button is disabled for user interaction; it is not focusable or clickable.",
299
- "attribute": "disabled",
300
- "inheritedFrom": {
301
- "name": "Buttonsimple",
302
- "module": "components/buttonsimple/buttonsimple.component.js"
303
- }
304
- },
305
- {
306
- "kind": "field",
307
- "name": "softDisabled",
308
- "type": {
309
- "text": "boolean"
310
- },
311
- "default": "undefined as unknown",
312
- "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.",
313
- "attribute": "soft-disabled",
314
- "inheritedFrom": {
315
- "name": "Buttonsimple",
316
- "module": "components/buttonsimple/buttonsimple.component.js"
317
- }
318
- },
319
- {
320
- "kind": "field",
321
- "name": "role",
322
- "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.",
323
- "default": "'button'",
324
- "attribute": "role",
325
- "reflects": true,
326
- "type": {
327
- "text": "string"
328
- },
329
- "inheritedFrom": {
330
- "name": "Buttonsimple",
331
- "module": "components/buttonsimple/buttonsimple.component.js"
332
- }
333
- },
334
254
  {
335
255
  "kind": "field",
336
256
  "name": "type",
337
257
  "type": {
338
- "text": "ButtonType"
258
+ "text": "BadgeType | undefined"
339
259
  },
340
- "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.",
341
- "default": "button",
260
+ "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
342
261
  "attribute": "type",
343
- "reflects": true,
344
- "inheritedFrom": {
345
- "name": "Buttonsimple",
346
- "module": "components/buttonsimple/buttonsimple.component.js"
347
- }
348
- },
349
- {
350
- "kind": "field",
351
- "name": "src",
352
- "type": {
353
- "text": "string | undefined"
354
- },
355
- "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.",
356
- "attribute": "src",
357
- "inheritedFrom": {
358
- "name": "AvatarComponentMixin",
359
- "module": "utils/mixins/AvatarComponentMixin.js"
360
- }
361
- },
362
- {
363
- "kind": "field",
364
- "name": "initials",
365
- "type": {
366
- "text": "string | undefined"
367
- },
368
- "description": "The initials to be displayed for the avatar.",
369
- "attribute": "initials",
370
- "inheritedFrom": {
371
- "name": "AvatarComponentMixin",
372
- "module": "utils/mixins/AvatarComponentMixin.js"
373
- }
262
+ "reflects": true
374
263
  },
375
264
  {
376
265
  "kind": "field",
377
- "name": "presence",
266
+ "name": "iconName",
378
267
  "type": {
379
- "text": "PresenceType | undefined"
268
+ "text": "IconNames | undefined"
380
269
  },
381
- "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`",
382
- "attribute": "presence",
383
- "inheritedFrom": {
384
- "name": "AvatarComponentMixin",
385
- "module": "utils/mixins/AvatarComponentMixin.js"
386
- }
270
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
271
+ "attribute": "icon-name"
387
272
  },
388
273
  {
389
274
  "kind": "field",
390
- "name": "size",
275
+ "name": "variant",
391
276
  "type": {
392
- "text": "ButtonSize"
277
+ "text": "IconVariant"
393
278
  },
394
- "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
395
- "default": "32",
396
- "attribute": "size",
397
- "reflects": true,
398
- "inheritedFrom": {
399
- "name": "Buttonsimple",
400
- "module": "components/buttonsimple/buttonsimple.component.js"
401
- }
279
+ "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
280
+ "default": "primary",
281
+ "attribute": "variant",
282
+ "reflects": true
402
283
  },
403
284
  {
404
285
  "kind": "field",
405
- "name": "iconName",
286
+ "name": "counter",
406
287
  "type": {
407
- "text": "IconNames | undefined"
288
+ "text": "number | undefined"
408
289
  },
409
- "description": "Name of the icon to be displayed inside the Avatar.\nMust be a valid icon name.",
410
- "attribute": "icon-name",
411
- "inheritedFrom": {
412
- "name": "AvatarComponentMixin",
413
- "module": "utils/mixins/AvatarComponentMixin.js"
414
- }
290
+ "description": "Counter is the number which can be provided in the badge.",
291
+ "attribute": "counter"
415
292
  },
416
293
  {
417
294
  "kind": "field",
418
- "name": "counter",
295
+ "name": "maxCounter",
419
296
  "type": {
420
- "text": "number | undefined"
297
+ "text": "number"
421
298
  },
422
- "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`.",
423
- "attribute": "counter",
424
- "inheritedFrom": {
425
- "name": "AvatarComponentMixin",
426
- "module": "utils/mixins/AvatarComponentMixin.js"
427
- }
299
+ "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`.",
300
+ "default": "99",
301
+ "attribute": "max-counter",
302
+ "reflects": true
428
303
  },
429
304
  {
430
305
  "kind": "field",
431
- "name": "isTyping",
306
+ "name": "overlay",
432
307
  "type": {
433
308
  "text": "boolean"
434
309
  },
435
310
  "default": "false",
436
- "description": "Represents the typing indicator when the user is typing.",
437
- "attribute": "is-typing",
438
- "inheritedFrom": {
439
- "name": "AvatarComponentMixin",
440
- "module": "utils/mixins/AvatarComponentMixin.js"
441
- }
311
+ "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.",
312
+ "attribute": "overlay"
442
313
  },
443
314
  {
444
315
  "kind": "field",
445
- "name": "tabIndex",
316
+ "name": "ariaLabel",
446
317
  "type": {
447
- "text": "number"
318
+ "text": "string | null"
448
319
  },
449
- "default": "0",
450
- "description": "The tabindex of the button.",
451
- "attribute": "tabIndex",
452
- "reflects": true,
453
- "inheritedFrom": {
454
- "name": "Buttonsimple",
455
- "module": "components/buttonsimple/buttonsimple.component.js"
456
- }
457
- },
458
- {
459
- "kind": "method",
460
- "name": "executeAction",
461
- "privacy": "private",
462
- "inheritedFrom": {
463
- "name": "Buttonsimple",
464
- "module": "components/buttonsimple/buttonsimple.component.js"
465
- }
320
+ "default": "null",
321
+ "description": "Aria-label attribute to be set for accessibility",
322
+ "attribute": "aria-label"
466
323
  },
467
324
  {
468
325
  "kind": "method",
469
- "name": "setAriaPressed",
326
+ "name": "getCounterText",
470
327
  "privacy": "private",
328
+ "return": {
329
+ "type": {
330
+ "text": ""
331
+ }
332
+ },
471
333
  "parameters": [
472
334
  {
473
- "name": "element",
335
+ "name": "maxCounter",
474
336
  "type": {
475
- "text": "HTMLElement"
337
+ "text": "number"
476
338
  },
477
- "description": "The target element."
339
+ "description": "the maximum limit which can be displayed on the badge"
478
340
  },
479
341
  {
480
- "name": "active",
342
+ "name": "counter",
343
+ "optional": true,
481
344
  "type": {
482
- "text": "boolean"
345
+ "text": "number"
483
346
  },
484
- "description": "The active state."
347
+ "description": "the number to be displayed on the badge"
485
348
  }
486
349
  ],
487
- "description": "Sets the aria-pressed attribute based on the active state.",
488
- "inheritedFrom": {
489
- "name": "Buttonsimple",
490
- "module": "components/buttonsimple/buttonsimple.component.js"
491
- }
350
+ "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."
492
351
  },
493
352
  {
494
353
  "kind": "method",
495
- "name": "setSoftDisabled",
354
+ "name": "getBadgeIcon",
496
355
  "privacy": "private",
356
+ "return": {
357
+ "type": {
358
+ "text": ""
359
+ }
360
+ },
497
361
  "parameters": [
498
362
  {
499
- "name": "element",
363
+ "name": "iconName",
500
364
  "type": {
501
- "text": "HTMLElement"
365
+ "text": "string"
502
366
  },
503
- "description": "The button element."
367
+ "description": "the name of the icon from the icon set"
504
368
  },
505
369
  {
506
- "name": "softDisabled",
370
+ "name": "backgroundClassPostfix",
507
371
  "type": {
508
- "text": "boolean"
372
+ "text": "string"
509
373
  },
510
- "description": "The soft-disabled state."
374
+ "description": "postfix for the class to style the badge icon."
511
375
  }
512
376
  ],
513
- "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.",
514
- "inheritedFrom": {
515
- "name": "Buttonsimple",
516
- "module": "components/buttonsimple/buttonsimple.component.js"
517
- }
377
+ "description": "Method to generate the badge icon."
518
378
  },
519
379
  {
520
380
  "kind": "method",
521
- "name": "setDisabled",
381
+ "name": "getBadgeDot",
522
382
  "privacy": "private",
523
- "parameters": [
524
- {
525
- "name": "element",
526
- "type": {
527
- "text": "HTMLElement"
528
- },
529
- "description": "The button element."
530
- },
531
- {
532
- "name": "disabled",
533
- "type": {
534
- "text": "boolean"
535
- },
536
- "description": "The disabled state."
383
+ "return": {
384
+ "type": {
385
+ "text": ""
537
386
  }
538
- ],
539
- "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.",
540
- "inheritedFrom": {
541
- "name": "Buttonsimple",
542
- "module": "components/buttonsimple/buttonsimple.component.js"
543
- }
387
+ },
388
+ "description": "Method to generate the badge dot template."
544
389
  },
545
390
  {
546
391
  "kind": "method",
547
- "name": "triggerClickEvent",
392
+ "name": "getBadgeCounterText",
548
393
  "privacy": "private",
549
- "inheritedFrom": {
550
- "name": "Buttonsimple",
551
- "module": "components/buttonsimple/buttonsimple.component.js"
552
- }
394
+ "return": {
395
+ "type": {
396
+ "text": ""
397
+ }
398
+ },
399
+ "description": "Method to generate the badge text and counter template."
553
400
  },
554
401
  {
555
402
  "kind": "method",
556
- "name": "handleKeyDown",
403
+ "name": "setRoleByAriaLabel",
557
404
  "privacy": "private",
558
- "parameters": [
559
- {
560
- "name": "event",
561
- "type": {
562
- "text": "KeyboardEvent"
563
- },
564
- "description": "The keyboard event."
405
+ "return": {
406
+ "type": {
407
+ "text": "void"
565
408
  }
566
- ],
567
- "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.",
568
- "inheritedFrom": {
569
- "name": "Buttonsimple",
570
- "module": "components/buttonsimple/buttonsimple.component.js"
571
- }
409
+ },
410
+ "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."
572
411
  },
573
412
  {
574
413
  "kind": "method",
575
- "name": "handleKeyUp",
414
+ "name": "getBadgeContentBasedOnType",
576
415
  "privacy": "private",
577
- "parameters": [
578
- {
579
- "name": "event",
580
- "type": {
581
- "text": "KeyboardEvent"
582
- },
583
- "description": "The keyboard event."
416
+ "return": {
417
+ "type": {
418
+ "text": ""
584
419
  }
585
- ],
586
- "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.",
587
- "inheritedFrom": {
588
- "name": "Buttonsimple",
589
- "module": "components/buttonsimple/buttonsimple.component.js"
590
- }
420
+ },
421
+ "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."
591
422
  }
592
423
  ],
593
424
  "attributes": [
594
425
  {
595
- "name": "aria-label",
426
+ "name": "type",
596
427
  "type": {
597
- "text": "string | null"
428
+ "text": "BadgeType | undefined"
598
429
  },
599
- "default": "null",
600
- "description": "Aria-label attribute to be set for accessibility",
601
- "fieldName": "ariaLabel"
430
+ "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
431
+ "fieldName": "type"
602
432
  },
603
433
  {
604
- "name": "src",
434
+ "name": "icon-name",
605
435
  "type": {
606
- "text": "string | undefined"
436
+ "text": "IconNames | undefined"
607
437
  },
608
- "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.",
609
- "fieldName": "src",
610
- "inheritedFrom": {
611
- "name": "AvatarComponentMixin",
612
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
613
- }
438
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
439
+ "fieldName": "iconName"
614
440
  },
615
441
  {
616
- "name": "initials",
442
+ "name": "variant",
617
443
  "type": {
618
- "text": "string | undefined"
444
+ "text": "IconVariant"
619
445
  },
620
- "description": "The initials to be displayed for the avatar.",
621
- "fieldName": "initials",
622
- "inheritedFrom": {
623
- "name": "AvatarComponentMixin",
624
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
625
- }
446
+ "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
447
+ "default": "primary",
448
+ "fieldName": "variant"
626
449
  },
627
450
  {
628
- "name": "presence",
451
+ "name": "counter",
629
452
  "type": {
630
- "text": "PresenceType | undefined"
453
+ "text": "number | undefined"
631
454
  },
632
- "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`",
633
- "fieldName": "presence",
634
- "inheritedFrom": {
635
- "name": "AvatarComponentMixin",
636
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
637
- }
455
+ "description": "Counter is the number which can be provided in the badge.",
456
+ "fieldName": "counter"
638
457
  },
639
458
  {
640
- "name": "size",
459
+ "name": "max-counter",
641
460
  "type": {
642
- "text": "ButtonSize"
461
+ "text": "number"
643
462
  },
644
- "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
645
- "default": "32",
646
- "fieldName": "size",
647
- "inheritedFrom": {
648
- "name": "Buttonsimple",
649
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
650
- }
463
+ "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`.",
464
+ "default": "99",
465
+ "fieldName": "maxCounter"
651
466
  },
652
467
  {
653
- "name": "icon-name",
468
+ "name": "overlay",
654
469
  "type": {
655
- "text": "IconNames | undefined"
470
+ "text": "boolean"
656
471
  },
657
- "description": "Name of the icon to be displayed inside the Avatar.\nMust be a valid icon name.",
658
- "fieldName": "iconName",
659
- "inheritedFrom": {
660
- "name": "AvatarComponentMixin",
661
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
662
- }
472
+ "default": "false",
473
+ "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.",
474
+ "fieldName": "overlay"
663
475
  },
664
476
  {
665
- "name": "counter",
477
+ "name": "aria-label",
666
478
  "type": {
667
- "text": "number | undefined"
479
+ "text": "string | null"
668
480
  },
669
- "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`.",
670
- "fieldName": "counter",
671
- "inheritedFrom": {
672
- "name": "AvatarComponentMixin",
673
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
674
- }
675
- },
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": [
676
515
  {
677
- "name": "is-typing",
516
+ "kind": "field",
517
+ "name": "ariaLabel",
678
518
  "type": {
679
- "text": "boolean"
519
+ "text": "string | null"
680
520
  },
681
- "default": "false",
682
- "description": "Represents the typing indicator when the user is typing.",
683
- "fieldName": "isTyping",
684
- "inheritedFrom": {
685
- "name": "AvatarComponentMixin",
686
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
687
- }
521
+ "default": "null",
522
+ "description": "Aria-label attribute to be set for accessibility",
523
+ "attribute": "aria-label"
524
+ },
525
+ {
526
+ "kind": "method",
527
+ "name": "setSize",
528
+ "privacy": "private",
529
+ "parameters": [
530
+ {
531
+ "name": "size",
532
+ "type": {
533
+ "text": "AvatarSize"
534
+ }
535
+ }
536
+ ]
688
537
  },
689
538
  {
539
+ "kind": "field",
690
540
  "name": "active",
691
541
  "type": {
692
542
  "text": "boolean"
693
543
  },
694
- "default": "false",
544
+ "default": "undefined as unknown",
695
545
  "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.",
696
- "fieldName": "active",
546
+ "attribute": "active",
697
547
  "inheritedFrom": {
698
548
  "name": "Buttonsimple",
699
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
549
+ "module": "components/buttonsimple/buttonsimple.component.js"
700
550
  }
701
551
  },
702
552
  {
553
+ "kind": "field",
703
554
  "name": "disabled",
704
555
  "type": {
705
556
  "text": "boolean"
706
557
  },
707
- "default": "false",
558
+ "default": "undefined as unknown",
708
559
  "description": "Indicates whether the button is disabled.\nWhen the button is disabled for user interaction; it is not focusable or clickable.",
709
- "fieldName": "disabled",
560
+ "attribute": "disabled",
710
561
  "inheritedFrom": {
711
562
  "name": "Buttonsimple",
712
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
563
+ "module": "components/buttonsimple/buttonsimple.component.js"
713
564
  }
714
565
  },
715
566
  {
716
- "name": "soft-disabled",
567
+ "kind": "field",
568
+ "name": "softDisabled",
717
569
  "type": {
718
570
  "text": "boolean"
719
571
  },
720
- "default": "false",
572
+ "default": "undefined as unknown",
721
573
  "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.",
722
- "fieldName": "softDisabled",
574
+ "attribute": "soft-disabled",
723
575
  "inheritedFrom": {
724
576
  "name": "Buttonsimple",
725
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
726
- }
727
- },
728
- {
729
- "name": "tabIndex",
730
- "type": {
731
- "text": "number"
732
- },
733
- "default": "0",
734
- "description": "The tabindex of the button.",
735
- "fieldName": "tabIndex",
736
- "inheritedFrom": {
737
- "name": "Buttonsimple",
738
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
577
+ "module": "components/buttonsimple/buttonsimple.component.js"
739
578
  }
740
579
  },
741
580
  {
581
+ "kind": "field",
742
582
  "name": "role",
743
583
  "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.",
744
- "default": "button",
745
- "fieldName": "role",
584
+ "default": "'button'",
585
+ "attribute": "role",
586
+ "reflects": true,
587
+ "type": {
588
+ "text": "string"
589
+ },
746
590
  "inheritedFrom": {
747
591
  "name": "Buttonsimple",
748
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
592
+ "module": "components/buttonsimple/buttonsimple.component.js"
749
593
  }
750
594
  },
751
595
  {
596
+ "kind": "field",
752
597
  "name": "type",
753
598
  "type": {
754
599
  "text": "ButtonType"
755
600
  },
756
601
  "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.",
757
602
  "default": "button",
758
- "fieldName": "type",
603
+ "attribute": "type",
604
+ "reflects": true,
759
605
  "inheritedFrom": {
760
606
  "name": "Buttonsimple",
761
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
607
+ "module": "components/buttonsimple/buttonsimple.component.js"
762
608
  }
763
- }
764
- ],
765
- "mixins": [
609
+ },
766
610
  {
767
- "name": "AvatarComponentMixin",
768
- "module": "/src/utils/mixins/AvatarComponentMixin"
769
- }
770
- ],
771
- "superclass": {
772
- "name": "Buttonsimple",
773
- "module": "/src/components/buttonsimple"
774
- },
775
- "tagName": "mdc-avatarbutton",
776
- "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 */",
777
- "customElement": true
778
- }
779
- ],
780
- "exports": [
781
- {
782
- "kind": "js",
783
- "name": "default",
784
- "declaration": {
785
- "name": "AvatarButton",
786
- "module": "components/avatarbutton/avatarbutton.component.js"
787
- }
788
- }
789
- ]
790
- },
791
- {
792
- "kind": "javascript-module",
793
- "path": "components/badge/badge.component.js",
794
- "declarations": [
795
- {
796
- "kind": "class",
797
- "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.",
798
- "name": "Badge",
799
- "members": [
611
+ "kind": "field",
612
+ "name": "src",
613
+ "type": {
614
+ "text": "string | undefined"
615
+ },
616
+ "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.",
617
+ "attribute": "src",
618
+ "inheritedFrom": {
619
+ "name": "AvatarComponentMixin",
620
+ "module": "utils/mixins/AvatarComponentMixin.js"
621
+ }
622
+ },
800
623
  {
801
624
  "kind": "field",
802
- "name": "type",
625
+ "name": "initials",
803
626
  "type": {
804
- "text": "BadgeType | undefined"
627
+ "text": "string | undefined"
805
628
  },
806
- "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
807
- "attribute": "type",
808
- "reflects": true
629
+ "description": "The initials to be displayed for the avatar.",
630
+ "attribute": "initials",
631
+ "inheritedFrom": {
632
+ "name": "AvatarComponentMixin",
633
+ "module": "utils/mixins/AvatarComponentMixin.js"
634
+ }
809
635
  },
810
636
  {
811
637
  "kind": "field",
812
- "name": "iconName",
638
+ "name": "presence",
813
639
  "type": {
814
- "text": "IconNames | undefined"
640
+ "text": "PresenceType | undefined"
815
641
  },
816
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
817
- "attribute": "icon-name"
642
+ "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`",
643
+ "attribute": "presence",
644
+ "inheritedFrom": {
645
+ "name": "AvatarComponentMixin",
646
+ "module": "utils/mixins/AvatarComponentMixin.js"
647
+ }
818
648
  },
819
649
  {
820
650
  "kind": "field",
821
- "name": "variant",
651
+ "name": "size",
822
652
  "type": {
823
- "text": "IconVariant"
653
+ "text": "ButtonSize"
824
654
  },
825
- "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
826
- "default": "primary",
827
- "attribute": "variant",
828
- "reflects": true
655
+ "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
656
+ "default": "32",
657
+ "attribute": "size",
658
+ "reflects": true,
659
+ "inheritedFrom": {
660
+ "name": "Buttonsimple",
661
+ "module": "components/buttonsimple/buttonsimple.component.js"
662
+ }
829
663
  },
830
664
  {
831
665
  "kind": "field",
832
- "name": "counter",
666
+ "name": "iconName",
833
667
  "type": {
834
- "text": "number | undefined"
668
+ "text": "IconNames | undefined"
835
669
  },
836
- "description": "Counter is the number which can be provided in the badge.",
837
- "attribute": "counter"
670
+ "description": "Name of the icon to be displayed inside the Avatar.\nMust be a valid icon name.",
671
+ "attribute": "icon-name",
672
+ "inheritedFrom": {
673
+ "name": "AvatarComponentMixin",
674
+ "module": "utils/mixins/AvatarComponentMixin.js"
675
+ }
838
676
  },
839
677
  {
840
678
  "kind": "field",
841
- "name": "maxCounter",
679
+ "name": "counter",
842
680
  "type": {
843
- "text": "number"
681
+ "text": "number | undefined"
844
682
  },
845
- "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`.",
846
- "default": "99",
847
- "attribute": "max-counter",
848
- "reflects": true
683
+ "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`.",
684
+ "attribute": "counter",
685
+ "inheritedFrom": {
686
+ "name": "AvatarComponentMixin",
687
+ "module": "utils/mixins/AvatarComponentMixin.js"
688
+ }
849
689
  },
850
690
  {
851
691
  "kind": "field",
852
- "name": "overlay",
692
+ "name": "isTyping",
853
693
  "type": {
854
694
  "text": "boolean"
855
695
  },
856
696
  "default": "false",
857
- "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.",
858
- "attribute": "overlay"
697
+ "description": "Represents the typing indicator when the user is typing.",
698
+ "attribute": "is-typing",
699
+ "inheritedFrom": {
700
+ "name": "AvatarComponentMixin",
701
+ "module": "utils/mixins/AvatarComponentMixin.js"
702
+ }
859
703
  },
860
704
  {
861
705
  "kind": "field",
862
- "name": "ariaLabel",
706
+ "name": "tabIndex",
863
707
  "type": {
864
- "text": "string | null"
708
+ "text": "number"
865
709
  },
866
- "default": "null",
867
- "description": "Aria-label attribute to be set for accessibility",
868
- "attribute": "aria-label"
710
+ "default": "0",
711
+ "description": "The tabindex of the button.",
712
+ "attribute": "tabIndex",
713
+ "reflects": true,
714
+ "inheritedFrom": {
715
+ "name": "Buttonsimple",
716
+ "module": "components/buttonsimple/buttonsimple.component.js"
717
+ }
869
718
  },
870
719
  {
871
720
  "kind": "method",
872
- "name": "getCounterText",
721
+ "name": "executeAction",
722
+ "privacy": "private",
723
+ "inheritedFrom": {
724
+ "name": "Buttonsimple",
725
+ "module": "components/buttonsimple/buttonsimple.component.js"
726
+ }
727
+ },
728
+ {
729
+ "kind": "method",
730
+ "name": "setAriaPressed",
873
731
  "privacy": "private",
874
- "return": {
875
- "type": {
876
- "text": ""
877
- }
878
- },
879
732
  "parameters": [
880
733
  {
881
- "name": "maxCounter",
734
+ "name": "element",
882
735
  "type": {
883
- "text": "number"
736
+ "text": "HTMLElement"
884
737
  },
885
- "description": "the maximum limit which can be displayed on the badge"
738
+ "description": "The target element."
886
739
  },
887
740
  {
888
- "name": "counter",
889
- "optional": true,
741
+ "name": "active",
890
742
  "type": {
891
- "text": "number"
743
+ "text": "boolean"
892
744
  },
893
- "description": "the number to be displayed on the badge"
745
+ "description": "The active state."
894
746
  }
895
747
  ],
896
- "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."
748
+ "description": "Sets the aria-pressed attribute based on the active state.",
749
+ "inheritedFrom": {
750
+ "name": "Buttonsimple",
751
+ "module": "components/buttonsimple/buttonsimple.component.js"
752
+ }
897
753
  },
898
754
  {
899
755
  "kind": "method",
900
- "name": "getBadgeIcon",
756
+ "name": "setSoftDisabled",
901
757
  "privacy": "private",
902
- "return": {
903
- "type": {
904
- "text": ""
758
+ "parameters": [
759
+ {
760
+ "name": "element",
761
+ "type": {
762
+ "text": "HTMLElement"
763
+ },
764
+ "description": "The button element."
765
+ },
766
+ {
767
+ "name": "softDisabled",
768
+ "type": {
769
+ "text": "boolean"
770
+ },
771
+ "description": "The soft-disabled state."
905
772
  }
906
- },
773
+ ],
774
+ "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.",
775
+ "inheritedFrom": {
776
+ "name": "Buttonsimple",
777
+ "module": "components/buttonsimple/buttonsimple.component.js"
778
+ }
779
+ },
780
+ {
781
+ "kind": "method",
782
+ "name": "setDisabled",
783
+ "privacy": "private",
907
784
  "parameters": [
908
785
  {
909
- "name": "iconName",
786
+ "name": "element",
910
787
  "type": {
911
- "text": "string"
788
+ "text": "HTMLElement"
912
789
  },
913
- "description": "the name of the icon from the icon set"
790
+ "description": "The button element."
914
791
  },
915
792
  {
916
- "name": "backgroundClassPostfix",
793
+ "name": "disabled",
794
+ "type": {
795
+ "text": "boolean"
796
+ },
797
+ "description": "The disabled state."
798
+ }
799
+ ],
800
+ "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.",
801
+ "inheritedFrom": {
802
+ "name": "Buttonsimple",
803
+ "module": "components/buttonsimple/buttonsimple.component.js"
804
+ }
805
+ },
806
+ {
807
+ "kind": "method",
808
+ "name": "triggerClickEvent",
809
+ "privacy": "private",
810
+ "inheritedFrom": {
811
+ "name": "Buttonsimple",
812
+ "module": "components/buttonsimple/buttonsimple.component.js"
813
+ }
814
+ },
815
+ {
816
+ "kind": "method",
817
+ "name": "handleKeyDown",
818
+ "privacy": "private",
819
+ "parameters": [
820
+ {
821
+ "name": "event",
822
+ "type": {
823
+ "text": "KeyboardEvent"
824
+ },
825
+ "description": "The keyboard event."
826
+ }
827
+ ],
828
+ "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.",
829
+ "inheritedFrom": {
830
+ "name": "Buttonsimple",
831
+ "module": "components/buttonsimple/buttonsimple.component.js"
832
+ }
833
+ },
834
+ {
835
+ "kind": "method",
836
+ "name": "handleKeyUp",
837
+ "privacy": "private",
838
+ "parameters": [
839
+ {
840
+ "name": "event",
917
841
  "type": {
918
- "text": "string"
842
+ "text": "KeyboardEvent"
919
843
  },
920
- "description": "postfix for the class to style the badge icon."
844
+ "description": "The keyboard event."
921
845
  }
922
846
  ],
923
- "description": "Method to generate the badge icon."
924
- },
847
+ "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.",
848
+ "inheritedFrom": {
849
+ "name": "Buttonsimple",
850
+ "module": "components/buttonsimple/buttonsimple.component.js"
851
+ }
852
+ }
853
+ ],
854
+ "attributes": [
925
855
  {
926
- "kind": "method",
927
- "name": "getBadgeDot",
928
- "privacy": "private",
929
- "return": {
930
- "type": {
931
- "text": ""
932
- }
856
+ "name": "aria-label",
857
+ "type": {
858
+ "text": "string | null"
933
859
  },
934
- "description": "Method to generate the badge dot template."
860
+ "default": "null",
861
+ "description": "Aria-label attribute to be set for accessibility",
862
+ "fieldName": "ariaLabel"
935
863
  },
936
864
  {
937
- "kind": "method",
938
- "name": "getBadgeCounterText",
939
- "privacy": "private",
940
- "return": {
941
- "type": {
942
- "text": ""
943
- }
865
+ "name": "src",
866
+ "type": {
867
+ "text": "string | undefined"
944
868
  },
945
- "description": "Method to generate the badge text and counter template."
869
+ "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.",
870
+ "fieldName": "src",
871
+ "inheritedFrom": {
872
+ "name": "AvatarComponentMixin",
873
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
874
+ }
946
875
  },
947
876
  {
948
- "kind": "method",
949
- "name": "setRoleByAriaLabel",
950
- "privacy": "private",
951
- "return": {
952
- "type": {
953
- "text": "void"
954
- }
877
+ "name": "initials",
878
+ "type": {
879
+ "text": "string | undefined"
955
880
  },
956
- "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."
881
+ "description": "The initials to be displayed for the avatar.",
882
+ "fieldName": "initials",
883
+ "inheritedFrom": {
884
+ "name": "AvatarComponentMixin",
885
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
886
+ }
957
887
  },
958
888
  {
959
- "kind": "method",
960
- "name": "getBadgeContentBasedOnType",
961
- "privacy": "private",
962
- "return": {
963
- "type": {
964
- "text": ""
965
- }
889
+ "name": "presence",
890
+ "type": {
891
+ "text": "PresenceType | undefined"
966
892
  },
967
- "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."
968
- }
969
- ],
970
- "attributes": [
893
+ "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`",
894
+ "fieldName": "presence",
895
+ "inheritedFrom": {
896
+ "name": "AvatarComponentMixin",
897
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
898
+ }
899
+ },
971
900
  {
972
- "name": "type",
901
+ "name": "size",
973
902
  "type": {
974
- "text": "BadgeType | undefined"
903
+ "text": "ButtonSize"
975
904
  },
976
- "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
977
- "fieldName": "type"
905
+ "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
906
+ "default": "32",
907
+ "fieldName": "size",
908
+ "inheritedFrom": {
909
+ "name": "Buttonsimple",
910
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
911
+ }
978
912
  },
979
913
  {
980
914
  "name": "icon-name",
981
915
  "type": {
982
916
  "text": "IconNames | undefined"
983
917
  },
984
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
985
- "fieldName": "iconName"
918
+ "description": "Name of the icon to be displayed inside the Avatar.\nMust be a valid icon name.",
919
+ "fieldName": "iconName",
920
+ "inheritedFrom": {
921
+ "name": "AvatarComponentMixin",
922
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
923
+ }
986
924
  },
987
925
  {
988
- "name": "variant",
926
+ "name": "counter",
989
927
  "type": {
990
- "text": "IconVariant"
928
+ "text": "number | undefined"
991
929
  },
992
- "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
993
- "default": "primary",
994
- "fieldName": "variant"
930
+ "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`.",
931
+ "fieldName": "counter",
932
+ "inheritedFrom": {
933
+ "name": "AvatarComponentMixin",
934
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
935
+ }
995
936
  },
996
937
  {
997
- "name": "counter",
938
+ "name": "is-typing",
998
939
  "type": {
999
- "text": "number | undefined"
940
+ "text": "boolean"
1000
941
  },
1001
- "description": "Counter is the number which can be provided in the badge.",
1002
- "fieldName": "counter"
942
+ "default": "false",
943
+ "description": "Represents the typing indicator when the user is typing.",
944
+ "fieldName": "isTyping",
945
+ "inheritedFrom": {
946
+ "name": "AvatarComponentMixin",
947
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
948
+ }
1003
949
  },
1004
950
  {
1005
- "name": "max-counter",
951
+ "name": "active",
1006
952
  "type": {
1007
- "text": "number"
953
+ "text": "boolean"
1008
954
  },
1009
- "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`.",
1010
- "default": "99",
1011
- "fieldName": "maxCounter"
955
+ "default": "false",
956
+ "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.",
957
+ "fieldName": "active",
958
+ "inheritedFrom": {
959
+ "name": "Buttonsimple",
960
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
961
+ }
1012
962
  },
1013
963
  {
1014
- "name": "overlay",
964
+ "name": "disabled",
1015
965
  "type": {
1016
966
  "text": "boolean"
1017
967
  },
1018
968
  "default": "false",
1019
- "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.",
1020
- "fieldName": "overlay"
969
+ "description": "Indicates whether the button is disabled.\nWhen the button is disabled for user interaction; it is not focusable or clickable.",
970
+ "fieldName": "disabled",
971
+ "inheritedFrom": {
972
+ "name": "Buttonsimple",
973
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
974
+ }
1021
975
  },
1022
976
  {
1023
- "name": "aria-label",
977
+ "name": "soft-disabled",
1024
978
  "type": {
1025
- "text": "string | null"
979
+ "text": "boolean"
1026
980
  },
1027
- "default": "null",
1028
- "description": "Aria-label attribute to be set for accessibility",
1029
- "fieldName": "ariaLabel"
981
+ "default": "false",
982
+ "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.",
983
+ "fieldName": "softDisabled",
984
+ "inheritedFrom": {
985
+ "name": "Buttonsimple",
986
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
987
+ }
988
+ },
989
+ {
990
+ "name": "tabIndex",
991
+ "type": {
992
+ "text": "number"
993
+ },
994
+ "default": "0",
995
+ "description": "The tabindex of the button.",
996
+ "fieldName": "tabIndex",
997
+ "inheritedFrom": {
998
+ "name": "Buttonsimple",
999
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1000
+ }
1001
+ },
1002
+ {
1003
+ "name": "role",
1004
+ "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.",
1005
+ "default": "button",
1006
+ "fieldName": "role",
1007
+ "inheritedFrom": {
1008
+ "name": "Buttonsimple",
1009
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1010
+ }
1011
+ },
1012
+ {
1013
+ "name": "type",
1014
+ "type": {
1015
+ "text": "ButtonType"
1016
+ },
1017
+ "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.",
1018
+ "default": "button",
1019
+ "fieldName": "type",
1020
+ "inheritedFrom": {
1021
+ "name": "Buttonsimple",
1022
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1023
+ }
1024
+ }
1025
+ ],
1026
+ "mixins": [
1027
+ {
1028
+ "name": "AvatarComponentMixin",
1029
+ "module": "/src/utils/mixins/AvatarComponentMixin"
1030
1030
  }
1031
1031
  ],
1032
1032
  "superclass": {
1033
- "name": "Component",
1034
- "module": "/src/models"
1033
+ "name": "Buttonsimple",
1034
+ "module": "/src/components/buttonsimple"
1035
1035
  },
1036
- "tagName": "mdc-badge",
1037
- "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 */",
1036
+ "tagName": "mdc-avatarbutton",
1037
+ "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 */",
1038
1038
  "customElement": true
1039
1039
  }
1040
1040
  ],
@@ -1043,8 +1043,8 @@
1043
1043
  "kind": "js",
1044
1044
  "name": "default",
1045
1045
  "declaration": {
1046
- "name": "Badge",
1047
- "module": "components/badge/badge.component.js"
1046
+ "name": "AvatarButton",
1047
+ "module": "components/avatarbutton/avatarbutton.component.js"
1048
1048
  }
1049
1049
  }
1050
1050
  ]
@@ -2222,12 +2222,52 @@
2222
2222
  "privacy": "private",
2223
2223
  "default": "new AbortController()"
2224
2224
  },
2225
+ {
2226
+ "kind": "method",
2227
+ "name": "triggerIconLoaded",
2228
+ "privacy": "private",
2229
+ "return": {
2230
+ "type": {
2231
+ "text": "void"
2232
+ }
2233
+ },
2234
+ "description": "Dispatches a 'load' event on the component once the icon has been successfully loaded.\nThis event bubbles and is cancelable."
2235
+ },
2225
2236
  {
2226
2237
  "kind": "method",
2227
2238
  "name": "getIconData",
2228
2239
  "privacy": "private",
2229
2240
  "description": "Get Icon Data function which will fetch the icon (currently only svg)\nand sets state and attributes once fetched successfully\n\nThis method uses abortController.signal to cancel the fetch request when the component is disconnected or updated.\nIf the request is aborted after the fetch() call has been fulfilled but before the response body has been read,\nthen attempting to read the response body will reject with an AbortError exception."
2230
2241
  },
2242
+ {
2243
+ "kind": "method",
2244
+ "name": "handleIconLoadedSuccess",
2245
+ "privacy": "private",
2246
+ "parameters": [
2247
+ {
2248
+ "name": "iconHtml",
2249
+ "type": {
2250
+ "text": "HTMLElement"
2251
+ },
2252
+ "description": "The icon html element which has been fetched from the icon provider."
2253
+ }
2254
+ ],
2255
+ "description": "Sets the iconData state to the fetched icon,\nand calls functions to set role, aria-label and aria-hidden attributes on the icon.\nDispatches a 'load' event on the component once the icon has been successfully loaded."
2256
+ },
2257
+ {
2258
+ "kind": "method",
2259
+ "name": "handleIconLoadedFailure",
2260
+ "privacy": "private",
2261
+ "parameters": [
2262
+ {
2263
+ "name": "error",
2264
+ "type": {
2265
+ "text": "unknown"
2266
+ }
2267
+ }
2268
+ ],
2269
+ "description": "Dispatches an 'error' event on the component when the icon fetching has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
2270
+ },
2231
2271
  {
2232
2272
  "kind": "method",
2233
2273
  "name": "updateSize",