@momentum-design/components 0.127.3 → 0.127.5
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 +9 -7
- package/dist/browser/index.js.map +2 -2
- package/dist/components/banner/banner.component.d.ts +1 -0
- package/dist/components/banner/banner.component.js +6 -2
- package/dist/components/banner/banner.constants.d.ts +1 -1
- package/dist/components/banner/banner.constants.js +1 -1
- package/dist/components/banner/banner.styles.js +3 -4
- package/dist/custom-elements.json +1262 -1258
- package/dist/react/banner/index.d.ts +1 -0
- package/dist/react/banner/index.js +1 -0
- package/dist/react/index.d.ts +2 -2
- package/dist/react/index.js +2 -2
- package/package.json +1 -1
|
@@ -3292,108 +3292,53 @@
|
|
|
3292
3292
|
},
|
|
3293
3293
|
{
|
|
3294
3294
|
"kind": "javascript-module",
|
|
3295
|
-
"path": "components/
|
|
3295
|
+
"path": "components/avatar/avatar.component.js",
|
|
3296
3296
|
"declarations": [
|
|
3297
3297
|
{
|
|
3298
3298
|
"kind": "class",
|
|
3299
|
-
"description": "The `mdc-
|
|
3300
|
-
"name": "
|
|
3299
|
+
"description": "The `mdc-avatar` component is used to represent a person or a space.\nAn avatar can be an icon, initials, counter and photo.\n\nTo set the photo of an avatar,\nyou need to set \"src\" attribute.\n\nWhile the avatar image is loading, as a placeholder,\nwe will show the initials text.\nIf the initials are not specified then,\nwe will show `user-regular` icon as a placeholder.\n\nBy default, if there are no attributes specified,\nthen the default avatar will be an icon with `user-regular` name.\n\nThe avatar component is non clickable and non interactive/focusable component.\nIf the avatar is typing, then the loading indicator will be displayed.\nIf the counter type avatar is set to a negative number, then we will display 0.\nThe presence indicator will be hidden when the counter property is set.",
|
|
3300
|
+
"name": "Avatar",
|
|
3301
3301
|
"cssProperties": [
|
|
3302
3302
|
{
|
|
3303
|
-
"description": "
|
|
3304
|
-
"name": "--mdc-
|
|
3305
|
-
},
|
|
3306
|
-
{
|
|
3307
|
-
"description": "Background color of the overlay in hover state",
|
|
3308
|
-
"name": "--mdc-avatarbutton-overlay-background-color-hover"
|
|
3309
|
-
},
|
|
3310
|
-
{
|
|
3311
|
-
"description": "Background color of the overlay in active state",
|
|
3312
|
-
"name": "--mdc-avatarbutton-overlay-background-color-active"
|
|
3303
|
+
"description": "Allows customization of the default background color.",
|
|
3304
|
+
"name": "--mdc-avatar-default-background-color"
|
|
3313
3305
|
},
|
|
3314
3306
|
{
|
|
3315
|
-
"description": "
|
|
3316
|
-
"name": "--mdc-
|
|
3317
|
-
"inheritedFrom": {
|
|
3318
|
-
"name": "Buttonsimple",
|
|
3319
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3320
|
-
}
|
|
3307
|
+
"description": "Allows customization of the default foreground color.",
|
|
3308
|
+
"name": "--mdc-avatar-default-foreground-color"
|
|
3321
3309
|
},
|
|
3322
3310
|
{
|
|
3323
|
-
"description": "
|
|
3324
|
-
"name": "--mdc-
|
|
3325
|
-
"inheritedFrom": {
|
|
3326
|
-
"name": "Buttonsimple",
|
|
3327
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3328
|
-
}
|
|
3311
|
+
"description": "Allows customization of the loading indicator background color.",
|
|
3312
|
+
"name": "--mdc-avatar-loading-indicator-background-color"
|
|
3329
3313
|
},
|
|
3330
3314
|
{
|
|
3331
|
-
"description": "
|
|
3332
|
-
"name": "--mdc-
|
|
3333
|
-
"inheritedFrom": {
|
|
3334
|
-
"name": "Buttonsimple",
|
|
3335
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3336
|
-
}
|
|
3315
|
+
"description": "Allows customization of the loading indicator foreground color.",
|
|
3316
|
+
"name": "--mdc-avatar-loading-indicator-foreground-color"
|
|
3337
3317
|
},
|
|
3338
3318
|
{
|
|
3339
|
-
"description": "
|
|
3340
|
-
"name": "--mdc-
|
|
3341
|
-
"inheritedFrom": {
|
|
3342
|
-
"name": "Buttonsimple",
|
|
3343
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3344
|
-
}
|
|
3319
|
+
"description": "Allows customization of the loading overlay background color.",
|
|
3320
|
+
"name": "--mdc-avatar-loading-overlay-background-color"
|
|
3345
3321
|
}
|
|
3346
3322
|
],
|
|
3347
3323
|
"cssParts": [
|
|
3348
3324
|
{
|
|
3349
|
-
"description": "The
|
|
3350
|
-
"name": "overlay"
|
|
3351
|
-
},
|
|
3352
|
-
{
|
|
3353
|
-
"description": "The main content of the avatar.",
|
|
3354
|
-
"name": "content"
|
|
3355
|
-
},
|
|
3356
|
-
{
|
|
3357
|
-
"description": "The photo part of the avatar.",
|
|
3325
|
+
"description": "The photo of the avatar.",
|
|
3358
3326
|
"name": "photo"
|
|
3359
3327
|
},
|
|
3360
3328
|
{
|
|
3361
|
-
"description": "The presence indicator
|
|
3329
|
+
"description": "The presence indicator of the avatar.",
|
|
3362
3330
|
"name": "presence"
|
|
3363
3331
|
},
|
|
3364
3332
|
{
|
|
3365
|
-
"description": "The wrapper for the loading indicator
|
|
3333
|
+
"description": "The wrapper for the loading indicator.",
|
|
3366
3334
|
"name": "loading-wrapper"
|
|
3367
3335
|
},
|
|
3368
3336
|
{
|
|
3369
|
-
"description": "The loading indicator
|
|
3337
|
+
"description": "The loading indicator of the avatar.",
|
|
3370
3338
|
"name": "loader"
|
|
3371
3339
|
}
|
|
3372
3340
|
],
|
|
3373
3341
|
"members": [
|
|
3374
|
-
{
|
|
3375
|
-
"kind": "field",
|
|
3376
|
-
"name": "ariaLabel",
|
|
3377
|
-
"type": {
|
|
3378
|
-
"text": "string | null"
|
|
3379
|
-
},
|
|
3380
|
-
"default": "null",
|
|
3381
|
-
"description": "Aria-label attribute to be set for accessibility",
|
|
3382
|
-
"attribute": "aria-label"
|
|
3383
|
-
},
|
|
3384
|
-
{
|
|
3385
|
-
"kind": "method",
|
|
3386
|
-
"name": "setSize",
|
|
3387
|
-
"privacy": "private",
|
|
3388
|
-
"parameters": [
|
|
3389
|
-
{
|
|
3390
|
-
"name": "size",
|
|
3391
|
-
"type": {
|
|
3392
|
-
"text": "AvatarSize"
|
|
3393
|
-
}
|
|
3394
|
-
}
|
|
3395
|
-
]
|
|
3396
|
-
},
|
|
3397
3342
|
{
|
|
3398
3343
|
"kind": "field",
|
|
3399
3344
|
"name": "src",
|
|
@@ -3437,15 +3382,15 @@
|
|
|
3437
3382
|
"kind": "field",
|
|
3438
3383
|
"name": "size",
|
|
3439
3384
|
"type": {
|
|
3440
|
-
"text": "
|
|
3385
|
+
"text": "AvatarSize"
|
|
3441
3386
|
},
|
|
3442
3387
|
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
|
3443
3388
|
"default": "32",
|
|
3444
3389
|
"attribute": "size",
|
|
3445
3390
|
"reflects": true,
|
|
3446
3391
|
"inheritedFrom": {
|
|
3447
|
-
"name": "
|
|
3448
|
-
"module": "
|
|
3392
|
+
"name": "AvatarComponentMixin",
|
|
3393
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
3449
3394
|
}
|
|
3450
3395
|
},
|
|
3451
3396
|
{
|
|
@@ -3487,757 +3432,667 @@
|
|
|
3487
3432
|
"name": "IconNameMixin",
|
|
3488
3433
|
"module": "utils/mixins/IconNameMixin.js"
|
|
3489
3434
|
}
|
|
3490
|
-
}
|
|
3435
|
+
}
|
|
3436
|
+
],
|
|
3437
|
+
"mixins": [
|
|
3491
3438
|
{
|
|
3492
|
-
"
|
|
3493
|
-
"
|
|
3494
|
-
"type": {
|
|
3495
|
-
"text": "boolean"
|
|
3496
|
-
},
|
|
3497
|
-
"default": "false",
|
|
3498
|
-
"description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
|
|
3499
|
-
"attribute": "auto-focus-on-mount",
|
|
3500
|
-
"reflects": true,
|
|
3501
|
-
"inheritedFrom": {
|
|
3502
|
-
"name": "AutoFocusOnMountMixin",
|
|
3503
|
-
"module": "utils/mixins/AutoFocusOnMountMixin.js"
|
|
3504
|
-
}
|
|
3439
|
+
"name": "AvatarComponentMixin",
|
|
3440
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
|
3505
3441
|
},
|
|
3506
3442
|
{
|
|
3507
|
-
"
|
|
3508
|
-
"
|
|
3509
|
-
|
|
3510
|
-
|
|
3511
|
-
|
|
3512
|
-
|
|
3513
|
-
|
|
3514
|
-
|
|
3515
|
-
|
|
3516
|
-
|
|
3517
|
-
|
|
3518
|
-
|
|
3519
|
-
}
|
|
3520
|
-
},
|
|
3443
|
+
"name": "IconNameMixin",
|
|
3444
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
|
3445
|
+
}
|
|
3446
|
+
],
|
|
3447
|
+
"superclass": {
|
|
3448
|
+
"name": "Component",
|
|
3449
|
+
"module": "/src/models"
|
|
3450
|
+
},
|
|
3451
|
+
"tagName": "mdc-avatar",
|
|
3452
|
+
"jsDoc": "/**\n * The `mdc-avatar` component is used to represent a person or a space.\n * An avatar can be an icon, initials, counter and photo.\n *\n * To set the photo of an avatar,\n * you need to set \"src\" attribute.\n *\n * While the avatar image is loading, as a placeholder,\n * we will show the initials text.\n * If the initials are not specified then,\n * we will show `user-regular` icon as a placeholder.\n *\n * By default, if there are no attributes specified,\n * then the default avatar will be an icon with `user-regular` name.\n *\n * The avatar component is non clickable and non interactive/focusable component.\n * If the avatar is typing, then the loading indicator will be displayed.\n * If the counter type avatar is set to a negative number, then we will display 0.\n * The presence indicator will be hidden when the counter property is set.\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n *\n * @csspart photo - The photo of the avatar.\n * @csspart presence - The presence indicator of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator.\n * @csspart loader - The loading indicator of the avatar.\n */",
|
|
3453
|
+
"customElement": true,
|
|
3454
|
+
"attributes": [
|
|
3521
3455
|
{
|
|
3522
|
-
"
|
|
3523
|
-
"name": "disabled",
|
|
3456
|
+
"name": "src",
|
|
3524
3457
|
"type": {
|
|
3525
|
-
"text": "
|
|
3458
|
+
"text": "string | undefined"
|
|
3526
3459
|
},
|
|
3527
|
-
"description": "
|
|
3528
|
-
"
|
|
3529
|
-
"attribute": "disabled",
|
|
3530
|
-
"reflects": true,
|
|
3460
|
+
"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.",
|
|
3461
|
+
"fieldName": "src",
|
|
3531
3462
|
"inheritedFrom": {
|
|
3532
|
-
"name": "
|
|
3533
|
-
"module": "utils/mixins/
|
|
3463
|
+
"name": "AvatarComponentMixin",
|
|
3464
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
3534
3465
|
}
|
|
3535
3466
|
},
|
|
3536
3467
|
{
|
|
3537
|
-
"
|
|
3538
|
-
"name": "active",
|
|
3468
|
+
"name": "initials",
|
|
3539
3469
|
"type": {
|
|
3540
|
-
"text": "
|
|
3470
|
+
"text": "string | undefined"
|
|
3541
3471
|
},
|
|
3542
|
-
"description": "The
|
|
3543
|
-
"
|
|
3544
|
-
"attribute": "active",
|
|
3545
|
-
"reflects": true,
|
|
3472
|
+
"description": "The initials to be displayed for the avatar.",
|
|
3473
|
+
"fieldName": "initials",
|
|
3546
3474
|
"inheritedFrom": {
|
|
3547
|
-
"name": "
|
|
3548
|
-
"module": "
|
|
3475
|
+
"name": "AvatarComponentMixin",
|
|
3476
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
3549
3477
|
}
|
|
3550
3478
|
},
|
|
3551
3479
|
{
|
|
3552
|
-
"
|
|
3553
|
-
"name": "softDisabled",
|
|
3480
|
+
"name": "presence",
|
|
3554
3481
|
"type": {
|
|
3555
|
-
"text": "
|
|
3482
|
+
"text": "PresenceType | undefined"
|
|
3556
3483
|
},
|
|
3557
|
-
"description": "
|
|
3558
|
-
"
|
|
3559
|
-
"attribute": "soft-disabled",
|
|
3560
|
-
"reflects": true,
|
|
3484
|
+
"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`",
|
|
3485
|
+
"fieldName": "presence",
|
|
3561
3486
|
"inheritedFrom": {
|
|
3562
|
-
"name": "
|
|
3563
|
-
"module": "
|
|
3487
|
+
"name": "AvatarComponentMixin",
|
|
3488
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
3564
3489
|
}
|
|
3565
3490
|
},
|
|
3566
3491
|
{
|
|
3567
|
-
"
|
|
3568
|
-
"name": "role",
|
|
3492
|
+
"name": "size",
|
|
3569
3493
|
"type": {
|
|
3570
|
-
"text": "
|
|
3494
|
+
"text": "AvatarSize"
|
|
3571
3495
|
},
|
|
3572
|
-
"description": "
|
|
3573
|
-
"default": "
|
|
3574
|
-
"
|
|
3575
|
-
"reflects": true,
|
|
3496
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
|
3497
|
+
"default": "32",
|
|
3498
|
+
"fieldName": "size",
|
|
3576
3499
|
"inheritedFrom": {
|
|
3577
|
-
"name": "
|
|
3578
|
-
"module": "
|
|
3500
|
+
"name": "AvatarComponentMixin",
|
|
3501
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
3579
3502
|
}
|
|
3580
3503
|
},
|
|
3581
3504
|
{
|
|
3582
|
-
"
|
|
3583
|
-
"name": "ariaStateKey",
|
|
3505
|
+
"name": "counter",
|
|
3584
3506
|
"type": {
|
|
3585
|
-
"text": "
|
|
3507
|
+
"text": "number | undefined"
|
|
3586
3508
|
},
|
|
3587
|
-
"description": "
|
|
3588
|
-
"
|
|
3589
|
-
"attribute": "ariaStateKey",
|
|
3590
|
-
"reflects": true,
|
|
3509
|
+
"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`.",
|
|
3510
|
+
"fieldName": "counter",
|
|
3591
3511
|
"inheritedFrom": {
|
|
3592
|
-
"name": "
|
|
3593
|
-
"module": "
|
|
3512
|
+
"name": "AvatarComponentMixin",
|
|
3513
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
3594
3514
|
}
|
|
3595
3515
|
},
|
|
3596
3516
|
{
|
|
3597
|
-
"
|
|
3598
|
-
"name": "type",
|
|
3517
|
+
"name": "is-typing",
|
|
3599
3518
|
"type": {
|
|
3600
|
-
"text": "
|
|
3519
|
+
"text": "boolean"
|
|
3601
3520
|
},
|
|
3602
|
-
"
|
|
3603
|
-
"
|
|
3604
|
-
"
|
|
3605
|
-
"reflects": true,
|
|
3521
|
+
"default": "false",
|
|
3522
|
+
"description": "Represents the typing indicator when the user is typing.",
|
|
3523
|
+
"fieldName": "isTyping",
|
|
3606
3524
|
"inheritedFrom": {
|
|
3607
|
-
"name": "
|
|
3608
|
-
"module": "
|
|
3525
|
+
"name": "AvatarComponentMixin",
|
|
3526
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
3609
3527
|
}
|
|
3610
3528
|
},
|
|
3611
3529
|
{
|
|
3612
|
-
"
|
|
3613
|
-
"name": "name",
|
|
3530
|
+
"name": "icon-name",
|
|
3614
3531
|
"type": {
|
|
3615
|
-
"text": "
|
|
3532
|
+
"text": "IconNames | undefined"
|
|
3616
3533
|
},
|
|
3617
|
-
"description": "
|
|
3618
|
-
"
|
|
3619
|
-
"reflects": true,
|
|
3534
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
3535
|
+
"fieldName": "iconName",
|
|
3620
3536
|
"inheritedFrom": {
|
|
3621
|
-
"name": "
|
|
3622
|
-
"module": "
|
|
3537
|
+
"name": "IconNameMixin",
|
|
3538
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
|
3623
3539
|
}
|
|
3624
|
-
}
|
|
3625
|
-
|
|
3626
|
-
|
|
3627
|
-
|
|
3628
|
-
|
|
3629
|
-
|
|
3630
|
-
|
|
3631
|
-
|
|
3632
|
-
|
|
3633
|
-
|
|
3634
|
-
|
|
3635
|
-
|
|
3636
|
-
|
|
3637
|
-
|
|
3638
|
-
|
|
3639
|
-
|
|
3640
|
-
|
|
3641
|
-
|
|
3642
|
-
|
|
3643
|
-
|
|
3644
|
-
|
|
3645
|
-
|
|
3646
|
-
|
|
3647
|
-
|
|
3540
|
+
}
|
|
3541
|
+
]
|
|
3542
|
+
}
|
|
3543
|
+
],
|
|
3544
|
+
"exports": [
|
|
3545
|
+
{
|
|
3546
|
+
"kind": "js",
|
|
3547
|
+
"name": "default",
|
|
3548
|
+
"declaration": {
|
|
3549
|
+
"name": "Avatar",
|
|
3550
|
+
"module": "components/avatar/avatar.component.js"
|
|
3551
|
+
}
|
|
3552
|
+
}
|
|
3553
|
+
]
|
|
3554
|
+
},
|
|
3555
|
+
{
|
|
3556
|
+
"kind": "javascript-module",
|
|
3557
|
+
"path": "components/avatarbutton/avatarbutton.component.js",
|
|
3558
|
+
"declarations": [
|
|
3559
|
+
{
|
|
3560
|
+
"kind": "class",
|
|
3561
|
+
"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.\n\nTo override styles of the avatar inside, use the specified css parts.",
|
|
3562
|
+
"name": "AvatarButton",
|
|
3563
|
+
"cssProperties": [
|
|
3648
3564
|
{
|
|
3649
|
-
"
|
|
3650
|
-
"name": "
|
|
3651
|
-
"privacy": "protected",
|
|
3652
|
-
"parameters": [
|
|
3653
|
-
{
|
|
3654
|
-
"name": "element",
|
|
3655
|
-
"type": {
|
|
3656
|
-
"text": "HTMLElement"
|
|
3657
|
-
},
|
|
3658
|
-
"description": "The button element"
|
|
3659
|
-
},
|
|
3660
|
-
{
|
|
3661
|
-
"name": "active",
|
|
3662
|
-
"optional": true,
|
|
3663
|
-
"type": {
|
|
3664
|
-
"text": "boolean"
|
|
3665
|
-
},
|
|
3666
|
-
"description": "The active state of the element"
|
|
3667
|
-
}
|
|
3668
|
-
],
|
|
3669
|
-
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
|
3670
|
-
"inheritedFrom": {
|
|
3671
|
-
"name": "Buttonsimple",
|
|
3672
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3673
|
-
}
|
|
3565
|
+
"description": "Background color of the overlay in rest state",
|
|
3566
|
+
"name": "--mdc-avatarbutton-overlay-background-color-rest"
|
|
3674
3567
|
},
|
|
3675
3568
|
{
|
|
3676
|
-
"
|
|
3677
|
-
"name": "
|
|
3678
|
-
"privacy": "private",
|
|
3679
|
-
"parameters": [
|
|
3680
|
-
{
|
|
3681
|
-
"name": "element",
|
|
3682
|
-
"type": {
|
|
3683
|
-
"text": "HTMLElement"
|
|
3684
|
-
},
|
|
3685
|
-
"description": "The button element."
|
|
3686
|
-
},
|
|
3687
|
-
{
|
|
3688
|
-
"name": "softDisabled",
|
|
3689
|
-
"optional": true,
|
|
3690
|
-
"type": {
|
|
3691
|
-
"text": "boolean"
|
|
3692
|
-
},
|
|
3693
|
-
"description": "The soft-disabled state."
|
|
3694
|
-
}
|
|
3695
|
-
],
|
|
3696
|
-
"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.",
|
|
3697
|
-
"inheritedFrom": {
|
|
3698
|
-
"name": "Buttonsimple",
|
|
3699
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3700
|
-
}
|
|
3569
|
+
"description": "Background color of the overlay in hover state",
|
|
3570
|
+
"name": "--mdc-avatarbutton-overlay-background-color-hover"
|
|
3701
3571
|
},
|
|
3702
3572
|
{
|
|
3703
|
-
"
|
|
3704
|
-
"name": "
|
|
3705
|
-
"privacy": "private",
|
|
3706
|
-
"parameters": [
|
|
3707
|
-
{
|
|
3708
|
-
"name": "element",
|
|
3709
|
-
"type": {
|
|
3710
|
-
"text": "HTMLElement"
|
|
3711
|
-
},
|
|
3712
|
-
"description": "The button element."
|
|
3713
|
-
},
|
|
3714
|
-
{
|
|
3715
|
-
"name": "disabled",
|
|
3716
|
-
"type": {
|
|
3717
|
-
"text": "boolean"
|
|
3718
|
-
},
|
|
3719
|
-
"description": "The disabled state."
|
|
3720
|
-
}
|
|
3721
|
-
],
|
|
3722
|
-
"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.",
|
|
3723
|
-
"inheritedFrom": {
|
|
3724
|
-
"name": "Buttonsimple",
|
|
3725
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3726
|
-
}
|
|
3573
|
+
"description": "Background color of the overlay in active state",
|
|
3574
|
+
"name": "--mdc-avatarbutton-overlay-background-color-active"
|
|
3727
3575
|
},
|
|
3728
3576
|
{
|
|
3729
|
-
"
|
|
3730
|
-
"name": "
|
|
3731
|
-
"privacy": "private",
|
|
3577
|
+
"description": "Height for button size",
|
|
3578
|
+
"name": "--mdc-button-height",
|
|
3732
3579
|
"inheritedFrom": {
|
|
3733
3580
|
"name": "Buttonsimple",
|
|
3734
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
|
3581
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3735
3582
|
}
|
|
3736
3583
|
},
|
|
3737
3584
|
{
|
|
3738
|
-
"
|
|
3739
|
-
"name": "
|
|
3740
|
-
"privacy": "private",
|
|
3741
|
-
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
|
3585
|
+
"description": "Background color of the button",
|
|
3586
|
+
"name": "--mdc-button-background",
|
|
3742
3587
|
"inheritedFrom": {
|
|
3743
3588
|
"name": "Buttonsimple",
|
|
3744
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
|
3589
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3745
3590
|
}
|
|
3746
3591
|
},
|
|
3747
3592
|
{
|
|
3748
|
-
"
|
|
3749
|
-
"name": "
|
|
3750
|
-
"privacy": "private",
|
|
3751
|
-
"parameters": [
|
|
3752
|
-
{
|
|
3753
|
-
"name": "event",
|
|
3754
|
-
"type": {
|
|
3755
|
-
"text": "KeyboardEvent"
|
|
3756
|
-
},
|
|
3757
|
-
"description": "The keyboard event."
|
|
3758
|
-
}
|
|
3759
|
-
],
|
|
3760
|
-
"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.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
|
|
3593
|
+
"description": "Borer color of the button",
|
|
3594
|
+
"name": "--mdc-button-border-color",
|
|
3761
3595
|
"inheritedFrom": {
|
|
3762
3596
|
"name": "Buttonsimple",
|
|
3763
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
|
3597
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3764
3598
|
}
|
|
3765
3599
|
},
|
|
3766
3600
|
{
|
|
3767
|
-
"
|
|
3768
|
-
"name": "
|
|
3769
|
-
"privacy": "private",
|
|
3770
|
-
"parameters": [
|
|
3771
|
-
{
|
|
3772
|
-
"name": "event",
|
|
3773
|
-
"type": {
|
|
3774
|
-
"text": "KeyboardEvent"
|
|
3775
|
-
},
|
|
3776
|
-
"description": "The keyboard event."
|
|
3777
|
-
}
|
|
3778
|
-
],
|
|
3779
|
-
"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.",
|
|
3601
|
+
"description": "Text color of the button",
|
|
3602
|
+
"name": "--mdc-button-text-color",
|
|
3780
3603
|
"inheritedFrom": {
|
|
3781
3604
|
"name": "Buttonsimple",
|
|
3782
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
|
3605
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3783
3606
|
}
|
|
3784
3607
|
}
|
|
3785
3608
|
],
|
|
3786
|
-
"
|
|
3609
|
+
"cssParts": [
|
|
3787
3610
|
{
|
|
3788
|
-
"description": "
|
|
3789
|
-
"name": "
|
|
3790
|
-
"reactName": "onClick",
|
|
3791
|
-
"inheritedFrom": {
|
|
3792
|
-
"name": "Buttonsimple",
|
|
3793
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3794
|
-
}
|
|
3611
|
+
"description": "The overlay part of the avatar button.",
|
|
3612
|
+
"name": "overlay"
|
|
3795
3613
|
},
|
|
3796
3614
|
{
|
|
3797
|
-
"description": "
|
|
3798
|
-
"name": "
|
|
3799
|
-
"reactName": "onKeyDown",
|
|
3800
|
-
"inheritedFrom": {
|
|
3801
|
-
"name": "Buttonsimple",
|
|
3802
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3803
|
-
}
|
|
3615
|
+
"description": "The main content of the avatar.",
|
|
3616
|
+
"name": "content"
|
|
3804
3617
|
},
|
|
3805
3618
|
{
|
|
3806
|
-
"description": "
|
|
3807
|
-
"name": "
|
|
3808
|
-
"reactName": "onKeyUp",
|
|
3809
|
-
"inheritedFrom": {
|
|
3810
|
-
"name": "Buttonsimple",
|
|
3811
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3812
|
-
}
|
|
3619
|
+
"description": "The photo part of the avatar.",
|
|
3620
|
+
"name": "photo"
|
|
3813
3621
|
},
|
|
3814
3622
|
{
|
|
3815
|
-
"description": "
|
|
3816
|
-
"name": "
|
|
3817
|
-
|
|
3818
|
-
|
|
3819
|
-
|
|
3820
|
-
|
|
3821
|
-
|
|
3623
|
+
"description": "The presence indicator part of the avatar.",
|
|
3624
|
+
"name": "presence"
|
|
3625
|
+
},
|
|
3626
|
+
{
|
|
3627
|
+
"description": "The wrapper for the loading indicator of the avatar.",
|
|
3628
|
+
"name": "loading-wrapper"
|
|
3629
|
+
},
|
|
3630
|
+
{
|
|
3631
|
+
"description": "The loading indicator part of the avatar.",
|
|
3632
|
+
"name": "loader"
|
|
3822
3633
|
}
|
|
3823
3634
|
],
|
|
3824
|
-
"
|
|
3635
|
+
"members": [
|
|
3825
3636
|
{
|
|
3826
|
-
"
|
|
3637
|
+
"kind": "field",
|
|
3638
|
+
"name": "ariaLabel",
|
|
3827
3639
|
"type": {
|
|
3828
3640
|
"text": "string | null"
|
|
3829
3641
|
},
|
|
3830
3642
|
"default": "null",
|
|
3831
3643
|
"description": "Aria-label attribute to be set for accessibility",
|
|
3832
|
-
"
|
|
3644
|
+
"attribute": "aria-label"
|
|
3645
|
+
},
|
|
3646
|
+
{
|
|
3647
|
+
"kind": "method",
|
|
3648
|
+
"name": "setSize",
|
|
3649
|
+
"privacy": "private",
|
|
3650
|
+
"parameters": [
|
|
3651
|
+
{
|
|
3652
|
+
"name": "size",
|
|
3653
|
+
"type": {
|
|
3654
|
+
"text": "AvatarSize"
|
|
3655
|
+
}
|
|
3656
|
+
}
|
|
3657
|
+
]
|
|
3833
3658
|
},
|
|
3834
3659
|
{
|
|
3660
|
+
"kind": "field",
|
|
3835
3661
|
"name": "src",
|
|
3836
3662
|
"type": {
|
|
3837
3663
|
"text": "string | undefined"
|
|
3838
3664
|
},
|
|
3839
3665
|
"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.",
|
|
3840
|
-
"
|
|
3666
|
+
"attribute": "src",
|
|
3841
3667
|
"inheritedFrom": {
|
|
3842
3668
|
"name": "AvatarComponentMixin",
|
|
3843
|
-
"module": "
|
|
3669
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
3844
3670
|
}
|
|
3845
3671
|
},
|
|
3846
3672
|
{
|
|
3673
|
+
"kind": "field",
|
|
3847
3674
|
"name": "initials",
|
|
3848
3675
|
"type": {
|
|
3849
3676
|
"text": "string | undefined"
|
|
3850
3677
|
},
|
|
3851
3678
|
"description": "The initials to be displayed for the avatar.",
|
|
3852
|
-
"
|
|
3679
|
+
"attribute": "initials",
|
|
3853
3680
|
"inheritedFrom": {
|
|
3854
3681
|
"name": "AvatarComponentMixin",
|
|
3855
|
-
"module": "
|
|
3682
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
3856
3683
|
}
|
|
3857
3684
|
},
|
|
3858
3685
|
{
|
|
3686
|
+
"kind": "field",
|
|
3859
3687
|
"name": "presence",
|
|
3860
3688
|
"type": {
|
|
3861
3689
|
"text": "PresenceType | undefined"
|
|
3862
3690
|
},
|
|
3863
3691
|
"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`",
|
|
3864
|
-
"
|
|
3692
|
+
"attribute": "presence",
|
|
3865
3693
|
"inheritedFrom": {
|
|
3866
3694
|
"name": "AvatarComponentMixin",
|
|
3867
|
-
"module": "
|
|
3695
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
3868
3696
|
}
|
|
3869
3697
|
},
|
|
3870
3698
|
{
|
|
3699
|
+
"kind": "field",
|
|
3871
3700
|
"name": "size",
|
|
3872
3701
|
"type": {
|
|
3873
3702
|
"text": "ButtonSize"
|
|
3874
3703
|
},
|
|
3875
3704
|
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
|
3876
3705
|
"default": "32",
|
|
3877
|
-
"
|
|
3706
|
+
"attribute": "size",
|
|
3707
|
+
"reflects": true,
|
|
3878
3708
|
"inheritedFrom": {
|
|
3879
3709
|
"name": "Buttonsimple",
|
|
3880
|
-
"module": "
|
|
3710
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3881
3711
|
}
|
|
3882
3712
|
},
|
|
3883
3713
|
{
|
|
3714
|
+
"kind": "field",
|
|
3884
3715
|
"name": "counter",
|
|
3885
3716
|
"type": {
|
|
3886
3717
|
"text": "number | undefined"
|
|
3887
3718
|
},
|
|
3888
3719
|
"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`.",
|
|
3889
|
-
"
|
|
3720
|
+
"attribute": "counter",
|
|
3890
3721
|
"inheritedFrom": {
|
|
3891
3722
|
"name": "AvatarComponentMixin",
|
|
3892
|
-
"module": "
|
|
3723
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
3893
3724
|
}
|
|
3894
3725
|
},
|
|
3895
3726
|
{
|
|
3896
|
-
"
|
|
3727
|
+
"kind": "field",
|
|
3728
|
+
"name": "isTyping",
|
|
3897
3729
|
"type": {
|
|
3898
3730
|
"text": "boolean"
|
|
3899
3731
|
},
|
|
3900
3732
|
"default": "false",
|
|
3901
3733
|
"description": "Represents the typing indicator when the user is typing.",
|
|
3902
|
-
"
|
|
3734
|
+
"attribute": "is-typing",
|
|
3903
3735
|
"inheritedFrom": {
|
|
3904
3736
|
"name": "AvatarComponentMixin",
|
|
3905
|
-
"module": "
|
|
3737
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
3906
3738
|
}
|
|
3907
3739
|
},
|
|
3908
3740
|
{
|
|
3909
|
-
"
|
|
3741
|
+
"kind": "field",
|
|
3742
|
+
"name": "iconName",
|
|
3910
3743
|
"type": {
|
|
3911
3744
|
"text": "IconNames | undefined"
|
|
3912
3745
|
},
|
|
3913
3746
|
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
3914
|
-
"
|
|
3747
|
+
"attribute": "icon-name",
|
|
3915
3748
|
"inheritedFrom": {
|
|
3916
3749
|
"name": "IconNameMixin",
|
|
3917
|
-
"module": "
|
|
3750
|
+
"module": "utils/mixins/IconNameMixin.js"
|
|
3918
3751
|
}
|
|
3919
3752
|
},
|
|
3920
3753
|
{
|
|
3921
|
-
"
|
|
3754
|
+
"kind": "field",
|
|
3755
|
+
"name": "autoFocusOnMount",
|
|
3922
3756
|
"type": {
|
|
3923
3757
|
"text": "boolean"
|
|
3924
3758
|
},
|
|
3925
3759
|
"default": "false",
|
|
3926
3760
|
"description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
|
|
3927
|
-
"
|
|
3761
|
+
"attribute": "auto-focus-on-mount",
|
|
3762
|
+
"reflects": true,
|
|
3928
3763
|
"inheritedFrom": {
|
|
3929
3764
|
"name": "AutoFocusOnMountMixin",
|
|
3930
|
-
"module": "
|
|
3765
|
+
"module": "utils/mixins/AutoFocusOnMountMixin.js"
|
|
3931
3766
|
}
|
|
3932
3767
|
},
|
|
3933
3768
|
{
|
|
3769
|
+
"kind": "field",
|
|
3934
3770
|
"name": "tabIndex",
|
|
3935
3771
|
"type": {
|
|
3936
3772
|
"text": "number"
|
|
3937
3773
|
},
|
|
3938
3774
|
"default": "0",
|
|
3939
3775
|
"description": "This property specifies the tab order of the element.",
|
|
3940
|
-
"
|
|
3776
|
+
"attribute": "tabIndex",
|
|
3777
|
+
"reflects": true,
|
|
3941
3778
|
"inheritedFrom": {
|
|
3942
3779
|
"name": "TabIndexMixin",
|
|
3943
|
-
"module": "
|
|
3780
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
|
3944
3781
|
}
|
|
3945
3782
|
},
|
|
3946
3783
|
{
|
|
3784
|
+
"kind": "field",
|
|
3947
3785
|
"name": "disabled",
|
|
3948
3786
|
"type": {
|
|
3949
3787
|
"text": "boolean | undefined"
|
|
3950
3788
|
},
|
|
3951
3789
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
3952
3790
|
"default": "undefined",
|
|
3953
|
-
"
|
|
3791
|
+
"attribute": "disabled",
|
|
3792
|
+
"reflects": true,
|
|
3954
3793
|
"inheritedFrom": {
|
|
3955
3794
|
"name": "DisabledMixin",
|
|
3956
|
-
"module": "
|
|
3795
|
+
"module": "utils/mixins/DisabledMixin.js"
|
|
3957
3796
|
}
|
|
3958
3797
|
},
|
|
3959
3798
|
{
|
|
3799
|
+
"kind": "field",
|
|
3960
3800
|
"name": "active",
|
|
3961
3801
|
"type": {
|
|
3962
3802
|
"text": "boolean | undefined"
|
|
3963
3803
|
},
|
|
3964
3804
|
"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.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
|
3965
3805
|
"default": "undefined",
|
|
3966
|
-
"
|
|
3806
|
+
"attribute": "active",
|
|
3807
|
+
"reflects": true,
|
|
3967
3808
|
"inheritedFrom": {
|
|
3968
3809
|
"name": "Buttonsimple",
|
|
3969
|
-
"module": "
|
|
3810
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3970
3811
|
}
|
|
3971
3812
|
},
|
|
3972
3813
|
{
|
|
3973
|
-
"
|
|
3814
|
+
"kind": "field",
|
|
3815
|
+
"name": "softDisabled",
|
|
3974
3816
|
"type": {
|
|
3975
3817
|
"text": "boolean | undefined"
|
|
3976
3818
|
},
|
|
3977
3819
|
"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.",
|
|
3978
3820
|
"default": "undefined",
|
|
3979
|
-
"
|
|
3821
|
+
"attribute": "soft-disabled",
|
|
3822
|
+
"reflects": true,
|
|
3980
3823
|
"inheritedFrom": {
|
|
3981
3824
|
"name": "Buttonsimple",
|
|
3982
|
-
"module": "
|
|
3825
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3983
3826
|
}
|
|
3984
3827
|
},
|
|
3985
3828
|
{
|
|
3829
|
+
"kind": "field",
|
|
3986
3830
|
"name": "role",
|
|
3987
3831
|
"type": {
|
|
3988
3832
|
"text": "RoleType"
|
|
3989
3833
|
},
|
|
3990
3834
|
"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.",
|
|
3991
3835
|
"default": "button",
|
|
3992
|
-
"
|
|
3836
|
+
"attribute": "role",
|
|
3837
|
+
"reflects": true,
|
|
3993
3838
|
"inheritedFrom": {
|
|
3994
3839
|
"name": "Buttonsimple",
|
|
3995
|
-
"module": "
|
|
3840
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3996
3841
|
}
|
|
3997
3842
|
},
|
|
3998
3843
|
{
|
|
3844
|
+
"kind": "field",
|
|
3999
3845
|
"name": "ariaStateKey",
|
|
4000
3846
|
"type": {
|
|
4001
3847
|
"text": "string | undefined"
|
|
4002
3848
|
},
|
|
4003
3849
|
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
|
4004
3850
|
"default": "'aria-pressed' (when)",
|
|
4005
|
-
"
|
|
3851
|
+
"attribute": "ariaStateKey",
|
|
3852
|
+
"reflects": true,
|
|
4006
3853
|
"inheritedFrom": {
|
|
4007
3854
|
"name": "Buttonsimple",
|
|
4008
|
-
"module": "
|
|
3855
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
4009
3856
|
}
|
|
4010
3857
|
},
|
|
4011
3858
|
{
|
|
3859
|
+
"kind": "field",
|
|
4012
3860
|
"name": "type",
|
|
4013
3861
|
"type": {
|
|
4014
3862
|
"text": "ButtonType"
|
|
4015
3863
|
},
|
|
4016
3864
|
"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.",
|
|
4017
3865
|
"default": "button",
|
|
4018
|
-
"
|
|
3866
|
+
"attribute": "type",
|
|
3867
|
+
"reflects": true,
|
|
4019
3868
|
"inheritedFrom": {
|
|
4020
3869
|
"name": "Buttonsimple",
|
|
4021
|
-
"module": "
|
|
3870
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
4022
3871
|
}
|
|
4023
3872
|
},
|
|
4024
3873
|
{
|
|
3874
|
+
"kind": "field",
|
|
4025
3875
|
"name": "name",
|
|
4026
3876
|
"type": {
|
|
4027
3877
|
"text": "string | undefined"
|
|
4028
3878
|
},
|
|
4029
3879
|
"description": "The name of the button, submitted as a pair with the button's value as part of the form data,\nwhen that button is used to submit the form.",
|
|
4030
|
-
"
|
|
3880
|
+
"attribute": "name",
|
|
3881
|
+
"reflects": true,
|
|
4031
3882
|
"inheritedFrom": {
|
|
4032
3883
|
"name": "Buttonsimple",
|
|
4033
|
-
"module": "
|
|
3884
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
4034
3885
|
}
|
|
4035
3886
|
},
|
|
4036
3887
|
{
|
|
3888
|
+
"kind": "field",
|
|
4037
3889
|
"name": "value",
|
|
4038
3890
|
"type": {
|
|
4039
3891
|
"text": "string | undefined"
|
|
4040
3892
|
},
|
|
4041
3893
|
"description": "Defines the value associated with the button's name when it's submitted with the form data.\nThis value is passed to the server in params when the form is submitted using this button.",
|
|
4042
|
-
"
|
|
3894
|
+
"attribute": "value",
|
|
3895
|
+
"reflects": true,
|
|
4043
3896
|
"inheritedFrom": {
|
|
4044
3897
|
"name": "Buttonsimple",
|
|
4045
|
-
"module": "
|
|
3898
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
4046
3899
|
}
|
|
4047
|
-
}
|
|
4048
|
-
],
|
|
4049
|
-
"mixins": [
|
|
4050
|
-
{
|
|
4051
|
-
"name": "AvatarComponentMixin",
|
|
4052
|
-
"module": "/src/utils/mixins/AvatarComponentMixin"
|
|
4053
|
-
},
|
|
4054
|
-
{
|
|
4055
|
-
"name": "IconNameMixin",
|
|
4056
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
|
4057
|
-
}
|
|
4058
|
-
],
|
|
4059
|
-
"superclass": {
|
|
4060
|
-
"name": "Buttonsimple",
|
|
4061
|
-
"module": "/src/components/buttonsimple/buttonsimple.component"
|
|
4062
|
-
},
|
|
4063
|
-
"tagName": "mdc-avatarbutton",
|
|
4064
|
-
"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 * To override styles of the avatar inside, use the specified css parts.\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 *\n * @cssproperty --mdc-avatarbutton-overlay-background-color-rest - Background color of the overlay in rest state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-hover - Background color of the overlay in hover state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-active - Background color of the overlay in active state\n *\n * @csspart overlay - The overlay part of the avatar button.\n * @csspart content - The main content of the avatar.\n * @csspart photo - The photo part of the avatar.\n * @csspart presence - The presence indicator part of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator of the avatar.\n * @csspart loader - The loading indicator part of the avatar.\n */",
|
|
4065
|
-
"customElement": true
|
|
4066
|
-
}
|
|
4067
|
-
],
|
|
4068
|
-
"exports": [
|
|
4069
|
-
{
|
|
4070
|
-
"kind": "js",
|
|
4071
|
-
"name": "default",
|
|
4072
|
-
"declaration": {
|
|
4073
|
-
"name": "AvatarButton",
|
|
4074
|
-
"module": "components/avatarbutton/avatarbutton.component.js"
|
|
4075
|
-
}
|
|
4076
|
-
}
|
|
4077
|
-
]
|
|
4078
|
-
},
|
|
4079
|
-
{
|
|
4080
|
-
"kind": "javascript-module",
|
|
4081
|
-
"path": "components/avatar/avatar.component.js",
|
|
4082
|
-
"declarations": [
|
|
4083
|
-
{
|
|
4084
|
-
"kind": "class",
|
|
4085
|
-
"description": "The `mdc-avatar` component is used to represent a person or a space.\nAn avatar can be an icon, initials, counter and photo.\n\nTo set the photo of an avatar,\nyou need to set \"src\" attribute.\n\nWhile the avatar image is loading, as a placeholder,\nwe will show the initials text.\nIf the initials are not specified then,\nwe will show `user-regular` icon as a placeholder.\n\nBy default, if there are no attributes specified,\nthen the default avatar will be an icon with `user-regular` name.\n\nThe avatar component is non clickable and non interactive/focusable component.\nIf the avatar is typing, then the loading indicator will be displayed.\nIf the counter type avatar is set to a negative number, then we will display 0.\nThe presence indicator will be hidden when the counter property is set.",
|
|
4086
|
-
"name": "Avatar",
|
|
4087
|
-
"cssProperties": [
|
|
4088
|
-
{
|
|
4089
|
-
"description": "Allows customization of the default background color.",
|
|
4090
|
-
"name": "--mdc-avatar-default-background-color"
|
|
4091
|
-
},
|
|
4092
|
-
{
|
|
4093
|
-
"description": "Allows customization of the default foreground color.",
|
|
4094
|
-
"name": "--mdc-avatar-default-foreground-color"
|
|
4095
3900
|
},
|
|
4096
3901
|
{
|
|
4097
|
-
"
|
|
4098
|
-
"name": "
|
|
3902
|
+
"kind": "method",
|
|
3903
|
+
"name": "executeAction",
|
|
3904
|
+
"privacy": "protected",
|
|
3905
|
+
"inheritedFrom": {
|
|
3906
|
+
"name": "Buttonsimple",
|
|
3907
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3908
|
+
}
|
|
4099
3909
|
},
|
|
4100
3910
|
{
|
|
4101
|
-
"
|
|
4102
|
-
"name": "
|
|
3911
|
+
"kind": "method",
|
|
3912
|
+
"name": "setActive",
|
|
3913
|
+
"privacy": "protected",
|
|
3914
|
+
"parameters": [
|
|
3915
|
+
{
|
|
3916
|
+
"name": "element",
|
|
3917
|
+
"type": {
|
|
3918
|
+
"text": "HTMLElement"
|
|
3919
|
+
},
|
|
3920
|
+
"description": "The button element"
|
|
3921
|
+
},
|
|
3922
|
+
{
|
|
3923
|
+
"name": "active",
|
|
3924
|
+
"optional": true,
|
|
3925
|
+
"type": {
|
|
3926
|
+
"text": "boolean"
|
|
3927
|
+
},
|
|
3928
|
+
"description": "The active state of the element"
|
|
3929
|
+
}
|
|
3930
|
+
],
|
|
3931
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
|
3932
|
+
"inheritedFrom": {
|
|
3933
|
+
"name": "Buttonsimple",
|
|
3934
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3935
|
+
}
|
|
4103
3936
|
},
|
|
4104
3937
|
{
|
|
4105
|
-
"
|
|
4106
|
-
"name": "
|
|
4107
|
-
|
|
4108
|
-
|
|
4109
|
-
|
|
4110
|
-
|
|
4111
|
-
|
|
4112
|
-
|
|
3938
|
+
"kind": "method",
|
|
3939
|
+
"name": "setSoftDisabled",
|
|
3940
|
+
"privacy": "private",
|
|
3941
|
+
"parameters": [
|
|
3942
|
+
{
|
|
3943
|
+
"name": "element",
|
|
3944
|
+
"type": {
|
|
3945
|
+
"text": "HTMLElement"
|
|
3946
|
+
},
|
|
3947
|
+
"description": "The button element."
|
|
3948
|
+
},
|
|
3949
|
+
{
|
|
3950
|
+
"name": "softDisabled",
|
|
3951
|
+
"optional": true,
|
|
3952
|
+
"type": {
|
|
3953
|
+
"text": "boolean"
|
|
3954
|
+
},
|
|
3955
|
+
"description": "The soft-disabled state."
|
|
3956
|
+
}
|
|
3957
|
+
],
|
|
3958
|
+
"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.",
|
|
3959
|
+
"inheritedFrom": {
|
|
3960
|
+
"name": "Buttonsimple",
|
|
3961
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3962
|
+
}
|
|
4113
3963
|
},
|
|
4114
3964
|
{
|
|
4115
|
-
"
|
|
4116
|
-
"name": "
|
|
3965
|
+
"kind": "method",
|
|
3966
|
+
"name": "setDisabled",
|
|
3967
|
+
"privacy": "private",
|
|
3968
|
+
"parameters": [
|
|
3969
|
+
{
|
|
3970
|
+
"name": "element",
|
|
3971
|
+
"type": {
|
|
3972
|
+
"text": "HTMLElement"
|
|
3973
|
+
},
|
|
3974
|
+
"description": "The button element."
|
|
3975
|
+
},
|
|
3976
|
+
{
|
|
3977
|
+
"name": "disabled",
|
|
3978
|
+
"type": {
|
|
3979
|
+
"text": "boolean"
|
|
3980
|
+
},
|
|
3981
|
+
"description": "The disabled state."
|
|
3982
|
+
}
|
|
3983
|
+
],
|
|
3984
|
+
"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.",
|
|
3985
|
+
"inheritedFrom": {
|
|
3986
|
+
"name": "Buttonsimple",
|
|
3987
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3988
|
+
}
|
|
4117
3989
|
},
|
|
4118
3990
|
{
|
|
4119
|
-
"
|
|
4120
|
-
"name": "
|
|
3991
|
+
"kind": "method",
|
|
3992
|
+
"name": "triggerClickEvent",
|
|
3993
|
+
"privacy": "private",
|
|
3994
|
+
"inheritedFrom": {
|
|
3995
|
+
"name": "Buttonsimple",
|
|
3996
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3997
|
+
}
|
|
4121
3998
|
},
|
|
4122
3999
|
{
|
|
4123
|
-
"
|
|
4124
|
-
"name": "
|
|
4125
|
-
|
|
4126
|
-
|
|
4127
|
-
"members": [
|
|
4128
|
-
{
|
|
4129
|
-
"kind": "field",
|
|
4130
|
-
"name": "src",
|
|
4131
|
-
"type": {
|
|
4132
|
-
"text": "string | undefined"
|
|
4133
|
-
},
|
|
4134
|
-
"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.",
|
|
4135
|
-
"attribute": "src",
|
|
4000
|
+
"kind": "method",
|
|
4001
|
+
"name": "handleBlur",
|
|
4002
|
+
"privacy": "private",
|
|
4003
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
|
4136
4004
|
"inheritedFrom": {
|
|
4137
|
-
"name": "
|
|
4138
|
-
"module": "
|
|
4005
|
+
"name": "Buttonsimple",
|
|
4006
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
4139
4007
|
}
|
|
4140
4008
|
},
|
|
4141
4009
|
{
|
|
4142
|
-
"kind": "
|
|
4143
|
-
"name": "
|
|
4144
|
-
"
|
|
4145
|
-
|
|
4146
|
-
|
|
4147
|
-
|
|
4148
|
-
|
|
4010
|
+
"kind": "method",
|
|
4011
|
+
"name": "handleKeyDown",
|
|
4012
|
+
"privacy": "private",
|
|
4013
|
+
"parameters": [
|
|
4014
|
+
{
|
|
4015
|
+
"name": "event",
|
|
4016
|
+
"type": {
|
|
4017
|
+
"text": "KeyboardEvent"
|
|
4018
|
+
},
|
|
4019
|
+
"description": "The keyboard event."
|
|
4020
|
+
}
|
|
4021
|
+
],
|
|
4022
|
+
"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.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
|
|
4149
4023
|
"inheritedFrom": {
|
|
4150
|
-
"name": "
|
|
4151
|
-
"module": "
|
|
4024
|
+
"name": "Buttonsimple",
|
|
4025
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
4152
4026
|
}
|
|
4153
4027
|
},
|
|
4154
4028
|
{
|
|
4155
|
-
"kind": "
|
|
4156
|
-
"name": "
|
|
4157
|
-
"
|
|
4158
|
-
|
|
4159
|
-
|
|
4160
|
-
|
|
4161
|
-
|
|
4029
|
+
"kind": "method",
|
|
4030
|
+
"name": "handleKeyUp",
|
|
4031
|
+
"privacy": "private",
|
|
4032
|
+
"parameters": [
|
|
4033
|
+
{
|
|
4034
|
+
"name": "event",
|
|
4035
|
+
"type": {
|
|
4036
|
+
"text": "KeyboardEvent"
|
|
4037
|
+
},
|
|
4038
|
+
"description": "The keyboard event."
|
|
4039
|
+
}
|
|
4040
|
+
],
|
|
4041
|
+
"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.",
|
|
4162
4042
|
"inheritedFrom": {
|
|
4163
|
-
"name": "
|
|
4164
|
-
"module": "
|
|
4043
|
+
"name": "Buttonsimple",
|
|
4044
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
4165
4045
|
}
|
|
4166
|
-
}
|
|
4046
|
+
}
|
|
4047
|
+
],
|
|
4048
|
+
"events": [
|
|
4167
4049
|
{
|
|
4168
|
-
"
|
|
4169
|
-
"name": "
|
|
4170
|
-
"
|
|
4171
|
-
"text": "AvatarSize"
|
|
4172
|
-
},
|
|
4173
|
-
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
|
4174
|
-
"default": "32",
|
|
4175
|
-
"attribute": "size",
|
|
4176
|
-
"reflects": true,
|
|
4050
|
+
"description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
|
|
4051
|
+
"name": "click",
|
|
4052
|
+
"reactName": "onClick",
|
|
4177
4053
|
"inheritedFrom": {
|
|
4178
|
-
"name": "
|
|
4179
|
-
"module": "
|
|
4054
|
+
"name": "Buttonsimple",
|
|
4055
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4180
4056
|
}
|
|
4181
4057
|
},
|
|
4182
4058
|
{
|
|
4183
|
-
"
|
|
4184
|
-
"name": "
|
|
4185
|
-
"
|
|
4186
|
-
"text": "number | undefined"
|
|
4187
|
-
},
|
|
4188
|
-
"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`.",
|
|
4189
|
-
"attribute": "counter",
|
|
4059
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
|
|
4060
|
+
"name": "keydown",
|
|
4061
|
+
"reactName": "onKeyDown",
|
|
4190
4062
|
"inheritedFrom": {
|
|
4191
|
-
"name": "
|
|
4192
|
-
"module": "
|
|
4063
|
+
"name": "Buttonsimple",
|
|
4064
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4193
4065
|
}
|
|
4194
4066
|
},
|
|
4195
4067
|
{
|
|
4196
|
-
"
|
|
4197
|
-
"name": "
|
|
4198
|
-
"
|
|
4199
|
-
"text": "boolean"
|
|
4200
|
-
},
|
|
4201
|
-
"default": "false",
|
|
4202
|
-
"description": "Represents the typing indicator when the user is typing.",
|
|
4203
|
-
"attribute": "is-typing",
|
|
4068
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
|
|
4069
|
+
"name": "keyup",
|
|
4070
|
+
"reactName": "onKeyUp",
|
|
4204
4071
|
"inheritedFrom": {
|
|
4205
|
-
"name": "
|
|
4206
|
-
"module": "
|
|
4072
|
+
"name": "Buttonsimple",
|
|
4073
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4207
4074
|
}
|
|
4208
4075
|
},
|
|
4209
4076
|
{
|
|
4210
|
-
"
|
|
4211
|
-
"name": "
|
|
4212
|
-
"
|
|
4213
|
-
"text": "IconNames | undefined"
|
|
4214
|
-
},
|
|
4215
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
4216
|
-
"attribute": "icon-name",
|
|
4077
|
+
"description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
|
|
4078
|
+
"name": "focus",
|
|
4079
|
+
"reactName": "onFocus",
|
|
4217
4080
|
"inheritedFrom": {
|
|
4218
|
-
"name": "
|
|
4219
|
-
"module": "
|
|
4081
|
+
"name": "Buttonsimple",
|
|
4082
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4220
4083
|
}
|
|
4221
4084
|
}
|
|
4222
4085
|
],
|
|
4223
|
-
"
|
|
4086
|
+
"attributes": [
|
|
4224
4087
|
{
|
|
4225
|
-
"name": "
|
|
4226
|
-
"
|
|
4088
|
+
"name": "aria-label",
|
|
4089
|
+
"type": {
|
|
4090
|
+
"text": "string | null"
|
|
4091
|
+
},
|
|
4092
|
+
"default": "null",
|
|
4093
|
+
"description": "Aria-label attribute to be set for accessibility",
|
|
4094
|
+
"fieldName": "ariaLabel"
|
|
4227
4095
|
},
|
|
4228
|
-
{
|
|
4229
|
-
"name": "IconNameMixin",
|
|
4230
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
|
4231
|
-
}
|
|
4232
|
-
],
|
|
4233
|
-
"superclass": {
|
|
4234
|
-
"name": "Component",
|
|
4235
|
-
"module": "/src/models"
|
|
4236
|
-
},
|
|
4237
|
-
"tagName": "mdc-avatar",
|
|
4238
|
-
"jsDoc": "/**\n * The `mdc-avatar` component is used to represent a person or a space.\n * An avatar can be an icon, initials, counter and photo.\n *\n * To set the photo of an avatar,\n * you need to set \"src\" attribute.\n *\n * While the avatar image is loading, as a placeholder,\n * we will show the initials text.\n * If the initials are not specified then,\n * we will show `user-regular` icon as a placeholder.\n *\n * By default, if there are no attributes specified,\n * then the default avatar will be an icon with `user-regular` name.\n *\n * The avatar component is non clickable and non interactive/focusable component.\n * If the avatar is typing, then the loading indicator will be displayed.\n * If the counter type avatar is set to a negative number, then we will display 0.\n * The presence indicator will be hidden when the counter property is set.\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n *\n * @csspart photo - The photo of the avatar.\n * @csspart presence - The presence indicator of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator.\n * @csspart loader - The loading indicator of the avatar.\n */",
|
|
4239
|
-
"customElement": true,
|
|
4240
|
-
"attributes": [
|
|
4241
4096
|
{
|
|
4242
4097
|
"name": "src",
|
|
4243
4098
|
"type": {
|
|
@@ -4277,14 +4132,14 @@
|
|
|
4277
4132
|
{
|
|
4278
4133
|
"name": "size",
|
|
4279
4134
|
"type": {
|
|
4280
|
-
"text": "
|
|
4135
|
+
"text": "ButtonSize"
|
|
4281
4136
|
},
|
|
4282
4137
|
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
|
4283
4138
|
"default": "32",
|
|
4284
4139
|
"fieldName": "size",
|
|
4285
4140
|
"inheritedFrom": {
|
|
4286
|
-
"name": "
|
|
4287
|
-
"module": "src/
|
|
4141
|
+
"name": "Buttonsimple",
|
|
4142
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4288
4143
|
}
|
|
4289
4144
|
},
|
|
4290
4145
|
{
|
|
@@ -4323,60 +4178,205 @@
|
|
|
4323
4178
|
"name": "IconNameMixin",
|
|
4324
4179
|
"module": "src/utils/mixins/IconNameMixin.ts"
|
|
4325
4180
|
}
|
|
4326
|
-
}
|
|
4327
|
-
]
|
|
4328
|
-
}
|
|
4329
|
-
],
|
|
4330
|
-
"exports": [
|
|
4331
|
-
{
|
|
4332
|
-
"kind": "js",
|
|
4333
|
-
"name": "default",
|
|
4334
|
-
"declaration": {
|
|
4335
|
-
"name": "Avatar",
|
|
4336
|
-
"module": "components/avatar/avatar.component.js"
|
|
4337
|
-
}
|
|
4338
|
-
}
|
|
4339
|
-
]
|
|
4340
|
-
},
|
|
4341
|
-
{
|
|
4342
|
-
"kind": "javascript-module",
|
|
4343
|
-
"path": "components/badge/badge.component.js",
|
|
4344
|
-
"declarations": [
|
|
4345
|
-
{
|
|
4346
|
-
"kind": "class",
|
|
4347
|
-
"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.",
|
|
4348
|
-
"name": "Badge",
|
|
4349
|
-
"cssProperties": [
|
|
4181
|
+
},
|
|
4350
4182
|
{
|
|
4351
|
-
"
|
|
4352
|
-
"
|
|
4183
|
+
"name": "auto-focus-on-mount",
|
|
4184
|
+
"type": {
|
|
4185
|
+
"text": "boolean"
|
|
4186
|
+
},
|
|
4187
|
+
"default": "false",
|
|
4188
|
+
"description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
|
|
4189
|
+
"fieldName": "autoFocusOnMount",
|
|
4190
|
+
"inheritedFrom": {
|
|
4191
|
+
"name": "AutoFocusOnMountMixin",
|
|
4192
|
+
"module": "src/utils/mixins/AutoFocusOnMountMixin.ts"
|
|
4193
|
+
}
|
|
4353
4194
|
},
|
|
4354
4195
|
{
|
|
4355
|
-
"
|
|
4356
|
-
"
|
|
4196
|
+
"name": "tabIndex",
|
|
4197
|
+
"type": {
|
|
4198
|
+
"text": "number"
|
|
4199
|
+
},
|
|
4200
|
+
"default": "0",
|
|
4201
|
+
"description": "This property specifies the tab order of the element.",
|
|
4202
|
+
"fieldName": "tabIndex",
|
|
4203
|
+
"inheritedFrom": {
|
|
4204
|
+
"name": "TabIndexMixin",
|
|
4205
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
|
4206
|
+
}
|
|
4357
4207
|
},
|
|
4358
4208
|
{
|
|
4359
|
-
"
|
|
4360
|
-
"
|
|
4209
|
+
"name": "disabled",
|
|
4210
|
+
"type": {
|
|
4211
|
+
"text": "boolean | undefined"
|
|
4212
|
+
},
|
|
4213
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
4214
|
+
"default": "undefined",
|
|
4215
|
+
"fieldName": "disabled",
|
|
4216
|
+
"inheritedFrom": {
|
|
4217
|
+
"name": "DisabledMixin",
|
|
4218
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
|
4219
|
+
}
|
|
4361
4220
|
},
|
|
4362
4221
|
{
|
|
4363
|
-
"
|
|
4364
|
-
"
|
|
4222
|
+
"name": "active",
|
|
4223
|
+
"type": {
|
|
4224
|
+
"text": "boolean | undefined"
|
|
4225
|
+
},
|
|
4226
|
+
"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.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
|
4227
|
+
"default": "undefined",
|
|
4228
|
+
"fieldName": "active",
|
|
4229
|
+
"inheritedFrom": {
|
|
4230
|
+
"name": "Buttonsimple",
|
|
4231
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4232
|
+
}
|
|
4365
4233
|
},
|
|
4366
4234
|
{
|
|
4367
|
-
"
|
|
4368
|
-
"
|
|
4235
|
+
"name": "soft-disabled",
|
|
4236
|
+
"type": {
|
|
4237
|
+
"text": "boolean | undefined"
|
|
4238
|
+
},
|
|
4239
|
+
"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.",
|
|
4240
|
+
"default": "undefined",
|
|
4241
|
+
"fieldName": "softDisabled",
|
|
4242
|
+
"inheritedFrom": {
|
|
4243
|
+
"name": "Buttonsimple",
|
|
4244
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4245
|
+
}
|
|
4369
4246
|
},
|
|
4370
4247
|
{
|
|
4371
|
-
"
|
|
4372
|
-
"
|
|
4248
|
+
"name": "role",
|
|
4249
|
+
"type": {
|
|
4250
|
+
"text": "RoleType"
|
|
4251
|
+
},
|
|
4252
|
+
"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.",
|
|
4253
|
+
"default": "button",
|
|
4254
|
+
"fieldName": "role",
|
|
4255
|
+
"inheritedFrom": {
|
|
4256
|
+
"name": "Buttonsimple",
|
|
4257
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4258
|
+
}
|
|
4373
4259
|
},
|
|
4374
4260
|
{
|
|
4375
|
-
"
|
|
4376
|
-
"
|
|
4261
|
+
"name": "ariaStateKey",
|
|
4262
|
+
"type": {
|
|
4263
|
+
"text": "string | undefined"
|
|
4264
|
+
},
|
|
4265
|
+
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
|
4266
|
+
"default": "'aria-pressed' (when)",
|
|
4267
|
+
"fieldName": "ariaStateKey",
|
|
4268
|
+
"inheritedFrom": {
|
|
4269
|
+
"name": "Buttonsimple",
|
|
4270
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4271
|
+
}
|
|
4377
4272
|
},
|
|
4378
4273
|
{
|
|
4379
|
-
"
|
|
4274
|
+
"name": "type",
|
|
4275
|
+
"type": {
|
|
4276
|
+
"text": "ButtonType"
|
|
4277
|
+
},
|
|
4278
|
+
"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.",
|
|
4279
|
+
"default": "button",
|
|
4280
|
+
"fieldName": "type",
|
|
4281
|
+
"inheritedFrom": {
|
|
4282
|
+
"name": "Buttonsimple",
|
|
4283
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4284
|
+
}
|
|
4285
|
+
},
|
|
4286
|
+
{
|
|
4287
|
+
"name": "name",
|
|
4288
|
+
"type": {
|
|
4289
|
+
"text": "string | undefined"
|
|
4290
|
+
},
|
|
4291
|
+
"description": "The name of the button, submitted as a pair with the button's value as part of the form data,\nwhen that button is used to submit the form.",
|
|
4292
|
+
"fieldName": "name",
|
|
4293
|
+
"inheritedFrom": {
|
|
4294
|
+
"name": "Buttonsimple",
|
|
4295
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4296
|
+
}
|
|
4297
|
+
},
|
|
4298
|
+
{
|
|
4299
|
+
"name": "value",
|
|
4300
|
+
"type": {
|
|
4301
|
+
"text": "string | undefined"
|
|
4302
|
+
},
|
|
4303
|
+
"description": "Defines the value associated with the button's name when it's submitted with the form data.\nThis value is passed to the server in params when the form is submitted using this button.",
|
|
4304
|
+
"fieldName": "value",
|
|
4305
|
+
"inheritedFrom": {
|
|
4306
|
+
"name": "Buttonsimple",
|
|
4307
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4308
|
+
}
|
|
4309
|
+
}
|
|
4310
|
+
],
|
|
4311
|
+
"mixins": [
|
|
4312
|
+
{
|
|
4313
|
+
"name": "AvatarComponentMixin",
|
|
4314
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
|
4315
|
+
},
|
|
4316
|
+
{
|
|
4317
|
+
"name": "IconNameMixin",
|
|
4318
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
|
4319
|
+
}
|
|
4320
|
+
],
|
|
4321
|
+
"superclass": {
|
|
4322
|
+
"name": "Buttonsimple",
|
|
4323
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
|
4324
|
+
},
|
|
4325
|
+
"tagName": "mdc-avatarbutton",
|
|
4326
|
+
"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 * To override styles of the avatar inside, use the specified css parts.\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 *\n * @cssproperty --mdc-avatarbutton-overlay-background-color-rest - Background color of the overlay in rest state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-hover - Background color of the overlay in hover state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-active - Background color of the overlay in active state\n *\n * @csspart overlay - The overlay part of the avatar button.\n * @csspart content - The main content of the avatar.\n * @csspart photo - The photo part of the avatar.\n * @csspart presence - The presence indicator part of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator of the avatar.\n * @csspart loader - The loading indicator part of the avatar.\n */",
|
|
4327
|
+
"customElement": true
|
|
4328
|
+
}
|
|
4329
|
+
],
|
|
4330
|
+
"exports": [
|
|
4331
|
+
{
|
|
4332
|
+
"kind": "js",
|
|
4333
|
+
"name": "default",
|
|
4334
|
+
"declaration": {
|
|
4335
|
+
"name": "AvatarButton",
|
|
4336
|
+
"module": "components/avatarbutton/avatarbutton.component.js"
|
|
4337
|
+
}
|
|
4338
|
+
}
|
|
4339
|
+
]
|
|
4340
|
+
},
|
|
4341
|
+
{
|
|
4342
|
+
"kind": "javascript-module",
|
|
4343
|
+
"path": "components/badge/badge.component.js",
|
|
4344
|
+
"declarations": [
|
|
4345
|
+
{
|
|
4346
|
+
"kind": "class",
|
|
4347
|
+
"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.",
|
|
4348
|
+
"name": "Badge",
|
|
4349
|
+
"cssProperties": [
|
|
4350
|
+
{
|
|
4351
|
+
"description": "The foreground color of the primary badge.",
|
|
4352
|
+
"name": "--mdc-badge-primary-foreground-color"
|
|
4353
|
+
},
|
|
4354
|
+
{
|
|
4355
|
+
"description": "The background color of the primary badge.",
|
|
4356
|
+
"name": "--mdc-badge-primary-background-color"
|
|
4357
|
+
},
|
|
4358
|
+
{
|
|
4359
|
+
"description": "The foreground color of the secondary badge.",
|
|
4360
|
+
"name": "--mdc-badge-secondary-foreground-color"
|
|
4361
|
+
},
|
|
4362
|
+
{
|
|
4363
|
+
"description": "The background color of the secondary badge.",
|
|
4364
|
+
"name": "--mdc-badge-secondary-background-color"
|
|
4365
|
+
},
|
|
4366
|
+
{
|
|
4367
|
+
"description": "The foreground color of the success badge.",
|
|
4368
|
+
"name": "--mdc-badge-success-foreground-color"
|
|
4369
|
+
},
|
|
4370
|
+
{
|
|
4371
|
+
"description": "The background color of the success badge.",
|
|
4372
|
+
"name": "--mdc-badge-success-background-color"
|
|
4373
|
+
},
|
|
4374
|
+
{
|
|
4375
|
+
"description": "The foreground color of the warning badge.",
|
|
4376
|
+
"name": "--mdc-badge-warning-foreground-color"
|
|
4377
|
+
},
|
|
4378
|
+
{
|
|
4379
|
+
"description": "The background color of the warning badge.",
|
|
4380
4380
|
"name": "--mdc-badge-warning-background-color"
|
|
4381
4381
|
},
|
|
4382
4382
|
{
|
|
@@ -4684,7 +4684,7 @@
|
|
|
4684
4684
|
"declarations": [
|
|
4685
4685
|
{
|
|
4686
4686
|
"kind": "class",
|
|
4687
|
-
"description": "`mdc-banner` is a component that allows applications to communicate important messages to users
|
|
4687
|
+
"description": "`mdc-banner` is a component that allows applications to communicate important messages to users\nand requires user action to dismiss them. It supports different message types with appropriate styling\nand icons, and provides flexibility for customization through label, secondary label, icons, and actions.\n\nThey are designed to be noticeable yet non-intrusive, helping users stay informed without interrupting their workflow.\n\nThis component supports both structured content via properties and flexible customization via slots:\n- Use the properties (`label`, `secondaryLabel`, `variant`) for standard banner layouts with automatic icon selection.\n- Use slots for custom content and complete layout control.\n- Combine both approaches for maximum flexibility.\n- Create custom orientations and actions using CSS parts and slots.",
|
|
4688
4688
|
"name": "Banner",
|
|
4689
4689
|
"cssProperties": [
|
|
4690
4690
|
{
|
|
@@ -4695,6 +4695,10 @@
|
|
|
4695
4695
|
"description": "Border color of the banner.",
|
|
4696
4696
|
"name": "--mdc-banner-border-color"
|
|
4697
4697
|
},
|
|
4698
|
+
{
|
|
4699
|
+
"description": "Border width of the banner.",
|
|
4700
|
+
"name": "--mdc-banner-border-width"
|
|
4701
|
+
},
|
|
4698
4702
|
{
|
|
4699
4703
|
"description": "Color of the icon in the banner.",
|
|
4700
4704
|
"name": "--mdc-banner-icon-color"
|
|
@@ -4823,7 +4827,7 @@
|
|
|
4823
4827
|
"module": "/src/models"
|
|
4824
4828
|
},
|
|
4825
4829
|
"tagName": "mdc-banner",
|
|
4826
|
-
"jsDoc": "/**\n * `mdc-banner` is a component that allows applications to communicate important messages to users
|
|
4830
|
+
"jsDoc": "/**\n * `mdc-banner` is a component that allows applications to communicate important messages to users\n * and requires user action to dismiss them. It supports different message types with appropriate styling\n * and icons, and provides flexibility for customization through label, secondary label, icons, and actions.\n *\n * They are designed to be noticeable yet non-intrusive, helping users stay informed without interrupting their workflow.\n *\n * This component supports both structured content via properties and flexible customization via slots:\n * - Use the properties (`label`, `secondaryLabel`, `variant`) for standard banner layouts with automatic icon selection.\n * - Use slots for custom content and complete layout control.\n * - Combine both approaches for maximum flexibility.\n * - Create custom orientations and actions using CSS parts and slots.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @slot content - Complete content override. When used, it replaces all default banner content including icon, label, secondary label, and actions.\n * @slot leading-icon - Custom icon content. Overrides the default variant-based icon.\n * @slot leading-text - Custom text content. Overrides the label and secondaryLabel properties.\n * @slot trailing-actions - Custom action buttons and controls. Use this for dismiss buttons, reset buttons, or any other actions.\n *\n * @tagname mdc-banner\n *\n * @csspart leading - The leading section containing the icon and text.\n * @csspart leading-icon - The icon displayed for variants or custom icon slot.\n * @csspart leading-text - The leading section containing label and secondary label text.\n * @csspart trailing - The trailing section containing action buttons and controls.\n * @csspart leading-label - The label text of the banner.\n * @csspart leading-secondary-label - The secondary label text of the banner.\n *\n * @cssproperty --mdc-banner-background-color - Background color of the banner.\n * @cssproperty --mdc-banner-border-color - Border color of the banner.\n * @cssproperty --mdc-banner-border-width - Border width of the banner.\n * @cssproperty --mdc-banner-icon-color - Color of the icon in the banner.\n * @cssproperty --mdc-banner-elevation - Elevation/shadow of the banner.\n * @cssproperty --mdc-banner-padding - Padding inside the banner.\n * @cssproperty --mdc-banner-gap - Gap between banner elements.\n */",
|
|
4827
4831
|
"customElement": true
|
|
4828
4832
|
}
|
|
4829
4833
|
],
|
|
@@ -22853,112 +22857,28 @@
|
|
|
22853
22857
|
},
|
|
22854
22858
|
{
|
|
22855
22859
|
"kind": "javascript-module",
|
|
22856
|
-
"path": "components/
|
|
22860
|
+
"path": "components/marker/marker.component.js",
|
|
22857
22861
|
"declarations": [
|
|
22858
22862
|
{
|
|
22859
22863
|
"kind": "class",
|
|
22860
|
-
"description": "mdc-
|
|
22861
|
-
"name": "
|
|
22864
|
+
"description": "`mdc-marker`, which is a vertical line and\nused to draw attention to specific parts of\nthe content or to signify important information.\n\n**Marker Variants**:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
|
|
22865
|
+
"name": "Marker",
|
|
22862
22866
|
"cssProperties": [
|
|
22863
22867
|
{
|
|
22864
|
-
"description": "Allows customization of the default background color.",
|
|
22865
|
-
"name": "--mdc-
|
|
22866
|
-
},
|
|
22867
|
-
{
|
|
22868
|
-
"description": "Allows customization of the background color on hover.",
|
|
22869
|
-
"name": "--mdc-listitem-background-color-hover"
|
|
22870
|
-
},
|
|
22871
|
-
{
|
|
22872
|
-
"description": "Allows customization of the background color when pressed.",
|
|
22873
|
-
"name": "--mdc-listitem-background-color-active"
|
|
22874
|
-
},
|
|
22875
|
-
{
|
|
22876
|
-
"description": "Allows customization of the primary label, side header and subline text slot color.",
|
|
22877
|
-
"name": "--mdc-listitem-primary-label-color"
|
|
22878
|
-
},
|
|
22879
|
-
{
|
|
22880
|
-
"description": "Allows customization of the secondary and tertiary label text slot color.",
|
|
22881
|
-
"name": "--mdc-listitem-secondary-label-color"
|
|
22882
|
-
},
|
|
22883
|
-
{
|
|
22884
|
-
"description": "Allows customization of the disabled color.",
|
|
22885
|
-
"name": "--mdc-listitem-disabled-color"
|
|
22886
|
-
},
|
|
22887
|
-
{
|
|
22888
|
-
"description": "Allows customization of column gap.",
|
|
22889
|
-
"name": "--mdc-listitem-column-gap"
|
|
22890
|
-
},
|
|
22891
|
-
{
|
|
22892
|
-
"description": "Allows customization of padding left and right.",
|
|
22893
|
-
"name": "--mdc-listitem-padding-left-right"
|
|
22894
|
-
},
|
|
22895
|
-
{
|
|
22896
|
-
"description": "Allows customization of padding top and bottom.",
|
|
22897
|
-
"name": "--mdc-listitem-padding-top-bottom"
|
|
22898
|
-
},
|
|
22899
|
-
{
|
|
22900
|
-
"description": "Allows customization of the cursor.",
|
|
22901
|
-
"name": "--mdc-listitem-cursor"
|
|
22902
|
-
},
|
|
22903
|
-
{
|
|
22904
|
-
"description": "Allows customization of the width of the list item.",
|
|
22905
|
-
"name": "--mdc-listitem-width"
|
|
22906
|
-
},
|
|
22907
|
-
{
|
|
22908
|
-
"description": "Allows customization of the height of the list item.",
|
|
22909
|
-
"name": "--mdc-listitem-height"
|
|
22910
|
-
}
|
|
22911
|
-
],
|
|
22912
|
-
"cssParts": [
|
|
22913
|
-
{
|
|
22914
|
-
"description": "Allows customization of the leading part.",
|
|
22915
|
-
"name": "leading"
|
|
22916
|
-
},
|
|
22917
|
-
{
|
|
22918
|
-
"description": "Allows customization of the leading text part.",
|
|
22919
|
-
"name": "leading-text"
|
|
22920
|
-
},
|
|
22921
|
-
{
|
|
22922
|
-
"description": "Allows customization of the trailing part.",
|
|
22923
|
-
"name": "trailing"
|
|
22924
|
-
},
|
|
22925
|
-
{
|
|
22926
|
-
"description": "Allows customization of the trailing text part.",
|
|
22927
|
-
"name": "trailing-text"
|
|
22928
|
-
}
|
|
22929
|
-
],
|
|
22930
|
-
"slots": [
|
|
22931
|
-
{
|
|
22932
|
-
"description": "slot for list item controls to appear of leading end.",
|
|
22933
|
-
"name": "leading-controls"
|
|
22934
|
-
},
|
|
22935
|
-
{
|
|
22936
|
-
"description": "slot for list item primary label.",
|
|
22937
|
-
"name": "leading-text-primary-label"
|
|
22938
|
-
},
|
|
22939
|
-
{
|
|
22940
|
-
"description": "slot for list item secondary label.",
|
|
22941
|
-
"name": "leading-text-secondary-label"
|
|
22942
|
-
},
|
|
22943
|
-
{
|
|
22944
|
-
"description": "slot for list item tertiary label.",
|
|
22945
|
-
"name": "leading-text-tertiary-label"
|
|
22946
|
-
},
|
|
22947
|
-
{
|
|
22948
|
-
"description": "slot for list item side header text.",
|
|
22949
|
-
"name": "trailing-text-side-header"
|
|
22868
|
+
"description": "Allows customization of the default background color in solid variant.",
|
|
22869
|
+
"name": "--mdc-marker-solid-background-color"
|
|
22950
22870
|
},
|
|
22951
22871
|
{
|
|
22952
|
-
"description": "
|
|
22953
|
-
"name": "
|
|
22872
|
+
"description": "Allows customization of the default stripes in striped variant.",
|
|
22873
|
+
"name": "--mdc-marker-striped-color"
|
|
22954
22874
|
},
|
|
22955
22875
|
{
|
|
22956
|
-
"description": "
|
|
22957
|
-
"name": "
|
|
22876
|
+
"description": "Allows customization of the default background color in striped variant.",
|
|
22877
|
+
"name": "--mdc-marker-striped-background-color"
|
|
22958
22878
|
},
|
|
22959
22879
|
{
|
|
22960
|
-
"description": "
|
|
22961
|
-
"name": "
|
|
22880
|
+
"description": "Allows customization of the default width.",
|
|
22881
|
+
"name": "--mdc-marker-width"
|
|
22962
22882
|
}
|
|
22963
22883
|
],
|
|
22964
22884
|
"members": [
|
|
@@ -22966,95 +22886,87 @@
|
|
|
22966
22886
|
"kind": "field",
|
|
22967
22887
|
"name": "variant",
|
|
22968
22888
|
"type": {
|
|
22969
|
-
"text": "
|
|
22889
|
+
"text": "MarkerVariants"
|
|
22970
22890
|
},
|
|
22971
|
-
"
|
|
22972
|
-
"
|
|
22891
|
+
"privacy": "public",
|
|
22892
|
+
"description": "There are two variants of markers, each with a width of 0.25rem:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
|
|
22893
|
+
"default": "solid",
|
|
22973
22894
|
"attribute": "variant",
|
|
22974
22895
|
"reflects": true
|
|
22975
|
-
}
|
|
22976
|
-
|
|
22977
|
-
|
|
22978
|
-
"name": "label",
|
|
22979
|
-
"type": {
|
|
22980
|
-
"text": "string | undefined"
|
|
22981
|
-
},
|
|
22982
|
-
"description": "The primary label of the list item.\nThis appears on the leading side of the list item.",
|
|
22983
|
-
"attribute": "label",
|
|
22984
|
-
"reflects": true
|
|
22985
|
-
},
|
|
22986
|
-
{
|
|
22987
|
-
"kind": "field",
|
|
22988
|
-
"name": "secondaryLabel",
|
|
22989
|
-
"type": {
|
|
22990
|
-
"text": "string | undefined"
|
|
22991
|
-
},
|
|
22992
|
-
"description": "The secondary label of the list item.\nThis appears on the leading side of the list item.",
|
|
22993
|
-
"attribute": "secondary-label",
|
|
22994
|
-
"reflects": true
|
|
22995
|
-
},
|
|
22896
|
+
}
|
|
22897
|
+
],
|
|
22898
|
+
"attributes": [
|
|
22996
22899
|
{
|
|
22997
|
-
"
|
|
22998
|
-
"name": "tertiaryLabel",
|
|
22900
|
+
"name": "variant",
|
|
22999
22901
|
"type": {
|
|
23000
|
-
"text": "
|
|
22902
|
+
"text": "MarkerVariants"
|
|
23001
22903
|
},
|
|
23002
|
-
"description": "
|
|
23003
|
-
"
|
|
23004
|
-
"
|
|
23005
|
-
}
|
|
23006
|
-
|
|
23007
|
-
|
|
23008
|
-
|
|
23009
|
-
|
|
23010
|
-
|
|
23011
|
-
|
|
23012
|
-
|
|
23013
|
-
|
|
23014
|
-
|
|
23015
|
-
|
|
22904
|
+
"description": "There are two variants of markers, each with a width of 0.25rem:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
|
|
22905
|
+
"default": "solid",
|
|
22906
|
+
"fieldName": "variant"
|
|
22907
|
+
}
|
|
22908
|
+
],
|
|
22909
|
+
"superclass": {
|
|
22910
|
+
"name": "Component",
|
|
22911
|
+
"module": "/src/models"
|
|
22912
|
+
},
|
|
22913
|
+
"tagName": "mdc-marker",
|
|
22914
|
+
"jsDoc": "/**\n * `mdc-marker`, which is a vertical line and\n * used to draw attention to specific parts of\n * the content or to signify important information.\n *\n * **Marker Variants**:\n * - **solid**: Solid marker.\n * - **striped**: Striped marker.\n *\n * @tagname mdc-marker\n *\n * @cssproperty --mdc-marker-solid-background-color - Allows customization of the default background color\n * in solid variant.\n * @cssproperty --mdc-marker-striped-color - Allows customization of the default stripes in striped variant.\n * @cssproperty --mdc-marker-striped-background-color - Allows customization of the default background color\n * in striped variant.\n * @cssproperty --mdc-marker-width - Allows customization of the default width.\n */",
|
|
22915
|
+
"customElement": true
|
|
22916
|
+
}
|
|
22917
|
+
],
|
|
22918
|
+
"exports": [
|
|
22919
|
+
{
|
|
22920
|
+
"kind": "js",
|
|
22921
|
+
"name": "default",
|
|
22922
|
+
"declaration": {
|
|
22923
|
+
"name": "Marker",
|
|
22924
|
+
"module": "components/marker/marker.component.js"
|
|
22925
|
+
}
|
|
22926
|
+
}
|
|
22927
|
+
]
|
|
22928
|
+
},
|
|
22929
|
+
{
|
|
22930
|
+
"kind": "javascript-module",
|
|
22931
|
+
"path": "components/menubar/menubar.component.js",
|
|
22932
|
+
"declarations": [
|
|
22933
|
+
{
|
|
22934
|
+
"kind": "class",
|
|
22935
|
+
"description": "Menubar is a navigational menu component that provides a vertical fixed list of menu items,\nwith support for nested submenus and keyboard navigation. It serves as a container\nfor menu items and manages their interaction patterns, including:\n- Keyboard navigation (Arrow keys, Home, End)\n- Menu item activation (Enter/Space)\n- Submenu toggling (Right/Left arrow keys)\n- Focus management\n- Integration with MenuPopover for nested menus\n\nA menubar will contain a set of menu items and their associated popovers.\nEach menu item can have a popover for nested menus.\n\nThe component automatically handles ARIA attributes and follows WAI-ARIA menu design patterns.\nIt works in conjunction with `mdc-menuitem` and `mdc-menupopover` to create accessible menu structures.\n\n**Note:** A menubar contains three types of menu items, including menuitem, menuitemradio and menuitemcheckbox. These menu items may optionally be nested in one or more group containers. Groups or items may optionally by separated with separator elements.\n\n`mdc-menubar` contains a group that wraps all its chilren passed within the default slot. This has been added to ensure the right accessibility behavior while using screen readers.",
|
|
22936
|
+
"name": "MenuBar",
|
|
22937
|
+
"slots": [
|
|
23016
22938
|
{
|
|
23017
|
-
"
|
|
23018
|
-
"name": "
|
|
23019
|
-
|
|
23020
|
-
|
|
23021
|
-
|
|
23022
|
-
"description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
|
|
23023
|
-
"attribute": "subline-text",
|
|
23024
|
-
"reflects": true
|
|
23025
|
-
},
|
|
22939
|
+
"description": "Contains the menu items and their associated popovers",
|
|
22940
|
+
"name": "default"
|
|
22941
|
+
}
|
|
22942
|
+
],
|
|
22943
|
+
"members": [
|
|
23026
22944
|
{
|
|
23027
22945
|
"kind": "field",
|
|
23028
|
-
"name": "
|
|
22946
|
+
"name": "menusections",
|
|
23029
22947
|
"type": {
|
|
23030
|
-
"text": "
|
|
23031
|
-
}
|
|
23032
|
-
"description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element 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 element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
|
23033
|
-
"default": "undefined",
|
|
23034
|
-
"attribute": "soft-disabled",
|
|
23035
|
-
"reflects": true
|
|
22948
|
+
"text": "Array<HTMLElement>"
|
|
22949
|
+
}
|
|
23036
22950
|
},
|
|
23037
22951
|
{
|
|
23038
22952
|
"kind": "field",
|
|
23039
|
-
"name": "
|
|
22953
|
+
"name": "menuItems",
|
|
23040
22954
|
"type": {
|
|
23041
|
-
"text": "
|
|
22955
|
+
"text": "Array<HTMLElement>"
|
|
23042
22956
|
},
|
|
23043
|
-
"description": "
|
|
23044
|
-
"
|
|
23045
|
-
"attribute": "data-index",
|
|
23046
|
-
"reflects": true
|
|
22957
|
+
"description": "Returns all menuitem elements, including those nested inside menusection.",
|
|
22958
|
+
"readonly": true
|
|
23047
22959
|
},
|
|
23048
22960
|
{
|
|
23049
|
-
"kind": "
|
|
23050
|
-
"name": "
|
|
23051
|
-
"
|
|
23052
|
-
|
|
22961
|
+
"kind": "method",
|
|
22962
|
+
"name": "getAllPopovers",
|
|
22963
|
+
"privacy": "private",
|
|
22964
|
+
"return": {
|
|
22965
|
+
"type": {
|
|
22966
|
+
"text": "Element[]"
|
|
22967
|
+
}
|
|
23053
22968
|
},
|
|
23054
|
-
"description": "
|
|
23055
|
-
"default": "undefined",
|
|
23056
|
-
"attribute": "active",
|
|
23057
|
-
"reflects": true
|
|
22969
|
+
"description": "Returns all menupopovers, including direct and slotted ones ."
|
|
23058
22970
|
},
|
|
23059
22971
|
{
|
|
23060
22972
|
"kind": "method",
|
|
@@ -23070,90 +22982,72 @@
|
|
|
23070
22982
|
"name": "event",
|
|
23071
22983
|
"type": {
|
|
23072
22984
|
"text": "MouseEvent"
|
|
23073
|
-
}
|
|
23074
|
-
|
|
22985
|
+
}
|
|
22986
|
+
},
|
|
22987
|
+
{
|
|
22988
|
+
"description": "The target menu item that was clicked.",
|
|
22989
|
+
"name": "target"
|
|
23075
22990
|
}
|
|
23076
22991
|
],
|
|
23077
|
-
"description": "
|
|
22992
|
+
"description": "Closes all other submenus on the top level.\nThis method is used to ensure that only one topolevel submenu is open at a time.\nIt finds all other menu items with submenus and closes their submenus."
|
|
23078
22993
|
},
|
|
23079
22994
|
{
|
|
23080
22995
|
"kind": "method",
|
|
23081
|
-
"name": "
|
|
23082
|
-
"privacy": "
|
|
23083
|
-
"return": {
|
|
23084
|
-
"type": {
|
|
23085
|
-
"text": "void"
|
|
23086
|
-
}
|
|
23087
|
-
},
|
|
22996
|
+
"name": "resetTabIndexAndSetActiveTabIndex",
|
|
22997
|
+
"privacy": "private",
|
|
23088
22998
|
"parameters": [
|
|
23089
22999
|
{
|
|
23090
|
-
"name": "
|
|
23000
|
+
"name": "menuItems",
|
|
23091
23001
|
"type": {
|
|
23092
|
-
"text": "
|
|
23093
|
-
}
|
|
23094
|
-
|
|
23002
|
+
"text": "Array<HTMLElement>"
|
|
23003
|
+
}
|
|
23004
|
+
},
|
|
23005
|
+
{
|
|
23006
|
+
"description": "The index of the new active element in the list.",
|
|
23007
|
+
"name": "newIndex"
|
|
23095
23008
|
}
|
|
23096
23009
|
],
|
|
23097
|
-
"description": "
|
|
23010
|
+
"description": "Resets all list items tabindex to -1 and sets the tabindex of the\nelement at the given index to 0, effectively setting the active\nelement. This is used when navigating the list via keyboard."
|
|
23098
23011
|
},
|
|
23099
23012
|
{
|
|
23100
23013
|
"kind": "method",
|
|
23101
|
-
"name": "
|
|
23102
|
-
"privacy": "
|
|
23014
|
+
"name": "getCurrentIndex",
|
|
23015
|
+
"privacy": "private",
|
|
23103
23016
|
"return": {
|
|
23104
23017
|
"type": {
|
|
23105
|
-
"text": ""
|
|
23018
|
+
"text": "number"
|
|
23106
23019
|
}
|
|
23107
23020
|
},
|
|
23108
23021
|
"parameters": [
|
|
23109
23022
|
{
|
|
23110
|
-
"name": "
|
|
23023
|
+
"name": "target",
|
|
23111
23024
|
"type": {
|
|
23112
|
-
"text": "
|
|
23113
|
-
}
|
|
23114
|
-
"description": "The event that triggered the click."
|
|
23025
|
+
"text": "EventTarget | null"
|
|
23026
|
+
}
|
|
23115
23027
|
}
|
|
23116
|
-
]
|
|
23117
|
-
"description": "Triggers a click event on the list item."
|
|
23028
|
+
]
|
|
23118
23029
|
},
|
|
23119
23030
|
{
|
|
23120
23031
|
"kind": "method",
|
|
23121
|
-
"name": "
|
|
23122
|
-
"privacy": "
|
|
23032
|
+
"name": "getSubmenu",
|
|
23033
|
+
"privacy": "private",
|
|
23123
23034
|
"return": {
|
|
23124
23035
|
"type": {
|
|
23125
|
-
"text": ""
|
|
23036
|
+
"text": "MenuPopover | undefined"
|
|
23126
23037
|
}
|
|
23127
23038
|
},
|
|
23128
23039
|
"parameters": [
|
|
23129
23040
|
{
|
|
23130
|
-
"name": "
|
|
23131
|
-
"type": {
|
|
23132
|
-
"text": "string"
|
|
23133
|
-
},
|
|
23134
|
-
"description": "The name of the slot to be used."
|
|
23135
|
-
},
|
|
23136
|
-
{
|
|
23137
|
-
"name": "type",
|
|
23138
|
-
"type": {
|
|
23139
|
-
"text": "TextType"
|
|
23140
|
-
},
|
|
23141
|
-
"description": "The type of the text element."
|
|
23142
|
-
},
|
|
23143
|
-
{
|
|
23144
|
-
"name": "content",
|
|
23145
|
-
"optional": true,
|
|
23041
|
+
"name": "triggerId",
|
|
23146
23042
|
"type": {
|
|
23147
|
-
"text": "string"
|
|
23148
|
-
}
|
|
23149
|
-
"description": "The text content to be displayed within the slot."
|
|
23043
|
+
"text": "string | null"
|
|
23044
|
+
}
|
|
23150
23045
|
}
|
|
23151
|
-
]
|
|
23152
|
-
"description": "Generates a template for a text slot with the specified content."
|
|
23046
|
+
]
|
|
23153
23047
|
},
|
|
23154
23048
|
{
|
|
23155
23049
|
"kind": "method",
|
|
23156
|
-
"name": "
|
|
23050
|
+
"name": "showSubmenu",
|
|
23157
23051
|
"privacy": "private",
|
|
23158
23052
|
"return": {
|
|
23159
23053
|
"type": {
|
|
@@ -23162,42 +23056,57 @@
|
|
|
23162
23056
|
},
|
|
23163
23057
|
"parameters": [
|
|
23164
23058
|
{
|
|
23165
|
-
"name": "
|
|
23166
|
-
"default": "false",
|
|
23059
|
+
"name": "triggerId",
|
|
23167
23060
|
"type": {
|
|
23168
|
-
"text": "
|
|
23169
|
-
}
|
|
23170
|
-
"description": "Whether to disable or enable the controls."
|
|
23061
|
+
"text": "string | null"
|
|
23062
|
+
}
|
|
23171
23063
|
}
|
|
23172
|
-
]
|
|
23173
|
-
"description": "Disable or enable all slotted elements in the leading and trailing slots.\nThis is useful when the list item is disabled, to prevent the user from interacting with the controls."
|
|
23064
|
+
]
|
|
23174
23065
|
},
|
|
23175
23066
|
{
|
|
23176
23067
|
"kind": "method",
|
|
23177
|
-
"name": "
|
|
23178
|
-
"privacy": "
|
|
23179
|
-
"description": "Renders the trailing controls slot.",
|
|
23068
|
+
"name": "updatePopoverPlacement",
|
|
23069
|
+
"privacy": "private",
|
|
23180
23070
|
"return": {
|
|
23181
23071
|
"type": {
|
|
23182
|
-
"text": ""
|
|
23072
|
+
"text": "void"
|
|
23183
23073
|
}
|
|
23184
23074
|
}
|
|
23185
23075
|
},
|
|
23186
23076
|
{
|
|
23187
23077
|
"kind": "method",
|
|
23188
|
-
"name": "
|
|
23189
|
-
"privacy": "
|
|
23190
|
-
"description": "Renders the leading controls slot.",
|
|
23078
|
+
"name": "updateTabIndexAndFocus",
|
|
23079
|
+
"privacy": "private",
|
|
23191
23080
|
"return": {
|
|
23192
23081
|
"type": {
|
|
23193
|
-
"text": ""
|
|
23082
|
+
"text": "void"
|
|
23194
23083
|
}
|
|
23195
|
-
}
|
|
23084
|
+
},
|
|
23085
|
+
"parameters": [
|
|
23086
|
+
{
|
|
23087
|
+
"name": "menuItems",
|
|
23088
|
+
"type": {
|
|
23089
|
+
"text": "HTMLElement[]"
|
|
23090
|
+
}
|
|
23091
|
+
},
|
|
23092
|
+
{
|
|
23093
|
+
"name": "currentIndex",
|
|
23094
|
+
"type": {
|
|
23095
|
+
"text": "number"
|
|
23096
|
+
}
|
|
23097
|
+
},
|
|
23098
|
+
{
|
|
23099
|
+
"name": "newIndex",
|
|
23100
|
+
"type": {
|
|
23101
|
+
"text": "number"
|
|
23102
|
+
}
|
|
23103
|
+
}
|
|
23104
|
+
]
|
|
23196
23105
|
},
|
|
23197
23106
|
{
|
|
23198
23107
|
"kind": "method",
|
|
23199
|
-
"name": "
|
|
23200
|
-
"privacy": "
|
|
23108
|
+
"name": "navigateToMenuItem",
|
|
23109
|
+
"privacy": "private",
|
|
23201
23110
|
"return": {
|
|
23202
23111
|
"type": {
|
|
23203
23112
|
"text": "void"
|
|
@@ -23205,250 +23114,284 @@
|
|
|
23205
23114
|
},
|
|
23206
23115
|
"parameters": [
|
|
23207
23116
|
{
|
|
23208
|
-
"name": "
|
|
23117
|
+
"name": "currentIndex",
|
|
23209
23118
|
"type": {
|
|
23210
|
-
"text": "
|
|
23211
|
-
}
|
|
23212
|
-
|
|
23119
|
+
"text": "number"
|
|
23120
|
+
}
|
|
23121
|
+
},
|
|
23122
|
+
{
|
|
23123
|
+
"name": "direction",
|
|
23124
|
+
"type": {
|
|
23125
|
+
"text": "'prev' | 'next'"
|
|
23126
|
+
}
|
|
23127
|
+
},
|
|
23128
|
+
{
|
|
23129
|
+
"name": "shouldOpenSubmenu",
|
|
23130
|
+
"default": "false"
|
|
23213
23131
|
}
|
|
23214
|
-
]
|
|
23215
|
-
"description": "Stops the click event from propagating to parent elements. In case of keyboard events,\nit stops the propagation for Enter and Space keys.\nThis is useful when the list item contains controls that\nshould not trigger the click event on the list item itself."
|
|
23132
|
+
]
|
|
23216
23133
|
},
|
|
23217
23134
|
{
|
|
23218
|
-
"kind": "
|
|
23219
|
-
"name": "
|
|
23220
|
-
"
|
|
23221
|
-
|
|
23135
|
+
"kind": "method",
|
|
23136
|
+
"name": "getKeyWithDirectionFix",
|
|
23137
|
+
"privacy": "private",
|
|
23138
|
+
"return": {
|
|
23139
|
+
"type": {
|
|
23140
|
+
"text": "string"
|
|
23141
|
+
}
|
|
23222
23142
|
},
|
|
23223
|
-
"
|
|
23224
|
-
|
|
23225
|
-
|
|
23226
|
-
|
|
23227
|
-
|
|
23228
|
-
|
|
23229
|
-
|
|
23230
|
-
|
|
23143
|
+
"parameters": [
|
|
23144
|
+
{
|
|
23145
|
+
"name": "originalKey",
|
|
23146
|
+
"type": {
|
|
23147
|
+
"text": "string"
|
|
23148
|
+
}
|
|
23149
|
+
}
|
|
23150
|
+
]
|
|
23231
23151
|
},
|
|
23232
23152
|
{
|
|
23233
|
-
"kind": "
|
|
23234
|
-
"name": "
|
|
23235
|
-
"
|
|
23236
|
-
|
|
23153
|
+
"kind": "method",
|
|
23154
|
+
"name": "isTopLevelMenuItem",
|
|
23155
|
+
"privacy": "private",
|
|
23156
|
+
"return": {
|
|
23157
|
+
"type": {
|
|
23158
|
+
"text": "boolean"
|
|
23159
|
+
}
|
|
23237
23160
|
},
|
|
23238
|
-
"
|
|
23239
|
-
|
|
23240
|
-
|
|
23241
|
-
|
|
23242
|
-
|
|
23243
|
-
|
|
23244
|
-
|
|
23245
|
-
|
|
23246
|
-
|
|
23247
|
-
],
|
|
23248
|
-
"events": [
|
|
23249
|
-
{
|
|
23250
|
-
"description": "(React: onClick) This event is dispatched when the listitem is clicked.",
|
|
23251
|
-
"name": "click",
|
|
23252
|
-
"reactName": "onClick"
|
|
23253
|
-
},
|
|
23254
|
-
{
|
|
23255
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the listitem.",
|
|
23256
|
-
"name": "keydown",
|
|
23257
|
-
"reactName": "onKeyDown"
|
|
23161
|
+
"parameters": [
|
|
23162
|
+
{
|
|
23163
|
+
"name": "element",
|
|
23164
|
+
"type": {
|
|
23165
|
+
"text": "HTMLElement"
|
|
23166
|
+
}
|
|
23167
|
+
}
|
|
23168
|
+
],
|
|
23169
|
+
"description": "Determines if a menuitem is a top-level menuitem (direct child of menubar or child of menusection whose parent is menubar)"
|
|
23258
23170
|
},
|
|
23259
23171
|
{
|
|
23260
|
-
"
|
|
23261
|
-
"name": "
|
|
23262
|
-
"
|
|
23172
|
+
"kind": "method",
|
|
23173
|
+
"name": "isNestedMenuItem",
|
|
23174
|
+
"privacy": "private",
|
|
23175
|
+
"return": {
|
|
23176
|
+
"type": {
|
|
23177
|
+
"text": "boolean"
|
|
23178
|
+
}
|
|
23179
|
+
},
|
|
23180
|
+
"parameters": [
|
|
23181
|
+
{
|
|
23182
|
+
"name": "element",
|
|
23183
|
+
"type": {
|
|
23184
|
+
"text": "HTMLElement"
|
|
23185
|
+
}
|
|
23186
|
+
}
|
|
23187
|
+
]
|
|
23263
23188
|
},
|
|
23264
23189
|
{
|
|
23265
|
-
"
|
|
23266
|
-
"name": "
|
|
23267
|
-
"
|
|
23190
|
+
"kind": "method",
|
|
23191
|
+
"name": "closeAllMenuPopovers",
|
|
23192
|
+
"privacy": "private"
|
|
23268
23193
|
},
|
|
23269
23194
|
{
|
|
23270
|
-
"
|
|
23271
|
-
"name": "
|
|
23272
|
-
"
|
|
23195
|
+
"kind": "method",
|
|
23196
|
+
"name": "crossMenubarNavigationOnLeft",
|
|
23197
|
+
"privacy": "private",
|
|
23198
|
+
"return": {
|
|
23199
|
+
"type": {
|
|
23200
|
+
"text": "Promise<void>"
|
|
23201
|
+
}
|
|
23202
|
+
},
|
|
23203
|
+
"parameters": [
|
|
23204
|
+
{
|
|
23205
|
+
"name": "element",
|
|
23206
|
+
"type": {
|
|
23207
|
+
"text": "HTMLElement"
|
|
23208
|
+
}
|
|
23209
|
+
}
|
|
23210
|
+
]
|
|
23273
23211
|
},
|
|
23274
23212
|
{
|
|
23275
|
-
"
|
|
23276
|
-
"name": "
|
|
23277
|
-
"
|
|
23213
|
+
"kind": "method",
|
|
23214
|
+
"name": "crossMenubarNavigationOnRight",
|
|
23215
|
+
"privacy": "private",
|
|
23216
|
+
"return": {
|
|
23217
|
+
"type": {
|
|
23218
|
+
"text": "Promise<void>"
|
|
23219
|
+
}
|
|
23220
|
+
},
|
|
23221
|
+
"parameters": [
|
|
23222
|
+
{
|
|
23223
|
+
"name": "element",
|
|
23224
|
+
"type": {
|
|
23225
|
+
"text": "HTMLElement"
|
|
23226
|
+
}
|
|
23227
|
+
}
|
|
23228
|
+
]
|
|
23278
23229
|
},
|
|
23279
23230
|
{
|
|
23280
|
-
"
|
|
23281
|
-
"name": "
|
|
23282
|
-
"
|
|
23231
|
+
"kind": "method",
|
|
23232
|
+
"name": "getParentMenuItemIndex",
|
|
23233
|
+
"privacy": "private",
|
|
23234
|
+
"return": {
|
|
23235
|
+
"type": {
|
|
23236
|
+
"text": "number"
|
|
23237
|
+
}
|
|
23238
|
+
},
|
|
23239
|
+
"parameters": [
|
|
23240
|
+
{
|
|
23241
|
+
"name": "element",
|
|
23242
|
+
"type": {
|
|
23243
|
+
"text": "HTMLElement"
|
|
23244
|
+
}
|
|
23245
|
+
}
|
|
23246
|
+
]
|
|
23283
23247
|
},
|
|
23284
23248
|
{
|
|
23285
|
-
"
|
|
23286
|
-
"name": "
|
|
23287
|
-
"
|
|
23249
|
+
"kind": "method",
|
|
23250
|
+
"name": "handleKeyDown",
|
|
23251
|
+
"privacy": "private",
|
|
23252
|
+
"return": {
|
|
23253
|
+
"type": {
|
|
23254
|
+
"text": "Promise<void>"
|
|
23255
|
+
}
|
|
23256
|
+
},
|
|
23257
|
+
"parameters": [
|
|
23258
|
+
{
|
|
23259
|
+
"name": "event",
|
|
23260
|
+
"type": {
|
|
23261
|
+
"text": "KeyboardEvent"
|
|
23262
|
+
}
|
|
23263
|
+
}
|
|
23264
|
+
]
|
|
23288
23265
|
}
|
|
23289
23266
|
],
|
|
23290
|
-
"
|
|
23267
|
+
"superclass": {
|
|
23268
|
+
"name": "Component",
|
|
23269
|
+
"module": "/src/models"
|
|
23270
|
+
},
|
|
23271
|
+
"tagName": "mdc-menubar",
|
|
23272
|
+
"jsDoc": "/**\n * Menubar is a navigational menu component that provides a vertical fixed list of menu items,\n * with support for nested submenus and keyboard navigation. It serves as a container\n * for menu items and manages their interaction patterns, including:\n * - Keyboard navigation (Arrow keys, Home, End)\n * - Menu item activation (Enter/Space)\n * - Submenu toggling (Right/Left arrow keys)\n * - Focus management\n * - Integration with MenuPopover for nested menus\n *\n * A menubar will contain a set of menu items and their associated popovers.\n * Each menu item can have a popover for nested menus.\n *\n * The component automatically handles ARIA attributes and follows WAI-ARIA menu design patterns.\n * It works in conjunction with `mdc-menuitem` and `mdc-menupopover` to create accessible menu structures.\n *\n * **Note:** A menubar contains three types of menu items, including menuitem, menuitemradio and menuitemcheckbox. These menu items may optionally be nested in one or more group containers. Groups or items may optionally by separated with separator elements.\n *\n * `mdc-menubar` contains a group that wraps all its chilren passed within the default slot. This has been added to ensure the right accessibility behavior while using screen readers.\n *\n * @tagname mdc-menubar\n * @slot default - Contains the menu items and their associated popovers\n */",
|
|
23273
|
+
"customElement": true
|
|
23274
|
+
}
|
|
23275
|
+
],
|
|
23276
|
+
"exports": [
|
|
23277
|
+
{
|
|
23278
|
+
"kind": "js",
|
|
23279
|
+
"name": "default",
|
|
23280
|
+
"declaration": {
|
|
23281
|
+
"name": "MenuBar",
|
|
23282
|
+
"module": "components/menubar/menubar.component.js"
|
|
23283
|
+
}
|
|
23284
|
+
}
|
|
23285
|
+
]
|
|
23286
|
+
},
|
|
23287
|
+
{
|
|
23288
|
+
"kind": "javascript-module",
|
|
23289
|
+
"path": "components/listitem/listitem.component.js",
|
|
23290
|
+
"declarations": [
|
|
23291
|
+
{
|
|
23292
|
+
"kind": "class",
|
|
23293
|
+
"description": "mdc-listitem component is used to display a label with different types of controls.\nThere can be three types of controls, a radio button, a checkbox on the\nleading side and a toggle on the trailing side.\nThe list item can contain an avatar on the leading side and a badge on the trailing side.\nAdditionally, the list item can contain a side header and a subline text.\n\nThe leading and trailing slots can be used to display controls and text. <br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted. <br/>\nPlease use mdc-list as a parent element even when there is only listitem for a11y purpose.\n\n**Note**: If a listitem contains a long text, it is recommended to create a tooltip for the listitem that displays the full text on hover.\nConsumers need to add a unique ID to this listitem and use that ID in the tooltip's `triggerID` attribute. We are not creating the tooltip automatically, consumers need to add `<mdc-tooltip>` element manually and associate it with the listitem using the `triggerID` attribute.",
|
|
23294
|
+
"name": "ListItem",
|
|
23295
|
+
"cssProperties": [
|
|
23291
23296
|
{
|
|
23292
|
-
"
|
|
23293
|
-
"
|
|
23294
|
-
"text": "ListItemVariants"
|
|
23295
|
-
},
|
|
23296
|
-
"description": "The variant of the list item. It can be a pill, rectangle or a full-width.",
|
|
23297
|
-
"default": "'full-width'",
|
|
23298
|
-
"fieldName": "variant"
|
|
23297
|
+
"description": "Allows customization of the default background color.",
|
|
23298
|
+
"name": "--mdc-listitem-default-background-color"
|
|
23299
23299
|
},
|
|
23300
23300
|
{
|
|
23301
|
-
"
|
|
23302
|
-
"
|
|
23303
|
-
"text": "string | undefined"
|
|
23304
|
-
},
|
|
23305
|
-
"description": "The primary label of the list item.\nThis appears on the leading side of the list item.",
|
|
23306
|
-
"fieldName": "label"
|
|
23301
|
+
"description": "Allows customization of the background color on hover.",
|
|
23302
|
+
"name": "--mdc-listitem-background-color-hover"
|
|
23307
23303
|
},
|
|
23308
23304
|
{
|
|
23309
|
-
"
|
|
23310
|
-
"
|
|
23311
|
-
"text": "string | undefined"
|
|
23312
|
-
},
|
|
23313
|
-
"description": "The secondary label of the list item.\nThis appears on the leading side of the list item.",
|
|
23314
|
-
"fieldName": "secondaryLabel"
|
|
23305
|
+
"description": "Allows customization of the background color when pressed.",
|
|
23306
|
+
"name": "--mdc-listitem-background-color-active"
|
|
23315
23307
|
},
|
|
23316
23308
|
{
|
|
23317
|
-
"
|
|
23318
|
-
"
|
|
23319
|
-
"text": "string | undefined"
|
|
23320
|
-
},
|
|
23321
|
-
"description": "The tertiary label of the list item.\nThis appears on the leading side of the list item.",
|
|
23322
|
-
"fieldName": "tertiaryLabel"
|
|
23309
|
+
"description": "Allows customization of the primary label, side header and subline text slot color.",
|
|
23310
|
+
"name": "--mdc-listitem-primary-label-color"
|
|
23323
23311
|
},
|
|
23324
23312
|
{
|
|
23325
|
-
"
|
|
23326
|
-
"
|
|
23327
|
-
"text": "string | undefined"
|
|
23328
|
-
},
|
|
23329
|
-
"description": "The header text of the list item.\nThis appears on the trailing side of the list item.",
|
|
23330
|
-
"fieldName": "sideHeaderText"
|
|
23313
|
+
"description": "Allows customization of the secondary and tertiary label text slot color.",
|
|
23314
|
+
"name": "--mdc-listitem-secondary-label-color"
|
|
23331
23315
|
},
|
|
23332
23316
|
{
|
|
23333
|
-
"
|
|
23334
|
-
"
|
|
23335
|
-
"text": "string | undefined"
|
|
23336
|
-
},
|
|
23337
|
-
"description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
|
|
23338
|
-
"fieldName": "sublineText"
|
|
23317
|
+
"description": "Allows customization of the disabled color.",
|
|
23318
|
+
"name": "--mdc-listitem-disabled-color"
|
|
23339
23319
|
},
|
|
23340
23320
|
{
|
|
23341
|
-
"
|
|
23342
|
-
"
|
|
23343
|
-
"text": "boolean | undefined"
|
|
23344
|
-
},
|
|
23345
|
-
"description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element 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 element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
|
23346
|
-
"default": "undefined",
|
|
23347
|
-
"fieldName": "softDisabled"
|
|
23321
|
+
"description": "Allows customization of column gap.",
|
|
23322
|
+
"name": "--mdc-listitem-column-gap"
|
|
23348
23323
|
},
|
|
23349
23324
|
{
|
|
23350
|
-
"
|
|
23351
|
-
"
|
|
23352
|
-
"text": "number | undefined"
|
|
23353
|
-
},
|
|
23354
|
-
"description": "Data attribute to define the index of the list item in a list.\nThis also set the `aria-posinset` attribute for accessibility purposes.\n\nIt is required when the list item is used inside a virtualized list where the items are not sequentially rendered.\nIt should be a zero-based index.",
|
|
23355
|
-
"default": "undefined",
|
|
23356
|
-
"fieldName": "dataIndex"
|
|
23325
|
+
"description": "Allows customization of padding left and right.",
|
|
23326
|
+
"name": "--mdc-listitem-padding-left-right"
|
|
23357
23327
|
},
|
|
23358
23328
|
{
|
|
23359
|
-
"
|
|
23360
|
-
"
|
|
23361
|
-
"text": "boolean | undefined"
|
|
23362
|
-
},
|
|
23363
|
-
"description": "Indicates whether the list item is active.\nWhen set to true, the list item appears in a active state.\n\nNOTE: this is a visual state only, it does not affect the behavior or a11y of the list item.",
|
|
23364
|
-
"default": "undefined",
|
|
23365
|
-
"fieldName": "active"
|
|
23329
|
+
"description": "Allows customization of padding top and bottom.",
|
|
23330
|
+
"name": "--mdc-listitem-padding-top-bottom"
|
|
23366
23331
|
},
|
|
23367
23332
|
{
|
|
23368
|
-
"
|
|
23369
|
-
"
|
|
23370
|
-
"text": "boolean | undefined"
|
|
23371
|
-
},
|
|
23372
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
23373
|
-
"default": "undefined",
|
|
23374
|
-
"fieldName": "disabled",
|
|
23375
|
-
"inheritedFrom": {
|
|
23376
|
-
"name": "DisabledMixin",
|
|
23377
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
|
23378
|
-
}
|
|
23333
|
+
"description": "Allows customization of the cursor.",
|
|
23334
|
+
"name": "--mdc-listitem-cursor"
|
|
23379
23335
|
},
|
|
23380
23336
|
{
|
|
23381
|
-
"
|
|
23382
|
-
"
|
|
23383
|
-
|
|
23384
|
-
|
|
23385
|
-
"
|
|
23386
|
-
"
|
|
23387
|
-
"fieldName": "tabIndex",
|
|
23388
|
-
"inheritedFrom": {
|
|
23389
|
-
"name": "TabIndexMixin",
|
|
23390
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
|
23391
|
-
}
|
|
23337
|
+
"description": "Allows customization of the width of the list item.",
|
|
23338
|
+
"name": "--mdc-listitem-width"
|
|
23339
|
+
},
|
|
23340
|
+
{
|
|
23341
|
+
"description": "Allows customization of the height of the list item.",
|
|
23342
|
+
"name": "--mdc-listitem-height"
|
|
23392
23343
|
}
|
|
23393
23344
|
],
|
|
23394
|
-
"
|
|
23345
|
+
"cssParts": [
|
|
23395
23346
|
{
|
|
23396
|
-
"
|
|
23397
|
-
"
|
|
23347
|
+
"description": "Allows customization of the leading part.",
|
|
23348
|
+
"name": "leading"
|
|
23398
23349
|
},
|
|
23399
23350
|
{
|
|
23400
|
-
"
|
|
23401
|
-
"
|
|
23351
|
+
"description": "Allows customization of the leading text part.",
|
|
23352
|
+
"name": "leading-text"
|
|
23402
23353
|
},
|
|
23403
23354
|
{
|
|
23404
|
-
"
|
|
23405
|
-
"
|
|
23355
|
+
"description": "Allows customization of the trailing part.",
|
|
23356
|
+
"name": "trailing"
|
|
23357
|
+
},
|
|
23358
|
+
{
|
|
23359
|
+
"description": "Allows customization of the trailing text part.",
|
|
23360
|
+
"name": "trailing-text"
|
|
23406
23361
|
}
|
|
23407
23362
|
],
|
|
23408
|
-
"
|
|
23409
|
-
"name": "Component",
|
|
23410
|
-
"module": "/src/models"
|
|
23411
|
-
},
|
|
23412
|
-
"tagName": "mdc-listitem",
|
|
23413
|
-
"jsDoc": "/**\n * mdc-listitem component is used to display a label with different types of controls.\n * There can be three types of controls, a radio button, a checkbox on the\n * leading side and a toggle on the trailing side.\n * The list item can contain an avatar on the leading side and a badge on the trailing side.\n * Additionally, the list item can contain a side header and a subline text.\n *\n * The leading and trailing slots can be used to display controls and text. <br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted. <br/>\n * Please use mdc-list as a parent element even when there is only listitem for a11y purpose.\n *\n * **Note**: If a listitem contains a long text, it is recommended to create a tooltip for the listitem that displays the full text on hover.\n * Consumers need to add a unique ID to this listitem and use that ID in the tooltip's `triggerID` attribute. We are not creating the tooltip automatically, consumers need to add `<mdc-tooltip>` element manually and associate it with the listitem using the `triggerID` attribute.\n *\n * @tagname mdc-listitem\n *\n * @dependency mdc-text\n *\n * @slot leading-controls - slot for list item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for list item primary label.\n * @slot leading-text-secondary-label - slot for list item secondary label.\n * @slot leading-text-tertiary-label - slot for list item tertiary label.\n * @slot trailing-text-side-header - slot for list item side header text.\n * @slot trailing-text-subline - slot for list item subline text.\n * @slot trailing-controls - slot for list item controls to appear of trailing end.\n * @slot content - content slot can be used to override the content completely. Be aware that\n * this will override the default content of the list item.\n *\n * @cssproperty --mdc-listitem-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-listitem-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-listitem-background-color-active - Allows customization of the background color when pressed.\n * @cssproperty --mdc-listitem-primary-label-color\n * - Allows customization of the primary label, side header and subline text slot color.\n * @cssproperty --mdc-listitem-secondary-label-color\n * - Allows customization of the secondary and tertiary label text slot color.\n * @cssproperty --mdc-listitem-disabled-color - Allows customization of the disabled color.\n * @cssproperty --mdc-listitem-column-gap - Allows customization of column gap.\n * @cssproperty --mdc-listitem-padding-left-right - Allows customization of padding left and right.\n * @cssproperty --mdc-listitem-padding-top-bottom - Allows customization of padding top and bottom.\n * @cssproperty --mdc-listitem-cursor - Allows customization of the cursor.\n * @cssproperty --mdc-listitem-width - Allows customization of the width of the list item.\n * @cssproperty --mdc-listitem-height - Allows customization of the height of the list item.\n *\n * @csspart leading - Allows customization of the leading part.\n * @csspart leading-text - Allows customization of the leading text part.\n * @csspart trailing - Allows customization of the trailing part.\n * @csspart trailing-text - Allows customization of the trailing text part.\n *\n * @event click - (React: onClick) This event is dispatched when the listitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the listitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the listitem.\n * @event focus - (React: onFocus) This event is dispatched when the listitem receives focus.\n * @event enabled - (React: onEnabled) This event is dispatched after the listitem is enabled\n * @event disabled - (React: onDisabled) This event is dispatched after the listitem is disabled\n * @event created - (React: onCreated) This event is dispatched after the listitem is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched after the listitem is destroyed (removed from the DOM)\n */",
|
|
23414
|
-
"customElement": true
|
|
23415
|
-
}
|
|
23416
|
-
],
|
|
23417
|
-
"exports": [
|
|
23418
|
-
{
|
|
23419
|
-
"kind": "js",
|
|
23420
|
-
"name": "default",
|
|
23421
|
-
"declaration": {
|
|
23422
|
-
"name": "ListItem",
|
|
23423
|
-
"module": "components/listitem/listitem.component.js"
|
|
23424
|
-
}
|
|
23425
|
-
}
|
|
23426
|
-
]
|
|
23427
|
-
},
|
|
23428
|
-
{
|
|
23429
|
-
"kind": "javascript-module",
|
|
23430
|
-
"path": "components/marker/marker.component.js",
|
|
23431
|
-
"declarations": [
|
|
23432
|
-
{
|
|
23433
|
-
"kind": "class",
|
|
23434
|
-
"description": "`mdc-marker`, which is a vertical line and\nused to draw attention to specific parts of\nthe content or to signify important information.\n\n**Marker Variants**:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
|
|
23435
|
-
"name": "Marker",
|
|
23436
|
-
"cssProperties": [
|
|
23363
|
+
"slots": [
|
|
23437
23364
|
{
|
|
23438
|
-
"description": "
|
|
23439
|
-
"name": "
|
|
23365
|
+
"description": "slot for list item controls to appear of leading end.",
|
|
23366
|
+
"name": "leading-controls"
|
|
23440
23367
|
},
|
|
23441
23368
|
{
|
|
23442
|
-
"description": "
|
|
23443
|
-
"name": "
|
|
23369
|
+
"description": "slot for list item primary label.",
|
|
23370
|
+
"name": "leading-text-primary-label"
|
|
23444
23371
|
},
|
|
23445
23372
|
{
|
|
23446
|
-
"description": "
|
|
23447
|
-
"name": "
|
|
23373
|
+
"description": "slot for list item secondary label.",
|
|
23374
|
+
"name": "leading-text-secondary-label"
|
|
23448
23375
|
},
|
|
23449
23376
|
{
|
|
23450
|
-
"description": "
|
|
23451
|
-
"name": "
|
|
23377
|
+
"description": "slot for list item tertiary label.",
|
|
23378
|
+
"name": "leading-text-tertiary-label"
|
|
23379
|
+
},
|
|
23380
|
+
{
|
|
23381
|
+
"description": "slot for list item side header text.",
|
|
23382
|
+
"name": "trailing-text-side-header"
|
|
23383
|
+
},
|
|
23384
|
+
{
|
|
23385
|
+
"description": "slot for list item subline text.",
|
|
23386
|
+
"name": "trailing-text-subline"
|
|
23387
|
+
},
|
|
23388
|
+
{
|
|
23389
|
+
"description": "slot for list item controls to appear of trailing end.",
|
|
23390
|
+
"name": "trailing-controls"
|
|
23391
|
+
},
|
|
23392
|
+
{
|
|
23393
|
+
"description": "content slot can be used to override the content completely. Be aware that this will override the default content of the list item.",
|
|
23394
|
+
"name": "content"
|
|
23452
23395
|
}
|
|
23453
23396
|
],
|
|
23454
23397
|
"members": [
|
|
@@ -23456,87 +23399,95 @@
|
|
|
23456
23399
|
"kind": "field",
|
|
23457
23400
|
"name": "variant",
|
|
23458
23401
|
"type": {
|
|
23459
|
-
"text": "
|
|
23402
|
+
"text": "ListItemVariants"
|
|
23460
23403
|
},
|
|
23461
|
-
"
|
|
23462
|
-
"
|
|
23463
|
-
"default": "solid",
|
|
23404
|
+
"description": "The variant of the list item. It can be a pill, rectangle or a full-width.",
|
|
23405
|
+
"default": "'full-width'",
|
|
23464
23406
|
"attribute": "variant",
|
|
23465
23407
|
"reflects": true
|
|
23466
|
-
}
|
|
23467
|
-
],
|
|
23468
|
-
"attributes": [
|
|
23408
|
+
},
|
|
23469
23409
|
{
|
|
23470
|
-
"
|
|
23410
|
+
"kind": "field",
|
|
23411
|
+
"name": "label",
|
|
23471
23412
|
"type": {
|
|
23472
|
-
"text": "
|
|
23413
|
+
"text": "string | undefined"
|
|
23473
23414
|
},
|
|
23474
|
-
"description": "
|
|
23475
|
-
"
|
|
23476
|
-
"
|
|
23477
|
-
}
|
|
23478
|
-
],
|
|
23479
|
-
"superclass": {
|
|
23480
|
-
"name": "Component",
|
|
23481
|
-
"module": "/src/models"
|
|
23482
|
-
},
|
|
23483
|
-
"tagName": "mdc-marker",
|
|
23484
|
-
"jsDoc": "/**\n * `mdc-marker`, which is a vertical line and\n * used to draw attention to specific parts of\n * the content or to signify important information.\n *\n * **Marker Variants**:\n * - **solid**: Solid marker.\n * - **striped**: Striped marker.\n *\n * @tagname mdc-marker\n *\n * @cssproperty --mdc-marker-solid-background-color - Allows customization of the default background color\n * in solid variant.\n * @cssproperty --mdc-marker-striped-color - Allows customization of the default stripes in striped variant.\n * @cssproperty --mdc-marker-striped-background-color - Allows customization of the default background color\n * in striped variant.\n * @cssproperty --mdc-marker-width - Allows customization of the default width.\n */",
|
|
23485
|
-
"customElement": true
|
|
23486
|
-
}
|
|
23487
|
-
],
|
|
23488
|
-
"exports": [
|
|
23489
|
-
{
|
|
23490
|
-
"kind": "js",
|
|
23491
|
-
"name": "default",
|
|
23492
|
-
"declaration": {
|
|
23493
|
-
"name": "Marker",
|
|
23494
|
-
"module": "components/marker/marker.component.js"
|
|
23495
|
-
}
|
|
23496
|
-
}
|
|
23497
|
-
]
|
|
23498
|
-
},
|
|
23499
|
-
{
|
|
23500
|
-
"kind": "javascript-module",
|
|
23501
|
-
"path": "components/menubar/menubar.component.js",
|
|
23502
|
-
"declarations": [
|
|
23503
|
-
{
|
|
23504
|
-
"kind": "class",
|
|
23505
|
-
"description": "Menubar is a navigational menu component that provides a vertical fixed list of menu items,\nwith support for nested submenus and keyboard navigation. It serves as a container\nfor menu items and manages their interaction patterns, including:\n- Keyboard navigation (Arrow keys, Home, End)\n- Menu item activation (Enter/Space)\n- Submenu toggling (Right/Left arrow keys)\n- Focus management\n- Integration with MenuPopover for nested menus\n\nA menubar will contain a set of menu items and their associated popovers.\nEach menu item can have a popover for nested menus.\n\nThe component automatically handles ARIA attributes and follows WAI-ARIA menu design patterns.\nIt works in conjunction with `mdc-menuitem` and `mdc-menupopover` to create accessible menu structures.\n\n**Note:** A menubar contains three types of menu items, including menuitem, menuitemradio and menuitemcheckbox. These menu items may optionally be nested in one or more group containers. Groups or items may optionally by separated with separator elements.\n\n`mdc-menubar` contains a group that wraps all its chilren passed within the default slot. This has been added to ensure the right accessibility behavior while using screen readers.",
|
|
23506
|
-
"name": "MenuBar",
|
|
23507
|
-
"slots": [
|
|
23415
|
+
"description": "The primary label of the list item.\nThis appears on the leading side of the list item.",
|
|
23416
|
+
"attribute": "label",
|
|
23417
|
+
"reflects": true
|
|
23418
|
+
},
|
|
23508
23419
|
{
|
|
23509
|
-
"
|
|
23510
|
-
"name": "
|
|
23511
|
-
|
|
23512
|
-
|
|
23513
|
-
|
|
23420
|
+
"kind": "field",
|
|
23421
|
+
"name": "secondaryLabel",
|
|
23422
|
+
"type": {
|
|
23423
|
+
"text": "string | undefined"
|
|
23424
|
+
},
|
|
23425
|
+
"description": "The secondary label of the list item.\nThis appears on the leading side of the list item.",
|
|
23426
|
+
"attribute": "secondary-label",
|
|
23427
|
+
"reflects": true
|
|
23428
|
+
},
|
|
23429
|
+
{
|
|
23430
|
+
"kind": "field",
|
|
23431
|
+
"name": "tertiaryLabel",
|
|
23432
|
+
"type": {
|
|
23433
|
+
"text": "string | undefined"
|
|
23434
|
+
},
|
|
23435
|
+
"description": "The tertiary label of the list item.\nThis appears on the leading side of the list item.",
|
|
23436
|
+
"attribute": "tertiary-label",
|
|
23437
|
+
"reflects": true
|
|
23438
|
+
},
|
|
23439
|
+
{
|
|
23440
|
+
"kind": "field",
|
|
23441
|
+
"name": "sideHeaderText",
|
|
23442
|
+
"type": {
|
|
23443
|
+
"text": "string | undefined"
|
|
23444
|
+
},
|
|
23445
|
+
"description": "The header text of the list item.\nThis appears on the trailing side of the list item.",
|
|
23446
|
+
"attribute": "side-header-text",
|
|
23447
|
+
"reflects": true
|
|
23448
|
+
},
|
|
23449
|
+
{
|
|
23450
|
+
"kind": "field",
|
|
23451
|
+
"name": "sublineText",
|
|
23452
|
+
"type": {
|
|
23453
|
+
"text": "string | undefined"
|
|
23454
|
+
},
|
|
23455
|
+
"description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
|
|
23456
|
+
"attribute": "subline-text",
|
|
23457
|
+
"reflects": true
|
|
23458
|
+
},
|
|
23514
23459
|
{
|
|
23515
23460
|
"kind": "field",
|
|
23516
|
-
"name": "
|
|
23461
|
+
"name": "softDisabled",
|
|
23517
23462
|
"type": {
|
|
23518
|
-
"text": "
|
|
23519
|
-
}
|
|
23463
|
+
"text": "boolean | undefined"
|
|
23464
|
+
},
|
|
23465
|
+
"description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element 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 element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
|
23466
|
+
"default": "undefined",
|
|
23467
|
+
"attribute": "soft-disabled",
|
|
23468
|
+
"reflects": true
|
|
23520
23469
|
},
|
|
23521
23470
|
{
|
|
23522
23471
|
"kind": "field",
|
|
23523
|
-
"name": "
|
|
23472
|
+
"name": "dataIndex",
|
|
23524
23473
|
"type": {
|
|
23525
|
-
"text": "
|
|
23474
|
+
"text": "number | undefined"
|
|
23526
23475
|
},
|
|
23527
|
-
"description": "
|
|
23528
|
-
"
|
|
23476
|
+
"description": "Data attribute to define the index of the list item in a list.\nThis also set the `aria-posinset` attribute for accessibility purposes.\n\nIt is required when the list item is used inside a virtualized list where the items are not sequentially rendered.\nIt should be a zero-based index.",
|
|
23477
|
+
"default": "undefined",
|
|
23478
|
+
"attribute": "data-index",
|
|
23479
|
+
"reflects": true
|
|
23529
23480
|
},
|
|
23530
23481
|
{
|
|
23531
|
-
"kind": "
|
|
23532
|
-
"name": "
|
|
23533
|
-
"
|
|
23534
|
-
|
|
23535
|
-
"type": {
|
|
23536
|
-
"text": "Element[]"
|
|
23537
|
-
}
|
|
23482
|
+
"kind": "field",
|
|
23483
|
+
"name": "active",
|
|
23484
|
+
"type": {
|
|
23485
|
+
"text": "boolean | undefined"
|
|
23538
23486
|
},
|
|
23539
|
-
"description": "
|
|
23487
|
+
"description": "Indicates whether the list item is active.\nWhen set to true, the list item appears in a active state.\n\nNOTE: this is a visual state only, it does not affect the behavior or a11y of the list item.",
|
|
23488
|
+
"default": "undefined",
|
|
23489
|
+
"attribute": "active",
|
|
23490
|
+
"reflects": true
|
|
23540
23491
|
},
|
|
23541
23492
|
{
|
|
23542
23493
|
"kind": "method",
|
|
@@ -23552,73 +23503,16 @@
|
|
|
23552
23503
|
"name": "event",
|
|
23553
23504
|
"type": {
|
|
23554
23505
|
"text": "MouseEvent"
|
|
23555
|
-
}
|
|
23556
|
-
|
|
23557
|
-
{
|
|
23558
|
-
"description": "The target menu item that was clicked.",
|
|
23559
|
-
"name": "target"
|
|
23560
|
-
}
|
|
23561
|
-
],
|
|
23562
|
-
"description": "Closes all other submenus on the top level.\nThis method is used to ensure that only one topolevel submenu is open at a time.\nIt finds all other menu items with submenus and closes their submenus."
|
|
23563
|
-
},
|
|
23564
|
-
{
|
|
23565
|
-
"kind": "method",
|
|
23566
|
-
"name": "resetTabIndexAndSetActiveTabIndex",
|
|
23567
|
-
"privacy": "private",
|
|
23568
|
-
"parameters": [
|
|
23569
|
-
{
|
|
23570
|
-
"name": "menuItems",
|
|
23571
|
-
"type": {
|
|
23572
|
-
"text": "Array<HTMLElement>"
|
|
23573
|
-
}
|
|
23574
|
-
},
|
|
23575
|
-
{
|
|
23576
|
-
"description": "The index of the new active element in the list.",
|
|
23577
|
-
"name": "newIndex"
|
|
23506
|
+
},
|
|
23507
|
+
"description": "The mouse event triggered when the list item is clicked."
|
|
23578
23508
|
}
|
|
23579
23509
|
],
|
|
23580
|
-
"description": "
|
|
23581
|
-
},
|
|
23582
|
-
{
|
|
23583
|
-
"kind": "method",
|
|
23584
|
-
"name": "getCurrentIndex",
|
|
23585
|
-
"privacy": "private",
|
|
23586
|
-
"return": {
|
|
23587
|
-
"type": {
|
|
23588
|
-
"text": "number"
|
|
23589
|
-
}
|
|
23590
|
-
},
|
|
23591
|
-
"parameters": [
|
|
23592
|
-
{
|
|
23593
|
-
"name": "target",
|
|
23594
|
-
"type": {
|
|
23595
|
-
"text": "EventTarget | null"
|
|
23596
|
-
}
|
|
23597
|
-
}
|
|
23598
|
-
]
|
|
23599
|
-
},
|
|
23600
|
-
{
|
|
23601
|
-
"kind": "method",
|
|
23602
|
-
"name": "getSubmenu",
|
|
23603
|
-
"privacy": "private",
|
|
23604
|
-
"return": {
|
|
23605
|
-
"type": {
|
|
23606
|
-
"text": "MenuPopover | undefined"
|
|
23607
|
-
}
|
|
23608
|
-
},
|
|
23609
|
-
"parameters": [
|
|
23610
|
-
{
|
|
23611
|
-
"name": "triggerId",
|
|
23612
|
-
"type": {
|
|
23613
|
-
"text": "string | null"
|
|
23614
|
-
}
|
|
23615
|
-
}
|
|
23616
|
-
]
|
|
23510
|
+
"description": "Handles the click event on the list item.\nPrevents click when listitem is disabled"
|
|
23617
23511
|
},
|
|
23618
23512
|
{
|
|
23619
23513
|
"kind": "method",
|
|
23620
|
-
"name": "
|
|
23621
|
-
"privacy": "
|
|
23514
|
+
"name": "handleKeyDown",
|
|
23515
|
+
"privacy": "protected",
|
|
23622
23516
|
"return": {
|
|
23623
23517
|
"type": {
|
|
23624
23518
|
"text": "void"
|
|
@@ -23626,220 +23520,330 @@
|
|
|
23626
23520
|
},
|
|
23627
23521
|
"parameters": [
|
|
23628
23522
|
{
|
|
23629
|
-
"name": "
|
|
23523
|
+
"name": "event",
|
|
23630
23524
|
"type": {
|
|
23631
|
-
"text": "
|
|
23632
|
-
}
|
|
23633
|
-
|
|
23634
|
-
]
|
|
23635
|
-
},
|
|
23636
|
-
{
|
|
23637
|
-
"kind": "method",
|
|
23638
|
-
"name": "updatePopoverPlacement",
|
|
23639
|
-
"privacy": "private",
|
|
23640
|
-
"return": {
|
|
23641
|
-
"type": {
|
|
23642
|
-
"text": "void"
|
|
23525
|
+
"text": "KeyboardEvent"
|
|
23526
|
+
},
|
|
23527
|
+
"description": "The keyboard event triggered when a key is pressed down."
|
|
23643
23528
|
}
|
|
23644
|
-
|
|
23529
|
+
],
|
|
23530
|
+
"description": "Fires the click event when the enter or space key is pressed down.\nThis behavior is similar to a button click and key interaction."
|
|
23645
23531
|
},
|
|
23646
23532
|
{
|
|
23647
23533
|
"kind": "method",
|
|
23648
|
-
"name": "
|
|
23649
|
-
"privacy": "
|
|
23534
|
+
"name": "triggerClickEvent",
|
|
23535
|
+
"privacy": "protected",
|
|
23650
23536
|
"return": {
|
|
23651
23537
|
"type": {
|
|
23652
|
-
"text": "
|
|
23538
|
+
"text": ""
|
|
23653
23539
|
}
|
|
23654
23540
|
},
|
|
23655
23541
|
"parameters": [
|
|
23656
23542
|
{
|
|
23657
|
-
"name": "
|
|
23658
|
-
"type": {
|
|
23659
|
-
"text": "HTMLElement[]"
|
|
23660
|
-
}
|
|
23661
|
-
},
|
|
23662
|
-
{
|
|
23663
|
-
"name": "currentIndex",
|
|
23664
|
-
"type": {
|
|
23665
|
-
"text": "number"
|
|
23666
|
-
}
|
|
23667
|
-
},
|
|
23668
|
-
{
|
|
23669
|
-
"name": "newIndex",
|
|
23543
|
+
"name": "event",
|
|
23670
23544
|
"type": {
|
|
23671
|
-
"text": "
|
|
23672
|
-
}
|
|
23545
|
+
"text": "Event"
|
|
23546
|
+
},
|
|
23547
|
+
"description": "The event that triggered the click."
|
|
23673
23548
|
}
|
|
23674
|
-
]
|
|
23549
|
+
],
|
|
23550
|
+
"description": "Triggers a click event on the list item."
|
|
23675
23551
|
},
|
|
23676
23552
|
{
|
|
23677
23553
|
"kind": "method",
|
|
23678
|
-
"name": "
|
|
23679
|
-
"privacy": "
|
|
23554
|
+
"name": "getText",
|
|
23555
|
+
"privacy": "protected",
|
|
23680
23556
|
"return": {
|
|
23681
23557
|
"type": {
|
|
23682
|
-
"text": "
|
|
23558
|
+
"text": ""
|
|
23683
23559
|
}
|
|
23684
23560
|
},
|
|
23685
23561
|
"parameters": [
|
|
23686
23562
|
{
|
|
23687
|
-
"name": "
|
|
23563
|
+
"name": "slotName",
|
|
23688
23564
|
"type": {
|
|
23689
|
-
"text": "
|
|
23690
|
-
}
|
|
23565
|
+
"text": "string"
|
|
23566
|
+
},
|
|
23567
|
+
"description": "The name of the slot to be used."
|
|
23691
23568
|
},
|
|
23692
23569
|
{
|
|
23693
|
-
"name": "
|
|
23570
|
+
"name": "type",
|
|
23694
23571
|
"type": {
|
|
23695
|
-
"text": "
|
|
23696
|
-
}
|
|
23572
|
+
"text": "TextType"
|
|
23573
|
+
},
|
|
23574
|
+
"description": "The type of the text element."
|
|
23697
23575
|
},
|
|
23698
23576
|
{
|
|
23699
|
-
"name": "
|
|
23700
|
-
"
|
|
23701
|
-
}
|
|
23702
|
-
]
|
|
23703
|
-
},
|
|
23704
|
-
{
|
|
23705
|
-
"kind": "method",
|
|
23706
|
-
"name": "getKeyWithDirectionFix",
|
|
23707
|
-
"privacy": "private",
|
|
23708
|
-
"return": {
|
|
23709
|
-
"type": {
|
|
23710
|
-
"text": "string"
|
|
23711
|
-
}
|
|
23712
|
-
},
|
|
23713
|
-
"parameters": [
|
|
23714
|
-
{
|
|
23715
|
-
"name": "originalKey",
|
|
23577
|
+
"name": "content",
|
|
23578
|
+
"optional": true,
|
|
23716
23579
|
"type": {
|
|
23717
23580
|
"text": "string"
|
|
23718
|
-
}
|
|
23719
|
-
|
|
23720
|
-
]
|
|
23721
|
-
},
|
|
23722
|
-
{
|
|
23723
|
-
"kind": "method",
|
|
23724
|
-
"name": "isTopLevelMenuItem",
|
|
23725
|
-
"privacy": "private",
|
|
23726
|
-
"return": {
|
|
23727
|
-
"type": {
|
|
23728
|
-
"text": "boolean"
|
|
23729
|
-
}
|
|
23730
|
-
},
|
|
23731
|
-
"parameters": [
|
|
23732
|
-
{
|
|
23733
|
-
"name": "element",
|
|
23734
|
-
"type": {
|
|
23735
|
-
"text": "HTMLElement"
|
|
23736
|
-
}
|
|
23737
|
-
}
|
|
23738
|
-
],
|
|
23739
|
-
"description": "Determines if a menuitem is a top-level menuitem (direct child of menubar or child of menusection whose parent is menubar)"
|
|
23740
|
-
},
|
|
23741
|
-
{
|
|
23742
|
-
"kind": "method",
|
|
23743
|
-
"name": "isNestedMenuItem",
|
|
23744
|
-
"privacy": "private",
|
|
23745
|
-
"return": {
|
|
23746
|
-
"type": {
|
|
23747
|
-
"text": "boolean"
|
|
23748
|
-
}
|
|
23749
|
-
},
|
|
23750
|
-
"parameters": [
|
|
23751
|
-
{
|
|
23752
|
-
"name": "element",
|
|
23753
|
-
"type": {
|
|
23754
|
-
"text": "HTMLElement"
|
|
23755
|
-
}
|
|
23756
|
-
}
|
|
23757
|
-
]
|
|
23758
|
-
},
|
|
23759
|
-
{
|
|
23760
|
-
"kind": "method",
|
|
23761
|
-
"name": "closeAllMenuPopovers",
|
|
23762
|
-
"privacy": "private"
|
|
23763
|
-
},
|
|
23764
|
-
{
|
|
23765
|
-
"kind": "method",
|
|
23766
|
-
"name": "crossMenubarNavigationOnLeft",
|
|
23767
|
-
"privacy": "private",
|
|
23768
|
-
"return": {
|
|
23769
|
-
"type": {
|
|
23770
|
-
"text": "Promise<void>"
|
|
23771
|
-
}
|
|
23772
|
-
},
|
|
23773
|
-
"parameters": [
|
|
23774
|
-
{
|
|
23775
|
-
"name": "element",
|
|
23776
|
-
"type": {
|
|
23777
|
-
"text": "HTMLElement"
|
|
23778
|
-
}
|
|
23581
|
+
},
|
|
23582
|
+
"description": "The text content to be displayed within the slot."
|
|
23779
23583
|
}
|
|
23780
|
-
]
|
|
23584
|
+
],
|
|
23585
|
+
"description": "Generates a template for a text slot with the specified content."
|
|
23781
23586
|
},
|
|
23782
23587
|
{
|
|
23783
23588
|
"kind": "method",
|
|
23784
|
-
"name": "
|
|
23589
|
+
"name": "disableSlottedChildren",
|
|
23785
23590
|
"privacy": "private",
|
|
23786
23591
|
"return": {
|
|
23787
23592
|
"type": {
|
|
23788
|
-
"text": "
|
|
23593
|
+
"text": "void"
|
|
23789
23594
|
}
|
|
23790
23595
|
},
|
|
23791
23596
|
"parameters": [
|
|
23792
23597
|
{
|
|
23793
|
-
"name": "
|
|
23598
|
+
"name": "disabled",
|
|
23599
|
+
"default": "false",
|
|
23794
23600
|
"type": {
|
|
23795
|
-
"text": "
|
|
23796
|
-
}
|
|
23601
|
+
"text": "boolean"
|
|
23602
|
+
},
|
|
23603
|
+
"description": "Whether to disable or enable the controls."
|
|
23797
23604
|
}
|
|
23798
|
-
]
|
|
23605
|
+
],
|
|
23606
|
+
"description": "Disable or enable all slotted elements in the leading and trailing slots.\nThis is useful when the list item is disabled, to prevent the user from interacting with the controls."
|
|
23799
23607
|
},
|
|
23800
23608
|
{
|
|
23801
23609
|
"kind": "method",
|
|
23802
|
-
"name": "
|
|
23803
|
-
"privacy": "
|
|
23610
|
+
"name": "renderTrailingControls",
|
|
23611
|
+
"privacy": "protected",
|
|
23612
|
+
"description": "Renders the trailing controls slot.",
|
|
23804
23613
|
"return": {
|
|
23805
23614
|
"type": {
|
|
23806
|
-
"text": "
|
|
23615
|
+
"text": ""
|
|
23807
23616
|
}
|
|
23808
|
-
}
|
|
23809
|
-
|
|
23810
|
-
|
|
23811
|
-
|
|
23812
|
-
|
|
23813
|
-
|
|
23814
|
-
|
|
23617
|
+
}
|
|
23618
|
+
},
|
|
23619
|
+
{
|
|
23620
|
+
"kind": "method",
|
|
23621
|
+
"name": "renderLeadingControls",
|
|
23622
|
+
"privacy": "protected",
|
|
23623
|
+
"description": "Renders the leading controls slot.",
|
|
23624
|
+
"return": {
|
|
23625
|
+
"type": {
|
|
23626
|
+
"text": ""
|
|
23815
23627
|
}
|
|
23816
|
-
|
|
23628
|
+
}
|
|
23817
23629
|
},
|
|
23818
23630
|
{
|
|
23819
23631
|
"kind": "method",
|
|
23820
|
-
"name": "
|
|
23821
|
-
"privacy": "
|
|
23632
|
+
"name": "stopEventPropagation",
|
|
23633
|
+
"privacy": "protected",
|
|
23822
23634
|
"return": {
|
|
23823
23635
|
"type": {
|
|
23824
|
-
"text": "
|
|
23636
|
+
"text": "void"
|
|
23825
23637
|
}
|
|
23826
23638
|
},
|
|
23827
23639
|
"parameters": [
|
|
23828
23640
|
{
|
|
23829
23641
|
"name": "event",
|
|
23830
23642
|
"type": {
|
|
23831
|
-
"text": "
|
|
23832
|
-
}
|
|
23643
|
+
"text": "Event"
|
|
23644
|
+
},
|
|
23645
|
+
"description": "The mouse event triggered when a click occurs."
|
|
23833
23646
|
}
|
|
23834
|
-
]
|
|
23647
|
+
],
|
|
23648
|
+
"description": "Stops the click event from propagating to parent elements. In case of keyboard events,\nit stops the propagation for Enter and Space keys.\nThis is useful when the list item contains controls that\nshould not trigger the click event on the list item itself."
|
|
23649
|
+
},
|
|
23650
|
+
{
|
|
23651
|
+
"kind": "field",
|
|
23652
|
+
"name": "disabled",
|
|
23653
|
+
"type": {
|
|
23654
|
+
"text": "boolean | undefined"
|
|
23655
|
+
},
|
|
23656
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
23657
|
+
"default": "undefined",
|
|
23658
|
+
"attribute": "disabled",
|
|
23659
|
+
"reflects": true,
|
|
23660
|
+
"inheritedFrom": {
|
|
23661
|
+
"name": "DisabledMixin",
|
|
23662
|
+
"module": "utils/mixins/DisabledMixin.js"
|
|
23663
|
+
}
|
|
23664
|
+
},
|
|
23665
|
+
{
|
|
23666
|
+
"kind": "field",
|
|
23667
|
+
"name": "tabIndex",
|
|
23668
|
+
"type": {
|
|
23669
|
+
"text": "number"
|
|
23670
|
+
},
|
|
23671
|
+
"default": "0",
|
|
23672
|
+
"description": "This property specifies the tab order of the element.",
|
|
23673
|
+
"attribute": "tabIndex",
|
|
23674
|
+
"reflects": true,
|
|
23675
|
+
"inheritedFrom": {
|
|
23676
|
+
"name": "TabIndexMixin",
|
|
23677
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
|
23678
|
+
}
|
|
23679
|
+
}
|
|
23680
|
+
],
|
|
23681
|
+
"events": [
|
|
23682
|
+
{
|
|
23683
|
+
"description": "(React: onClick) This event is dispatched when the listitem is clicked.",
|
|
23684
|
+
"name": "click",
|
|
23685
|
+
"reactName": "onClick"
|
|
23686
|
+
},
|
|
23687
|
+
{
|
|
23688
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the listitem.",
|
|
23689
|
+
"name": "keydown",
|
|
23690
|
+
"reactName": "onKeyDown"
|
|
23691
|
+
},
|
|
23692
|
+
{
|
|
23693
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the listitem.",
|
|
23694
|
+
"name": "keyup",
|
|
23695
|
+
"reactName": "onKeyUp"
|
|
23696
|
+
},
|
|
23697
|
+
{
|
|
23698
|
+
"description": "(React: onFocus) This event is dispatched when the listitem receives focus.",
|
|
23699
|
+
"name": "focus",
|
|
23700
|
+
"reactName": "onFocus"
|
|
23701
|
+
},
|
|
23702
|
+
{
|
|
23703
|
+
"description": "(React: onEnabled) This event is dispatched after the listitem is enabled",
|
|
23704
|
+
"name": "enabled",
|
|
23705
|
+
"reactName": "onEnabled"
|
|
23706
|
+
},
|
|
23707
|
+
{
|
|
23708
|
+
"description": "(React: onDisabled) This event is dispatched after the listitem is disabled",
|
|
23709
|
+
"name": "disabled",
|
|
23710
|
+
"reactName": "onDisabled"
|
|
23711
|
+
},
|
|
23712
|
+
{
|
|
23713
|
+
"description": "(React: onCreated) This event is dispatched after the listitem is created (added to the DOM)",
|
|
23714
|
+
"name": "created",
|
|
23715
|
+
"reactName": "onCreated"
|
|
23716
|
+
},
|
|
23717
|
+
{
|
|
23718
|
+
"description": "(React: onDestroyed) This event is dispatched after the listitem is destroyed (removed from the DOM)",
|
|
23719
|
+
"name": "destroyed",
|
|
23720
|
+
"reactName": "onDestroyed"
|
|
23721
|
+
}
|
|
23722
|
+
],
|
|
23723
|
+
"attributes": [
|
|
23724
|
+
{
|
|
23725
|
+
"name": "variant",
|
|
23726
|
+
"type": {
|
|
23727
|
+
"text": "ListItemVariants"
|
|
23728
|
+
},
|
|
23729
|
+
"description": "The variant of the list item. It can be a pill, rectangle or a full-width.",
|
|
23730
|
+
"default": "'full-width'",
|
|
23731
|
+
"fieldName": "variant"
|
|
23732
|
+
},
|
|
23733
|
+
{
|
|
23734
|
+
"name": "label",
|
|
23735
|
+
"type": {
|
|
23736
|
+
"text": "string | undefined"
|
|
23737
|
+
},
|
|
23738
|
+
"description": "The primary label of the list item.\nThis appears on the leading side of the list item.",
|
|
23739
|
+
"fieldName": "label"
|
|
23740
|
+
},
|
|
23741
|
+
{
|
|
23742
|
+
"name": "secondary-label",
|
|
23743
|
+
"type": {
|
|
23744
|
+
"text": "string | undefined"
|
|
23745
|
+
},
|
|
23746
|
+
"description": "The secondary label of the list item.\nThis appears on the leading side of the list item.",
|
|
23747
|
+
"fieldName": "secondaryLabel"
|
|
23748
|
+
},
|
|
23749
|
+
{
|
|
23750
|
+
"name": "tertiary-label",
|
|
23751
|
+
"type": {
|
|
23752
|
+
"text": "string | undefined"
|
|
23753
|
+
},
|
|
23754
|
+
"description": "The tertiary label of the list item.\nThis appears on the leading side of the list item.",
|
|
23755
|
+
"fieldName": "tertiaryLabel"
|
|
23756
|
+
},
|
|
23757
|
+
{
|
|
23758
|
+
"name": "side-header-text",
|
|
23759
|
+
"type": {
|
|
23760
|
+
"text": "string | undefined"
|
|
23761
|
+
},
|
|
23762
|
+
"description": "The header text of the list item.\nThis appears on the trailing side of the list item.",
|
|
23763
|
+
"fieldName": "sideHeaderText"
|
|
23764
|
+
},
|
|
23765
|
+
{
|
|
23766
|
+
"name": "subline-text",
|
|
23767
|
+
"type": {
|
|
23768
|
+
"text": "string | undefined"
|
|
23769
|
+
},
|
|
23770
|
+
"description": "The subline text of the list item.\nThis appears on the trailing side of the list item.",
|
|
23771
|
+
"fieldName": "sublineText"
|
|
23772
|
+
},
|
|
23773
|
+
{
|
|
23774
|
+
"name": "soft-disabled",
|
|
23775
|
+
"type": {
|
|
23776
|
+
"text": "boolean | undefined"
|
|
23777
|
+
},
|
|
23778
|
+
"description": "Indicates whether the element is soft disabled.\nWhen set to `true`, the element 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 element behaves like a disabled element, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
|
23779
|
+
"default": "undefined",
|
|
23780
|
+
"fieldName": "softDisabled"
|
|
23781
|
+
},
|
|
23782
|
+
{
|
|
23783
|
+
"name": "data-index",
|
|
23784
|
+
"type": {
|
|
23785
|
+
"text": "number | undefined"
|
|
23786
|
+
},
|
|
23787
|
+
"description": "Data attribute to define the index of the list item in a list.\nThis also set the `aria-posinset` attribute for accessibility purposes.\n\nIt is required when the list item is used inside a virtualized list where the items are not sequentially rendered.\nIt should be a zero-based index.",
|
|
23788
|
+
"default": "undefined",
|
|
23789
|
+
"fieldName": "dataIndex"
|
|
23790
|
+
},
|
|
23791
|
+
{
|
|
23792
|
+
"name": "active",
|
|
23793
|
+
"type": {
|
|
23794
|
+
"text": "boolean | undefined"
|
|
23795
|
+
},
|
|
23796
|
+
"description": "Indicates whether the list item is active.\nWhen set to true, the list item appears in a active state.\n\nNOTE: this is a visual state only, it does not affect the behavior or a11y of the list item.",
|
|
23797
|
+
"default": "undefined",
|
|
23798
|
+
"fieldName": "active"
|
|
23799
|
+
},
|
|
23800
|
+
{
|
|
23801
|
+
"name": "disabled",
|
|
23802
|
+
"type": {
|
|
23803
|
+
"text": "boolean | undefined"
|
|
23804
|
+
},
|
|
23805
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
23806
|
+
"default": "undefined",
|
|
23807
|
+
"fieldName": "disabled",
|
|
23808
|
+
"inheritedFrom": {
|
|
23809
|
+
"name": "DisabledMixin",
|
|
23810
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
|
23811
|
+
}
|
|
23812
|
+
},
|
|
23813
|
+
{
|
|
23814
|
+
"name": "tabIndex",
|
|
23815
|
+
"type": {
|
|
23816
|
+
"text": "number"
|
|
23817
|
+
},
|
|
23818
|
+
"default": "0",
|
|
23819
|
+
"description": "This property specifies the tab order of the element.",
|
|
23820
|
+
"fieldName": "tabIndex",
|
|
23821
|
+
"inheritedFrom": {
|
|
23822
|
+
"name": "TabIndexMixin",
|
|
23823
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
|
23824
|
+
}
|
|
23825
|
+
}
|
|
23826
|
+
],
|
|
23827
|
+
"mixins": [
|
|
23828
|
+
{
|
|
23829
|
+
"name": "DisabledMixin",
|
|
23830
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
|
23831
|
+
},
|
|
23832
|
+
{
|
|
23833
|
+
"name": "TabIndexMixin",
|
|
23834
|
+
"module": "/src/utils/mixins/TabIndexMixin"
|
|
23835
|
+
},
|
|
23836
|
+
{
|
|
23837
|
+
"name": "LifeCycleMixin",
|
|
23838
|
+
"module": "/src/utils/mixins/lifecycle/LifeCycleMixin"
|
|
23835
23839
|
}
|
|
23836
23840
|
],
|
|
23837
23841
|
"superclass": {
|
|
23838
23842
|
"name": "Component",
|
|
23839
23843
|
"module": "/src/models"
|
|
23840
23844
|
},
|
|
23841
|
-
"tagName": "mdc-
|
|
23842
|
-
"jsDoc": "/**\n *
|
|
23845
|
+
"tagName": "mdc-listitem",
|
|
23846
|
+
"jsDoc": "/**\n * mdc-listitem component is used to display a label with different types of controls.\n * There can be three types of controls, a radio button, a checkbox on the\n * leading side and a toggle on the trailing side.\n * The list item can contain an avatar on the leading side and a badge on the trailing side.\n * Additionally, the list item can contain a side header and a subline text.\n *\n * The leading and trailing slots can be used to display controls and text. <br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted. <br/>\n * Please use mdc-list as a parent element even when there is only listitem for a11y purpose.\n *\n * **Note**: If a listitem contains a long text, it is recommended to create a tooltip for the listitem that displays the full text on hover.\n * Consumers need to add a unique ID to this listitem and use that ID in the tooltip's `triggerID` attribute. We are not creating the tooltip automatically, consumers need to add `<mdc-tooltip>` element manually and associate it with the listitem using the `triggerID` attribute.\n *\n * @tagname mdc-listitem\n *\n * @dependency mdc-text\n *\n * @slot leading-controls - slot for list item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for list item primary label.\n * @slot leading-text-secondary-label - slot for list item secondary label.\n * @slot leading-text-tertiary-label - slot for list item tertiary label.\n * @slot trailing-text-side-header - slot for list item side header text.\n * @slot trailing-text-subline - slot for list item subline text.\n * @slot trailing-controls - slot for list item controls to appear of trailing end.\n * @slot content - content slot can be used to override the content completely. Be aware that\n * this will override the default content of the list item.\n *\n * @cssproperty --mdc-listitem-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-listitem-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-listitem-background-color-active - Allows customization of the background color when pressed.\n * @cssproperty --mdc-listitem-primary-label-color\n * - Allows customization of the primary label, side header and subline text slot color.\n * @cssproperty --mdc-listitem-secondary-label-color\n * - Allows customization of the secondary and tertiary label text slot color.\n * @cssproperty --mdc-listitem-disabled-color - Allows customization of the disabled color.\n * @cssproperty --mdc-listitem-column-gap - Allows customization of column gap.\n * @cssproperty --mdc-listitem-padding-left-right - Allows customization of padding left and right.\n * @cssproperty --mdc-listitem-padding-top-bottom - Allows customization of padding top and bottom.\n * @cssproperty --mdc-listitem-cursor - Allows customization of the cursor.\n * @cssproperty --mdc-listitem-width - Allows customization of the width of the list item.\n * @cssproperty --mdc-listitem-height - Allows customization of the height of the list item.\n *\n * @csspart leading - Allows customization of the leading part.\n * @csspart leading-text - Allows customization of the leading text part.\n * @csspart trailing - Allows customization of the trailing part.\n * @csspart trailing-text - Allows customization of the trailing text part.\n *\n * @event click - (React: onClick) This event is dispatched when the listitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the listitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the listitem.\n * @event focus - (React: onFocus) This event is dispatched when the listitem receives focus.\n * @event enabled - (React: onEnabled) This event is dispatched after the listitem is enabled\n * @event disabled - (React: onDisabled) This event is dispatched after the listitem is disabled\n * @event created - (React: onCreated) This event is dispatched after the listitem is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched after the listitem is destroyed (removed from the DOM)\n */",
|
|
23843
23847
|
"customElement": true
|
|
23844
23848
|
}
|
|
23845
23849
|
],
|
|
@@ -23848,8 +23852,8 @@
|
|
|
23848
23852
|
"kind": "js",
|
|
23849
23853
|
"name": "default",
|
|
23850
23854
|
"declaration": {
|
|
23851
|
-
"name": "
|
|
23852
|
-
"module": "components/
|
|
23855
|
+
"name": "ListItem",
|
|
23856
|
+
"module": "components/listitem/listitem.component.js"
|
|
23853
23857
|
}
|
|
23854
23858
|
}
|
|
23855
23859
|
]
|