@momentum-design/components 0.16.7 → 0.16.8
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/custom-elements.json +582 -582
- package/dist/react/index.d.ts +1 -1
- package/dist/react/index.js +1 -1
- package/package.json +1 -1
@@ -244,537 +244,322 @@
|
|
244
244
|
},
|
245
245
|
{
|
246
246
|
"kind": "javascript-module",
|
247
|
-
"path": "components/
|
247
|
+
"path": "components/badge/badge.component.js",
|
248
248
|
"declarations": [
|
249
249
|
{
|
250
250
|
"kind": "class",
|
251
|
-
"description": "The `mdc-
|
252
|
-
"name": "
|
251
|
+
"description": "The `mdc-badge` component is a versatile UI element used to\ndisplay dot, icons, counters, success, warning and error type badge.\n\nSupported badge types:\n- `dot`: Displays a dot notification badge with a blue color.\n- `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n- `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\nit shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n- `success`: Displays a success badge with a check circle icon and green color.\n- `warning`: Displays a warning badge with a warning icon and yellow color.\n- `error`: Displays a error badge with a error legacy icon and red color.\n\nFor `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n\nFor the `counter` type, the `mdc-text` component is used to render the counter value.",
|
252
|
+
"name": "Badge",
|
253
253
|
"members": [
|
254
|
-
{
|
255
|
-
"kind": "field",
|
256
|
-
"name": "ariaLabel",
|
257
|
-
"type": {
|
258
|
-
"text": "string | null"
|
259
|
-
},
|
260
|
-
"default": "null",
|
261
|
-
"description": "Aria-label attribute to be set for accessibility",
|
262
|
-
"attribute": "aria-label"
|
263
|
-
},
|
264
|
-
{
|
265
|
-
"kind": "method",
|
266
|
-
"name": "setSize",
|
267
|
-
"privacy": "private",
|
268
|
-
"parameters": [
|
269
|
-
{
|
270
|
-
"name": "size",
|
271
|
-
"type": {
|
272
|
-
"text": "AvatarSize"
|
273
|
-
}
|
274
|
-
}
|
275
|
-
]
|
276
|
-
},
|
277
|
-
{
|
278
|
-
"kind": "field",
|
279
|
-
"name": "active",
|
280
|
-
"type": {
|
281
|
-
"text": "boolean"
|
282
|
-
},
|
283
|
-
"default": "undefined as unknown",
|
284
|
-
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
|
285
|
-
"attribute": "active",
|
286
|
-
"inheritedFrom": {
|
287
|
-
"name": "Buttonsimple",
|
288
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
289
|
-
}
|
290
|
-
},
|
291
|
-
{
|
292
|
-
"kind": "field",
|
293
|
-
"name": "disabled",
|
294
|
-
"type": {
|
295
|
-
"text": "boolean"
|
296
|
-
},
|
297
|
-
"default": "undefined as unknown",
|
298
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
299
|
-
"attribute": "disabled",
|
300
|
-
"reflects": true,
|
301
|
-
"inheritedFrom": {
|
302
|
-
"name": "DisabledMixin",
|
303
|
-
"module": "utils/mixins/DisabledMixin.js"
|
304
|
-
}
|
305
|
-
},
|
306
|
-
{
|
307
|
-
"kind": "field",
|
308
|
-
"name": "softDisabled",
|
309
|
-
"type": {
|
310
|
-
"text": "boolean"
|
311
|
-
},
|
312
|
-
"default": "undefined as unknown",
|
313
|
-
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
314
|
-
"attribute": "soft-disabled",
|
315
|
-
"inheritedFrom": {
|
316
|
-
"name": "Buttonsimple",
|
317
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
318
|
-
}
|
319
|
-
},
|
320
|
-
{
|
321
|
-
"kind": "field",
|
322
|
-
"name": "role",
|
323
|
-
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
324
|
-
"default": "'button'",
|
325
|
-
"attribute": "role",
|
326
|
-
"reflects": true,
|
327
|
-
"type": {
|
328
|
-
"text": "string"
|
329
|
-
},
|
330
|
-
"inheritedFrom": {
|
331
|
-
"name": "Buttonsimple",
|
332
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
333
|
-
}
|
334
|
-
},
|
335
254
|
{
|
336
255
|
"kind": "field",
|
337
256
|
"name": "type",
|
338
257
|
"type": {
|
339
|
-
"text": "
|
258
|
+
"text": "BadgeType | undefined"
|
340
259
|
},
|
341
|
-
"description": "
|
342
|
-
"default": "button",
|
260
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
343
261
|
"attribute": "type",
|
344
|
-
"reflects": true
|
345
|
-
"inheritedFrom": {
|
346
|
-
"name": "Buttonsimple",
|
347
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
348
|
-
}
|
349
|
-
},
|
350
|
-
{
|
351
|
-
"kind": "field",
|
352
|
-
"name": "src",
|
353
|
-
"type": {
|
354
|
-
"text": "string | undefined"
|
355
|
-
},
|
356
|
-
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
357
|
-
"attribute": "src",
|
358
|
-
"inheritedFrom": {
|
359
|
-
"name": "AvatarComponentMixin",
|
360
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
361
|
-
}
|
362
|
-
},
|
363
|
-
{
|
364
|
-
"kind": "field",
|
365
|
-
"name": "initials",
|
366
|
-
"type": {
|
367
|
-
"text": "string | undefined"
|
368
|
-
},
|
369
|
-
"description": "The initials to be displayed for the avatar.",
|
370
|
-
"attribute": "initials",
|
371
|
-
"inheritedFrom": {
|
372
|
-
"name": "AvatarComponentMixin",
|
373
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
374
|
-
}
|
262
|
+
"reflects": true
|
375
263
|
},
|
376
264
|
{
|
377
265
|
"kind": "field",
|
378
|
-
"name": "
|
266
|
+
"name": "iconName",
|
379
267
|
"type": {
|
380
|
-
"text": "
|
268
|
+
"text": "IconNames | undefined"
|
381
269
|
},
|
382
|
-
"description": "
|
383
|
-
"attribute": "
|
384
|
-
"inheritedFrom": {
|
385
|
-
"name": "AvatarComponentMixin",
|
386
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
387
|
-
}
|
270
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
271
|
+
"attribute": "icon-name"
|
388
272
|
},
|
389
273
|
{
|
390
274
|
"kind": "field",
|
391
|
-
"name": "
|
275
|
+
"name": "variant",
|
392
276
|
"type": {
|
393
|
-
"text": "
|
277
|
+
"text": "IconVariant"
|
394
278
|
},
|
395
|
-
"description": "
|
396
|
-
"default": "
|
397
|
-
"attribute": "
|
398
|
-
"reflects": true
|
399
|
-
"inheritedFrom": {
|
400
|
-
"name": "Buttonsimple",
|
401
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
402
|
-
}
|
279
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
280
|
+
"default": "primary",
|
281
|
+
"attribute": "variant",
|
282
|
+
"reflects": true
|
403
283
|
},
|
404
284
|
{
|
405
285
|
"kind": "field",
|
406
|
-
"name": "
|
286
|
+
"name": "counter",
|
407
287
|
"type": {
|
408
|
-
"text": "
|
288
|
+
"text": "number | undefined"
|
409
289
|
},
|
410
|
-
"description": "
|
411
|
-
"attribute": "
|
412
|
-
"inheritedFrom": {
|
413
|
-
"name": "AvatarComponentMixin",
|
414
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
415
|
-
}
|
290
|
+
"description": "Counter is the number which can be provided in the badge.",
|
291
|
+
"attribute": "counter"
|
416
292
|
},
|
417
293
|
{
|
418
294
|
"kind": "field",
|
419
|
-
"name": "
|
295
|
+
"name": "maxCounter",
|
420
296
|
"type": {
|
421
|
-
"text": "number
|
297
|
+
"text": "number"
|
422
298
|
},
|
423
|
-
"description": "The
|
424
|
-
"
|
425
|
-
"
|
426
|
-
|
427
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
428
|
-
}
|
299
|
+
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
300
|
+
"default": "99",
|
301
|
+
"attribute": "max-counter",
|
302
|
+
"reflects": true
|
429
303
|
},
|
430
304
|
{
|
431
305
|
"kind": "field",
|
432
|
-
"name": "
|
306
|
+
"name": "overlay",
|
433
307
|
"type": {
|
434
308
|
"text": "boolean"
|
435
309
|
},
|
436
310
|
"default": "false",
|
437
|
-
"description": "
|
438
|
-
"attribute": "
|
439
|
-
"inheritedFrom": {
|
440
|
-
"name": "AvatarComponentMixin",
|
441
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
442
|
-
}
|
311
|
+
"description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
|
312
|
+
"attribute": "overlay"
|
443
313
|
},
|
444
314
|
{
|
445
315
|
"kind": "field",
|
446
|
-
"name": "
|
316
|
+
"name": "ariaLabel",
|
447
317
|
"type": {
|
448
|
-
"text": "
|
318
|
+
"text": "string | null"
|
449
319
|
},
|
450
|
-
"default": "
|
451
|
-
"description": "
|
452
|
-
"attribute": "
|
453
|
-
"reflects": true,
|
454
|
-
"inheritedFrom": {
|
455
|
-
"name": "TabIndexMixin",
|
456
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
457
|
-
}
|
458
|
-
},
|
459
|
-
{
|
460
|
-
"kind": "method",
|
461
|
-
"name": "executeAction",
|
462
|
-
"privacy": "private",
|
463
|
-
"inheritedFrom": {
|
464
|
-
"name": "Buttonsimple",
|
465
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
466
|
-
}
|
320
|
+
"default": "null",
|
321
|
+
"description": "Aria-label attribute to be set for accessibility",
|
322
|
+
"attribute": "aria-label"
|
467
323
|
},
|
468
324
|
{
|
469
325
|
"kind": "method",
|
470
|
-
"name": "
|
326
|
+
"name": "getCounterText",
|
471
327
|
"privacy": "private",
|
328
|
+
"return": {
|
329
|
+
"type": {
|
330
|
+
"text": ""
|
331
|
+
}
|
332
|
+
},
|
472
333
|
"parameters": [
|
473
334
|
{
|
474
|
-
"name": "
|
335
|
+
"name": "maxCounter",
|
475
336
|
"type": {
|
476
|
-
"text": "
|
337
|
+
"text": "number"
|
477
338
|
},
|
478
|
-
"description": "
|
339
|
+
"description": "the maximum limit which can be displayed on the badge"
|
479
340
|
},
|
480
341
|
{
|
481
|
-
"name": "
|
342
|
+
"name": "counter",
|
343
|
+
"optional": true,
|
482
344
|
"type": {
|
483
|
-
"text": "
|
345
|
+
"text": "number"
|
484
346
|
},
|
485
|
-
"description": "
|
347
|
+
"description": "the number to be displayed on the badge"
|
486
348
|
}
|
487
349
|
],
|
488
|
-
"description": "
|
489
|
-
"inheritedFrom": {
|
490
|
-
"name": "Buttonsimple",
|
491
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
492
|
-
}
|
350
|
+
"description": "If `type` is set to `counter` and if `counter` is greater than `maxCounter`,\nthen it will return a string the maxCounter value as string.\nOtherwise, it will return a string representation of `counter`.\nIf `counter` is not a number, it will return an empty string."
|
493
351
|
},
|
494
352
|
{
|
495
353
|
"kind": "method",
|
496
|
-
"name": "
|
354
|
+
"name": "getBadgeIcon",
|
497
355
|
"privacy": "private",
|
356
|
+
"return": {
|
357
|
+
"type": {
|
358
|
+
"text": ""
|
359
|
+
}
|
360
|
+
},
|
498
361
|
"parameters": [
|
499
362
|
{
|
500
|
-
"name": "
|
363
|
+
"name": "iconName",
|
501
364
|
"type": {
|
502
|
-
"text": "
|
365
|
+
"text": "string"
|
503
366
|
},
|
504
|
-
"description": "
|
367
|
+
"description": "the name of the icon from the icon set"
|
505
368
|
},
|
506
369
|
{
|
507
|
-
"name": "
|
370
|
+
"name": "backgroundClassPostfix",
|
508
371
|
"type": {
|
509
|
-
"text": "
|
372
|
+
"text": "string"
|
510
373
|
},
|
511
|
-
"description": "
|
374
|
+
"description": "postfix for the class to style the badge icon."
|
512
375
|
}
|
513
376
|
],
|
514
|
-
"description": "
|
515
|
-
"inheritedFrom": {
|
516
|
-
"name": "Buttonsimple",
|
517
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
518
|
-
}
|
377
|
+
"description": "Method to generate the badge icon."
|
519
378
|
},
|
520
379
|
{
|
521
380
|
"kind": "method",
|
522
|
-
"name": "
|
381
|
+
"name": "getBadgeDot",
|
523
382
|
"privacy": "private",
|
524
|
-
"
|
525
|
-
{
|
526
|
-
"
|
527
|
-
"type": {
|
528
|
-
"text": "HTMLElement"
|
529
|
-
},
|
530
|
-
"description": "The button element."
|
531
|
-
},
|
532
|
-
{
|
533
|
-
"name": "disabled",
|
534
|
-
"type": {
|
535
|
-
"text": "boolean"
|
536
|
-
},
|
537
|
-
"description": "The disabled state."
|
383
|
+
"return": {
|
384
|
+
"type": {
|
385
|
+
"text": ""
|
538
386
|
}
|
539
|
-
|
540
|
-
"description": "
|
541
|
-
"inheritedFrom": {
|
542
|
-
"name": "Buttonsimple",
|
543
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
544
|
-
}
|
387
|
+
},
|
388
|
+
"description": "Method to generate the badge dot template."
|
545
389
|
},
|
546
390
|
{
|
547
391
|
"kind": "method",
|
548
|
-
"name": "
|
392
|
+
"name": "getBadgeCounterText",
|
549
393
|
"privacy": "private",
|
550
|
-
"
|
551
|
-
"
|
552
|
-
|
553
|
-
|
394
|
+
"return": {
|
395
|
+
"type": {
|
396
|
+
"text": ""
|
397
|
+
}
|
398
|
+
},
|
399
|
+
"description": "Method to generate the badge text and counter template."
|
554
400
|
},
|
555
401
|
{
|
556
402
|
"kind": "method",
|
557
|
-
"name": "
|
403
|
+
"name": "setRoleByAriaLabel",
|
558
404
|
"privacy": "private",
|
559
|
-
"
|
560
|
-
{
|
561
|
-
"
|
562
|
-
"type": {
|
563
|
-
"text": "KeyboardEvent"
|
564
|
-
},
|
565
|
-
"description": "The keyboard event."
|
405
|
+
"return": {
|
406
|
+
"type": {
|
407
|
+
"text": "void"
|
566
408
|
}
|
567
|
-
|
568
|
-
"description": "
|
569
|
-
"inheritedFrom": {
|
570
|
-
"name": "Buttonsimple",
|
571
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
572
|
-
}
|
409
|
+
},
|
410
|
+
"description": "Method to set the role based on the aria-label provided.\nIf the aria-label is provided, the role of the element will be 'img'.\nOtherwise, the role will be null."
|
573
411
|
},
|
574
412
|
{
|
575
413
|
"kind": "method",
|
576
|
-
"name": "
|
414
|
+
"name": "getBadgeContentBasedOnType",
|
577
415
|
"privacy": "private",
|
578
|
-
"
|
579
|
-
{
|
580
|
-
"
|
581
|
-
"type": {
|
582
|
-
"text": "KeyboardEvent"
|
583
|
-
},
|
584
|
-
"description": "The keyboard event."
|
416
|
+
"return": {
|
417
|
+
"type": {
|
418
|
+
"text": ""
|
585
419
|
}
|
586
|
-
|
587
|
-
"description": "
|
588
|
-
"inheritedFrom": {
|
589
|
-
"name": "Buttonsimple",
|
590
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
591
|
-
}
|
420
|
+
},
|
421
|
+
"description": "Generates the badge content based on the badge type.\nUtilizes various helper methods to create the appropriate badge template based on the\ncurrent badge type. Supports 'dot', 'icon', 'counter', 'success', 'warning', and 'error'\ntypes, returning the corresponding template result for each type."
|
592
422
|
}
|
593
423
|
],
|
594
424
|
"attributes": [
|
595
425
|
{
|
596
|
-
"name": "
|
597
|
-
"type": {
|
598
|
-
"text": "string | null"
|
599
|
-
},
|
600
|
-
"default": "null",
|
601
|
-
"description": "Aria-label attribute to be set for accessibility",
|
602
|
-
"fieldName": "ariaLabel"
|
603
|
-
},
|
604
|
-
{
|
605
|
-
"name": "src",
|
606
|
-
"type": {
|
607
|
-
"text": "string | undefined"
|
608
|
-
},
|
609
|
-
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
610
|
-
"fieldName": "src",
|
611
|
-
"inheritedFrom": {
|
612
|
-
"name": "AvatarComponentMixin",
|
613
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
614
|
-
}
|
615
|
-
},
|
616
|
-
{
|
617
|
-
"name": "initials",
|
618
|
-
"type": {
|
619
|
-
"text": "string | undefined"
|
620
|
-
},
|
621
|
-
"description": "The initials to be displayed for the avatar.",
|
622
|
-
"fieldName": "initials",
|
623
|
-
"inheritedFrom": {
|
624
|
-
"name": "AvatarComponentMixin",
|
625
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
626
|
-
}
|
627
|
-
},
|
628
|
-
{
|
629
|
-
"name": "presence",
|
630
|
-
"type": {
|
631
|
-
"text": "PresenceType | undefined"
|
632
|
-
},
|
633
|
-
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
634
|
-
"fieldName": "presence",
|
635
|
-
"inheritedFrom": {
|
636
|
-
"name": "AvatarComponentMixin",
|
637
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
638
|
-
}
|
639
|
-
},
|
640
|
-
{
|
641
|
-
"name": "size",
|
426
|
+
"name": "type",
|
642
427
|
"type": {
|
643
|
-
"text": "
|
428
|
+
"text": "BadgeType | undefined"
|
644
429
|
},
|
645
|
-
"description": "
|
646
|
-
"
|
647
|
-
"fieldName": "size",
|
648
|
-
"inheritedFrom": {
|
649
|
-
"name": "Buttonsimple",
|
650
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
651
|
-
}
|
430
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
431
|
+
"fieldName": "type"
|
652
432
|
},
|
653
433
|
{
|
654
434
|
"name": "icon-name",
|
655
435
|
"type": {
|
656
436
|
"text": "IconNames | undefined"
|
657
437
|
},
|
658
|
-
"description": "Name of the icon
|
659
|
-
"fieldName": "iconName"
|
660
|
-
"inheritedFrom": {
|
661
|
-
"name": "AvatarComponentMixin",
|
662
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
663
|
-
}
|
438
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
439
|
+
"fieldName": "iconName"
|
664
440
|
},
|
665
441
|
{
|
666
|
-
"name": "
|
442
|
+
"name": "variant",
|
667
443
|
"type": {
|
668
|
-
"text": "
|
444
|
+
"text": "IconVariant"
|
669
445
|
},
|
670
|
-
"description": "
|
671
|
-
"
|
672
|
-
"
|
673
|
-
"name": "AvatarComponentMixin",
|
674
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
675
|
-
}
|
446
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
447
|
+
"default": "primary",
|
448
|
+
"fieldName": "variant"
|
676
449
|
},
|
677
450
|
{
|
678
|
-
"name": "
|
451
|
+
"name": "counter",
|
679
452
|
"type": {
|
680
|
-
"text": "
|
453
|
+
"text": "number | undefined"
|
681
454
|
},
|
682
|
-
"
|
683
|
-
"
|
684
|
-
"fieldName": "isTyping",
|
685
|
-
"inheritedFrom": {
|
686
|
-
"name": "AvatarComponentMixin",
|
687
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
688
|
-
}
|
455
|
+
"description": "Counter is the number which can be provided in the badge.",
|
456
|
+
"fieldName": "counter"
|
689
457
|
},
|
690
458
|
{
|
691
|
-
"name": "
|
459
|
+
"name": "max-counter",
|
692
460
|
"type": {
|
693
461
|
"text": "number"
|
694
462
|
},
|
695
|
-
"
|
696
|
-
"
|
697
|
-
"fieldName": "
|
698
|
-
"inheritedFrom": {
|
699
|
-
"name": "TabIndexMixin",
|
700
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
701
|
-
}
|
463
|
+
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
464
|
+
"default": "99",
|
465
|
+
"fieldName": "maxCounter"
|
702
466
|
},
|
703
467
|
{
|
704
|
-
"name": "
|
468
|
+
"name": "overlay",
|
705
469
|
"type": {
|
706
470
|
"text": "boolean"
|
707
471
|
},
|
708
472
|
"default": "false",
|
709
|
-
"description": "
|
710
|
-
"fieldName": "
|
711
|
-
"inheritedFrom": {
|
712
|
-
"name": "DisabledMixin",
|
713
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
714
|
-
}
|
473
|
+
"description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
|
474
|
+
"fieldName": "overlay"
|
715
475
|
},
|
716
476
|
{
|
717
|
-
"name": "
|
477
|
+
"name": "aria-label",
|
718
478
|
"type": {
|
719
|
-
"text": "
|
479
|
+
"text": "string | null"
|
720
480
|
},
|
721
|
-
"default": "
|
722
|
-
"description": "
|
723
|
-
"fieldName": "
|
724
|
-
|
725
|
-
|
726
|
-
|
727
|
-
|
481
|
+
"default": "null",
|
482
|
+
"description": "Aria-label attribute to be set for accessibility",
|
483
|
+
"fieldName": "ariaLabel"
|
484
|
+
}
|
485
|
+
],
|
486
|
+
"superclass": {
|
487
|
+
"name": "Component",
|
488
|
+
"module": "/src/models"
|
489
|
+
},
|
490
|
+
"tagName": "mdc-badge",
|
491
|
+
"jsDoc": "/**\n * The `mdc-badge` component is a versatile UI element used to\n * display dot, icons, counters, success, warning and error type badge.\n *\n * Supported badge types:\n * - `dot`: Displays a dot notification badge with a blue color.\n * - `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n * - `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\n * it shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n * - `success`: Displays a success badge with a check circle icon and green color.\n * - `warning`: Displays a warning badge with a warning icon and yellow color.\n * - `error`: Displays a error badge with a error legacy icon and red color.\n *\n * For `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n *\n * For the `counter` type, the `mdc-text` component is used to render the counter value.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-badge\n */",
|
492
|
+
"customElement": true
|
493
|
+
}
|
494
|
+
],
|
495
|
+
"exports": [
|
496
|
+
{
|
497
|
+
"kind": "js",
|
498
|
+
"name": "default",
|
499
|
+
"declaration": {
|
500
|
+
"name": "Badge",
|
501
|
+
"module": "components/badge/badge.component.js"
|
502
|
+
}
|
503
|
+
}
|
504
|
+
]
|
505
|
+
},
|
506
|
+
{
|
507
|
+
"kind": "javascript-module",
|
508
|
+
"path": "components/bullet/bullet.component.js",
|
509
|
+
"declarations": [
|
510
|
+
{
|
511
|
+
"kind": "class",
|
512
|
+
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
513
|
+
"name": "Bullet",
|
514
|
+
"cssProperties": [
|
515
|
+
{
|
516
|
+
"description": "background color of the bullet",
|
517
|
+
"name": "--mdc-bullet-background-color"
|
728
518
|
},
|
729
519
|
{
|
730
|
-
"
|
731
|
-
"
|
732
|
-
"text": "boolean"
|
733
|
-
},
|
734
|
-
"default": "false",
|
735
|
-
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
736
|
-
"fieldName": "softDisabled",
|
737
|
-
"inheritedFrom": {
|
738
|
-
"name": "Buttonsimple",
|
739
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
740
|
-
}
|
520
|
+
"description": "small size value of the bullet",
|
521
|
+
"name": "--mdc-bullet-size-small"
|
741
522
|
},
|
742
523
|
{
|
743
|
-
"
|
744
|
-
"
|
745
|
-
"default": "button",
|
746
|
-
"fieldName": "role",
|
747
|
-
"inheritedFrom": {
|
748
|
-
"name": "Buttonsimple",
|
749
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
750
|
-
}
|
524
|
+
"description": "medium size value of the bullet",
|
525
|
+
"name": "--mdc-bullet-size-medium"
|
751
526
|
},
|
752
527
|
{
|
753
|
-
"
|
528
|
+
"description": "large size value of the bullet",
|
529
|
+
"name": "--mdc-bullet-size-large"
|
530
|
+
}
|
531
|
+
],
|
532
|
+
"members": [
|
533
|
+
{
|
534
|
+
"kind": "field",
|
535
|
+
"name": "size",
|
754
536
|
"type": {
|
755
|
-
"text": "
|
537
|
+
"text": "Size"
|
756
538
|
},
|
757
|
-
"
|
758
|
-
"
|
759
|
-
"
|
760
|
-
"
|
761
|
-
|
762
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
763
|
-
}
|
539
|
+
"privacy": "public",
|
540
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
541
|
+
"default": "small",
|
542
|
+
"attribute": "size",
|
543
|
+
"reflects": true
|
764
544
|
}
|
765
545
|
],
|
766
|
-
"
|
546
|
+
"attributes": [
|
767
547
|
{
|
768
|
-
"name": "
|
769
|
-
"
|
548
|
+
"name": "size",
|
549
|
+
"type": {
|
550
|
+
"text": "Size"
|
551
|
+
},
|
552
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
553
|
+
"default": "small",
|
554
|
+
"fieldName": "size"
|
770
555
|
}
|
771
556
|
],
|
772
557
|
"superclass": {
|
773
|
-
"name": "
|
774
|
-
"module": "/src/
|
558
|
+
"name": "Component",
|
559
|
+
"module": "/src/models"
|
775
560
|
},
|
776
|
-
"tagName": "mdc-
|
777
|
-
"jsDoc": "/**\n *
|
561
|
+
"tagName": "mdc-bullet",
|
562
|
+
"jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n*/",
|
778
563
|
"customElement": true
|
779
564
|
}
|
780
565
|
],
|
@@ -783,330 +568,545 @@
|
|
783
568
|
"kind": "js",
|
784
569
|
"name": "default",
|
785
570
|
"declaration": {
|
786
|
-
"name": "
|
787
|
-
"module": "components/
|
571
|
+
"name": "Bullet",
|
572
|
+
"module": "components/bullet/bullet.component.js"
|
788
573
|
}
|
789
574
|
}
|
790
575
|
]
|
791
576
|
},
|
792
577
|
{
|
793
578
|
"kind": "javascript-module",
|
794
|
-
"path": "components/
|
579
|
+
"path": "components/avatarbutton/avatarbutton.component.js",
|
795
580
|
"declarations": [
|
796
581
|
{
|
797
582
|
"kind": "class",
|
798
|
-
"description": "The `mdc-
|
799
|
-
"name": "
|
583
|
+
"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.",
|
584
|
+
"name": "AvatarButton",
|
800
585
|
"members": [
|
586
|
+
{
|
587
|
+
"kind": "field",
|
588
|
+
"name": "ariaLabel",
|
589
|
+
"type": {
|
590
|
+
"text": "string | null"
|
591
|
+
},
|
592
|
+
"default": "null",
|
593
|
+
"description": "Aria-label attribute to be set for accessibility",
|
594
|
+
"attribute": "aria-label"
|
595
|
+
},
|
596
|
+
{
|
597
|
+
"kind": "method",
|
598
|
+
"name": "setSize",
|
599
|
+
"privacy": "private",
|
600
|
+
"parameters": [
|
601
|
+
{
|
602
|
+
"name": "size",
|
603
|
+
"type": {
|
604
|
+
"text": "AvatarSize"
|
605
|
+
}
|
606
|
+
}
|
607
|
+
]
|
608
|
+
},
|
609
|
+
{
|
610
|
+
"kind": "field",
|
611
|
+
"name": "active",
|
612
|
+
"type": {
|
613
|
+
"text": "boolean"
|
614
|
+
},
|
615
|
+
"default": "undefined as unknown",
|
616
|
+
"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.",
|
617
|
+
"attribute": "active",
|
618
|
+
"inheritedFrom": {
|
619
|
+
"name": "Buttonsimple",
|
620
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
621
|
+
}
|
622
|
+
},
|
623
|
+
{
|
624
|
+
"kind": "field",
|
625
|
+
"name": "disabled",
|
626
|
+
"type": {
|
627
|
+
"text": "boolean"
|
628
|
+
},
|
629
|
+
"default": "undefined as unknown",
|
630
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
631
|
+
"attribute": "disabled",
|
632
|
+
"reflects": true,
|
633
|
+
"inheritedFrom": {
|
634
|
+
"name": "DisabledMixin",
|
635
|
+
"module": "utils/mixins/DisabledMixin.js"
|
636
|
+
}
|
637
|
+
},
|
638
|
+
{
|
639
|
+
"kind": "field",
|
640
|
+
"name": "softDisabled",
|
641
|
+
"type": {
|
642
|
+
"text": "boolean"
|
643
|
+
},
|
644
|
+
"default": "undefined as unknown",
|
645
|
+
"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.",
|
646
|
+
"attribute": "soft-disabled",
|
647
|
+
"inheritedFrom": {
|
648
|
+
"name": "Buttonsimple",
|
649
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
650
|
+
}
|
651
|
+
},
|
652
|
+
{
|
653
|
+
"kind": "field",
|
654
|
+
"name": "role",
|
655
|
+
"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.",
|
656
|
+
"default": "'button'",
|
657
|
+
"attribute": "role",
|
658
|
+
"reflects": true,
|
659
|
+
"type": {
|
660
|
+
"text": "string"
|
661
|
+
},
|
662
|
+
"inheritedFrom": {
|
663
|
+
"name": "Buttonsimple",
|
664
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
665
|
+
}
|
666
|
+
},
|
801
667
|
{
|
802
668
|
"kind": "field",
|
803
669
|
"name": "type",
|
804
670
|
"type": {
|
805
|
-
"text": "
|
671
|
+
"text": "ButtonType"
|
806
672
|
},
|
807
|
-
"description": "
|
673
|
+
"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.",
|
674
|
+
"default": "button",
|
808
675
|
"attribute": "type",
|
809
|
-
"reflects": true
|
676
|
+
"reflects": true,
|
677
|
+
"inheritedFrom": {
|
678
|
+
"name": "Buttonsimple",
|
679
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
680
|
+
}
|
810
681
|
},
|
811
682
|
{
|
812
683
|
"kind": "field",
|
813
|
-
"name": "
|
684
|
+
"name": "src",
|
814
685
|
"type": {
|
815
|
-
"text": "
|
686
|
+
"text": "string | undefined"
|
816
687
|
},
|
817
|
-
"description": "
|
818
|
-
"attribute": "
|
688
|
+
"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.",
|
689
|
+
"attribute": "src",
|
690
|
+
"inheritedFrom": {
|
691
|
+
"name": "AvatarComponentMixin",
|
692
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
693
|
+
}
|
819
694
|
},
|
820
695
|
{
|
821
696
|
"kind": "field",
|
822
|
-
"name": "
|
697
|
+
"name": "initials",
|
823
698
|
"type": {
|
824
|
-
"text": "
|
699
|
+
"text": "string | undefined"
|
825
700
|
},
|
826
|
-
"description": "
|
827
|
-
"
|
828
|
-
"
|
829
|
-
|
701
|
+
"description": "The initials to be displayed for the avatar.",
|
702
|
+
"attribute": "initials",
|
703
|
+
"inheritedFrom": {
|
704
|
+
"name": "AvatarComponentMixin",
|
705
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
706
|
+
}
|
830
707
|
},
|
831
708
|
{
|
832
709
|
"kind": "field",
|
833
|
-
"name": "
|
710
|
+
"name": "presence",
|
834
711
|
"type": {
|
835
|
-
"text": "
|
712
|
+
"text": "PresenceType | undefined"
|
836
713
|
},
|
837
|
-
"description": "
|
838
|
-
"attribute": "
|
714
|
+
"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`",
|
715
|
+
"attribute": "presence",
|
716
|
+
"inheritedFrom": {
|
717
|
+
"name": "AvatarComponentMixin",
|
718
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
719
|
+
}
|
839
720
|
},
|
840
721
|
{
|
841
722
|
"kind": "field",
|
842
|
-
"name": "
|
723
|
+
"name": "size",
|
843
724
|
"type": {
|
844
|
-
"text": "
|
725
|
+
"text": "ButtonSize"
|
845
726
|
},
|
846
|
-
"description": "
|
847
|
-
"default": "
|
848
|
-
"attribute": "
|
849
|
-
"reflects": true
|
727
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
728
|
+
"default": "32",
|
729
|
+
"attribute": "size",
|
730
|
+
"reflects": true,
|
731
|
+
"inheritedFrom": {
|
732
|
+
"name": "Buttonsimple",
|
733
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
734
|
+
}
|
850
735
|
},
|
851
736
|
{
|
852
737
|
"kind": "field",
|
853
|
-
"name": "
|
738
|
+
"name": "iconName",
|
739
|
+
"type": {
|
740
|
+
"text": "IconNames | undefined"
|
741
|
+
},
|
742
|
+
"description": "Name of the icon to be displayed inside the Avatar.\nMust be a valid icon name.",
|
743
|
+
"attribute": "icon-name",
|
744
|
+
"inheritedFrom": {
|
745
|
+
"name": "AvatarComponentMixin",
|
746
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
747
|
+
}
|
748
|
+
},
|
749
|
+
{
|
750
|
+
"kind": "field",
|
751
|
+
"name": "counter",
|
752
|
+
"type": {
|
753
|
+
"text": "number | undefined"
|
754
|
+
},
|
755
|
+
"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`.",
|
756
|
+
"attribute": "counter",
|
757
|
+
"inheritedFrom": {
|
758
|
+
"name": "AvatarComponentMixin",
|
759
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
760
|
+
}
|
761
|
+
},
|
762
|
+
{
|
763
|
+
"kind": "field",
|
764
|
+
"name": "isTyping",
|
854
765
|
"type": {
|
855
766
|
"text": "boolean"
|
856
767
|
},
|
857
768
|
"default": "false",
|
858
|
-
"description": "
|
859
|
-
"attribute": "
|
769
|
+
"description": "Represents the typing indicator when the user is typing.",
|
770
|
+
"attribute": "is-typing",
|
771
|
+
"inheritedFrom": {
|
772
|
+
"name": "AvatarComponentMixin",
|
773
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
774
|
+
}
|
860
775
|
},
|
861
776
|
{
|
862
777
|
"kind": "field",
|
863
|
-
"name": "
|
778
|
+
"name": "tabIndex",
|
864
779
|
"type": {
|
865
|
-
"text": "
|
780
|
+
"text": "number"
|
866
781
|
},
|
867
|
-
"default": "
|
868
|
-
"description": "
|
869
|
-
"attribute": "
|
782
|
+
"default": "0",
|
783
|
+
"description": "This property specifies the tab order of the element.",
|
784
|
+
"attribute": "tabIndex",
|
785
|
+
"reflects": true,
|
786
|
+
"inheritedFrom": {
|
787
|
+
"name": "TabIndexMixin",
|
788
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
789
|
+
}
|
870
790
|
},
|
871
791
|
{
|
872
792
|
"kind": "method",
|
873
|
-
"name": "
|
793
|
+
"name": "executeAction",
|
794
|
+
"privacy": "private",
|
795
|
+
"inheritedFrom": {
|
796
|
+
"name": "Buttonsimple",
|
797
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
798
|
+
}
|
799
|
+
},
|
800
|
+
{
|
801
|
+
"kind": "method",
|
802
|
+
"name": "setAriaPressed",
|
874
803
|
"privacy": "private",
|
875
|
-
"return": {
|
876
|
-
"type": {
|
877
|
-
"text": ""
|
878
|
-
}
|
879
|
-
},
|
880
804
|
"parameters": [
|
881
805
|
{
|
882
|
-
"name": "
|
806
|
+
"name": "element",
|
883
807
|
"type": {
|
884
|
-
"text": "
|
808
|
+
"text": "HTMLElement"
|
885
809
|
},
|
886
|
-
"description": "
|
810
|
+
"description": "The target element."
|
887
811
|
},
|
888
812
|
{
|
889
|
-
"name": "
|
890
|
-
"optional": true,
|
813
|
+
"name": "active",
|
891
814
|
"type": {
|
892
|
-
"text": "
|
815
|
+
"text": "boolean"
|
893
816
|
},
|
894
|
-
"description": "
|
817
|
+
"description": "The active state."
|
895
818
|
}
|
896
819
|
],
|
897
|
-
"description": "
|
820
|
+
"description": "Sets the aria-pressed attribute based on the active state.",
|
821
|
+
"inheritedFrom": {
|
822
|
+
"name": "Buttonsimple",
|
823
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
824
|
+
}
|
898
825
|
},
|
899
826
|
{
|
900
827
|
"kind": "method",
|
901
|
-
"name": "
|
828
|
+
"name": "setSoftDisabled",
|
902
829
|
"privacy": "private",
|
903
|
-
"
|
904
|
-
|
905
|
-
"
|
830
|
+
"parameters": [
|
831
|
+
{
|
832
|
+
"name": "element",
|
833
|
+
"type": {
|
834
|
+
"text": "HTMLElement"
|
835
|
+
},
|
836
|
+
"description": "The button element."
|
837
|
+
},
|
838
|
+
{
|
839
|
+
"name": "softDisabled",
|
840
|
+
"type": {
|
841
|
+
"text": "boolean"
|
842
|
+
},
|
843
|
+
"description": "The soft-disabled state."
|
906
844
|
}
|
907
|
-
|
845
|
+
],
|
846
|
+
"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.",
|
847
|
+
"inheritedFrom": {
|
848
|
+
"name": "Buttonsimple",
|
849
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
850
|
+
}
|
851
|
+
},
|
852
|
+
{
|
853
|
+
"kind": "method",
|
854
|
+
"name": "setDisabled",
|
855
|
+
"privacy": "private",
|
908
856
|
"parameters": [
|
909
857
|
{
|
910
|
-
"name": "
|
858
|
+
"name": "element",
|
911
859
|
"type": {
|
912
|
-
"text": "
|
860
|
+
"text": "HTMLElement"
|
913
861
|
},
|
914
|
-
"description": "
|
862
|
+
"description": "The button element."
|
915
863
|
},
|
916
864
|
{
|
917
|
-
"name": "
|
865
|
+
"name": "disabled",
|
918
866
|
"type": {
|
919
|
-
"text": "
|
867
|
+
"text": "boolean"
|
920
868
|
},
|
921
|
-
"description": "
|
869
|
+
"description": "The disabled state."
|
922
870
|
}
|
923
871
|
],
|
924
|
-
"description": "
|
872
|
+
"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.",
|
873
|
+
"inheritedFrom": {
|
874
|
+
"name": "Buttonsimple",
|
875
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
876
|
+
}
|
877
|
+
},
|
878
|
+
{
|
879
|
+
"kind": "method",
|
880
|
+
"name": "triggerClickEvent",
|
881
|
+
"privacy": "private",
|
882
|
+
"inheritedFrom": {
|
883
|
+
"name": "Buttonsimple",
|
884
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
885
|
+
}
|
886
|
+
},
|
887
|
+
{
|
888
|
+
"kind": "method",
|
889
|
+
"name": "handleKeyDown",
|
890
|
+
"privacy": "private",
|
891
|
+
"parameters": [
|
892
|
+
{
|
893
|
+
"name": "event",
|
894
|
+
"type": {
|
895
|
+
"text": "KeyboardEvent"
|
896
|
+
},
|
897
|
+
"description": "The keyboard event."
|
898
|
+
}
|
899
|
+
],
|
900
|
+
"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.",
|
901
|
+
"inheritedFrom": {
|
902
|
+
"name": "Buttonsimple",
|
903
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
904
|
+
}
|
925
905
|
},
|
926
906
|
{
|
927
|
-
"kind": "method",
|
928
|
-
"name": "
|
929
|
-
"privacy": "private",
|
930
|
-
"
|
931
|
-
|
932
|
-
"
|
933
|
-
|
907
|
+
"kind": "method",
|
908
|
+
"name": "handleKeyUp",
|
909
|
+
"privacy": "private",
|
910
|
+
"parameters": [
|
911
|
+
{
|
912
|
+
"name": "event",
|
913
|
+
"type": {
|
914
|
+
"text": "KeyboardEvent"
|
915
|
+
},
|
916
|
+
"description": "The keyboard event."
|
917
|
+
}
|
918
|
+
],
|
919
|
+
"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.",
|
920
|
+
"inheritedFrom": {
|
921
|
+
"name": "Buttonsimple",
|
922
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
923
|
+
}
|
924
|
+
}
|
925
|
+
],
|
926
|
+
"attributes": [
|
927
|
+
{
|
928
|
+
"name": "aria-label",
|
929
|
+
"type": {
|
930
|
+
"text": "string | null"
|
934
931
|
},
|
935
|
-
"
|
932
|
+
"default": "null",
|
933
|
+
"description": "Aria-label attribute to be set for accessibility",
|
934
|
+
"fieldName": "ariaLabel"
|
936
935
|
},
|
937
936
|
{
|
938
|
-
"
|
939
|
-
"
|
940
|
-
|
941
|
-
"return": {
|
942
|
-
"type": {
|
943
|
-
"text": ""
|
944
|
-
}
|
937
|
+
"name": "src",
|
938
|
+
"type": {
|
939
|
+
"text": "string | undefined"
|
945
940
|
},
|
946
|
-
"description": "
|
941
|
+
"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.",
|
942
|
+
"fieldName": "src",
|
943
|
+
"inheritedFrom": {
|
944
|
+
"name": "AvatarComponentMixin",
|
945
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
946
|
+
}
|
947
947
|
},
|
948
948
|
{
|
949
|
-
"
|
950
|
-
"
|
951
|
-
|
952
|
-
"return": {
|
953
|
-
"type": {
|
954
|
-
"text": "void"
|
955
|
-
}
|
949
|
+
"name": "initials",
|
950
|
+
"type": {
|
951
|
+
"text": "string | undefined"
|
956
952
|
},
|
957
|
-
"description": "
|
953
|
+
"description": "The initials to be displayed for the avatar.",
|
954
|
+
"fieldName": "initials",
|
955
|
+
"inheritedFrom": {
|
956
|
+
"name": "AvatarComponentMixin",
|
957
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
958
|
+
}
|
958
959
|
},
|
959
960
|
{
|
960
|
-
"
|
961
|
-
"
|
962
|
-
|
963
|
-
"return": {
|
964
|
-
"type": {
|
965
|
-
"text": ""
|
966
|
-
}
|
961
|
+
"name": "presence",
|
962
|
+
"type": {
|
963
|
+
"text": "PresenceType | undefined"
|
967
964
|
},
|
968
|
-
"description": "
|
969
|
-
|
970
|
-
|
971
|
-
|
965
|
+
"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`",
|
966
|
+
"fieldName": "presence",
|
967
|
+
"inheritedFrom": {
|
968
|
+
"name": "AvatarComponentMixin",
|
969
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
970
|
+
}
|
971
|
+
},
|
972
972
|
{
|
973
|
-
"name": "
|
973
|
+
"name": "size",
|
974
974
|
"type": {
|
975
|
-
"text": "
|
975
|
+
"text": "ButtonSize"
|
976
976
|
},
|
977
|
-
"description": "
|
978
|
-
"
|
977
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
978
|
+
"default": "32",
|
979
|
+
"fieldName": "size",
|
980
|
+
"inheritedFrom": {
|
981
|
+
"name": "Buttonsimple",
|
982
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
983
|
+
}
|
979
984
|
},
|
980
985
|
{
|
981
986
|
"name": "icon-name",
|
982
987
|
"type": {
|
983
988
|
"text": "IconNames | undefined"
|
984
989
|
},
|
985
|
-
"description": "Name of the icon
|
986
|
-
"fieldName": "iconName"
|
990
|
+
"description": "Name of the icon to be displayed inside the Avatar.\nMust be a valid icon name.",
|
991
|
+
"fieldName": "iconName",
|
992
|
+
"inheritedFrom": {
|
993
|
+
"name": "AvatarComponentMixin",
|
994
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
995
|
+
}
|
987
996
|
},
|
988
997
|
{
|
989
|
-
"name": "
|
998
|
+
"name": "counter",
|
990
999
|
"type": {
|
991
|
-
"text": "
|
1000
|
+
"text": "number | undefined"
|
992
1001
|
},
|
993
|
-
"description": "
|
994
|
-
"
|
995
|
-
"
|
1002
|
+
"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`.",
|
1003
|
+
"fieldName": "counter",
|
1004
|
+
"inheritedFrom": {
|
1005
|
+
"name": "AvatarComponentMixin",
|
1006
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1007
|
+
}
|
996
1008
|
},
|
997
1009
|
{
|
998
|
-
"name": "
|
1010
|
+
"name": "is-typing",
|
999
1011
|
"type": {
|
1000
|
-
"text": "
|
1012
|
+
"text": "boolean"
|
1001
1013
|
},
|
1002
|
-
"
|
1003
|
-
"
|
1014
|
+
"default": "false",
|
1015
|
+
"description": "Represents the typing indicator when the user is typing.",
|
1016
|
+
"fieldName": "isTyping",
|
1017
|
+
"inheritedFrom": {
|
1018
|
+
"name": "AvatarComponentMixin",
|
1019
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1020
|
+
}
|
1004
1021
|
},
|
1005
1022
|
{
|
1006
|
-
"name": "
|
1023
|
+
"name": "tabIndex",
|
1007
1024
|
"type": {
|
1008
1025
|
"text": "number"
|
1009
1026
|
},
|
1010
|
-
"
|
1011
|
-
"
|
1012
|
-
"fieldName": "
|
1027
|
+
"default": "0",
|
1028
|
+
"description": "This property specifies the tab order of the element.",
|
1029
|
+
"fieldName": "tabIndex",
|
1030
|
+
"inheritedFrom": {
|
1031
|
+
"name": "TabIndexMixin",
|
1032
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
1033
|
+
}
|
1013
1034
|
},
|
1014
1035
|
{
|
1015
|
-
"name": "
|
1036
|
+
"name": "disabled",
|
1016
1037
|
"type": {
|
1017
1038
|
"text": "boolean"
|
1018
1039
|
},
|
1019
1040
|
"default": "false",
|
1020
|
-
"description": "
|
1021
|
-
"fieldName": "
|
1041
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1042
|
+
"fieldName": "disabled",
|
1043
|
+
"inheritedFrom": {
|
1044
|
+
"name": "DisabledMixin",
|
1045
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
1046
|
+
}
|
1022
1047
|
},
|
1023
1048
|
{
|
1024
|
-
"name": "
|
1049
|
+
"name": "active",
|
1025
1050
|
"type": {
|
1026
|
-
"text": "
|
1051
|
+
"text": "boolean"
|
1027
1052
|
},
|
1028
|
-
"default": "
|
1029
|
-
"description": "
|
1030
|
-
"fieldName": "
|
1031
|
-
|
1032
|
-
|
1033
|
-
|
1034
|
-
|
1035
|
-
"module": "/src/models"
|
1036
|
-
},
|
1037
|
-
"tagName": "mdc-badge",
|
1038
|
-
"jsDoc": "/**\n * The `mdc-badge` component is a versatile UI element used to\n * display dot, icons, counters, success, warning and error type badge.\n *\n * Supported badge types:\n * - `dot`: Displays a dot notification badge with a blue color.\n * - `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n * - `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\n * it shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n * - `success`: Displays a success badge with a check circle icon and green color.\n * - `warning`: Displays a warning badge with a warning icon and yellow color.\n * - `error`: Displays a error badge with a error legacy icon and red color.\n *\n * For `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n *\n * For the `counter` type, the `mdc-text` component is used to render the counter value.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-badge\n */",
|
1039
|
-
"customElement": true
|
1040
|
-
}
|
1041
|
-
],
|
1042
|
-
"exports": [
|
1043
|
-
{
|
1044
|
-
"kind": "js",
|
1045
|
-
"name": "default",
|
1046
|
-
"declaration": {
|
1047
|
-
"name": "Badge",
|
1048
|
-
"module": "components/badge/badge.component.js"
|
1049
|
-
}
|
1050
|
-
}
|
1051
|
-
]
|
1052
|
-
},
|
1053
|
-
{
|
1054
|
-
"kind": "javascript-module",
|
1055
|
-
"path": "components/bullet/bullet.component.js",
|
1056
|
-
"declarations": [
|
1057
|
-
{
|
1058
|
-
"kind": "class",
|
1059
|
-
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
1060
|
-
"name": "Bullet",
|
1061
|
-
"cssProperties": [
|
1062
|
-
{
|
1063
|
-
"description": "background color of the bullet",
|
1064
|
-
"name": "--mdc-bullet-background-color"
|
1053
|
+
"default": "false",
|
1054
|
+
"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.",
|
1055
|
+
"fieldName": "active",
|
1056
|
+
"inheritedFrom": {
|
1057
|
+
"name": "Buttonsimple",
|
1058
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1059
|
+
}
|
1065
1060
|
},
|
1066
1061
|
{
|
1067
|
-
"
|
1068
|
-
"
|
1062
|
+
"name": "soft-disabled",
|
1063
|
+
"type": {
|
1064
|
+
"text": "boolean"
|
1065
|
+
},
|
1066
|
+
"default": "false",
|
1067
|
+
"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.",
|
1068
|
+
"fieldName": "softDisabled",
|
1069
|
+
"inheritedFrom": {
|
1070
|
+
"name": "Buttonsimple",
|
1071
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1072
|
+
}
|
1069
1073
|
},
|
1070
1074
|
{
|
1071
|
-
"
|
1072
|
-
"
|
1075
|
+
"name": "role",
|
1076
|
+
"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.",
|
1077
|
+
"default": "button",
|
1078
|
+
"fieldName": "role",
|
1079
|
+
"inheritedFrom": {
|
1080
|
+
"name": "Buttonsimple",
|
1081
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1082
|
+
}
|
1073
1083
|
},
|
1074
1084
|
{
|
1075
|
-
"
|
1076
|
-
"name": "--mdc-bullet-size-large"
|
1077
|
-
}
|
1078
|
-
],
|
1079
|
-
"members": [
|
1080
|
-
{
|
1081
|
-
"kind": "field",
|
1082
|
-
"name": "size",
|
1085
|
+
"name": "type",
|
1083
1086
|
"type": {
|
1084
|
-
"text": "
|
1087
|
+
"text": "ButtonType"
|
1085
1088
|
},
|
1086
|
-
"
|
1087
|
-
"
|
1088
|
-
"
|
1089
|
-
"
|
1090
|
-
|
1089
|
+
"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.",
|
1090
|
+
"default": "button",
|
1091
|
+
"fieldName": "type",
|
1092
|
+
"inheritedFrom": {
|
1093
|
+
"name": "Buttonsimple",
|
1094
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1095
|
+
}
|
1091
1096
|
}
|
1092
1097
|
],
|
1093
|
-
"
|
1098
|
+
"mixins": [
|
1094
1099
|
{
|
1095
|
-
"name": "
|
1096
|
-
"
|
1097
|
-
"text": "Size"
|
1098
|
-
},
|
1099
|
-
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
1100
|
-
"default": "small",
|
1101
|
-
"fieldName": "size"
|
1100
|
+
"name": "AvatarComponentMixin",
|
1101
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
1102
1102
|
}
|
1103
1103
|
],
|
1104
1104
|
"superclass": {
|
1105
|
-
"name": "
|
1106
|
-
"module": "/src/
|
1105
|
+
"name": "Buttonsimple",
|
1106
|
+
"module": "/src/components/buttonsimple"
|
1107
1107
|
},
|
1108
|
-
"tagName": "mdc-
|
1109
|
-
"jsDoc": "/**\n *
|
1108
|
+
"tagName": "mdc-avatarbutton",
|
1109
|
+
"jsDoc": "/**\n * The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n *\n * This component is made by extending `buttonsimple` class.\n * The button component acts as a wrapper for the avatar component.\n *\n * @dependency mdc-avatar\n *\n * @tagname mdc-avatarbutton\n */",
|
1110
1110
|
"customElement": true
|
1111
1111
|
}
|
1112
1112
|
],
|
@@ -1115,8 +1115,8 @@
|
|
1115
1115
|
"kind": "js",
|
1116
1116
|
"name": "default",
|
1117
1117
|
"declaration": {
|
1118
|
-
"name": "
|
1119
|
-
"module": "components/
|
1118
|
+
"name": "AvatarButton",
|
1119
|
+
"module": "components/avatarbutton/avatarbutton.component.js"
|
1120
1120
|
}
|
1121
1121
|
}
|
1122
1122
|
]
|