@momentum-design/components 0.35.0 → 0.36.0
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.
- package/dist/browser/index.js +217 -217
- package/dist/browser/index.js.map +4 -4
- package/dist/components/coachmark/coachmark.component.d.ts +52 -0
- package/dist/components/coachmark/coachmark.component.js +82 -0
- package/dist/components/coachmark/coachmark.constants.d.ts +9 -0
- package/dist/components/coachmark/coachmark.constants.js +11 -0
- package/dist/components/coachmark/index.d.ts +8 -0
- package/dist/components/coachmark/index.js +5 -0
- package/dist/custom-elements.json +2517 -966
- package/dist/index.d.ts +2 -1
- package/dist/index.js +2 -1
- package/dist/react/coachmark/index.d.ts +23 -0
- package/dist/react/coachmark/index.js +32 -0
- package/dist/react/index.d.ts +2 -1
- package/dist/react/index.js +2 -1
- package/package.json +1 -1
@@ -248,163 +248,79 @@
|
|
248
248
|
},
|
249
249
|
{
|
250
250
|
"kind": "javascript-module",
|
251
|
-
"path": "components/
|
251
|
+
"path": "components/badge/badge.component.js",
|
252
252
|
"declarations": [
|
253
253
|
{
|
254
254
|
"kind": "class",
|
255
|
-
"description": "The `mdc-
|
256
|
-
"name": "
|
257
|
-
"
|
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
258
|
{
|
259
|
-
"
|
260
|
-
"name": "
|
261
|
-
"type": {
|
262
|
-
"text": "string | null"
|
263
|
-
},
|
264
|
-
"default": "null",
|
265
|
-
"description": "Aria-label attribute to be set for accessibility",
|
266
|
-
"attribute": "aria-label"
|
259
|
+
"description": "The foreground color of the primary badge.",
|
260
|
+
"name": "--mdc-badge-primary-foreground-color"
|
267
261
|
},
|
268
262
|
{
|
269
|
-
"
|
270
|
-
"name": "
|
271
|
-
"privacy": "private",
|
272
|
-
"parameters": [
|
273
|
-
{
|
274
|
-
"name": "size",
|
275
|
-
"type": {
|
276
|
-
"text": "AvatarSize"
|
277
|
-
}
|
278
|
-
}
|
279
|
-
]
|
263
|
+
"description": "The background color of the primary badge.",
|
264
|
+
"name": "--mdc-badge-primary-background-color"
|
280
265
|
},
|
281
266
|
{
|
282
|
-
"
|
283
|
-
"name": "
|
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
|
-
}
|
267
|
+
"description": "The foreground color of the secondary badge.",
|
268
|
+
"name": "--mdc-badge-secondary-foreground-color"
|
295
269
|
},
|
296
270
|
{
|
297
|
-
"
|
298
|
-
"name": "
|
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
|
-
}
|
271
|
+
"description": "The background color of the secondary badge.",
|
272
|
+
"name": "--mdc-badge-secondary-background-color"
|
310
273
|
},
|
311
274
|
{
|
312
|
-
"
|
313
|
-
"name": "
|
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
|
-
}
|
275
|
+
"description": "The foreground color of the success badge.",
|
276
|
+
"name": "--mdc-badge-success-foreground-color"
|
324
277
|
},
|
325
278
|
{
|
326
|
-
"
|
327
|
-
"name": "
|
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
|
-
}
|
279
|
+
"description": "The background color of the success badge.",
|
280
|
+
"name": "--mdc-badge-success-background-color"
|
339
281
|
},
|
340
282
|
{
|
341
|
-
"
|
342
|
-
"name": "
|
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
|
-
}
|
283
|
+
"description": "The foreground color of the warning badge.",
|
284
|
+
"name": "--mdc-badge-warning-foreground-color"
|
354
285
|
},
|
355
286
|
{
|
356
|
-
"
|
357
|
-
"name": "
|
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
|
-
}
|
287
|
+
"description": "The background color of the warning badge.",
|
288
|
+
"name": "--mdc-badge-warning-background-color"
|
367
289
|
},
|
368
290
|
{
|
369
|
-
"
|
370
|
-
"name": "
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
"
|
375
|
-
"attribute": "initials",
|
376
|
-
"inheritedFrom": {
|
377
|
-
"name": "AvatarComponentMixin",
|
378
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
379
|
-
}
|
291
|
+
"description": "The foreground color of the error badge.",
|
292
|
+
"name": "--mdc-badge-error-foreground-color"
|
293
|
+
},
|
294
|
+
{
|
295
|
+
"description": "The background color of the error badge.",
|
296
|
+
"name": "--mdc-badge-error-background-color"
|
380
297
|
},
|
298
|
+
{
|
299
|
+
"description": "The background color of the badge overlay.",
|
300
|
+
"name": "--mdc-badge-overlay-background-color"
|
301
|
+
}
|
302
|
+
],
|
303
|
+
"members": [
|
381
304
|
{
|
382
305
|
"kind": "field",
|
383
|
-
"name": "
|
306
|
+
"name": "type",
|
384
307
|
"type": {
|
385
|
-
"text": "
|
308
|
+
"text": "BadgeType | undefined"
|
386
309
|
},
|
387
|
-
"description": "
|
388
|
-
"attribute": "
|
389
|
-
"
|
390
|
-
"name": "AvatarComponentMixin",
|
391
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
392
|
-
}
|
310
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
311
|
+
"attribute": "type",
|
312
|
+
"reflects": true
|
393
313
|
},
|
394
314
|
{
|
395
315
|
"kind": "field",
|
396
|
-
"name": "
|
316
|
+
"name": "variant",
|
397
317
|
"type": {
|
398
|
-
"text": "
|
318
|
+
"text": "IconVariant"
|
399
319
|
},
|
400
|
-
"description": "
|
401
|
-
"default": "
|
402
|
-
"attribute": "
|
403
|
-
"reflects": true
|
404
|
-
"inheritedFrom": {
|
405
|
-
"name": "Buttonsimple",
|
406
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
407
|
-
}
|
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
|
408
324
|
},
|
409
325
|
{
|
410
326
|
"kind": "field",
|
@@ -412,325 +328,205 @@
|
|
412
328
|
"type": {
|
413
329
|
"text": "number | undefined"
|
414
330
|
},
|
415
|
-
"description": "
|
416
|
-
"attribute": "counter"
|
417
|
-
"inheritedFrom": {
|
418
|
-
"name": "AvatarComponentMixin",
|
419
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
420
|
-
}
|
331
|
+
"description": "Counter is the number which can be provided in the badge.",
|
332
|
+
"attribute": "counter"
|
421
333
|
},
|
422
334
|
{
|
423
335
|
"kind": "field",
|
424
|
-
"name": "
|
336
|
+
"name": "maxCounter",
|
425
337
|
"type": {
|
426
|
-
"text": "
|
338
|
+
"text": "number"
|
427
339
|
},
|
428
|
-
"
|
429
|
-
"
|
430
|
-
"attribute": "
|
431
|
-
"
|
432
|
-
"name": "AvatarComponentMixin",
|
433
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
434
|
-
}
|
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
|
435
344
|
},
|
436
345
|
{
|
437
346
|
"kind": "field",
|
438
|
-
"name": "
|
347
|
+
"name": "overlay",
|
439
348
|
"type": {
|
440
|
-
"text": "
|
349
|
+
"text": "boolean"
|
441
350
|
},
|
442
|
-
"
|
443
|
-
"
|
444
|
-
"
|
445
|
-
"name": "IconNameMixin",
|
446
|
-
"module": "utils/mixins/IconNameMixin.js"
|
447
|
-
}
|
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"
|
448
354
|
},
|
449
355
|
{
|
450
356
|
"kind": "field",
|
451
|
-
"name": "
|
357
|
+
"name": "ariaLabel",
|
452
358
|
"type": {
|
453
|
-
"text": "
|
359
|
+
"text": "string | null"
|
454
360
|
},
|
455
|
-
"default": "
|
456
|
-
"description": "
|
457
|
-
"attribute": "
|
458
|
-
"reflects": true,
|
459
|
-
"inheritedFrom": {
|
460
|
-
"name": "TabIndexMixin",
|
461
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
462
|
-
}
|
463
|
-
},
|
464
|
-
{
|
465
|
-
"kind": "method",
|
466
|
-
"name": "executeAction",
|
467
|
-
"privacy": "protected",
|
468
|
-
"inheritedFrom": {
|
469
|
-
"name": "Buttonsimple",
|
470
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
471
|
-
}
|
361
|
+
"default": "null",
|
362
|
+
"description": "Aria-label attribute to be set for accessibility",
|
363
|
+
"attribute": "aria-label"
|
472
364
|
},
|
473
365
|
{
|
474
366
|
"kind": "method",
|
475
|
-
"name": "
|
476
|
-
"privacy": "
|
367
|
+
"name": "getCounterText",
|
368
|
+
"privacy": "private",
|
369
|
+
"return": {
|
370
|
+
"type": {
|
371
|
+
"text": ""
|
372
|
+
}
|
373
|
+
},
|
477
374
|
"parameters": [
|
478
375
|
{
|
479
|
-
"name": "
|
376
|
+
"name": "maxCounter",
|
480
377
|
"type": {
|
481
|
-
"text": "
|
378
|
+
"text": "number"
|
482
379
|
},
|
483
|
-
"description": "
|
380
|
+
"description": "the maximum limit which can be displayed on the badge"
|
484
381
|
},
|
485
382
|
{
|
486
|
-
"name": "
|
383
|
+
"name": "counter",
|
384
|
+
"optional": true,
|
487
385
|
"type": {
|
488
|
-
"text": "
|
386
|
+
"text": "number"
|
489
387
|
},
|
490
|
-
"description": "
|
388
|
+
"description": "the number to be displayed on the badge"
|
491
389
|
}
|
492
390
|
],
|
493
|
-
"description": "
|
494
|
-
"inheritedFrom": {
|
495
|
-
"name": "Buttonsimple",
|
496
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
497
|
-
}
|
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."
|
498
392
|
},
|
499
393
|
{
|
500
394
|
"kind": "method",
|
501
|
-
"name": "
|
395
|
+
"name": "getBadgeIcon",
|
502
396
|
"privacy": "private",
|
503
|
-
"
|
504
|
-
{
|
505
|
-
"
|
506
|
-
"type": {
|
507
|
-
"text": "HTMLElement"
|
508
|
-
},
|
509
|
-
"description": "The button element."
|
510
|
-
},
|
511
|
-
{
|
512
|
-
"name": "softDisabled",
|
513
|
-
"type": {
|
514
|
-
"text": "boolean"
|
515
|
-
},
|
516
|
-
"description": "The soft-disabled state."
|
397
|
+
"return": {
|
398
|
+
"type": {
|
399
|
+
"text": ""
|
517
400
|
}
|
518
|
-
|
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
|
-
}
|
524
|
-
},
|
525
|
-
{
|
526
|
-
"kind": "method",
|
527
|
-
"name": "setDisabled",
|
528
|
-
"privacy": "private",
|
401
|
+
},
|
529
402
|
"parameters": [
|
530
403
|
{
|
531
|
-
"name": "
|
404
|
+
"name": "iconName",
|
532
405
|
"type": {
|
533
|
-
"text": "
|
406
|
+
"text": "string"
|
534
407
|
},
|
535
|
-
"description": "
|
408
|
+
"description": "the name of the icon from the icon set"
|
536
409
|
},
|
537
410
|
{
|
538
|
-
"name": "
|
411
|
+
"name": "backgroundClassPostfix",
|
539
412
|
"type": {
|
540
|
-
"text": "
|
413
|
+
"text": "string"
|
541
414
|
},
|
542
|
-
"description": "
|
415
|
+
"description": "postfix for the class to style the badge icon."
|
543
416
|
}
|
544
417
|
],
|
545
|
-
"description": "
|
546
|
-
"inheritedFrom": {
|
547
|
-
"name": "Buttonsimple",
|
548
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
549
|
-
}
|
418
|
+
"description": "Method to generate the badge icon."
|
550
419
|
},
|
551
420
|
{
|
552
421
|
"kind": "method",
|
553
|
-
"name": "
|
422
|
+
"name": "getBadgeDot",
|
554
423
|
"privacy": "private",
|
555
|
-
"
|
556
|
-
"
|
557
|
-
|
558
|
-
|
424
|
+
"return": {
|
425
|
+
"type": {
|
426
|
+
"text": ""
|
427
|
+
}
|
428
|
+
},
|
429
|
+
"description": "Method to generate the badge dot template."
|
559
430
|
},
|
560
431
|
{
|
561
432
|
"kind": "method",
|
562
|
-
"name": "
|
433
|
+
"name": "getBadgeCounterText",
|
563
434
|
"privacy": "private",
|
564
|
-
"
|
565
|
-
|
566
|
-
|
567
|
-
|
568
|
-
}
|
435
|
+
"return": {
|
436
|
+
"type": {
|
437
|
+
"text": ""
|
438
|
+
}
|
439
|
+
},
|
440
|
+
"description": "Method to generate the badge text and counter template."
|
569
441
|
},
|
570
442
|
{
|
571
443
|
"kind": "method",
|
572
|
-
"name": "
|
444
|
+
"name": "setRoleByAriaLabel",
|
573
445
|
"privacy": "private",
|
574
|
-
"
|
575
|
-
{
|
576
|
-
"
|
577
|
-
"type": {
|
578
|
-
"text": "KeyboardEvent"
|
579
|
-
},
|
580
|
-
"description": "The keyboard event."
|
446
|
+
"return": {
|
447
|
+
"type": {
|
448
|
+
"text": "void"
|
581
449
|
}
|
582
|
-
|
583
|
-
"description": "
|
584
|
-
"inheritedFrom": {
|
585
|
-
"name": "Buttonsimple",
|
586
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
587
|
-
}
|
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."
|
588
452
|
},
|
589
453
|
{
|
590
454
|
"kind": "method",
|
591
|
-
"name": "
|
455
|
+
"name": "getBadgeContentBasedOnType",
|
592
456
|
"privacy": "private",
|
593
|
-
"
|
594
|
-
{
|
595
|
-
"
|
596
|
-
"type": {
|
597
|
-
"text": "KeyboardEvent"
|
598
|
-
},
|
599
|
-
"description": "The keyboard event."
|
457
|
+
"return": {
|
458
|
+
"type": {
|
459
|
+
"text": ""
|
600
460
|
}
|
601
|
-
|
602
|
-
"description": "
|
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
|
-
}
|
619
|
-
},
|
620
|
-
{
|
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",
|
625
|
-
"inheritedFrom": {
|
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
|
-
}
|
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."
|
639
463
|
},
|
640
464
|
{
|
641
|
-
"
|
642
|
-
"name": "
|
643
|
-
"
|
644
|
-
|
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",
|
645
472
|
"inheritedFrom": {
|
646
|
-
"name": "
|
647
|
-
"module": "
|
473
|
+
"name": "IconNameMixin",
|
474
|
+
"module": "utils/mixins/IconNameMixin.js"
|
648
475
|
}
|
649
476
|
}
|
650
477
|
],
|
651
478
|
"attributes": [
|
652
479
|
{
|
653
|
-
"name": "
|
654
|
-
"type": {
|
655
|
-
"text": "string | null"
|
656
|
-
},
|
657
|
-
"default": "null",
|
658
|
-
"description": "Aria-label attribute to be set for accessibility",
|
659
|
-
"fieldName": "ariaLabel"
|
660
|
-
},
|
661
|
-
{
|
662
|
-
"name": "src",
|
480
|
+
"name": "type",
|
663
481
|
"type": {
|
664
|
-
"text": "
|
482
|
+
"text": "BadgeType | undefined"
|
665
483
|
},
|
666
|
-
"description": "
|
667
|
-
"fieldName": "
|
668
|
-
"inheritedFrom": {
|
669
|
-
"name": "AvatarComponentMixin",
|
670
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
671
|
-
}
|
484
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
485
|
+
"fieldName": "type"
|
672
486
|
},
|
673
487
|
{
|
674
|
-
"name": "
|
488
|
+
"name": "variant",
|
675
489
|
"type": {
|
676
|
-
"text": "
|
490
|
+
"text": "IconVariant"
|
677
491
|
},
|
678
|
-
"description": "
|
679
|
-
"
|
680
|
-
"
|
681
|
-
"name": "AvatarComponentMixin",
|
682
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
683
|
-
}
|
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"
|
684
495
|
},
|
685
496
|
{
|
686
|
-
"name": "
|
497
|
+
"name": "counter",
|
687
498
|
"type": {
|
688
|
-
"text": "
|
499
|
+
"text": "number | undefined"
|
689
500
|
},
|
690
|
-
"description": "
|
691
|
-
"fieldName": "
|
692
|
-
"inheritedFrom": {
|
693
|
-
"name": "AvatarComponentMixin",
|
694
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
695
|
-
}
|
501
|
+
"description": "Counter is the number which can be provided in the badge.",
|
502
|
+
"fieldName": "counter"
|
696
503
|
},
|
697
504
|
{
|
698
|
-
"name": "
|
505
|
+
"name": "max-counter",
|
699
506
|
"type": {
|
700
|
-
"text": "
|
507
|
+
"text": "number"
|
701
508
|
},
|
702
|
-
"description": "
|
703
|
-
"default": "
|
704
|
-
"fieldName": "
|
705
|
-
"inheritedFrom": {
|
706
|
-
"name": "Buttonsimple",
|
707
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
708
|
-
}
|
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"
|
709
512
|
},
|
710
513
|
{
|
711
|
-
"name": "
|
514
|
+
"name": "overlay",
|
712
515
|
"type": {
|
713
|
-
"text": "
|
516
|
+
"text": "boolean"
|
714
517
|
},
|
715
|
-
"
|
716
|
-
"
|
717
|
-
"
|
718
|
-
"name": "AvatarComponentMixin",
|
719
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
720
|
-
}
|
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"
|
721
521
|
},
|
722
522
|
{
|
723
|
-
"name": "
|
523
|
+
"name": "aria-label",
|
724
524
|
"type": {
|
725
|
-
"text": "
|
525
|
+
"text": "string | null"
|
726
526
|
},
|
727
|
-
"default": "
|
728
|
-
"description": "
|
729
|
-
"fieldName": "
|
730
|
-
"inheritedFrom": {
|
731
|
-
"name": "AvatarComponentMixin",
|
732
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
733
|
-
}
|
527
|
+
"default": "null",
|
528
|
+
"description": "Aria-label attribute to be set for accessibility",
|
529
|
+
"fieldName": "ariaLabel"
|
734
530
|
},
|
735
531
|
{
|
736
532
|
"name": "icon-name",
|
@@ -743,386 +539,437 @@
|
|
743
539
|
"name": "IconNameMixin",
|
744
540
|
"module": "src/utils/mixins/IconNameMixin.ts"
|
745
541
|
}
|
746
|
-
}
|
542
|
+
}
|
543
|
+
],
|
544
|
+
"mixins": [
|
747
545
|
{
|
748
|
-
"name": "
|
749
|
-
"
|
750
|
-
|
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": [
|
579
|
+
{
|
580
|
+
"kind": "field",
|
581
|
+
"name": "ariaLabel",
|
582
|
+
"type": {
|
583
|
+
"text": "string | null"
|
751
584
|
},
|
752
|
-
"default": "
|
753
|
-
"description": "
|
754
|
-
"
|
755
|
-
"inheritedFrom": {
|
756
|
-
"name": "TabIndexMixin",
|
757
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
758
|
-
}
|
585
|
+
"default": "null",
|
586
|
+
"description": "Aria-label attribute to be set for accessibility",
|
587
|
+
"attribute": "aria-label"
|
759
588
|
},
|
760
589
|
{
|
761
|
-
"
|
590
|
+
"kind": "method",
|
591
|
+
"name": "setSize",
|
592
|
+
"privacy": "private",
|
593
|
+
"parameters": [
|
594
|
+
{
|
595
|
+
"name": "size",
|
596
|
+
"type": {
|
597
|
+
"text": "AvatarSize"
|
598
|
+
}
|
599
|
+
}
|
600
|
+
]
|
601
|
+
},
|
602
|
+
{
|
603
|
+
"kind": "field",
|
604
|
+
"name": "active",
|
762
605
|
"type": {
|
763
606
|
"text": "boolean"
|
764
607
|
},
|
765
|
-
"default": "
|
766
|
-
"description": "
|
767
|
-
"
|
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,
|
768
612
|
"inheritedFrom": {
|
769
|
-
"name": "
|
770
|
-
"module": "
|
613
|
+
"name": "Buttonsimple",
|
614
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
771
615
|
}
|
772
616
|
},
|
773
617
|
{
|
774
|
-
"
|
618
|
+
"kind": "field",
|
619
|
+
"name": "disabled",
|
775
620
|
"type": {
|
776
621
|
"text": "boolean"
|
777
622
|
},
|
778
|
-
"default": "
|
779
|
-
"description": "
|
780
|
-
"
|
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,
|
781
627
|
"inheritedFrom": {
|
782
|
-
"name": "
|
783
|
-
"module": "
|
628
|
+
"name": "DisabledMixin",
|
629
|
+
"module": "utils/mixins/DisabledMixin.js"
|
784
630
|
}
|
785
631
|
},
|
786
632
|
{
|
787
|
-
"
|
633
|
+
"kind": "field",
|
634
|
+
"name": "softDisabled",
|
788
635
|
"type": {
|
789
636
|
"text": "boolean"
|
790
637
|
},
|
791
|
-
"default": "
|
638
|
+
"default": "undefined as unknown",
|
792
639
|
"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.",
|
793
|
-
"
|
640
|
+
"attribute": "soft-disabled",
|
794
641
|
"inheritedFrom": {
|
795
642
|
"name": "Buttonsimple",
|
796
|
-
"module": "
|
643
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
797
644
|
}
|
798
645
|
},
|
799
646
|
{
|
647
|
+
"kind": "field",
|
800
648
|
"name": "role",
|
801
649
|
"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.",
|
802
|
-
"default": "button",
|
803
|
-
"
|
650
|
+
"default": "'button'",
|
651
|
+
"attribute": "role",
|
652
|
+
"reflects": true,
|
653
|
+
"type": {
|
654
|
+
"text": "string"
|
655
|
+
},
|
804
656
|
"inheritedFrom": {
|
805
657
|
"name": "Buttonsimple",
|
806
|
-
"module": "
|
658
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
807
659
|
}
|
808
660
|
},
|
809
661
|
{
|
662
|
+
"kind": "field",
|
810
663
|
"name": "type",
|
811
664
|
"type": {
|
812
665
|
"text": "ButtonType"
|
813
666
|
},
|
814
667
|
"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.",
|
815
668
|
"default": "button",
|
816
|
-
"
|
669
|
+
"attribute": "type",
|
670
|
+
"reflects": true,
|
817
671
|
"inheritedFrom": {
|
818
672
|
"name": "Buttonsimple",
|
819
|
-
"module": "
|
673
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
820
674
|
}
|
821
|
-
}
|
822
|
-
],
|
823
|
-
"mixins": [
|
824
|
-
{
|
825
|
-
"name": "AvatarComponentMixin",
|
826
|
-
"module": "/src/utils/mixins/AvatarComponentMixin"
|
827
|
-
},
|
828
|
-
{
|
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"
|
865
|
-
},
|
866
|
-
{
|
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
675
|
},
|
898
676
|
{
|
899
|
-
"
|
900
|
-
"name": "
|
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
|
+
}
|
901
688
|
},
|
902
|
-
{
|
903
|
-
"description": "The background color of the badge overlay.",
|
904
|
-
"name": "--mdc-badge-overlay-background-color"
|
905
|
-
}
|
906
|
-
],
|
907
|
-
"members": [
|
908
689
|
{
|
909
690
|
"kind": "field",
|
910
|
-
"name": "
|
691
|
+
"name": "initials",
|
911
692
|
"type": {
|
912
|
-
"text": "
|
693
|
+
"text": "string | undefined"
|
913
694
|
},
|
914
|
-
"description": "
|
915
|
-
"attribute": "
|
916
|
-
"
|
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
|
+
}
|
917
701
|
},
|
918
702
|
{
|
919
703
|
"kind": "field",
|
920
|
-
"name": "
|
704
|
+
"name": "presence",
|
921
705
|
"type": {
|
922
|
-
"text": "
|
706
|
+
"text": "PresenceType | undefined"
|
923
707
|
},
|
924
|
-
"description": "
|
925
|
-
"
|
926
|
-
"
|
927
|
-
|
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
|
+
}
|
928
714
|
},
|
929
715
|
{
|
930
716
|
"kind": "field",
|
931
|
-
"name": "
|
717
|
+
"name": "size",
|
932
718
|
"type": {
|
933
|
-
"text": "
|
719
|
+
"text": "ButtonSize"
|
934
720
|
},
|
935
|
-
"description": "
|
936
|
-
"
|
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
|
+
}
|
937
729
|
},
|
938
730
|
{
|
939
731
|
"kind": "field",
|
940
|
-
"name": "
|
732
|
+
"name": "counter",
|
941
733
|
"type": {
|
942
|
-
"text": "number"
|
734
|
+
"text": "number | undefined"
|
943
735
|
},
|
944
|
-
"description": "The
|
945
|
-
"
|
946
|
-
"
|
947
|
-
|
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
|
+
}
|
948
742
|
},
|
949
743
|
{
|
950
744
|
"kind": "field",
|
951
|
-
"name": "
|
745
|
+
"name": "isTyping",
|
952
746
|
"type": {
|
953
747
|
"text": "boolean"
|
954
748
|
},
|
955
749
|
"default": "false",
|
956
|
-
"description": "
|
957
|
-
"attribute": "
|
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
|
+
}
|
958
756
|
},
|
959
757
|
{
|
960
758
|
"kind": "field",
|
961
|
-
"name": "
|
759
|
+
"name": "iconName",
|
962
760
|
"type": {
|
963
|
-
"text": "
|
761
|
+
"text": "IconNames | undefined"
|
964
762
|
},
|
965
|
-
"
|
966
|
-
"
|
967
|
-
"
|
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
|
+
}
|
968
769
|
},
|
969
770
|
{
|
970
|
-
"kind": "
|
971
|
-
"name": "
|
972
|
-
"
|
973
|
-
|
974
|
-
"type": {
|
975
|
-
"text": ""
|
976
|
-
}
|
771
|
+
"kind": "field",
|
772
|
+
"name": "tabIndex",
|
773
|
+
"type": {
|
774
|
+
"text": "number"
|
977
775
|
},
|
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",
|
978
798
|
"parameters": [
|
979
799
|
{
|
980
|
-
"name": "
|
800
|
+
"name": "element",
|
981
801
|
"type": {
|
982
|
-
"text": "
|
802
|
+
"text": "HTMLElement"
|
983
803
|
},
|
984
|
-
"description": "
|
804
|
+
"description": "The button element"
|
985
805
|
},
|
986
806
|
{
|
987
|
-
"name": "
|
988
|
-
"optional": true,
|
807
|
+
"name": "active",
|
989
808
|
"type": {
|
990
|
-
"text": "
|
809
|
+
"text": "boolean"
|
991
810
|
},
|
992
|
-
"description": "
|
811
|
+
"description": "The active state of the element"
|
993
812
|
}
|
994
813
|
],
|
995
|
-
"description": "
|
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
|
+
}
|
996
819
|
},
|
997
820
|
{
|
998
821
|
"kind": "method",
|
999
|
-
"name": "
|
822
|
+
"name": "setSoftDisabled",
|
1000
823
|
"privacy": "private",
|
1001
|
-
"return": {
|
1002
|
-
"type": {
|
1003
|
-
"text": ""
|
1004
|
-
}
|
1005
|
-
},
|
1006
824
|
"parameters": [
|
1007
825
|
{
|
1008
|
-
"name": "
|
826
|
+
"name": "element",
|
1009
827
|
"type": {
|
1010
|
-
"text": "
|
828
|
+
"text": "HTMLElement"
|
1011
829
|
},
|
1012
|
-
"description": "
|
830
|
+
"description": "The button element."
|
1013
831
|
},
|
1014
832
|
{
|
1015
|
-
"name": "
|
833
|
+
"name": "softDisabled",
|
1016
834
|
"type": {
|
1017
|
-
"text": "
|
835
|
+
"text": "boolean"
|
1018
836
|
},
|
1019
|
-
"description": "
|
837
|
+
"description": "The soft-disabled state."
|
1020
838
|
}
|
1021
839
|
],
|
1022
|
-
"description": "
|
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
|
+
}
|
1023
845
|
},
|
1024
846
|
{
|
1025
847
|
"kind": "method",
|
1026
|
-
"name": "
|
848
|
+
"name": "setDisabled",
|
1027
849
|
"privacy": "private",
|
1028
|
-
"
|
1029
|
-
|
1030
|
-
"
|
850
|
+
"parameters": [
|
851
|
+
{
|
852
|
+
"name": "element",
|
853
|
+
"type": {
|
854
|
+
"text": "HTMLElement"
|
855
|
+
},
|
856
|
+
"description": "The button element."
|
857
|
+
},
|
858
|
+
{
|
859
|
+
"name": "disabled",
|
860
|
+
"type": {
|
861
|
+
"text": "boolean"
|
862
|
+
},
|
863
|
+
"description": "The disabled state."
|
1031
864
|
}
|
1032
|
-
|
1033
|
-
"description": "
|
865
|
+
],
|
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
|
+
}
|
1034
871
|
},
|
1035
872
|
{
|
1036
873
|
"kind": "method",
|
1037
|
-
"name": "
|
874
|
+
"name": "triggerClickEvent",
|
1038
875
|
"privacy": "private",
|
1039
|
-
"
|
1040
|
-
"
|
1041
|
-
|
1042
|
-
|
1043
|
-
},
|
1044
|
-
"description": "Method to generate the badge text and counter template."
|
876
|
+
"inheritedFrom": {
|
877
|
+
"name": "Buttonsimple",
|
878
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
879
|
+
}
|
1045
880
|
},
|
1046
881
|
{
|
1047
882
|
"kind": "method",
|
1048
|
-
"name": "
|
883
|
+
"name": "handleBlur",
|
1049
884
|
"privacy": "private",
|
1050
|
-
"
|
1051
|
-
|
1052
|
-
|
1053
|
-
|
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."
|
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
|
+
}
|
1056
890
|
},
|
1057
891
|
{
|
1058
892
|
"kind": "method",
|
1059
|
-
"name": "
|
893
|
+
"name": "handleKeyDown",
|
1060
894
|
"privacy": "private",
|
1061
|
-
"
|
1062
|
-
|
1063
|
-
"
|
895
|
+
"parameters": [
|
896
|
+
{
|
897
|
+
"name": "event",
|
898
|
+
"type": {
|
899
|
+
"text": "KeyboardEvent"
|
900
|
+
},
|
901
|
+
"description": "The keyboard event."
|
1064
902
|
}
|
1065
|
-
|
1066
|
-
"description": "
|
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
|
+
}
|
1067
909
|
},
|
1068
910
|
{
|
1069
|
-
"kind": "
|
1070
|
-
"name": "
|
1071
|
-
"
|
1072
|
-
|
1073
|
-
|
1074
|
-
|
1075
|
-
|
911
|
+
"kind": "method",
|
912
|
+
"name": "handleKeyUp",
|
913
|
+
"privacy": "private",
|
914
|
+
"parameters": [
|
915
|
+
{
|
916
|
+
"name": "event",
|
917
|
+
"type": {
|
918
|
+
"text": "KeyboardEvent"
|
919
|
+
},
|
920
|
+
"description": "The keyboard event."
|
921
|
+
}
|
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.",
|
1076
924
|
"inheritedFrom": {
|
1077
|
-
"name": "
|
1078
|
-
"module": "
|
925
|
+
"name": "Buttonsimple",
|
926
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1079
927
|
}
|
1080
928
|
}
|
1081
929
|
],
|
1082
|
-
"
|
930
|
+
"events": [
|
1083
931
|
{
|
1084
|
-
"
|
1085
|
-
"
|
1086
|
-
|
1087
|
-
|
1088
|
-
"
|
1089
|
-
|
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
|
+
}
|
1090
940
|
},
|
1091
941
|
{
|
1092
|
-
"
|
1093
|
-
"
|
1094
|
-
|
1095
|
-
|
1096
|
-
"
|
1097
|
-
|
1098
|
-
|
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
|
+
}
|
1099
950
|
},
|
1100
951
|
{
|
1101
|
-
"
|
1102
|
-
"
|
1103
|
-
|
1104
|
-
|
1105
|
-
"
|
1106
|
-
|
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
|
+
}
|
1107
960
|
},
|
1108
961
|
{
|
1109
|
-
"
|
1110
|
-
"
|
1111
|
-
|
1112
|
-
|
1113
|
-
"
|
1114
|
-
|
1115
|
-
|
1116
|
-
|
1117
|
-
|
1118
|
-
|
1119
|
-
|
1120
|
-
"text": "boolean"
|
1121
|
-
},
|
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"
|
1125
|
-
},
|
962
|
+
"description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
|
963
|
+
"name": "focus",
|
964
|
+
"reactName": "onFocus",
|
965
|
+
"eventName": "FocusEvent",
|
966
|
+
"inheritedFrom": {
|
967
|
+
"name": "Buttonsimple",
|
968
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
969
|
+
}
|
970
|
+
}
|
971
|
+
],
|
972
|
+
"attributes": [
|
1126
973
|
{
|
1127
974
|
"name": "aria-label",
|
1128
975
|
"type": {
|
@@ -1132,6 +979,80 @@
|
|
1132
979
|
"description": "Aria-label attribute to be set for accessibility",
|
1133
980
|
"fieldName": "ariaLabel"
|
1134
981
|
},
|
982
|
+
{
|
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",
|
996
|
+
"type": {
|
997
|
+
"text": "string | undefined"
|
998
|
+
},
|
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
|
+
}
|
1005
|
+
},
|
1006
|
+
{
|
1007
|
+
"name": "presence",
|
1008
|
+
"type": {
|
1009
|
+
"text": "PresenceType | undefined"
|
1010
|
+
},
|
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
|
+
}
|
1017
|
+
},
|
1018
|
+
{
|
1019
|
+
"name": "size",
|
1020
|
+
"type": {
|
1021
|
+
"text": "ButtonSize"
|
1022
|
+
},
|
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
|
+
}
|
1030
|
+
},
|
1031
|
+
{
|
1032
|
+
"name": "counter",
|
1033
|
+
"type": {
|
1034
|
+
"text": "number | undefined"
|
1035
|
+
},
|
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
|
+
}
|
1042
|
+
},
|
1043
|
+
{
|
1044
|
+
"name": "is-typing",
|
1045
|
+
"type": {
|
1046
|
+
"text": "boolean"
|
1047
|
+
},
|
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
|
+
}
|
1055
|
+
},
|
1135
1056
|
{
|
1136
1057
|
"name": "icon-name",
|
1137
1058
|
"type": {
|
@@ -1143,20 +1064,99 @@
|
|
1143
1064
|
"name": "IconNameMixin",
|
1144
1065
|
"module": "src/utils/mixins/IconNameMixin.ts"
|
1145
1066
|
}
|
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
|
+
}
|
1146
1142
|
}
|
1147
1143
|
],
|
1148
1144
|
"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": "
|
1156
|
-
"module": "/src/
|
1155
|
+
"name": "Buttonsimple",
|
1156
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
1157
1157
|
},
|
1158
|
-
"tagName": "mdc-
|
1159
|
-
"jsDoc": "/**\n * The `mdc-
|
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 */",
|
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": "
|
1169
|
-
"module": "components/
|
1168
|
+
"name": "AvatarButton",
|
1169
|
+
"module": "components/avatarbutton/avatarbutton.component.js"
|
1170
1170
|
}
|
1171
1171
|
}
|
1172
1172
|
]
|
@@ -2182,609 +2182,2160 @@
|
|
2182
2182
|
"name": "--mdc-checkbox-disabled-icon-color"
|
2183
2183
|
},
|
2184
2184
|
{
|
2185
|
-
"description": "Background color for an unselected checkbox.",
|
2186
|
-
"name": "--mdc-checkbox-icon-background-color"
|
2185
|
+
"description": "Background color for an unselected checkbox.",
|
2186
|
+
"name": "--mdc-checkbox-icon-background-color"
|
2187
|
+
},
|
2188
|
+
{
|
2189
|
+
"description": "Default background color for an unselected checkbox.",
|
2190
|
+
"name": "--mdc-checkbox-icon-border-color"
|
2191
|
+
},
|
2192
|
+
{
|
2193
|
+
"description": "Icon color for an unselected checkbox.",
|
2194
|
+
"name": "--mdc-checkbox-icon-color"
|
2195
|
+
},
|
2196
|
+
{
|
2197
|
+
"description": "Background color for a selected checkbox when pressed.",
|
2198
|
+
"name": "--mdc-checkbox-pressed-icon-color"
|
2199
|
+
}
|
2200
|
+
],
|
2201
|
+
"members": [
|
2202
|
+
{
|
2203
|
+
"kind": "field",
|
2204
|
+
"name": "checked",
|
2205
|
+
"type": {
|
2206
|
+
"text": "boolean"
|
2207
|
+
},
|
2208
|
+
"default": "false",
|
2209
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
2210
|
+
"attribute": "checked",
|
2211
|
+
"reflects": true
|
2212
|
+
},
|
2213
|
+
{
|
2214
|
+
"kind": "field",
|
2215
|
+
"name": "indeterminate",
|
2216
|
+
"type": {
|
2217
|
+
"text": "boolean"
|
2218
|
+
},
|
2219
|
+
"default": "false",
|
2220
|
+
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
2221
|
+
"attribute": "indeterminate",
|
2222
|
+
"reflects": true
|
2223
|
+
},
|
2224
|
+
{
|
2225
|
+
"kind": "field",
|
2226
|
+
"name": "autofocus",
|
2227
|
+
"type": {
|
2228
|
+
"text": "boolean"
|
2229
|
+
},
|
2230
|
+
"default": "false",
|
2231
|
+
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
2232
|
+
"attribute": "autofocus",
|
2233
|
+
"reflects": true
|
2234
|
+
},
|
2235
|
+
{
|
2236
|
+
"kind": "method",
|
2237
|
+
"name": "setFormValue",
|
2238
|
+
"privacy": "private",
|
2239
|
+
"description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
|
2240
|
+
},
|
2241
|
+
{
|
2242
|
+
"kind": "method",
|
2243
|
+
"name": "manageRequired",
|
2244
|
+
"privacy": "private",
|
2245
|
+
"description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the requiredLabel property is set, then the checkbox is invalid."
|
2246
|
+
},
|
2247
|
+
{
|
2248
|
+
"kind": "method",
|
2249
|
+
"name": "toggleState",
|
2250
|
+
"privacy": "private",
|
2251
|
+
"return": {
|
2252
|
+
"type": {
|
2253
|
+
"text": "void"
|
2254
|
+
}
|
2255
|
+
},
|
2256
|
+
"description": "Toggles the state of the checkbox element.\nIf the element is not disabled, then\nthe checked property is toggled and the indeterminate property is set to false."
|
2257
|
+
},
|
2258
|
+
{
|
2259
|
+
"kind": "method",
|
2260
|
+
"name": "handleKeyDown",
|
2261
|
+
"privacy": "private",
|
2262
|
+
"return": {
|
2263
|
+
"type": {
|
2264
|
+
"text": "void"
|
2265
|
+
}
|
2266
|
+
},
|
2267
|
+
"parameters": [
|
2268
|
+
{
|
2269
|
+
"name": "event",
|
2270
|
+
"type": {
|
2271
|
+
"text": "KeyboardEvent"
|
2272
|
+
},
|
2273
|
+
"description": "The keyboard event."
|
2274
|
+
}
|
2275
|
+
],
|
2276
|
+
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
2277
|
+
},
|
2278
|
+
{
|
2279
|
+
"kind": "method",
|
2280
|
+
"name": "handleChange",
|
2281
|
+
"privacy": "public",
|
2282
|
+
"return": {
|
2283
|
+
"type": {
|
2284
|
+
"text": "void"
|
2285
|
+
}
|
2286
|
+
},
|
2287
|
+
"parameters": [
|
2288
|
+
{
|
2289
|
+
"name": "event",
|
2290
|
+
"type": {
|
2291
|
+
"text": "Event"
|
2292
|
+
}
|
2293
|
+
}
|
2294
|
+
],
|
2295
|
+
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
2296
|
+
},
|
2297
|
+
{
|
2298
|
+
"kind": "field",
|
2299
|
+
"name": "renderLabelAndHelperText",
|
2300
|
+
"privacy": "private"
|
2301
|
+
},
|
2302
|
+
{
|
2303
|
+
"kind": "field",
|
2304
|
+
"name": "helpTextType",
|
2305
|
+
"type": {
|
2306
|
+
"text": "ValidationType"
|
2307
|
+
},
|
2308
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
2309
|
+
"attribute": "help-text-type",
|
2310
|
+
"reflects": true,
|
2311
|
+
"default": "undefined as unknown",
|
2312
|
+
"inheritedFrom": {
|
2313
|
+
"name": "FormfieldWrapper",
|
2314
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2315
|
+
}
|
2316
|
+
},
|
2317
|
+
{
|
2318
|
+
"kind": "field",
|
2319
|
+
"name": "name",
|
2320
|
+
"type": {
|
2321
|
+
"text": "string"
|
2322
|
+
},
|
2323
|
+
"default": "''",
|
2324
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
2325
|
+
"attribute": "name",
|
2326
|
+
"reflects": true,
|
2327
|
+
"inheritedFrom": {
|
2328
|
+
"name": "FormInternalsMixin",
|
2329
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2330
|
+
}
|
2331
|
+
},
|
2332
|
+
{
|
2333
|
+
"kind": "field",
|
2334
|
+
"name": "value",
|
2335
|
+
"type": {
|
2336
|
+
"text": "string"
|
2337
|
+
},
|
2338
|
+
"default": "''",
|
2339
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
2340
|
+
"attribute": "value",
|
2341
|
+
"reflects": true,
|
2342
|
+
"inheritedFrom": {
|
2343
|
+
"name": "FormInternalsMixin",
|
2344
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2345
|
+
}
|
2346
|
+
},
|
2347
|
+
{
|
2348
|
+
"kind": "field",
|
2349
|
+
"name": "validationMessage",
|
2350
|
+
"type": {
|
2351
|
+
"text": "string | undefined"
|
2352
|
+
},
|
2353
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
2354
|
+
"attribute": "validation-message",
|
2355
|
+
"reflects": true,
|
2356
|
+
"inheritedFrom": {
|
2357
|
+
"name": "FormInternalsMixin",
|
2358
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2359
|
+
}
|
2360
|
+
},
|
2361
|
+
{
|
2362
|
+
"kind": "field",
|
2363
|
+
"name": "validity",
|
2364
|
+
"type": {
|
2365
|
+
"text": "ValidityState"
|
2366
|
+
},
|
2367
|
+
"readonly": true,
|
2368
|
+
"inheritedFrom": {
|
2369
|
+
"name": "FormInternalsMixin",
|
2370
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2371
|
+
}
|
2372
|
+
},
|
2373
|
+
{
|
2374
|
+
"kind": "field",
|
2375
|
+
"name": "willValidate",
|
2376
|
+
"readonly": true,
|
2377
|
+
"inheritedFrom": {
|
2378
|
+
"name": "FormInternalsMixin",
|
2379
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2380
|
+
}
|
2381
|
+
},
|
2382
|
+
{
|
2383
|
+
"kind": "method",
|
2384
|
+
"name": "setValidity",
|
2385
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
2386
|
+
"return": {
|
2387
|
+
"type": {
|
2388
|
+
"text": ""
|
2389
|
+
}
|
2390
|
+
},
|
2391
|
+
"inheritedFrom": {
|
2392
|
+
"name": "FormInternalsMixin",
|
2393
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2394
|
+
}
|
2395
|
+
},
|
2396
|
+
{
|
2397
|
+
"kind": "method",
|
2398
|
+
"name": "checkValidity",
|
2399
|
+
"return": {
|
2400
|
+
"type": {
|
2401
|
+
"text": "boolean"
|
2402
|
+
}
|
2403
|
+
},
|
2404
|
+
"inheritedFrom": {
|
2405
|
+
"name": "FormInternalsMixin",
|
2406
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2407
|
+
}
|
2408
|
+
},
|
2409
|
+
{
|
2410
|
+
"kind": "method",
|
2411
|
+
"name": "reportValidity",
|
2412
|
+
"inheritedFrom": {
|
2413
|
+
"name": "FormInternalsMixin",
|
2414
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
2415
|
+
}
|
2416
|
+
},
|
2417
|
+
{
|
2418
|
+
"kind": "field",
|
2419
|
+
"name": "id",
|
2420
|
+
"type": {
|
2421
|
+
"text": "string"
|
2422
|
+
},
|
2423
|
+
"default": "`mdc-input-${uuidv4()}`",
|
2424
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2425
|
+
"attribute": "id",
|
2426
|
+
"inheritedFrom": {
|
2427
|
+
"name": "FormfieldWrapper",
|
2428
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2429
|
+
}
|
2430
|
+
},
|
2431
|
+
{
|
2432
|
+
"kind": "field",
|
2433
|
+
"name": "dataAriaLabel",
|
2434
|
+
"type": {
|
2435
|
+
"text": "string | null"
|
2436
|
+
},
|
2437
|
+
"default": "null",
|
2438
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
2439
|
+
"attribute": "data-aria-label",
|
2440
|
+
"reflects": true,
|
2441
|
+
"inheritedFrom": {
|
2442
|
+
"name": "DataAriaLabelMixin",
|
2443
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
2444
|
+
}
|
2445
|
+
},
|
2446
|
+
{
|
2447
|
+
"kind": "field",
|
2448
|
+
"name": "disabled",
|
2449
|
+
"type": {
|
2450
|
+
"text": "boolean"
|
2451
|
+
},
|
2452
|
+
"default": "false",
|
2453
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2454
|
+
"attribute": "disabled",
|
2455
|
+
"reflects": true,
|
2456
|
+
"inheritedFrom": {
|
2457
|
+
"name": "DisabledMixin",
|
2458
|
+
"module": "utils/mixins/DisabledMixin.js"
|
2459
|
+
}
|
2460
|
+
},
|
2461
|
+
{
|
2462
|
+
"kind": "field",
|
2463
|
+
"name": "label",
|
2464
|
+
"type": {
|
2465
|
+
"text": "string | undefined"
|
2466
|
+
},
|
2467
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
2468
|
+
"attribute": "label",
|
2469
|
+
"reflects": true,
|
2470
|
+
"inheritedFrom": {
|
2471
|
+
"name": "FormfieldWrapper",
|
2472
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2473
|
+
}
|
2474
|
+
},
|
2475
|
+
{
|
2476
|
+
"kind": "field",
|
2477
|
+
"name": "requiredLabel",
|
2478
|
+
"type": {
|
2479
|
+
"text": "string | undefined"
|
2480
|
+
},
|
2481
|
+
"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.",
|
2482
|
+
"attribute": "required-label",
|
2483
|
+
"reflects": true,
|
2484
|
+
"inheritedFrom": {
|
2485
|
+
"name": "FormfieldWrapper",
|
2486
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2487
|
+
}
|
2488
|
+
},
|
2489
|
+
{
|
2490
|
+
"kind": "field",
|
2491
|
+
"name": "helpText",
|
2492
|
+
"type": {
|
2493
|
+
"text": "string | undefined"
|
2494
|
+
},
|
2495
|
+
"description": "The help text that is displayed below the input field.",
|
2496
|
+
"attribute": "help-text",
|
2497
|
+
"reflects": true,
|
2498
|
+
"inheritedFrom": {
|
2499
|
+
"name": "FormfieldWrapper",
|
2500
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2501
|
+
}
|
2502
|
+
},
|
2503
|
+
{
|
2504
|
+
"kind": "method",
|
2505
|
+
"name": "renderLabelElement",
|
2506
|
+
"privacy": "protected",
|
2507
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
2508
|
+
"return": {
|
2509
|
+
"type": {
|
2510
|
+
"text": ""
|
2511
|
+
}
|
2512
|
+
},
|
2513
|
+
"inheritedFrom": {
|
2514
|
+
"name": "FormfieldWrapper",
|
2515
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2516
|
+
}
|
2517
|
+
},
|
2518
|
+
{
|
2519
|
+
"kind": "method",
|
2520
|
+
"name": "renderRequiredLabel",
|
2521
|
+
"privacy": "protected",
|
2522
|
+
"inheritedFrom": {
|
2523
|
+
"name": "FormfieldWrapper",
|
2524
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2525
|
+
}
|
2526
|
+
},
|
2527
|
+
{
|
2528
|
+
"kind": "method",
|
2529
|
+
"name": "renderHelpTextIcon",
|
2530
|
+
"privacy": "protected",
|
2531
|
+
"description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
|
2532
|
+
"return": {
|
2533
|
+
"type": {
|
2534
|
+
"text": ""
|
2535
|
+
}
|
2536
|
+
},
|
2537
|
+
"inheritedFrom": {
|
2538
|
+
"name": "FormfieldWrapper",
|
2539
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2540
|
+
}
|
2541
|
+
},
|
2542
|
+
{
|
2543
|
+
"kind": "method",
|
2544
|
+
"name": "renderHelpText",
|
2545
|
+
"privacy": "protected",
|
2546
|
+
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
2547
|
+
"return": {
|
2548
|
+
"type": {
|
2549
|
+
"text": ""
|
2550
|
+
}
|
2551
|
+
},
|
2552
|
+
"inheritedFrom": {
|
2553
|
+
"name": "FormfieldWrapper",
|
2554
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2555
|
+
}
|
2556
|
+
},
|
2557
|
+
{
|
2558
|
+
"kind": "method",
|
2559
|
+
"name": "renderLabel",
|
2560
|
+
"privacy": "protected",
|
2561
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
2562
|
+
"return": {
|
2563
|
+
"type": {
|
2564
|
+
"text": ""
|
2565
|
+
}
|
2566
|
+
},
|
2567
|
+
"inheritedFrom": {
|
2568
|
+
"name": "FormfieldWrapper",
|
2569
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2570
|
+
}
|
2571
|
+
},
|
2572
|
+
{
|
2573
|
+
"kind": "method",
|
2574
|
+
"name": "renderHelperText",
|
2575
|
+
"privacy": "protected",
|
2576
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
2577
|
+
"return": {
|
2578
|
+
"type": {
|
2579
|
+
"text": ""
|
2580
|
+
}
|
2581
|
+
},
|
2582
|
+
"inheritedFrom": {
|
2583
|
+
"name": "FormfieldWrapper",
|
2584
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2585
|
+
}
|
2586
|
+
}
|
2587
|
+
],
|
2588
|
+
"events": [
|
2589
|
+
{
|
2590
|
+
"type": {
|
2591
|
+
"text": "EventConstructor"
|
2592
|
+
}
|
2593
|
+
},
|
2594
|
+
{
|
2595
|
+
"description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
|
2596
|
+
"name": "change",
|
2597
|
+
"reactName": "onChange",
|
2598
|
+
"eventName": "ChangeEvent"
|
2599
|
+
},
|
2600
|
+
{
|
2601
|
+
"description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
|
2602
|
+
"name": "focus",
|
2603
|
+
"reactName": "onFocus",
|
2604
|
+
"eventName": "FocusEvent"
|
2605
|
+
}
|
2606
|
+
],
|
2607
|
+
"attributes": [
|
2608
|
+
{
|
2609
|
+
"name": "checked",
|
2610
|
+
"type": {
|
2611
|
+
"text": "boolean"
|
2612
|
+
},
|
2613
|
+
"default": "false",
|
2614
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
2615
|
+
"fieldName": "checked"
|
2616
|
+
},
|
2617
|
+
{
|
2618
|
+
"name": "indeterminate",
|
2619
|
+
"type": {
|
2620
|
+
"text": "boolean"
|
2621
|
+
},
|
2622
|
+
"default": "false",
|
2623
|
+
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
2624
|
+
"fieldName": "indeterminate"
|
2625
|
+
},
|
2626
|
+
{
|
2627
|
+
"name": "autofocus",
|
2628
|
+
"type": {
|
2629
|
+
"text": "boolean"
|
2630
|
+
},
|
2631
|
+
"default": "false",
|
2632
|
+
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
2633
|
+
"fieldName": "autofocus"
|
2634
|
+
},
|
2635
|
+
{
|
2636
|
+
"name": "name",
|
2637
|
+
"type": {
|
2638
|
+
"text": "string"
|
2639
|
+
},
|
2640
|
+
"default": "''",
|
2641
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
2642
|
+
"fieldName": "name",
|
2643
|
+
"inheritedFrom": {
|
2644
|
+
"name": "FormInternalsMixin",
|
2645
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
2646
|
+
}
|
2647
|
+
},
|
2648
|
+
{
|
2649
|
+
"name": "value",
|
2650
|
+
"type": {
|
2651
|
+
"text": "string"
|
2652
|
+
},
|
2653
|
+
"default": "''",
|
2654
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
2655
|
+
"fieldName": "value",
|
2656
|
+
"inheritedFrom": {
|
2657
|
+
"name": "FormInternalsMixin",
|
2658
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
2659
|
+
}
|
2660
|
+
},
|
2661
|
+
{
|
2662
|
+
"name": "validation-message",
|
2663
|
+
"type": {
|
2664
|
+
"text": "string | undefined"
|
2665
|
+
},
|
2666
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
2667
|
+
"fieldName": "validationMessage",
|
2668
|
+
"inheritedFrom": {
|
2669
|
+
"name": "FormInternalsMixin",
|
2670
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
2671
|
+
}
|
2672
|
+
},
|
2673
|
+
{
|
2674
|
+
"name": "data-aria-label",
|
2675
|
+
"type": {
|
2676
|
+
"text": "string | null"
|
2677
|
+
},
|
2678
|
+
"default": "null",
|
2679
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
2680
|
+
"fieldName": "dataAriaLabel",
|
2681
|
+
"inheritedFrom": {
|
2682
|
+
"name": "DataAriaLabelMixin",
|
2683
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
2684
|
+
}
|
2685
|
+
},
|
2686
|
+
{
|
2687
|
+
"name": "disabled",
|
2688
|
+
"type": {
|
2689
|
+
"text": "boolean"
|
2690
|
+
},
|
2691
|
+
"default": "false",
|
2692
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2693
|
+
"fieldName": "disabled",
|
2694
|
+
"inheritedFrom": {
|
2695
|
+
"name": "DisabledMixin",
|
2696
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
2697
|
+
}
|
2698
|
+
},
|
2699
|
+
{
|
2700
|
+
"name": "label",
|
2701
|
+
"type": {
|
2702
|
+
"text": "string | undefined"
|
2703
|
+
},
|
2704
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
2705
|
+
"fieldName": "label",
|
2706
|
+
"inheritedFrom": {
|
2707
|
+
"name": "FormfieldWrapper",
|
2708
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2709
|
+
}
|
2710
|
+
},
|
2711
|
+
{
|
2712
|
+
"name": "required-label",
|
2713
|
+
"type": {
|
2714
|
+
"text": "string | undefined"
|
2715
|
+
},
|
2716
|
+
"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.",
|
2717
|
+
"fieldName": "requiredLabel",
|
2718
|
+
"inheritedFrom": {
|
2719
|
+
"name": "FormfieldWrapper",
|
2720
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2721
|
+
}
|
2722
|
+
},
|
2723
|
+
{
|
2724
|
+
"name": "id",
|
2725
|
+
"type": {
|
2726
|
+
"text": "string"
|
2727
|
+
},
|
2728
|
+
"default": "''",
|
2729
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2730
|
+
"fieldName": "id",
|
2731
|
+
"inheritedFrom": {
|
2732
|
+
"name": "FormfieldWrapper",
|
2733
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2734
|
+
}
|
2735
|
+
},
|
2736
|
+
{
|
2737
|
+
"name": "help-text-type",
|
2738
|
+
"type": {
|
2739
|
+
"text": "ValidationType"
|
2740
|
+
},
|
2741
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
2742
|
+
"fieldName": "helpTextType",
|
2743
|
+
"inheritedFrom": {
|
2744
|
+
"name": "FormfieldWrapper",
|
2745
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2746
|
+
}
|
2747
|
+
},
|
2748
|
+
{
|
2749
|
+
"name": "help-text",
|
2750
|
+
"type": {
|
2751
|
+
"text": "string | undefined"
|
2752
|
+
},
|
2753
|
+
"description": "The help text that is displayed below the input field.",
|
2754
|
+
"fieldName": "helpText",
|
2755
|
+
"inheritedFrom": {
|
2756
|
+
"name": "FormfieldWrapper",
|
2757
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2758
|
+
}
|
2759
|
+
}
|
2760
|
+
],
|
2761
|
+
"mixins": [
|
2762
|
+
{
|
2763
|
+
"name": "FormInternalsMixin",
|
2764
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
2765
|
+
},
|
2766
|
+
{
|
2767
|
+
"name": "DataAriaLabelMixin",
|
2768
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
2769
|
+
}
|
2770
|
+
],
|
2771
|
+
"superclass": {
|
2772
|
+
"name": "FormfieldWrapper",
|
2773
|
+
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
2774
|
+
},
|
2775
|
+
"tagName": "mdc-checkbox",
|
2776
|
+
"jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * To create a group of checkboxes, use the FormFieldGroup component.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-checkbox\n *\n * @event change - (React: onChange) Event that gets dispatched when the checkbox state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the checkbox receives focus.\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-border-color - Border color in high contrast.\n * @cssproperty --mdc-checkbox-checked-background-color - Background color for a selected checkbox.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-background-color - Background color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-border-color - Border color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a disabled, selected checkbox.\n * @cssproperty --mdc-checkbox-disabled-icon-color - Icon color for a disabled checkbox.\n * @cssproperty --mdc-checkbox-icon-background-color - Background color for an unselected checkbox.\n * @cssproperty --mdc-checkbox-icon-border-color - Default background color for an unselected checkbox.\n * @cssproperty --mdc-checkbox-icon-color - Icon color for an unselected checkbox.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n */",
|
2777
|
+
"customElement": true,
|
2778
|
+
"slots": [
|
2779
|
+
{
|
2780
|
+
"description": "slot to add the label info icon",
|
2781
|
+
"name": "label-info",
|
2782
|
+
"inheritedFrom": {
|
2783
|
+
"name": "FormfieldWrapper",
|
2784
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2785
|
+
}
|
2786
|
+
}
|
2787
|
+
]
|
2788
|
+
}
|
2789
|
+
],
|
2790
|
+
"exports": [
|
2791
|
+
{
|
2792
|
+
"kind": "js",
|
2793
|
+
"name": "default",
|
2794
|
+
"declaration": {
|
2795
|
+
"name": "Checkbox",
|
2796
|
+
"module": "components/checkbox/checkbox.component.js"
|
2797
|
+
}
|
2798
|
+
}
|
2799
|
+
]
|
2800
|
+
},
|
2801
|
+
{
|
2802
|
+
"kind": "javascript-module",
|
2803
|
+
"path": "components/coachmark/coachmark.component.js",
|
2804
|
+
"declarations": [
|
2805
|
+
{
|
2806
|
+
"kind": "class",
|
2807
|
+
"description": "Coachmark component based on top of the popover component,\nwith the default value of certain properties changed.",
|
2808
|
+
"name": "Coachmark",
|
2809
|
+
"cssProperties": [
|
2810
|
+
{
|
2811
|
+
"description": "radius of the arrow border",
|
2812
|
+
"name": "--mdc-popover-arrow-border-radius",
|
2813
|
+
"inheritedFrom": {
|
2814
|
+
"name": "Popover",
|
2815
|
+
"module": "src/components/popover/popover.component.ts"
|
2816
|
+
}
|
2817
|
+
},
|
2818
|
+
{
|
2819
|
+
"description": "border of the arrow",
|
2820
|
+
"name": "--mdc-popover-arrow-border",
|
2821
|
+
"inheritedFrom": {
|
2822
|
+
"name": "Popover",
|
2823
|
+
"module": "src/components/popover/popover.component.ts"
|
2824
|
+
}
|
2825
|
+
},
|
2826
|
+
{
|
2827
|
+
"description": "primary background color of the popover",
|
2828
|
+
"name": "--mdc-popover-primary-background-color",
|
2829
|
+
"inheritedFrom": {
|
2830
|
+
"name": "Popover",
|
2831
|
+
"module": "src/components/popover/popover.component.ts"
|
2832
|
+
}
|
2833
|
+
},
|
2834
|
+
{
|
2835
|
+
"description": "border color of the popover",
|
2836
|
+
"name": "--mdc-popover-border-color",
|
2837
|
+
"inheritedFrom": {
|
2838
|
+
"name": "Popover",
|
2839
|
+
"module": "src/components/popover/popover.component.ts"
|
2840
|
+
}
|
2841
|
+
},
|
2842
|
+
{
|
2843
|
+
"description": "inverted background color of the popover",
|
2844
|
+
"name": "--mdc-popover-inverted-background-color",
|
2845
|
+
"inheritedFrom": {
|
2846
|
+
"name": "Popover",
|
2847
|
+
"module": "src/components/popover/popover.component.ts"
|
2848
|
+
}
|
2849
|
+
},
|
2850
|
+
{
|
2851
|
+
"description": "inverted border color of the popover",
|
2852
|
+
"name": "--mdc-popover-inverted-border-color",
|
2853
|
+
"inheritedFrom": {
|
2854
|
+
"name": "Popover",
|
2855
|
+
"module": "src/components/popover/popover.component.ts"
|
2856
|
+
}
|
2857
|
+
},
|
2858
|
+
{
|
2859
|
+
"description": "inverted text color of the popover",
|
2860
|
+
"name": "--mdc-popover-inverted-text-color",
|
2861
|
+
"inheritedFrom": {
|
2862
|
+
"name": "Popover",
|
2863
|
+
"module": "src/components/popover/popover.component.ts"
|
2864
|
+
}
|
2865
|
+
},
|
2866
|
+
{
|
2867
|
+
"description": "elevation of the popover",
|
2868
|
+
"name": "--mdc-popover-elevation-3",
|
2869
|
+
"inheritedFrom": {
|
2870
|
+
"name": "Popover",
|
2871
|
+
"module": "src/components/popover/popover.component.ts"
|
2872
|
+
}
|
2873
|
+
}
|
2874
|
+
],
|
2875
|
+
"slots": [
|
2876
|
+
{
|
2877
|
+
"description": "Default slot for modal container",
|
2878
|
+
"name": "",
|
2879
|
+
"inheritedFrom": {
|
2880
|
+
"name": "Popover",
|
2881
|
+
"module": "src/components/popover/popover.component.ts"
|
2882
|
+
}
|
2883
|
+
}
|
2884
|
+
],
|
2885
|
+
"members": [
|
2886
|
+
{
|
2887
|
+
"kind": "field",
|
2888
|
+
"name": "trigger",
|
2889
|
+
"type": {
|
2890
|
+
"text": "PopoverTrigger"
|
2891
|
+
},
|
2892
|
+
"description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
|
2893
|
+
"default": "manual",
|
2894
|
+
"attribute": "trigger",
|
2895
|
+
"reflects": true,
|
2896
|
+
"inheritedFrom": {
|
2897
|
+
"name": "Popover",
|
2898
|
+
"module": "components/popover/popover.component.js"
|
2899
|
+
}
|
2900
|
+
},
|
2901
|
+
{
|
2902
|
+
"kind": "field",
|
2903
|
+
"name": "showArrow",
|
2904
|
+
"type": {
|
2905
|
+
"text": "boolean"
|
2906
|
+
},
|
2907
|
+
"description": "The arrow visibility of the Coachmark.",
|
2908
|
+
"default": "true",
|
2909
|
+
"attribute": "show-arrow",
|
2910
|
+
"reflects": true,
|
2911
|
+
"inheritedFrom": {
|
2912
|
+
"name": "Popover",
|
2913
|
+
"module": "components/popover/popover.component.js"
|
2914
|
+
}
|
2915
|
+
},
|
2916
|
+
{
|
2917
|
+
"kind": "field",
|
2918
|
+
"name": "closeButton",
|
2919
|
+
"type": {
|
2920
|
+
"text": "boolean"
|
2921
|
+
},
|
2922
|
+
"description": "The close button visibility of the Coachmark.",
|
2923
|
+
"default": "true",
|
2924
|
+
"attribute": "close-button",
|
2925
|
+
"reflects": true,
|
2926
|
+
"inheritedFrom": {
|
2927
|
+
"name": "Popover",
|
2928
|
+
"module": "components/popover/popover.component.js"
|
2929
|
+
}
|
2930
|
+
},
|
2931
|
+
{
|
2932
|
+
"kind": "field",
|
2933
|
+
"name": "disableAriaExpanded",
|
2934
|
+
"type": {
|
2935
|
+
"text": "boolean"
|
2936
|
+
},
|
2937
|
+
"description": "Disable aria-expanded attribute on trigger element.",
|
2938
|
+
"default": "true",
|
2939
|
+
"attribute": "disable-aria-expanded",
|
2940
|
+
"reflects": true,
|
2941
|
+
"inheritedFrom": {
|
2942
|
+
"name": "Popover",
|
2943
|
+
"module": "components/popover/popover.component.js"
|
2944
|
+
}
|
2945
|
+
},
|
2946
|
+
{
|
2947
|
+
"kind": "field",
|
2948
|
+
"name": "color",
|
2949
|
+
"type": {
|
2950
|
+
"text": "PopoverColor"
|
2951
|
+
},
|
2952
|
+
"description": "Color of the popover\n- **tonal**\n- **contrast**",
|
2953
|
+
"default": "tonal",
|
2954
|
+
"attribute": "color",
|
2955
|
+
"reflects": true,
|
2956
|
+
"inheritedFrom": {
|
2957
|
+
"name": "Popover",
|
2958
|
+
"module": "components/popover/popover.component.js"
|
2959
|
+
}
|
2960
|
+
},
|
2961
|
+
{
|
2962
|
+
"kind": "field",
|
2963
|
+
"name": "enabledFocusTrap",
|
2964
|
+
"type": {
|
2965
|
+
"text": "boolean"
|
2966
|
+
},
|
2967
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
2968
|
+
"default": "false",
|
2969
|
+
"attribute": "enabledFocusTrap",
|
2970
|
+
"inheritedFrom": {
|
2971
|
+
"name": "FocusTrapMixin",
|
2972
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2973
|
+
}
|
2974
|
+
},
|
2975
|
+
{
|
2976
|
+
"kind": "field",
|
2977
|
+
"name": "enabledPreventScroll",
|
2978
|
+
"type": {
|
2979
|
+
"text": "boolean"
|
2980
|
+
},
|
2981
|
+
"description": "Prevent outside scrolling when popover show.",
|
2982
|
+
"default": "false",
|
2983
|
+
"attribute": "enabledPreventScroll",
|
2984
|
+
"inheritedFrom": {
|
2985
|
+
"name": "FocusTrapMixin",
|
2986
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2987
|
+
}
|
2988
|
+
},
|
2989
|
+
{
|
2990
|
+
"kind": "field",
|
2991
|
+
"name": "shouldWrapFocus",
|
2992
|
+
"type": {
|
2993
|
+
"text": "() => boolean"
|
2994
|
+
},
|
2995
|
+
"inheritedFrom": {
|
2996
|
+
"name": "FocusTrapMixin",
|
2997
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2998
|
+
}
|
2999
|
+
},
|
3000
|
+
{
|
3001
|
+
"kind": "method",
|
3002
|
+
"name": "deactivateFocusTrap",
|
3003
|
+
"description": "Deactivate the focus trap.",
|
3004
|
+
"inheritedFrom": {
|
3005
|
+
"name": "FocusTrapMixin",
|
3006
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3007
|
+
}
|
3008
|
+
},
|
3009
|
+
{
|
3010
|
+
"kind": "method",
|
3011
|
+
"name": "hasNoClientRects",
|
3012
|
+
"privacy": "private",
|
3013
|
+
"parameters": [
|
3014
|
+
{
|
3015
|
+
"name": "element",
|
3016
|
+
"type": {
|
3017
|
+
"text": "HTMLElement"
|
3018
|
+
},
|
3019
|
+
"description": "The element to check."
|
3020
|
+
}
|
3021
|
+
],
|
3022
|
+
"description": "Checks if the element has no client rectangles (not visible in the viewport).",
|
3023
|
+
"return": {
|
3024
|
+
"type": {
|
3025
|
+
"text": ""
|
3026
|
+
}
|
3027
|
+
},
|
3028
|
+
"inheritedFrom": {
|
3029
|
+
"name": "FocusTrapMixin",
|
3030
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3031
|
+
}
|
3032
|
+
},
|
3033
|
+
{
|
3034
|
+
"kind": "method",
|
3035
|
+
"name": "hasZeroDimensions",
|
3036
|
+
"privacy": "private",
|
3037
|
+
"parameters": [
|
3038
|
+
{
|
3039
|
+
"name": "element",
|
3040
|
+
"type": {
|
3041
|
+
"text": "HTMLElement"
|
3042
|
+
},
|
3043
|
+
"description": "The element to check."
|
3044
|
+
}
|
3045
|
+
],
|
3046
|
+
"description": "Checks if the element has zero dimensions (width and height are both 0).",
|
3047
|
+
"return": {
|
3048
|
+
"type": {
|
3049
|
+
"text": ""
|
3050
|
+
}
|
3051
|
+
},
|
3052
|
+
"inheritedFrom": {
|
3053
|
+
"name": "FocusTrapMixin",
|
3054
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3055
|
+
}
|
3056
|
+
},
|
3057
|
+
{
|
3058
|
+
"kind": "method",
|
3059
|
+
"name": "isNotVisible",
|
3060
|
+
"privacy": "private",
|
3061
|
+
"parameters": [
|
3062
|
+
{
|
3063
|
+
"name": "element",
|
3064
|
+
"type": {
|
3065
|
+
"text": "HTMLElement"
|
3066
|
+
},
|
3067
|
+
"description": "The element to check."
|
3068
|
+
}
|
3069
|
+
],
|
3070
|
+
"description": "Determines if the element is not visible in the DOM.",
|
3071
|
+
"return": {
|
3072
|
+
"type": {
|
3073
|
+
"text": ""
|
3074
|
+
}
|
3075
|
+
},
|
3076
|
+
"inheritedFrom": {
|
3077
|
+
"name": "FocusTrapMixin",
|
3078
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3079
|
+
}
|
3080
|
+
},
|
3081
|
+
{
|
3082
|
+
"kind": "method",
|
3083
|
+
"name": "hasHiddenStyle",
|
3084
|
+
"privacy": "private",
|
3085
|
+
"parameters": [
|
3086
|
+
{
|
3087
|
+
"name": "element",
|
3088
|
+
"type": {
|
3089
|
+
"text": "HTMLElement"
|
3090
|
+
},
|
3091
|
+
"description": "The element to check."
|
3092
|
+
}
|
3093
|
+
],
|
3094
|
+
"description": "Checks if the element has inline styles that make it hidden.",
|
3095
|
+
"return": {
|
3096
|
+
"type": {
|
3097
|
+
"text": ""
|
3098
|
+
}
|
3099
|
+
},
|
3100
|
+
"inheritedFrom": {
|
3101
|
+
"name": "FocusTrapMixin",
|
3102
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3103
|
+
}
|
3104
|
+
},
|
3105
|
+
{
|
3106
|
+
"kind": "method",
|
3107
|
+
"name": "hasComputedHidden",
|
3108
|
+
"privacy": "private",
|
3109
|
+
"parameters": [
|
3110
|
+
{
|
3111
|
+
"name": "element",
|
3112
|
+
"type": {
|
3113
|
+
"text": "HTMLElement"
|
3114
|
+
},
|
3115
|
+
"description": "The element to check."
|
3116
|
+
}
|
3117
|
+
],
|
3118
|
+
"description": "Checks if the element is hidden by a computed style.",
|
3119
|
+
"return": {
|
3120
|
+
"type": {
|
3121
|
+
"text": ""
|
3122
|
+
}
|
3123
|
+
},
|
3124
|
+
"inheritedFrom": {
|
3125
|
+
"name": "FocusTrapMixin",
|
3126
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3127
|
+
}
|
3128
|
+
},
|
3129
|
+
{
|
3130
|
+
"kind": "method",
|
3131
|
+
"name": "isHidden",
|
3132
|
+
"privacy": "private",
|
3133
|
+
"parameters": [
|
3134
|
+
{
|
3135
|
+
"name": "element",
|
3136
|
+
"type": {
|
3137
|
+
"text": "HTMLElement"
|
3138
|
+
},
|
3139
|
+
"description": "The element to check."
|
3140
|
+
}
|
3141
|
+
],
|
3142
|
+
"description": "Checks if the element is hidden from the user.",
|
3143
|
+
"return": {
|
3144
|
+
"type": {
|
3145
|
+
"text": ""
|
3146
|
+
}
|
3147
|
+
},
|
3148
|
+
"inheritedFrom": {
|
3149
|
+
"name": "FocusTrapMixin",
|
3150
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3151
|
+
}
|
3152
|
+
},
|
3153
|
+
{
|
3154
|
+
"kind": "method",
|
3155
|
+
"name": "isNotTabbable",
|
3156
|
+
"privacy": "private",
|
3157
|
+
"parameters": [
|
3158
|
+
{
|
3159
|
+
"name": "element",
|
3160
|
+
"type": {
|
3161
|
+
"text": "HTMLElement"
|
3162
|
+
},
|
3163
|
+
"description": "The element to check."
|
3164
|
+
}
|
3165
|
+
],
|
3166
|
+
"description": "Checks if the element is not tabbable.",
|
3167
|
+
"return": {
|
3168
|
+
"type": {
|
3169
|
+
"text": ""
|
3170
|
+
}
|
3171
|
+
},
|
3172
|
+
"inheritedFrom": {
|
3173
|
+
"name": "FocusTrapMixin",
|
3174
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3175
|
+
}
|
3176
|
+
},
|
3177
|
+
{
|
3178
|
+
"kind": "method",
|
3179
|
+
"name": "isInteractiveElement",
|
3180
|
+
"privacy": "private",
|
3181
|
+
"return": {
|
3182
|
+
"type": {
|
3183
|
+
"text": ""
|
3184
|
+
}
|
3185
|
+
},
|
3186
|
+
"parameters": [
|
3187
|
+
{
|
3188
|
+
"name": "element",
|
3189
|
+
"type": {
|
3190
|
+
"text": "HTMLElement"
|
3191
|
+
},
|
3192
|
+
"description": "The element to check."
|
3193
|
+
}
|
3194
|
+
],
|
3195
|
+
"description": "Checks if the element is interactive.",
|
3196
|
+
"inheritedFrom": {
|
3197
|
+
"name": "FocusTrapMixin",
|
3198
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3199
|
+
}
|
3200
|
+
},
|
3201
|
+
{
|
3202
|
+
"kind": "method",
|
3203
|
+
"name": "isFocusable",
|
3204
|
+
"privacy": "private",
|
3205
|
+
"parameters": [
|
3206
|
+
{
|
3207
|
+
"name": "element",
|
3208
|
+
"type": {
|
3209
|
+
"text": "HTMLElement"
|
3210
|
+
},
|
3211
|
+
"description": "The element to check."
|
3212
|
+
}
|
3213
|
+
],
|
3214
|
+
"description": "Checks if the element is focusable.",
|
3215
|
+
"return": {
|
3216
|
+
"type": {
|
3217
|
+
"text": ""
|
3218
|
+
}
|
3219
|
+
},
|
3220
|
+
"inheritedFrom": {
|
3221
|
+
"name": "FocusTrapMixin",
|
3222
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3223
|
+
}
|
3224
|
+
},
|
3225
|
+
{
|
3226
|
+
"kind": "method",
|
3227
|
+
"name": "findFocusable",
|
3228
|
+
"privacy": "private",
|
3229
|
+
"return": {
|
3230
|
+
"type": {
|
3231
|
+
"text": ""
|
3232
|
+
}
|
3233
|
+
},
|
3234
|
+
"parameters": [
|
3235
|
+
{
|
3236
|
+
"name": "root",
|
3237
|
+
"type": {
|
3238
|
+
"text": "ShadowRoot | HTMLElement"
|
3239
|
+
},
|
3240
|
+
"description": "The root element to search for focusable elements."
|
3241
|
+
},
|
3242
|
+
{
|
3243
|
+
"name": "matches",
|
3244
|
+
"default": "new Set()",
|
3245
|
+
"type": {
|
3246
|
+
"text": "Set<HTMLElement>"
|
3247
|
+
},
|
3248
|
+
"description": "The set of focusable elements."
|
3249
|
+
}
|
3250
|
+
],
|
3251
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.",
|
3252
|
+
"inheritedFrom": {
|
3253
|
+
"name": "FocusTrapMixin",
|
3254
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3255
|
+
}
|
3256
|
+
},
|
3257
|
+
{
|
3258
|
+
"kind": "method",
|
3259
|
+
"name": "setFocusableElements",
|
3260
|
+
"privacy": "public",
|
3261
|
+
"description": "Updates the list of focusable elements within the component's shadow root.",
|
3262
|
+
"inheritedFrom": {
|
3263
|
+
"name": "FocusTrapMixin",
|
3264
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3265
|
+
}
|
3266
|
+
},
|
3267
|
+
{
|
3268
|
+
"kind": "method",
|
3269
|
+
"name": "setInitialFocus",
|
3270
|
+
"privacy": "public",
|
3271
|
+
"parameters": [
|
3272
|
+
{
|
3273
|
+
"name": "prefferableElement",
|
3274
|
+
"default": "0",
|
3275
|
+
"type": {
|
3276
|
+
"text": "number"
|
3277
|
+
},
|
3278
|
+
"description": "The index of the prefferable element to focus."
|
3279
|
+
}
|
3280
|
+
],
|
3281
|
+
"description": "Sets the initial focus within the container.",
|
3282
|
+
"inheritedFrom": {
|
3283
|
+
"name": "FocusTrapMixin",
|
3284
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3285
|
+
}
|
3286
|
+
},
|
3287
|
+
{
|
3288
|
+
"kind": "method",
|
3289
|
+
"name": "calculateNextIndex",
|
3290
|
+
"privacy": "private",
|
3291
|
+
"parameters": [
|
3292
|
+
{
|
3293
|
+
"name": "currentIndex",
|
3294
|
+
"type": {
|
3295
|
+
"text": "number"
|
3296
|
+
},
|
3297
|
+
"description": "The current index."
|
3298
|
+
},
|
3299
|
+
{
|
3300
|
+
"name": "step",
|
3301
|
+
"type": {
|
3302
|
+
"text": "number"
|
3303
|
+
},
|
3304
|
+
"description": "The step to calculate the next index."
|
3305
|
+
}
|
3306
|
+
],
|
3307
|
+
"description": "Calculates the next index for the focus trap.",
|
3308
|
+
"return": {
|
3309
|
+
"type": {
|
3310
|
+
"text": ""
|
3311
|
+
}
|
3312
|
+
},
|
3313
|
+
"inheritedFrom": {
|
3314
|
+
"name": "FocusTrapMixin",
|
3315
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3316
|
+
}
|
3317
|
+
},
|
3318
|
+
{
|
3319
|
+
"kind": "method",
|
3320
|
+
"name": "getDeepActiveElement",
|
3321
|
+
"privacy": "private",
|
3322
|
+
"description": "Returns the deepest active element in the shadow DOM.",
|
3323
|
+
"return": {
|
3324
|
+
"type": {
|
3325
|
+
"text": ""
|
3326
|
+
}
|
3327
|
+
},
|
3328
|
+
"inheritedFrom": {
|
3329
|
+
"name": "FocusTrapMixin",
|
3330
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3331
|
+
}
|
3332
|
+
},
|
3333
|
+
{
|
3334
|
+
"kind": "method",
|
3335
|
+
"name": "findElement",
|
3336
|
+
"privacy": "private",
|
3337
|
+
"parameters": [
|
3338
|
+
{
|
3339
|
+
"name": "activeElement",
|
3340
|
+
"type": {
|
3341
|
+
"text": "HTMLElement"
|
3342
|
+
},
|
3343
|
+
"description": "The active element."
|
3344
|
+
}
|
3345
|
+
],
|
3346
|
+
"description": "Finds the index of the active element within the focusable elements.",
|
3347
|
+
"return": {
|
3348
|
+
"type": {
|
3349
|
+
"text": ""
|
3350
|
+
}
|
3351
|
+
},
|
3352
|
+
"inheritedFrom": {
|
3353
|
+
"name": "FocusTrapMixin",
|
3354
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3355
|
+
}
|
3356
|
+
},
|
3357
|
+
{
|
3358
|
+
"kind": "method",
|
3359
|
+
"name": "isEqualFocusNode",
|
3360
|
+
"privacy": "private",
|
3361
|
+
"parameters": [
|
3362
|
+
{
|
3363
|
+
"name": "activeElement",
|
3364
|
+
"type": {
|
3365
|
+
"text": "HTMLElement"
|
3366
|
+
},
|
3367
|
+
"description": "The active element."
|
3368
|
+
},
|
3369
|
+
{
|
3370
|
+
"name": "element",
|
3371
|
+
"type": {
|
3372
|
+
"text": "HTMLElement"
|
3373
|
+
},
|
3374
|
+
"description": "The element to compare."
|
3375
|
+
}
|
3376
|
+
],
|
3377
|
+
"description": "Checks if the active element is equal to the given element.",
|
3378
|
+
"return": {
|
3379
|
+
"type": {
|
3380
|
+
"text": ""
|
3381
|
+
}
|
3382
|
+
},
|
3383
|
+
"inheritedFrom": {
|
3384
|
+
"name": "FocusTrapMixin",
|
3385
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3386
|
+
}
|
3387
|
+
},
|
3388
|
+
{
|
3389
|
+
"kind": "method",
|
3390
|
+
"name": "trapFocus",
|
3391
|
+
"privacy": "private",
|
3392
|
+
"parameters": [
|
3393
|
+
{
|
3394
|
+
"name": "direction",
|
3395
|
+
"type": {
|
3396
|
+
"text": "boolean"
|
3397
|
+
},
|
3398
|
+
"description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element."
|
3399
|
+
}
|
3400
|
+
],
|
3401
|
+
"description": "Traps focus within the container.",
|
3402
|
+
"inheritedFrom": {
|
3403
|
+
"name": "FocusTrapMixin",
|
3404
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3405
|
+
}
|
3406
|
+
},
|
3407
|
+
{
|
3408
|
+
"kind": "method",
|
3409
|
+
"name": "handleKeydown",
|
3410
|
+
"privacy": "private",
|
3411
|
+
"parameters": [
|
3412
|
+
{
|
3413
|
+
"name": "event",
|
3414
|
+
"type": {
|
3415
|
+
"text": "KeyboardEvent"
|
3416
|
+
},
|
3417
|
+
"description": "The keyboard event."
|
3418
|
+
}
|
3419
|
+
],
|
3420
|
+
"description": "Traps focus within the container.",
|
3421
|
+
"inheritedFrom": {
|
3422
|
+
"name": "FocusTrapMixin",
|
3423
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
3424
|
+
}
|
3425
|
+
},
|
3426
|
+
{
|
3427
|
+
"kind": "field",
|
3428
|
+
"name": "id",
|
3429
|
+
"type": {
|
3430
|
+
"text": "string"
|
3431
|
+
},
|
3432
|
+
"default": "''",
|
3433
|
+
"description": "The unique ID of the popover.",
|
3434
|
+
"attribute": "id",
|
3435
|
+
"inheritedFrom": {
|
3436
|
+
"name": "Popover",
|
3437
|
+
"module": "components/popover/popover.component.js"
|
3438
|
+
}
|
3439
|
+
},
|
3440
|
+
{
|
3441
|
+
"kind": "field",
|
3442
|
+
"name": "triggerID",
|
3443
|
+
"type": {
|
3444
|
+
"text": "string"
|
3445
|
+
},
|
3446
|
+
"default": "''",
|
3447
|
+
"description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
|
3448
|
+
"attribute": "triggerID",
|
3449
|
+
"inheritedFrom": {
|
3450
|
+
"name": "Popover",
|
3451
|
+
"module": "components/popover/popover.component.js"
|
3452
|
+
}
|
3453
|
+
},
|
3454
|
+
{
|
3455
|
+
"kind": "field",
|
3456
|
+
"name": "placement",
|
3457
|
+
"type": {
|
3458
|
+
"text": "PopoverPlacement"
|
3459
|
+
},
|
3460
|
+
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
3461
|
+
"default": "bottom",
|
3462
|
+
"attribute": "placement",
|
3463
|
+
"reflects": true,
|
3464
|
+
"inheritedFrom": {
|
3465
|
+
"name": "Popover",
|
3466
|
+
"module": "components/popover/popover.component.js"
|
3467
|
+
}
|
3468
|
+
},
|
3469
|
+
{
|
3470
|
+
"kind": "field",
|
3471
|
+
"name": "visible",
|
3472
|
+
"type": {
|
3473
|
+
"text": "boolean"
|
3474
|
+
},
|
3475
|
+
"description": "The visibility of the popover.",
|
3476
|
+
"default": "false",
|
3477
|
+
"attribute": "visible",
|
3478
|
+
"reflects": true,
|
3479
|
+
"inheritedFrom": {
|
3480
|
+
"name": "Popover",
|
3481
|
+
"module": "components/popover/popover.component.js"
|
3482
|
+
}
|
3483
|
+
},
|
3484
|
+
{
|
3485
|
+
"kind": "field",
|
3486
|
+
"name": "offset",
|
3487
|
+
"type": {
|
3488
|
+
"text": "number"
|
3489
|
+
},
|
3490
|
+
"description": "The offset of the popover.",
|
3491
|
+
"default": "4",
|
3492
|
+
"attribute": "offset",
|
3493
|
+
"reflects": true,
|
3494
|
+
"inheritedFrom": {
|
3495
|
+
"name": "Popover",
|
3496
|
+
"module": "components/popover/popover.component.js"
|
3497
|
+
}
|
3498
|
+
},
|
3499
|
+
{
|
3500
|
+
"kind": "field",
|
3501
|
+
"name": "focusTrap",
|
3502
|
+
"type": {
|
3503
|
+
"text": "boolean"
|
3504
|
+
},
|
3505
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
3506
|
+
"default": "false",
|
3507
|
+
"attribute": "focus-trap",
|
3508
|
+
"reflects": true,
|
3509
|
+
"inheritedFrom": {
|
3510
|
+
"name": "Popover",
|
3511
|
+
"module": "components/popover/popover.component.js"
|
3512
|
+
}
|
3513
|
+
},
|
3514
|
+
{
|
3515
|
+
"kind": "field",
|
3516
|
+
"name": "preventScroll",
|
3517
|
+
"type": {
|
3518
|
+
"text": "boolean"
|
3519
|
+
},
|
3520
|
+
"description": "Prevent outside scrolling when popover show.",
|
3521
|
+
"default": "false",
|
3522
|
+
"attribute": "prevent-scroll",
|
3523
|
+
"reflects": true,
|
3524
|
+
"inheritedFrom": {
|
3525
|
+
"name": "Popover",
|
3526
|
+
"module": "components/popover/popover.component.js"
|
3527
|
+
}
|
3528
|
+
},
|
3529
|
+
{
|
3530
|
+
"kind": "field",
|
3531
|
+
"name": "interactive",
|
3532
|
+
"type": {
|
3533
|
+
"text": "boolean"
|
3534
|
+
},
|
3535
|
+
"description": "Determines whether the popover is interactive。",
|
3536
|
+
"default": "false",
|
3537
|
+
"attribute": "interactive",
|
3538
|
+
"reflects": true,
|
3539
|
+
"inheritedFrom": {
|
3540
|
+
"name": "Popover",
|
3541
|
+
"module": "components/popover/popover.component.js"
|
3542
|
+
}
|
3543
|
+
},
|
3544
|
+
{
|
3545
|
+
"kind": "field",
|
3546
|
+
"name": "delay",
|
3547
|
+
"type": {
|
3548
|
+
"text": "string"
|
3549
|
+
},
|
3550
|
+
"description": "The delay of the show/hide popover.",
|
3551
|
+
"default": "0,0",
|
3552
|
+
"attribute": "delay",
|
3553
|
+
"reflects": true,
|
3554
|
+
"inheritedFrom": {
|
3555
|
+
"name": "Popover",
|
3556
|
+
"module": "components/popover/popover.component.js"
|
3557
|
+
}
|
3558
|
+
},
|
3559
|
+
{
|
3560
|
+
"kind": "field",
|
3561
|
+
"name": "hideOnEscape",
|
3562
|
+
"type": {
|
3563
|
+
"text": "boolean"
|
3564
|
+
},
|
3565
|
+
"description": "Hide popover on escape key press.",
|
3566
|
+
"default": "false",
|
3567
|
+
"attribute": "hide-on-escape",
|
3568
|
+
"reflects": true,
|
3569
|
+
"inheritedFrom": {
|
3570
|
+
"name": "Popover",
|
3571
|
+
"module": "components/popover/popover.component.js"
|
3572
|
+
}
|
3573
|
+
},
|
3574
|
+
{
|
3575
|
+
"kind": "field",
|
3576
|
+
"name": "hideOnBlur",
|
3577
|
+
"type": {
|
3578
|
+
"text": "boolean"
|
3579
|
+
},
|
3580
|
+
"description": "Hide popover on blur.",
|
3581
|
+
"default": "false",
|
3582
|
+
"attribute": "hide-on-blur",
|
3583
|
+
"reflects": true,
|
3584
|
+
"inheritedFrom": {
|
3585
|
+
"name": "Popover",
|
3586
|
+
"module": "components/popover/popover.component.js"
|
3587
|
+
}
|
3588
|
+
},
|
3589
|
+
{
|
3590
|
+
"kind": "field",
|
3591
|
+
"name": "hideOnOutsideClick",
|
3592
|
+
"type": {
|
3593
|
+
"text": "boolean"
|
3594
|
+
},
|
3595
|
+
"description": "Hide on outside click of the popover.",
|
3596
|
+
"default": "false",
|
3597
|
+
"attribute": "hide-on-outside-click",
|
3598
|
+
"reflects": true,
|
3599
|
+
"inheritedFrom": {
|
3600
|
+
"name": "Popover",
|
3601
|
+
"module": "components/popover/popover.component.js"
|
3602
|
+
}
|
3603
|
+
},
|
3604
|
+
{
|
3605
|
+
"kind": "field",
|
3606
|
+
"name": "focusBackToTrigger",
|
3607
|
+
"type": {
|
3608
|
+
"text": "boolean"
|
3609
|
+
},
|
3610
|
+
"description": "The focus back to trigger after the popover hide.",
|
3611
|
+
"default": "false",
|
3612
|
+
"attribute": "focus-back-to-trigger",
|
3613
|
+
"reflects": true,
|
3614
|
+
"inheritedFrom": {
|
3615
|
+
"name": "Popover",
|
3616
|
+
"module": "components/popover/popover.component.js"
|
3617
|
+
}
|
3618
|
+
},
|
3619
|
+
{
|
3620
|
+
"kind": "field",
|
3621
|
+
"name": "backdrop",
|
3622
|
+
"type": {
|
3623
|
+
"text": "boolean"
|
3624
|
+
},
|
3625
|
+
"description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
|
3626
|
+
"default": "false",
|
3627
|
+
"attribute": "backdrop",
|
3628
|
+
"reflects": true,
|
3629
|
+
"inheritedFrom": {
|
3630
|
+
"name": "Popover",
|
3631
|
+
"module": "components/popover/popover.component.js"
|
3632
|
+
}
|
3633
|
+
},
|
3634
|
+
{
|
3635
|
+
"kind": "field",
|
3636
|
+
"name": "flip",
|
3637
|
+
"type": {
|
3638
|
+
"text": "boolean"
|
3639
|
+
},
|
3640
|
+
"description": "Changes the placement of popover to keep it in view when scrolling.",
|
3641
|
+
"default": "true",
|
3642
|
+
"attribute": "flip",
|
3643
|
+
"reflects": true,
|
3644
|
+
"inheritedFrom": {
|
3645
|
+
"name": "Popover",
|
3646
|
+
"module": "components/popover/popover.component.js"
|
3647
|
+
}
|
3648
|
+
},
|
3649
|
+
{
|
3650
|
+
"kind": "field",
|
3651
|
+
"name": "size",
|
3652
|
+
"type": {
|
3653
|
+
"text": "boolean"
|
3654
|
+
},
|
3655
|
+
"description": "Changes the size of popover to keep it in view when scrolling.",
|
3656
|
+
"default": "false",
|
3657
|
+
"attribute": "size",
|
3658
|
+
"reflects": true,
|
3659
|
+
"inheritedFrom": {
|
3660
|
+
"name": "Popover",
|
3661
|
+
"module": "components/popover/popover.component.js"
|
3662
|
+
}
|
3663
|
+
},
|
3664
|
+
{
|
3665
|
+
"kind": "field",
|
3666
|
+
"name": "zIndex",
|
3667
|
+
"type": {
|
3668
|
+
"text": "number"
|
3669
|
+
},
|
3670
|
+
"description": "The z-index of the popover.",
|
3671
|
+
"default": "1000",
|
3672
|
+
"attribute": "z-index",
|
3673
|
+
"reflects": true,
|
3674
|
+
"inheritedFrom": {
|
3675
|
+
"name": "Popover",
|
3676
|
+
"module": "components/popover/popover.component.js"
|
3677
|
+
}
|
3678
|
+
},
|
3679
|
+
{
|
3680
|
+
"kind": "field",
|
3681
|
+
"name": "appendTo",
|
3682
|
+
"type": {
|
3683
|
+
"text": "string"
|
3684
|
+
},
|
3685
|
+
"default": "''",
|
3686
|
+
"description": "Element ID that the popover append to.",
|
3687
|
+
"attribute": "append-to",
|
3688
|
+
"reflects": true,
|
3689
|
+
"inheritedFrom": {
|
3690
|
+
"name": "Popover",
|
3691
|
+
"module": "components/popover/popover.component.js"
|
3692
|
+
}
|
2187
3693
|
},
|
2188
3694
|
{
|
2189
|
-
"
|
2190
|
-
"name": "
|
3695
|
+
"kind": "field",
|
3696
|
+
"name": "closeButtonAriaLabel",
|
3697
|
+
"type": {
|
3698
|
+
"text": "string | null"
|
3699
|
+
},
|
3700
|
+
"default": "null",
|
3701
|
+
"description": "aria-label attribute to be set for close button accessibility.",
|
3702
|
+
"attribute": "close-button-aria-label",
|
3703
|
+
"inheritedFrom": {
|
3704
|
+
"name": "Popover",
|
3705
|
+
"module": "components/popover/popover.component.js"
|
3706
|
+
}
|
2191
3707
|
},
|
2192
3708
|
{
|
2193
|
-
"
|
2194
|
-
"name": "
|
3709
|
+
"kind": "field",
|
3710
|
+
"name": "role",
|
3711
|
+
"type": {
|
3712
|
+
"text": "HTMLElement['role']"
|
3713
|
+
},
|
3714
|
+
"description": "Role of the popover",
|
3715
|
+
"default": "dialog",
|
3716
|
+
"attribute": "role",
|
3717
|
+
"reflects": true,
|
3718
|
+
"inheritedFrom": {
|
3719
|
+
"name": "Popover",
|
3720
|
+
"module": "components/popover/popover.component.js"
|
3721
|
+
}
|
2195
3722
|
},
|
2196
3723
|
{
|
2197
|
-
"
|
2198
|
-
"name": "
|
2199
|
-
|
2200
|
-
|
2201
|
-
|
3724
|
+
"kind": "field",
|
3725
|
+
"name": "ariaLabelledby",
|
3726
|
+
"type": {
|
3727
|
+
"text": "string | null"
|
3728
|
+
},
|
3729
|
+
"default": "null",
|
3730
|
+
"description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
|
3731
|
+
"attribute": "aria-labelledby",
|
3732
|
+
"reflects": true,
|
3733
|
+
"inheritedFrom": {
|
3734
|
+
"name": "Popover",
|
3735
|
+
"module": "components/popover/popover.component.js"
|
3736
|
+
}
|
3737
|
+
},
|
2202
3738
|
{
|
2203
3739
|
"kind": "field",
|
2204
|
-
"name": "
|
3740
|
+
"name": "ariaDescribedby",
|
2205
3741
|
"type": {
|
2206
|
-
"text": "
|
3742
|
+
"text": "string | null"
|
2207
3743
|
},
|
2208
|
-
"default": "
|
2209
|
-
"description": "
|
2210
|
-
"attribute": "
|
2211
|
-
"reflects": true
|
3744
|
+
"default": "null",
|
3745
|
+
"description": "aria-describedby of the popover.",
|
3746
|
+
"attribute": "aria-describedby",
|
3747
|
+
"reflects": true,
|
3748
|
+
"inheritedFrom": {
|
3749
|
+
"name": "Popover",
|
3750
|
+
"module": "components/popover/popover.component.js"
|
3751
|
+
}
|
2212
3752
|
},
|
2213
3753
|
{
|
2214
3754
|
"kind": "field",
|
2215
|
-
"name": "
|
3755
|
+
"name": "arrowElement",
|
2216
3756
|
"type": {
|
2217
|
-
"text": "
|
3757
|
+
"text": "HTMLElement | null"
|
2218
3758
|
},
|
2219
|
-
"
|
2220
|
-
"
|
2221
|
-
"
|
2222
|
-
|
3759
|
+
"privacy": "public",
|
3760
|
+
"default": "null",
|
3761
|
+
"inheritedFrom": {
|
3762
|
+
"name": "Popover",
|
3763
|
+
"module": "components/popover/popover.component.js"
|
3764
|
+
}
|
2223
3765
|
},
|
2224
3766
|
{
|
2225
3767
|
"kind": "field",
|
2226
|
-
"name": "
|
3768
|
+
"name": "triggerElement",
|
2227
3769
|
"type": {
|
2228
|
-
"text": "
|
3770
|
+
"text": "HTMLElement | null"
|
2229
3771
|
},
|
2230
|
-
"
|
2231
|
-
"
|
2232
|
-
"
|
2233
|
-
|
3772
|
+
"privacy": "public",
|
3773
|
+
"default": "null",
|
3774
|
+
"inheritedFrom": {
|
3775
|
+
"name": "Popover",
|
3776
|
+
"module": "components/popover/popover.component.js"
|
3777
|
+
}
|
2234
3778
|
},
|
2235
3779
|
{
|
2236
3780
|
"kind": "method",
|
2237
|
-
"name": "
|
3781
|
+
"name": "setupTriggerListener",
|
2238
3782
|
"privacy": "private",
|
2239
|
-
"description": "
|
3783
|
+
"description": "Sets up the trigger event listeners based on the trigger type.",
|
3784
|
+
"inheritedFrom": {
|
3785
|
+
"name": "Popover",
|
3786
|
+
"module": "components/popover/popover.component.js"
|
3787
|
+
}
|
2240
3788
|
},
|
2241
3789
|
{
|
2242
3790
|
"kind": "method",
|
2243
|
-
"name": "
|
3791
|
+
"name": "removeEventListeners",
|
2244
3792
|
"privacy": "private",
|
2245
|
-
"description": "
|
3793
|
+
"description": "Removes the trigger event listeners.",
|
3794
|
+
"inheritedFrom": {
|
3795
|
+
"name": "Popover",
|
3796
|
+
"module": "components/popover/popover.component.js"
|
3797
|
+
}
|
2246
3798
|
},
|
2247
3799
|
{
|
2248
|
-
"kind": "
|
2249
|
-
"name": "
|
3800
|
+
"kind": "field",
|
3801
|
+
"name": "onOutsidePopoverClick",
|
2250
3802
|
"privacy": "private",
|
2251
|
-
"
|
2252
|
-
|
2253
|
-
|
3803
|
+
"description": "Handles the outside click event to close the popover.",
|
3804
|
+
"parameters": [
|
3805
|
+
{
|
3806
|
+
"description": "The mouse event.",
|
3807
|
+
"name": "event"
|
2254
3808
|
}
|
2255
|
-
|
2256
|
-
"
|
3809
|
+
],
|
3810
|
+
"inheritedFrom": {
|
3811
|
+
"name": "Popover",
|
3812
|
+
"module": "components/popover/popover.component.js"
|
3813
|
+
}
|
2257
3814
|
},
|
2258
3815
|
{
|
2259
|
-
"kind": "
|
2260
|
-
"name": "
|
3816
|
+
"kind": "field",
|
3817
|
+
"name": "onEscapeKeydown",
|
2261
3818
|
"privacy": "private",
|
2262
|
-
"
|
2263
|
-
|
2264
|
-
|
3819
|
+
"description": "Handles the escape keydown event to close the popover.",
|
3820
|
+
"parameters": [
|
3821
|
+
{
|
3822
|
+
"description": "The keyboard event.",
|
3823
|
+
"name": "event"
|
2265
3824
|
}
|
2266
|
-
|
3825
|
+
],
|
3826
|
+
"inheritedFrom": {
|
3827
|
+
"name": "Popover",
|
3828
|
+
"module": "components/popover/popover.component.js"
|
3829
|
+
}
|
3830
|
+
},
|
3831
|
+
{
|
3832
|
+
"kind": "field",
|
3833
|
+
"name": "onPopoverFocusOut",
|
3834
|
+
"privacy": "private",
|
3835
|
+
"description": "Handles the popover focus out event.",
|
2267
3836
|
"parameters": [
|
2268
3837
|
{
|
2269
|
-
"
|
2270
|
-
"
|
2271
|
-
"text": "KeyboardEvent"
|
2272
|
-
},
|
2273
|
-
"description": "The keyboard event."
|
3838
|
+
"description": "The focus event.",
|
3839
|
+
"name": "event"
|
2274
3840
|
}
|
2275
3841
|
],
|
2276
|
-
"
|
3842
|
+
"inheritedFrom": {
|
3843
|
+
"name": "Popover",
|
3844
|
+
"module": "components/popover/popover.component.js"
|
3845
|
+
}
|
2277
3846
|
},
|
2278
3847
|
{
|
2279
3848
|
"kind": "method",
|
2280
|
-
"name": "
|
2281
|
-
"privacy": "
|
2282
|
-
"return": {
|
2283
|
-
"type": {
|
2284
|
-
"text": "void"
|
2285
|
-
}
|
2286
|
-
},
|
3849
|
+
"name": "isOpenUpdated",
|
3850
|
+
"privacy": "private",
|
2287
3851
|
"parameters": [
|
2288
3852
|
{
|
2289
|
-
"name": "
|
3853
|
+
"name": "oldValue",
|
2290
3854
|
"type": {
|
2291
|
-
"text": "
|
2292
|
-
}
|
3855
|
+
"text": "boolean"
|
3856
|
+
},
|
3857
|
+
"description": "The old value of the visible property."
|
3858
|
+
},
|
3859
|
+
{
|
3860
|
+
"name": "newValue",
|
3861
|
+
"type": {
|
3862
|
+
"text": "boolean"
|
3863
|
+
},
|
3864
|
+
"description": "The new value of the visible property."
|
2293
3865
|
}
|
2294
3866
|
],
|
2295
|
-
"description": "
|
2296
|
-
|
2297
|
-
|
2298
|
-
|
2299
|
-
|
2300
|
-
"privacy": "private"
|
3867
|
+
"description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
|
3868
|
+
"inheritedFrom": {
|
3869
|
+
"name": "Popover",
|
3870
|
+
"module": "components/popover/popover.component.js"
|
3871
|
+
}
|
2301
3872
|
},
|
2302
3873
|
{
|
2303
3874
|
"kind": "field",
|
2304
|
-
"name": "
|
2305
|
-
"
|
2306
|
-
|
2307
|
-
},
|
2308
|
-
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
2309
|
-
"attribute": "help-text-type",
|
2310
|
-
"reflects": true,
|
2311
|
-
"default": "undefined as unknown",
|
3875
|
+
"name": "startCloseDelay",
|
3876
|
+
"privacy": "private",
|
3877
|
+
"description": "Starts the close delay timer.\nIf the popover is not interactive, it will close the popover after the delay.",
|
2312
3878
|
"inheritedFrom": {
|
2313
|
-
"name": "
|
2314
|
-
"module": "components/
|
3879
|
+
"name": "Popover",
|
3880
|
+
"module": "components/popover/popover.component.js"
|
2315
3881
|
}
|
2316
3882
|
},
|
2317
3883
|
{
|
2318
3884
|
"kind": "field",
|
2319
|
-
"name": "
|
2320
|
-
"
|
2321
|
-
|
2322
|
-
},
|
2323
|
-
"default": "''",
|
2324
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
2325
|
-
"attribute": "name",
|
2326
|
-
"reflects": true,
|
3885
|
+
"name": "cancelCloseDelay",
|
3886
|
+
"privacy": "private",
|
3887
|
+
"description": "Cancels the close delay timer.",
|
2327
3888
|
"inheritedFrom": {
|
2328
|
-
"name": "
|
2329
|
-
"module": "
|
3889
|
+
"name": "Popover",
|
3890
|
+
"module": "components/popover/popover.component.js"
|
2330
3891
|
}
|
2331
3892
|
},
|
2332
3893
|
{
|
2333
3894
|
"kind": "field",
|
2334
|
-
"name": "
|
2335
|
-
"
|
2336
|
-
|
2337
|
-
},
|
2338
|
-
"default": "''",
|
2339
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
2340
|
-
"attribute": "value",
|
2341
|
-
"reflects": true,
|
3895
|
+
"name": "showPopover",
|
3896
|
+
"privacy": "public",
|
3897
|
+
"description": "Shows the popover.",
|
2342
3898
|
"inheritedFrom": {
|
2343
|
-
"name": "
|
2344
|
-
"module": "
|
3899
|
+
"name": "Popover",
|
3900
|
+
"module": "components/popover/popover.component.js"
|
2345
3901
|
}
|
2346
3902
|
},
|
2347
3903
|
{
|
2348
3904
|
"kind": "field",
|
2349
|
-
"name": "
|
2350
|
-
"
|
2351
|
-
|
2352
|
-
},
|
2353
|
-
"description": "Custom validation message that will override the default message and displayed when the input is invalid.",
|
2354
|
-
"attribute": "validation-message",
|
2355
|
-
"reflects": true,
|
3905
|
+
"name": "hidePopover",
|
3906
|
+
"privacy": "public",
|
3907
|
+
"description": "Hides the popover.",
|
2356
3908
|
"inheritedFrom": {
|
2357
|
-
"name": "
|
2358
|
-
"module": "
|
3909
|
+
"name": "Popover",
|
3910
|
+
"module": "components/popover/popover.component.js"
|
2359
3911
|
}
|
2360
3912
|
},
|
2361
3913
|
{
|
2362
3914
|
"kind": "field",
|
2363
|
-
"name": "
|
2364
|
-
"
|
2365
|
-
|
2366
|
-
},
|
2367
|
-
"readonly": true,
|
3915
|
+
"name": "togglePopoverVisible",
|
3916
|
+
"privacy": "public",
|
3917
|
+
"description": "Toggles the popover visibility.",
|
2368
3918
|
"inheritedFrom": {
|
2369
|
-
"name": "
|
2370
|
-
"module": "
|
3919
|
+
"name": "Popover",
|
3920
|
+
"module": "components/popover/popover.component.js"
|
2371
3921
|
}
|
2372
3922
|
},
|
2373
3923
|
{
|
2374
|
-
"kind": "
|
2375
|
-
"name": "
|
2376
|
-
"
|
3924
|
+
"kind": "method",
|
3925
|
+
"name": "handleCreatePopoverFirstUpdate",
|
3926
|
+
"privacy": "private",
|
3927
|
+
"description": "Sets the focusable elements inside the popover.",
|
2377
3928
|
"inheritedFrom": {
|
2378
|
-
"name": "
|
2379
|
-
"module": "
|
3929
|
+
"name": "Popover",
|
3930
|
+
"module": "components/popover/popover.component.js"
|
2380
3931
|
}
|
2381
3932
|
},
|
2382
3933
|
{
|
2383
3934
|
"kind": "method",
|
2384
|
-
"name": "
|
2385
|
-
"
|
2386
|
-
"
|
2387
|
-
"type": {
|
2388
|
-
"text": ""
|
2389
|
-
}
|
2390
|
-
},
|
3935
|
+
"name": "positionPopover",
|
3936
|
+
"privacy": "private",
|
3937
|
+
"description": "Positions the popover based on the trigger element.\nIt also handles the flip, size and arrow placement.\nIt uses the floating-ui/dom library to calculate the position.",
|
2391
3938
|
"inheritedFrom": {
|
2392
|
-
"name": "
|
2393
|
-
"module": "
|
3939
|
+
"name": "Popover",
|
3940
|
+
"module": "components/popover/popover.component.js"
|
2394
3941
|
}
|
2395
3942
|
},
|
2396
3943
|
{
|
2397
|
-
"kind": "
|
2398
|
-
"name": "
|
2399
|
-
"
|
2400
|
-
|
2401
|
-
|
2402
|
-
|
3944
|
+
"kind": "field",
|
3945
|
+
"name": "utils",
|
3946
|
+
"default": "new PopoverUtils(this)",
|
3947
|
+
"inheritedFrom": {
|
3948
|
+
"name": "Popover",
|
3949
|
+
"module": "components/popover/popover.component.js"
|
3950
|
+
}
|
3951
|
+
}
|
3952
|
+
],
|
3953
|
+
"attributes": [
|
3954
|
+
{
|
3955
|
+
"name": "trigger",
|
3956
|
+
"type": {
|
3957
|
+
"text": "PopoverTrigger"
|
2403
3958
|
},
|
3959
|
+
"description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
|
3960
|
+
"default": "manual",
|
3961
|
+
"fieldName": "trigger",
|
2404
3962
|
"inheritedFrom": {
|
2405
|
-
"name": "
|
2406
|
-
"module": "
|
3963
|
+
"name": "Popover",
|
3964
|
+
"module": "src/components/popover/popover.component.ts"
|
2407
3965
|
}
|
2408
3966
|
},
|
2409
3967
|
{
|
2410
|
-
"
|
2411
|
-
"
|
3968
|
+
"name": "show-arrow",
|
3969
|
+
"type": {
|
3970
|
+
"text": "boolean"
|
3971
|
+
},
|
3972
|
+
"description": "The arrow visibility of the Coachmark.",
|
3973
|
+
"default": "true",
|
3974
|
+
"fieldName": "showArrow",
|
2412
3975
|
"inheritedFrom": {
|
2413
|
-
"name": "
|
2414
|
-
"module": "
|
3976
|
+
"name": "Popover",
|
3977
|
+
"module": "src/components/popover/popover.component.ts"
|
2415
3978
|
}
|
2416
3979
|
},
|
2417
3980
|
{
|
2418
|
-
"
|
2419
|
-
"name": "id",
|
3981
|
+
"name": "close-button",
|
2420
3982
|
"type": {
|
2421
|
-
"text": "
|
3983
|
+
"text": "boolean"
|
2422
3984
|
},
|
2423
|
-
"
|
2424
|
-
"
|
2425
|
-
"
|
3985
|
+
"description": "The close button visibility of the Coachmark.",
|
3986
|
+
"default": "true",
|
3987
|
+
"fieldName": "closeButton",
|
2426
3988
|
"inheritedFrom": {
|
2427
|
-
"name": "
|
2428
|
-
"module": "components/
|
3989
|
+
"name": "Popover",
|
3990
|
+
"module": "src/components/popover/popover.component.ts"
|
2429
3991
|
}
|
2430
3992
|
},
|
2431
3993
|
{
|
2432
|
-
"
|
2433
|
-
"name": "dataAriaLabel",
|
3994
|
+
"name": "disable-aria-expanded",
|
2434
3995
|
"type": {
|
2435
|
-
"text": "
|
3996
|
+
"text": "boolean"
|
2436
3997
|
},
|
2437
|
-
"
|
2438
|
-
"
|
2439
|
-
"
|
2440
|
-
"reflects": true,
|
3998
|
+
"description": "Disable aria-expanded attribute on trigger element.",
|
3999
|
+
"default": "true",
|
4000
|
+
"fieldName": "disableAriaExpanded",
|
2441
4001
|
"inheritedFrom": {
|
2442
|
-
"name": "
|
2443
|
-
"module": "
|
4002
|
+
"name": "Popover",
|
4003
|
+
"module": "src/components/popover/popover.component.ts"
|
2444
4004
|
}
|
2445
4005
|
},
|
2446
4006
|
{
|
2447
|
-
"
|
2448
|
-
"name": "disabled",
|
4007
|
+
"name": "enabledFocusTrap",
|
2449
4008
|
"type": {
|
2450
4009
|
"text": "boolean"
|
2451
4010
|
},
|
4011
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
2452
4012
|
"default": "false",
|
2453
|
-
"
|
2454
|
-
"attribute": "disabled",
|
2455
|
-
"reflects": true,
|
4013
|
+
"fieldName": "enabledFocusTrap",
|
2456
4014
|
"inheritedFrom": {
|
2457
|
-
"name": "
|
2458
|
-
"module": "utils/mixins/
|
4015
|
+
"name": "FocusTrapMixin",
|
4016
|
+
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
2459
4017
|
}
|
2460
4018
|
},
|
2461
4019
|
{
|
2462
|
-
"
|
2463
|
-
"name": "label",
|
4020
|
+
"name": "enabledPreventScroll",
|
2464
4021
|
"type": {
|
2465
|
-
"text": "
|
4022
|
+
"text": "boolean"
|
2466
4023
|
},
|
2467
|
-
"description": "
|
2468
|
-
"
|
2469
|
-
"
|
4024
|
+
"description": "Prevent outside scrolling when popover show.",
|
4025
|
+
"default": "false",
|
4026
|
+
"fieldName": "enabledPreventScroll",
|
2470
4027
|
"inheritedFrom": {
|
2471
|
-
"name": "
|
2472
|
-
"module": "
|
4028
|
+
"name": "FocusTrapMixin",
|
4029
|
+
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
2473
4030
|
}
|
2474
4031
|
},
|
2475
4032
|
{
|
2476
|
-
"
|
2477
|
-
"name": "requiredLabel",
|
4033
|
+
"name": "id",
|
2478
4034
|
"type": {
|
2479
|
-
"text": "string
|
4035
|
+
"text": "string"
|
2480
4036
|
},
|
2481
|
-
"
|
2482
|
-
"
|
2483
|
-
"
|
4037
|
+
"default": "''",
|
4038
|
+
"description": "The unique ID of the popover.",
|
4039
|
+
"fieldName": "id",
|
2484
4040
|
"inheritedFrom": {
|
2485
|
-
"name": "
|
2486
|
-
"module": "components/
|
4041
|
+
"name": "Popover",
|
4042
|
+
"module": "src/components/popover/popover.component.ts"
|
2487
4043
|
}
|
2488
4044
|
},
|
2489
4045
|
{
|
2490
|
-
"
|
2491
|
-
"name": "helpText",
|
4046
|
+
"name": "triggerID",
|
2492
4047
|
"type": {
|
2493
|
-
"text": "string
|
4048
|
+
"text": "string"
|
2494
4049
|
},
|
2495
|
-
"
|
2496
|
-
"
|
2497
|
-
"
|
4050
|
+
"default": "''",
|
4051
|
+
"description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
|
4052
|
+
"fieldName": "triggerID",
|
2498
4053
|
"inheritedFrom": {
|
2499
|
-
"name": "
|
2500
|
-
"module": "components/
|
4054
|
+
"name": "Popover",
|
4055
|
+
"module": "src/components/popover/popover.component.ts"
|
2501
4056
|
}
|
2502
4057
|
},
|
2503
4058
|
{
|
2504
|
-
"
|
2505
|
-
"
|
2506
|
-
|
2507
|
-
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
2508
|
-
"return": {
|
2509
|
-
"type": {
|
2510
|
-
"text": ""
|
2511
|
-
}
|
4059
|
+
"name": "placement",
|
4060
|
+
"type": {
|
4061
|
+
"text": "PopoverPlacement"
|
2512
4062
|
},
|
4063
|
+
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
4064
|
+
"default": "bottom",
|
4065
|
+
"fieldName": "placement",
|
2513
4066
|
"inheritedFrom": {
|
2514
|
-
"name": "
|
2515
|
-
"module": "components/
|
4067
|
+
"name": "Popover",
|
4068
|
+
"module": "src/components/popover/popover.component.ts"
|
2516
4069
|
}
|
2517
4070
|
},
|
2518
4071
|
{
|
2519
|
-
"
|
2520
|
-
"
|
2521
|
-
|
4072
|
+
"name": "color",
|
4073
|
+
"type": {
|
4074
|
+
"text": "PopoverColor"
|
4075
|
+
},
|
4076
|
+
"description": "Color of the popover\n- **tonal**\n- **contrast**",
|
4077
|
+
"default": "tonal",
|
4078
|
+
"fieldName": "color",
|
2522
4079
|
"inheritedFrom": {
|
2523
|
-
"name": "
|
2524
|
-
"module": "components/
|
4080
|
+
"name": "Popover",
|
4081
|
+
"module": "src/components/popover/popover.component.ts"
|
2525
4082
|
}
|
2526
4083
|
},
|
2527
4084
|
{
|
2528
|
-
"
|
2529
|
-
"
|
2530
|
-
|
2531
|
-
"description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
|
2532
|
-
"return": {
|
2533
|
-
"type": {
|
2534
|
-
"text": ""
|
2535
|
-
}
|
4085
|
+
"name": "visible",
|
4086
|
+
"type": {
|
4087
|
+
"text": "boolean"
|
2536
4088
|
},
|
4089
|
+
"description": "The visibility of the popover.",
|
4090
|
+
"default": "false",
|
4091
|
+
"fieldName": "visible",
|
2537
4092
|
"inheritedFrom": {
|
2538
|
-
"name": "
|
2539
|
-
"module": "components/
|
4093
|
+
"name": "Popover",
|
4094
|
+
"module": "src/components/popover/popover.component.ts"
|
2540
4095
|
}
|
2541
4096
|
},
|
2542
4097
|
{
|
2543
|
-
"
|
2544
|
-
"
|
2545
|
-
|
2546
|
-
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
2547
|
-
"return": {
|
2548
|
-
"type": {
|
2549
|
-
"text": ""
|
2550
|
-
}
|
4098
|
+
"name": "offset",
|
4099
|
+
"type": {
|
4100
|
+
"text": "number"
|
2551
4101
|
},
|
4102
|
+
"description": "The offset of the popover.",
|
4103
|
+
"default": "4",
|
4104
|
+
"fieldName": "offset",
|
2552
4105
|
"inheritedFrom": {
|
2553
|
-
"name": "
|
2554
|
-
"module": "components/
|
4106
|
+
"name": "Popover",
|
4107
|
+
"module": "src/components/popover/popover.component.ts"
|
2555
4108
|
}
|
2556
4109
|
},
|
2557
4110
|
{
|
2558
|
-
"
|
2559
|
-
"
|
2560
|
-
|
2561
|
-
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
2562
|
-
"return": {
|
2563
|
-
"type": {
|
2564
|
-
"text": ""
|
2565
|
-
}
|
4111
|
+
"name": "focus-trap",
|
4112
|
+
"type": {
|
4113
|
+
"text": "boolean"
|
2566
4114
|
},
|
4115
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
4116
|
+
"default": "false",
|
4117
|
+
"fieldName": "focusTrap",
|
2567
4118
|
"inheritedFrom": {
|
2568
|
-
"name": "
|
2569
|
-
"module": "components/
|
4119
|
+
"name": "Popover",
|
4120
|
+
"module": "src/components/popover/popover.component.ts"
|
2570
4121
|
}
|
2571
4122
|
},
|
2572
4123
|
{
|
2573
|
-
"
|
2574
|
-
"
|
2575
|
-
|
2576
|
-
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
2577
|
-
"return": {
|
2578
|
-
"type": {
|
2579
|
-
"text": ""
|
2580
|
-
}
|
4124
|
+
"name": "prevent-scroll",
|
4125
|
+
"type": {
|
4126
|
+
"text": "boolean"
|
2581
4127
|
},
|
4128
|
+
"description": "Prevent outside scrolling when popover show.",
|
4129
|
+
"default": "false",
|
4130
|
+
"fieldName": "preventScroll",
|
2582
4131
|
"inheritedFrom": {
|
2583
|
-
"name": "
|
2584
|
-
"module": "components/
|
4132
|
+
"name": "Popover",
|
4133
|
+
"module": "src/components/popover/popover.component.ts"
|
2585
4134
|
}
|
2586
|
-
}
|
2587
|
-
],
|
2588
|
-
"events": [
|
4135
|
+
},
|
2589
4136
|
{
|
4137
|
+
"name": "interactive",
|
2590
4138
|
"type": {
|
2591
|
-
"text": "
|
4139
|
+
"text": "boolean"
|
4140
|
+
},
|
4141
|
+
"description": "Determines whether the popover is interactive。",
|
4142
|
+
"default": "false",
|
4143
|
+
"fieldName": "interactive",
|
4144
|
+
"inheritedFrom": {
|
4145
|
+
"name": "Popover",
|
4146
|
+
"module": "src/components/popover/popover.component.ts"
|
2592
4147
|
}
|
2593
4148
|
},
|
2594
4149
|
{
|
2595
|
-
"
|
2596
|
-
"name": "change",
|
2597
|
-
"reactName": "onChange",
|
2598
|
-
"eventName": "ChangeEvent"
|
2599
|
-
},
|
2600
|
-
{
|
2601
|
-
"description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
|
2602
|
-
"name": "focus",
|
2603
|
-
"reactName": "onFocus",
|
2604
|
-
"eventName": "FocusEvent"
|
2605
|
-
}
|
2606
|
-
],
|
2607
|
-
"attributes": [
|
2608
|
-
{
|
2609
|
-
"name": "checked",
|
4150
|
+
"name": "delay",
|
2610
4151
|
"type": {
|
2611
|
-
"text": "
|
4152
|
+
"text": "string"
|
2612
4153
|
},
|
2613
|
-
"
|
2614
|
-
"
|
2615
|
-
"fieldName": "
|
4154
|
+
"description": "The delay of the show/hide popover.",
|
4155
|
+
"default": "0,0",
|
4156
|
+
"fieldName": "delay",
|
4157
|
+
"inheritedFrom": {
|
4158
|
+
"name": "Popover",
|
4159
|
+
"module": "src/components/popover/popover.component.ts"
|
4160
|
+
}
|
2616
4161
|
},
|
2617
4162
|
{
|
2618
|
-
"name": "
|
4163
|
+
"name": "hide-on-escape",
|
2619
4164
|
"type": {
|
2620
4165
|
"text": "boolean"
|
2621
4166
|
},
|
4167
|
+
"description": "Hide popover on escape key press.",
|
2622
4168
|
"default": "false",
|
2623
|
-
"
|
2624
|
-
"
|
4169
|
+
"fieldName": "hideOnEscape",
|
4170
|
+
"inheritedFrom": {
|
4171
|
+
"name": "Popover",
|
4172
|
+
"module": "src/components/popover/popover.component.ts"
|
4173
|
+
}
|
2625
4174
|
},
|
2626
4175
|
{
|
2627
|
-
"name": "
|
4176
|
+
"name": "hide-on-blur",
|
2628
4177
|
"type": {
|
2629
4178
|
"text": "boolean"
|
2630
4179
|
},
|
4180
|
+
"description": "Hide popover on blur.",
|
2631
4181
|
"default": "false",
|
2632
|
-
"
|
2633
|
-
"
|
4182
|
+
"fieldName": "hideOnBlur",
|
4183
|
+
"inheritedFrom": {
|
4184
|
+
"name": "Popover",
|
4185
|
+
"module": "src/components/popover/popover.component.ts"
|
4186
|
+
}
|
2634
4187
|
},
|
2635
4188
|
{
|
2636
|
-
"name": "
|
4189
|
+
"name": "hide-on-outside-click",
|
2637
4190
|
"type": {
|
2638
|
-
"text": "
|
4191
|
+
"text": "boolean"
|
2639
4192
|
},
|
2640
|
-
"
|
2641
|
-
"
|
2642
|
-
"fieldName": "
|
4193
|
+
"description": "Hide on outside click of the popover.",
|
4194
|
+
"default": "false",
|
4195
|
+
"fieldName": "hideOnOutsideClick",
|
2643
4196
|
"inheritedFrom": {
|
2644
|
-
"name": "
|
2645
|
-
"module": "src/
|
4197
|
+
"name": "Popover",
|
4198
|
+
"module": "src/components/popover/popover.component.ts"
|
2646
4199
|
}
|
2647
4200
|
},
|
2648
4201
|
{
|
2649
|
-
"name": "
|
4202
|
+
"name": "focus-back-to-trigger",
|
2650
4203
|
"type": {
|
2651
|
-
"text": "
|
4204
|
+
"text": "boolean"
|
2652
4205
|
},
|
2653
|
-
"
|
2654
|
-
"
|
2655
|
-
"fieldName": "
|
4206
|
+
"description": "The focus back to trigger after the popover hide.",
|
4207
|
+
"default": "false",
|
4208
|
+
"fieldName": "focusBackToTrigger",
|
2656
4209
|
"inheritedFrom": {
|
2657
|
-
"name": "
|
2658
|
-
"module": "src/
|
4210
|
+
"name": "Popover",
|
4211
|
+
"module": "src/components/popover/popover.component.ts"
|
2659
4212
|
}
|
2660
4213
|
},
|
2661
4214
|
{
|
2662
|
-
"name": "
|
4215
|
+
"name": "backdrop",
|
2663
4216
|
"type": {
|
2664
|
-
"text": "
|
4217
|
+
"text": "boolean"
|
2665
4218
|
},
|
2666
|
-
"description": "
|
2667
|
-
"
|
4219
|
+
"description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
|
4220
|
+
"default": "false",
|
4221
|
+
"fieldName": "backdrop",
|
2668
4222
|
"inheritedFrom": {
|
2669
|
-
"name": "
|
2670
|
-
"module": "src/
|
4223
|
+
"name": "Popover",
|
4224
|
+
"module": "src/components/popover/popover.component.ts"
|
2671
4225
|
}
|
2672
4226
|
},
|
2673
4227
|
{
|
2674
|
-
"name": "
|
4228
|
+
"name": "flip",
|
2675
4229
|
"type": {
|
2676
|
-
"text": "
|
4230
|
+
"text": "boolean"
|
2677
4231
|
},
|
2678
|
-
"
|
2679
|
-
"
|
2680
|
-
"fieldName": "
|
4232
|
+
"description": "Changes the placement of popover to keep it in view when scrolling.",
|
4233
|
+
"default": "true",
|
4234
|
+
"fieldName": "flip",
|
2681
4235
|
"inheritedFrom": {
|
2682
|
-
"name": "
|
2683
|
-
"module": "src/
|
4236
|
+
"name": "Popover",
|
4237
|
+
"module": "src/components/popover/popover.component.ts"
|
2684
4238
|
}
|
2685
4239
|
},
|
2686
4240
|
{
|
2687
|
-
"name": "
|
4241
|
+
"name": "size",
|
2688
4242
|
"type": {
|
2689
4243
|
"text": "boolean"
|
2690
4244
|
},
|
4245
|
+
"description": "Changes the size of popover to keep it in view when scrolling.",
|
2691
4246
|
"default": "false",
|
2692
|
-
"
|
2693
|
-
"fieldName": "disabled",
|
4247
|
+
"fieldName": "size",
|
2694
4248
|
"inheritedFrom": {
|
2695
|
-
"name": "
|
2696
|
-
"module": "src/
|
4249
|
+
"name": "Popover",
|
4250
|
+
"module": "src/components/popover/popover.component.ts"
|
2697
4251
|
}
|
2698
4252
|
},
|
2699
4253
|
{
|
2700
|
-
"name": "
|
4254
|
+
"name": "z-index",
|
2701
4255
|
"type": {
|
2702
|
-
"text": "
|
4256
|
+
"text": "number"
|
2703
4257
|
},
|
2704
|
-
"description": "The
|
2705
|
-
"
|
4258
|
+
"description": "The z-index of the popover.",
|
4259
|
+
"default": "1000",
|
4260
|
+
"fieldName": "zIndex",
|
2706
4261
|
"inheritedFrom": {
|
2707
|
-
"name": "
|
2708
|
-
"module": "src/components/
|
4262
|
+
"name": "Popover",
|
4263
|
+
"module": "src/components/popover/popover.component.ts"
|
2709
4264
|
}
|
2710
4265
|
},
|
2711
4266
|
{
|
2712
|
-
"name": "
|
4267
|
+
"name": "append-to",
|
2713
4268
|
"type": {
|
2714
|
-
"text": "string
|
4269
|
+
"text": "string"
|
2715
4270
|
},
|
2716
|
-
"
|
2717
|
-
"
|
4271
|
+
"default": "''",
|
4272
|
+
"description": "Element ID that the popover append to.",
|
4273
|
+
"fieldName": "appendTo",
|
2718
4274
|
"inheritedFrom": {
|
2719
|
-
"name": "
|
2720
|
-
"module": "src/components/
|
4275
|
+
"name": "Popover",
|
4276
|
+
"module": "src/components/popover/popover.component.ts"
|
2721
4277
|
}
|
2722
4278
|
},
|
2723
4279
|
{
|
2724
|
-
"name": "
|
4280
|
+
"name": "close-button-aria-label",
|
2725
4281
|
"type": {
|
2726
|
-
"text": "string"
|
4282
|
+
"text": "string | null"
|
2727
4283
|
},
|
2728
|
-
"default": "
|
2729
|
-
"description": "
|
2730
|
-
"fieldName": "
|
4284
|
+
"default": "null",
|
4285
|
+
"description": "aria-label attribute to be set for close button accessibility.",
|
4286
|
+
"fieldName": "closeButtonAriaLabel",
|
2731
4287
|
"inheritedFrom": {
|
2732
|
-
"name": "
|
2733
|
-
"module": "src/components/
|
4288
|
+
"name": "Popover",
|
4289
|
+
"module": "src/components/popover/popover.component.ts"
|
2734
4290
|
}
|
2735
4291
|
},
|
2736
4292
|
{
|
2737
|
-
"name": "
|
4293
|
+
"name": "role",
|
2738
4294
|
"type": {
|
2739
|
-
"text": "
|
4295
|
+
"text": "HTMLElement['role']"
|
2740
4296
|
},
|
2741
|
-
"description": "
|
2742
|
-
"
|
4297
|
+
"description": "Role of the popover",
|
4298
|
+
"default": "dialog",
|
4299
|
+
"fieldName": "role",
|
2743
4300
|
"inheritedFrom": {
|
2744
|
-
"name": "
|
2745
|
-
"module": "src/components/
|
4301
|
+
"name": "Popover",
|
4302
|
+
"module": "src/components/popover/popover.component.ts"
|
2746
4303
|
}
|
2747
4304
|
},
|
2748
4305
|
{
|
2749
|
-
"name": "
|
4306
|
+
"name": "aria-labelledby",
|
2750
4307
|
"type": {
|
2751
|
-
"text": "string |
|
4308
|
+
"text": "string | null"
|
2752
4309
|
},
|
2753
|
-
"
|
2754
|
-
"
|
4310
|
+
"default": "null",
|
4311
|
+
"description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
|
4312
|
+
"fieldName": "ariaLabelledby",
|
2755
4313
|
"inheritedFrom": {
|
2756
|
-
"name": "
|
2757
|
-
"module": "src/components/
|
4314
|
+
"name": "Popover",
|
4315
|
+
"module": "src/components/popover/popover.component.ts"
|
2758
4316
|
}
|
2759
|
-
}
|
2760
|
-
],
|
2761
|
-
"mixins": [
|
2762
|
-
{
|
2763
|
-
"name": "FormInternalsMixin",
|
2764
|
-
"module": "/src/utils/mixins/FormInternalsMixin"
|
2765
4317
|
},
|
2766
4318
|
{
|
2767
|
-
"name": "
|
2768
|
-
"
|
4319
|
+
"name": "aria-describedby",
|
4320
|
+
"type": {
|
4321
|
+
"text": "string | null"
|
4322
|
+
},
|
4323
|
+
"default": "null",
|
4324
|
+
"description": "aria-describedby of the popover.",
|
4325
|
+
"fieldName": "ariaDescribedby",
|
4326
|
+
"inheritedFrom": {
|
4327
|
+
"name": "Popover",
|
4328
|
+
"module": "src/components/popover/popover.component.ts"
|
4329
|
+
}
|
2769
4330
|
}
|
2770
4331
|
],
|
2771
4332
|
"superclass": {
|
2772
|
-
"name": "
|
2773
|
-
"module": "/src/components/
|
4333
|
+
"name": "Popover",
|
4334
|
+
"module": "/src/components/popover/popover.component"
|
2774
4335
|
},
|
2775
|
-
"tagName": "mdc-
|
2776
|
-
"jsDoc": "/**\n *
|
2777
|
-
"customElement": true
|
2778
|
-
"slots": [
|
2779
|
-
{
|
2780
|
-
"description": "slot to add the label info icon",
|
2781
|
-
"name": "label-info",
|
2782
|
-
"inheritedFrom": {
|
2783
|
-
"name": "FormfieldWrapper",
|
2784
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
2785
|
-
}
|
2786
|
-
}
|
2787
|
-
]
|
4336
|
+
"tagName": "mdc-coachmark",
|
4337
|
+
"jsDoc": "/**\n * Coachmark component based on top of the popover component,\n * with the default value of certain properties changed.\n *\n * @dependency mdc-popover\n *\n * @tagname mdc-coachmark\n *\n * @cssproperty --mdc-popover-arrow-border-radius - radius of the arrow border\n * @cssproperty --mdc-popover-arrow-border - border of the arrow\n * @cssproperty --mdc-popover-primary-background-color - primary background color of the popover\n * @cssproperty --mdc-popover-border-color - border color of the popover\n * @cssproperty --mdc-popover-inverted-background-color - inverted background color of the popover\n * @cssproperty --mdc-popover-inverted-border-color - inverted border color of the popover\n * @cssproperty --mdc-popover-inverted-text-color - inverted text color of the popover\n * @cssproperty --mdc-popover-elevation-3 - elevation of the popover\n *\n * @slot - Default slot for modal container\n *\n */",
|
4338
|
+
"customElement": true
|
2788
4339
|
}
|
2789
4340
|
],
|
2790
4341
|
"exports": [
|
@@ -2792,8 +4343,8 @@
|
|
2792
4343
|
"kind": "js",
|
2793
4344
|
"name": "default",
|
2794
4345
|
"declaration": {
|
2795
|
-
"name": "
|
2796
|
-
"module": "components/
|
4346
|
+
"name": "Coachmark",
|
4347
|
+
"module": "components/coachmark/coachmark.component.js"
|
2797
4348
|
}
|
2798
4349
|
}
|
2799
4350
|
]
|