@momentum-design/components 0.62.1 → 0.62.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -492,6 +492,67 @@
492
492
  }
493
493
  ]
494
494
  },
495
+ {
496
+ "kind": "javascript-module",
497
+ "path": "components/appheader/appheader.component.js",
498
+ "declarations": [
499
+ {
500
+ "kind": "class",
501
+ "description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
502
+ "name": "Appheader",
503
+ "cssParts": [
504
+ {
505
+ "description": "The main container for styling the header.",
506
+ "name": "container"
507
+ },
508
+ {
509
+ "description": "The leading section of the header.",
510
+ "name": "leading-section"
511
+ },
512
+ {
513
+ "description": "The center section of the header.",
514
+ "name": "center-section"
515
+ },
516
+ {
517
+ "description": "The trailing section of the header.",
518
+ "name": "trailing-section"
519
+ }
520
+ ],
521
+ "slots": [
522
+ {
523
+ "description": "Slot for the leading section (e.g., brand logo, brand name).",
524
+ "name": "leading"
525
+ },
526
+ {
527
+ "description": "Slot for the center section (e.g., search bar, icons).",
528
+ "name": "center"
529
+ },
530
+ {
531
+ "description": "Slot for the trailing section (e.g., profile avatar, icons).",
532
+ "name": "trailing"
533
+ }
534
+ ],
535
+ "members": [],
536
+ "superclass": {
537
+ "name": "Component",
538
+ "module": "/src/models"
539
+ },
540
+ "tagName": "mdc-appheader",
541
+ "jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
542
+ "customElement": true
543
+ }
544
+ ],
545
+ "exports": [
546
+ {
547
+ "kind": "js",
548
+ "name": "default",
549
+ "declaration": {
550
+ "name": "Appheader",
551
+ "module": "components/appheader/appheader.component.js"
552
+ }
553
+ }
554
+ ]
555
+ },
495
556
  {
496
557
  "kind": "javascript-module",
497
558
  "path": "components/avatar/avatar.component.js",
@@ -736,67 +797,6 @@
736
797
  }
737
798
  ]
738
799
  },
739
- {
740
- "kind": "javascript-module",
741
- "path": "components/appheader/appheader.component.js",
742
- "declarations": [
743
- {
744
- "kind": "class",
745
- "description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
746
- "name": "Appheader",
747
- "cssParts": [
748
- {
749
- "description": "The main container for styling the header.",
750
- "name": "container"
751
- },
752
- {
753
- "description": "The leading section of the header.",
754
- "name": "leading-section"
755
- },
756
- {
757
- "description": "The center section of the header.",
758
- "name": "center-section"
759
- },
760
- {
761
- "description": "The trailing section of the header.",
762
- "name": "trailing-section"
763
- }
764
- ],
765
- "slots": [
766
- {
767
- "description": "Slot for the leading section (e.g., brand logo, brand name).",
768
- "name": "leading"
769
- },
770
- {
771
- "description": "Slot for the center section (e.g., search bar, icons).",
772
- "name": "center"
773
- },
774
- {
775
- "description": "Slot for the trailing section (e.g., profile avatar, icons).",
776
- "name": "trailing"
777
- }
778
- ],
779
- "members": [],
780
- "superclass": {
781
- "name": "Component",
782
- "module": "/src/models"
783
- },
784
- "tagName": "mdc-appheader",
785
- "jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
786
- "customElement": true
787
- }
788
- ],
789
- "exports": [
790
- {
791
- "kind": "js",
792
- "name": "default",
793
- "declaration": {
794
- "name": "Appheader",
795
- "module": "components/appheader/appheader.component.js"
796
- }
797
- }
798
- ]
799
- },
800
800
  {
801
801
  "kind": "javascript-module",
802
802
  "path": "components/avatarbutton/avatarbutton.component.js",
@@ -4185,228 +4185,240 @@
4185
4185
  },
4186
4186
  {
4187
4187
  "kind": "javascript-module",
4188
- "path": "components/chip/chip.component.js",
4188
+ "path": "components/coachmark/coachmark.component.js",
4189
4189
  "declarations": [
4190
4190
  {
4191
4191
  "kind": "class",
4192
- "description": "mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\nConsumers can wrap this component around a tooltip to provide additional context.\n\nIt is recommended to keep the label text for the chip component concise and compact.\nFor best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.\n\nThis component is built by extending Buttonsimple.",
4193
- "name": "Chip",
4192
+ "description": "Coachmark component based on top of the popover component,\nwith the default value of certain properties changed.",
4193
+ "name": "Coachmark",
4194
4194
  "cssProperties": [
4195
4195
  {
4196
- "description": "The color of the chip.",
4197
- "name": "--mdc-chip-color"
4196
+ "description": "radius of the arrow border",
4197
+ "name": "--mdc-popover-arrow-border-radius",
4198
+ "inheritedFrom": {
4199
+ "name": "Popover",
4200
+ "module": "src/components/popover/popover.component.ts"
4201
+ }
4198
4202
  },
4199
4203
  {
4200
- "description": "The border color of the chip.",
4201
- "name": "--mdc-chip-border-color"
4204
+ "description": "border of the arrow",
4205
+ "name": "--mdc-popover-arrow-border",
4206
+ "inheritedFrom": {
4207
+ "name": "Popover",
4208
+ "module": "src/components/popover/popover.component.ts"
4209
+ }
4202
4210
  },
4203
4211
  {
4204
- "description": "The background color of the chip.",
4205
- "name": "--mdc-chip-background-color"
4206
- }
4207
- ],
4208
- "members": [
4209
- {
4210
- "kind": "field",
4211
- "name": "color",
4212
- "type": {
4213
- "text": "ColorType"
4214
- },
4215
- "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- pink\n- purple\n- slate\n- violet",
4216
- "default": "default",
4217
- "attribute": "color",
4218
- "reflects": true
4212
+ "description": "primary background color of the popover",
4213
+ "name": "--mdc-popover-primary-background-color",
4214
+ "inheritedFrom": {
4215
+ "name": "Popover",
4216
+ "module": "src/components/popover/popover.component.ts"
4217
+ }
4219
4218
  },
4220
4219
  {
4221
- "kind": "field",
4222
- "name": "label",
4223
- "type": {
4224
- "text": "string"
4225
- },
4226
- "default": "''",
4227
- "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
4228
- "attribute": "label"
4220
+ "description": "border color of the popover",
4221
+ "name": "--mdc-popover-border-color",
4222
+ "inheritedFrom": {
4223
+ "name": "Popover",
4224
+ "module": "src/components/popover/popover.component.ts"
4225
+ }
4229
4226
  },
4230
4227
  {
4231
- "kind": "method",
4232
- "name": "renderIcon",
4233
- "privacy": "private",
4234
- "description": "Renders the icon element if available.",
4235
- "return": {
4236
- "type": {
4237
- "text": ""
4238
- }
4228
+ "description": "inverted background color of the popover",
4229
+ "name": "--mdc-popover-inverted-background-color",
4230
+ "inheritedFrom": {
4231
+ "name": "Popover",
4232
+ "module": "src/components/popover/popover.component.ts"
4239
4233
  }
4240
4234
  },
4241
4235
  {
4242
- "kind": "field",
4243
- "name": "iconName",
4244
- "type": {
4245
- "text": "IconNames | undefined"
4246
- },
4247
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
4248
- "attribute": "icon-name",
4236
+ "description": "inverted border color of the popover",
4237
+ "name": "--mdc-popover-inverted-border-color",
4249
4238
  "inheritedFrom": {
4250
- "name": "IconNameMixin",
4251
- "module": "utils/mixins/IconNameMixin.js"
4239
+ "name": "Popover",
4240
+ "module": "src/components/popover/popover.component.ts"
4252
4241
  }
4253
4242
  },
4254
4243
  {
4255
- "kind": "field",
4256
- "name": "tabIndex",
4257
- "type": {
4258
- "text": "number"
4259
- },
4260
- "default": "0",
4261
- "description": "This property specifies the tab order of the element.",
4262
- "attribute": "tabIndex",
4263
- "reflects": true,
4244
+ "description": "inverted text color of the popover",
4245
+ "name": "--mdc-popover-inverted-text-color",
4264
4246
  "inheritedFrom": {
4265
- "name": "Buttonsimple",
4266
- "module": "components/buttonsimple/buttonsimple.component.js"
4247
+ "name": "Popover",
4248
+ "module": "src/components/popover/popover.component.ts"
4267
4249
  }
4268
4250
  },
4269
4251
  {
4270
- "kind": "field",
4271
- "name": "disabled",
4272
- "type": {
4273
- "text": "boolean | undefined"
4274
- },
4275
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
4276
- "default": "undefined",
4277
- "attribute": "disabled",
4278
- "reflects": true,
4252
+ "description": "elevation of the popover",
4253
+ "name": "--mdc-popover-elevation-3",
4279
4254
  "inheritedFrom": {
4280
- "name": "Buttonsimple",
4281
- "module": "components/buttonsimple/buttonsimple.component.js"
4255
+ "name": "Popover",
4256
+ "module": "src/components/popover/popover.component.ts"
4282
4257
  }
4283
4258
  },
4284
4259
  {
4285
- "kind": "field",
4286
- "name": "active",
4287
- "type": {
4288
- "text": "boolean | undefined"
4289
- },
4290
- "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.",
4291
- "default": "undefined",
4292
- "attribute": "active",
4293
- "reflects": true,
4260
+ "description": "max width of the popover",
4261
+ "name": "--mdc-popover-max-width",
4294
4262
  "inheritedFrom": {
4295
- "name": "Buttonsimple",
4296
- "module": "components/buttonsimple/buttonsimple.component.js"
4263
+ "name": "Popover",
4264
+ "module": "src/components/popover/popover.component.ts"
4297
4265
  }
4298
4266
  },
4299
4267
  {
4300
- "kind": "field",
4301
- "name": "softDisabled",
4302
- "type": {
4303
- "text": "boolean | undefined"
4304
- },
4305
- "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.",
4306
- "default": "undefined",
4307
- "attribute": "soft-disabled",
4268
+ "description": "max height of the popover",
4269
+ "name": "--mdc-popover-max-height",
4270
+ "inheritedFrom": {
4271
+ "name": "Popover",
4272
+ "module": "src/components/popover/popover.component.ts"
4273
+ }
4274
+ }
4275
+ ],
4276
+ "slots": [
4277
+ {
4278
+ "description": "Default slot for modal container",
4279
+ "name": "",
4280
+ "inheritedFrom": {
4281
+ "name": "Popover",
4282
+ "module": "src/components/popover/popover.component.ts"
4283
+ }
4284
+ }
4285
+ ],
4286
+ "members": [
4287
+ {
4288
+ "kind": "field",
4289
+ "name": "trigger",
4290
+ "type": {
4291
+ "text": "PopoverTrigger"
4292
+ },
4293
+ "description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
4294
+ "default": "manual",
4295
+ "attribute": "trigger",
4308
4296
  "reflects": true,
4309
4297
  "inheritedFrom": {
4310
- "name": "Buttonsimple",
4311
- "module": "components/buttonsimple/buttonsimple.component.js"
4298
+ "name": "Popover",
4299
+ "module": "components/popover/popover.component.js"
4312
4300
  }
4313
4301
  },
4314
4302
  {
4315
4303
  "kind": "field",
4316
- "name": "size",
4304
+ "name": "showArrow",
4317
4305
  "type": {
4318
- "text": "ButtonSize"
4306
+ "text": "boolean"
4319
4307
  },
4320
- "description": "Simplebutton size is a super set of all the sizes supported by children components.",
4321
- "default": "32",
4322
- "attribute": "size",
4308
+ "description": "The arrow visibility of the Coachmark.",
4309
+ "default": "true",
4310
+ "attribute": "show-arrow",
4323
4311
  "reflects": true,
4324
4312
  "inheritedFrom": {
4325
- "name": "Buttonsimple",
4326
- "module": "components/buttonsimple/buttonsimple.component.js"
4313
+ "name": "Popover",
4314
+ "module": "components/popover/popover.component.js"
4327
4315
  }
4328
4316
  },
4329
4317
  {
4330
4318
  "kind": "field",
4331
- "name": "role",
4332
- "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.",
4333
- "default": "button",
4334
- "attribute": "role",
4319
+ "name": "closeButton",
4320
+ "type": {
4321
+ "text": "boolean"
4322
+ },
4323
+ "description": "The close button visibility of the Coachmark.",
4324
+ "default": "true",
4325
+ "attribute": "close-button",
4335
4326
  "reflects": true,
4336
4327
  "inheritedFrom": {
4337
- "name": "Buttonsimple",
4338
- "module": "components/buttonsimple/buttonsimple.component.js"
4328
+ "name": "Popover",
4329
+ "module": "components/popover/popover.component.js"
4339
4330
  }
4340
4331
  },
4341
4332
  {
4342
4333
  "kind": "field",
4343
- "name": "ariaStateKey",
4334
+ "name": "disableAriaExpanded",
4344
4335
  "type": {
4345
- "text": "string | undefined"
4336
+ "text": "boolean"
4346
4337
  },
4347
- "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`",
4348
- "default": "'aria-pressed' (when)",
4349
- "attribute": "ariaStateKey",
4338
+ "description": "Disable aria-expanded attribute on trigger element.",
4339
+ "default": "true",
4340
+ "attribute": "disable-aria-expanded",
4350
4341
  "reflects": true,
4351
4342
  "inheritedFrom": {
4352
- "name": "Buttonsimple",
4353
- "module": "components/buttonsimple/buttonsimple.component.js"
4343
+ "name": "Popover",
4344
+ "module": "components/popover/popover.component.js"
4354
4345
  }
4355
4346
  },
4356
4347
  {
4357
4348
  "kind": "field",
4358
- "name": "type",
4349
+ "name": "enabledFocusTrap",
4359
4350
  "type": {
4360
- "text": "ButtonType"
4351
+ "text": "boolean"
4361
4352
  },
4362
- "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.",
4363
- "default": "button",
4364
- "attribute": "type",
4365
- "reflects": true,
4353
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
4354
+ "default": "false",
4355
+ "attribute": "enabledFocusTrap",
4366
4356
  "inheritedFrom": {
4367
- "name": "Buttonsimple",
4368
- "module": "components/buttonsimple/buttonsimple.component.js"
4357
+ "name": "FocusTrapMixin",
4358
+ "module": "utils/mixins/FocusTrapMixin.js"
4359
+ }
4360
+ },
4361
+ {
4362
+ "kind": "field",
4363
+ "name": "enabledPreventScroll",
4364
+ "type": {
4365
+ "text": "boolean"
4366
+ },
4367
+ "description": "Prevent outside scrolling when popover show.",
4368
+ "default": "false",
4369
+ "attribute": "enabledPreventScroll",
4370
+ "inheritedFrom": {
4371
+ "name": "FocusTrapMixin",
4372
+ "module": "utils/mixins/FocusTrapMixin.js"
4373
+ }
4374
+ },
4375
+ {
4376
+ "kind": "field",
4377
+ "name": "shouldWrapFocus",
4378
+ "type": {
4379
+ "text": "() => boolean"
4380
+ },
4381
+ "inheritedFrom": {
4382
+ "name": "FocusTrapMixin",
4383
+ "module": "utils/mixins/FocusTrapMixin.js"
4369
4384
  }
4370
4385
  },
4371
4386
  {
4372
4387
  "kind": "method",
4373
- "name": "executeAction",
4374
- "privacy": "protected",
4388
+ "name": "deactivateFocusTrap",
4389
+ "description": "Deactivate the focus trap.",
4375
4390
  "inheritedFrom": {
4376
- "name": "Buttonsimple",
4377
- "module": "components/buttonsimple/buttonsimple.component.js"
4391
+ "name": "FocusTrapMixin",
4392
+ "module": "utils/mixins/FocusTrapMixin.js"
4378
4393
  }
4379
4394
  },
4380
4395
  {
4381
4396
  "kind": "method",
4382
- "name": "setActive",
4383
- "privacy": "protected",
4397
+ "name": "hasNoClientRects",
4398
+ "privacy": "private",
4384
4399
  "parameters": [
4385
4400
  {
4386
4401
  "name": "element",
4387
4402
  "type": {
4388
4403
  "text": "HTMLElement"
4389
4404
  },
4390
- "description": "The button element"
4391
- },
4392
- {
4393
- "name": "active",
4394
- "optional": true,
4395
- "type": {
4396
- "text": "boolean"
4397
- },
4398
- "description": "The active state of the element"
4405
+ "description": "The element to check."
4399
4406
  }
4400
4407
  ],
4401
- "description": "Sets the ariaStateKey attributes based on the active state of the button.",
4408
+ "description": "Checks if the element has no client rectangles (not visible in the viewport).",
4409
+ "return": {
4410
+ "type": {
4411
+ "text": ""
4412
+ }
4413
+ },
4402
4414
  "inheritedFrom": {
4403
- "name": "Buttonsimple",
4404
- "module": "components/buttonsimple/buttonsimple.component.js"
4415
+ "name": "FocusTrapMixin",
4416
+ "module": "utils/mixins/FocusTrapMixin.js"
4405
4417
  }
4406
4418
  },
4407
4419
  {
4408
4420
  "kind": "method",
4409
- "name": "setSoftDisabled",
4421
+ "name": "hasZeroDimensions",
4410
4422
  "privacy": "private",
4411
4423
  "parameters": [
4412
4424
  {
@@ -4414,26 +4426,23 @@
4414
4426
  "type": {
4415
4427
  "text": "HTMLElement"
4416
4428
  },
4417
- "description": "The button element."
4418
- },
4419
- {
4420
- "name": "softDisabled",
4421
- "optional": true,
4422
- "type": {
4423
- "text": "boolean"
4424
- },
4425
- "description": "The soft-disabled state."
4429
+ "description": "The element to check."
4426
4430
  }
4427
4431
  ],
4428
- "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.",
4432
+ "description": "Checks if the element has zero dimensions (width and height are both 0).",
4433
+ "return": {
4434
+ "type": {
4435
+ "text": ""
4436
+ }
4437
+ },
4429
4438
  "inheritedFrom": {
4430
- "name": "Buttonsimple",
4431
- "module": "components/buttonsimple/buttonsimple.component.js"
4439
+ "name": "FocusTrapMixin",
4440
+ "module": "utils/mixins/FocusTrapMixin.js"
4432
4441
  }
4433
4442
  },
4434
4443
  {
4435
4444
  "kind": "method",
4436
- "name": "setDisabled",
4445
+ "name": "isNotVisible",
4437
4446
  "privacy": "private",
4438
4447
  "parameters": [
4439
4448
  {
@@ -4441,387 +4450,449 @@
4441
4450
  "type": {
4442
4451
  "text": "HTMLElement"
4443
4452
  },
4444
- "description": "The button element."
4445
- },
4446
- {
4447
- "name": "disabled",
4448
- "type": {
4449
- "text": "boolean"
4450
- },
4451
- "description": "The disabled state."
4453
+ "description": "The element to check."
4452
4454
  }
4453
4455
  ],
4454
- "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.",
4455
- "inheritedFrom": {
4456
- "name": "Buttonsimple",
4457
- "module": "components/buttonsimple/buttonsimple.component.js"
4458
- }
4459
- },
4460
- {
4461
- "kind": "method",
4462
- "name": "triggerClickEvent",
4463
- "privacy": "private",
4456
+ "description": "Determines if the element is not visible in the DOM.",
4457
+ "return": {
4458
+ "type": {
4459
+ "text": ""
4460
+ }
4461
+ },
4464
4462
  "inheritedFrom": {
4465
- "name": "Buttonsimple",
4466
- "module": "components/buttonsimple/buttonsimple.component.js"
4463
+ "name": "FocusTrapMixin",
4464
+ "module": "utils/mixins/FocusTrapMixin.js"
4467
4465
  }
4468
4466
  },
4469
4467
  {
4470
4468
  "kind": "method",
4471
- "name": "handleBlur",
4469
+ "name": "hasHiddenStyle",
4472
4470
  "privacy": "private",
4473
- "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
4471
+ "parameters": [
4472
+ {
4473
+ "name": "element",
4474
+ "type": {
4475
+ "text": "HTMLElement"
4476
+ },
4477
+ "description": "The element to check."
4478
+ }
4479
+ ],
4480
+ "description": "Checks if the element has inline styles that make it hidden.",
4481
+ "return": {
4482
+ "type": {
4483
+ "text": ""
4484
+ }
4485
+ },
4474
4486
  "inheritedFrom": {
4475
- "name": "Buttonsimple",
4476
- "module": "components/buttonsimple/buttonsimple.component.js"
4487
+ "name": "FocusTrapMixin",
4488
+ "module": "utils/mixins/FocusTrapMixin.js"
4477
4489
  }
4478
4490
  },
4479
4491
  {
4480
4492
  "kind": "method",
4481
- "name": "handleKeyDown",
4493
+ "name": "hasComputedHidden",
4482
4494
  "privacy": "private",
4483
4495
  "parameters": [
4484
4496
  {
4485
- "name": "event",
4497
+ "name": "element",
4486
4498
  "type": {
4487
- "text": "KeyboardEvent"
4499
+ "text": "HTMLElement"
4488
4500
  },
4489
- "description": "The keyboard event."
4501
+ "description": "The element to check."
4490
4502
  }
4491
4503
  ],
4492
- "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.",
4504
+ "description": "Checks if the element is hidden by a computed style.",
4505
+ "return": {
4506
+ "type": {
4507
+ "text": ""
4508
+ }
4509
+ },
4493
4510
  "inheritedFrom": {
4494
- "name": "Buttonsimple",
4495
- "module": "components/buttonsimple/buttonsimple.component.js"
4511
+ "name": "FocusTrapMixin",
4512
+ "module": "utils/mixins/FocusTrapMixin.js"
4496
4513
  }
4497
4514
  },
4498
4515
  {
4499
4516
  "kind": "method",
4500
- "name": "handleKeyUp",
4517
+ "name": "isHidden",
4501
4518
  "privacy": "private",
4502
4519
  "parameters": [
4503
4520
  {
4504
- "name": "event",
4521
+ "name": "element",
4505
4522
  "type": {
4506
- "text": "KeyboardEvent"
4523
+ "text": "HTMLElement"
4507
4524
  },
4508
- "description": "The keyboard event."
4525
+ "description": "The element to check."
4509
4526
  }
4510
4527
  ],
4511
- "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.",
4512
- "inheritedFrom": {
4513
- "name": "Buttonsimple",
4514
- "module": "components/buttonsimple/buttonsimple.component.js"
4515
- }
4516
- }
4517
- ],
4518
- "attributes": [
4519
- {
4520
- "name": "color",
4521
- "type": {
4522
- "text": "ColorType"
4523
- },
4524
- "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- pink\n- purple\n- slate\n- violet",
4525
- "default": "default",
4526
- "fieldName": "color"
4527
- },
4528
- {
4529
- "name": "label",
4530
- "type": {
4531
- "text": "string"
4532
- },
4533
- "default": "''",
4534
- "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
4535
- "fieldName": "label"
4536
- },
4537
- {
4538
- "name": "icon-name",
4539
- "type": {
4540
- "text": "IconNames | undefined"
4528
+ "description": "Checks if the element is hidden from the user.",
4529
+ "return": {
4530
+ "type": {
4531
+ "text": ""
4532
+ }
4541
4533
  },
4542
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
4543
- "fieldName": "iconName",
4544
4534
  "inheritedFrom": {
4545
- "name": "IconNameMixin",
4546
- "module": "src/utils/mixins/IconNameMixin.ts"
4535
+ "name": "FocusTrapMixin",
4536
+ "module": "utils/mixins/FocusTrapMixin.js"
4547
4537
  }
4548
4538
  },
4549
4539
  {
4550
- "name": "tabIndex",
4551
- "type": {
4552
- "text": "number"
4540
+ "kind": "method",
4541
+ "name": "isNotTabbable",
4542
+ "privacy": "private",
4543
+ "parameters": [
4544
+ {
4545
+ "name": "element",
4546
+ "type": {
4547
+ "text": "HTMLElement"
4548
+ },
4549
+ "description": "The element to check."
4550
+ }
4551
+ ],
4552
+ "description": "Checks if the element is not tabbable.",
4553
+ "return": {
4554
+ "type": {
4555
+ "text": ""
4556
+ }
4553
4557
  },
4554
- "default": "0",
4555
- "description": "This property specifies the tab order of the element.",
4556
- "fieldName": "tabIndex",
4557
4558
  "inheritedFrom": {
4558
- "name": "Buttonsimple",
4559
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
4559
+ "name": "FocusTrapMixin",
4560
+ "module": "utils/mixins/FocusTrapMixin.js"
4560
4561
  }
4561
4562
  },
4562
4563
  {
4563
- "name": "disabled",
4564
- "type": {
4565
- "text": "boolean | undefined"
4564
+ "kind": "method",
4565
+ "name": "isInteractiveElement",
4566
+ "privacy": "private",
4567
+ "return": {
4568
+ "type": {
4569
+ "text": ""
4570
+ }
4566
4571
  },
4567
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
4568
- "default": "undefined",
4569
- "fieldName": "disabled",
4572
+ "parameters": [
4573
+ {
4574
+ "name": "element",
4575
+ "type": {
4576
+ "text": "HTMLElement"
4577
+ },
4578
+ "description": "The element to check."
4579
+ }
4580
+ ],
4581
+ "description": "Checks if the element is interactive.",
4570
4582
  "inheritedFrom": {
4571
- "name": "Buttonsimple",
4572
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
4583
+ "name": "FocusTrapMixin",
4584
+ "module": "utils/mixins/FocusTrapMixin.js"
4573
4585
  }
4574
4586
  },
4575
4587
  {
4576
- "name": "active",
4577
- "type": {
4578
- "text": "boolean | undefined"
4588
+ "kind": "method",
4589
+ "name": "isFocusable",
4590
+ "privacy": "private",
4591
+ "parameters": [
4592
+ {
4593
+ "name": "element",
4594
+ "type": {
4595
+ "text": "HTMLElement"
4596
+ },
4597
+ "description": "The element to check."
4598
+ }
4599
+ ],
4600
+ "description": "Checks if the element is focusable.",
4601
+ "return": {
4602
+ "type": {
4603
+ "text": ""
4604
+ }
4579
4605
  },
4580
- "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.",
4581
- "default": "undefined",
4582
- "fieldName": "active",
4583
4606
  "inheritedFrom": {
4584
- "name": "Buttonsimple",
4585
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
4607
+ "name": "FocusTrapMixin",
4608
+ "module": "utils/mixins/FocusTrapMixin.js"
4586
4609
  }
4587
4610
  },
4588
4611
  {
4589
- "name": "soft-disabled",
4590
- "type": {
4591
- "text": "boolean | undefined"
4612
+ "kind": "method",
4613
+ "name": "findFocusable",
4614
+ "privacy": "private",
4615
+ "return": {
4616
+ "type": {
4617
+ "text": ""
4618
+ }
4592
4619
  },
4593
- "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.",
4594
- "default": "undefined",
4595
- "fieldName": "softDisabled",
4620
+ "parameters": [
4621
+ {
4622
+ "name": "root",
4623
+ "type": {
4624
+ "text": "ShadowRoot | HTMLElement"
4625
+ },
4626
+ "description": "The root element to search for focusable elements."
4627
+ },
4628
+ {
4629
+ "name": "matches",
4630
+ "default": "new Set()",
4631
+ "type": {
4632
+ "text": "Set<HTMLElement>"
4633
+ },
4634
+ "description": "The set of focusable elements."
4635
+ }
4636
+ ],
4637
+ "description": "Recursively finds all focusable elements within the given root and its descendants.",
4596
4638
  "inheritedFrom": {
4597
- "name": "Buttonsimple",
4598
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
4639
+ "name": "FocusTrapMixin",
4640
+ "module": "utils/mixins/FocusTrapMixin.js"
4599
4641
  }
4600
4642
  },
4601
4643
  {
4602
- "name": "size",
4603
- "type": {
4604
- "text": "ButtonSize"
4605
- },
4606
- "description": "Simplebutton size is a super set of all the sizes supported by children components.",
4607
- "default": "32",
4608
- "fieldName": "size",
4644
+ "kind": "method",
4645
+ "name": "setFocusableElements",
4646
+ "privacy": "public",
4647
+ "description": "Updates the list of focusable elements within the component's shadow root.",
4609
4648
  "inheritedFrom": {
4610
- "name": "Buttonsimple",
4611
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
4649
+ "name": "FocusTrapMixin",
4650
+ "module": "utils/mixins/FocusTrapMixin.js"
4612
4651
  }
4613
4652
  },
4614
4653
  {
4615
- "name": "role",
4616
- "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.",
4617
- "default": "button",
4618
- "fieldName": "role",
4654
+ "kind": "method",
4655
+ "name": "setInitialFocus",
4656
+ "privacy": "public",
4657
+ "parameters": [
4658
+ {
4659
+ "name": "prefferableElement",
4660
+ "default": "0",
4661
+ "type": {
4662
+ "text": "number"
4663
+ },
4664
+ "description": "The index of the prefferable element to focus."
4665
+ }
4666
+ ],
4667
+ "description": "Sets the initial focus within the container.",
4619
4668
  "inheritedFrom": {
4620
- "name": "Buttonsimple",
4621
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
4669
+ "name": "FocusTrapMixin",
4670
+ "module": "utils/mixins/FocusTrapMixin.js"
4622
4671
  }
4623
4672
  },
4624
4673
  {
4625
- "name": "ariaStateKey",
4626
- "type": {
4627
- "text": "string | undefined"
4674
+ "kind": "method",
4675
+ "name": "calculateNextIndex",
4676
+ "privacy": "private",
4677
+ "parameters": [
4678
+ {
4679
+ "name": "currentIndex",
4680
+ "type": {
4681
+ "text": "number"
4682
+ },
4683
+ "description": "The current index."
4684
+ },
4685
+ {
4686
+ "name": "step",
4687
+ "type": {
4688
+ "text": "number"
4689
+ },
4690
+ "description": "The step to calculate the next index."
4691
+ }
4692
+ ],
4693
+ "description": "Calculates the next index for the focus trap.",
4694
+ "return": {
4695
+ "type": {
4696
+ "text": ""
4697
+ }
4628
4698
  },
4629
- "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`",
4630
- "default": "'aria-pressed' (when)",
4631
- "fieldName": "ariaStateKey",
4632
4699
  "inheritedFrom": {
4633
- "name": "Buttonsimple",
4634
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
4700
+ "name": "FocusTrapMixin",
4701
+ "module": "utils/mixins/FocusTrapMixin.js"
4635
4702
  }
4636
4703
  },
4637
4704
  {
4638
- "name": "type",
4639
- "type": {
4640
- "text": "ButtonType"
4705
+ "kind": "method",
4706
+ "name": "getDeepActiveElement",
4707
+ "privacy": "private",
4708
+ "description": "Returns the deepest active element in the shadow DOM.",
4709
+ "return": {
4710
+ "type": {
4711
+ "text": ""
4712
+ }
4641
4713
  },
4642
- "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.",
4643
- "default": "button",
4644
- "fieldName": "type",
4645
- "inheritedFrom": {
4646
- "name": "Buttonsimple",
4647
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
4648
- }
4649
- }
4650
- ],
4651
- "mixins": [
4652
- {
4653
- "name": "IconNameMixin",
4654
- "module": "/src/utils/mixins/IconNameMixin"
4655
- }
4656
- ],
4657
- "superclass": {
4658
- "name": "Buttonsimple",
4659
- "module": "/src/components/buttonsimple/buttonsimple.component"
4660
- },
4661
- "tagName": "mdc-chip",
4662
- "jsDoc": "/**\n * mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\n * Consumers can wrap this component around a tooltip to provide additional context.\n *\n * It is recommended to keep the label text for the chip component concise and compact.\n * For best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\n * including empty spaces to split words.\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-chip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the chip.\n * @cssproperty --mdc-chip-border-color - The border color of the chip.\n * @cssproperty --mdc-chip-background-color - The background color of the chip.\n *\n */",
4663
- "customElement": true,
4664
- "events": [
4665
- {
4666
- "description": "(React: onClick) This event is dispatched when the button is clicked.",
4667
- "name": "click",
4668
- "reactName": "onClick",
4669
- "inheritedFrom": {
4670
- "name": "Buttonsimple",
4671
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
4672
- }
4673
- },
4674
- {
4675
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
4676
- "name": "keydown",
4677
- "reactName": "onKeyDown",
4678
- "inheritedFrom": {
4679
- "name": "Buttonsimple",
4680
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
4681
- }
4682
- },
4683
- {
4684
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
4685
- "name": "keyup",
4686
- "reactName": "onKeyUp",
4687
- "inheritedFrom": {
4688
- "name": "Buttonsimple",
4689
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
4690
- }
4691
- },
4692
- {
4693
- "description": "(React: onFocus) This event is dispatched when the button receives focus.",
4694
- "name": "focus",
4695
- "reactName": "onFocus",
4696
4714
  "inheritedFrom": {
4697
- "name": "Buttonsimple",
4698
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
4699
- }
4700
- }
4701
- ]
4702
- }
4703
- ],
4704
- "exports": [
4705
- {
4706
- "kind": "js",
4707
- "name": "default",
4708
- "declaration": {
4709
- "name": "Chip",
4710
- "module": "components/chip/chip.component.js"
4711
- }
4712
- }
4713
- ]
4714
- },
4715
- {
4716
- "kind": "javascript-module",
4717
- "path": "components/coachmark/coachmark.component.js",
4718
- "declarations": [
4719
- {
4720
- "kind": "class",
4721
- "description": "Coachmark component based on top of the popover component,\nwith the default value of certain properties changed.",
4722
- "name": "Coachmark",
4723
- "cssProperties": [
4724
- {
4725
- "description": "radius of the arrow border",
4726
- "name": "--mdc-popover-arrow-border-radius",
4727
- "inheritedFrom": {
4728
- "name": "Popover",
4729
- "module": "src/components/popover/popover.component.ts"
4715
+ "name": "FocusTrapMixin",
4716
+ "module": "utils/mixins/FocusTrapMixin.js"
4730
4717
  }
4731
4718
  },
4732
4719
  {
4733
- "description": "border of the arrow",
4734
- "name": "--mdc-popover-arrow-border",
4720
+ "kind": "method",
4721
+ "name": "findElement",
4722
+ "privacy": "private",
4723
+ "parameters": [
4724
+ {
4725
+ "name": "activeElement",
4726
+ "type": {
4727
+ "text": "HTMLElement"
4728
+ },
4729
+ "description": "The active element."
4730
+ }
4731
+ ],
4732
+ "description": "Finds the index of the active element within the focusable elements.",
4733
+ "return": {
4734
+ "type": {
4735
+ "text": ""
4736
+ }
4737
+ },
4735
4738
  "inheritedFrom": {
4736
- "name": "Popover",
4737
- "module": "src/components/popover/popover.component.ts"
4739
+ "name": "FocusTrapMixin",
4740
+ "module": "utils/mixins/FocusTrapMixin.js"
4738
4741
  }
4739
4742
  },
4740
4743
  {
4741
- "description": "primary background color of the popover",
4742
- "name": "--mdc-popover-primary-background-color",
4744
+ "kind": "method",
4745
+ "name": "isEqualFocusNode",
4746
+ "privacy": "private",
4747
+ "parameters": [
4748
+ {
4749
+ "name": "activeElement",
4750
+ "type": {
4751
+ "text": "HTMLElement"
4752
+ },
4753
+ "description": "The active element."
4754
+ },
4755
+ {
4756
+ "name": "element",
4757
+ "type": {
4758
+ "text": "HTMLElement"
4759
+ },
4760
+ "description": "The element to compare."
4761
+ }
4762
+ ],
4763
+ "description": "Checks if the active element is equal to the given element.",
4764
+ "return": {
4765
+ "type": {
4766
+ "text": ""
4767
+ }
4768
+ },
4743
4769
  "inheritedFrom": {
4744
- "name": "Popover",
4745
- "module": "src/components/popover/popover.component.ts"
4770
+ "name": "FocusTrapMixin",
4771
+ "module": "utils/mixins/FocusTrapMixin.js"
4746
4772
  }
4747
4773
  },
4748
4774
  {
4749
- "description": "border color of the popover",
4750
- "name": "--mdc-popover-border-color",
4775
+ "kind": "method",
4776
+ "name": "trapFocus",
4777
+ "privacy": "private",
4778
+ "parameters": [
4779
+ {
4780
+ "name": "direction",
4781
+ "type": {
4782
+ "text": "boolean"
4783
+ },
4784
+ "description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element."
4785
+ }
4786
+ ],
4787
+ "description": "Traps focus within the container.",
4751
4788
  "inheritedFrom": {
4752
- "name": "Popover",
4753
- "module": "src/components/popover/popover.component.ts"
4789
+ "name": "FocusTrapMixin",
4790
+ "module": "utils/mixins/FocusTrapMixin.js"
4754
4791
  }
4755
4792
  },
4756
4793
  {
4757
- "description": "inverted background color of the popover",
4758
- "name": "--mdc-popover-inverted-background-color",
4794
+ "kind": "method",
4795
+ "name": "handleKeydown",
4796
+ "privacy": "private",
4797
+ "parameters": [
4798
+ {
4799
+ "name": "event",
4800
+ "type": {
4801
+ "text": "KeyboardEvent"
4802
+ },
4803
+ "description": "The keyboard event."
4804
+ }
4805
+ ],
4806
+ "description": "Traps focus within the container.",
4759
4807
  "inheritedFrom": {
4760
- "name": "Popover",
4761
- "module": "src/components/popover/popover.component.ts"
4808
+ "name": "FocusTrapMixin",
4809
+ "module": "utils/mixins/FocusTrapMixin.js"
4762
4810
  }
4763
4811
  },
4764
4812
  {
4765
- "description": "inverted border color of the popover",
4766
- "name": "--mdc-popover-inverted-border-color",
4813
+ "kind": "field",
4814
+ "name": "id",
4815
+ "type": {
4816
+ "text": "string"
4817
+ },
4818
+ "default": "''",
4819
+ "description": "The unique ID of the popover.",
4820
+ "attribute": "id",
4821
+ "reflects": true,
4767
4822
  "inheritedFrom": {
4768
4823
  "name": "Popover",
4769
- "module": "src/components/popover/popover.component.ts"
4824
+ "module": "components/popover/popover.component.js"
4770
4825
  }
4771
4826
  },
4772
4827
  {
4773
- "description": "inverted text color of the popover",
4774
- "name": "--mdc-popover-inverted-text-color",
4828
+ "kind": "field",
4829
+ "name": "triggerID",
4830
+ "type": {
4831
+ "text": "string"
4832
+ },
4833
+ "default": "''",
4834
+ "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
4835
+ "attribute": "triggerID",
4836
+ "reflects": true,
4775
4837
  "inheritedFrom": {
4776
4838
  "name": "Popover",
4777
- "module": "src/components/popover/popover.component.ts"
4839
+ "module": "components/popover/popover.component.js"
4778
4840
  }
4779
4841
  },
4780
4842
  {
4781
- "description": "elevation of the popover",
4782
- "name": "--mdc-popover-elevation-3",
4843
+ "kind": "field",
4844
+ "name": "placement",
4845
+ "type": {
4846
+ "text": "PopoverPlacement"
4847
+ },
4848
+ "description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
4849
+ "default": "bottom",
4850
+ "attribute": "placement",
4851
+ "reflects": true,
4783
4852
  "inheritedFrom": {
4784
4853
  "name": "Popover",
4785
- "module": "src/components/popover/popover.component.ts"
4854
+ "module": "components/popover/popover.component.js"
4786
4855
  }
4787
4856
  },
4788
4857
  {
4789
- "description": "max width of the popover",
4790
- "name": "--mdc-popover-max-width",
4858
+ "kind": "field",
4859
+ "name": "color",
4860
+ "type": {
4861
+ "text": "PopoverColor"
4862
+ },
4863
+ "description": "Color of the popover\n- **tonal**\n- **contrast**",
4864
+ "default": "tonal",
4865
+ "attribute": "color",
4866
+ "reflects": true,
4791
4867
  "inheritedFrom": {
4792
4868
  "name": "Popover",
4793
- "module": "src/components/popover/popover.component.ts"
4869
+ "module": "components/popover/popover.component.js"
4794
4870
  }
4795
4871
  },
4796
4872
  {
4797
- "description": "max height of the popover",
4798
- "name": "--mdc-popover-max-height",
4799
- "inheritedFrom": {
4800
- "name": "Popover",
4801
- "module": "src/components/popover/popover.component.ts"
4802
- }
4803
- }
4804
- ],
4805
- "slots": [
4806
- {
4807
- "description": "Default slot for modal container",
4808
- "name": "",
4873
+ "kind": "field",
4874
+ "name": "visible",
4875
+ "type": {
4876
+ "text": "boolean"
4877
+ },
4878
+ "description": "The visibility of the popover.",
4879
+ "default": "false",
4880
+ "attribute": "visible",
4881
+ "reflects": true,
4809
4882
  "inheritedFrom": {
4810
4883
  "name": "Popover",
4811
- "module": "src/components/popover/popover.component.ts"
4884
+ "module": "components/popover/popover.component.js"
4812
4885
  }
4813
- }
4814
- ],
4815
- "members": [
4886
+ },
4816
4887
  {
4817
4888
  "kind": "field",
4818
- "name": "trigger",
4889
+ "name": "offset",
4819
4890
  "type": {
4820
- "text": "PopoverTrigger"
4891
+ "text": "number"
4821
4892
  },
4822
- "description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
4823
- "default": "manual",
4824
- "attribute": "trigger",
4893
+ "description": "The offset of the popover.",
4894
+ "default": "4",
4895
+ "attribute": "offset",
4825
4896
  "reflects": true,
4826
4897
  "inheritedFrom": {
4827
4898
  "name": "Popover",
@@ -4830,13 +4901,13 @@
4830
4901
  },
4831
4902
  {
4832
4903
  "kind": "field",
4833
- "name": "showArrow",
4904
+ "name": "focusTrap",
4834
4905
  "type": {
4835
4906
  "text": "boolean"
4836
4907
  },
4837
- "description": "The arrow visibility of the Coachmark.",
4838
- "default": "true",
4839
- "attribute": "show-arrow",
4908
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
4909
+ "default": "false",
4910
+ "attribute": "focus-trap",
4840
4911
  "reflects": true,
4841
4912
  "inheritedFrom": {
4842
4913
  "name": "Popover",
@@ -4845,13 +4916,13 @@
4845
4916
  },
4846
4917
  {
4847
4918
  "kind": "field",
4848
- "name": "closeButton",
4919
+ "name": "preventScroll",
4849
4920
  "type": {
4850
4921
  "text": "boolean"
4851
4922
  },
4852
- "description": "The close button visibility of the Coachmark.",
4853
- "default": "true",
4854
- "attribute": "close-button",
4923
+ "description": "Prevent outside scrolling when popover show.",
4924
+ "default": "false",
4925
+ "attribute": "prevent-scroll",
4855
4926
  "reflects": true,
4856
4927
  "inheritedFrom": {
4857
4928
  "name": "Popover",
@@ -4860,13 +4931,13 @@
4860
4931
  },
4861
4932
  {
4862
4933
  "kind": "field",
4863
- "name": "disableAriaExpanded",
4934
+ "name": "interactive",
4864
4935
  "type": {
4865
4936
  "text": "boolean"
4866
4937
  },
4867
- "description": "Disable aria-expanded attribute on trigger element.",
4868
- "default": "true",
4869
- "attribute": "disable-aria-expanded",
4938
+ "description": "Determines whether the popover is interactive。",
4939
+ "default": "false",
4940
+ "attribute": "interactive",
4870
4941
  "reflects": true,
4871
4942
  "inheritedFrom": {
4872
4943
  "name": "Popover",
@@ -4875,479 +4946,339 @@
4875
4946
  },
4876
4947
  {
4877
4948
  "kind": "field",
4878
- "name": "enabledFocusTrap",
4949
+ "name": "delay",
4879
4950
  "type": {
4880
- "text": "boolean"
4951
+ "text": "string"
4881
4952
  },
4882
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
4883
- "default": "false",
4884
- "attribute": "enabledFocusTrap",
4953
+ "description": "The delay of the show/hide popover.",
4954
+ "default": "0,0",
4955
+ "attribute": "delay",
4956
+ "reflects": true,
4885
4957
  "inheritedFrom": {
4886
- "name": "FocusTrapMixin",
4887
- "module": "utils/mixins/FocusTrapMixin.js"
4958
+ "name": "Popover",
4959
+ "module": "components/popover/popover.component.js"
4888
4960
  }
4889
4961
  },
4890
4962
  {
4891
4963
  "kind": "field",
4892
- "name": "enabledPreventScroll",
4964
+ "name": "hideOnEscape",
4893
4965
  "type": {
4894
4966
  "text": "boolean"
4895
4967
  },
4896
- "description": "Prevent outside scrolling when popover show.",
4968
+ "description": "Hide popover on escape key press.",
4897
4969
  "default": "false",
4898
- "attribute": "enabledPreventScroll",
4970
+ "attribute": "hide-on-escape",
4971
+ "reflects": true,
4899
4972
  "inheritedFrom": {
4900
- "name": "FocusTrapMixin",
4901
- "module": "utils/mixins/FocusTrapMixin.js"
4973
+ "name": "Popover",
4974
+ "module": "components/popover/popover.component.js"
4902
4975
  }
4903
4976
  },
4904
4977
  {
4905
4978
  "kind": "field",
4906
- "name": "shouldWrapFocus",
4979
+ "name": "hideOnBlur",
4907
4980
  "type": {
4908
- "text": "() => boolean"
4981
+ "text": "boolean"
4909
4982
  },
4983
+ "description": "Hide popover on blur.",
4984
+ "default": "false",
4985
+ "attribute": "hide-on-blur",
4986
+ "reflects": true,
4910
4987
  "inheritedFrom": {
4911
- "name": "FocusTrapMixin",
4912
- "module": "utils/mixins/FocusTrapMixin.js"
4913
- }
4914
- },
4915
- {
4916
- "kind": "method",
4917
- "name": "deactivateFocusTrap",
4918
- "description": "Deactivate the focus trap.",
4919
- "inheritedFrom": {
4920
- "name": "FocusTrapMixin",
4921
- "module": "utils/mixins/FocusTrapMixin.js"
4988
+ "name": "Popover",
4989
+ "module": "components/popover/popover.component.js"
4922
4990
  }
4923
4991
  },
4924
4992
  {
4925
- "kind": "method",
4926
- "name": "hasNoClientRects",
4927
- "privacy": "private",
4928
- "parameters": [
4929
- {
4930
- "name": "element",
4931
- "type": {
4932
- "text": "HTMLElement"
4933
- },
4934
- "description": "The element to check."
4935
- }
4936
- ],
4937
- "description": "Checks if the element has no client rectangles (not visible in the viewport).",
4938
- "return": {
4939
- "type": {
4940
- "text": ""
4941
- }
4993
+ "kind": "field",
4994
+ "name": "hideOnOutsideClick",
4995
+ "type": {
4996
+ "text": "boolean"
4942
4997
  },
4998
+ "description": "Hide on outside click of the popover.",
4999
+ "default": "false",
5000
+ "attribute": "hide-on-outside-click",
5001
+ "reflects": true,
4943
5002
  "inheritedFrom": {
4944
- "name": "FocusTrapMixin",
4945
- "module": "utils/mixins/FocusTrapMixin.js"
5003
+ "name": "Popover",
5004
+ "module": "components/popover/popover.component.js"
4946
5005
  }
4947
5006
  },
4948
5007
  {
4949
- "kind": "method",
4950
- "name": "hasZeroDimensions",
4951
- "privacy": "private",
4952
- "parameters": [
4953
- {
4954
- "name": "element",
4955
- "type": {
4956
- "text": "HTMLElement"
4957
- },
4958
- "description": "The element to check."
4959
- }
4960
- ],
4961
- "description": "Checks if the element has zero dimensions (width and height are both 0).",
4962
- "return": {
4963
- "type": {
4964
- "text": ""
4965
- }
5008
+ "kind": "field",
5009
+ "name": "focusBackToTrigger",
5010
+ "type": {
5011
+ "text": "boolean"
4966
5012
  },
5013
+ "description": "The focus back to trigger after the popover hide.",
5014
+ "default": "false",
5015
+ "attribute": "focus-back-to-trigger",
5016
+ "reflects": true,
4967
5017
  "inheritedFrom": {
4968
- "name": "FocusTrapMixin",
4969
- "module": "utils/mixins/FocusTrapMixin.js"
5018
+ "name": "Popover",
5019
+ "module": "components/popover/popover.component.js"
4970
5020
  }
4971
5021
  },
4972
5022
  {
4973
- "kind": "method",
4974
- "name": "isNotVisible",
4975
- "privacy": "private",
4976
- "parameters": [
4977
- {
4978
- "name": "element",
4979
- "type": {
4980
- "text": "HTMLElement"
4981
- },
4982
- "description": "The element to check."
4983
- }
4984
- ],
4985
- "description": "Determines if the element is not visible in the DOM.",
4986
- "return": {
4987
- "type": {
4988
- "text": ""
4989
- }
5023
+ "kind": "field",
5024
+ "name": "backdrop",
5025
+ "type": {
5026
+ "text": "boolean"
4990
5027
  },
5028
+ "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
5029
+ "default": "false",
5030
+ "attribute": "backdrop",
5031
+ "reflects": true,
4991
5032
  "inheritedFrom": {
4992
- "name": "FocusTrapMixin",
4993
- "module": "utils/mixins/FocusTrapMixin.js"
5033
+ "name": "Popover",
5034
+ "module": "components/popover/popover.component.js"
4994
5035
  }
4995
5036
  },
4996
5037
  {
4997
- "kind": "method",
4998
- "name": "hasHiddenStyle",
4999
- "privacy": "private",
5000
- "parameters": [
5001
- {
5002
- "name": "element",
5003
- "type": {
5004
- "text": "HTMLElement"
5005
- },
5006
- "description": "The element to check."
5007
- }
5008
- ],
5009
- "description": "Checks if the element has inline styles that make it hidden.",
5010
- "return": {
5011
- "type": {
5012
- "text": ""
5013
- }
5038
+ "kind": "field",
5039
+ "name": "flip",
5040
+ "type": {
5041
+ "text": "boolean"
5014
5042
  },
5043
+ "description": "Changes the placement of popover to keep it in view when scrolling.",
5044
+ "default": "true",
5045
+ "attribute": "flip",
5046
+ "reflects": true,
5015
5047
  "inheritedFrom": {
5016
- "name": "FocusTrapMixin",
5017
- "module": "utils/mixins/FocusTrapMixin.js"
5048
+ "name": "Popover",
5049
+ "module": "components/popover/popover.component.js"
5018
5050
  }
5019
5051
  },
5020
5052
  {
5021
- "kind": "method",
5022
- "name": "hasComputedHidden",
5023
- "privacy": "private",
5024
- "parameters": [
5025
- {
5026
- "name": "element",
5027
- "type": {
5028
- "text": "HTMLElement"
5029
- },
5030
- "description": "The element to check."
5031
- }
5032
- ],
5033
- "description": "Checks if the element is hidden by a computed style.",
5034
- "return": {
5035
- "type": {
5036
- "text": ""
5037
- }
5053
+ "kind": "field",
5054
+ "name": "size",
5055
+ "type": {
5056
+ "text": "boolean"
5038
5057
  },
5058
+ "description": "Changes the size of popover to keep it in view when scrolling.",
5059
+ "default": "false",
5060
+ "attribute": "size",
5061
+ "reflects": true,
5039
5062
  "inheritedFrom": {
5040
- "name": "FocusTrapMixin",
5041
- "module": "utils/mixins/FocusTrapMixin.js"
5063
+ "name": "Popover",
5064
+ "module": "components/popover/popover.component.js"
5042
5065
  }
5043
5066
  },
5044
5067
  {
5045
- "kind": "method",
5046
- "name": "isHidden",
5047
- "privacy": "private",
5048
- "parameters": [
5049
- {
5050
- "name": "element",
5051
- "type": {
5052
- "text": "HTMLElement"
5053
- },
5054
- "description": "The element to check."
5055
- }
5056
- ],
5057
- "description": "Checks if the element is hidden from the user.",
5058
- "return": {
5059
- "type": {
5060
- "text": ""
5061
- }
5068
+ "kind": "field",
5069
+ "name": "zIndex",
5070
+ "type": {
5071
+ "text": "number"
5072
+ },
5073
+ "description": "The z-index of the popover.",
5074
+ "default": "1000",
5075
+ "attribute": "z-index",
5076
+ "reflects": true,
5077
+ "inheritedFrom": {
5078
+ "name": "Popover",
5079
+ "module": "components/popover/popover.component.js"
5080
+ }
5081
+ },
5082
+ {
5083
+ "kind": "field",
5084
+ "name": "appendTo",
5085
+ "type": {
5086
+ "text": "string"
5062
5087
  },
5088
+ "default": "''",
5089
+ "description": "Element ID that the popover append to.",
5090
+ "attribute": "append-to",
5091
+ "reflects": true,
5063
5092
  "inheritedFrom": {
5064
- "name": "FocusTrapMixin",
5065
- "module": "utils/mixins/FocusTrapMixin.js"
5093
+ "name": "Popover",
5094
+ "module": "components/popover/popover.component.js"
5066
5095
  }
5067
5096
  },
5068
5097
  {
5069
- "kind": "method",
5070
- "name": "isNotTabbable",
5071
- "privacy": "private",
5072
- "parameters": [
5073
- {
5074
- "name": "element",
5075
- "type": {
5076
- "text": "HTMLElement"
5077
- },
5078
- "description": "The element to check."
5079
- }
5080
- ],
5081
- "description": "Checks if the element is not tabbable.",
5082
- "return": {
5083
- "type": {
5084
- "text": ""
5085
- }
5098
+ "kind": "field",
5099
+ "name": "closeButtonAriaLabel",
5100
+ "type": {
5101
+ "text": "string | null"
5086
5102
  },
5103
+ "default": "null",
5104
+ "description": "aria-label attribute to be set for close button accessibility.",
5105
+ "attribute": "close-button-aria-label",
5106
+ "reflects": true,
5087
5107
  "inheritedFrom": {
5088
- "name": "FocusTrapMixin",
5089
- "module": "utils/mixins/FocusTrapMixin.js"
5108
+ "name": "Popover",
5109
+ "module": "components/popover/popover.component.js"
5090
5110
  }
5091
5111
  },
5092
5112
  {
5093
- "kind": "method",
5094
- "name": "isInteractiveElement",
5095
- "privacy": "private",
5096
- "return": {
5097
- "type": {
5098
- "text": ""
5099
- }
5113
+ "kind": "field",
5114
+ "name": "role",
5115
+ "type": {
5116
+ "text": "HTMLElement['role']"
5100
5117
  },
5101
- "parameters": [
5102
- {
5103
- "name": "element",
5104
- "type": {
5105
- "text": "HTMLElement"
5106
- },
5107
- "description": "The element to check."
5108
- }
5109
- ],
5110
- "description": "Checks if the element is interactive.",
5118
+ "description": "Role of the popover",
5119
+ "default": "dialog",
5120
+ "attribute": "role",
5121
+ "reflects": true,
5111
5122
  "inheritedFrom": {
5112
- "name": "FocusTrapMixin",
5113
- "module": "utils/mixins/FocusTrapMixin.js"
5123
+ "name": "Popover",
5124
+ "module": "components/popover/popover.component.js"
5114
5125
  }
5115
5126
  },
5116
5127
  {
5117
- "kind": "method",
5118
- "name": "isFocusable",
5119
- "privacy": "private",
5120
- "parameters": [
5121
- {
5122
- "name": "element",
5123
- "type": {
5124
- "text": "HTMLElement"
5125
- },
5126
- "description": "The element to check."
5127
- }
5128
- ],
5129
- "description": "Checks if the element is focusable.",
5130
- "return": {
5131
- "type": {
5132
- "text": ""
5133
- }
5128
+ "kind": "field",
5129
+ "name": "ariaLabelledby",
5130
+ "type": {
5131
+ "text": "string | null"
5134
5132
  },
5133
+ "default": "null",
5134
+ "description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
5135
+ "attribute": "aria-labelledby",
5136
+ "reflects": true,
5135
5137
  "inheritedFrom": {
5136
- "name": "FocusTrapMixin",
5137
- "module": "utils/mixins/FocusTrapMixin.js"
5138
+ "name": "Popover",
5139
+ "module": "components/popover/popover.component.js"
5138
5140
  }
5139
5141
  },
5140
5142
  {
5141
- "kind": "method",
5142
- "name": "findFocusable",
5143
- "privacy": "private",
5144
- "return": {
5145
- "type": {
5146
- "text": ""
5147
- }
5143
+ "kind": "field",
5144
+ "name": "ariaDescribedby",
5145
+ "type": {
5146
+ "text": "string | null"
5148
5147
  },
5149
- "parameters": [
5150
- {
5151
- "name": "root",
5152
- "type": {
5153
- "text": "ShadowRoot | HTMLElement"
5154
- },
5155
- "description": "The root element to search for focusable elements."
5156
- },
5157
- {
5158
- "name": "matches",
5159
- "default": "new Set()",
5160
- "type": {
5161
- "text": "Set<HTMLElement>"
5162
- },
5163
- "description": "The set of focusable elements."
5164
- }
5165
- ],
5166
- "description": "Recursively finds all focusable elements within the given root and its descendants.",
5148
+ "default": "null",
5149
+ "description": "aria-describedby of the popover.",
5150
+ "attribute": "aria-describedby",
5151
+ "reflects": true,
5167
5152
  "inheritedFrom": {
5168
- "name": "FocusTrapMixin",
5169
- "module": "utils/mixins/FocusTrapMixin.js"
5153
+ "name": "Popover",
5154
+ "module": "components/popover/popover.component.js"
5170
5155
  }
5171
5156
  },
5172
5157
  {
5173
- "kind": "method",
5174
- "name": "setFocusableElements",
5158
+ "kind": "field",
5159
+ "name": "arrowElement",
5160
+ "type": {
5161
+ "text": "HTMLElement | null"
5162
+ },
5175
5163
  "privacy": "public",
5176
- "description": "Updates the list of focusable elements within the component's shadow root.",
5164
+ "default": "null",
5177
5165
  "inheritedFrom": {
5178
- "name": "FocusTrapMixin",
5179
- "module": "utils/mixins/FocusTrapMixin.js"
5166
+ "name": "Popover",
5167
+ "module": "components/popover/popover.component.js"
5180
5168
  }
5181
5169
  },
5182
5170
  {
5183
- "kind": "method",
5184
- "name": "setInitialFocus",
5171
+ "kind": "field",
5172
+ "name": "triggerElement",
5173
+ "type": {
5174
+ "text": "HTMLElement | null"
5175
+ },
5185
5176
  "privacy": "public",
5186
- "parameters": [
5187
- {
5188
- "name": "prefferableElement",
5189
- "default": "0",
5190
- "type": {
5191
- "text": "number"
5192
- },
5193
- "description": "The index of the prefferable element to focus."
5194
- }
5195
- ],
5196
- "description": "Sets the initial focus within the container.",
5177
+ "default": "null",
5197
5178
  "inheritedFrom": {
5198
- "name": "FocusTrapMixin",
5199
- "module": "utils/mixins/FocusTrapMixin.js"
5179
+ "name": "Popover",
5180
+ "module": "components/popover/popover.component.js"
5200
5181
  }
5201
5182
  },
5202
5183
  {
5203
5184
  "kind": "method",
5204
- "name": "calculateNextIndex",
5185
+ "name": "setupTriggerListener",
5205
5186
  "privacy": "private",
5206
- "parameters": [
5207
- {
5208
- "name": "currentIndex",
5209
- "type": {
5210
- "text": "number"
5211
- },
5212
- "description": "The current index."
5213
- },
5214
- {
5215
- "name": "step",
5216
- "type": {
5217
- "text": "number"
5218
- },
5219
- "description": "The step to calculate the next index."
5220
- }
5221
- ],
5222
- "description": "Calculates the next index for the focus trap.",
5223
- "return": {
5224
- "type": {
5225
- "text": ""
5226
- }
5227
- },
5187
+ "description": "Sets up the trigger event listeners based on the trigger type.",
5228
5188
  "inheritedFrom": {
5229
- "name": "FocusTrapMixin",
5230
- "module": "utils/mixins/FocusTrapMixin.js"
5189
+ "name": "Popover",
5190
+ "module": "components/popover/popover.component.js"
5231
5191
  }
5232
5192
  },
5233
5193
  {
5234
5194
  "kind": "method",
5235
- "name": "getDeepActiveElement",
5195
+ "name": "removeEventListeners",
5236
5196
  "privacy": "private",
5237
- "description": "Returns the deepest active element in the shadow DOM.",
5238
- "return": {
5239
- "type": {
5240
- "text": ""
5241
- }
5242
- },
5197
+ "description": "Removes the trigger event listeners.",
5243
5198
  "inheritedFrom": {
5244
- "name": "FocusTrapMixin",
5245
- "module": "utils/mixins/FocusTrapMixin.js"
5199
+ "name": "Popover",
5200
+ "module": "components/popover/popover.component.js"
5246
5201
  }
5247
5202
  },
5248
5203
  {
5249
- "kind": "method",
5250
- "name": "findElement",
5204
+ "kind": "field",
5205
+ "name": "onOutsidePopoverClick",
5251
5206
  "privacy": "private",
5207
+ "description": "Handles the outside click event to close the popover.",
5252
5208
  "parameters": [
5253
5209
  {
5254
- "name": "activeElement",
5255
- "type": {
5256
- "text": "HTMLElement"
5257
- },
5258
- "description": "The active element."
5210
+ "description": "The mouse event.",
5211
+ "name": "event"
5259
5212
  }
5260
5213
  ],
5261
- "description": "Finds the index of the active element within the focusable elements.",
5262
- "return": {
5263
- "type": {
5264
- "text": ""
5265
- }
5266
- },
5267
5214
  "inheritedFrom": {
5268
- "name": "FocusTrapMixin",
5269
- "module": "utils/mixins/FocusTrapMixin.js"
5215
+ "name": "Popover",
5216
+ "module": "components/popover/popover.component.js"
5270
5217
  }
5271
5218
  },
5272
5219
  {
5273
- "kind": "method",
5274
- "name": "isEqualFocusNode",
5275
- "privacy": "private",
5276
- "parameters": [
5277
- {
5278
- "name": "activeElement",
5279
- "type": {
5280
- "text": "HTMLElement"
5281
- },
5282
- "description": "The active element."
5283
- },
5220
+ "kind": "field",
5221
+ "name": "onEscapeKeydown",
5222
+ "privacy": "private",
5223
+ "description": "Handles the escape keydown event to close the popover.",
5224
+ "parameters": [
5284
5225
  {
5285
- "name": "element",
5286
- "type": {
5287
- "text": "HTMLElement"
5288
- },
5289
- "description": "The element to compare."
5226
+ "description": "The keyboard event.",
5227
+ "name": "event"
5290
5228
  }
5291
5229
  ],
5292
- "description": "Checks if the active element is equal to the given element.",
5293
- "return": {
5294
- "type": {
5295
- "text": ""
5296
- }
5297
- },
5298
5230
  "inheritedFrom": {
5299
- "name": "FocusTrapMixin",
5300
- "module": "utils/mixins/FocusTrapMixin.js"
5231
+ "name": "Popover",
5232
+ "module": "components/popover/popover.component.js"
5301
5233
  }
5302
5234
  },
5303
5235
  {
5304
- "kind": "method",
5305
- "name": "trapFocus",
5236
+ "kind": "field",
5237
+ "name": "onPopoverFocusOut",
5306
5238
  "privacy": "private",
5239
+ "description": "Handles the popover focus out event.",
5307
5240
  "parameters": [
5308
5241
  {
5309
- "name": "direction",
5310
- "type": {
5311
- "text": "boolean"
5312
- },
5313
- "description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element."
5242
+ "description": "The focus event.",
5243
+ "name": "event"
5314
5244
  }
5315
5245
  ],
5316
- "description": "Traps focus within the container.",
5317
5246
  "inheritedFrom": {
5318
- "name": "FocusTrapMixin",
5319
- "module": "utils/mixins/FocusTrapMixin.js"
5247
+ "name": "Popover",
5248
+ "module": "components/popover/popover.component.js"
5320
5249
  }
5321
5250
  },
5322
5251
  {
5323
5252
  "kind": "method",
5324
- "name": "handleKeydown",
5253
+ "name": "isOpenUpdated",
5325
5254
  "privacy": "private",
5326
5255
  "parameters": [
5327
5256
  {
5328
- "name": "event",
5257
+ "name": "oldValue",
5329
5258
  "type": {
5330
- "text": "KeyboardEvent"
5259
+ "text": "boolean"
5331
5260
  },
5332
- "description": "The keyboard event."
5261
+ "description": "The old value of the visible property."
5262
+ },
5263
+ {
5264
+ "name": "newValue",
5265
+ "type": {
5266
+ "text": "boolean"
5267
+ },
5268
+ "description": "The new value of the visible property."
5333
5269
  }
5334
5270
  ],
5335
- "description": "Traps focus within the container.",
5271
+ "description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
5336
5272
  "inheritedFrom": {
5337
- "name": "FocusTrapMixin",
5338
- "module": "utils/mixins/FocusTrapMixin.js"
5273
+ "name": "Popover",
5274
+ "module": "components/popover/popover.component.js"
5339
5275
  }
5340
5276
  },
5341
5277
  {
5342
5278
  "kind": "field",
5343
- "name": "id",
5344
- "type": {
5345
- "text": "string"
5346
- },
5347
- "default": "''",
5348
- "description": "The unique ID of the popover.",
5349
- "attribute": "id",
5350
- "reflects": true,
5279
+ "name": "startCloseDelay",
5280
+ "privacy": "private",
5281
+ "description": "Starts the close delay timer.\nIf the popover is not interactive, it will close the popover after the delay.",
5351
5282
  "inheritedFrom": {
5352
5283
  "name": "Popover",
5353
5284
  "module": "components/popover/popover.component.js"
@@ -5355,14 +5286,9 @@
5355
5286
  },
5356
5287
  {
5357
5288
  "kind": "field",
5358
- "name": "triggerID",
5359
- "type": {
5360
- "text": "string"
5361
- },
5362
- "default": "''",
5363
- "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
5364
- "attribute": "triggerID",
5365
- "reflects": true,
5289
+ "name": "cancelCloseDelay",
5290
+ "privacy": "private",
5291
+ "description": "Cancels the close delay timer.",
5366
5292
  "inheritedFrom": {
5367
5293
  "name": "Popover",
5368
5294
  "module": "components/popover/popover.component.js"
@@ -5370,14 +5296,9 @@
5370
5296
  },
5371
5297
  {
5372
5298
  "kind": "field",
5373
- "name": "placement",
5374
- "type": {
5375
- "text": "PopoverPlacement"
5376
- },
5377
- "description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
5378
- "default": "bottom",
5379
- "attribute": "placement",
5380
- "reflects": true,
5299
+ "name": "showPopover",
5300
+ "privacy": "public",
5301
+ "description": "Shows the popover.",
5381
5302
  "inheritedFrom": {
5382
5303
  "name": "Popover",
5383
5304
  "module": "components/popover/popover.component.js"
@@ -5385,14 +5306,9 @@
5385
5306
  },
5386
5307
  {
5387
5308
  "kind": "field",
5388
- "name": "color",
5389
- "type": {
5390
- "text": "PopoverColor"
5391
- },
5392
- "description": "Color of the popover\n- **tonal**\n- **contrast**",
5393
- "default": "tonal",
5394
- "attribute": "color",
5395
- "reflects": true,
5309
+ "name": "hidePopover",
5310
+ "privacy": "public",
5311
+ "description": "Hides the popover.",
5396
5312
  "inheritedFrom": {
5397
5313
  "name": "Popover",
5398
5314
  "module": "components/popover/popover.component.js"
@@ -5400,44 +5316,29 @@
5400
5316
  },
5401
5317
  {
5402
5318
  "kind": "field",
5403
- "name": "visible",
5404
- "type": {
5405
- "text": "boolean"
5406
- },
5407
- "description": "The visibility of the popover.",
5408
- "default": "false",
5409
- "attribute": "visible",
5410
- "reflects": true,
5319
+ "name": "togglePopoverVisible",
5320
+ "privacy": "public",
5321
+ "description": "Toggles the popover visibility.",
5411
5322
  "inheritedFrom": {
5412
5323
  "name": "Popover",
5413
5324
  "module": "components/popover/popover.component.js"
5414
5325
  }
5415
5326
  },
5416
5327
  {
5417
- "kind": "field",
5418
- "name": "offset",
5419
- "type": {
5420
- "text": "number"
5421
- },
5422
- "description": "The offset of the popover.",
5423
- "default": "4",
5424
- "attribute": "offset",
5425
- "reflects": true,
5328
+ "kind": "method",
5329
+ "name": "handleCreatePopoverFirstUpdate",
5330
+ "privacy": "private",
5331
+ "description": "Sets the focusable elements inside the popover.",
5426
5332
  "inheritedFrom": {
5427
5333
  "name": "Popover",
5428
5334
  "module": "components/popover/popover.component.js"
5429
5335
  }
5430
5336
  },
5431
5337
  {
5432
- "kind": "field",
5433
- "name": "focusTrap",
5434
- "type": {
5435
- "text": "boolean"
5436
- },
5437
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
5438
- "default": "false",
5439
- "attribute": "focus-trap",
5440
- "reflects": true,
5338
+ "kind": "method",
5339
+ "name": "positionPopover",
5340
+ "privacy": "private",
5341
+ "description": "Positions the popover based on the trigger element.\nIt also handles the flip, size and arrow placement.\nIt uses the floating-ui/dom library to calculate the position.",
5441
5342
  "inheritedFrom": {
5442
5343
  "name": "Popover",
5443
5344
  "module": "components/popover/popover.component.js"
@@ -5445,868 +5346,967 @@
5445
5346
  },
5446
5347
  {
5447
5348
  "kind": "field",
5448
- "name": "preventScroll",
5449
- "type": {
5450
- "text": "boolean"
5451
- },
5452
- "description": "Prevent outside scrolling when popover show.",
5453
- "default": "false",
5454
- "attribute": "prevent-scroll",
5455
- "reflects": true,
5349
+ "name": "utils",
5350
+ "default": "new PopoverUtils(this)",
5456
5351
  "inheritedFrom": {
5457
5352
  "name": "Popover",
5458
5353
  "module": "components/popover/popover.component.js"
5459
5354
  }
5460
- },
5355
+ }
5356
+ ],
5357
+ "events": [
5461
5358
  {
5462
- "kind": "field",
5463
- "name": "interactive",
5464
- "type": {
5465
- "text": "boolean"
5466
- },
5467
- "description": "Determines whether the popover is interactive。",
5468
- "default": "false",
5469
- "attribute": "interactive",
5470
- "reflects": true,
5359
+ "description": "(React: onShown) This event is dispatched when the coachmark is shown",
5360
+ "name": "shown",
5361
+ "reactName": "onShown",
5471
5362
  "inheritedFrom": {
5472
5363
  "name": "Popover",
5473
- "module": "components/popover/popover.component.js"
5364
+ "module": "src/components/popover/popover.component.ts"
5474
5365
  }
5475
5366
  },
5476
5367
  {
5477
- "kind": "field",
5478
- "name": "delay",
5479
- "type": {
5480
- "text": "string"
5481
- },
5482
- "description": "The delay of the show/hide popover.",
5483
- "default": "0,0",
5484
- "attribute": "delay",
5485
- "reflects": true,
5368
+ "description": "(React: onHidden) This event is dispatched when the coachmark is hidden",
5369
+ "name": "hidden",
5370
+ "reactName": "onHidden",
5486
5371
  "inheritedFrom": {
5487
5372
  "name": "Popover",
5488
- "module": "components/popover/popover.component.js"
5373
+ "module": "src/components/popover/popover.component.ts"
5489
5374
  }
5490
5375
  },
5491
5376
  {
5492
- "kind": "field",
5493
- "name": "hideOnEscape",
5494
- "type": {
5495
- "text": "boolean"
5496
- },
5497
- "description": "Hide popover on escape key press.",
5498
- "default": "false",
5499
- "attribute": "hide-on-escape",
5500
- "reflects": true,
5377
+ "description": "(React: onCreated) This event is dispatched when the coachmark is created (added to the DOM)",
5378
+ "name": "created",
5379
+ "reactName": "onCreated",
5501
5380
  "inheritedFrom": {
5502
5381
  "name": "Popover",
5503
- "module": "components/popover/popover.component.js"
5382
+ "module": "src/components/popover/popover.component.ts"
5504
5383
  }
5505
5384
  },
5506
5385
  {
5507
- "kind": "field",
5508
- "name": "hideOnBlur",
5509
- "type": {
5510
- "text": "boolean"
5511
- },
5512
- "description": "Hide popover on blur.",
5513
- "default": "false",
5514
- "attribute": "hide-on-blur",
5515
- "reflects": true,
5386
+ "description": "(React: onDestroyed) This event is dispatched when the coachmark is destroyed (removed from the DOM)",
5387
+ "name": "destroyed",
5388
+ "reactName": "onDestroyed",
5516
5389
  "inheritedFrom": {
5517
5390
  "name": "Popover",
5518
- "module": "components/popover/popover.component.js"
5391
+ "module": "src/components/popover/popover.component.ts"
5519
5392
  }
5520
- },
5393
+ }
5394
+ ],
5395
+ "attributes": [
5521
5396
  {
5522
- "kind": "field",
5523
- "name": "hideOnOutsideClick",
5397
+ "name": "trigger",
5524
5398
  "type": {
5525
- "text": "boolean"
5399
+ "text": "PopoverTrigger"
5526
5400
  },
5527
- "description": "Hide on outside click of the popover.",
5528
- "default": "false",
5529
- "attribute": "hide-on-outside-click",
5530
- "reflects": true,
5401
+ "description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
5402
+ "default": "manual",
5403
+ "fieldName": "trigger",
5531
5404
  "inheritedFrom": {
5532
5405
  "name": "Popover",
5533
- "module": "components/popover/popover.component.js"
5406
+ "module": "src/components/popover/popover.component.ts"
5534
5407
  }
5535
5408
  },
5536
5409
  {
5537
- "kind": "field",
5538
- "name": "focusBackToTrigger",
5410
+ "name": "show-arrow",
5539
5411
  "type": {
5540
5412
  "text": "boolean"
5541
5413
  },
5542
- "description": "The focus back to trigger after the popover hide.",
5543
- "default": "false",
5544
- "attribute": "focus-back-to-trigger",
5545
- "reflects": true,
5414
+ "description": "The arrow visibility of the Coachmark.",
5415
+ "default": "true",
5416
+ "fieldName": "showArrow",
5546
5417
  "inheritedFrom": {
5547
5418
  "name": "Popover",
5548
- "module": "components/popover/popover.component.js"
5419
+ "module": "src/components/popover/popover.component.ts"
5549
5420
  }
5550
5421
  },
5551
5422
  {
5552
- "kind": "field",
5553
- "name": "backdrop",
5423
+ "name": "close-button",
5554
5424
  "type": {
5555
5425
  "text": "boolean"
5556
5426
  },
5557
- "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
5558
- "default": "false",
5559
- "attribute": "backdrop",
5560
- "reflects": true,
5427
+ "description": "The close button visibility of the Coachmark.",
5428
+ "default": "true",
5429
+ "fieldName": "closeButton",
5561
5430
  "inheritedFrom": {
5562
5431
  "name": "Popover",
5563
- "module": "components/popover/popover.component.js"
5432
+ "module": "src/components/popover/popover.component.ts"
5564
5433
  }
5565
5434
  },
5566
- {
5567
- "kind": "field",
5568
- "name": "flip",
5435
+ {
5436
+ "name": "disable-aria-expanded",
5569
5437
  "type": {
5570
5438
  "text": "boolean"
5571
5439
  },
5572
- "description": "Changes the placement of popover to keep it in view when scrolling.",
5440
+ "description": "Disable aria-expanded attribute on trigger element.",
5573
5441
  "default": "true",
5574
- "attribute": "flip",
5575
- "reflects": true,
5442
+ "fieldName": "disableAriaExpanded",
5576
5443
  "inheritedFrom": {
5577
5444
  "name": "Popover",
5578
- "module": "components/popover/popover.component.js"
5445
+ "module": "src/components/popover/popover.component.ts"
5579
5446
  }
5580
5447
  },
5581
5448
  {
5582
- "kind": "field",
5583
- "name": "size",
5449
+ "name": "enabledFocusTrap",
5584
5450
  "type": {
5585
5451
  "text": "boolean"
5586
5452
  },
5587
- "description": "Changes the size of popover to keep it in view when scrolling.",
5453
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
5588
5454
  "default": "false",
5589
- "attribute": "size",
5590
- "reflects": true,
5455
+ "fieldName": "enabledFocusTrap",
5591
5456
  "inheritedFrom": {
5592
- "name": "Popover",
5593
- "module": "components/popover/popover.component.js"
5457
+ "name": "FocusTrapMixin",
5458
+ "module": "src/utils/mixins/FocusTrapMixin.ts"
5594
5459
  }
5595
5460
  },
5596
5461
  {
5597
- "kind": "field",
5598
- "name": "zIndex",
5462
+ "name": "enabledPreventScroll",
5599
5463
  "type": {
5600
- "text": "number"
5464
+ "text": "boolean"
5601
5465
  },
5602
- "description": "The z-index of the popover.",
5603
- "default": "1000",
5604
- "attribute": "z-index",
5605
- "reflects": true,
5466
+ "description": "Prevent outside scrolling when popover show.",
5467
+ "default": "false",
5468
+ "fieldName": "enabledPreventScroll",
5606
5469
  "inheritedFrom": {
5607
- "name": "Popover",
5608
- "module": "components/popover/popover.component.js"
5470
+ "name": "FocusTrapMixin",
5471
+ "module": "src/utils/mixins/FocusTrapMixin.ts"
5609
5472
  }
5610
5473
  },
5611
5474
  {
5612
- "kind": "field",
5613
- "name": "appendTo",
5475
+ "name": "id",
5614
5476
  "type": {
5615
5477
  "text": "string"
5616
5478
  },
5617
5479
  "default": "''",
5618
- "description": "Element ID that the popover append to.",
5619
- "attribute": "append-to",
5620
- "reflects": true,
5480
+ "description": "The unique ID of the popover.",
5481
+ "fieldName": "id",
5621
5482
  "inheritedFrom": {
5622
5483
  "name": "Popover",
5623
- "module": "components/popover/popover.component.js"
5484
+ "module": "src/components/popover/popover.component.ts"
5624
5485
  }
5625
5486
  },
5626
5487
  {
5627
- "kind": "field",
5628
- "name": "closeButtonAriaLabel",
5488
+ "name": "triggerID",
5629
5489
  "type": {
5630
- "text": "string | null"
5490
+ "text": "string"
5631
5491
  },
5632
- "default": "null",
5633
- "description": "aria-label attribute to be set for close button accessibility.",
5634
- "attribute": "close-button-aria-label",
5635
- "reflects": true,
5492
+ "default": "''",
5493
+ "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
5494
+ "fieldName": "triggerID",
5636
5495
  "inheritedFrom": {
5637
5496
  "name": "Popover",
5638
- "module": "components/popover/popover.component.js"
5497
+ "module": "src/components/popover/popover.component.ts"
5639
5498
  }
5640
5499
  },
5641
5500
  {
5642
- "kind": "field",
5643
- "name": "role",
5501
+ "name": "placement",
5644
5502
  "type": {
5645
- "text": "HTMLElement['role']"
5503
+ "text": "PopoverPlacement"
5646
5504
  },
5647
- "description": "Role of the popover",
5648
- "default": "dialog",
5649
- "attribute": "role",
5650
- "reflects": true,
5505
+ "description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
5506
+ "default": "bottom",
5507
+ "fieldName": "placement",
5651
5508
  "inheritedFrom": {
5652
5509
  "name": "Popover",
5653
- "module": "components/popover/popover.component.js"
5510
+ "module": "src/components/popover/popover.component.ts"
5654
5511
  }
5655
5512
  },
5656
5513
  {
5657
- "kind": "field",
5658
- "name": "ariaLabelledby",
5514
+ "name": "color",
5659
5515
  "type": {
5660
- "text": "string | null"
5516
+ "text": "PopoverColor"
5661
5517
  },
5662
- "default": "null",
5663
- "description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
5664
- "attribute": "aria-labelledby",
5665
- "reflects": true,
5518
+ "description": "Color of the popover\n- **tonal**\n- **contrast**",
5519
+ "default": "tonal",
5520
+ "fieldName": "color",
5666
5521
  "inheritedFrom": {
5667
5522
  "name": "Popover",
5668
- "module": "components/popover/popover.component.js"
5523
+ "module": "src/components/popover/popover.component.ts"
5669
5524
  }
5670
5525
  },
5671
5526
  {
5672
- "kind": "field",
5673
- "name": "ariaDescribedby",
5527
+ "name": "visible",
5674
5528
  "type": {
5675
- "text": "string | null"
5529
+ "text": "boolean"
5676
5530
  },
5677
- "default": "null",
5678
- "description": "aria-describedby of the popover.",
5679
- "attribute": "aria-describedby",
5680
- "reflects": true,
5531
+ "description": "The visibility of the popover.",
5532
+ "default": "false",
5533
+ "fieldName": "visible",
5681
5534
  "inheritedFrom": {
5682
5535
  "name": "Popover",
5683
- "module": "components/popover/popover.component.js"
5536
+ "module": "src/components/popover/popover.component.ts"
5684
5537
  }
5685
5538
  },
5686
5539
  {
5687
- "kind": "field",
5688
- "name": "arrowElement",
5540
+ "name": "offset",
5689
5541
  "type": {
5690
- "text": "HTMLElement | null"
5542
+ "text": "number"
5691
5543
  },
5692
- "privacy": "public",
5693
- "default": "null",
5544
+ "description": "The offset of the popover.",
5545
+ "default": "4",
5546
+ "fieldName": "offset",
5694
5547
  "inheritedFrom": {
5695
5548
  "name": "Popover",
5696
- "module": "components/popover/popover.component.js"
5549
+ "module": "src/components/popover/popover.component.ts"
5697
5550
  }
5698
5551
  },
5699
5552
  {
5700
- "kind": "field",
5701
- "name": "triggerElement",
5553
+ "name": "focus-trap",
5702
5554
  "type": {
5703
- "text": "HTMLElement | null"
5555
+ "text": "boolean"
5704
5556
  },
5705
- "privacy": "public",
5706
- "default": "null",
5707
- "inheritedFrom": {
5708
- "name": "Popover",
5709
- "module": "components/popover/popover.component.js"
5710
- }
5711
- },
5712
- {
5713
- "kind": "method",
5714
- "name": "setupTriggerListener",
5715
- "privacy": "private",
5716
- "description": "Sets up the trigger event listeners based on the trigger type.",
5717
- "inheritedFrom": {
5718
- "name": "Popover",
5719
- "module": "components/popover/popover.component.js"
5720
- }
5721
- },
5722
- {
5723
- "kind": "method",
5724
- "name": "removeEventListeners",
5725
- "privacy": "private",
5726
- "description": "Removes the trigger event listeners.",
5557
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
5558
+ "default": "false",
5559
+ "fieldName": "focusTrap",
5727
5560
  "inheritedFrom": {
5728
5561
  "name": "Popover",
5729
- "module": "components/popover/popover.component.js"
5562
+ "module": "src/components/popover/popover.component.ts"
5730
5563
  }
5731
5564
  },
5732
5565
  {
5733
- "kind": "field",
5734
- "name": "onOutsidePopoverClick",
5735
- "privacy": "private",
5736
- "description": "Handles the outside click event to close the popover.",
5737
- "parameters": [
5738
- {
5739
- "description": "The mouse event.",
5740
- "name": "event"
5741
- }
5742
- ],
5566
+ "name": "prevent-scroll",
5567
+ "type": {
5568
+ "text": "boolean"
5569
+ },
5570
+ "description": "Prevent outside scrolling when popover show.",
5571
+ "default": "false",
5572
+ "fieldName": "preventScroll",
5743
5573
  "inheritedFrom": {
5744
5574
  "name": "Popover",
5745
- "module": "components/popover/popover.component.js"
5575
+ "module": "src/components/popover/popover.component.ts"
5746
5576
  }
5747
5577
  },
5748
5578
  {
5749
- "kind": "field",
5750
- "name": "onEscapeKeydown",
5751
- "privacy": "private",
5752
- "description": "Handles the escape keydown event to close the popover.",
5753
- "parameters": [
5754
- {
5755
- "description": "The keyboard event.",
5756
- "name": "event"
5757
- }
5758
- ],
5579
+ "name": "interactive",
5580
+ "type": {
5581
+ "text": "boolean"
5582
+ },
5583
+ "description": "Determines whether the popover is interactive。",
5584
+ "default": "false",
5585
+ "fieldName": "interactive",
5759
5586
  "inheritedFrom": {
5760
5587
  "name": "Popover",
5761
- "module": "components/popover/popover.component.js"
5588
+ "module": "src/components/popover/popover.component.ts"
5762
5589
  }
5763
5590
  },
5764
5591
  {
5765
- "kind": "field",
5766
- "name": "onPopoverFocusOut",
5767
- "privacy": "private",
5768
- "description": "Handles the popover focus out event.",
5769
- "parameters": [
5770
- {
5771
- "description": "The focus event.",
5772
- "name": "event"
5773
- }
5774
- ],
5592
+ "name": "delay",
5593
+ "type": {
5594
+ "text": "string"
5595
+ },
5596
+ "description": "The delay of the show/hide popover.",
5597
+ "default": "0,0",
5598
+ "fieldName": "delay",
5775
5599
  "inheritedFrom": {
5776
5600
  "name": "Popover",
5777
- "module": "components/popover/popover.component.js"
5601
+ "module": "src/components/popover/popover.component.ts"
5778
5602
  }
5779
5603
  },
5780
5604
  {
5781
- "kind": "method",
5782
- "name": "isOpenUpdated",
5783
- "privacy": "private",
5784
- "parameters": [
5785
- {
5786
- "name": "oldValue",
5787
- "type": {
5788
- "text": "boolean"
5789
- },
5790
- "description": "The old value of the visible property."
5791
- },
5792
- {
5793
- "name": "newValue",
5794
- "type": {
5795
- "text": "boolean"
5796
- },
5797
- "description": "The new value of the visible property."
5798
- }
5799
- ],
5800
- "description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
5605
+ "name": "hide-on-escape",
5606
+ "type": {
5607
+ "text": "boolean"
5608
+ },
5609
+ "description": "Hide popover on escape key press.",
5610
+ "default": "false",
5611
+ "fieldName": "hideOnEscape",
5801
5612
  "inheritedFrom": {
5802
5613
  "name": "Popover",
5803
- "module": "components/popover/popover.component.js"
5614
+ "module": "src/components/popover/popover.component.ts"
5804
5615
  }
5805
5616
  },
5806
5617
  {
5807
- "kind": "field",
5808
- "name": "startCloseDelay",
5809
- "privacy": "private",
5810
- "description": "Starts the close delay timer.\nIf the popover is not interactive, it will close the popover after the delay.",
5618
+ "name": "hide-on-blur",
5619
+ "type": {
5620
+ "text": "boolean"
5621
+ },
5622
+ "description": "Hide popover on blur.",
5623
+ "default": "false",
5624
+ "fieldName": "hideOnBlur",
5811
5625
  "inheritedFrom": {
5812
5626
  "name": "Popover",
5813
- "module": "components/popover/popover.component.js"
5627
+ "module": "src/components/popover/popover.component.ts"
5814
5628
  }
5815
5629
  },
5816
5630
  {
5817
- "kind": "field",
5818
- "name": "cancelCloseDelay",
5819
- "privacy": "private",
5820
- "description": "Cancels the close delay timer.",
5631
+ "name": "hide-on-outside-click",
5632
+ "type": {
5633
+ "text": "boolean"
5634
+ },
5635
+ "description": "Hide on outside click of the popover.",
5636
+ "default": "false",
5637
+ "fieldName": "hideOnOutsideClick",
5821
5638
  "inheritedFrom": {
5822
5639
  "name": "Popover",
5823
- "module": "components/popover/popover.component.js"
5640
+ "module": "src/components/popover/popover.component.ts"
5824
5641
  }
5825
5642
  },
5826
5643
  {
5827
- "kind": "field",
5828
- "name": "showPopover",
5829
- "privacy": "public",
5830
- "description": "Shows the popover.",
5644
+ "name": "focus-back-to-trigger",
5645
+ "type": {
5646
+ "text": "boolean"
5647
+ },
5648
+ "description": "The focus back to trigger after the popover hide.",
5649
+ "default": "false",
5650
+ "fieldName": "focusBackToTrigger",
5831
5651
  "inheritedFrom": {
5832
5652
  "name": "Popover",
5833
- "module": "components/popover/popover.component.js"
5653
+ "module": "src/components/popover/popover.component.ts"
5834
5654
  }
5835
5655
  },
5836
5656
  {
5837
- "kind": "field",
5838
- "name": "hidePopover",
5839
- "privacy": "public",
5840
- "description": "Hides the popover.",
5657
+ "name": "backdrop",
5658
+ "type": {
5659
+ "text": "boolean"
5660
+ },
5661
+ "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
5662
+ "default": "false",
5663
+ "fieldName": "backdrop",
5841
5664
  "inheritedFrom": {
5842
5665
  "name": "Popover",
5843
- "module": "components/popover/popover.component.js"
5666
+ "module": "src/components/popover/popover.component.ts"
5844
5667
  }
5845
5668
  },
5846
5669
  {
5847
- "kind": "field",
5848
- "name": "togglePopoverVisible",
5849
- "privacy": "public",
5850
- "description": "Toggles the popover visibility.",
5670
+ "name": "flip",
5671
+ "type": {
5672
+ "text": "boolean"
5673
+ },
5674
+ "description": "Changes the placement of popover to keep it in view when scrolling.",
5675
+ "default": "true",
5676
+ "fieldName": "flip",
5851
5677
  "inheritedFrom": {
5852
5678
  "name": "Popover",
5853
- "module": "components/popover/popover.component.js"
5679
+ "module": "src/components/popover/popover.component.ts"
5854
5680
  }
5855
5681
  },
5856
5682
  {
5857
- "kind": "method",
5858
- "name": "handleCreatePopoverFirstUpdate",
5859
- "privacy": "private",
5860
- "description": "Sets the focusable elements inside the popover.",
5683
+ "name": "size",
5684
+ "type": {
5685
+ "text": "boolean"
5686
+ },
5687
+ "description": "Changes the size of popover to keep it in view when scrolling.",
5688
+ "default": "false",
5689
+ "fieldName": "size",
5861
5690
  "inheritedFrom": {
5862
5691
  "name": "Popover",
5863
- "module": "components/popover/popover.component.js"
5692
+ "module": "src/components/popover/popover.component.ts"
5864
5693
  }
5865
5694
  },
5866
5695
  {
5867
- "kind": "method",
5868
- "name": "positionPopover",
5869
- "privacy": "private",
5870
- "description": "Positions the popover based on the trigger element.\nIt also handles the flip, size and arrow placement.\nIt uses the floating-ui/dom library to calculate the position.",
5696
+ "name": "z-index",
5697
+ "type": {
5698
+ "text": "number"
5699
+ },
5700
+ "description": "The z-index of the popover.",
5701
+ "default": "1000",
5702
+ "fieldName": "zIndex",
5871
5703
  "inheritedFrom": {
5872
5704
  "name": "Popover",
5873
- "module": "components/popover/popover.component.js"
5705
+ "module": "src/components/popover/popover.component.ts"
5874
5706
  }
5875
5707
  },
5876
5708
  {
5877
- "kind": "field",
5878
- "name": "utils",
5879
- "default": "new PopoverUtils(this)",
5709
+ "name": "append-to",
5710
+ "type": {
5711
+ "text": "string"
5712
+ },
5713
+ "default": "''",
5714
+ "description": "Element ID that the popover append to.",
5715
+ "fieldName": "appendTo",
5880
5716
  "inheritedFrom": {
5881
5717
  "name": "Popover",
5882
- "module": "components/popover/popover.component.js"
5718
+ "module": "src/components/popover/popover.component.ts"
5883
5719
  }
5884
- }
5885
- ],
5886
- "events": [
5720
+ },
5887
5721
  {
5888
- "description": "(React: onShown) This event is dispatched when the coachmark is shown",
5889
- "name": "shown",
5890
- "reactName": "onShown",
5722
+ "name": "close-button-aria-label",
5723
+ "type": {
5724
+ "text": "string | null"
5725
+ },
5726
+ "default": "null",
5727
+ "description": "aria-label attribute to be set for close button accessibility.",
5728
+ "fieldName": "closeButtonAriaLabel",
5891
5729
  "inheritedFrom": {
5892
5730
  "name": "Popover",
5893
5731
  "module": "src/components/popover/popover.component.ts"
5894
5732
  }
5895
5733
  },
5896
5734
  {
5897
- "description": "(React: onHidden) This event is dispatched when the coachmark is hidden",
5898
- "name": "hidden",
5899
- "reactName": "onHidden",
5735
+ "name": "role",
5736
+ "type": {
5737
+ "text": "HTMLElement['role']"
5738
+ },
5739
+ "description": "Role of the popover",
5740
+ "default": "dialog",
5741
+ "fieldName": "role",
5900
5742
  "inheritedFrom": {
5901
5743
  "name": "Popover",
5902
5744
  "module": "src/components/popover/popover.component.ts"
5903
5745
  }
5904
5746
  },
5905
5747
  {
5906
- "description": "(React: onCreated) This event is dispatched when the coachmark is created (added to the DOM)",
5907
- "name": "created",
5908
- "reactName": "onCreated",
5748
+ "name": "aria-labelledby",
5749
+ "type": {
5750
+ "text": "string | null"
5751
+ },
5752
+ "default": "null",
5753
+ "description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
5754
+ "fieldName": "ariaLabelledby",
5909
5755
  "inheritedFrom": {
5910
5756
  "name": "Popover",
5911
5757
  "module": "src/components/popover/popover.component.ts"
5912
5758
  }
5913
5759
  },
5914
5760
  {
5915
- "description": "(React: onDestroyed) This event is dispatched when the coachmark is destroyed (removed from the DOM)",
5916
- "name": "destroyed",
5917
- "reactName": "onDestroyed",
5761
+ "name": "aria-describedby",
5762
+ "type": {
5763
+ "text": "string | null"
5764
+ },
5765
+ "default": "null",
5766
+ "description": "aria-describedby of the popover.",
5767
+ "fieldName": "ariaDescribedby",
5918
5768
  "inheritedFrom": {
5919
5769
  "name": "Popover",
5920
5770
  "module": "src/components/popover/popover.component.ts"
5921
5771
  }
5922
5772
  }
5923
5773
  ],
5924
- "attributes": [
5774
+ "superclass": {
5775
+ "name": "Popover",
5776
+ "module": "/src/components/popover/popover.component"
5777
+ },
5778
+ "tagName": "mdc-coachmark",
5779
+ "jsDoc": "/**\n * Coachmark component based on top of the popover component,\n * with the default value of certain properties changed.\n *\n * @dependency mdc-popover\n *\n * @tagname mdc-coachmark\n *\n * @event shown - (React: onShown) This event is dispatched when the coachmark is shown\n * @event hidden - (React: onHidden) This event is dispatched when the coachmark is hidden\n * @event created - (React: onCreated) This event is dispatched when the coachmark is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched when the coachmark is\n * destroyed (removed from the DOM)\n *\n * @cssproperty --mdc-popover-arrow-border-radius - radius of the arrow border\n * @cssproperty --mdc-popover-arrow-border - border of the arrow\n * @cssproperty --mdc-popover-primary-background-color - primary background color of the popover\n * @cssproperty --mdc-popover-border-color - border color of the popover\n * @cssproperty --mdc-popover-inverted-background-color - inverted background color of the popover\n * @cssproperty --mdc-popover-inverted-border-color - inverted border color of the popover\n * @cssproperty --mdc-popover-inverted-text-color - inverted text color of the popover\n * @cssproperty --mdc-popover-elevation-3 - elevation of the popover\n *\n * @slot - Default slot for modal container\n *\n */",
5780
+ "customElement": true
5781
+ }
5782
+ ],
5783
+ "exports": [
5784
+ {
5785
+ "kind": "js",
5786
+ "name": "default",
5787
+ "declaration": {
5788
+ "name": "Coachmark",
5789
+ "module": "components/coachmark/coachmark.component.js"
5790
+ }
5791
+ }
5792
+ ]
5793
+ },
5794
+ {
5795
+ "kind": "javascript-module",
5796
+ "path": "components/chip/chip.component.js",
5797
+ "declarations": [
5798
+ {
5799
+ "kind": "class",
5800
+ "description": "mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\nConsumers can wrap this component around a tooltip to provide additional context.\n\nIt is recommended to keep the label text for the chip component concise and compact.\nFor best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.\n\nThis component is built by extending Buttonsimple.",
5801
+ "name": "Chip",
5802
+ "cssProperties": [
5925
5803
  {
5926
- "name": "trigger",
5804
+ "description": "The color of the chip.",
5805
+ "name": "--mdc-chip-color"
5806
+ },
5807
+ {
5808
+ "description": "The border color of the chip.",
5809
+ "name": "--mdc-chip-border-color"
5810
+ },
5811
+ {
5812
+ "description": "The background color of the chip.",
5813
+ "name": "--mdc-chip-background-color"
5814
+ }
5815
+ ],
5816
+ "members": [
5817
+ {
5818
+ "kind": "field",
5819
+ "name": "color",
5927
5820
  "type": {
5928
- "text": "PopoverTrigger"
5821
+ "text": "ColorType"
5929
5822
  },
5930
- "description": "Determines the events that cause the Coachmark to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
5931
- "default": "manual",
5932
- "fieldName": "trigger",
5823
+ "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- pink\n- purple\n- slate\n- violet",
5824
+ "default": "default",
5825
+ "attribute": "color",
5826
+ "reflects": true
5827
+ },
5828
+ {
5829
+ "kind": "field",
5830
+ "name": "label",
5831
+ "type": {
5832
+ "text": "string"
5833
+ },
5834
+ "default": "''",
5835
+ "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
5836
+ "attribute": "label"
5837
+ },
5838
+ {
5839
+ "kind": "method",
5840
+ "name": "renderIcon",
5841
+ "privacy": "private",
5842
+ "description": "Renders the icon element if available.",
5843
+ "return": {
5844
+ "type": {
5845
+ "text": ""
5846
+ }
5847
+ }
5848
+ },
5849
+ {
5850
+ "kind": "field",
5851
+ "name": "iconName",
5852
+ "type": {
5853
+ "text": "IconNames | undefined"
5854
+ },
5855
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
5856
+ "attribute": "icon-name",
5933
5857
  "inheritedFrom": {
5934
- "name": "Popover",
5935
- "module": "src/components/popover/popover.component.ts"
5858
+ "name": "IconNameMixin",
5859
+ "module": "utils/mixins/IconNameMixin.js"
5860
+ }
5861
+ },
5862
+ {
5863
+ "kind": "field",
5864
+ "name": "tabIndex",
5865
+ "type": {
5866
+ "text": "number"
5867
+ },
5868
+ "default": "0",
5869
+ "description": "This property specifies the tab order of the element.",
5870
+ "attribute": "tabIndex",
5871
+ "reflects": true,
5872
+ "inheritedFrom": {
5873
+ "name": "Buttonsimple",
5874
+ "module": "components/buttonsimple/buttonsimple.component.js"
5875
+ }
5876
+ },
5877
+ {
5878
+ "kind": "field",
5879
+ "name": "disabled",
5880
+ "type": {
5881
+ "text": "boolean | undefined"
5882
+ },
5883
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
5884
+ "default": "undefined",
5885
+ "attribute": "disabled",
5886
+ "reflects": true,
5887
+ "inheritedFrom": {
5888
+ "name": "Buttonsimple",
5889
+ "module": "components/buttonsimple/buttonsimple.component.js"
5890
+ }
5891
+ },
5892
+ {
5893
+ "kind": "field",
5894
+ "name": "active",
5895
+ "type": {
5896
+ "text": "boolean | undefined"
5897
+ },
5898
+ "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.",
5899
+ "default": "undefined",
5900
+ "attribute": "active",
5901
+ "reflects": true,
5902
+ "inheritedFrom": {
5903
+ "name": "Buttonsimple",
5904
+ "module": "components/buttonsimple/buttonsimple.component.js"
5936
5905
  }
5937
5906
  },
5938
5907
  {
5939
- "name": "show-arrow",
5908
+ "kind": "field",
5909
+ "name": "softDisabled",
5940
5910
  "type": {
5941
- "text": "boolean"
5911
+ "text": "boolean | undefined"
5942
5912
  },
5943
- "description": "The arrow visibility of the Coachmark.",
5944
- "default": "true",
5945
- "fieldName": "showArrow",
5913
+ "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.",
5914
+ "default": "undefined",
5915
+ "attribute": "soft-disabled",
5916
+ "reflects": true,
5946
5917
  "inheritedFrom": {
5947
- "name": "Popover",
5948
- "module": "src/components/popover/popover.component.ts"
5918
+ "name": "Buttonsimple",
5919
+ "module": "components/buttonsimple/buttonsimple.component.js"
5949
5920
  }
5950
5921
  },
5951
5922
  {
5952
- "name": "close-button",
5923
+ "kind": "field",
5924
+ "name": "size",
5953
5925
  "type": {
5954
- "text": "boolean"
5926
+ "text": "ButtonSize"
5955
5927
  },
5956
- "description": "The close button visibility of the Coachmark.",
5957
- "default": "true",
5958
- "fieldName": "closeButton",
5928
+ "description": "Simplebutton size is a super set of all the sizes supported by children components.",
5929
+ "default": "32",
5930
+ "attribute": "size",
5931
+ "reflects": true,
5959
5932
  "inheritedFrom": {
5960
- "name": "Popover",
5961
- "module": "src/components/popover/popover.component.ts"
5933
+ "name": "Buttonsimple",
5934
+ "module": "components/buttonsimple/buttonsimple.component.js"
5962
5935
  }
5963
5936
  },
5964
5937
  {
5965
- "name": "disable-aria-expanded",
5966
- "type": {
5967
- "text": "boolean"
5968
- },
5969
- "description": "Disable aria-expanded attribute on trigger element.",
5970
- "default": "true",
5971
- "fieldName": "disableAriaExpanded",
5938
+ "kind": "field",
5939
+ "name": "role",
5940
+ "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.",
5941
+ "default": "button",
5942
+ "attribute": "role",
5943
+ "reflects": true,
5972
5944
  "inheritedFrom": {
5973
- "name": "Popover",
5974
- "module": "src/components/popover/popover.component.ts"
5945
+ "name": "Buttonsimple",
5946
+ "module": "components/buttonsimple/buttonsimple.component.js"
5975
5947
  }
5976
5948
  },
5977
5949
  {
5978
- "name": "enabledFocusTrap",
5950
+ "kind": "field",
5951
+ "name": "ariaStateKey",
5979
5952
  "type": {
5980
- "text": "boolean"
5953
+ "text": "string | undefined"
5981
5954
  },
5982
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
5983
- "default": "false",
5984
- "fieldName": "enabledFocusTrap",
5955
+ "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`",
5956
+ "default": "'aria-pressed' (when)",
5957
+ "attribute": "ariaStateKey",
5958
+ "reflects": true,
5985
5959
  "inheritedFrom": {
5986
- "name": "FocusTrapMixin",
5987
- "module": "src/utils/mixins/FocusTrapMixin.ts"
5960
+ "name": "Buttonsimple",
5961
+ "module": "components/buttonsimple/buttonsimple.component.js"
5988
5962
  }
5989
5963
  },
5990
5964
  {
5991
- "name": "enabledPreventScroll",
5965
+ "kind": "field",
5966
+ "name": "type",
5992
5967
  "type": {
5993
- "text": "boolean"
5968
+ "text": "ButtonType"
5994
5969
  },
5995
- "description": "Prevent outside scrolling when popover show.",
5996
- "default": "false",
5997
- "fieldName": "enabledPreventScroll",
5970
+ "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.",
5971
+ "default": "button",
5972
+ "attribute": "type",
5973
+ "reflects": true,
5998
5974
  "inheritedFrom": {
5999
- "name": "FocusTrapMixin",
6000
- "module": "src/utils/mixins/FocusTrapMixin.ts"
5975
+ "name": "Buttonsimple",
5976
+ "module": "components/buttonsimple/buttonsimple.component.js"
6001
5977
  }
6002
5978
  },
6003
5979
  {
6004
- "name": "id",
6005
- "type": {
6006
- "text": "string"
6007
- },
6008
- "default": "''",
6009
- "description": "The unique ID of the popover.",
6010
- "fieldName": "id",
5980
+ "kind": "method",
5981
+ "name": "executeAction",
5982
+ "privacy": "protected",
6011
5983
  "inheritedFrom": {
6012
- "name": "Popover",
6013
- "module": "src/components/popover/popover.component.ts"
5984
+ "name": "Buttonsimple",
5985
+ "module": "components/buttonsimple/buttonsimple.component.js"
6014
5986
  }
6015
5987
  },
6016
5988
  {
6017
- "name": "triggerID",
6018
- "type": {
6019
- "text": "string"
6020
- },
6021
- "default": "''",
6022
- "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
6023
- "fieldName": "triggerID",
5989
+ "kind": "method",
5990
+ "name": "setActive",
5991
+ "privacy": "protected",
5992
+ "parameters": [
5993
+ {
5994
+ "name": "element",
5995
+ "type": {
5996
+ "text": "HTMLElement"
5997
+ },
5998
+ "description": "The button element"
5999
+ },
6000
+ {
6001
+ "name": "active",
6002
+ "optional": true,
6003
+ "type": {
6004
+ "text": "boolean"
6005
+ },
6006
+ "description": "The active state of the element"
6007
+ }
6008
+ ],
6009
+ "description": "Sets the ariaStateKey attributes based on the active state of the button.",
6024
6010
  "inheritedFrom": {
6025
- "name": "Popover",
6026
- "module": "src/components/popover/popover.component.ts"
6011
+ "name": "Buttonsimple",
6012
+ "module": "components/buttonsimple/buttonsimple.component.js"
6027
6013
  }
6028
6014
  },
6029
6015
  {
6030
- "name": "placement",
6031
- "type": {
6032
- "text": "PopoverPlacement"
6033
- },
6034
- "description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
6035
- "default": "bottom",
6036
- "fieldName": "placement",
6016
+ "kind": "method",
6017
+ "name": "setSoftDisabled",
6018
+ "privacy": "private",
6019
+ "parameters": [
6020
+ {
6021
+ "name": "element",
6022
+ "type": {
6023
+ "text": "HTMLElement"
6024
+ },
6025
+ "description": "The button element."
6026
+ },
6027
+ {
6028
+ "name": "softDisabled",
6029
+ "optional": true,
6030
+ "type": {
6031
+ "text": "boolean"
6032
+ },
6033
+ "description": "The soft-disabled state."
6034
+ }
6035
+ ],
6036
+ "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.",
6037
6037
  "inheritedFrom": {
6038
- "name": "Popover",
6039
- "module": "src/components/popover/popover.component.ts"
6038
+ "name": "Buttonsimple",
6039
+ "module": "components/buttonsimple/buttonsimple.component.js"
6040
6040
  }
6041
6041
  },
6042
6042
  {
6043
- "name": "color",
6044
- "type": {
6045
- "text": "PopoverColor"
6046
- },
6047
- "description": "Color of the popover\n- **tonal**\n- **contrast**",
6048
- "default": "tonal",
6049
- "fieldName": "color",
6043
+ "kind": "method",
6044
+ "name": "setDisabled",
6045
+ "privacy": "private",
6046
+ "parameters": [
6047
+ {
6048
+ "name": "element",
6049
+ "type": {
6050
+ "text": "HTMLElement"
6051
+ },
6052
+ "description": "The button element."
6053
+ },
6054
+ {
6055
+ "name": "disabled",
6056
+ "type": {
6057
+ "text": "boolean"
6058
+ },
6059
+ "description": "The disabled state."
6060
+ }
6061
+ ],
6062
+ "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.",
6050
6063
  "inheritedFrom": {
6051
- "name": "Popover",
6052
- "module": "src/components/popover/popover.component.ts"
6064
+ "name": "Buttonsimple",
6065
+ "module": "components/buttonsimple/buttonsimple.component.js"
6053
6066
  }
6054
6067
  },
6055
6068
  {
6056
- "name": "visible",
6057
- "type": {
6058
- "text": "boolean"
6059
- },
6060
- "description": "The visibility of the popover.",
6061
- "default": "false",
6062
- "fieldName": "visible",
6069
+ "kind": "method",
6070
+ "name": "triggerClickEvent",
6071
+ "privacy": "private",
6063
6072
  "inheritedFrom": {
6064
- "name": "Popover",
6065
- "module": "src/components/popover/popover.component.ts"
6073
+ "name": "Buttonsimple",
6074
+ "module": "components/buttonsimple/buttonsimple.component.js"
6066
6075
  }
6067
6076
  },
6068
6077
  {
6069
- "name": "offset",
6070
- "type": {
6071
- "text": "number"
6072
- },
6073
- "description": "The offset of the popover.",
6074
- "default": "4",
6075
- "fieldName": "offset",
6078
+ "kind": "method",
6079
+ "name": "handleBlur",
6080
+ "privacy": "private",
6081
+ "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
6076
6082
  "inheritedFrom": {
6077
- "name": "Popover",
6078
- "module": "src/components/popover/popover.component.ts"
6083
+ "name": "Buttonsimple",
6084
+ "module": "components/buttonsimple/buttonsimple.component.js"
6079
6085
  }
6080
6086
  },
6081
6087
  {
6082
- "name": "focus-trap",
6083
- "type": {
6084
- "text": "boolean"
6085
- },
6086
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
6087
- "default": "false",
6088
- "fieldName": "focusTrap",
6088
+ "kind": "method",
6089
+ "name": "handleKeyDown",
6090
+ "privacy": "private",
6091
+ "parameters": [
6092
+ {
6093
+ "name": "event",
6094
+ "type": {
6095
+ "text": "KeyboardEvent"
6096
+ },
6097
+ "description": "The keyboard event."
6098
+ }
6099
+ ],
6100
+ "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.",
6089
6101
  "inheritedFrom": {
6090
- "name": "Popover",
6091
- "module": "src/components/popover/popover.component.ts"
6102
+ "name": "Buttonsimple",
6103
+ "module": "components/buttonsimple/buttonsimple.component.js"
6092
6104
  }
6093
6105
  },
6094
6106
  {
6095
- "name": "prevent-scroll",
6096
- "type": {
6097
- "text": "boolean"
6098
- },
6099
- "description": "Prevent outside scrolling when popover show.",
6100
- "default": "false",
6101
- "fieldName": "preventScroll",
6107
+ "kind": "method",
6108
+ "name": "handleKeyUp",
6109
+ "privacy": "private",
6110
+ "parameters": [
6111
+ {
6112
+ "name": "event",
6113
+ "type": {
6114
+ "text": "KeyboardEvent"
6115
+ },
6116
+ "description": "The keyboard event."
6117
+ }
6118
+ ],
6119
+ "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.",
6102
6120
  "inheritedFrom": {
6103
- "name": "Popover",
6104
- "module": "src/components/popover/popover.component.ts"
6121
+ "name": "Buttonsimple",
6122
+ "module": "components/buttonsimple/buttonsimple.component.js"
6105
6123
  }
6106
- },
6124
+ }
6125
+ ],
6126
+ "attributes": [
6107
6127
  {
6108
- "name": "interactive",
6128
+ "name": "color",
6109
6129
  "type": {
6110
- "text": "boolean"
6130
+ "text": "ColorType"
6111
6131
  },
6112
- "description": "Determines whether the popover is interactive。",
6113
- "default": "false",
6114
- "fieldName": "interactive",
6115
- "inheritedFrom": {
6116
- "name": "Popover",
6117
- "module": "src/components/popover/popover.component.ts"
6118
- }
6132
+ "description": "The color of the chip. It supports the following colors\n- default\n- cobalt\n- gold\n- lime\n- mint\n- pink\n- purple\n- slate\n- violet",
6133
+ "default": "default",
6134
+ "fieldName": "color"
6119
6135
  },
6120
6136
  {
6121
- "name": "delay",
6137
+ "name": "label",
6122
6138
  "type": {
6123
6139
  "text": "string"
6124
6140
  },
6125
- "description": "The delay of the show/hide popover.",
6126
- "default": "0,0",
6127
- "fieldName": "delay",
6128
- "inheritedFrom": {
6129
- "name": "Popover",
6130
- "module": "src/components/popover/popover.component.ts"
6131
- }
6141
+ "default": "''",
6142
+ "description": "The visible label text of the chip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
6143
+ "fieldName": "label"
6132
6144
  },
6133
6145
  {
6134
- "name": "hide-on-escape",
6146
+ "name": "icon-name",
6135
6147
  "type": {
6136
- "text": "boolean"
6148
+ "text": "IconNames | undefined"
6137
6149
  },
6138
- "description": "Hide popover on escape key press.",
6139
- "default": "false",
6140
- "fieldName": "hideOnEscape",
6150
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
6151
+ "fieldName": "iconName",
6141
6152
  "inheritedFrom": {
6142
- "name": "Popover",
6143
- "module": "src/components/popover/popover.component.ts"
6153
+ "name": "IconNameMixin",
6154
+ "module": "src/utils/mixins/IconNameMixin.ts"
6144
6155
  }
6145
6156
  },
6146
6157
  {
6147
- "name": "hide-on-blur",
6158
+ "name": "tabIndex",
6148
6159
  "type": {
6149
- "text": "boolean"
6160
+ "text": "number"
6150
6161
  },
6151
- "description": "Hide popover on blur.",
6152
- "default": "false",
6153
- "fieldName": "hideOnBlur",
6162
+ "default": "0",
6163
+ "description": "This property specifies the tab order of the element.",
6164
+ "fieldName": "tabIndex",
6154
6165
  "inheritedFrom": {
6155
- "name": "Popover",
6156
- "module": "src/components/popover/popover.component.ts"
6166
+ "name": "Buttonsimple",
6167
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
6157
6168
  }
6158
6169
  },
6159
6170
  {
6160
- "name": "hide-on-outside-click",
6171
+ "name": "disabled",
6161
6172
  "type": {
6162
- "text": "boolean"
6173
+ "text": "boolean | undefined"
6163
6174
  },
6164
- "description": "Hide on outside click of the popover.",
6165
- "default": "false",
6166
- "fieldName": "hideOnOutsideClick",
6175
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6176
+ "default": "undefined",
6177
+ "fieldName": "disabled",
6167
6178
  "inheritedFrom": {
6168
- "name": "Popover",
6169
- "module": "src/components/popover/popover.component.ts"
6179
+ "name": "Buttonsimple",
6180
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
6170
6181
  }
6171
6182
  },
6172
6183
  {
6173
- "name": "focus-back-to-trigger",
6184
+ "name": "active",
6174
6185
  "type": {
6175
- "text": "boolean"
6186
+ "text": "boolean | undefined"
6176
6187
  },
6177
- "description": "The focus back to trigger after the popover hide.",
6178
- "default": "false",
6179
- "fieldName": "focusBackToTrigger",
6188
+ "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.",
6189
+ "default": "undefined",
6190
+ "fieldName": "active",
6180
6191
  "inheritedFrom": {
6181
- "name": "Popover",
6182
- "module": "src/components/popover/popover.component.ts"
6192
+ "name": "Buttonsimple",
6193
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
6183
6194
  }
6184
6195
  },
6185
6196
  {
6186
- "name": "backdrop",
6197
+ "name": "soft-disabled",
6187
6198
  "type": {
6188
- "text": "boolean"
6199
+ "text": "boolean | undefined"
6189
6200
  },
6190
- "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
6191
- "default": "false",
6192
- "fieldName": "backdrop",
6201
+ "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.",
6202
+ "default": "undefined",
6203
+ "fieldName": "softDisabled",
6193
6204
  "inheritedFrom": {
6194
- "name": "Popover",
6195
- "module": "src/components/popover/popover.component.ts"
6205
+ "name": "Buttonsimple",
6206
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
6196
6207
  }
6197
6208
  },
6198
6209
  {
6199
- "name": "flip",
6210
+ "name": "size",
6200
6211
  "type": {
6201
- "text": "boolean"
6212
+ "text": "ButtonSize"
6202
6213
  },
6203
- "description": "Changes the placement of popover to keep it in view when scrolling.",
6204
- "default": "true",
6205
- "fieldName": "flip",
6214
+ "description": "Simplebutton size is a super set of all the sizes supported by children components.",
6215
+ "default": "32",
6216
+ "fieldName": "size",
6206
6217
  "inheritedFrom": {
6207
- "name": "Popover",
6208
- "module": "src/components/popover/popover.component.ts"
6218
+ "name": "Buttonsimple",
6219
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
6209
6220
  }
6210
6221
  },
6211
6222
  {
6212
- "name": "size",
6213
- "type": {
6214
- "text": "boolean"
6215
- },
6216
- "description": "Changes the size of popover to keep it in view when scrolling.",
6217
- "default": "false",
6218
- "fieldName": "size",
6223
+ "name": "role",
6224
+ "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.",
6225
+ "default": "button",
6226
+ "fieldName": "role",
6219
6227
  "inheritedFrom": {
6220
- "name": "Popover",
6221
- "module": "src/components/popover/popover.component.ts"
6228
+ "name": "Buttonsimple",
6229
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
6222
6230
  }
6223
6231
  },
6224
6232
  {
6225
- "name": "z-index",
6233
+ "name": "ariaStateKey",
6226
6234
  "type": {
6227
- "text": "number"
6235
+ "text": "string | undefined"
6228
6236
  },
6229
- "description": "The z-index of the popover.",
6230
- "default": "1000",
6231
- "fieldName": "zIndex",
6237
+ "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`",
6238
+ "default": "'aria-pressed' (when)",
6239
+ "fieldName": "ariaStateKey",
6232
6240
  "inheritedFrom": {
6233
- "name": "Popover",
6234
- "module": "src/components/popover/popover.component.ts"
6241
+ "name": "Buttonsimple",
6242
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
6235
6243
  }
6236
6244
  },
6237
6245
  {
6238
- "name": "append-to",
6246
+ "name": "type",
6239
6247
  "type": {
6240
- "text": "string"
6248
+ "text": "ButtonType"
6241
6249
  },
6242
- "default": "''",
6243
- "description": "Element ID that the popover append to.",
6244
- "fieldName": "appendTo",
6250
+ "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.",
6251
+ "default": "button",
6252
+ "fieldName": "type",
6245
6253
  "inheritedFrom": {
6246
- "name": "Popover",
6247
- "module": "src/components/popover/popover.component.ts"
6254
+ "name": "Buttonsimple",
6255
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
6248
6256
  }
6249
- },
6257
+ }
6258
+ ],
6259
+ "mixins": [
6250
6260
  {
6251
- "name": "close-button-aria-label",
6252
- "type": {
6253
- "text": "string | null"
6254
- },
6255
- "default": "null",
6256
- "description": "aria-label attribute to be set for close button accessibility.",
6257
- "fieldName": "closeButtonAriaLabel",
6261
+ "name": "IconNameMixin",
6262
+ "module": "/src/utils/mixins/IconNameMixin"
6263
+ }
6264
+ ],
6265
+ "superclass": {
6266
+ "name": "Buttonsimple",
6267
+ "module": "/src/components/buttonsimple/buttonsimple.component"
6268
+ },
6269
+ "tagName": "mdc-chip",
6270
+ "jsDoc": "/**\n * mdc-chip is an interactive element that can be used to represent a chip. It supports a leading icon along with label.\n * Consumers can wrap this component around a tooltip to provide additional context.\n *\n * It is recommended to keep the label text for the chip component concise and compact.\n * For best results, we recommend limiting the <b>maximum length of the label text to 20 characters</b>,\n * including empty spaces to split words.\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-chip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the chip.\n * @cssproperty --mdc-chip-border-color - The border color of the chip.\n * @cssproperty --mdc-chip-background-color - The background color of the chip.\n *\n */",
6271
+ "customElement": true,
6272
+ "events": [
6273
+ {
6274
+ "description": "(React: onClick) This event is dispatched when the button is clicked.",
6275
+ "name": "click",
6276
+ "reactName": "onClick",
6258
6277
  "inheritedFrom": {
6259
- "name": "Popover",
6260
- "module": "src/components/popover/popover.component.ts"
6278
+ "name": "Buttonsimple",
6279
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
6261
6280
  }
6262
6281
  },
6263
6282
  {
6264
- "name": "role",
6265
- "type": {
6266
- "text": "HTMLElement['role']"
6267
- },
6268
- "description": "Role of the popover",
6269
- "default": "dialog",
6270
- "fieldName": "role",
6283
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
6284
+ "name": "keydown",
6285
+ "reactName": "onKeyDown",
6271
6286
  "inheritedFrom": {
6272
- "name": "Popover",
6273
- "module": "src/components/popover/popover.component.ts"
6287
+ "name": "Buttonsimple",
6288
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
6274
6289
  }
6275
6290
  },
6276
6291
  {
6277
- "name": "aria-labelledby",
6278
- "type": {
6279
- "text": "string | null"
6280
- },
6281
- "default": "null",
6282
- "description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
6283
- "fieldName": "ariaLabelledby",
6292
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
6293
+ "name": "keyup",
6294
+ "reactName": "onKeyUp",
6284
6295
  "inheritedFrom": {
6285
- "name": "Popover",
6286
- "module": "src/components/popover/popover.component.ts"
6296
+ "name": "Buttonsimple",
6297
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
6287
6298
  }
6288
6299
  },
6289
6300
  {
6290
- "name": "aria-describedby",
6291
- "type": {
6292
- "text": "string | null"
6293
- },
6294
- "default": "null",
6295
- "description": "aria-describedby of the popover.",
6296
- "fieldName": "ariaDescribedby",
6301
+ "description": "(React: onFocus) This event is dispatched when the button receives focus.",
6302
+ "name": "focus",
6303
+ "reactName": "onFocus",
6297
6304
  "inheritedFrom": {
6298
- "name": "Popover",
6299
- "module": "src/components/popover/popover.component.ts"
6305
+ "name": "Buttonsimple",
6306
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
6300
6307
  }
6301
6308
  }
6302
- ],
6303
- "superclass": {
6304
- "name": "Popover",
6305
- "module": "/src/components/popover/popover.component"
6306
- },
6307
- "tagName": "mdc-coachmark",
6308
- "jsDoc": "/**\n * Coachmark component based on top of the popover component,\n * with the default value of certain properties changed.\n *\n * @dependency mdc-popover\n *\n * @tagname mdc-coachmark\n *\n * @event shown - (React: onShown) This event is dispatched when the coachmark is shown\n * @event hidden - (React: onHidden) This event is dispatched when the coachmark is hidden\n * @event created - (React: onCreated) This event is dispatched when the coachmark is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched when the coachmark is\n * destroyed (removed from the DOM)\n *\n * @cssproperty --mdc-popover-arrow-border-radius - radius of the arrow border\n * @cssproperty --mdc-popover-arrow-border - border of the arrow\n * @cssproperty --mdc-popover-primary-background-color - primary background color of the popover\n * @cssproperty --mdc-popover-border-color - border color of the popover\n * @cssproperty --mdc-popover-inverted-background-color - inverted background color of the popover\n * @cssproperty --mdc-popover-inverted-border-color - inverted border color of the popover\n * @cssproperty --mdc-popover-inverted-text-color - inverted text color of the popover\n * @cssproperty --mdc-popover-elevation-3 - elevation of the popover\n *\n * @slot - Default slot for modal container\n *\n */",
6309
- "customElement": true
6309
+ ]
6310
6310
  }
6311
6311
  ],
6312
6312
  "exports": [
@@ -6314,8 +6314,8 @@
6314
6314
  "kind": "js",
6315
6315
  "name": "default",
6316
6316
  "declaration": {
6317
- "name": "Coachmark",
6318
- "module": "components/coachmark/coachmark.component.js"
6317
+ "name": "Chip",
6318
+ "module": "components/chip/chip.component.js"
6319
6319
  }
6320
6320
  }
6321
6321
  ]