@carbon/ibm-products-web-components 0.29.0 → 0.30.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (139) hide show
  1. package/custom-elements.json +637 -24
  2. package/es/components/about-modal/about-modal.scss.js +1 -1
  3. package/es/components/coachmark/coachmark-beacon/coachmark-beacon.d.ts +6 -1
  4. package/es/components/coachmark/coachmark-beacon/coachmark-beacon.js +15 -2
  5. package/es/components/coachmark/coachmark-beacon/coachmark-beacon.js.map +1 -1
  6. package/es/components/coachmark/coachmark-beacon/coachmark-beacon.scss.js +1 -1
  7. package/es/components/coachmark/coachmark-beacon/coachmark-beacon.test.js +8 -1
  8. package/es/components/coachmark/coachmark-beacon/coachmark-beacon.test.js.map +1 -1
  9. package/es/components/coachmark/coachmark-body.d.ts +382 -0
  10. package/es/components/coachmark/coachmark-body.js +40 -0
  11. package/es/components/coachmark/coachmark-body.js.map +1 -0
  12. package/es/components/coachmark/coachmark-body.scss.js +13 -0
  13. package/es/components/coachmark/coachmark-body.scss.js.map +1 -0
  14. package/es/components/coachmark/coachmark-context.d.ts +11 -0
  15. package/es/components/coachmark/coachmark-context.js +39 -0
  16. package/es/components/coachmark/coachmark-context.js.map +1 -0
  17. package/es/components/coachmark/coachmark-header.d.ts +392 -0
  18. package/es/components/coachmark/coachmark-header.js +92 -0
  19. package/es/components/coachmark/coachmark-header.js.map +1 -0
  20. package/es/components/coachmark/coachmark-header.scss.js +13 -0
  21. package/es/components/coachmark/coachmark-header.scss.js.map +1 -0
  22. package/es/components/coachmark/coachmark.d.ts +416 -0
  23. package/es/components/coachmark/coachmark.js +165 -0
  24. package/es/components/coachmark/coachmark.js.map +1 -0
  25. package/es/components/coachmark/coachmark.scss.js +13 -0
  26. package/es/components/coachmark/coachmark.scss.js.map +1 -0
  27. package/es/components/coachmark/coachmark.test.d.ts +1 -0
  28. package/es/components/coachmark/coachmark.test.js +168 -0
  29. package/es/components/coachmark/coachmark.test.js.map +1 -0
  30. package/es/components/coachmark/index.d.ts +11 -0
  31. package/es/components/coachmark/index.js +11 -0
  32. package/es/components/coachmark/index.js.map +1 -0
  33. package/es/components/guide-banner/guide-banner-element.d.ts +378 -0
  34. package/es/components/guide-banner/guide-banner-element.js +38 -0
  35. package/es/components/guide-banner/guide-banner-element.js.map +1 -0
  36. package/es/components/guide-banner/guide-banner.d.ts +398 -0
  37. package/es/components/guide-banner/guide-banner.js +151 -0
  38. package/es/components/guide-banner/guide-banner.js.map +1 -0
  39. package/es/components/guide-banner/guide-banner.scss.js +13 -0
  40. package/es/components/guide-banner/guide-banner.scss.js.map +1 -0
  41. package/es/components/guide-banner/guide-banner.test.d.ts +1 -0
  42. package/es/components/guide-banner/guide-banner.test.js +121 -0
  43. package/es/components/guide-banner/guide-banner.test.js.map +1 -0
  44. package/es/components/guide-banner/index.d.ts +10 -0
  45. package/es/components/guide-banner/index.js +10 -0
  46. package/es/components/guide-banner/index.js.map +1 -0
  47. package/es/components/notification-panel/notification-footer.scss.js +1 -1
  48. package/es/components/notification-panel/notification-panel.scss.js +1 -1
  49. package/es/components/notification-panel/notification.scss.js +1 -1
  50. package/es/components/page-header/_story-assets/set-of-breadcrumbs.scss.js +1 -1
  51. package/es/components/page-header/_story-assets/set-of-tags/set-of-tags.scss.js +1 -1
  52. package/es/components/side-panel/side-panel.scss.js +1 -1
  53. package/es/components/tearsheet/tearsheet.scss.js +1 -1
  54. package/es/index.d.ts +5 -1
  55. package/es/index.js +4 -0
  56. package/es/index.js.map +1 -1
  57. package/es/packages/ibm-products-web-components/package.json.js +1 -1
  58. package/es/utilities/makeDraggable/makeDraggable.d.ts +38 -0
  59. package/es/utilities/makeDraggable/makeDraggable.js +136 -0
  60. package/es/utilities/makeDraggable/makeDraggable.js.map +1 -0
  61. package/es-custom/components/about-modal/about-modal.scss.js +1 -1
  62. package/es-custom/components/coachmark/coachmark-beacon/coachmark-beacon.d.ts +6 -1
  63. package/es-custom/components/coachmark/coachmark-beacon/coachmark-beacon.js +15 -2
  64. package/es-custom/components/coachmark/coachmark-beacon/coachmark-beacon.js.map +1 -1
  65. package/es-custom/components/coachmark/coachmark-beacon/coachmark-beacon.scss.js +1 -1
  66. package/es-custom/components/coachmark/coachmark-beacon/coachmark-beacon.test.js +8 -1
  67. package/es-custom/components/coachmark/coachmark-beacon/coachmark-beacon.test.js.map +1 -1
  68. package/es-custom/components/coachmark/coachmark-body.d.ts +382 -0
  69. package/es-custom/components/coachmark/coachmark-body.js +40 -0
  70. package/es-custom/components/coachmark/coachmark-body.js.map +1 -0
  71. package/es-custom/components/coachmark/coachmark-body.scss.js +13 -0
  72. package/es-custom/components/coachmark/coachmark-body.scss.js.map +1 -0
  73. package/es-custom/components/coachmark/coachmark-context.d.ts +11 -0
  74. package/es-custom/components/coachmark/coachmark-context.js +39 -0
  75. package/es-custom/components/coachmark/coachmark-context.js.map +1 -0
  76. package/es-custom/components/coachmark/coachmark-header.d.ts +392 -0
  77. package/es-custom/components/coachmark/coachmark-header.js +92 -0
  78. package/es-custom/components/coachmark/coachmark-header.js.map +1 -0
  79. package/es-custom/components/coachmark/coachmark-header.scss.js +13 -0
  80. package/es-custom/components/coachmark/coachmark-header.scss.js.map +1 -0
  81. package/es-custom/components/coachmark/coachmark.d.ts +416 -0
  82. package/es-custom/components/coachmark/coachmark.js +165 -0
  83. package/es-custom/components/coachmark/coachmark.js.map +1 -0
  84. package/es-custom/components/coachmark/coachmark.scss.js +13 -0
  85. package/es-custom/components/coachmark/coachmark.scss.js.map +1 -0
  86. package/es-custom/components/coachmark/coachmark.test.d.ts +1 -0
  87. package/es-custom/components/coachmark/coachmark.test.js +168 -0
  88. package/es-custom/components/coachmark/coachmark.test.js.map +1 -0
  89. package/es-custom/components/coachmark/index.d.ts +11 -0
  90. package/es-custom/components/coachmark/index.js +11 -0
  91. package/es-custom/components/coachmark/index.js.map +1 -0
  92. package/es-custom/components/guide-banner/guide-banner-element.d.ts +378 -0
  93. package/es-custom/components/guide-banner/guide-banner-element.js +38 -0
  94. package/es-custom/components/guide-banner/guide-banner-element.js.map +1 -0
  95. package/es-custom/components/guide-banner/guide-banner.d.ts +398 -0
  96. package/es-custom/components/guide-banner/guide-banner.js +151 -0
  97. package/es-custom/components/guide-banner/guide-banner.js.map +1 -0
  98. package/es-custom/components/guide-banner/guide-banner.scss.js +13 -0
  99. package/es-custom/components/guide-banner/guide-banner.scss.js.map +1 -0
  100. package/es-custom/components/guide-banner/guide-banner.test.d.ts +1 -0
  101. package/es-custom/components/guide-banner/guide-banner.test.js +121 -0
  102. package/es-custom/components/guide-banner/guide-banner.test.js.map +1 -0
  103. package/es-custom/components/guide-banner/index.d.ts +10 -0
  104. package/es-custom/components/guide-banner/index.js +10 -0
  105. package/es-custom/components/guide-banner/index.js.map +1 -0
  106. package/es-custom/components/notification-panel/notification-footer.scss.js +1 -1
  107. package/es-custom/components/notification-panel/notification-panel.scss.js +1 -1
  108. package/es-custom/components/notification-panel/notification.scss.js +1 -1
  109. package/es-custom/components/page-header/_story-assets/set-of-breadcrumbs.scss.js +1 -1
  110. package/es-custom/components/page-header/_story-assets/set-of-tags/set-of-tags.scss.js +1 -1
  111. package/es-custom/components/side-panel/side-panel.scss.js +1 -1
  112. package/es-custom/components/tearsheet/tearsheet.scss.js +1 -1
  113. package/es-custom/index.d.ts +5 -1
  114. package/es-custom/index.js +4 -0
  115. package/es-custom/index.js.map +1 -1
  116. package/es-custom/packages/ibm-products-web-components/package.json.js +1 -1
  117. package/es-custom/utilities/makeDraggable/makeDraggable.d.ts +38 -0
  118. package/es-custom/utilities/makeDraggable/makeDraggable.js +136 -0
  119. package/es-custom/utilities/makeDraggable/makeDraggable.js.map +1 -0
  120. package/lib/components/coachmark/coachmark-beacon/coachmark-beacon.d.ts +6 -1
  121. package/lib/components/coachmark/coachmark-body.d.ts +382 -0
  122. package/lib/components/coachmark/coachmark-context.d.ts +11 -0
  123. package/lib/components/coachmark/coachmark-header.d.ts +392 -0
  124. package/lib/components/coachmark/coachmark.d.ts +416 -0
  125. package/lib/components/coachmark/coachmark.test.d.ts +1 -0
  126. package/lib/components/coachmark/index.d.ts +11 -0
  127. package/lib/components/guide-banner/guide-banner-element.d.ts +378 -0
  128. package/lib/components/guide-banner/guide-banner.d.ts +398 -0
  129. package/lib/components/guide-banner/guide-banner.test.d.ts +1 -0
  130. package/lib/components/guide-banner/index.d.ts +10 -0
  131. package/lib/index.d.ts +5 -1
  132. package/lib/utilities/makeDraggable/makeDraggable.d.ts +38 -0
  133. package/package.json +8 -8
  134. package/scss/components/coachmark/coachmark-beacon/coachmark-beacon.scss +1 -0
  135. package/scss/components/coachmark/coachmark-body.scss +19 -0
  136. package/scss/components/coachmark/coachmark-header.scss +32 -0
  137. package/scss/components/coachmark/coachmark.scss +30 -0
  138. package/scss/components/guide-banner/guide-banner.scss +30 -0
  139. package/telemetry.yml +14 -3
@@ -453,39 +453,530 @@
453
453
  "description": "id for the coachmark beacon",
454
454
  "type": "string",
455
455
  "default": "\"crypto.randomUUID()\""
456
+ },
457
+ {
458
+ "name": "expanded",
459
+ "description": "specify aria-expanded of beacon",
460
+ "type": "boolean",
461
+ "default": "false"
462
+ }
463
+ ],
464
+ "properties": [
465
+ {
466
+ "name": "kind",
467
+ "attribute": "kind",
468
+ "description": "What style of beacon.\nBEACON_KIND is an enum from the Coachmark and can be used for this value.",
469
+ "type": "BEACON_KIND | undefined",
470
+ "default": "\"default\""
471
+ },
472
+ {
473
+ "name": "label",
474
+ "attribute": "label",
475
+ "description": "The aria label.",
476
+ "type": "string",
477
+ "default": "\"Show information\""
478
+ },
479
+ {
480
+ "name": "id",
481
+ "attribute": "id",
482
+ "description": "id for the coachmark beacon",
483
+ "type": "string",
484
+ "default": "\"crypto.randomUUID()\""
485
+ },
486
+ {
487
+ "name": "expanded",
488
+ "attribute": "expanded",
489
+ "description": "specify aria-expanded of beacon",
490
+ "type": "boolean",
491
+ "default": "false"
492
+ },
493
+ {
494
+ "name": "shadowRootOptions",
495
+ "type": "{ delegatesFocus: boolean; mode: ShadowRootMode; slotAssignment?: SlotAssignmentMode | undefined; customElements?: CustomElementRegistry | undefined; registry?: CustomElementRegistry | undefined; }",
496
+ "default": "{\"delegatesFocus\":true}"
497
+ },
498
+ {
499
+ "name": "styles",
500
+ "default": "\"styles\""
501
+ },
502
+ {
503
+ "name": "size",
504
+ "type": "number"
505
+ },
506
+ {
507
+ "name": "context-request",
508
+ "description": "A 'context-request' event can be emitted by any element which desires\na context value to be injected by an external provider.",
509
+ "type": "ContextRequestEvent<{ __context__: unknown; }>"
510
+ },
511
+ {
512
+ "name": "context-provider",
513
+ "description": "A 'context-provider' event can be emitted by any element which hosts\na context provider to indicate it is available for use.",
514
+ "type": "ContextProviderEvent<{ __context__: unknown; }>"
515
+ },
516
+ {
517
+ "name": "customElements",
518
+ "type": "CustomElementRegistry | undefined"
519
+ },
520
+ {
521
+ "name": "registry",
522
+ "type": "CustomElementRegistry | undefined"
523
+ },
524
+ {
525
+ "name": "set-of-actions",
526
+ "type": "SetOfActions"
527
+ },
528
+ {
529
+ "name": "set-of-breadcrumbs",
530
+ "type": "SetOfBreadcrumbs"
531
+ },
532
+ {
533
+ "name": "set-of-tags",
534
+ "type": "SetOfTags"
535
+ },
536
+ {
537
+ "name": "set-of-users",
538
+ "type": "SetOfUsers"
539
+ },
540
+ {
541
+ "name": "step-group",
542
+ "type": "StepGroup"
543
+ },
544
+ {
545
+ "name": "step-tearsheet",
546
+ "type": "StepTearsheet"
547
+ },
548
+ {
549
+ "name": "step-full-page",
550
+ "type": "StepFullPage"
551
+ },
552
+ {
553
+ "name": "length",
554
+ "description": "Gets the length of the array. This is a number one higher than the highest element defined in an array.",
555
+ "type": "number"
556
+ }
557
+ ],
558
+ "events": [
559
+ {
560
+ "name": "c4p-coachmark-beacon-clicked",
561
+ "description": "Custom event fired when beacon is clicked"
562
+ }
563
+ ]
564
+ },
565
+ {
566
+ "name": "c4p-coachmark-body",
567
+ "path": "./src/components/coachmark/coachmark-body.ts",
568
+ "description": "coachmark-body for content body",
569
+ "properties": [
570
+ {
571
+ "name": "enabledWarnings",
572
+ "description": "Read or set all the enabled warning categories for this class.\n\nThis property is only used in development builds.",
573
+ "type": "WarningKind[] | undefined"
574
+ },
575
+ {
576
+ "name": "enableWarning",
577
+ "description": "Enable the given warning category for this class.\n\nThis method only exists in development builds, so it should be accessed\nwith a guard like:\n\n```ts\n// Enable for all ReactiveElement subclasses\nReactiveElement.enableWarning?.('migration');\n\n// Enable for only MyElement and subclasses\nMyElement.enableWarning?.('migration');\n```",
578
+ "type": "((warningKind: WarningKind) => void) | undefined"
579
+ },
580
+ {
581
+ "name": "disableWarning",
582
+ "description": "Disable the given warning category for this class.\n\nThis method only exists in development builds, so it should be accessed\nwith a guard like:\n\n```ts\n// Disable for all ReactiveElement subclasses\nReactiveElement.disableWarning?.('migration');\n\n// Disable for only MyElement and subclasses\nMyElement.disableWarning?.('migration');\n```",
583
+ "type": "((warningKind: WarningKind) => void) | undefined"
584
+ },
585
+ {
586
+ "name": "elementProperties",
587
+ "description": "Memoized list of all element properties, including any superclass\nproperties. Created lazily on user subclasses when finalizing the class.",
588
+ "type": "PropertyDeclarationMap"
589
+ },
590
+ {
591
+ "name": "properties",
592
+ "description": "User-supplied object that maps property names to `PropertyDeclaration`\nobjects containing options for configuring reactive properties. When\na reactive property is set the element will update and render.\n\nBy default properties are public fields, and as such, they should be\nconsidered as primarily settable by element users, either via attribute or\nthe property itself.\n\nGenerally, properties that are changed by the element should be private or\nprotected fields and should use the `state: true` option. Properties\nmarked as `state` do not reflect from the corresponding attribute\n\nHowever, sometimes element code does need to set a public property. This\nshould typically only be done in response to user interaction, and an event\nshould be fired informing the user; for example, a checkbox sets its\n`checked` property when clicked and fires a `changed` event. Mutating\npublic properties should typically not be done for non-primitive (object or\narray) properties. In other cases when an element needs to manage state, a\nprivate property set with the `state: true` option should be used. When\nneeded, state properties can be initialized via public properties to\nfacilitate complex interactions.",
593
+ "type": "PropertyDeclarations"
594
+ },
595
+ {
596
+ "name": "elementStyles",
597
+ "description": "Memoized list of all element styles.\nCreated lazily on user subclasses when finalizing the class.",
598
+ "type": "CSSResultOrNative[]"
599
+ },
600
+ {
601
+ "name": "styles",
602
+ "description": "[object Object],[object Object],[object Object]",
603
+ "default": "\"styles\""
604
+ },
605
+ {
606
+ "name": "shadowRootOptions",
607
+ "description": "Options used when calling `attachShadow`. Set this property to customize\nthe options for the shadowRoot; for example, to create a closed\nshadowRoot: `{mode: 'closed'}`.\n\nNote, these options are used in `createRenderRoot`. If this method\nis customized, options should be respected if possible.",
608
+ "type": "ShadowRootInit"
609
+ },
610
+ {
611
+ "name": "renderRoot",
612
+ "description": "Node or ShadowRoot into which element DOM should be rendered. Defaults\nto an open shadowRoot.",
613
+ "type": "HTMLElement | DocumentFragment"
614
+ },
615
+ {
616
+ "name": "isUpdatePending",
617
+ "description": "True if there is a pending update as a result of calling `requestUpdate()`.\nShould only be read.",
618
+ "type": "boolean"
619
+ },
620
+ {
621
+ "name": "hasUpdated",
622
+ "description": "Is set to `true` after the first update. The element code cannot assume\nthat `renderRoot` exists before the element `hasUpdated`.",
623
+ "type": "boolean"
624
+ },
625
+ {
626
+ "name": "updateComplete",
627
+ "description": "Returns a Promise that resolves when the element has completed updating.\nThe Promise value is a boolean that is `true` if the element completed the\nupdate without triggering another update. The Promise result is `false` if\na property was set inside `updated()`. If the Promise is rejected, an\nexception was thrown during the update.\n\nTo await additional asynchronous work, override the `getUpdateComplete`\nmethod. For example, it is sometimes useful to await a rendered element\nbefore fulfilling this Promise. To do this, first await\n`super.getUpdateComplete()`, then any subsequent state.",
628
+ "type": "Promise<boolean>"
629
+ },
630
+ {
631
+ "name": "size",
632
+ "type": "number"
633
+ },
634
+ {
635
+ "name": "context-request",
636
+ "description": "A 'context-request' event can be emitted by any element which desires\na context value to be injected by an external provider.",
637
+ "type": "ContextRequestEvent<{ __context__: unknown; }>"
638
+ },
639
+ {
640
+ "name": "context-provider",
641
+ "description": "A 'context-provider' event can be emitted by any element which hosts\na context provider to indicate it is available for use.",
642
+ "type": "ContextProviderEvent<{ __context__: unknown; }>"
643
+ },
644
+ {
645
+ "name": "customElements",
646
+ "type": "CustomElementRegistry | undefined"
647
+ },
648
+ {
649
+ "name": "registry",
650
+ "type": "CustomElementRegistry | undefined"
651
+ },
652
+ {
653
+ "name": "set-of-actions",
654
+ "type": "SetOfActions"
655
+ },
656
+ {
657
+ "name": "set-of-breadcrumbs",
658
+ "type": "SetOfBreadcrumbs"
659
+ },
660
+ {
661
+ "name": "set-of-tags",
662
+ "type": "SetOfTags"
663
+ },
664
+ {
665
+ "name": "set-of-users",
666
+ "type": "SetOfUsers"
667
+ },
668
+ {
669
+ "name": "step-group",
670
+ "type": "StepGroup"
671
+ },
672
+ {
673
+ "name": "step-tearsheet",
674
+ "type": "StepTearsheet"
675
+ },
676
+ {
677
+ "name": "step-full-page",
678
+ "type": "StepFullPage"
679
+ },
680
+ {
681
+ "name": "length",
682
+ "description": "Gets the length of the array. This is a number one higher than the highest element defined in an array.",
683
+ "type": "number"
684
+ }
685
+ ]
686
+ },
687
+ {
688
+ "name": "c4p-coachmark-header",
689
+ "path": "./src/components/coachmark/coachmark-header.ts",
690
+ "description": "coachmark-header for content header section",
691
+ "attributes": [
692
+ {
693
+ "name": "closeIconDescription",
694
+ "description": "Tooltip text and aria label for the Close button icon.",
695
+ "type": "string | undefined",
696
+ "default": "\"\""
697
+ },
698
+ {
699
+ "name": "dragIconDescription",
700
+ "description": "Tooltip text and aria label for the Drag button icon.",
701
+ "type": "string | undefined",
702
+ "default": "\"\""
703
+ }
704
+ ],
705
+ "properties": [
706
+ {
707
+ "name": "closeIconDescription",
708
+ "attribute": "closeIconDescription",
709
+ "description": "Tooltip text and aria label for the Close button icon.",
710
+ "type": "string | undefined",
711
+ "default": "\"\""
712
+ },
713
+ {
714
+ "name": "dragIconDescription",
715
+ "attribute": "dragIconDescription",
716
+ "description": "Tooltip text and aria label for the Drag button icon.",
717
+ "type": "string | undefined",
718
+ "default": "\"\""
719
+ },
720
+ {
721
+ "name": "enabledWarnings",
722
+ "description": "Read or set all the enabled warning categories for this class.\n\nThis property is only used in development builds.",
723
+ "type": "WarningKind[] | undefined"
724
+ },
725
+ {
726
+ "name": "enableWarning",
727
+ "description": "Enable the given warning category for this class.\n\nThis method only exists in development builds, so it should be accessed\nwith a guard like:\n\n```ts\n// Enable for all ReactiveElement subclasses\nReactiveElement.enableWarning?.('migration');\n\n// Enable for only MyElement and subclasses\nMyElement.enableWarning?.('migration');\n```",
728
+ "type": "((warningKind: WarningKind) => void) | undefined"
729
+ },
730
+ {
731
+ "name": "disableWarning",
732
+ "description": "Disable the given warning category for this class.\n\nThis method only exists in development builds, so it should be accessed\nwith a guard like:\n\n```ts\n// Disable for all ReactiveElement subclasses\nReactiveElement.disableWarning?.('migration');\n\n// Disable for only MyElement and subclasses\nMyElement.disableWarning?.('migration');\n```",
733
+ "type": "((warningKind: WarningKind) => void) | undefined"
734
+ },
735
+ {
736
+ "name": "elementProperties",
737
+ "description": "Memoized list of all element properties, including any superclass\nproperties. Created lazily on user subclasses when finalizing the class.",
738
+ "type": "PropertyDeclarationMap"
739
+ },
740
+ {
741
+ "name": "properties",
742
+ "description": "User-supplied object that maps property names to `PropertyDeclaration`\nobjects containing options for configuring reactive properties. When\na reactive property is set the element will update and render.\n\nBy default properties are public fields, and as such, they should be\nconsidered as primarily settable by element users, either via attribute or\nthe property itself.\n\nGenerally, properties that are changed by the element should be private or\nprotected fields and should use the `state: true` option. Properties\nmarked as `state` do not reflect from the corresponding attribute\n\nHowever, sometimes element code does need to set a public property. This\nshould typically only be done in response to user interaction, and an event\nshould be fired informing the user; for example, a checkbox sets its\n`checked` property when clicked and fires a `changed` event. Mutating\npublic properties should typically not be done for non-primitive (object or\narray) properties. In other cases when an element needs to manage state, a\nprivate property set with the `state: true` option should be used. When\nneeded, state properties can be initialized via public properties to\nfacilitate complex interactions.",
743
+ "type": "PropertyDeclarations"
744
+ },
745
+ {
746
+ "name": "elementStyles",
747
+ "description": "Memoized list of all element styles.\nCreated lazily on user subclasses when finalizing the class.",
748
+ "type": "CSSResultOrNative[]"
749
+ },
750
+ {
751
+ "name": "styles",
752
+ "description": "[object Object],[object Object],[object Object]",
753
+ "default": "\"styles\""
754
+ },
755
+ {
756
+ "name": "shadowRootOptions",
757
+ "description": "Options used when calling `attachShadow`. Set this property to customize\nthe options for the shadowRoot; for example, to create a closed\nshadowRoot: `{mode: 'closed'}`.\n\nNote, these options are used in `createRenderRoot`. If this method\nis customized, options should be respected if possible.",
758
+ "type": "ShadowRootInit"
759
+ },
760
+ {
761
+ "name": "renderRoot",
762
+ "description": "Node or ShadowRoot into which element DOM should be rendered. Defaults\nto an open shadowRoot.",
763
+ "type": "HTMLElement | DocumentFragment"
764
+ },
765
+ {
766
+ "name": "isUpdatePending",
767
+ "description": "True if there is a pending update as a result of calling `requestUpdate()`.\nShould only be read.",
768
+ "type": "boolean"
769
+ },
770
+ {
771
+ "name": "hasUpdated",
772
+ "description": "Is set to `true` after the first update. The element code cannot assume\nthat `renderRoot` exists before the element `hasUpdated`.",
773
+ "type": "boolean"
774
+ },
775
+ {
776
+ "name": "updateComplete",
777
+ "description": "Returns a Promise that resolves when the element has completed updating.\nThe Promise value is a boolean that is `true` if the element completed the\nupdate without triggering another update. The Promise result is `false` if\na property was set inside `updated()`. If the Promise is rejected, an\nexception was thrown during the update.\n\nTo await additional asynchronous work, override the `getUpdateComplete`\nmethod. For example, it is sometimes useful to await a rendered element\nbefore fulfilling this Promise. To do this, first await\n`super.getUpdateComplete()`, then any subsequent state.",
778
+ "type": "Promise<boolean>"
779
+ },
780
+ {
781
+ "name": "size",
782
+ "type": "number"
783
+ },
784
+ {
785
+ "name": "context-request",
786
+ "description": "A 'context-request' event can be emitted by any element which desires\na context value to be injected by an external provider.",
787
+ "type": "ContextRequestEvent<{ __context__: unknown; }>"
788
+ },
789
+ {
790
+ "name": "context-provider",
791
+ "description": "A 'context-provider' event can be emitted by any element which hosts\na context provider to indicate it is available for use.",
792
+ "type": "ContextProviderEvent<{ __context__: unknown; }>"
793
+ },
794
+ {
795
+ "name": "customElements",
796
+ "type": "CustomElementRegistry | undefined"
797
+ },
798
+ {
799
+ "name": "registry",
800
+ "type": "CustomElementRegistry | undefined"
801
+ },
802
+ {
803
+ "name": "set-of-actions",
804
+ "type": "SetOfActions"
805
+ },
806
+ {
807
+ "name": "set-of-breadcrumbs",
808
+ "type": "SetOfBreadcrumbs"
809
+ },
810
+ {
811
+ "name": "set-of-tags",
812
+ "type": "SetOfTags"
813
+ },
814
+ {
815
+ "name": "set-of-users",
816
+ "type": "SetOfUsers"
817
+ },
818
+ {
819
+ "name": "step-group",
820
+ "type": "StepGroup"
821
+ },
822
+ {
823
+ "name": "step-tearsheet",
824
+ "type": "StepTearsheet"
825
+ },
826
+ {
827
+ "name": "step-full-page",
828
+ "type": "StepFullPage"
829
+ },
830
+ {
831
+ "name": "length",
832
+ "description": "Gets the length of the array. This is a number one higher than the highest element defined in an array.",
833
+ "type": "number"
834
+ }
835
+ ]
836
+ },
837
+ {
838
+ "name": "c4p-coachmark",
839
+ "path": "./src/components/coachmark/coachmark.ts",
840
+ "description": "coachmark main component",
841
+ "attributes": [
842
+ {
843
+ "name": "open",
844
+ "description": "Specifies whether the component is currently open.",
845
+ "type": "boolean",
846
+ "default": "false"
847
+ },
848
+ {
849
+ "name": "align",
850
+ "description": "Where to render the Coachmark relative to its target.",
851
+ "type": "string | undefined",
852
+ "default": "\"top\""
853
+ },
854
+ {
855
+ "name": "position",
856
+ "description": "Fine tune the position of the target in pixels.",
857
+ "type": "{ x: number; y: number; } | undefined"
858
+ },
859
+ {
860
+ "name": "floating",
861
+ "description": "Specifies whether the component is floating or not.",
862
+ "type": "boolean | undefined",
863
+ "default": "false"
864
+ },
865
+ {
866
+ "name": "highContrast",
867
+ "description": "Specify whether the component should be rendered on high-contrast.",
868
+ "type": "boolean | undefined",
869
+ "default": "false"
870
+ },
871
+ {
872
+ "name": "dropShadow",
873
+ "description": "Specify whether a drop shadow should be rendered on the popover.",
874
+ "type": "boolean | undefined",
875
+ "default": "false"
456
876
  }
457
877
  ],
458
878
  "properties": [
459
879
  {
460
- "name": "kind",
461
- "attribute": "kind",
462
- "description": "What style of beacon.\nBEACON_KIND is an enum from the Coachmark and can be used for this value.",
463
- "type": "BEACON_KIND | undefined",
464
- "default": "\"default\""
880
+ "name": "open",
881
+ "attribute": "open",
882
+ "description": "Specifies whether the component is currently open.",
883
+ "type": "boolean",
884
+ "default": "false"
465
885
  },
466
886
  {
467
- "name": "label",
468
- "attribute": "label",
469
- "description": "The aria label.",
470
- "type": "string",
471
- "default": "\"Show information\""
887
+ "name": "align",
888
+ "attribute": "align",
889
+ "description": "Where to render the Coachmark relative to its target.",
890
+ "type": "string | undefined",
891
+ "default": "\"top\""
472
892
  },
473
893
  {
474
- "name": "id",
475
- "attribute": "id",
476
- "description": "id for the coachmark beacon",
477
- "type": "string",
478
- "default": "\"crypto.randomUUID()\""
894
+ "name": "position",
895
+ "attribute": "position",
896
+ "description": "Fine tune the position of the target in pixels.",
897
+ "type": "{ x: number; y: number; } | undefined"
479
898
  },
480
899
  {
481
- "name": "shadowRootOptions",
482
- "type": "{ delegatesFocus: boolean; mode: ShadowRootMode; slotAssignment?: SlotAssignmentMode | undefined; customElements?: CustomElementRegistry | undefined; registry?: CustomElementRegistry | undefined; }",
483
- "default": "{\"delegatesFocus\":true}"
900
+ "name": "floating",
901
+ "attribute": "floating",
902
+ "description": "Specifies whether the component is floating or not.",
903
+ "type": "boolean | undefined",
904
+ "default": "false"
905
+ },
906
+ {
907
+ "name": "highContrast",
908
+ "attribute": "highContrast",
909
+ "description": "Specify whether the component should be rendered on high-contrast.",
910
+ "type": "boolean | undefined",
911
+ "default": "false"
912
+ },
913
+ {
914
+ "name": "dropShadow",
915
+ "attribute": "dropShadow",
916
+ "description": "Specify whether a drop shadow should be rendered on the popover.",
917
+ "type": "boolean | undefined",
918
+ "default": "false"
919
+ },
920
+ {
921
+ "name": "enabledWarnings",
922
+ "description": "Read or set all the enabled warning categories for this class.\n\nThis property is only used in development builds.",
923
+ "type": "WarningKind[] | undefined"
924
+ },
925
+ {
926
+ "name": "enableWarning",
927
+ "description": "Enable the given warning category for this class.\n\nThis method only exists in development builds, so it should be accessed\nwith a guard like:\n\n```ts\n// Enable for all ReactiveElement subclasses\nReactiveElement.enableWarning?.('migration');\n\n// Enable for only MyElement and subclasses\nMyElement.enableWarning?.('migration');\n```",
928
+ "type": "((warningKind: WarningKind) => void) | undefined"
929
+ },
930
+ {
931
+ "name": "disableWarning",
932
+ "description": "Disable the given warning category for this class.\n\nThis method only exists in development builds, so it should be accessed\nwith a guard like:\n\n```ts\n// Disable for all ReactiveElement subclasses\nReactiveElement.disableWarning?.('migration');\n\n// Disable for only MyElement and subclasses\nMyElement.disableWarning?.('migration');\n```",
933
+ "type": "((warningKind: WarningKind) => void) | undefined"
934
+ },
935
+ {
936
+ "name": "elementProperties",
937
+ "description": "Memoized list of all element properties, including any superclass\nproperties. Created lazily on user subclasses when finalizing the class.",
938
+ "type": "PropertyDeclarationMap"
939
+ },
940
+ {
941
+ "name": "properties",
942
+ "description": "User-supplied object that maps property names to `PropertyDeclaration`\nobjects containing options for configuring reactive properties. When\na reactive property is set the element will update and render.\n\nBy default properties are public fields, and as such, they should be\nconsidered as primarily settable by element users, either via attribute or\nthe property itself.\n\nGenerally, properties that are changed by the element should be private or\nprotected fields and should use the `state: true` option. Properties\nmarked as `state` do not reflect from the corresponding attribute\n\nHowever, sometimes element code does need to set a public property. This\nshould typically only be done in response to user interaction, and an event\nshould be fired informing the user; for example, a checkbox sets its\n`checked` property when clicked and fires a `changed` event. Mutating\npublic properties should typically not be done for non-primitive (object or\narray) properties. In other cases when an element needs to manage state, a\nprivate property set with the `state: true` option should be used. When\nneeded, state properties can be initialized via public properties to\nfacilitate complex interactions.",
943
+ "type": "PropertyDeclarations"
944
+ },
945
+ {
946
+ "name": "elementStyles",
947
+ "description": "Memoized list of all element styles.\nCreated lazily on user subclasses when finalizing the class.",
948
+ "type": "CSSResultOrNative[]"
484
949
  },
485
950
  {
486
951
  "name": "styles",
952
+ "description": "[object Object],[object Object],[object Object]",
487
953
  "default": "\"styles\""
488
954
  },
955
+ {
956
+ "name": "shadowRootOptions",
957
+ "description": "Options used when calling `attachShadow`. Set this property to customize\nthe options for the shadowRoot; for example, to create a closed\nshadowRoot: `{mode: 'closed'}`.\n\nNote, these options are used in `createRenderRoot`. If this method\nis customized, options should be respected if possible.",
958
+ "type": "ShadowRootInit"
959
+ },
960
+ {
961
+ "name": "renderRoot",
962
+ "description": "Node or ShadowRoot into which element DOM should be rendered. Defaults\nto an open shadowRoot.",
963
+ "type": "HTMLElement | DocumentFragment"
964
+ },
965
+ {
966
+ "name": "isUpdatePending",
967
+ "description": "True if there is a pending update as a result of calling `requestUpdate()`.\nShould only be read.",
968
+ "type": "boolean"
969
+ },
970
+ {
971
+ "name": "hasUpdated",
972
+ "description": "Is set to `true` after the first update. The element code cannot assume\nthat `renderRoot` exists before the element `hasUpdated`.",
973
+ "type": "boolean"
974
+ },
975
+ {
976
+ "name": "updateComplete",
977
+ "description": "Returns a Promise that resolves when the element has completed updating.\nThe Promise value is a boolean that is `true` if the element completed the\nupdate without triggering another update. The Promise result is `false` if\na property was set inside `updated()`. If the Promise is rejected, an\nexception was thrown during the update.\n\nTo await additional asynchronous work, override the `getUpdateComplete`\nmethod. For example, it is sometimes useful to await a rendered element\nbefore fulfilling this Promise. To do this, first await\n`super.getUpdateComplete()`, then any subsequent state.",
978
+ "type": "Promise<boolean>"
979
+ },
489
980
  {
490
981
  "name": "size",
491
982
  "type": "number"
@@ -541,12 +1032,6 @@
541
1032
  "description": "Gets the length of the array. This is a number one higher than the highest element defined in an array.",
542
1033
  "type": "number"
543
1034
  }
544
- ],
545
- "events": [
546
- {
547
- "name": "c4p-coachmark-beacon-clicked",
548
- "description": "Custom event fired when beacon is clicked"
549
- }
550
1035
  ]
551
1036
  },
552
1037
  {
@@ -675,6 +1160,134 @@
675
1160
  }
676
1161
  ]
677
1162
  },
1163
+ {
1164
+ "name": "c4p-guide-banner",
1165
+ "path": "./src/components/guide-banner/guide-banner.ts",
1166
+ "description": "OptionsTile.",
1167
+ "attributes": [
1168
+ {
1169
+ "name": "collapseText",
1170
+ "type": "string | undefined",
1171
+ "default": "\"\""
1172
+ },
1173
+ {
1174
+ "name": "expandText",
1175
+ "type": "string | undefined",
1176
+ "default": "\"\""
1177
+ },
1178
+ {
1179
+ "name": "open",
1180
+ "type": "boolean",
1181
+ "default": "false"
1182
+ },
1183
+ {
1184
+ "name": "titleText",
1185
+ "type": "string | undefined",
1186
+ "default": "\"\""
1187
+ }
1188
+ ],
1189
+ "properties": [
1190
+ {
1191
+ "name": "collapseText",
1192
+ "attribute": "collapseText",
1193
+ "type": "string | undefined",
1194
+ "default": "\"\""
1195
+ },
1196
+ {
1197
+ "name": "expandText",
1198
+ "attribute": "expandText",
1199
+ "type": "string | undefined",
1200
+ "default": "\"\""
1201
+ },
1202
+ {
1203
+ "name": "open",
1204
+ "attribute": "open",
1205
+ "type": "boolean",
1206
+ "default": "false"
1207
+ },
1208
+ {
1209
+ "name": "titleText",
1210
+ "attribute": "titleText",
1211
+ "type": "string | undefined",
1212
+ "default": "\"\""
1213
+ },
1214
+ {
1215
+ "name": "styles",
1216
+ "default": "\"styles\""
1217
+ },
1218
+ {
1219
+ "name": "size",
1220
+ "type": "number"
1221
+ },
1222
+ {
1223
+ "name": "context-request",
1224
+ "description": "A 'context-request' event can be emitted by any element which desires\na context value to be injected by an external provider.",
1225
+ "type": "ContextRequestEvent<{ __context__: unknown; }>"
1226
+ },
1227
+ {
1228
+ "name": "context-provider",
1229
+ "description": "A 'context-provider' event can be emitted by any element which hosts\na context provider to indicate it is available for use.",
1230
+ "type": "ContextProviderEvent<{ __context__: unknown; }>"
1231
+ },
1232
+ {
1233
+ "name": "customElements",
1234
+ "type": "CustomElementRegistry | undefined"
1235
+ },
1236
+ {
1237
+ "name": "registry",
1238
+ "type": "CustomElementRegistry | undefined"
1239
+ },
1240
+ {
1241
+ "name": "set-of-actions",
1242
+ "type": "SetOfActions"
1243
+ },
1244
+ {
1245
+ "name": "set-of-breadcrumbs",
1246
+ "type": "SetOfBreadcrumbs"
1247
+ },
1248
+ {
1249
+ "name": "set-of-tags",
1250
+ "type": "SetOfTags"
1251
+ },
1252
+ {
1253
+ "name": "set-of-users",
1254
+ "type": "SetOfUsers"
1255
+ },
1256
+ {
1257
+ "name": "step-group",
1258
+ "type": "StepGroup"
1259
+ },
1260
+ {
1261
+ "name": "step-tearsheet",
1262
+ "type": "StepTearsheet"
1263
+ },
1264
+ {
1265
+ "name": "step-full-page",
1266
+ "type": "StepFullPage"
1267
+ },
1268
+ {
1269
+ "name": "length",
1270
+ "description": "Gets the length of the array. This is a number one higher than the highest element defined in an array.",
1271
+ "type": "number"
1272
+ }
1273
+ ],
1274
+ "events": [
1275
+ {
1276
+ "name": "c4p-guide-banner-toggle",
1277
+ "description": "Custom event fired when tile is opened"
1278
+ },
1279
+ {
1280
+ "name": "c4p-guide-banner-close",
1281
+ "description": "Custom event fired when tile is closed"
1282
+ }
1283
+ ],
1284
+ "cssParts": [
1285
+ {
1286
+ "name": "guide",
1287
+ "description": "banner The options tile"
1288
+ }
1289
+ ]
1290
+ },
678
1291
  {
679
1292
  "name": "c4p-interstitial-screen-body-item",
680
1293
  "path": "./src/components/interstitial-screen/interstitial-screen-body-item.ts",