@momentum-design/components 0.36.0 → 0.36.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/dist/browser/index.js +187 -133
  2. package/dist/browser/index.js.map +4 -4
  3. package/dist/components/listitem/listitem.component.d.ts +3 -2
  4. package/dist/components/listitem/listitem.component.js +1 -1
  5. package/dist/components/listitem/listitem.styles.js +3 -0
  6. package/dist/components/optgroup/index.d.ts +8 -0
  7. package/dist/components/optgroup/index.js +5 -0
  8. package/dist/components/optgroup/optgroup.component.d.ts +28 -0
  9. package/dist/components/optgroup/optgroup.component.js +77 -0
  10. package/dist/components/optgroup/optgroup.constants.d.ts +3 -0
  11. package/dist/components/optgroup/optgroup.constants.js +4 -0
  12. package/dist/components/optgroup/optgroup.styles.d.ts +2 -0
  13. package/dist/components/optgroup/optgroup.styles.js +16 -0
  14. package/dist/components/option/index.d.ts +8 -0
  15. package/dist/components/option/index.js +5 -0
  16. package/dist/components/option/option.component.d.ts +46 -0
  17. package/dist/components/option/option.component.js +115 -0
  18. package/dist/components/option/option.constants.d.ts +4 -0
  19. package/dist/components/option/option.constants.js +4 -0
  20. package/dist/components/option/option.styles.d.ts +2 -0
  21. package/dist/components/option/option.styles.js +10 -0
  22. package/dist/components/popover/popover.component.js +2 -2
  23. package/dist/custom-elements.json +2195 -1307
  24. package/dist/index.d.ts +3 -1
  25. package/dist/index.js +3 -1
  26. package/dist/react/index.d.ts +3 -1
  27. package/dist/react/index.js +3 -1
  28. package/dist/react/optgroup/index.d.ts +14 -0
  29. package/dist/react/optgroup/index.js +23 -0
  30. package/dist/react/option/index.d.ts +21 -0
  31. package/dist/react/option/index.js +30 -0
  32. package/package.json +1 -1
@@ -248,79 +248,163 @@
248
248
  },
249
249
  {
250
250
  "kind": "javascript-module",
251
- "path": "components/badge/badge.component.js",
251
+ "path": "components/avatarbutton/avatarbutton.component.js",
252
252
  "declarations": [
253
253
  {
254
254
  "kind": "class",
255
- "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.",
256
- "name": "Badge",
257
- "cssProperties": [
258
- {
259
- "description": "The foreground color of the primary badge.",
260
- "name": "--mdc-badge-primary-foreground-color"
261
- },
255
+ "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.",
256
+ "name": "AvatarButton",
257
+ "members": [
262
258
  {
263
- "description": "The background color of the primary badge.",
264
- "name": "--mdc-badge-primary-background-color"
259
+ "kind": "field",
260
+ "name": "ariaLabel",
261
+ "type": {
262
+ "text": "string | null"
263
+ },
264
+ "default": "null",
265
+ "description": "Aria-label attribute to be set for accessibility",
266
+ "attribute": "aria-label"
265
267
  },
266
268
  {
267
- "description": "The foreground color of the secondary badge.",
268
- "name": "--mdc-badge-secondary-foreground-color"
269
+ "kind": "method",
270
+ "name": "setSize",
271
+ "privacy": "private",
272
+ "parameters": [
273
+ {
274
+ "name": "size",
275
+ "type": {
276
+ "text": "AvatarSize"
277
+ }
278
+ }
279
+ ]
269
280
  },
270
281
  {
271
- "description": "The background color of the secondary badge.",
272
- "name": "--mdc-badge-secondary-background-color"
282
+ "kind": "field",
283
+ "name": "active",
284
+ "type": {
285
+ "text": "boolean"
286
+ },
287
+ "default": "undefined as unknown",
288
+ "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.",
289
+ "attribute": "active",
290
+ "reflects": true,
291
+ "inheritedFrom": {
292
+ "name": "Buttonsimple",
293
+ "module": "components/buttonsimple/buttonsimple.component.js"
294
+ }
273
295
  },
274
296
  {
275
- "description": "The foreground color of the success badge.",
276
- "name": "--mdc-badge-success-foreground-color"
297
+ "kind": "field",
298
+ "name": "disabled",
299
+ "type": {
300
+ "text": "boolean"
301
+ },
302
+ "default": "undefined as unknown",
303
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
304
+ "attribute": "disabled",
305
+ "reflects": true,
306
+ "inheritedFrom": {
307
+ "name": "DisabledMixin",
308
+ "module": "utils/mixins/DisabledMixin.js"
309
+ }
277
310
  },
278
311
  {
279
- "description": "The background color of the success badge.",
280
- "name": "--mdc-badge-success-background-color"
312
+ "kind": "field",
313
+ "name": "softDisabled",
314
+ "type": {
315
+ "text": "boolean"
316
+ },
317
+ "default": "undefined as unknown",
318
+ "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.",
319
+ "attribute": "soft-disabled",
320
+ "inheritedFrom": {
321
+ "name": "Buttonsimple",
322
+ "module": "components/buttonsimple/buttonsimple.component.js"
323
+ }
281
324
  },
282
325
  {
283
- "description": "The foreground color of the warning badge.",
284
- "name": "--mdc-badge-warning-foreground-color"
326
+ "kind": "field",
327
+ "name": "role",
328
+ "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.",
329
+ "default": "'button'",
330
+ "attribute": "role",
331
+ "reflects": true,
332
+ "type": {
333
+ "text": "string"
334
+ },
335
+ "inheritedFrom": {
336
+ "name": "Buttonsimple",
337
+ "module": "components/buttonsimple/buttonsimple.component.js"
338
+ }
285
339
  },
286
340
  {
287
- "description": "The background color of the warning badge.",
288
- "name": "--mdc-badge-warning-background-color"
341
+ "kind": "field",
342
+ "name": "type",
343
+ "type": {
344
+ "text": "ButtonType"
345
+ },
346
+ "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.",
347
+ "default": "button",
348
+ "attribute": "type",
349
+ "reflects": true,
350
+ "inheritedFrom": {
351
+ "name": "Buttonsimple",
352
+ "module": "components/buttonsimple/buttonsimple.component.js"
353
+ }
289
354
  },
290
355
  {
291
- "description": "The foreground color of the error badge.",
292
- "name": "--mdc-badge-error-foreground-color"
356
+ "kind": "field",
357
+ "name": "src",
358
+ "type": {
359
+ "text": "string | undefined"
360
+ },
361
+ "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.",
362
+ "attribute": "src",
363
+ "inheritedFrom": {
364
+ "name": "AvatarComponentMixin",
365
+ "module": "utils/mixins/AvatarComponentMixin.js"
366
+ }
293
367
  },
294
368
  {
295
- "description": "The background color of the error badge.",
296
- "name": "--mdc-badge-error-background-color"
369
+ "kind": "field",
370
+ "name": "initials",
371
+ "type": {
372
+ "text": "string | undefined"
373
+ },
374
+ "description": "The initials to be displayed for the avatar.",
375
+ "attribute": "initials",
376
+ "inheritedFrom": {
377
+ "name": "AvatarComponentMixin",
378
+ "module": "utils/mixins/AvatarComponentMixin.js"
379
+ }
297
380
  },
298
- {
299
- "description": "The background color of the badge overlay.",
300
- "name": "--mdc-badge-overlay-background-color"
301
- }
302
- ],
303
- "members": [
304
381
  {
305
382
  "kind": "field",
306
- "name": "type",
383
+ "name": "presence",
307
384
  "type": {
308
- "text": "BadgeType | undefined"
385
+ "text": "PresenceType | undefined"
309
386
  },
310
- "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
311
- "attribute": "type",
312
- "reflects": true
387
+ "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`",
388
+ "attribute": "presence",
389
+ "inheritedFrom": {
390
+ "name": "AvatarComponentMixin",
391
+ "module": "utils/mixins/AvatarComponentMixin.js"
392
+ }
313
393
  },
314
394
  {
315
395
  "kind": "field",
316
- "name": "variant",
396
+ "name": "size",
317
397
  "type": {
318
- "text": "IconVariant"
398
+ "text": "ButtonSize"
319
399
  },
320
- "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
321
- "default": "primary",
322
- "attribute": "variant",
323
- "reflects": true
400
+ "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
401
+ "default": "32",
402
+ "attribute": "size",
403
+ "reflects": true,
404
+ "inheritedFrom": {
405
+ "name": "Buttonsimple",
406
+ "module": "components/buttonsimple/buttonsimple.component.js"
407
+ }
324
408
  },
325
409
  {
326
410
  "kind": "field",
@@ -328,205 +412,325 @@
328
412
  "type": {
329
413
  "text": "number | undefined"
330
414
  },
331
- "description": "Counter is the number which can be provided in the badge.",
332
- "attribute": "counter"
415
+ "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`.",
416
+ "attribute": "counter",
417
+ "inheritedFrom": {
418
+ "name": "AvatarComponentMixin",
419
+ "module": "utils/mixins/AvatarComponentMixin.js"
420
+ }
333
421
  },
334
422
  {
335
423
  "kind": "field",
336
- "name": "maxCounter",
424
+ "name": "isTyping",
337
425
  "type": {
338
- "text": "number"
426
+ "text": "boolean"
339
427
  },
340
- "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`.",
341
- "default": "99",
342
- "attribute": "max-counter",
343
- "reflects": true
428
+ "default": "false",
429
+ "description": "Represents the typing indicator when the user is typing.",
430
+ "attribute": "is-typing",
431
+ "inheritedFrom": {
432
+ "name": "AvatarComponentMixin",
433
+ "module": "utils/mixins/AvatarComponentMixin.js"
434
+ }
344
435
  },
345
436
  {
346
437
  "kind": "field",
347
- "name": "overlay",
438
+ "name": "iconName",
348
439
  "type": {
349
- "text": "boolean"
440
+ "text": "IconNames | undefined"
350
441
  },
351
- "default": "false",
352
- "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.",
353
- "attribute": "overlay"
442
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
443
+ "attribute": "icon-name",
444
+ "inheritedFrom": {
445
+ "name": "IconNameMixin",
446
+ "module": "utils/mixins/IconNameMixin.js"
447
+ }
354
448
  },
355
449
  {
356
450
  "kind": "field",
357
- "name": "ariaLabel",
451
+ "name": "tabIndex",
358
452
  "type": {
359
- "text": "string | null"
453
+ "text": "number"
360
454
  },
361
- "default": "null",
362
- "description": "Aria-label attribute to be set for accessibility",
363
- "attribute": "aria-label"
455
+ "default": "0",
456
+ "description": "This property specifies the tab order of the element.",
457
+ "attribute": "tabIndex",
458
+ "reflects": true,
459
+ "inheritedFrom": {
460
+ "name": "TabIndexMixin",
461
+ "module": "utils/mixins/TabIndexMixin.js"
462
+ }
364
463
  },
365
464
  {
366
465
  "kind": "method",
367
- "name": "getCounterText",
368
- "privacy": "private",
369
- "return": {
370
- "type": {
371
- "text": ""
372
- }
373
- },
466
+ "name": "executeAction",
467
+ "privacy": "protected",
468
+ "inheritedFrom": {
469
+ "name": "Buttonsimple",
470
+ "module": "components/buttonsimple/buttonsimple.component.js"
471
+ }
472
+ },
473
+ {
474
+ "kind": "method",
475
+ "name": "setActive",
476
+ "privacy": "protected",
374
477
  "parameters": [
375
478
  {
376
- "name": "maxCounter",
479
+ "name": "element",
377
480
  "type": {
378
- "text": "number"
481
+ "text": "HTMLElement"
379
482
  },
380
- "description": "the maximum limit which can be displayed on the badge"
483
+ "description": "The button element"
381
484
  },
382
485
  {
383
- "name": "counter",
384
- "optional": true,
486
+ "name": "active",
385
487
  "type": {
386
- "text": "number"
488
+ "text": "boolean"
387
489
  },
388
- "description": "the number to be displayed on the badge"
490
+ "description": "The active state of the element"
389
491
  }
390
492
  ],
391
- "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."
392
- },
393
- {
394
- "kind": "method",
395
- "name": "getBadgeIcon",
493
+ "description": "Sets the aria-pressed attribute based on the active state of the button.",
494
+ "inheritedFrom": {
495
+ "name": "Buttonsimple",
496
+ "module": "components/buttonsimple/buttonsimple.component.js"
497
+ }
498
+ },
499
+ {
500
+ "kind": "method",
501
+ "name": "setSoftDisabled",
396
502
  "privacy": "private",
397
- "return": {
398
- "type": {
399
- "text": ""
400
- }
401
- },
402
503
  "parameters": [
403
504
  {
404
- "name": "iconName",
505
+ "name": "element",
405
506
  "type": {
406
- "text": "string"
507
+ "text": "HTMLElement"
407
508
  },
408
- "description": "the name of the icon from the icon set"
509
+ "description": "The button element."
409
510
  },
410
511
  {
411
- "name": "backgroundClassPostfix",
512
+ "name": "softDisabled",
412
513
  "type": {
413
- "text": "string"
514
+ "text": "boolean"
414
515
  },
415
- "description": "postfix for the class to style the badge icon."
516
+ "description": "The soft-disabled state."
416
517
  }
417
518
  ],
418
- "description": "Method to generate the badge icon."
519
+ "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.",
520
+ "inheritedFrom": {
521
+ "name": "Buttonsimple",
522
+ "module": "components/buttonsimple/buttonsimple.component.js"
523
+ }
419
524
  },
420
525
  {
421
526
  "kind": "method",
422
- "name": "getBadgeDot",
527
+ "name": "setDisabled",
423
528
  "privacy": "private",
424
- "return": {
425
- "type": {
426
- "text": ""
529
+ "parameters": [
530
+ {
531
+ "name": "element",
532
+ "type": {
533
+ "text": "HTMLElement"
534
+ },
535
+ "description": "The button element."
536
+ },
537
+ {
538
+ "name": "disabled",
539
+ "type": {
540
+ "text": "boolean"
541
+ },
542
+ "description": "The disabled state."
427
543
  }
428
- },
429
- "description": "Method to generate the badge dot template."
544
+ ],
545
+ "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.",
546
+ "inheritedFrom": {
547
+ "name": "Buttonsimple",
548
+ "module": "components/buttonsimple/buttonsimple.component.js"
549
+ }
430
550
  },
431
551
  {
432
552
  "kind": "method",
433
- "name": "getBadgeCounterText",
553
+ "name": "triggerClickEvent",
434
554
  "privacy": "private",
435
- "return": {
436
- "type": {
437
- "text": ""
438
- }
439
- },
440
- "description": "Method to generate the badge text and counter template."
555
+ "inheritedFrom": {
556
+ "name": "Buttonsimple",
557
+ "module": "components/buttonsimple/buttonsimple.component.js"
558
+ }
441
559
  },
442
560
  {
443
561
  "kind": "method",
444
- "name": "setRoleByAriaLabel",
562
+ "name": "handleBlur",
445
563
  "privacy": "private",
446
- "return": {
447
- "type": {
448
- "text": "void"
564
+ "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
565
+ "inheritedFrom": {
566
+ "name": "Buttonsimple",
567
+ "module": "components/buttonsimple/buttonsimple.component.js"
568
+ }
569
+ },
570
+ {
571
+ "kind": "method",
572
+ "name": "handleKeyDown",
573
+ "privacy": "private",
574
+ "parameters": [
575
+ {
576
+ "name": "event",
577
+ "type": {
578
+ "text": "KeyboardEvent"
579
+ },
580
+ "description": "The keyboard event."
449
581
  }
450
- },
451
- "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."
582
+ ],
583
+ "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.",
584
+ "inheritedFrom": {
585
+ "name": "Buttonsimple",
586
+ "module": "components/buttonsimple/buttonsimple.component.js"
587
+ }
452
588
  },
453
589
  {
454
590
  "kind": "method",
455
- "name": "getBadgeContentBasedOnType",
591
+ "name": "handleKeyUp",
456
592
  "privacy": "private",
457
- "return": {
458
- "type": {
459
- "text": ""
593
+ "parameters": [
594
+ {
595
+ "name": "event",
596
+ "type": {
597
+ "text": "KeyboardEvent"
598
+ },
599
+ "description": "The keyboard event."
460
600
  }
461
- },
462
- "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."
601
+ ],
602
+ "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.",
603
+ "inheritedFrom": {
604
+ "name": "Buttonsimple",
605
+ "module": "components/buttonsimple/buttonsimple.component.js"
606
+ }
607
+ }
608
+ ],
609
+ "events": [
610
+ {
611
+ "description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
612
+ "name": "click",
613
+ "reactName": "onClick",
614
+ "eventName": "ClickEvent",
615
+ "inheritedFrom": {
616
+ "name": "Buttonsimple",
617
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
618
+ }
463
619
  },
464
620
  {
465
- "kind": "field",
466
- "name": "iconName",
467
- "type": {
468
- "text": "IconNames | undefined"
469
- },
470
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
471
- "attribute": "icon-name",
621
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
622
+ "name": "keydown",
623
+ "reactName": "onKeyDown",
624
+ "eventName": "KeydownEvent",
472
625
  "inheritedFrom": {
473
- "name": "IconNameMixin",
474
- "module": "utils/mixins/IconNameMixin.js"
626
+ "name": "Buttonsimple",
627
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
628
+ }
629
+ },
630
+ {
631
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
632
+ "name": "keyup",
633
+ "reactName": "onKeyUp",
634
+ "eventName": "KeyupEvent",
635
+ "inheritedFrom": {
636
+ "name": "Buttonsimple",
637
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
638
+ }
639
+ },
640
+ {
641
+ "description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
642
+ "name": "focus",
643
+ "reactName": "onFocus",
644
+ "eventName": "FocusEvent",
645
+ "inheritedFrom": {
646
+ "name": "Buttonsimple",
647
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
475
648
  }
476
649
  }
477
650
  ],
478
651
  "attributes": [
479
652
  {
480
- "name": "type",
653
+ "name": "aria-label",
481
654
  "type": {
482
- "text": "BadgeType | undefined"
655
+ "text": "string | null"
483
656
  },
484
- "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
485
- "fieldName": "type"
657
+ "default": "null",
658
+ "description": "Aria-label attribute to be set for accessibility",
659
+ "fieldName": "ariaLabel"
486
660
  },
487
661
  {
488
- "name": "variant",
662
+ "name": "src",
489
663
  "type": {
490
- "text": "IconVariant"
664
+ "text": "string | undefined"
491
665
  },
492
- "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
493
- "default": "primary",
494
- "fieldName": "variant"
666
+ "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.",
667
+ "fieldName": "src",
668
+ "inheritedFrom": {
669
+ "name": "AvatarComponentMixin",
670
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
671
+ }
495
672
  },
496
673
  {
497
- "name": "counter",
674
+ "name": "initials",
498
675
  "type": {
499
- "text": "number | undefined"
676
+ "text": "string | undefined"
500
677
  },
501
- "description": "Counter is the number which can be provided in the badge.",
502
- "fieldName": "counter"
678
+ "description": "The initials to be displayed for the avatar.",
679
+ "fieldName": "initials",
680
+ "inheritedFrom": {
681
+ "name": "AvatarComponentMixin",
682
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
683
+ }
503
684
  },
504
685
  {
505
- "name": "max-counter",
686
+ "name": "presence",
506
687
  "type": {
507
- "text": "number"
688
+ "text": "PresenceType | undefined"
508
689
  },
509
- "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`.",
510
- "default": "99",
511
- "fieldName": "maxCounter"
690
+ "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`",
691
+ "fieldName": "presence",
692
+ "inheritedFrom": {
693
+ "name": "AvatarComponentMixin",
694
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
695
+ }
512
696
  },
513
697
  {
514
- "name": "overlay",
698
+ "name": "size",
515
699
  "type": {
516
- "text": "boolean"
700
+ "text": "ButtonSize"
517
701
  },
518
- "default": "false",
519
- "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.",
520
- "fieldName": "overlay"
702
+ "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
703
+ "default": "32",
704
+ "fieldName": "size",
705
+ "inheritedFrom": {
706
+ "name": "Buttonsimple",
707
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
708
+ }
521
709
  },
522
710
  {
523
- "name": "aria-label",
711
+ "name": "counter",
524
712
  "type": {
525
- "text": "string | null"
713
+ "text": "number | undefined"
526
714
  },
527
- "default": "null",
528
- "description": "Aria-label attribute to be set for accessibility",
529
- "fieldName": "ariaLabel"
715
+ "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`.",
716
+ "fieldName": "counter",
717
+ "inheritedFrom": {
718
+ "name": "AvatarComponentMixin",
719
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
720
+ }
721
+ },
722
+ {
723
+ "name": "is-typing",
724
+ "type": {
725
+ "text": "boolean"
726
+ },
727
+ "default": "false",
728
+ "description": "Represents the typing indicator when the user is typing.",
729
+ "fieldName": "isTyping",
730
+ "inheritedFrom": {
731
+ "name": "AvatarComponentMixin",
732
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
733
+ }
530
734
  },
531
735
  {
532
736
  "name": "icon-name",
@@ -539,193 +743,188 @@
539
743
  "name": "IconNameMixin",
540
744
  "module": "src/utils/mixins/IconNameMixin.ts"
541
745
  }
542
- }
543
- ],
544
- "mixins": [
545
- {
546
- "name": "IconNameMixin",
547
- "module": "/src/utils/mixins/IconNameMixin"
548
- }
549
- ],
550
- "superclass": {
551
- "name": "Component",
552
- "module": "/src/models"
553
- },
554
- "tagName": "mdc-badge",
555
- "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 *\n * @cssproperty --mdc-badge-primary-foreground-color - The foreground color of the primary badge.\n * @cssproperty --mdc-badge-primary-background-color - The background color of the primary badge.\n * @cssproperty --mdc-badge-secondary-foreground-color - The foreground color of the secondary badge.\n * @cssproperty --mdc-badge-secondary-background-color - The background color of the secondary badge.\n * @cssproperty --mdc-badge-success-foreground-color - The foreground color of the success badge.\n * @cssproperty --mdc-badge-success-background-color - The background color of the success badge.\n * @cssproperty --mdc-badge-warning-foreground-color - The foreground color of the warning badge.\n * @cssproperty --mdc-badge-warning-background-color - The background color of the warning badge.\n * @cssproperty --mdc-badge-error-foreground-color - The foreground color of the error badge.\n * @cssproperty --mdc-badge-error-background-color - The background color of the error badge.\n * @cssproperty --mdc-badge-overlay-background-color - The background color of the badge overlay.\n */",
556
- "customElement": true
557
- }
558
- ],
559
- "exports": [
560
- {
561
- "kind": "js",
562
- "name": "default",
563
- "declaration": {
564
- "name": "Badge",
565
- "module": "components/badge/badge.component.js"
566
- }
567
- }
568
- ]
569
- },
570
- {
571
- "kind": "javascript-module",
572
- "path": "components/avatarbutton/avatarbutton.component.js",
573
- "declarations": [
574
- {
575
- "kind": "class",
576
- "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.",
577
- "name": "AvatarButton",
578
- "members": [
746
+ },
579
747
  {
580
- "kind": "field",
581
- "name": "ariaLabel",
748
+ "name": "tabIndex",
582
749
  "type": {
583
- "text": "string | null"
750
+ "text": "number"
584
751
  },
585
- "default": "null",
586
- "description": "Aria-label attribute to be set for accessibility",
587
- "attribute": "aria-label"
588
- },
589
- {
590
- "kind": "method",
591
- "name": "setSize",
592
- "privacy": "private",
593
- "parameters": [
594
- {
595
- "name": "size",
596
- "type": {
597
- "text": "AvatarSize"
598
- }
599
- }
600
- ]
752
+ "default": "0",
753
+ "description": "This property specifies the tab order of the element.",
754
+ "fieldName": "tabIndex",
755
+ "inheritedFrom": {
756
+ "name": "TabIndexMixin",
757
+ "module": "src/utils/mixins/TabIndexMixin.ts"
758
+ }
601
759
  },
602
760
  {
603
- "kind": "field",
604
- "name": "active",
761
+ "name": "disabled",
605
762
  "type": {
606
763
  "text": "boolean"
607
764
  },
608
- "default": "undefined as unknown",
609
- "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.",
610
- "attribute": "active",
611
- "reflects": true,
765
+ "default": "false",
766
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
767
+ "fieldName": "disabled",
612
768
  "inheritedFrom": {
613
- "name": "Buttonsimple",
614
- "module": "components/buttonsimple/buttonsimple.component.js"
769
+ "name": "DisabledMixin",
770
+ "module": "src/utils/mixins/DisabledMixin.ts"
615
771
  }
616
772
  },
617
773
  {
618
- "kind": "field",
619
- "name": "disabled",
774
+ "name": "active",
620
775
  "type": {
621
776
  "text": "boolean"
622
777
  },
623
- "default": "undefined as unknown",
624
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
625
- "attribute": "disabled",
626
- "reflects": true,
778
+ "default": "false",
779
+ "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.",
780
+ "fieldName": "active",
627
781
  "inheritedFrom": {
628
- "name": "DisabledMixin",
629
- "module": "utils/mixins/DisabledMixin.js"
782
+ "name": "Buttonsimple",
783
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
630
784
  }
631
785
  },
632
786
  {
633
- "kind": "field",
634
- "name": "softDisabled",
787
+ "name": "soft-disabled",
635
788
  "type": {
636
789
  "text": "boolean"
637
790
  },
638
- "default": "undefined as unknown",
791
+ "default": "false",
639
792
  "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.",
640
- "attribute": "soft-disabled",
793
+ "fieldName": "softDisabled",
641
794
  "inheritedFrom": {
642
795
  "name": "Buttonsimple",
643
- "module": "components/buttonsimple/buttonsimple.component.js"
796
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
644
797
  }
645
798
  },
646
799
  {
647
- "kind": "field",
648
800
  "name": "role",
649
801
  "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.",
650
- "default": "'button'",
651
- "attribute": "role",
652
- "reflects": true,
653
- "type": {
654
- "text": "string"
655
- },
802
+ "default": "button",
803
+ "fieldName": "role",
656
804
  "inheritedFrom": {
657
805
  "name": "Buttonsimple",
658
- "module": "components/buttonsimple/buttonsimple.component.js"
806
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
659
807
  }
660
808
  },
661
809
  {
662
- "kind": "field",
663
810
  "name": "type",
664
811
  "type": {
665
812
  "text": "ButtonType"
666
813
  },
667
814
  "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.",
668
815
  "default": "button",
669
- "attribute": "type",
670
- "reflects": true,
816
+ "fieldName": "type",
671
817
  "inheritedFrom": {
672
818
  "name": "Buttonsimple",
673
- "module": "components/buttonsimple/buttonsimple.component.js"
819
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
674
820
  }
821
+ }
822
+ ],
823
+ "mixins": [
824
+ {
825
+ "name": "AvatarComponentMixin",
826
+ "module": "/src/utils/mixins/AvatarComponentMixin"
675
827
  },
676
828
  {
677
- "kind": "field",
678
- "name": "src",
679
- "type": {
680
- "text": "string | undefined"
681
- },
682
- "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.",
683
- "attribute": "src",
684
- "inheritedFrom": {
685
- "name": "AvatarComponentMixin",
686
- "module": "utils/mixins/AvatarComponentMixin.js"
687
- }
829
+ "name": "IconNameMixin",
830
+ "module": "/src/utils/mixins/IconNameMixin"
831
+ }
832
+ ],
833
+ "superclass": {
834
+ "name": "Buttonsimple",
835
+ "module": "/src/components/buttonsimple/buttonsimple.component"
836
+ },
837
+ "tagName": "mdc-avatarbutton",
838
+ "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 * @event click - (React: onClick) This event is dispatched when the avatarbutton is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.\n * @event focus - (React: onFocus) This event is dispatched when the avatarbutton receives focus.\n *\n * @tagname mdc-avatarbutton\n */",
839
+ "customElement": true
840
+ }
841
+ ],
842
+ "exports": [
843
+ {
844
+ "kind": "js",
845
+ "name": "default",
846
+ "declaration": {
847
+ "name": "AvatarButton",
848
+ "module": "components/avatarbutton/avatarbutton.component.js"
849
+ }
850
+ }
851
+ ]
852
+ },
853
+ {
854
+ "kind": "javascript-module",
855
+ "path": "components/badge/badge.component.js",
856
+ "declarations": [
857
+ {
858
+ "kind": "class",
859
+ "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.",
860
+ "name": "Badge",
861
+ "cssProperties": [
862
+ {
863
+ "description": "The foreground color of the primary badge.",
864
+ "name": "--mdc-badge-primary-foreground-color"
688
865
  },
689
866
  {
690
- "kind": "field",
691
- "name": "initials",
692
- "type": {
693
- "text": "string | undefined"
694
- },
695
- "description": "The initials to be displayed for the avatar.",
696
- "attribute": "initials",
697
- "inheritedFrom": {
698
- "name": "AvatarComponentMixin",
699
- "module": "utils/mixins/AvatarComponentMixin.js"
700
- }
867
+ "description": "The background color of the primary badge.",
868
+ "name": "--mdc-badge-primary-background-color"
869
+ },
870
+ {
871
+ "description": "The foreground color of the secondary badge.",
872
+ "name": "--mdc-badge-secondary-foreground-color"
873
+ },
874
+ {
875
+ "description": "The background color of the secondary badge.",
876
+ "name": "--mdc-badge-secondary-background-color"
877
+ },
878
+ {
879
+ "description": "The foreground color of the success badge.",
880
+ "name": "--mdc-badge-success-foreground-color"
881
+ },
882
+ {
883
+ "description": "The background color of the success badge.",
884
+ "name": "--mdc-badge-success-background-color"
885
+ },
886
+ {
887
+ "description": "The foreground color of the warning badge.",
888
+ "name": "--mdc-badge-warning-foreground-color"
889
+ },
890
+ {
891
+ "description": "The background color of the warning badge.",
892
+ "name": "--mdc-badge-warning-background-color"
893
+ },
894
+ {
895
+ "description": "The foreground color of the error badge.",
896
+ "name": "--mdc-badge-error-foreground-color"
897
+ },
898
+ {
899
+ "description": "The background color of the error badge.",
900
+ "name": "--mdc-badge-error-background-color"
701
901
  },
902
+ {
903
+ "description": "The background color of the badge overlay.",
904
+ "name": "--mdc-badge-overlay-background-color"
905
+ }
906
+ ],
907
+ "members": [
702
908
  {
703
909
  "kind": "field",
704
- "name": "presence",
910
+ "name": "type",
705
911
  "type": {
706
- "text": "PresenceType | undefined"
912
+ "text": "BadgeType | undefined"
707
913
  },
708
- "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`",
709
- "attribute": "presence",
710
- "inheritedFrom": {
711
- "name": "AvatarComponentMixin",
712
- "module": "utils/mixins/AvatarComponentMixin.js"
713
- }
914
+ "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
915
+ "attribute": "type",
916
+ "reflects": true
714
917
  },
715
918
  {
716
919
  "kind": "field",
717
- "name": "size",
920
+ "name": "variant",
718
921
  "type": {
719
- "text": "ButtonSize"
922
+ "text": "IconVariant"
720
923
  },
721
- "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
722
- "default": "32",
723
- "attribute": "size",
724
- "reflects": true,
725
- "inheritedFrom": {
726
- "name": "Buttonsimple",
727
- "module": "components/buttonsimple/buttonsimple.component.js"
728
- }
924
+ "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
925
+ "default": "primary",
926
+ "attribute": "variant",
927
+ "reflects": true
729
928
  },
730
929
  {
731
930
  "kind": "field",
@@ -733,325 +932,205 @@
733
932
  "type": {
734
933
  "text": "number | undefined"
735
934
  },
736
- "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`.",
737
- "attribute": "counter",
738
- "inheritedFrom": {
739
- "name": "AvatarComponentMixin",
740
- "module": "utils/mixins/AvatarComponentMixin.js"
741
- }
935
+ "description": "Counter is the number which can be provided in the badge.",
936
+ "attribute": "counter"
742
937
  },
743
938
  {
744
939
  "kind": "field",
745
- "name": "isTyping",
940
+ "name": "maxCounter",
746
941
  "type": {
747
- "text": "boolean"
942
+ "text": "number"
748
943
  },
749
- "default": "false",
750
- "description": "Represents the typing indicator when the user is typing.",
751
- "attribute": "is-typing",
752
- "inheritedFrom": {
753
- "name": "AvatarComponentMixin",
754
- "module": "utils/mixins/AvatarComponentMixin.js"
755
- }
944
+ "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`.",
945
+ "default": "99",
946
+ "attribute": "max-counter",
947
+ "reflects": true
756
948
  },
757
949
  {
758
950
  "kind": "field",
759
- "name": "iconName",
951
+ "name": "overlay",
760
952
  "type": {
761
- "text": "IconNames | undefined"
953
+ "text": "boolean"
762
954
  },
763
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
764
- "attribute": "icon-name",
765
- "inheritedFrom": {
766
- "name": "IconNameMixin",
767
- "module": "utils/mixins/IconNameMixin.js"
768
- }
955
+ "default": "false",
956
+ "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.",
957
+ "attribute": "overlay"
769
958
  },
770
959
  {
771
960
  "kind": "field",
772
- "name": "tabIndex",
961
+ "name": "ariaLabel",
773
962
  "type": {
774
- "text": "number"
963
+ "text": "string | null"
775
964
  },
776
- "default": "0",
777
- "description": "This property specifies the tab order of the element.",
778
- "attribute": "tabIndex",
779
- "reflects": true,
780
- "inheritedFrom": {
781
- "name": "TabIndexMixin",
782
- "module": "utils/mixins/TabIndexMixin.js"
783
- }
784
- },
785
- {
786
- "kind": "method",
787
- "name": "executeAction",
788
- "privacy": "protected",
789
- "inheritedFrom": {
790
- "name": "Buttonsimple",
791
- "module": "components/buttonsimple/buttonsimple.component.js"
792
- }
793
- },
794
- {
795
- "kind": "method",
796
- "name": "setActive",
797
- "privacy": "protected",
798
- "parameters": [
799
- {
800
- "name": "element",
801
- "type": {
802
- "text": "HTMLElement"
803
- },
804
- "description": "The button element"
805
- },
806
- {
807
- "name": "active",
808
- "type": {
809
- "text": "boolean"
810
- },
811
- "description": "The active state of the element"
812
- }
813
- ],
814
- "description": "Sets the aria-pressed attribute based on the active state of the button.",
815
- "inheritedFrom": {
816
- "name": "Buttonsimple",
817
- "module": "components/buttonsimple/buttonsimple.component.js"
818
- }
965
+ "default": "null",
966
+ "description": "Aria-label attribute to be set for accessibility",
967
+ "attribute": "aria-label"
819
968
  },
820
969
  {
821
970
  "kind": "method",
822
- "name": "setSoftDisabled",
971
+ "name": "getCounterText",
823
972
  "privacy": "private",
973
+ "return": {
974
+ "type": {
975
+ "text": ""
976
+ }
977
+ },
824
978
  "parameters": [
825
979
  {
826
- "name": "element",
980
+ "name": "maxCounter",
827
981
  "type": {
828
- "text": "HTMLElement"
982
+ "text": "number"
829
983
  },
830
- "description": "The button element."
984
+ "description": "the maximum limit which can be displayed on the badge"
831
985
  },
832
986
  {
833
- "name": "softDisabled",
987
+ "name": "counter",
988
+ "optional": true,
834
989
  "type": {
835
- "text": "boolean"
990
+ "text": "number"
836
991
  },
837
- "description": "The soft-disabled state."
992
+ "description": "the number to be displayed on the badge"
838
993
  }
839
994
  ],
840
- "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.",
841
- "inheritedFrom": {
842
- "name": "Buttonsimple",
843
- "module": "components/buttonsimple/buttonsimple.component.js"
844
- }
995
+ "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."
845
996
  },
846
997
  {
847
998
  "kind": "method",
848
- "name": "setDisabled",
999
+ "name": "getBadgeIcon",
849
1000
  "privacy": "private",
1001
+ "return": {
1002
+ "type": {
1003
+ "text": ""
1004
+ }
1005
+ },
850
1006
  "parameters": [
851
1007
  {
852
- "name": "element",
1008
+ "name": "iconName",
853
1009
  "type": {
854
- "text": "HTMLElement"
1010
+ "text": "string"
855
1011
  },
856
- "description": "The button element."
1012
+ "description": "the name of the icon from the icon set"
857
1013
  },
858
1014
  {
859
- "name": "disabled",
1015
+ "name": "backgroundClassPostfix",
860
1016
  "type": {
861
- "text": "boolean"
1017
+ "text": "string"
862
1018
  },
863
- "description": "The disabled state."
1019
+ "description": "postfix for the class to style the badge icon."
864
1020
  }
865
1021
  ],
866
- "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.",
867
- "inheritedFrom": {
868
- "name": "Buttonsimple",
869
- "module": "components/buttonsimple/buttonsimple.component.js"
870
- }
1022
+ "description": "Method to generate the badge icon."
871
1023
  },
872
1024
  {
873
1025
  "kind": "method",
874
- "name": "triggerClickEvent",
1026
+ "name": "getBadgeDot",
875
1027
  "privacy": "private",
876
- "inheritedFrom": {
877
- "name": "Buttonsimple",
878
- "module": "components/buttonsimple/buttonsimple.component.js"
879
- }
1028
+ "return": {
1029
+ "type": {
1030
+ "text": ""
1031
+ }
1032
+ },
1033
+ "description": "Method to generate the badge dot template."
880
1034
  },
881
1035
  {
882
1036
  "kind": "method",
883
- "name": "handleBlur",
1037
+ "name": "getBadgeCounterText",
884
1038
  "privacy": "private",
885
- "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
886
- "inheritedFrom": {
887
- "name": "Buttonsimple",
888
- "module": "components/buttonsimple/buttonsimple.component.js"
889
- }
1039
+ "return": {
1040
+ "type": {
1041
+ "text": ""
1042
+ }
1043
+ },
1044
+ "description": "Method to generate the badge text and counter template."
890
1045
  },
891
1046
  {
892
1047
  "kind": "method",
893
- "name": "handleKeyDown",
1048
+ "name": "setRoleByAriaLabel",
894
1049
  "privacy": "private",
895
- "parameters": [
896
- {
897
- "name": "event",
898
- "type": {
899
- "text": "KeyboardEvent"
900
- },
901
- "description": "The keyboard event."
1050
+ "return": {
1051
+ "type": {
1052
+ "text": "void"
902
1053
  }
903
- ],
904
- "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.",
905
- "inheritedFrom": {
906
- "name": "Buttonsimple",
907
- "module": "components/buttonsimple/buttonsimple.component.js"
908
- }
1054
+ },
1055
+ "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."
909
1056
  },
910
1057
  {
911
1058
  "kind": "method",
912
- "name": "handleKeyUp",
1059
+ "name": "getBadgeContentBasedOnType",
913
1060
  "privacy": "private",
914
- "parameters": [
915
- {
916
- "name": "event",
917
- "type": {
918
- "text": "KeyboardEvent"
919
- },
920
- "description": "The keyboard event."
1061
+ "return": {
1062
+ "type": {
1063
+ "text": ""
921
1064
  }
922
- ],
923
- "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.",
924
- "inheritedFrom": {
925
- "name": "Buttonsimple",
926
- "module": "components/buttonsimple/buttonsimple.component.js"
927
- }
928
- }
929
- ],
930
- "events": [
931
- {
932
- "description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
933
- "name": "click",
934
- "reactName": "onClick",
935
- "eventName": "ClickEvent",
936
- "inheritedFrom": {
937
- "name": "Buttonsimple",
938
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
939
- }
940
- },
941
- {
942
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
943
- "name": "keydown",
944
- "reactName": "onKeyDown",
945
- "eventName": "KeydownEvent",
946
- "inheritedFrom": {
947
- "name": "Buttonsimple",
948
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
949
- }
950
- },
951
- {
952
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
953
- "name": "keyup",
954
- "reactName": "onKeyUp",
955
- "eventName": "KeyupEvent",
956
- "inheritedFrom": {
957
- "name": "Buttonsimple",
958
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
959
- }
1065
+ },
1066
+ "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."
960
1067
  },
961
1068
  {
962
- "description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
963
- "name": "focus",
964
- "reactName": "onFocus",
965
- "eventName": "FocusEvent",
1069
+ "kind": "field",
1070
+ "name": "iconName",
1071
+ "type": {
1072
+ "text": "IconNames | undefined"
1073
+ },
1074
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
1075
+ "attribute": "icon-name",
966
1076
  "inheritedFrom": {
967
- "name": "Buttonsimple",
968
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1077
+ "name": "IconNameMixin",
1078
+ "module": "utils/mixins/IconNameMixin.js"
969
1079
  }
970
1080
  }
971
1081
  ],
972
1082
  "attributes": [
973
1083
  {
974
- "name": "aria-label",
1084
+ "name": "type",
975
1085
  "type": {
976
- "text": "string | null"
1086
+ "text": "BadgeType | undefined"
977
1087
  },
978
- "default": "null",
979
- "description": "Aria-label attribute to be set for accessibility",
980
- "fieldName": "ariaLabel"
1088
+ "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
1089
+ "fieldName": "type"
981
1090
  },
982
1091
  {
983
- "name": "src",
984
- "type": {
985
- "text": "string | undefined"
986
- },
987
- "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.",
988
- "fieldName": "src",
989
- "inheritedFrom": {
990
- "name": "AvatarComponentMixin",
991
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
992
- }
993
- },
994
- {
995
- "name": "initials",
1092
+ "name": "variant",
996
1093
  "type": {
997
- "text": "string | undefined"
1094
+ "text": "IconVariant"
998
1095
  },
999
- "description": "The initials to be displayed for the avatar.",
1000
- "fieldName": "initials",
1001
- "inheritedFrom": {
1002
- "name": "AvatarComponentMixin",
1003
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
1004
- }
1096
+ "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
1097
+ "default": "primary",
1098
+ "fieldName": "variant"
1005
1099
  },
1006
1100
  {
1007
- "name": "presence",
1101
+ "name": "counter",
1008
1102
  "type": {
1009
- "text": "PresenceType | undefined"
1103
+ "text": "number | undefined"
1010
1104
  },
1011
- "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`",
1012
- "fieldName": "presence",
1013
- "inheritedFrom": {
1014
- "name": "AvatarComponentMixin",
1015
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
1016
- }
1105
+ "description": "Counter is the number which can be provided in the badge.",
1106
+ "fieldName": "counter"
1017
1107
  },
1018
1108
  {
1019
- "name": "size",
1109
+ "name": "max-counter",
1020
1110
  "type": {
1021
- "text": "ButtonSize"
1111
+ "text": "number"
1022
1112
  },
1023
- "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
1024
- "default": "32",
1025
- "fieldName": "size",
1026
- "inheritedFrom": {
1027
- "name": "Buttonsimple",
1028
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1029
- }
1113
+ "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`.",
1114
+ "default": "99",
1115
+ "fieldName": "maxCounter"
1030
1116
  },
1031
1117
  {
1032
- "name": "counter",
1118
+ "name": "overlay",
1033
1119
  "type": {
1034
- "text": "number | undefined"
1120
+ "text": "boolean"
1035
1121
  },
1036
- "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`.",
1037
- "fieldName": "counter",
1038
- "inheritedFrom": {
1039
- "name": "AvatarComponentMixin",
1040
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
1041
- }
1122
+ "default": "false",
1123
+ "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.",
1124
+ "fieldName": "overlay"
1042
1125
  },
1043
1126
  {
1044
- "name": "is-typing",
1127
+ "name": "aria-label",
1045
1128
  "type": {
1046
- "text": "boolean"
1129
+ "text": "string | null"
1047
1130
  },
1048
- "default": "false",
1049
- "description": "Represents the typing indicator when the user is typing.",
1050
- "fieldName": "isTyping",
1051
- "inheritedFrom": {
1052
- "name": "AvatarComponentMixin",
1053
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
1054
- }
1131
+ "default": "null",
1132
+ "description": "Aria-label attribute to be set for accessibility",
1133
+ "fieldName": "ariaLabel"
1055
1134
  },
1056
1135
  {
1057
1136
  "name": "icon-name",
@@ -1064,99 +1143,20 @@
1064
1143
  "name": "IconNameMixin",
1065
1144
  "module": "src/utils/mixins/IconNameMixin.ts"
1066
1145
  }
1067
- },
1068
- {
1069
- "name": "tabIndex",
1070
- "type": {
1071
- "text": "number"
1072
- },
1073
- "default": "0",
1074
- "description": "This property specifies the tab order of the element.",
1075
- "fieldName": "tabIndex",
1076
- "inheritedFrom": {
1077
- "name": "TabIndexMixin",
1078
- "module": "src/utils/mixins/TabIndexMixin.ts"
1079
- }
1080
- },
1081
- {
1082
- "name": "disabled",
1083
- "type": {
1084
- "text": "boolean"
1085
- },
1086
- "default": "false",
1087
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
1088
- "fieldName": "disabled",
1089
- "inheritedFrom": {
1090
- "name": "DisabledMixin",
1091
- "module": "src/utils/mixins/DisabledMixin.ts"
1092
- }
1093
- },
1094
- {
1095
- "name": "active",
1096
- "type": {
1097
- "text": "boolean"
1098
- },
1099
- "default": "false",
1100
- "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.",
1101
- "fieldName": "active",
1102
- "inheritedFrom": {
1103
- "name": "Buttonsimple",
1104
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1105
- }
1106
- },
1107
- {
1108
- "name": "soft-disabled",
1109
- "type": {
1110
- "text": "boolean"
1111
- },
1112
- "default": "false",
1113
- "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.",
1114
- "fieldName": "softDisabled",
1115
- "inheritedFrom": {
1116
- "name": "Buttonsimple",
1117
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1118
- }
1119
- },
1120
- {
1121
- "name": "role",
1122
- "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.",
1123
- "default": "button",
1124
- "fieldName": "role",
1125
- "inheritedFrom": {
1126
- "name": "Buttonsimple",
1127
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1128
- }
1129
- },
1130
- {
1131
- "name": "type",
1132
- "type": {
1133
- "text": "ButtonType"
1134
- },
1135
- "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.",
1136
- "default": "button",
1137
- "fieldName": "type",
1138
- "inheritedFrom": {
1139
- "name": "Buttonsimple",
1140
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1141
- }
1142
1146
  }
1143
1147
  ],
1144
1148
  "mixins": [
1145
- {
1146
- "name": "AvatarComponentMixin",
1147
- "module": "/src/utils/mixins/AvatarComponentMixin"
1148
- },
1149
1149
  {
1150
1150
  "name": "IconNameMixin",
1151
1151
  "module": "/src/utils/mixins/IconNameMixin"
1152
1152
  }
1153
1153
  ],
1154
1154
  "superclass": {
1155
- "name": "Buttonsimple",
1156
- "module": "/src/components/buttonsimple/buttonsimple.component"
1155
+ "name": "Component",
1156
+ "module": "/src/models"
1157
1157
  },
1158
- "tagName": "mdc-avatarbutton",
1159
- "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 * @event click - (React: onClick) This event is dispatched when the avatarbutton is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.\n * @event focus - (React: onFocus) This event is dispatched when the avatarbutton receives focus.\n *\n * @tagname mdc-avatarbutton\n */",
1158
+ "tagName": "mdc-badge",
1159
+ "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 *\n * @cssproperty --mdc-badge-primary-foreground-color - The foreground color of the primary badge.\n * @cssproperty --mdc-badge-primary-background-color - The background color of the primary badge.\n * @cssproperty --mdc-badge-secondary-foreground-color - The foreground color of the secondary badge.\n * @cssproperty --mdc-badge-secondary-background-color - The background color of the secondary badge.\n * @cssproperty --mdc-badge-success-foreground-color - The foreground color of the success badge.\n * @cssproperty --mdc-badge-success-background-color - The background color of the success badge.\n * @cssproperty --mdc-badge-warning-foreground-color - The foreground color of the warning badge.\n * @cssproperty --mdc-badge-warning-background-color - The background color of the warning badge.\n * @cssproperty --mdc-badge-error-foreground-color - The foreground color of the error badge.\n * @cssproperty --mdc-badge-error-background-color - The background color of the error badge.\n * @cssproperty --mdc-badge-overlay-background-color - The background color of the badge overlay.\n */",
1160
1160
  "customElement": true
1161
1161
  }
1162
1162
  ],
@@ -1165,8 +1165,8 @@
1165
1165
  "kind": "js",
1166
1166
  "name": "default",
1167
1167
  "declaration": {
1168
- "name": "AvatarButton",
1169
- "module": "components/avatarbutton/avatarbutton.component.js"
1168
+ "name": "Badge",
1169
+ "module": "components/badge/badge.component.js"
1170
1170
  }
1171
1171
  }
1172
1172
  ]
@@ -3432,6 +3432,7 @@
3432
3432
  "default": "''",
3433
3433
  "description": "The unique ID of the popover.",
3434
3434
  "attribute": "id",
3435
+ "reflects": true,
3435
3436
  "inheritedFrom": {
3436
3437
  "name": "Popover",
3437
3438
  "module": "components/popover/popover.component.js"
@@ -3446,6 +3447,7 @@
3446
3447
  "default": "''",
3447
3448
  "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
3448
3449
  "attribute": "triggerID",
3450
+ "reflects": true,
3449
3451
  "inheritedFrom": {
3450
3452
  "name": "Popover",
3451
3453
  "module": "components/popover/popover.component.js"
@@ -6230,157 +6232,1031 @@
6230
6232
  "type": {
6231
6233
  "text": "boolean"
6232
6234
  },
6233
- "default": "false",
6234
- "description": "readonly attribute of the input field. If true, the input field is read-only.",
6235
- "fieldName": "readonly"
6235
+ "default": "false",
6236
+ "description": "readonly attribute of the input field. If true, the input field is read-only.",
6237
+ "fieldName": "readonly"
6238
+ },
6239
+ {
6240
+ "name": "prefix-text",
6241
+ "type": {
6242
+ "text": "string | undefined"
6243
+ },
6244
+ "description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
6245
+ "fieldName": "prefixText"
6246
+ },
6247
+ {
6248
+ "name": "leading-icon",
6249
+ "type": {
6250
+ "text": "IconNames | undefined"
6251
+ },
6252
+ "description": "The leading icon that is displayed before the input field.",
6253
+ "fieldName": "leadingIcon"
6254
+ },
6255
+ {
6256
+ "name": "trailing-button",
6257
+ "type": {
6258
+ "text": "boolean"
6259
+ },
6260
+ "default": "false",
6261
+ "description": "The trailing button when set to true, shows a clear button that clears the input field.",
6262
+ "fieldName": "trailingButton"
6263
+ },
6264
+ {
6265
+ "name": "maxlength",
6266
+ "type": {
6267
+ "text": "number | undefined"
6268
+ },
6269
+ "description": "The maximum number of characters that the input field can accept.",
6270
+ "fieldName": "maxlength"
6271
+ },
6272
+ {
6273
+ "name": "minlength",
6274
+ "type": {
6275
+ "text": "number | undefined"
6276
+ },
6277
+ "description": "The minimum number of characters that the input field can accept.",
6278
+ "fieldName": "minlength"
6279
+ },
6280
+ {
6281
+ "name": "autocapitalize",
6282
+ "type": {
6283
+ "text": "AutoCapitalizeType"
6284
+ },
6285
+ "description": "The autocapitalize attribute of the input field.",
6286
+ "default": "'off'",
6287
+ "fieldName": "autocapitalize"
6288
+ },
6289
+ {
6290
+ "name": "autocomplete",
6291
+ "type": {
6292
+ "text": "any"
6293
+ },
6294
+ "default": "'off'",
6295
+ "description": "The autocomplete attribute of the input field.",
6296
+ "fieldName": "autocomplete"
6297
+ },
6298
+ {
6299
+ "name": "autofocus",
6300
+ "type": {
6301
+ "text": "boolean"
6302
+ },
6303
+ "default": "false",
6304
+ "description": "If true, the input field is focused when the component is rendered.",
6305
+ "fieldName": "autofocus"
6306
+ },
6307
+ {
6308
+ "name": "dirname",
6309
+ "type": {
6310
+ "text": "string | undefined"
6311
+ },
6312
+ "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
6313
+ "fieldName": "dirname"
6314
+ },
6315
+ {
6316
+ "name": "pattern",
6317
+ "type": {
6318
+ "text": "string | undefined"
6319
+ },
6320
+ "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
6321
+ "fieldName": "pattern"
6322
+ },
6323
+ {
6324
+ "name": "list",
6325
+ "type": {
6326
+ "text": "string | undefined"
6327
+ },
6328
+ "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
6329
+ "fieldName": "list"
6330
+ },
6331
+ {
6332
+ "name": "size",
6333
+ "type": {
6334
+ "text": "number | undefined | undefined"
6335
+ },
6336
+ "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
6337
+ "default": "undefined",
6338
+ "fieldName": "size"
6339
+ },
6340
+ {
6341
+ "name": "clear-aria-label",
6342
+ "type": {
6343
+ "text": "string"
6344
+ },
6345
+ "default": "''",
6346
+ "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
6347
+ "fieldName": "clearAriaLabel"
6348
+ },
6349
+ {
6350
+ "name": "name",
6351
+ "type": {
6352
+ "text": "string"
6353
+ },
6354
+ "default": "''",
6355
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
6356
+ "fieldName": "name",
6357
+ "inheritedFrom": {
6358
+ "name": "FormInternalsMixin",
6359
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
6360
+ }
6361
+ },
6362
+ {
6363
+ "name": "value",
6364
+ "type": {
6365
+ "text": "string"
6366
+ },
6367
+ "default": "''",
6368
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
6369
+ "fieldName": "value",
6370
+ "inheritedFrom": {
6371
+ "name": "FormInternalsMixin",
6372
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
6373
+ }
6374
+ },
6375
+ {
6376
+ "name": "validation-message",
6377
+ "type": {
6378
+ "text": "string | undefined"
6379
+ },
6380
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
6381
+ "fieldName": "validationMessage",
6382
+ "inheritedFrom": {
6383
+ "name": "FormInternalsMixin",
6384
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
6385
+ }
6386
+ },
6387
+ {
6388
+ "name": "data-aria-label",
6389
+ "type": {
6390
+ "text": "string | null"
6391
+ },
6392
+ "default": "null",
6393
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
6394
+ "fieldName": "dataAriaLabel",
6395
+ "inheritedFrom": {
6396
+ "name": "DataAriaLabelMixin",
6397
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
6398
+ }
6399
+ },
6400
+ {
6401
+ "name": "disabled",
6402
+ "type": {
6403
+ "text": "boolean"
6404
+ },
6405
+ "default": "false",
6406
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6407
+ "fieldName": "disabled",
6408
+ "inheritedFrom": {
6409
+ "name": "FormfieldWrapper",
6410
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6411
+ }
6412
+ },
6413
+ {
6414
+ "name": "label",
6415
+ "type": {
6416
+ "text": "string | undefined"
6417
+ },
6418
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
6419
+ "fieldName": "label",
6420
+ "inheritedFrom": {
6421
+ "name": "FormfieldWrapper",
6422
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6423
+ }
6424
+ },
6425
+ {
6426
+ "name": "required-label",
6427
+ "type": {
6428
+ "text": "string | undefined"
6429
+ },
6430
+ "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
6431
+ "fieldName": "requiredLabel",
6432
+ "inheritedFrom": {
6433
+ "name": "FormfieldWrapper",
6434
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6435
+ }
6436
+ },
6437
+ {
6438
+ "name": "id",
6439
+ "type": {
6440
+ "text": "string"
6441
+ },
6442
+ "default": "''",
6443
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
6444
+ "fieldName": "id",
6445
+ "inheritedFrom": {
6446
+ "name": "FormfieldWrapper",
6447
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6448
+ }
6449
+ },
6450
+ {
6451
+ "name": "help-text-type",
6452
+ "type": {
6453
+ "text": "ValidationType"
6454
+ },
6455
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
6456
+ "fieldName": "helpTextType",
6457
+ "inheritedFrom": {
6458
+ "name": "FormfieldWrapper",
6459
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6460
+ }
6461
+ },
6462
+ {
6463
+ "name": "help-text",
6464
+ "type": {
6465
+ "text": "string | undefined"
6466
+ },
6467
+ "description": "The help text that is displayed below the input field.",
6468
+ "fieldName": "helpText",
6469
+ "inheritedFrom": {
6470
+ "name": "FormfieldWrapper",
6471
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6472
+ }
6473
+ }
6474
+ ],
6475
+ "mixins": [
6476
+ {
6477
+ "name": "FormInternalsMixin",
6478
+ "module": "/src/utils/mixins/FormInternalsMixin"
6479
+ },
6480
+ {
6481
+ "name": "DataAriaLabelMixin",
6482
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
6483
+ }
6484
+ ],
6485
+ "superclass": {
6486
+ "name": "FormfieldWrapper",
6487
+ "module": "/src/components/formfieldwrapper"
6488
+ },
6489
+ "tagName": "mdc-input",
6490
+ "jsDoc": "/**\n * mdc-input is a component that allows users to input text.\n * It contains:\n * - label field - describe the input field.\n * - input field - contains the value\n * - help text or validation message - displayed below the input field.\n * - trailing button - it displays a clear the input field.\n * - prefix text - displayed before the input field.\n * - leading icon - displayed before the input field.\n * - clear-aria-label - aria label for the trailing button.\n * - all the attributes of the input field.\n *\n * @tagname mdc-input\n *\n * @event input - (React: onInput) This event is dispatched when the value of the input field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the input field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the input receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the input loses focus.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n *\n * @cssproperty --mdc-input-disabled-border-color - Border color for the input container when disabled\n * @cssproperty --mdc-input-disabled-text-color - Text color for the input field when disabled\n * @cssproperty --mdc-input-disabled-background-color - Background color for the input field when disabled\n * @cssproperty --mdc-input-border-color - Border color for the input container\n * @cssproperty --mdc-input-text-color - Text color for the input field\n * @cssproperty --mdc-input-background-color - Background color for the input field\n * @cssproperty --mdc-input-selection-background-color - Background color for the selected text\n * @cssproperty --mdc-input-selection-text-color - Text color for the selected text\n * @cssproperty --mdc-input-support-text-color - Text color for the help text\n * @cssproperty --mdc-input-hover-background-color - Background color for the input field when hovered\n * @cssproperty --mdc-input-focused-background-color - Background color for the input field when focused\n * @cssproperty --mdc-input-focused-border-color - Border color for the input container when focused\n * @cssproperty --mdc-input-error-border-color - Border color for the input container when error\n * @cssproperty --mdc-input-warning-border-color - Border color for the input container when warning\n * @cssproperty --mdc-input-success-border-color - Border color for the input container when success\n * @cssproperty --mdc-input-primary-border-color - Border color for the input container when primary\n *\n */",
6491
+ "customElement": true,
6492
+ "slots": [
6493
+ {
6494
+ "description": "slot to add the label info icon",
6495
+ "name": "label-info",
6496
+ "inheritedFrom": {
6497
+ "name": "FormfieldWrapper",
6498
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6499
+ }
6500
+ }
6501
+ ]
6502
+ }
6503
+ ],
6504
+ "exports": [
6505
+ {
6506
+ "kind": "js",
6507
+ "name": "default",
6508
+ "declaration": {
6509
+ "name": "Input",
6510
+ "module": "components/input/input.component.js"
6511
+ }
6512
+ }
6513
+ ]
6514
+ },
6515
+ {
6516
+ "kind": "javascript-module",
6517
+ "path": "components/link/link.component.js",
6518
+ "declarations": [
6519
+ {
6520
+ "kind": "class",
6521
+ "description": "`mdc-link` component can be used to navigate to a different page\nwithin the application or to an external site. It can be used to link to\nemails or phone numbers.\n\nThe `children` of the link component is expected to be an anchor element\ncontaining the text, href, and other attributes.\n\nFor `icon`, the `mdc-icon` component is used to render the icon.",
6522
+ "name": "Link",
6523
+ "cssProperties": [
6524
+ {
6525
+ "description": "Border radius of the link",
6526
+ "name": "--mdc-link-border-radius"
6527
+ },
6528
+ {
6529
+ "description": "Text and icon color of the link in active state",
6530
+ "name": "--mdc-link-color-active"
6531
+ },
6532
+ {
6533
+ "description": "Text and icon color of the link in disabled state",
6534
+ "name": "--mdc-link-color-disabled"
6535
+ },
6536
+ {
6537
+ "description": "Text and icon color of the link in hover state",
6538
+ "name": "--mdc-link-color-hover"
6539
+ },
6540
+ {
6541
+ "description": "Text and icon color of the link in normal state",
6542
+ "name": "--mdc-link-color-normal"
6543
+ },
6544
+ {
6545
+ "description": "Gap between the text and icon (only applicable when an icon is set)",
6546
+ "name": "--mdc-link-icon-margin-left"
6547
+ },
6548
+ {
6549
+ "description": "Text and icon color of the inverted link in active state",
6550
+ "name": "--mdc-link-inverted-color-active"
6551
+ },
6552
+ {
6553
+ "description": "Text and icon color of the inverted link in disabled state",
6554
+ "name": "--mdc-link-inverted-color-disabled"
6555
+ },
6556
+ {
6557
+ "description": "Text and icon color of the inverted link in hover state",
6558
+ "name": "--mdc-link-inverted-color-hover"
6559
+ },
6560
+ {
6561
+ "description": "Text and icon color of the inverted link in normal state",
6562
+ "name": "--mdc-link-inverted-color-normal"
6563
+ },
6564
+ {
6565
+ "description": "Text decoration of the link in disabled state for all variants",
6566
+ "name": "--mdc-link-text-decoration-disabled"
6567
+ }
6568
+ ],
6569
+ "members": [
6570
+ {
6571
+ "kind": "field",
6572
+ "name": "inline",
6573
+ "type": {
6574
+ "text": "boolean"
6575
+ },
6576
+ "description": "The link can be inline or standalone.",
6577
+ "default": "false",
6578
+ "attribute": "inline",
6579
+ "reflects": true
6580
+ },
6581
+ {
6582
+ "kind": "field",
6583
+ "name": "inverted",
6584
+ "type": {
6585
+ "text": "boolean"
6586
+ },
6587
+ "description": "The link color can be inverted by setting the inverted attribute to true.",
6588
+ "default": "false",
6589
+ "attribute": "inverted",
6590
+ "reflects": true
6591
+ },
6592
+ {
6593
+ "kind": "field",
6594
+ "name": "size",
6595
+ "type": {
6596
+ "text": "LinkSize"
6597
+ },
6598
+ "description": "Size of the link.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'",
6599
+ "default": "large",
6600
+ "attribute": "size",
6601
+ "reflects": true
6602
+ },
6603
+ {
6604
+ "kind": "method",
6605
+ "name": "getIconSize",
6606
+ "privacy": "private",
6607
+ "return": {
6608
+ "type": {
6609
+ "text": ""
6610
+ }
6611
+ },
6612
+ "description": "Method to get the size of the trailing icon based on the link size."
6613
+ },
6614
+ {
6615
+ "kind": "method",
6616
+ "name": "setDisabled",
6617
+ "privacy": "private",
6618
+ "parameters": [
6619
+ {
6620
+ "name": "disabled",
6621
+ "type": {
6622
+ "text": "boolean"
6623
+ },
6624
+ "description": "The disabled state of icon"
6625
+ }
6626
+ ],
6627
+ "description": "Updates the tabindex of the host element to disable or enable the link.\nWhen disabled, the link is not focusable or clickable, and tabindex is set to -1\nand aria-disabled attribute is set to true\nWhen link is not disabled, the previous tabindex of the host element is restored\nand aria-disabled attribute is removed."
6628
+ },
6629
+ {
6630
+ "kind": "method",
6631
+ "name": "updateTrailingIcon",
6632
+ "privacy": "private",
6633
+ "description": "Method to create and append trailing icon to the first anchor element in the slot.\nIf no icon name is provided, no icon will be rendered."
6634
+ },
6635
+ {
6636
+ "kind": "field",
6637
+ "name": "disabled",
6638
+ "type": {
6639
+ "text": "boolean"
6640
+ },
6641
+ "default": "false",
6642
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6643
+ "attribute": "disabled",
6644
+ "reflects": true,
6645
+ "inheritedFrom": {
6646
+ "name": "DisabledMixin",
6647
+ "module": "utils/mixins/DisabledMixin.js"
6648
+ }
6649
+ },
6650
+ {
6651
+ "kind": "field",
6652
+ "name": "iconName",
6653
+ "type": {
6654
+ "text": "IconNames | undefined"
6655
+ },
6656
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
6657
+ "attribute": "icon-name",
6658
+ "inheritedFrom": {
6659
+ "name": "IconNameMixin",
6660
+ "module": "utils/mixins/IconNameMixin.js"
6661
+ }
6662
+ }
6663
+ ],
6664
+ "attributes": [
6665
+ {
6666
+ "name": "inline",
6667
+ "type": {
6668
+ "text": "boolean"
6669
+ },
6670
+ "description": "The link can be inline or standalone.",
6671
+ "default": "false",
6672
+ "fieldName": "inline"
6673
+ },
6674
+ {
6675
+ "name": "inverted",
6676
+ "type": {
6677
+ "text": "boolean"
6678
+ },
6679
+ "description": "The link color can be inverted by setting the inverted attribute to true.",
6680
+ "default": "false",
6681
+ "fieldName": "inverted"
6682
+ },
6683
+ {
6684
+ "name": "size",
6685
+ "type": {
6686
+ "text": "LinkSize"
6687
+ },
6688
+ "description": "Size of the link.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'",
6689
+ "default": "large",
6690
+ "fieldName": "size"
6691
+ },
6692
+ {
6693
+ "name": "disabled",
6694
+ "type": {
6695
+ "text": "boolean"
6696
+ },
6697
+ "default": "false",
6698
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6699
+ "fieldName": "disabled",
6700
+ "inheritedFrom": {
6701
+ "name": "DisabledMixin",
6702
+ "module": "src/utils/mixins/DisabledMixin.ts"
6703
+ }
6704
+ },
6705
+ {
6706
+ "name": "icon-name",
6707
+ "type": {
6708
+ "text": "IconNames | undefined"
6709
+ },
6710
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
6711
+ "fieldName": "iconName",
6712
+ "inheritedFrom": {
6713
+ "name": "IconNameMixin",
6714
+ "module": "src/utils/mixins/IconNameMixin.ts"
6715
+ }
6716
+ }
6717
+ ],
6718
+ "mixins": [
6719
+ {
6720
+ "name": "DisabledMixin",
6721
+ "module": "/src/utils/mixins/DisabledMixin"
6722
+ },
6723
+ {
6724
+ "name": "IconNameMixin",
6725
+ "module": "/src/utils/mixins/IconNameMixin"
6726
+ }
6727
+ ],
6728
+ "superclass": {
6729
+ "name": "Component",
6730
+ "module": "/src/models"
6731
+ },
6732
+ "tagName": "mdc-link",
6733
+ "jsDoc": "/**\n * `mdc-link` component can be used to navigate to a different page\n * within the application or to an external site. It can be used to link to\n * emails or phone numbers.\n *\n * The `children` of the link component is expected to be an anchor element\n * containing the text, href, and other attributes.\n *\n * For `icon`, the `mdc-icon` component is used to render the icon.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-link\n *\n * @cssproperty --mdc-link-border-radius - Border radius of the link\n * @cssproperty --mdc-link-color-active - Text and icon color of the link in active state\n * @cssproperty --mdc-link-color-disabled - Text and icon color of the link in disabled state\n * @cssproperty --mdc-link-color-hover - Text and icon color of the link in hover state\n * @cssproperty --mdc-link-color-normal - Text and icon color of the link in normal state\n * @cssproperty --mdc-link-icon-margin-left - Gap between the text and icon (only applicable when an icon is set)\n * @cssproperty --mdc-link-inverted-color-active - Text and icon color of the inverted link in active state\n * @cssproperty --mdc-link-inverted-color-disabled - Text and icon color of the inverted link in disabled state\n * @cssproperty --mdc-link-inverted-color-hover - Text and icon color of the inverted link in hover state\n * @cssproperty --mdc-link-inverted-color-normal - Text and icon color of the inverted link in normal state\n * @cssproperty --mdc-link-text-decoration-disabled - Text decoration of the link in disabled state for all variants\n */",
6734
+ "customElement": true
6735
+ }
6736
+ ],
6737
+ "exports": [
6738
+ {
6739
+ "kind": "js",
6740
+ "name": "default",
6741
+ "declaration": {
6742
+ "name": "Link",
6743
+ "module": "components/link/link.component.js"
6744
+ }
6745
+ }
6746
+ ]
6747
+ },
6748
+ {
6749
+ "kind": "javascript-module",
6750
+ "path": "components/list/list.component.js",
6751
+ "declarations": [
6752
+ {
6753
+ "kind": "class",
6754
+ "description": "mdc-list component is used to display a group of list items. It is used as a container to wrap other list items.",
6755
+ "name": "List",
6756
+ "slots": [
6757
+ {
6758
+ "description": "This is a default/unnamed slot",
6759
+ "name": "default"
6760
+ }
6761
+ ],
6762
+ "members": [
6763
+ {
6764
+ "kind": "field",
6765
+ "name": "listItems",
6766
+ "type": {
6767
+ "text": "Array<HTMLElement>"
6768
+ }
6769
+ },
6770
+ {
6771
+ "kind": "field",
6772
+ "name": "headerText",
6773
+ "type": {
6774
+ "text": "string | undefined"
6775
+ },
6776
+ "description": "The header text of the list.",
6777
+ "attribute": "header-text",
6778
+ "reflects": true
6779
+ },
6780
+ {
6781
+ "kind": "method",
6782
+ "name": "handleKeyDown",
6783
+ "privacy": "private",
6784
+ "return": {
6785
+ "type": {
6786
+ "text": "void"
6787
+ }
6788
+ },
6789
+ "parameters": [
6790
+ {
6791
+ "name": "event",
6792
+ "type": {
6793
+ "text": "KeyboardEvent"
6794
+ },
6795
+ "description": "The keyboard event."
6796
+ }
6797
+ ],
6798
+ "description": "Handles the keydown event on the list element.\nIf the key is 'ArrowUp' or 'ArrowDown', it focuses to the previous or next list item\nand sets the active tabindex of the list item.\nPrevents the default event behavior."
6799
+ },
6800
+ {
6801
+ "kind": "method",
6802
+ "name": "getCurrentIndex",
6803
+ "privacy": "private",
6804
+ "return": {
6805
+ "type": {
6806
+ "text": ""
6807
+ }
6808
+ },
6809
+ "parameters": [
6810
+ {
6811
+ "name": "target",
6812
+ "type": {
6813
+ "text": "EventTarget | null"
6814
+ },
6815
+ "description": "The target element to find the index of."
6816
+ }
6817
+ ],
6818
+ "description": "Returns the index of the given target in the listItems array.\nIf the target is not a list item, but a child element of a list item,\nit returns the index of the parent list item."
6819
+ },
6820
+ {
6821
+ "kind": "method",
6822
+ "name": "getNewIndexBasedOnKey",
6823
+ "privacy": "private",
6824
+ "return": {
6825
+ "type": {
6826
+ "text": ""
6827
+ }
6828
+ },
6829
+ "parameters": [
6830
+ {
6831
+ "name": "key",
6832
+ "type": {
6833
+ "text": "string"
6834
+ },
6835
+ "description": "The key that was pressed."
6836
+ },
6837
+ {
6838
+ "name": "currentIndex",
6839
+ "type": {
6840
+ "text": "number"
6841
+ },
6842
+ "description": "The current index of the focused list item."
6843
+ },
6844
+ {
6845
+ "name": "wrappedDivsCount",
6846
+ "type": {
6847
+ "text": "number"
6848
+ },
6849
+ "description": "The total number of list items."
6850
+ }
6851
+ ],
6852
+ "description": "Calculates a new index based on the pressed keyboard key.\nSupports navigation keys for moving focus within a list."
6853
+ },
6854
+ {
6855
+ "kind": "method",
6856
+ "name": "handleMouseClick",
6857
+ "privacy": "private",
6858
+ "return": {
6859
+ "type": {
6860
+ "text": "void"
6861
+ }
6862
+ },
6863
+ "parameters": [
6864
+ {
6865
+ "name": "event",
6866
+ "type": {
6867
+ "text": "MouseEvent"
6868
+ },
6869
+ "description": "The mouse event."
6870
+ }
6871
+ ],
6872
+ "description": "Handles the mouse click event on the list element.\nFinds the index of the target element in the list items array and calls\n`resetTabIndexAndSetActiveTabIndex` with that index."
6873
+ },
6874
+ {
6875
+ "kind": "method",
6876
+ "name": "resetTabIndexAndSetActiveTabIndex",
6877
+ "privacy": "private",
6878
+ "parameters": [
6879
+ {
6880
+ "name": "newIndex",
6881
+ "type": {
6882
+ "text": "number"
6883
+ },
6884
+ "description": "The index of the new active element in the list."
6885
+ }
6886
+ ],
6887
+ "description": "Resets all list items tabindex to -1 and sets the tabindex of the\nelement at the given index to 0, effectively setting the active\nelement. This is used when navigating the list via keyboard."
6888
+ },
6889
+ {
6890
+ "kind": "field",
6891
+ "name": "dataAriaLabel",
6892
+ "type": {
6893
+ "text": "string | null"
6894
+ },
6895
+ "default": "null",
6896
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
6897
+ "attribute": "data-aria-label",
6898
+ "reflects": true,
6899
+ "inheritedFrom": {
6900
+ "name": "DataAriaLabelMixin",
6901
+ "module": "utils/mixins/DataAriaLabelMixin.js"
6902
+ }
6903
+ }
6904
+ ],
6905
+ "attributes": [
6906
+ {
6907
+ "name": "header-text",
6908
+ "type": {
6909
+ "text": "string | undefined"
6910
+ },
6911
+ "description": "The header text of the list.",
6912
+ "fieldName": "headerText"
6913
+ },
6914
+ {
6915
+ "name": "data-aria-label",
6916
+ "type": {
6917
+ "text": "string | null"
6918
+ },
6919
+ "default": "null",
6920
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
6921
+ "fieldName": "dataAriaLabel",
6922
+ "inheritedFrom": {
6923
+ "name": "DataAriaLabelMixin",
6924
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
6925
+ }
6926
+ }
6927
+ ],
6928
+ "mixins": [
6929
+ {
6930
+ "name": "DataAriaLabelMixin",
6931
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
6932
+ }
6933
+ ],
6934
+ "superclass": {
6935
+ "name": "Component",
6936
+ "module": "/src/models"
6937
+ },
6938
+ "tagName": "mdc-list",
6939
+ "jsDoc": "/**\n * mdc-list component is used to display a group of list items. It is used as a container to wrap other list items.\n *\n * @tagname mdc-list\n *\n * @dependency mdc-text\n *\n * @slot default - This is a default/unnamed slot\n */",
6940
+ "customElement": true
6941
+ }
6942
+ ],
6943
+ "exports": [
6944
+ {
6945
+ "kind": "js",
6946
+ "name": "default",
6947
+ "declaration": {
6948
+ "name": "List",
6949
+ "module": "components/list/list.component.js"
6950
+ }
6951
+ }
6952
+ ]
6953
+ },
6954
+ {
6955
+ "kind": "javascript-module",
6956
+ "path": "components/listitem/listitem.component.js",
6957
+ "declarations": [
6958
+ {
6959
+ "kind": "class",
6960
+ "description": "mdc-listitem component is used to display a label with different types of controls.\nThere can be three types of controls, a radio button, a checkbox on the\nleading side and a toggle on the trailing side.\nThe list item can contain an avatar on the leading side and a badge on the trailing side.\nAdditionally, the list item can contain a side header and a subline text.\n\nThe leading and trailing slots can be used to display controls and text. <br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted. <br/>\nPlease use mdc-list as a parent element even when there is only listitem for a11y purpose.",
6961
+ "name": "ListItem",
6962
+ "cssProperties": [
6963
+ {
6964
+ "description": "Allows customization of the default background color.",
6965
+ "name": "--mdc-listitem-default-background-color"
6966
+ },
6967
+ {
6968
+ "description": "Allows customization of the background color on hover.",
6969
+ "name": "--mdc-listitem-background-color-hover"
6970
+ },
6971
+ {
6972
+ "description": "Allows customization of the background color when pressed.",
6973
+ "name": "--mdc-listitem-background-color-active"
6974
+ },
6975
+ {
6976
+ "description": "Allows customization of the primary label, side header and subline text slot color.",
6977
+ "name": "--mdc-listitem-primary-label-color"
6978
+ },
6979
+ {
6980
+ "description": "Allows customization of the secondary and teritary label text slot color.",
6981
+ "name": "--mdc-listitem-secondary-label-color"
6982
+ },
6983
+ {
6984
+ "description": "Allows customization of the disabled color.",
6985
+ "name": "--mdc-listitem-disabled-color"
6986
+ }
6987
+ ],
6988
+ "slots": [
6989
+ {
6990
+ "description": "slot for list item controls to appear of leading end.",
6991
+ "name": "leading-controls"
6992
+ },
6993
+ {
6994
+ "description": "slot for list item primary label.",
6995
+ "name": "leading-text-primary-label"
6996
+ },
6997
+ {
6998
+ "description": "slot for list item secondary label.",
6999
+ "name": "leading-text-secondary-label"
7000
+ },
7001
+ {
7002
+ "description": "slot for list item tertiary label.",
7003
+ "name": "leading-text-tertiary-label"
7004
+ },
7005
+ {
7006
+ "description": "slot for list item side header text.",
7007
+ "name": "trailing-text-side-header"
7008
+ },
7009
+ {
7010
+ "description": "slot for list item subline text.",
7011
+ "name": "trailing-text-subline"
7012
+ },
7013
+ {
7014
+ "description": "slot for list item controls to appear of trailing end.",
7015
+ "name": "trailing-controls"
7016
+ }
7017
+ ],
7018
+ "members": [
7019
+ {
7020
+ "kind": "field",
7021
+ "name": "variant",
7022
+ "type": {
7023
+ "text": "ListItemVariants"
7024
+ },
7025
+ "description": "The variant of the list item. It can be a pill, rectangle or a full-width.",
7026
+ "default": "'full-width'",
7027
+ "attribute": "variant",
7028
+ "reflects": true
7029
+ },
7030
+ {
7031
+ "kind": "field",
7032
+ "name": "label",
7033
+ "type": {
7034
+ "text": "string | undefined"
7035
+ },
7036
+ "description": "The primary label of the list item.\nThis appears on the leading side of the list item.",
7037
+ "attribute": "label",
7038
+ "reflects": true
7039
+ },
7040
+ {
7041
+ "kind": "field",
7042
+ "name": "secondaryLabel",
7043
+ "type": {
7044
+ "text": "string | undefined"
7045
+ },
7046
+ "description": "The secondary label of the list item.\nThis appears on the leading side of the list item.",
7047
+ "attribute": "secondary-label",
7048
+ "reflects": true
7049
+ },
7050
+ {
7051
+ "kind": "field",
7052
+ "name": "tertiaryLabel",
7053
+ "type": {
7054
+ "text": "string | undefined"
7055
+ },
7056
+ "description": "The tertiary label of the list item.\nThis appears on the leading side of the list item.",
7057
+ "attribute": "tertiary-label",
7058
+ "reflects": true
7059
+ },
7060
+ {
7061
+ "kind": "field",
7062
+ "name": "sideHeaderText",
7063
+ "type": {
7064
+ "text": "string | undefined"
7065
+ },
7066
+ "description": "The header text of the list item.\nThis appears on the trailing side of the list item.",
7067
+ "attribute": "side-header-text",
7068
+ "reflects": true
7069
+ },
7070
+ {
7071
+ "kind": "field",
7072
+ "name": "sublineText",
7073
+ "type": {
7074
+ "text": "string | undefined"
7075
+ },
7076
+ "description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
7077
+ "attribute": "subline-text",
7078
+ "reflects": true
7079
+ },
7080
+ {
7081
+ "kind": "method",
7082
+ "name": "getText",
7083
+ "privacy": "protected",
7084
+ "return": {
7085
+ "type": {
7086
+ "text": ""
7087
+ }
7088
+ },
7089
+ "parameters": [
7090
+ {
7091
+ "name": "slotName",
7092
+ "type": {
7093
+ "text": "string"
7094
+ },
7095
+ "description": "The name of the slot to be used."
7096
+ },
7097
+ {
7098
+ "name": "type",
7099
+ "type": {
7100
+ "text": "TextType"
7101
+ },
7102
+ "description": "The type of the text element."
7103
+ },
7104
+ {
7105
+ "name": "content",
7106
+ "optional": true,
7107
+ "type": {
7108
+ "text": "string"
7109
+ },
7110
+ "description": "The text content to be displayed within the slot."
7111
+ }
7112
+ ],
7113
+ "description": "Generates a template for a text slot with the specified content."
7114
+ },
7115
+ {
7116
+ "kind": "method",
7117
+ "name": "disableSlottedChildren",
7118
+ "privacy": "private",
7119
+ "return": {
7120
+ "type": {
7121
+ "text": "void"
7122
+ }
7123
+ },
7124
+ "parameters": [
7125
+ {
7126
+ "name": "disabled",
7127
+ "type": {
7128
+ "text": "boolean"
7129
+ },
7130
+ "description": "Whether to disable or enable the controls."
7131
+ }
7132
+ ],
7133
+ "description": "Disable or enable all slotted elements in the leading and trailing slots.\nThis is useful when the list item is disabled, to prevent the user from interacting with the controls."
6236
7134
  },
6237
7135
  {
6238
- "name": "prefix-text",
6239
- "type": {
6240
- "text": "string | undefined"
6241
- },
6242
- "description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
6243
- "fieldName": "prefixText"
7136
+ "kind": "field",
7137
+ "name": "role"
6244
7138
  },
6245
7139
  {
6246
- "name": "leading-icon",
7140
+ "kind": "field",
7141
+ "name": "dataAriaLabel",
6247
7142
  "type": {
6248
- "text": "IconNames | undefined"
7143
+ "text": "string | null"
6249
7144
  },
6250
- "description": "The leading icon that is displayed before the input field.",
6251
- "fieldName": "leadingIcon"
7145
+ "default": "null",
7146
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7147
+ "attribute": "data-aria-label",
7148
+ "reflects": true,
7149
+ "inheritedFrom": {
7150
+ "name": "DataAriaLabelMixin",
7151
+ "module": "utils/mixins/DataAriaLabelMixin.js"
7152
+ }
6252
7153
  },
6253
7154
  {
6254
- "name": "trailing-button",
7155
+ "kind": "field",
7156
+ "name": "disabled",
6255
7157
  "type": {
6256
7158
  "text": "boolean"
6257
7159
  },
6258
7160
  "default": "false",
6259
- "description": "The trailing button when set to true, shows a clear button that clears the input field.",
6260
- "fieldName": "trailingButton"
7161
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7162
+ "attribute": "disabled",
7163
+ "reflects": true,
7164
+ "inheritedFrom": {
7165
+ "name": "DisabledMixin",
7166
+ "module": "utils/mixins/DisabledMixin.js"
7167
+ }
6261
7168
  },
6262
7169
  {
6263
- "name": "maxlength",
7170
+ "kind": "field",
7171
+ "name": "tabIndex",
6264
7172
  "type": {
6265
- "text": "number | undefined"
7173
+ "text": "number"
6266
7174
  },
6267
- "description": "The maximum number of characters that the input field can accept.",
6268
- "fieldName": "maxlength"
6269
- },
7175
+ "default": "0",
7176
+ "description": "This property specifies the tab order of the element.",
7177
+ "attribute": "tabIndex",
7178
+ "reflects": true,
7179
+ "inheritedFrom": {
7180
+ "name": "TabIndexMixin",
7181
+ "module": "utils/mixins/TabIndexMixin.js"
7182
+ }
7183
+ }
7184
+ ],
7185
+ "events": [
6270
7186
  {
6271
- "name": "minlength",
6272
- "type": {
6273
- "text": "number | undefined"
6274
- },
6275
- "description": "The minimum number of characters that the input field can accept.",
6276
- "fieldName": "minlength"
7187
+ "description": "(React: onClick) This event is dispatched when the listitem is clicked.",
7188
+ "name": "click",
7189
+ "reactName": "onClick",
7190
+ "eventName": "ClickEvent"
6277
7191
  },
6278
7192
  {
6279
- "name": "autocapitalize",
6280
- "type": {
6281
- "text": "AutoCapitalizeType"
6282
- },
6283
- "description": "The autocapitalize attribute of the input field.",
6284
- "default": "'off'",
6285
- "fieldName": "autocapitalize"
7193
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the listitem.",
7194
+ "name": "keydown",
7195
+ "reactName": "onKeyDown",
7196
+ "eventName": "KeydownEvent"
6286
7197
  },
6287
7198
  {
6288
- "name": "autocomplete",
6289
- "type": {
6290
- "text": "any"
6291
- },
6292
- "default": "'off'",
6293
- "description": "The autocomplete attribute of the input field.",
6294
- "fieldName": "autocomplete"
7199
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the listitem.",
7200
+ "name": "keyup",
7201
+ "reactName": "onKeyUp",
7202
+ "eventName": "KeyupEvent"
6295
7203
  },
6296
7204
  {
6297
- "name": "autofocus",
6298
- "type": {
6299
- "text": "boolean"
6300
- },
6301
- "default": "false",
6302
- "description": "If true, the input field is focused when the component is rendered.",
6303
- "fieldName": "autofocus"
6304
- },
7205
+ "description": "(React: onFocus) This event is dispatched when the listitem receives focus.",
7206
+ "name": "focus",
7207
+ "reactName": "onFocus",
7208
+ "eventName": "FocusEvent"
7209
+ }
7210
+ ],
7211
+ "attributes": [
6305
7212
  {
6306
- "name": "dirname",
7213
+ "name": "variant",
6307
7214
  "type": {
6308
- "text": "string | undefined"
7215
+ "text": "ListItemVariants"
6309
7216
  },
6310
- "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
6311
- "fieldName": "dirname"
7217
+ "description": "The variant of the list item. It can be a pill, rectangle or a full-width.",
7218
+ "default": "'full-width'",
7219
+ "fieldName": "variant"
6312
7220
  },
6313
7221
  {
6314
- "name": "pattern",
7222
+ "name": "label",
6315
7223
  "type": {
6316
7224
  "text": "string | undefined"
6317
7225
  },
6318
- "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
6319
- "fieldName": "pattern"
7226
+ "description": "The primary label of the list item.\nThis appears on the leading side of the list item.",
7227
+ "fieldName": "label"
6320
7228
  },
6321
7229
  {
6322
- "name": "list",
7230
+ "name": "secondary-label",
6323
7231
  "type": {
6324
7232
  "text": "string | undefined"
6325
7233
  },
6326
- "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
6327
- "fieldName": "list"
6328
- },
6329
- {
6330
- "name": "size",
6331
- "type": {
6332
- "text": "number | undefined | undefined"
6333
- },
6334
- "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
6335
- "default": "undefined",
6336
- "fieldName": "size"
6337
- },
6338
- {
6339
- "name": "clear-aria-label",
6340
- "type": {
6341
- "text": "string"
6342
- },
6343
- "default": "''",
6344
- "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
6345
- "fieldName": "clearAriaLabel"
7234
+ "description": "The secondary label of the list item.\nThis appears on the leading side of the list item.",
7235
+ "fieldName": "secondaryLabel"
6346
7236
  },
6347
7237
  {
6348
- "name": "name",
7238
+ "name": "tertiary-label",
6349
7239
  "type": {
6350
- "text": "string"
7240
+ "text": "string | undefined"
6351
7241
  },
6352
- "default": "''",
6353
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
6354
- "fieldName": "name",
6355
- "inheritedFrom": {
6356
- "name": "FormInternalsMixin",
6357
- "module": "src/utils/mixins/FormInternalsMixin.ts"
6358
- }
7242
+ "description": "The tertiary label of the list item.\nThis appears on the leading side of the list item.",
7243
+ "fieldName": "tertiaryLabel"
6359
7244
  },
6360
7245
  {
6361
- "name": "value",
7246
+ "name": "side-header-text",
6362
7247
  "type": {
6363
- "text": "string"
7248
+ "text": "string | undefined"
6364
7249
  },
6365
- "default": "''",
6366
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
6367
- "fieldName": "value",
6368
- "inheritedFrom": {
6369
- "name": "FormInternalsMixin",
6370
- "module": "src/utils/mixins/FormInternalsMixin.ts"
6371
- }
7250
+ "description": "The header text of the list item.\nThis appears on the trailing side of the list item.",
7251
+ "fieldName": "sideHeaderText"
6372
7252
  },
6373
7253
  {
6374
- "name": "validation-message",
7254
+ "name": "subline-text",
6375
7255
  "type": {
6376
7256
  "text": "string | undefined"
6377
7257
  },
6378
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
6379
- "fieldName": "validationMessage",
6380
- "inheritedFrom": {
6381
- "name": "FormInternalsMixin",
6382
- "module": "src/utils/mixins/FormInternalsMixin.ts"
6383
- }
7258
+ "description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
7259
+ "fieldName": "sublineText"
6384
7260
  },
6385
7261
  {
6386
7262
  "name": "data-aria-label",
@@ -6404,99 +7280,45 @@
6404
7280
  "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6405
7281
  "fieldName": "disabled",
6406
7282
  "inheritedFrom": {
6407
- "name": "FormfieldWrapper",
6408
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6409
- }
6410
- },
6411
- {
6412
- "name": "label",
6413
- "type": {
6414
- "text": "string | undefined"
6415
- },
6416
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
6417
- "fieldName": "label",
6418
- "inheritedFrom": {
6419
- "name": "FormfieldWrapper",
6420
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6421
- }
6422
- },
6423
- {
6424
- "name": "required-label",
6425
- "type": {
6426
- "text": "string | undefined"
6427
- },
6428
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
6429
- "fieldName": "requiredLabel",
6430
- "inheritedFrom": {
6431
- "name": "FormfieldWrapper",
6432
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6433
- }
6434
- },
6435
- {
6436
- "name": "id",
6437
- "type": {
6438
- "text": "string"
6439
- },
6440
- "default": "''",
6441
- "description": "The unique id of the input field. It is used to link the input field with the label.",
6442
- "fieldName": "id",
6443
- "inheritedFrom": {
6444
- "name": "FormfieldWrapper",
6445
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6446
- }
6447
- },
6448
- {
6449
- "name": "help-text-type",
6450
- "type": {
6451
- "text": "ValidationType"
6452
- },
6453
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
6454
- "fieldName": "helpTextType",
6455
- "inheritedFrom": {
6456
- "name": "FormfieldWrapper",
6457
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7283
+ "name": "DisabledMixin",
7284
+ "module": "src/utils/mixins/DisabledMixin.ts"
6458
7285
  }
6459
7286
  },
6460
7287
  {
6461
- "name": "help-text",
7288
+ "name": "tabIndex",
6462
7289
  "type": {
6463
- "text": "string | undefined"
7290
+ "text": "number"
6464
7291
  },
6465
- "description": "The help text that is displayed below the input field.",
6466
- "fieldName": "helpText",
6467
- "inheritedFrom": {
6468
- "name": "FormfieldWrapper",
6469
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7292
+ "default": "0",
7293
+ "description": "This property specifies the tab order of the element.",
7294
+ "fieldName": "tabIndex",
7295
+ "inheritedFrom": {
7296
+ "name": "TabIndexMixin",
7297
+ "module": "src/utils/mixins/TabIndexMixin.ts"
6470
7298
  }
6471
7299
  }
6472
7300
  ],
6473
7301
  "mixins": [
6474
- {
6475
- "name": "FormInternalsMixin",
6476
- "module": "/src/utils/mixins/FormInternalsMixin"
6477
- },
6478
7302
  {
6479
7303
  "name": "DataAriaLabelMixin",
6480
7304
  "module": "/src/utils/mixins/DataAriaLabelMixin"
7305
+ },
7306
+ {
7307
+ "name": "DisabledMixin",
7308
+ "module": "/src/utils/mixins/DisabledMixin"
7309
+ },
7310
+ {
7311
+ "name": "TabIndexMixin",
7312
+ "module": "/src/utils/mixins/TabIndexMixin"
6481
7313
  }
6482
7314
  ],
6483
7315
  "superclass": {
6484
- "name": "FormfieldWrapper",
6485
- "module": "/src/components/formfieldwrapper"
7316
+ "name": "Component",
7317
+ "module": "/src/models"
6486
7318
  },
6487
- "tagName": "mdc-input",
6488
- "jsDoc": "/**\n * mdc-input is a component that allows users to input text.\n * It contains:\n * - label field - describe the input field.\n * - input field - contains the value\n * - help text or validation message - displayed below the input field.\n * - trailing button - it displays a clear the input field.\n * - prefix text - displayed before the input field.\n * - leading icon - displayed before the input field.\n * - clear-aria-label - aria label for the trailing button.\n * - all the attributes of the input field.\n *\n * @tagname mdc-input\n *\n * @event input - (React: onInput) This event is dispatched when the value of the input field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the input field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the input receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the input loses focus.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n *\n * @cssproperty --mdc-input-disabled-border-color - Border color for the input container when disabled\n * @cssproperty --mdc-input-disabled-text-color - Text color for the input field when disabled\n * @cssproperty --mdc-input-disabled-background-color - Background color for the input field when disabled\n * @cssproperty --mdc-input-border-color - Border color for the input container\n * @cssproperty --mdc-input-text-color - Text color for the input field\n * @cssproperty --mdc-input-background-color - Background color for the input field\n * @cssproperty --mdc-input-selection-background-color - Background color for the selected text\n * @cssproperty --mdc-input-selection-text-color - Text color for the selected text\n * @cssproperty --mdc-input-support-text-color - Text color for the help text\n * @cssproperty --mdc-input-hover-background-color - Background color for the input field when hovered\n * @cssproperty --mdc-input-focused-background-color - Background color for the input field when focused\n * @cssproperty --mdc-input-focused-border-color - Border color for the input container when focused\n * @cssproperty --mdc-input-error-border-color - Border color for the input container when error\n * @cssproperty --mdc-input-warning-border-color - Border color for the input container when warning\n * @cssproperty --mdc-input-success-border-color - Border color for the input container when success\n * @cssproperty --mdc-input-primary-border-color - Border color for the input container when primary\n *\n */",
6489
- "customElement": true,
6490
- "slots": [
6491
- {
6492
- "description": "slot to add the label info icon",
6493
- "name": "label-info",
6494
- "inheritedFrom": {
6495
- "name": "FormfieldWrapper",
6496
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6497
- }
6498
- }
6499
- ]
7319
+ "tagName": "mdc-listitem",
7320
+ "jsDoc": "/**\n * mdc-listitem component is used to display a label with different types of controls.\n * There can be three types of controls, a radio button, a checkbox on the\n * leading side and a toggle on the trailing side.\n * The list item can contain an avatar on the leading side and a badge on the trailing side.\n * Additionally, the list item can contain a side header and a subline text.\n *\n * The leading and trailing slots can be used to display controls and text. <br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted. <br/>\n * Please use mdc-list as a parent element even when there is only listitem for a11y purpose.\n *\n * @tagname mdc-listitem\n *\n * @dependency mdc-text\n *\n * @slot leading-controls - slot for list item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for list item primary label.\n * @slot leading-text-secondary-label - slot for list item secondary label.\n * @slot leading-text-tertiary-label - slot for list item tertiary label.\n * @slot trailing-text-side-header - slot for list item side header text.\n * @slot trailing-text-subline - slot for list item subline text.\n * @slot trailing-controls - slot for list item controls to appear of trailing end.\n *\n * @cssproperty --mdc-listitem-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-listitem-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-listitem-background-color-active - Allows customization of the background color when pressed.\n * @cssproperty --mdc-listitem-primary-label-color\n * - Allows customization of the primary label, side header and subline text slot color.\n * @cssproperty --mdc-listitem-secondary-label-color\n * - Allows customization of the secondary and teritary label text slot color.\n * @cssproperty --mdc-listitem-disabled-color - Allows customization of the disabled color.\n *\n * @event click - (React: onClick) This event is dispatched when the listitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the listitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the listitem.\n * @event focus - (React: onFocus) This event is dispatched when the listitem receives focus.\n */",
7321
+ "customElement": true
6500
7322
  }
6501
7323
  ],
6502
7324
  "exports": [
@@ -6504,131 +7326,138 @@
6504
7326
  "kind": "js",
6505
7327
  "name": "default",
6506
7328
  "declaration": {
6507
- "name": "Input",
6508
- "module": "components/input/input.component.js"
7329
+ "name": "ListItem",
7330
+ "module": "components/listitem/listitem.component.js"
6509
7331
  }
6510
7332
  }
6511
7333
  ]
6512
7334
  },
6513
7335
  {
6514
7336
  "kind": "javascript-module",
6515
- "path": "components/link/link.component.js",
7337
+ "path": "components/marker/marker.component.js",
6516
7338
  "declarations": [
6517
7339
  {
6518
7340
  "kind": "class",
6519
- "description": "`mdc-link` component can be used to navigate to a different page\nwithin the application or to an external site. It can be used to link to\nemails or phone numbers.\n\nThe `children` of the link component is expected to be an anchor element\ncontaining the text, href, and other attributes.\n\nFor `icon`, the `mdc-icon` component is used to render the icon.",
6520
- "name": "Link",
7341
+ "description": "`mdc-marker`, which is a vertical line and\nused to draw attention to specific parts of\nthe content or to signify important information.\n\n**Marker Variants**:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
7342
+ "name": "Marker",
6521
7343
  "cssProperties": [
6522
7344
  {
6523
- "description": "Border radius of the link",
6524
- "name": "--mdc-link-border-radius"
6525
- },
6526
- {
6527
- "description": "Text and icon color of the link in active state",
6528
- "name": "--mdc-link-color-active"
6529
- },
6530
- {
6531
- "description": "Text and icon color of the link in disabled state",
6532
- "name": "--mdc-link-color-disabled"
6533
- },
6534
- {
6535
- "description": "Text and icon color of the link in hover state",
6536
- "name": "--mdc-link-color-hover"
6537
- },
6538
- {
6539
- "description": "Text and icon color of the link in normal state",
6540
- "name": "--mdc-link-color-normal"
6541
- },
6542
- {
6543
- "description": "Gap between the text and icon (only applicable when an icon is set)",
6544
- "name": "--mdc-link-icon-margin-left"
6545
- },
6546
- {
6547
- "description": "Text and icon color of the inverted link in active state",
6548
- "name": "--mdc-link-inverted-color-active"
6549
- },
6550
- {
6551
- "description": "Text and icon color of the inverted link in disabled state",
6552
- "name": "--mdc-link-inverted-color-disabled"
7345
+ "description": "Allows customization of the default background color in solid variant.",
7346
+ "name": "--mdc-marker-solid-background-color"
6553
7347
  },
6554
7348
  {
6555
- "description": "Text and icon color of the inverted link in hover state",
6556
- "name": "--mdc-link-inverted-color-hover"
7349
+ "description": "Allows customization of the default stripes in striped variant.",
7350
+ "name": "--mdc-marker-striped-color"
6557
7351
  },
6558
7352
  {
6559
- "description": "Text and icon color of the inverted link in normal state",
6560
- "name": "--mdc-link-inverted-color-normal"
7353
+ "description": "Allows customization of the default background color in striped variant.",
7354
+ "name": "--mdc-marker-striped-background-color"
6561
7355
  },
6562
7356
  {
6563
- "description": "Text decoration of the link in disabled state for all variants",
6564
- "name": "--mdc-link-text-decoration-disabled"
7357
+ "description": "Allows customization of the default width.",
7358
+ "name": "--mdc-marker-width"
6565
7359
  }
6566
7360
  ],
6567
7361
  "members": [
6568
7362
  {
6569
7363
  "kind": "field",
6570
- "name": "inline",
7364
+ "name": "variant",
6571
7365
  "type": {
6572
- "text": "boolean"
7366
+ "text": "MarkerVariants"
6573
7367
  },
6574
- "description": "The link can be inline or standalone.",
6575
- "default": "false",
6576
- "attribute": "inline",
7368
+ "privacy": "public",
7369
+ "description": "There are two variants of markers, each with a width of 0.25rem:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
7370
+ "default": "solid",
7371
+ "attribute": "variant",
6577
7372
  "reflects": true
6578
- },
7373
+ }
7374
+ ],
7375
+ "attributes": [
6579
7376
  {
6580
- "kind": "field",
6581
- "name": "inverted",
7377
+ "name": "variant",
6582
7378
  "type": {
6583
- "text": "boolean"
7379
+ "text": "MarkerVariants"
6584
7380
  },
6585
- "description": "The link color can be inverted by setting the inverted attribute to true.",
6586
- "default": "false",
6587
- "attribute": "inverted",
6588
- "reflects": true
6589
- },
7381
+ "description": "There are two variants of markers, each with a width of 0.25rem:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
7382
+ "default": "solid",
7383
+ "fieldName": "variant"
7384
+ }
7385
+ ],
7386
+ "superclass": {
7387
+ "name": "Component",
7388
+ "module": "/src/models"
7389
+ },
7390
+ "tagName": "mdc-marker",
7391
+ "jsDoc": "/**\n * `mdc-marker`, which is a vertical line and\n * used to draw attention to specific parts of\n * the content or to signify important information.\n *\n * **Marker Variants**:\n * - **solid**: Solid marker.\n * - **striped**: Striped marker.\n *\n * @tagname mdc-marker\n *\n * @cssproperty --mdc-marker-solid-background-color - Allows customization of the default background color\n * in solid variant.\n * @cssproperty --mdc-marker-striped-color - Allows customization of the default stripes in striped variant.\n * @cssproperty --mdc-marker-striped-background-color - Allows customization of the default background color\n * in striped variant.\n * @cssproperty --mdc-marker-width - Allows customization of the default width.\n */",
7392
+ "customElement": true
7393
+ }
7394
+ ],
7395
+ "exports": [
7396
+ {
7397
+ "kind": "js",
7398
+ "name": "default",
7399
+ "declaration": {
7400
+ "name": "Marker",
7401
+ "module": "components/marker/marker.component.js"
7402
+ }
7403
+ }
7404
+ ]
7405
+ },
7406
+ {
7407
+ "kind": "javascript-module",
7408
+ "path": "components/optgroup/optgroup.component.js",
7409
+ "declarations": [
7410
+ {
7411
+ "kind": "class",
7412
+ "description": "optgroup component, which creates a grouping of mdc-option within a listbox element.",
7413
+ "name": "OptGroup",
7414
+ "cssProperties": [
7415
+ {
7416
+ "description": "Allows customization of the disabled option color.",
7417
+ "name": "--mdc-optgroup-disabled-color"
7418
+ }
7419
+ ],
7420
+ "slots": [
7421
+ {
7422
+ "description": "This is a default slot for mdc-option elements.",
7423
+ "name": "default"
7424
+ }
7425
+ ],
7426
+ "members": [
6590
7427
  {
6591
7428
  "kind": "field",
6592
- "name": "size",
7429
+ "name": "label",
6593
7430
  "type": {
6594
- "text": "LinkSize"
7431
+ "text": "string | undefined"
6595
7432
  },
6596
- "description": "Size of the link.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'",
6597
- "default": "large",
6598
- "attribute": "size",
7433
+ "description": "The header text to be displayed on the top of the options list.",
7434
+ "attribute": "label",
6599
7435
  "reflects": true
6600
7436
  },
6601
7437
  {
6602
7438
  "kind": "method",
6603
- "name": "getIconSize",
7439
+ "name": "setDisabledForAllOptions",
6604
7440
  "privacy": "private",
6605
7441
  "return": {
6606
7442
  "type": {
6607
- "text": ""
6608
- }
6609
- },
6610
- "description": "Method to get the size of the trailing icon based on the link size."
6611
- },
6612
- {
6613
- "kind": "method",
6614
- "name": "setDisabled",
6615
- "privacy": "private",
6616
- "parameters": [
6617
- {
6618
- "name": "disabled",
6619
- "type": {
6620
- "text": "boolean"
6621
- },
6622
- "description": "The disabled state of icon"
7443
+ "text": "void"
6623
7444
  }
6624
- ],
6625
- "description": "Updates the tabindex of the host element to disable or enable the link.\nWhen disabled, the link is not focusable or clickable, and tabindex is set to -1\nand aria-disabled attribute is set to true\nWhen link is not disabled, the previous tabindex of the host element is restored\nand aria-disabled attribute is removed."
7445
+ }
6626
7446
  },
6627
7447
  {
6628
- "kind": "method",
6629
- "name": "updateTrailingIcon",
6630
- "privacy": "private",
6631
- "description": "Method to create and append trailing icon to the first anchor element in the slot.\nIf no icon name is provided, no icon will be rendered."
7448
+ "kind": "field",
7449
+ "name": "dataAriaLabel",
7450
+ "type": {
7451
+ "text": "string | null"
7452
+ },
7453
+ "default": "null",
7454
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7455
+ "attribute": "data-aria-label",
7456
+ "reflects": true,
7457
+ "inheritedFrom": {
7458
+ "name": "DataAriaLabelMixin",
7459
+ "module": "utils/mixins/DataAriaLabelMixin.js"
7460
+ }
6632
7461
  },
6633
7462
  {
6634
7463
  "kind": "field",
@@ -6644,48 +7473,29 @@
6644
7473
  "name": "DisabledMixin",
6645
7474
  "module": "utils/mixins/DisabledMixin.js"
6646
7475
  }
6647
- },
6648
- {
6649
- "kind": "field",
6650
- "name": "iconName",
6651
- "type": {
6652
- "text": "IconNames | undefined"
6653
- },
6654
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
6655
- "attribute": "icon-name",
6656
- "inheritedFrom": {
6657
- "name": "IconNameMixin",
6658
- "module": "utils/mixins/IconNameMixin.js"
6659
- }
6660
7476
  }
6661
7477
  ],
6662
7478
  "attributes": [
6663
7479
  {
6664
- "name": "inline",
6665
- "type": {
6666
- "text": "boolean"
6667
- },
6668
- "description": "The link can be inline or standalone.",
6669
- "default": "false",
6670
- "fieldName": "inline"
6671
- },
6672
- {
6673
- "name": "inverted",
7480
+ "name": "label",
6674
7481
  "type": {
6675
- "text": "boolean"
7482
+ "text": "string | undefined"
6676
7483
  },
6677
- "description": "The link color can be inverted by setting the inverted attribute to true.",
6678
- "default": "false",
6679
- "fieldName": "inverted"
7484
+ "description": "The header text to be displayed on the top of the options list.",
7485
+ "fieldName": "label"
6680
7486
  },
6681
7487
  {
6682
- "name": "size",
7488
+ "name": "data-aria-label",
6683
7489
  "type": {
6684
- "text": "LinkSize"
7490
+ "text": "string | null"
6685
7491
  },
6686
- "description": "Size of the link.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'",
6687
- "default": "large",
6688
- "fieldName": "size"
7492
+ "default": "null",
7493
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7494
+ "fieldName": "dataAriaLabel",
7495
+ "inheritedFrom": {
7496
+ "name": "DataAriaLabelMixin",
7497
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
7498
+ }
6689
7499
  },
6690
7500
  {
6691
7501
  "name": "disabled",
@@ -6699,36 +7509,24 @@
6699
7509
  "name": "DisabledMixin",
6700
7510
  "module": "src/utils/mixins/DisabledMixin.ts"
6701
7511
  }
6702
- },
6703
- {
6704
- "name": "icon-name",
6705
- "type": {
6706
- "text": "IconNames | undefined"
6707
- },
6708
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
6709
- "fieldName": "iconName",
6710
- "inheritedFrom": {
6711
- "name": "IconNameMixin",
6712
- "module": "src/utils/mixins/IconNameMixin.ts"
6713
- }
6714
7512
  }
6715
7513
  ],
6716
7514
  "mixins": [
6717
7515
  {
6718
- "name": "DisabledMixin",
6719
- "module": "/src/utils/mixins/DisabledMixin"
7516
+ "name": "DataAriaLabelMixin",
7517
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
6720
7518
  },
6721
7519
  {
6722
- "name": "IconNameMixin",
6723
- "module": "/src/utils/mixins/IconNameMixin"
7520
+ "name": "DisabledMixin",
7521
+ "module": "/src/utils/mixins/DisabledMixin"
6724
7522
  }
6725
7523
  ],
6726
7524
  "superclass": {
6727
7525
  "name": "Component",
6728
7526
  "module": "/src/models"
6729
7527
  },
6730
- "tagName": "mdc-link",
6731
- "jsDoc": "/**\n * `mdc-link` component can be used to navigate to a different page\n * within the application or to an external site. It can be used to link to\n * emails or phone numbers.\n *\n * The `children` of the link component is expected to be an anchor element\n * containing the text, href, and other attributes.\n *\n * For `icon`, the `mdc-icon` component is used to render the icon.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-link\n *\n * @cssproperty --mdc-link-border-radius - Border radius of the link\n * @cssproperty --mdc-link-color-active - Text and icon color of the link in active state\n * @cssproperty --mdc-link-color-disabled - Text and icon color of the link in disabled state\n * @cssproperty --mdc-link-color-hover - Text and icon color of the link in hover state\n * @cssproperty --mdc-link-color-normal - Text and icon color of the link in normal state\n * @cssproperty --mdc-link-icon-margin-left - Gap between the text and icon (only applicable when an icon is set)\n * @cssproperty --mdc-link-inverted-color-active - Text and icon color of the inverted link in active state\n * @cssproperty --mdc-link-inverted-color-disabled - Text and icon color of the inverted link in disabled state\n * @cssproperty --mdc-link-inverted-color-hover - Text and icon color of the inverted link in hover state\n * @cssproperty --mdc-link-inverted-color-normal - Text and icon color of the inverted link in normal state\n * @cssproperty --mdc-link-text-decoration-disabled - Text decoration of the link in disabled state for all variants\n */",
7528
+ "tagName": "mdc-optgroup",
7529
+ "jsDoc": "/**\n * optgroup component, which creates a grouping of mdc-option within a listbox element.\n *\n * @dependency mdc-text\n *\n * @tagname mdc-optgroup\n *\n * @slot default - This is a default slot for mdc-option elements.\n *\n * @cssproperty --mdc-optgroup-disabled-color - Allows customization of the disabled option color.\n */",
6732
7530
  "customElement": true
6733
7531
  }
6734
7532
  ],
@@ -6737,313 +7535,385 @@
6737
7535
  "kind": "js",
6738
7536
  "name": "default",
6739
7537
  "declaration": {
6740
- "name": "Link",
6741
- "module": "components/link/link.component.js"
7538
+ "name": "OptGroup",
7539
+ "module": "components/optgroup/optgroup.component.js"
6742
7540
  }
6743
7541
  }
6744
7542
  ]
6745
7543
  },
6746
7544
  {
6747
7545
  "kind": "javascript-module",
6748
- "path": "components/list/list.component.js",
7546
+ "path": "components/option/option.component.js",
6749
7547
  "declarations": [
6750
7548
  {
6751
7549
  "kind": "class",
6752
- "description": "mdc-list component is used to display a group of list items. It is used as a container to wrap other list items.",
6753
- "name": "List",
7550
+ "description": "option component, which is used as a list item in a select component.<br/>\nWe can pass an icon which will be displayed in leading position of the option label text.",
7551
+ "name": "Option",
6754
7552
  "slots": [
6755
7553
  {
6756
7554
  "description": "This is a default/unnamed slot",
6757
7555
  "name": "default"
7556
+ },
7557
+ {
7558
+ "description": "slot for list item controls to appear of leading end.",
7559
+ "name": "leading-controls",
7560
+ "inheritedFrom": {
7561
+ "name": "ListItem",
7562
+ "module": "src/components/listitem/listitem.component.ts"
7563
+ }
7564
+ },
7565
+ {
7566
+ "description": "slot for list item primary label.",
7567
+ "name": "leading-text-primary-label",
7568
+ "inheritedFrom": {
7569
+ "name": "ListItem",
7570
+ "module": "src/components/listitem/listitem.component.ts"
7571
+ }
7572
+ },
7573
+ {
7574
+ "description": "slot for list item secondary label.",
7575
+ "name": "leading-text-secondary-label",
7576
+ "inheritedFrom": {
7577
+ "name": "ListItem",
7578
+ "module": "src/components/listitem/listitem.component.ts"
7579
+ }
7580
+ },
7581
+ {
7582
+ "description": "slot for list item tertiary label.",
7583
+ "name": "leading-text-tertiary-label",
7584
+ "inheritedFrom": {
7585
+ "name": "ListItem",
7586
+ "module": "src/components/listitem/listitem.component.ts"
7587
+ }
7588
+ },
7589
+ {
7590
+ "description": "slot for list item side header text.",
7591
+ "name": "trailing-text-side-header",
7592
+ "inheritedFrom": {
7593
+ "name": "ListItem",
7594
+ "module": "src/components/listitem/listitem.component.ts"
7595
+ }
7596
+ },
7597
+ {
7598
+ "description": "slot for list item subline text.",
7599
+ "name": "trailing-text-subline",
7600
+ "inheritedFrom": {
7601
+ "name": "ListItem",
7602
+ "module": "src/components/listitem/listitem.component.ts"
7603
+ }
7604
+ },
7605
+ {
7606
+ "description": "slot for list item controls to appear of trailing end.",
7607
+ "name": "trailing-controls",
7608
+ "inheritedFrom": {
7609
+ "name": "ListItem",
7610
+ "module": "src/components/listitem/listitem.component.ts"
7611
+ }
6758
7612
  }
6759
7613
  ],
6760
7614
  "members": [
6761
7615
  {
6762
7616
  "kind": "field",
6763
- "name": "listItems",
7617
+ "name": "selected",
6764
7618
  "type": {
6765
- "text": "Array<HTMLElement>"
6766
- }
7619
+ "text": "boolean"
7620
+ },
7621
+ "default": "false",
7622
+ "description": "The selected attribute is used to indicate that the option is selected.",
7623
+ "attribute": "selected",
7624
+ "reflects": true
6767
7625
  },
6768
7626
  {
6769
7627
  "kind": "field",
6770
- "name": "headerText",
7628
+ "name": "prefixIcon",
6771
7629
  "type": {
6772
- "text": "string | undefined"
7630
+ "text": "IconNames | undefined"
6773
7631
  },
6774
- "description": "The header text of the list.",
6775
- "attribute": "header-text",
7632
+ "description": "The prefix icon attribute is used to display the icon name on the left of the option label.",
7633
+ "attribute": "prefix-icon",
6776
7634
  "reflects": true
6777
7635
  },
6778
7636
  {
6779
- "kind": "method",
6780
- "name": "handleKeyDown",
6781
- "privacy": "private",
6782
- "return": {
6783
- "type": {
6784
- "text": "void"
6785
- }
7637
+ "kind": "field",
7638
+ "name": "ariaLabel",
7639
+ "type": {
7640
+ "text": "string | null"
6786
7641
  },
6787
- "parameters": [
6788
- {
6789
- "name": "event",
6790
- "type": {
6791
- "text": "KeyboardEvent"
6792
- },
6793
- "description": "The keyboard event."
6794
- }
6795
- ],
6796
- "description": "Handles the keydown event on the list element.\nIf the key is 'ArrowUp' or 'ArrowDown', it focuses to the previous or next list item\nand sets the active tabindex of the list item.\nPrevents the default event behavior."
7642
+ "default": "null",
7643
+ "description": "Any additional description can be provided here for screen readers.",
7644
+ "attribute": "aria-label",
7645
+ "reflects": true
6797
7646
  },
6798
7647
  {
6799
7648
  "kind": "method",
6800
- "name": "getCurrentIndex",
7649
+ "name": "handleDefaultSlotChange",
6801
7650
  "privacy": "private",
6802
- "return": {
6803
- "type": {
6804
- "text": ""
6805
- }
6806
- },
6807
- "parameters": [
6808
- {
6809
- "name": "target",
6810
- "type": {
6811
- "text": "EventTarget | null"
6812
- },
6813
- "description": "The target element to find the index of."
6814
- }
6815
- ],
6816
- "description": "Returns the index of the given target in the listItems array.\nIf the target is not a list item, but a child element of a list item,\nit returns the index of the parent list item."
7651
+ "description": "Listens to changes in the default slot and updates the label of the option accordingly.\nThis is used to set the label of the option when it is not explicitly set.\nIt is called internally when the slot is changed."
6817
7652
  },
6818
7653
  {
6819
7654
  "kind": "method",
6820
- "name": "getNewIndexBasedOnKey",
7655
+ "name": "updateAttribute",
6821
7656
  "privacy": "private",
6822
7657
  "return": {
6823
7658
  "type": {
6824
- "text": ""
7659
+ "text": "void"
6825
7660
  }
6826
7661
  },
6827
7662
  "parameters": [
6828
7663
  {
6829
- "name": "key",
7664
+ "name": "attributeName",
6830
7665
  "type": {
6831
7666
  "text": "string"
6832
- },
6833
- "description": "The key that was pressed."
6834
- },
6835
- {
6836
- "name": "currentIndex",
6837
- "type": {
6838
- "text": "number"
6839
- },
6840
- "description": "The current index of the focused list item."
7667
+ }
6841
7668
  },
6842
7669
  {
6843
- "name": "wrappedDivsCount",
7670
+ "name": "value",
6844
7671
  "type": {
6845
- "text": "number"
6846
- },
6847
- "description": "The total number of list items."
7672
+ "text": "string"
7673
+ }
6848
7674
  }
6849
7675
  ],
6850
- "description": "Calculates a new index based on the pressed keyboard key.\nSupports navigation keys for moving focus within a list."
7676
+ "description": "Updates the attribute of the option to reflect the current state."
6851
7677
  },
6852
7678
  {
6853
- "kind": "method",
6854
- "name": "handleMouseClick",
6855
- "privacy": "private",
6856
- "return": {
6857
- "type": {
6858
- "text": "void"
6859
- }
7679
+ "kind": "field",
7680
+ "name": "role",
7681
+ "type": {
7682
+ "text": "string"
6860
7683
  },
6861
- "parameters": [
6862
- {
6863
- "name": "event",
6864
- "type": {
6865
- "text": "MouseEvent"
6866
- },
6867
- "description": "The mouse event."
6868
- }
6869
- ],
6870
- "description": "Handles the mouse click event on the list element.\nFinds the index of the target element in the list items array and calls\n`resetTabIndexAndSetActiveTabIndex` with that index."
6871
- },
6872
- {
6873
- "kind": "method",
6874
- "name": "resetTabIndexAndSetActiveTabIndex",
6875
- "privacy": "private",
6876
- "parameters": [
6877
- {
6878
- "name": "newIndex",
6879
- "type": {
6880
- "text": "number"
6881
- },
6882
- "description": "The index of the new active element in the list."
6883
- }
6884
- ],
6885
- "description": "Resets all list items tabindex to -1 and sets the tabindex of the\nelement at the given index to 0, effectively setting the active\nelement. This is used when navigating the list via keyboard."
7684
+ "default": "'option'",
7685
+ "inheritedFrom": {
7686
+ "name": "ListItem",
7687
+ "module": "components/listitem/listitem.component.js"
7688
+ }
6886
7689
  },
6887
7690
  {
6888
7691
  "kind": "field",
6889
- "name": "dataAriaLabel",
7692
+ "name": "variant",
6890
7693
  "type": {
6891
- "text": "string | null"
7694
+ "text": "ListItemVariants"
6892
7695
  },
6893
- "default": "null",
6894
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
6895
- "attribute": "data-aria-label",
7696
+ "description": "The variant of the list item. It can be a pill, rectangle or a full-width.",
7697
+ "default": "'full-width'",
7698
+ "attribute": "variant",
6896
7699
  "reflects": true,
6897
7700
  "inheritedFrom": {
6898
- "name": "DataAriaLabelMixin",
6899
- "module": "utils/mixins/DataAriaLabelMixin.js"
7701
+ "name": "ListItem",
7702
+ "module": "components/listitem/listitem.component.js"
6900
7703
  }
6901
- }
6902
- ],
6903
- "attributes": [
7704
+ },
6904
7705
  {
6905
- "name": "header-text",
7706
+ "kind": "field",
7707
+ "name": "name",
6906
7708
  "type": {
6907
- "text": "string | undefined"
7709
+ "text": "string"
6908
7710
  },
6909
- "description": "The header text of the list.",
6910
- "fieldName": "headerText"
7711
+ "default": "undefined as unknown",
7712
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
7713
+ "attribute": "name",
7714
+ "reflects": true,
7715
+ "inheritedFrom": {
7716
+ "name": "FormInternalsMixin",
7717
+ "module": "utils/mixins/FormInternalsMixin.js"
7718
+ }
6911
7719
  },
6912
7720
  {
6913
- "name": "data-aria-label",
7721
+ "kind": "field",
7722
+ "name": "secondaryLabel",
6914
7723
  "type": {
6915
- "text": "string | null"
7724
+ "text": "string | undefined"
6916
7725
  },
6917
- "default": "null",
6918
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
6919
- "fieldName": "dataAriaLabel",
7726
+ "description": "The secondary label of the list item.\nThis appears on the leading side of the list item.",
7727
+ "attribute": "secondary-label",
7728
+ "reflects": true,
7729
+ "default": "undefined as unknown",
6920
7730
  "inheritedFrom": {
6921
- "name": "DataAriaLabelMixin",
6922
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
7731
+ "name": "ListItem",
7732
+ "module": "components/listitem/listitem.component.js"
6923
7733
  }
6924
- }
6925
- ],
6926
- "mixins": [
6927
- {
6928
- "name": "DataAriaLabelMixin",
6929
- "module": "/src/utils/mixins/DataAriaLabelMixin"
6930
- }
6931
- ],
6932
- "superclass": {
6933
- "name": "Component",
6934
- "module": "/src/models"
6935
- },
6936
- "tagName": "mdc-list",
6937
- "jsDoc": "/**\n * mdc-list component is used to display a group of list items. It is used as a container to wrap other list items.\n *\n * @tagname mdc-list\n *\n * @dependency mdc-text\n *\n * @slot default - This is a default/unnamed slot\n */",
6938
- "customElement": true
6939
- }
6940
- ],
6941
- "exports": [
6942
- {
6943
- "kind": "js",
6944
- "name": "default",
6945
- "declaration": {
6946
- "name": "List",
6947
- "module": "components/list/list.component.js"
6948
- }
6949
- }
6950
- ]
6951
- },
6952
- {
6953
- "kind": "javascript-module",
6954
- "path": "components/listitem/listitem.component.js",
6955
- "declarations": [
6956
- {
6957
- "kind": "class",
6958
- "description": "mdc-listitem component is used to display a label with different types of controls.\nThere can be three types of controls, a radio button, a checkbox on the\nleading side and a toggle on the trailing side.\nThe list item can contain an avatar on the leading side and a badge on the trailing side.\nAdditionally, the list item can contain a side header and a subline text.\n\nThe leading and trailing slots can be used to display controls and text. <br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted. <br/>\nPlease use mdc-list as a parent element even when there is only listitem for a11y purpose.",
6959
- "name": "ListItem",
6960
- "cssProperties": [
7734
+ },
6961
7735
  {
6962
- "description": "Allows customization of the default background color.",
6963
- "name": "--mdc-listitem-default-background-color"
7736
+ "kind": "field",
7737
+ "name": "sideHeaderText",
7738
+ "type": {
7739
+ "text": "string | undefined"
7740
+ },
7741
+ "description": "The header text of the list item.\nThis appears on the trailing side of the list item.",
7742
+ "attribute": "side-header-text",
7743
+ "reflects": true,
7744
+ "default": "undefined as unknown",
7745
+ "inheritedFrom": {
7746
+ "name": "ListItem",
7747
+ "module": "components/listitem/listitem.component.js"
7748
+ }
6964
7749
  },
6965
7750
  {
6966
- "description": "Allows customization of the background color on hover.",
6967
- "name": "--mdc-listitem-background-color-hover"
7751
+ "kind": "field",
7752
+ "name": "sublineText",
7753
+ "type": {
7754
+ "text": "string | undefined"
7755
+ },
7756
+ "description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
7757
+ "attribute": "subline-text",
7758
+ "reflects": true,
7759
+ "default": "undefined as unknown",
7760
+ "inheritedFrom": {
7761
+ "name": "ListItem",
7762
+ "module": "components/listitem/listitem.component.js"
7763
+ }
6968
7764
  },
6969
7765
  {
6970
- "description": "Allows customization of the background color when pressed.",
6971
- "name": "--mdc-listitem-background-color-active"
7766
+ "kind": "field",
7767
+ "name": "dataAriaLabel",
7768
+ "type": {
7769
+ "text": "string | null"
7770
+ },
7771
+ "default": "undefined as unknown",
7772
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7773
+ "attribute": "data-aria-label",
7774
+ "reflects": true,
7775
+ "inheritedFrom": {
7776
+ "name": "ListItem",
7777
+ "module": "components/listitem/listitem.component.js"
7778
+ }
6972
7779
  },
6973
7780
  {
6974
- "description": "Allows customization of the primary label, side header and subline text slot color.",
6975
- "name": "--mdc-listitem-primary-label-color"
7781
+ "kind": "field",
7782
+ "name": "value",
7783
+ "type": {
7784
+ "text": "string"
7785
+ },
7786
+ "default": "''",
7787
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
7788
+ "attribute": "value",
7789
+ "reflects": true,
7790
+ "inheritedFrom": {
7791
+ "name": "FormInternalsMixin",
7792
+ "module": "utils/mixins/FormInternalsMixin.js"
7793
+ }
6976
7794
  },
6977
7795
  {
6978
- "description": "Allows customization of the secondary and teritary label text slot color.",
6979
- "name": "--mdc-listitem-secondary-label-color"
7796
+ "kind": "field",
7797
+ "name": "validationMessage",
7798
+ "type": {
7799
+ "text": "string | undefined"
7800
+ },
7801
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
7802
+ "attribute": "validation-message",
7803
+ "reflects": true,
7804
+ "inheritedFrom": {
7805
+ "name": "FormInternalsMixin",
7806
+ "module": "utils/mixins/FormInternalsMixin.js"
7807
+ }
6980
7808
  },
6981
7809
  {
6982
- "description": "Allows customization of the disabled color.",
6983
- "name": "--mdc-listitem-disabled-color"
6984
- }
6985
- ],
6986
- "slots": [
6987
- {
6988
- "description": "slot for list item controls to appear of leading end.",
6989
- "name": "leading-controls"
7810
+ "kind": "field",
7811
+ "name": "validity",
7812
+ "type": {
7813
+ "text": "ValidityState"
7814
+ },
7815
+ "readonly": true,
7816
+ "inheritedFrom": {
7817
+ "name": "FormInternalsMixin",
7818
+ "module": "utils/mixins/FormInternalsMixin.js"
7819
+ }
6990
7820
  },
6991
7821
  {
6992
- "description": "slot for list item primary label.",
6993
- "name": "leading-text-primary-label"
7822
+ "kind": "field",
7823
+ "name": "willValidate",
7824
+ "readonly": true,
7825
+ "inheritedFrom": {
7826
+ "name": "FormInternalsMixin",
7827
+ "module": "utils/mixins/FormInternalsMixin.js"
7828
+ }
6994
7829
  },
6995
7830
  {
6996
- "description": "slot for list item secondary label.",
6997
- "name": "leading-text-secondary-label"
7831
+ "kind": "method",
7832
+ "name": "setValidity",
7833
+ "description": "Sets the validity of the input field based on the input field's validity.",
7834
+ "return": {
7835
+ "type": {
7836
+ "text": ""
7837
+ }
7838
+ },
7839
+ "inheritedFrom": {
7840
+ "name": "FormInternalsMixin",
7841
+ "module": "utils/mixins/FormInternalsMixin.js"
7842
+ }
6998
7843
  },
6999
7844
  {
7000
- "description": "slot for list item tertiary label.",
7001
- "name": "leading-text-tertiary-label"
7845
+ "kind": "method",
7846
+ "name": "checkValidity",
7847
+ "return": {
7848
+ "type": {
7849
+ "text": "boolean"
7850
+ }
7851
+ },
7852
+ "inheritedFrom": {
7853
+ "name": "FormInternalsMixin",
7854
+ "module": "utils/mixins/FormInternalsMixin.js"
7855
+ }
7002
7856
  },
7003
7857
  {
7004
- "description": "slot for list item side header text.",
7005
- "name": "trailing-text-side-header"
7858
+ "kind": "method",
7859
+ "name": "reportValidity",
7860
+ "inheritedFrom": {
7861
+ "name": "FormInternalsMixin",
7862
+ "module": "utils/mixins/FormInternalsMixin.js"
7863
+ }
7006
7864
  },
7007
7865
  {
7008
- "description": "slot for list item subline text.",
7009
- "name": "trailing-text-subline"
7866
+ "kind": "field",
7867
+ "name": "id",
7868
+ "default": "`mdc-input-${uuidv4()}`",
7869
+ "inheritedFrom": {
7870
+ "name": "FormInternalsMixin",
7871
+ "module": "utils/mixins/FormInternalsMixin.js"
7872
+ }
7010
7873
  },
7011
- {
7012
- "description": "slot for list item controls to appear of trailing end.",
7013
- "name": "trailing-controls"
7014
- }
7015
- ],
7016
- "members": [
7017
7874
  {
7018
7875
  "kind": "field",
7019
- "name": "variant",
7876
+ "name": "disabled",
7020
7877
  "type": {
7021
- "text": "ListItemVariants"
7878
+ "text": "boolean"
7022
7879
  },
7023
- "description": "The variant of the list item. It can be a pill, rectangle or a full-width.",
7024
- "default": "'full-width'",
7025
- "attribute": "variant",
7026
- "reflects": true
7880
+ "default": "false",
7881
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7882
+ "attribute": "disabled",
7883
+ "reflects": true,
7884
+ "inheritedFrom": {
7885
+ "name": "ListItem",
7886
+ "module": "components/listitem/listitem.component.js"
7887
+ }
7027
7888
  },
7028
7889
  {
7029
7890
  "kind": "field",
7030
- "name": "label",
7891
+ "name": "tabIndex",
7031
7892
  "type": {
7032
- "text": "string | undefined"
7893
+ "text": "number"
7033
7894
  },
7034
- "description": "The primary label of the list item.\nThis appears on the leading side of the list item.",
7035
- "attribute": "label",
7036
- "reflects": true
7895
+ "default": "0",
7896
+ "description": "This property specifies the tab order of the element.",
7897
+ "attribute": "tabIndex",
7898
+ "reflects": true,
7899
+ "inheritedFrom": {
7900
+ "name": "ListItem",
7901
+ "module": "components/listitem/listitem.component.js"
7902
+ }
7037
7903
  },
7038
7904
  {
7039
7905
  "kind": "field",
7040
- "name": "secondaryLabel",
7906
+ "name": "label",
7041
7907
  "type": {
7042
7908
  "text": "string | undefined"
7043
7909
  },
7044
- "description": "The secondary label of the list item.\nThis appears on the leading side of the list item.",
7045
- "attribute": "secondary-label",
7046
- "reflects": true
7910
+ "description": "The primary label of the list item.\nThis appears on the leading side of the list item.",
7911
+ "attribute": "label",
7912
+ "reflects": true,
7913
+ "inheritedFrom": {
7914
+ "name": "ListItem",
7915
+ "module": "components/listitem/listitem.component.js"
7916
+ }
7047
7917
  },
7048
7918
  {
7049
7919
  "kind": "field",
@@ -7053,32 +7923,16 @@
7053
7923
  },
7054
7924
  "description": "The tertiary label of the list item.\nThis appears on the leading side of the list item.",
7055
7925
  "attribute": "tertiary-label",
7056
- "reflects": true
7057
- },
7058
- {
7059
- "kind": "field",
7060
- "name": "sideHeaderText",
7061
- "type": {
7062
- "text": "string | undefined"
7063
- },
7064
- "description": "The header text of the list item.\nThis appears on the trailing side of the list item.",
7065
- "attribute": "side-header-text",
7066
- "reflects": true
7067
- },
7068
- {
7069
- "kind": "field",
7070
- "name": "sublineText",
7071
- "type": {
7072
- "text": "string | undefined"
7073
- },
7074
- "description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
7075
- "attribute": "subline-text",
7076
- "reflects": true
7926
+ "reflects": true,
7927
+ "inheritedFrom": {
7928
+ "name": "ListItem",
7929
+ "module": "components/listitem/listitem.component.js"
7930
+ }
7077
7931
  },
7078
7932
  {
7079
7933
  "kind": "method",
7080
7934
  "name": "getText",
7081
- "privacy": "private",
7935
+ "privacy": "protected",
7082
7936
  "return": {
7083
7937
  "type": {
7084
7938
  "text": ""
@@ -7108,7 +7962,11 @@
7108
7962
  "description": "The text content to be displayed within the slot."
7109
7963
  }
7110
7964
  ],
7111
- "description": "Generates a template for a text slot with the specified content."
7965
+ "description": "Generates a template for a text slot with the specified content.",
7966
+ "inheritedFrom": {
7967
+ "name": "ListItem",
7968
+ "module": "components/listitem/listitem.component.js"
7969
+ }
7112
7970
  },
7113
7971
  {
7114
7972
  "kind": "method",
@@ -7121,144 +7979,126 @@
7121
7979
  },
7122
7980
  "parameters": [
7123
7981
  {
7124
- "name": "disabled",
7125
- "type": {
7126
- "text": "boolean"
7127
- },
7128
- "description": "Whether to disable or enable the controls."
7129
- }
7130
- ],
7131
- "description": "Disable or enable all slotted elements in the leading and trailing slots.\nThis is useful when the list item is disabled, to prevent the user from interacting with the controls."
7132
- },
7133
- {
7134
- "kind": "field",
7135
- "name": "role",
7136
- "type": {
7137
- "text": "string"
7138
- },
7139
- "default": "'listitem'"
7140
- },
7141
- {
7142
- "kind": "field",
7143
- "name": "dataAriaLabel",
7144
- "type": {
7145
- "text": "string | null"
7146
- },
7147
- "default": "null",
7148
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7149
- "attribute": "data-aria-label",
7150
- "reflects": true,
7151
- "inheritedFrom": {
7152
- "name": "DataAriaLabelMixin",
7153
- "module": "utils/mixins/DataAriaLabelMixin.js"
7154
- }
7155
- },
7156
- {
7157
- "kind": "field",
7158
- "name": "disabled",
7159
- "type": {
7160
- "text": "boolean"
7161
- },
7162
- "default": "false",
7163
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7164
- "attribute": "disabled",
7165
- "reflects": true,
7166
- "inheritedFrom": {
7167
- "name": "DisabledMixin",
7168
- "module": "utils/mixins/DisabledMixin.js"
7169
- }
7170
- },
7171
- {
7172
- "kind": "field",
7173
- "name": "tabIndex",
7174
- "type": {
7175
- "text": "number"
7176
- },
7177
- "default": "0",
7178
- "description": "This property specifies the tab order of the element.",
7179
- "attribute": "tabIndex",
7180
- "reflects": true,
7982
+ "name": "disabled",
7983
+ "type": {
7984
+ "text": "boolean"
7985
+ },
7986
+ "description": "Whether to disable or enable the controls."
7987
+ }
7988
+ ],
7989
+ "description": "Disable or enable all slotted elements in the leading and trailing slots.\nThis is useful when the list item is disabled, to prevent the user from interacting with the controls.",
7181
7990
  "inheritedFrom": {
7182
- "name": "TabIndexMixin",
7183
- "module": "utils/mixins/TabIndexMixin.js"
7991
+ "name": "ListItem",
7992
+ "module": "components/listitem/listitem.component.js"
7184
7993
  }
7185
7994
  }
7186
7995
  ],
7187
7996
  "events": [
7188
7997
  {
7189
- "description": "(React: onClick) This event is dispatched when the listitem is clicked.",
7998
+ "description": "(React: onClick) This event is dispatched when the option is clicked.",
7190
7999
  "name": "click",
7191
8000
  "reactName": "onClick",
7192
- "eventName": "ClickEvent"
8001
+ "eventName": "ClickEvent",
8002
+ "inheritedFrom": {
8003
+ "name": "ListItem",
8004
+ "module": "src/components/listitem/listitem.component.ts"
8005
+ }
7193
8006
  },
7194
8007
  {
7195
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the listitem.",
8008
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the option.",
7196
8009
  "name": "keydown",
7197
8010
  "reactName": "onKeyDown",
7198
- "eventName": "KeydownEvent"
8011
+ "eventName": "KeydownEvent",
8012
+ "inheritedFrom": {
8013
+ "name": "ListItem",
8014
+ "module": "src/components/listitem/listitem.component.ts"
8015
+ }
7199
8016
  },
7200
8017
  {
7201
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the listitem.",
8018
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the option.",
7202
8019
  "name": "keyup",
7203
8020
  "reactName": "onKeyUp",
7204
- "eventName": "KeyupEvent"
8021
+ "eventName": "KeyupEvent",
8022
+ "inheritedFrom": {
8023
+ "name": "ListItem",
8024
+ "module": "src/components/listitem/listitem.component.ts"
8025
+ }
7205
8026
  },
7206
8027
  {
7207
- "description": "(React: onFocus) This event is dispatched when the listitem receives focus.",
8028
+ "description": "(React: onFocus) This event is dispatched when the option receives focus.",
7208
8029
  "name": "focus",
7209
8030
  "reactName": "onFocus",
7210
- "eventName": "FocusEvent"
8031
+ "eventName": "FocusEvent",
8032
+ "inheritedFrom": {
8033
+ "name": "ListItem",
8034
+ "module": "src/components/listitem/listitem.component.ts"
8035
+ }
7211
8036
  }
7212
8037
  ],
7213
8038
  "attributes": [
7214
8039
  {
7215
- "name": "variant",
8040
+ "name": "selected",
7216
8041
  "type": {
7217
- "text": "ListItemVariants"
8042
+ "text": "boolean"
7218
8043
  },
7219
- "description": "The variant of the list item. It can be a pill, rectangle or a full-width.",
7220
- "default": "'full-width'",
7221
- "fieldName": "variant"
8044
+ "default": "false",
8045
+ "description": "The selected attribute is used to indicate that the option is selected.",
8046
+ "fieldName": "selected"
7222
8047
  },
7223
8048
  {
7224
- "name": "label",
8049
+ "name": "prefix-icon",
7225
8050
  "type": {
7226
- "text": "string | undefined"
8051
+ "text": "IconNames | undefined"
7227
8052
  },
7228
- "description": "The primary label of the list item.\nThis appears on the leading side of the list item.",
7229
- "fieldName": "label"
8053
+ "description": "The prefix icon attribute is used to display the icon name on the left of the option label.",
8054
+ "fieldName": "prefixIcon"
7230
8055
  },
7231
8056
  {
7232
- "name": "secondary-label",
8057
+ "name": "aria-label",
7233
8058
  "type": {
7234
- "text": "string | undefined"
8059
+ "text": "string | null"
7235
8060
  },
7236
- "description": "The secondary label of the list item.\nThis appears on the leading side of the list item.",
7237
- "fieldName": "secondaryLabel"
8061
+ "default": "null",
8062
+ "description": "Any additional description can be provided here for screen readers.",
8063
+ "fieldName": "ariaLabel"
7238
8064
  },
7239
8065
  {
7240
- "name": "tertiary-label",
8066
+ "name": "name",
7241
8067
  "type": {
7242
- "text": "string | undefined"
8068
+ "text": "string"
7243
8069
  },
7244
- "description": "The tertiary label of the list item.\nThis appears on the leading side of the list item.",
7245
- "fieldName": "tertiaryLabel"
8070
+ "default": "''",
8071
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
8072
+ "fieldName": "name",
8073
+ "inheritedFrom": {
8074
+ "name": "FormInternalsMixin",
8075
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
8076
+ }
7246
8077
  },
7247
8078
  {
7248
- "name": "side-header-text",
8079
+ "name": "value",
7249
8080
  "type": {
7250
- "text": "string | undefined"
8081
+ "text": "string"
7251
8082
  },
7252
- "description": "The header text of the list item.\nThis appears on the trailing side of the list item.",
7253
- "fieldName": "sideHeaderText"
8083
+ "default": "''",
8084
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
8085
+ "fieldName": "value",
8086
+ "inheritedFrom": {
8087
+ "name": "FormInternalsMixin",
8088
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
8089
+ }
7254
8090
  },
7255
8091
  {
7256
- "name": "subline-text",
8092
+ "name": "validation-message",
7257
8093
  "type": {
7258
8094
  "text": "string | undefined"
7259
8095
  },
7260
- "description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
7261
- "fieldName": "sublineText"
8096
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
8097
+ "fieldName": "validationMessage",
8098
+ "inheritedFrom": {
8099
+ "name": "FormInternalsMixin",
8100
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
8101
+ }
7262
8102
  },
7263
8103
  {
7264
8104
  "name": "data-aria-label",
@@ -7269,8 +8109,8 @@
7269
8109
  "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7270
8110
  "fieldName": "dataAriaLabel",
7271
8111
  "inheritedFrom": {
7272
- "name": "DataAriaLabelMixin",
7273
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
8112
+ "name": "ListItem",
8113
+ "module": "src/components/listitem/listitem.component.ts"
7274
8114
  }
7275
8115
  },
7276
8116
  {
@@ -7282,8 +8122,8 @@
7282
8122
  "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7283
8123
  "fieldName": "disabled",
7284
8124
  "inheritedFrom": {
7285
- "name": "DisabledMixin",
7286
- "module": "src/utils/mixins/DisabledMixin.ts"
8125
+ "name": "ListItem",
8126
+ "module": "src/components/listitem/listitem.component.ts"
7287
8127
  }
7288
8128
  },
7289
8129
  {
@@ -7295,103 +8135,147 @@
7295
8135
  "description": "This property specifies the tab order of the element.",
7296
8136
  "fieldName": "tabIndex",
7297
8137
  "inheritedFrom": {
7298
- "name": "TabIndexMixin",
7299
- "module": "src/utils/mixins/TabIndexMixin.ts"
8138
+ "name": "ListItem",
8139
+ "module": "src/components/listitem/listitem.component.ts"
7300
8140
  }
7301
- }
7302
- ],
7303
- "mixins": [
7304
- {
7305
- "name": "DataAriaLabelMixin",
7306
- "module": "/src/utils/mixins/DataAriaLabelMixin"
7307
8141
  },
7308
8142
  {
7309
- "name": "DisabledMixin",
7310
- "module": "/src/utils/mixins/DisabledMixin"
8143
+ "name": "variant",
8144
+ "type": {
8145
+ "text": "ListItemVariants"
8146
+ },
8147
+ "description": "The variant of the list item. It can be a pill, rectangle or a full-width.",
8148
+ "default": "'full-width'",
8149
+ "fieldName": "variant",
8150
+ "inheritedFrom": {
8151
+ "name": "ListItem",
8152
+ "module": "src/components/listitem/listitem.component.ts"
8153
+ }
7311
8154
  },
7312
8155
  {
7313
- "name": "TabIndexMixin",
7314
- "module": "/src/utils/mixins/TabIndexMixin"
7315
- }
7316
- ],
7317
- "superclass": {
7318
- "name": "Component",
7319
- "module": "/src/models"
7320
- },
7321
- "tagName": "mdc-listitem",
7322
- "jsDoc": "/**\n * mdc-listitem component is used to display a label with different types of controls.\n * There can be three types of controls, a radio button, a checkbox on the\n * leading side and a toggle on the trailing side.\n * The list item can contain an avatar on the leading side and a badge on the trailing side.\n * Additionally, the list item can contain a side header and a subline text.\n *\n * The leading and trailing slots can be used to display controls and text. <br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted. <br/>\n * Please use mdc-list as a parent element even when there is only listitem for a11y purpose.\n *\n * @tagname mdc-listitem\n *\n * @dependency mdc-text\n *\n * @slot leading-controls - slot for list item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for list item primary label.\n * @slot leading-text-secondary-label - slot for list item secondary label.\n * @slot leading-text-tertiary-label - slot for list item tertiary label.\n * @slot trailing-text-side-header - slot for list item side header text.\n * @slot trailing-text-subline - slot for list item subline text.\n * @slot trailing-controls - slot for list item controls to appear of trailing end.\n *\n * @cssproperty --mdc-listitem-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-listitem-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-listitem-background-color-active - Allows customization of the background color when pressed.\n * @cssproperty --mdc-listitem-primary-label-color\n * - Allows customization of the primary label, side header and subline text slot color.\n * @cssproperty --mdc-listitem-secondary-label-color\n * - Allows customization of the secondary and teritary label text slot color.\n * @cssproperty --mdc-listitem-disabled-color - Allows customization of the disabled color.\n *\n * @event click - (React: onClick) This event is dispatched when the listitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the listitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the listitem.\n * @event focus - (React: onFocus) This event is dispatched when the listitem receives focus.\n */",
7323
- "customElement": true
7324
- }
7325
- ],
7326
- "exports": [
7327
- {
7328
- "kind": "js",
7329
- "name": "default",
7330
- "declaration": {
7331
- "name": "ListItem",
7332
- "module": "components/listitem/listitem.component.js"
7333
- }
7334
- }
7335
- ]
7336
- },
7337
- {
7338
- "kind": "javascript-module",
7339
- "path": "components/marker/marker.component.js",
7340
- "declarations": [
7341
- {
7342
- "kind": "class",
7343
- "description": "`mdc-marker`, which is a vertical line and\nused to draw attention to specific parts of\nthe content or to signify important information.\n\n**Marker Variants**:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
7344
- "name": "Marker",
7345
- "cssProperties": [
7346
- {
7347
- "description": "Allows customization of the default background color in solid variant.",
7348
- "name": "--mdc-marker-solid-background-color"
8156
+ "name": "label",
8157
+ "type": {
8158
+ "text": "string | undefined"
8159
+ },
8160
+ "description": "The primary label of the list item.\nThis appears on the leading side of the list item.",
8161
+ "fieldName": "label",
8162
+ "inheritedFrom": {
8163
+ "name": "ListItem",
8164
+ "module": "src/components/listitem/listitem.component.ts"
8165
+ }
7349
8166
  },
7350
8167
  {
7351
- "description": "Allows customization of the default stripes in striped variant.",
7352
- "name": "--mdc-marker-striped-color"
8168
+ "name": "secondary-label",
8169
+ "type": {
8170
+ "text": "string | undefined"
8171
+ },
8172
+ "description": "The secondary label of the list item.\nThis appears on the leading side of the list item.",
8173
+ "fieldName": "secondaryLabel",
8174
+ "inheritedFrom": {
8175
+ "name": "ListItem",
8176
+ "module": "src/components/listitem/listitem.component.ts"
8177
+ }
7353
8178
  },
7354
8179
  {
7355
- "description": "Allows customization of the default background color in striped variant.",
7356
- "name": "--mdc-marker-striped-background-color"
8180
+ "name": "tertiary-label",
8181
+ "type": {
8182
+ "text": "string | undefined"
8183
+ },
8184
+ "description": "The tertiary label of the list item.\nThis appears on the leading side of the list item.",
8185
+ "fieldName": "tertiaryLabel",
8186
+ "inheritedFrom": {
8187
+ "name": "ListItem",
8188
+ "module": "src/components/listitem/listitem.component.ts"
8189
+ }
7357
8190
  },
7358
8191
  {
7359
- "description": "Allows customization of the default width.",
7360
- "name": "--mdc-marker-width"
7361
- }
7362
- ],
7363
- "members": [
8192
+ "name": "side-header-text",
8193
+ "type": {
8194
+ "text": "string | undefined"
8195
+ },
8196
+ "description": "The header text of the list item.\nThis appears on the trailing side of the list item.",
8197
+ "fieldName": "sideHeaderText",
8198
+ "inheritedFrom": {
8199
+ "name": "ListItem",
8200
+ "module": "src/components/listitem/listitem.component.ts"
8201
+ }
8202
+ },
7364
8203
  {
7365
- "kind": "field",
7366
- "name": "variant",
8204
+ "name": "subline-text",
7367
8205
  "type": {
7368
- "text": "MarkerVariants"
8206
+ "text": "string | undefined"
7369
8207
  },
7370
- "privacy": "public",
7371
- "description": "There are two variants of markers, each with a width of 0.25rem:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
7372
- "default": "solid",
7373
- "attribute": "variant",
7374
- "reflects": true
8208
+ "description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
8209
+ "fieldName": "sublineText",
8210
+ "inheritedFrom": {
8211
+ "name": "ListItem",
8212
+ "module": "src/components/listitem/listitem.component.ts"
8213
+ }
7375
8214
  }
7376
8215
  ],
7377
- "attributes": [
8216
+ "mixins": [
7378
8217
  {
7379
- "name": "variant",
7380
- "type": {
7381
- "text": "MarkerVariants"
7382
- },
7383
- "description": "There are two variants of markers, each with a width of 0.25rem:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
7384
- "default": "solid",
7385
- "fieldName": "variant"
8218
+ "name": "FormInternalsMixin",
8219
+ "module": "/src/utils/mixins/FormInternalsMixin"
7386
8220
  }
7387
8221
  ],
7388
8222
  "superclass": {
7389
- "name": "Component",
7390
- "module": "/src/models"
8223
+ "name": "ListItem",
8224
+ "module": "/src/components/listitem/listitem.component"
7391
8225
  },
7392
- "tagName": "mdc-marker",
7393
- "jsDoc": "/**\n * `mdc-marker`, which is a vertical line and\n * used to draw attention to specific parts of\n * the content or to signify important information.\n *\n * **Marker Variants**:\n * - **solid**: Solid marker.\n * - **striped**: Striped marker.\n *\n * @tagname mdc-marker\n *\n * @cssproperty --mdc-marker-solid-background-color - Allows customization of the default background color\n * in solid variant.\n * @cssproperty --mdc-marker-striped-color - Allows customization of the default stripes in striped variant.\n * @cssproperty --mdc-marker-striped-background-color - Allows customization of the default background color\n * in striped variant.\n * @cssproperty --mdc-marker-width - Allows customization of the default width.\n */",
7394
- "customElement": true
8226
+ "tagName": "mdc-option",
8227
+ "jsDoc": "/**\n * option component, which is used as a list item in a select component.<br/>\n * We can pass an icon which will be displayed in leading position of the option label text.\n *\n * @tagname mdc-option\n *\n * @slot default - This is a default/unnamed slot\n *\n * @event click - (React: onClick) This event is dispatched when the option is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the option.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the option.\n * @event focus - (React: onFocus) This event is dispatched when the option receives focus.\n */",
8228
+ "customElement": true,
8229
+ "cssProperties": [
8230
+ {
8231
+ "description": "Allows customization of the default background color.",
8232
+ "name": "--mdc-listitem-default-background-color",
8233
+ "inheritedFrom": {
8234
+ "name": "ListItem",
8235
+ "module": "src/components/listitem/listitem.component.ts"
8236
+ }
8237
+ },
8238
+ {
8239
+ "description": "Allows customization of the background color on hover.",
8240
+ "name": "--mdc-listitem-background-color-hover",
8241
+ "inheritedFrom": {
8242
+ "name": "ListItem",
8243
+ "module": "src/components/listitem/listitem.component.ts"
8244
+ }
8245
+ },
8246
+ {
8247
+ "description": "Allows customization of the background color when pressed.",
8248
+ "name": "--mdc-listitem-background-color-active",
8249
+ "inheritedFrom": {
8250
+ "name": "ListItem",
8251
+ "module": "src/components/listitem/listitem.component.ts"
8252
+ }
8253
+ },
8254
+ {
8255
+ "description": "Allows customization of the primary label, side header and subline text slot color.",
8256
+ "name": "--mdc-listitem-primary-label-color",
8257
+ "inheritedFrom": {
8258
+ "name": "ListItem",
8259
+ "module": "src/components/listitem/listitem.component.ts"
8260
+ }
8261
+ },
8262
+ {
8263
+ "description": "Allows customization of the secondary and teritary label text slot color.",
8264
+ "name": "--mdc-listitem-secondary-label-color",
8265
+ "inheritedFrom": {
8266
+ "name": "ListItem",
8267
+ "module": "src/components/listitem/listitem.component.ts"
8268
+ }
8269
+ },
8270
+ {
8271
+ "description": "Allows customization of the disabled color.",
8272
+ "name": "--mdc-listitem-disabled-color",
8273
+ "inheritedFrom": {
8274
+ "name": "ListItem",
8275
+ "module": "src/components/listitem/listitem.component.ts"
8276
+ }
8277
+ }
8278
+ ]
7395
8279
  }
7396
8280
  ],
7397
8281
  "exports": [
@@ -7399,8 +8283,8 @@
7399
8283
  "kind": "js",
7400
8284
  "name": "default",
7401
8285
  "declaration": {
7402
- "name": "Marker",
7403
- "module": "components/marker/marker.component.js"
8286
+ "name": "Option",
8287
+ "module": "components/option/option.component.js"
7404
8288
  }
7405
8289
  }
7406
8290
  ]
@@ -7462,7 +8346,8 @@
7462
8346
  },
7463
8347
  "default": "''",
7464
8348
  "description": "The unique ID of the popover.",
7465
- "attribute": "id"
8349
+ "attribute": "id",
8350
+ "reflects": true
7466
8351
  },
7467
8352
  {
7468
8353
  "kind": "field",
@@ -7472,7 +8357,8 @@
7472
8357
  },
7473
8358
  "default": "''",
7474
8359
  "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
7475
- "attribute": "triggerID"
8360
+ "attribute": "triggerID",
8361
+ "reflects": true
7476
8362
  },
7477
8363
  {
7478
8364
  "kind": "field",
@@ -13534,6 +14420,7 @@
13534
14420
  "default": "''",
13535
14421
  "description": "The unique ID of the popover.",
13536
14422
  "attribute": "id",
14423
+ "reflects": true,
13537
14424
  "inheritedFrom": {
13538
14425
  "name": "Popover",
13539
14426
  "module": "components/popover/popover.component.js"
@@ -13548,6 +14435,7 @@
13548
14435
  "default": "''",
13549
14436
  "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
13550
14437
  "attribute": "triggerID",
14438
+ "reflects": true,
13551
14439
  "inheritedFrom": {
13552
14440
  "name": "Popover",
13553
14441
  "module": "components/popover/popover.component.js"